Difference between revisions of "Metadata requirements"
Line 5: | Line 5: | ||
− | Metadata requirements are organized hierarchically, breaking down core requirements into sub- and sub-sub-requirements. | + | Metadata requirements are organized hierarchically, breaking down core requirements into sub- and sub-sub-requirements. Four core requirements have been identified: |
#[[#MR-1 | Record information about archival materials]] | #[[#MR-1 | Record information about archival materials]] | ||
#[[#MR-2 | Record information about entities (actors) that interact with archival materials]] | #[[#MR-2 | Record information about entities (actors) that interact with archival materials]] |
Revision as of 13:33, 1 February 2008
Please note that ICA-AtoM is no longer actively supported by Artefactual Systems.
Visit https://www.accesstomemory.org for information about AtoM, the currently supported version.
Main Page > System Requirements > Metadata requirements
Metadata requirements identify the entities the system must track and the kinds of information about them it must capture in order to do the things specified by the functional requirements.
Metadata requirements are organized hierarchically, breaking down core requirements into sub- and sub-sub-requirements. Four core requirements have been identified:
- Record information about archival materials
- Record information about entities (actors) that interact with archival materials
- Record information about repositories that hold archival materials
- Record information that supports user interaction with the system
Each metadata requirement includes the following information:
Requirement number | MR-x.x.x (unique tracking number assigned to requirement) |
---|---|
Requirement name | Descriptive name assigned to requirement. |
Requirement specification | Brief description of requirement: what data must the system be able to capture? |
Sub-requirements | If the requirement is broken down into sub-requirements, provides links to these. |
Requirement quotation | Links to standards or other documents: why must the system capture this data? |
Associated functional requirements | Links to functional requirements: what functionality must the system have that requires this data? |
Associated quality requirements | Links to quality requirements: what design and interface features must the system have to capture this data well? |
Associated technical requirements | Links to technical requirements: what system architecture, hardware / software configurations, and programming rules must the system implement to capture this data? |
ICA-AtoM fields | List of the underlying ICA-AtoM database fields that capture the data. |
ICA-AtoM implementation | Brief description of how ICA-AtoM implements this metadata requirement. |
Known issues | Brief indication of known problems or limitations in the current version of ICA-AtoM that should be addressed in future releases. |
User Manual sections | Links to the User manual sections that provide step-by-step instructions for recording the data in ICA-AtoM. |
Record information about archival materials
Requirement number | MR-1 |
---|---|
Requirement name | Record information about archival materials |
Requirement specification | The system must:
|
Sub-requirements |
|
---
Identify units / objects of description
Requirement number | MR-1.1 |
---|---|
Requirement name | Identify units / objects of description |
Requirement specification | The system must be able to:
|
Sub-requirements |
---
Assign unique identifiers to units of description
Requirement number | MR-1.1.1 |
---|---|
Requirement name | Assign unique identifiers to units of description. |
Requirement specification | The system must be able to:
|
Requirement quotation | |
Associated functional requirements |
|
Associated quality requirements |
|
Associated technical requirements | |
ICA-AtoM fields |
|
ICA-AtoM implementation |
|
Known issues |
|
User Manual sections |
---
Register titles of units of description
Requirement number | MR-1.1.2 |
---|---|
Requirement name | Register titles of units of description |
Requirement specification | The system must be able to:
|
Requirement quotation | |
Associated functional requirements |
|
Associated quality requirements | |
Associated technical requirements | |
ICA-AtoM fields |
|
ICA-AtoM implementation |
|
Known issues |
|
User Manual sections |
---
Indicate the level of description
Requirement number | MR-1.1.3 |
---|---|
Requirement name | Indicate the level of description. |
Requirement specification | The system must be able to:
|
Requirement quotation | |
Associated functional requirements |
|
Associated quality requirements |
|
Associated technical requirements | |
ICA-AtoM fields | |
ICA-AtoM implementation |
|
Known issues |
|
User Manual sections |
---
Indicate the dates of the material described
Requirement number | 1.1.4 |
---|---|
Requirement name | Indicate the dates of the material described. |
Requirement specification | The system must be able to:
|
Requirement quotation | |
Associated functional requirements |
|
Associated quality requirements |
|
Associated technical requirements | |
ICA-AtoM fields | |
ICA-AtoM implementation |
|
Known issues |
|
User Manual sections |
---
Indicate the extent of the material described
Requirement number | MR-1.1.5 |
---|---|
Requirement name | Indicate the extent of the material described. |
Requirement specification | The system mus be able to:
|
Requirement quotation | |
Associated functional requirements |
|
Associated quality requirements |
|
Associated technical requirements | |
ICA-AtoM fields |
|
ICA-AtoM implementation |
|
Known issues |
|
User Manual sections |
Record information about the context of archival materials
Requirement number | MR-1.2 |
---|---|
Requirement name | Record information about the context of archival materials. |
Requirement specification | The system must be able to:
|
Sub-requirements |
---
Indicate the creator(s) of archival materials
Requirement number | MR-1.2.1 |
---|---|
Requirement name | Identify creator(s) of archival materials. |
Requirement specification | The system must be able to:
|
Requirement quotation | |
Associated functional requirements |
|
Associated quality requirements |
|
Associated technical requirements | |
ICA-AtoM fields |
|
ICA-AtoM implementation |
Users can registers as many creator events as required.
|
Known issues |
|
User Manual sections |
---
Describe the creator(s) of archival materials.
Requirement number | MR-1.2.2 |
---|---|
Requirement name | Describe the creator(s) of archival materials. |
Requirement specification | The system must be able to:
|
Requirement quotation | |
Associated functional requirements |
|
Associated quality requirements |
|
Associated technical requirements | |
ICA-AtoM fields |
|
ICA-AtoM implementation |
|
Known issues | |
User Manual sections |
---
Describe the custody of archival materials
Requirement number | MR-1.2.3 |
---|---|
Requirement name | Describe the custody of archival materials |
Requirement specification | The system must be able to:
|
Requirement quotation | |
Associated functional requirements |
|
Associated quality requirements |
|
Associated technical requirements | |
ICA-AtoM fields |
|
ICA-AtoM implementation |
|
Known issues |
|
User Manual sections |
---
Record information about the content and structure of archival materials
Requirement number | MR-1.3 |
---|---|
Requirement name | Record information about the content and structure of archival materials |
Requirement specification | The system must be able to:
|
Sub-requirements |
---
Describe the scope and content of archival materials
Requirement number | MR-1.3.1 |
---|---|
Requirement name | Describe the scope and content of archival materials. |
Requirement specification | The system must be able to:
|
Requirement quotation | |
Associated functional requirements |
|
Associated quality requirements | |
Associated technical requirements | |
ICA-AtoM fields |
information_object::scope_and_content |
ICA-AtoM implementation |
|
Known issues |
|
User Manual sections |
---
Describe the appraisal, destruction and scheduling of archival materials
Requirement number | MR-1.3.2 |
---|---|
Requirement name | Describe the appraisal, destruction and scheduling of archival materials |
Requirement specification | The system must be able to: |
Requirement quotation | |
Associated functional requirements | |
Associated quality requirements | |
Associated technical requirements | |
ICA-AtoM fields | |
ICA-AtoM implementation | |
Known issues | |
User Manual sections |
---
Indicate future accruals to archival materials
Requirement number | MR-1.3.3 |
---|---|
Requirement name | Indicate future accruals to archival materials. |
Requirement specification | The system must be able to: |
Requirement quotation | |
Associated functional requirements | |
Associated quality requirements | |
Associated technical requirements | |
ICA-AtoM fields | |
ICA-AtoM implementation | |
Known issues | |
User Manual sections |
---
Describe the system of arrangement of archival materials
Requirement number | MR-1.3.4 |
---|---|
Requirement name | Describe the system of arrangement of archival materials. |
Requirement specification | The system must be able to: |
Requirement quotation | |
Associated functional requirements | |
Associated quality requirements | |
Associated technical requirements | |
ICA-AtoM fields | |
ICA-AtoM implementation | |
Known issues | |
User Manual sections |
---
Record information about conditions of access and use of archival materials
Requirement number | MR-1.4 |
---|---|
Requirement name | Record information about abouts conditions of access and use of archival materials. |
Requirement specification | The system must:
|
Sub-requirements |
|
---
Indicate the conditions governing access to archival materials
Requirement number | MR-1.4.1 |
---|---|
Requirement name | Indicate the conditions governing access to archival materials. |
Requirement specification | The system must be able to: |
Requirement quotation | |
Associated functional requirements | |
Associated quality requirements | |
Associated technical requirements | |
ICA-AtoM fields | |
ICA-AtoM implementation | |
Known issues | |
User Manual sections |
---
Indicate the conditions governing reproduction of archival material
Requirement number | MR-1.4.2 |
---|---|
Requirement name | Indicate the conditions governing reproduction of archival material. |
Requirement specification | The system must be able to: |
Requirement quotation | |
Associated functional requirements | |
Associated quality requirements | |
Associated technical requirements | |
ICA-AtoM fields | |
ICA-AtoM implementation | |
Known issues | |
User Manual sections |
---
Indicate languages and scripts employed in archival materials
Requirement number | MR-1.4.3 |
---|---|
Requirement name | Indicate languages and scripts employed in archival materials. |
Requirement specification | The system must be able to: |
Requirement quotation | |
Associated functional requirements | |
Associated quality requirements | |
Associated technical requirements | |
ICA-AtoM fields | |
ICA-AtoM implementation | |
Known issues | |
User Manual sections |
---
Indicate physical characteristics and technical requirements affecting availability of archival materials
Requirement number | MR-1.4.4 |
---|---|
Requirement name | Indicate physical characteristics and technical requirements affecting availability of archival materials. |
Requirement specification | The system must be able to: |
Requirement quotation | |
Associated functional requirements | |
Associated quality requirements | |
Associated technical requirements | |
ICA-AtoM fields | |
ICA-AtoM implementation | |
Known issues | |
User Manual sections |
---
Indciate the existence of other finding aids to archival materials
Requirement number | MR-1.4.5 |
---|---|
Requirement name | Indciate the existence of other finding aids to archival materials. |
Requirement specification | The system must be able to: |
Requirement quotation | |
Associated functional requirements | |
Associated quality requirements | |
Associated technical requirements | |
ICA-AtoM fields | |
ICA-AtoM implementation | |
Known issues | |
User Manual sections |
---
Requirement number | MR-1.5 |
---|---|
Requirement name | Record information about materials related to the unit of description. |
Requirement specification | The system must:
|
Sub-requirements |
---
Indicate the location of the originals of the archival materials described
Requirement number | MR-1.5.1 |
---|---|
Requirement name | Indicate the location of the originals of the archival materials described. |
Requirement specification | The system must be able to: |
Requirement quotation | |
Associated functional requirements | |
Associated quality requirements | |
Associated technical requirements | |
ICA-AtoM fields | |
ICA-AtoM implementation | |
Known issues | |
User Manual sections |
---
Indicate the location of copies of the archival materials described
Requirement number | MR-1.5.2 |
---|---|
Requirement name | Indicate the location of copies of the archival materials described. |
Requirement specification | The system must be able to: |
Requirement quotation | |
Associated functional requirements | |
Associated quality requirements | |
Associated technical requirements | |
ICA-AtoM fields | |
ICA-AtoM implementation | |
Known issues | |
User Manual sections |
---
Requirement number | MR-1.5.3 |
---|---|
Requirement name | Indicate related archival materials in other units of description. |
Requirement specification | The system must be able to: |
Requirement quotation | |
Associated functional requirements | |
Associated quality requirements | |
Associated technical requirements | |
ICA-AtoM fields | |
ICA-AtoM implementation | |
Known issues | |
User Manual sections |
---
Requirement number | MR-1.5.4 |
---|---|
Requirement name | Indicate publications related to the archival materials described. |
Requirement specification | The system must be able to: |
Requirement quotation | |
Associated functional requirements | |
Associated quality requirements | |
Associated technical requirements | |
ICA-AtoM fields | |
ICA-AtoM implementation | |
Known issues | |
User Manual sections |
---
Record information about entities (actors) that interact with archival materials
Requirement number | MR-2 |
---|---|
Requirement name | Record information about entities (actors) that interact with archival materials. |
Requirement specification | The system must:
|
Sub-requirements |
---
Register actors that interact with archival materials
Requirement number | MR-1.1 |
---|---|
Requirement name | Register actors that interact with archival materials |
Requirement specification | The system must be able to: |
Sub-requirements |
---
Assign unique identifiers to actors
Requirement number | MR-2.1.1 |
---|---|
Requirement name | Assign unique identifiers to actors. |
Requirement specification | The system must be able to: |
Requirement quotation | |
Associated functional requirements | |
Associated quality requirements | |
Associated technical requirements | |
ICA-AtoM fields | |
ICA-AtoM implementation | |
Known issues | |
User Manual sections |
---
Register names of actors
Requirement number | MR-2.1.2 |
---|---|
Requirement name | Register names of actors. |
Requirement specification | The system must be able to: |
Requirement quotation | |
Associated functional requirements | |
Associated quality requirements | |
Associated technical requirements | |
ICA-AtoM fields | |
ICA-AtoM implementation | |
Known issues | |
User Manual sections |
---
Indicate the type of actor
Requirement number | MR-2.1.3 |
---|---|
Requirement name | Indicate the type of actor. |
Requirement specification | The system must be able to: |
Requirement quotation | |
Associated functional requirements | |
Associated quality requirements | |
Associated technical requirements | |
ICA-AtoM fields | |
ICA-AtoM implementation | |
Known issues | |
User Manual sections |
---
Indicate the dates of actors
Requirement number | MR-2.1.4 |
---|---|
Requirement name | Indicate the dates of actors. |
Requirement specification | The system must be able to: |
Requirement quotation | |
Associated functional requirements | |
Associated quality requirements | |
Associated technical requirements | |
ICA-AtoM fields | |
ICA-AtoM implementation | |
Known issues | |
User Manual sections |
---
Record infomation about the character and activities of actors
Requirement number | MR-2.2 |
---|---|
Requirement name | Record infomation about the character and activities of actors. |
Requirement specification | The system must be able to: |
Sub-requirements |
|
---
Describe the legal status of actors
Requirement number | MR-2.2.1 |
---|---|
Requirement name | Describe the legal status of actors. |
Requirement specification | The system must be able to: |
Requirement quotation | |
Associated functional requirements | |
Associated quality requirements | |
Associated technical requirements | |
ICA-AtoM fields | |
ICA-AtoM implementation | |
Known issues | |
User Manual sections |
---
Indicate the mandate or source of authority of actors
Requirement number | MR-2.2.2 |
---|---|
Requirement name | Indicate the mandate or source of authority of actors. |
Requirement specification | The system must be able to: |
Requirement quotation | |
Associated functional requirements | |
Associated quality requirements | |
Associated technical requirements | |
ICA-AtoM fields | |
ICA-AtoM implementation | |
Known issues | |
User Manual sections |
---
Describe the functions, occupations and activities of actors
Requirement number | MR-2.2.3 |
---|---|
Requirement name | Describe the functions, occupations and activities of actors. |
Requirement specification | The system must be able to: |
Requirement quotation | |
Associated functional requirements | |
Associated quality requirements | |
Associated technical requirements | |
ICA-AtoM fields | |
ICA-AtoM implementation | |
Known issues | |
User Manual sections |
---
Describe the internal structures or genealogy of actors
Requirement number | MR-2.2.4 |
---|---|
Requirement name | Describe the internal structures or genealogy of actors. |
Requirement specification | The system must be able to: |
Requirement quotation | |
Associated functional requirements | |
Associated quality requirements | |
Associated technical requirements | |
ICA-AtoM fields | |
ICA-AtoM implementation | |
Known issues | |
User Manual sections |
---
Indicate the geographical locations of actors
Requirement number | MR-2.2.5 |
---|---|
Requirement name | Indicate the geographical locations of actors. |
Requirement specification | The system must be able to: |
Requirement quotation | |
Associated functional requirements | |
Associated quality requirements | |
Associated technical requirements | |
ICA-AtoM fields | |
ICA-AtoM implementation | |
Known issues | |
User Manual sections |
---
Describe general context of actors
Requirement number | MR-2.2.6 |
---|---|
Requirement name | Describe the internal structures or genealogy of actors. |
Requirement specification | The system must be able to: |
Requirement quotation | |
Associated functional requirements | |
Associated quality requirements | |
Associated technical requirements | |
ICA-AtoM fields | |
ICA-AtoM implementation | |
Known issues | |
User Manual sections |
---
Record information about relationships between actors
Requirement number | MR-2.3 |
---|---|
Requirement name | Record information about relationships between actors. |
Requirement specification | The system must be able to: |
Sub-requirements |
---
Requirement number | MR-2.3.1 |
---|---|
Requirement name | Indicate the actors that are related. |
Requirement specification | The system must be able to: |
Requirement quotation | |
Associated functional requirements | |
Associated quality requirements | |
Associated technical requirements | |
ICA-AtoM fields | |
ICA-AtoM implementation | |
Known issues | |
User Manual sections |
---
Indicate the type and nature of relationship between actors
Requirement number | MR-2.3.2 |
---|---|
Requirement name | Indicate the type and nature of relationship between actors. |
Requirement specification | The system must be able to: |
Requirement quotation | |
Associated functional requirements | |
Associated quality requirements | |
Associated technical requirements | |
ICA-AtoM fields | |
ICA-AtoM implementation | |
Known issues | |
User Manual sections |
---
Indicate the dates of the relationship between actors
Requirement number | MR-2.3.3 |
---|---|
Requirement name | Indicate the dates of the relationship between actors. |
Requirement specification | The system must be able to: |
Requirement quotation | |
Associated functional requirements | |
Associated quality requirements | |
Associated technical requirements | |
ICA-AtoM fields | |
ICA-AtoM implementation | |
Known issues | |
User Manual sections |
---
Record information about relationships between actors and archival materials
Requirement number | MR-2.4 |
---|---|
Requirement name | Record information about relationships between actors and archival materials. |
Requirement specification | The system must be able to: |
Sub-requirements |
---
Requirement number | MR-2.4.1 |
---|---|
Requirement name | Indicate archival materials that are related to actors. |
Requirement specification | The system must be able to: |
Requirement quotation | |
Associated functional requirements | |
Associated quality requirements | |
Associated technical requirements | |
ICA-AtoM fields | |
ICA-AtoM implementation | |
Known issues | |
User Manual sections |
---
Indicate the type and nature of relationships to archival materials
Requirement number | MR-2.4.2 |
---|---|
Requirement name | Indicate the type and nature of relationships to archival materials. |
Requirement specification | The system must be able to: |
Requirement quotation | |
Associated functional requirements | |
Associated quality requirements | |
Associated technical requirements | |
ICA-AtoM fields | |
ICA-AtoM implementation | |
Known issues | |
User Manual sections |
---
Indicate the dates of relationships to archival materials
Requirement number | MR-2.4.3 |
---|---|
Requirement name | Indicate the dates of relationships to archival materials. |
Requirement specification | The system must be able to: |
Requirement quotation | |
Associated functional requirements | |
Associated quality requirements | |
Associated technical requirements | |
ICA-AtoM fields | |
ICA-AtoM implementation | |
Known issues | |
User Manual sections |
---
Template
Requirement number | Number |
---|---|
Requirement name | |
Requirement specification | The system must:
|
Requirement quotation | |
Associated functional requirements | |
Associated quality requirements |
|
Associated technical requirements |
|
ICA-AtoM fields |
|
ICA-AtoM implementation |
|
Known issues |
|
User Manual sections |
|
---