Difference between revisions of "MTD-1.1.1"

From ICA-AtoM
Jump to navigation Jump to search
 
 
(7 intermediate revisions by the same user not shown)
Line 1: Line 1:
[[Main Page]] > [[System Requirements]] > [[Metadata requirements]] > [[MTD-1 | MTD-1 Record information about archival materials]] > [[MTD-1.1 | MTD-1.1 Register units of description]] > MTD-1.1.1 Assign unique identifiers to a description
+
[[Main Page]] > [[System Requirements]] > [[Metadata requirements]]
 +
*[[MTD-1 | MTD-1 Record information about archival materials]]
 +
**[[MTD-1.1 | MTD-1.1 Register units of description]]
 +
***MTD-1.1.1 Assign unique identifiers to a description
 +
 
  
 
== Assign unique identifiers to a description ==
 
== Assign unique identifiers to a description ==
Line 16: Line 20:
 
| style="background:silver"  | Requirement specification
 
| style="background:silver"  | Requirement specification
 
|  
 
|  
The application must assign one or more unique identifiers (codes) to descriptions. In a multi-repository system (network), the identifier should include include components that uniquely identify the institution that is responsible for the description and its country of origin.
+
The application must be able to:
 
+
*Assign one or more unique identifiers (codes) to descriptions.
|- valign="top" align="left"
+
*Include in the identifier components that represent the institution that is responsible for the description and its country of origin.
| style="background:silver" | Context (parent requirements)
 
|
 
[[MTD-1 | MTD-1 Record information about archival materials]]
 
 
 
[[MTD-1.1 | MTD-1.1 Register units of description]]
 
  
 
|- valign="top" align="left"
 
|- valign="top" align="left"
 
| style="background:silver" | Source quotation
 
| style="background:silver" | Source quotation
 
|  
 
|  
[[ISAD(G)#isad3.1.1 | ISAD(G) 3.1.1]]
+
*[[ISAD(G)#isad3.1.1 | ISAD(G) 3.1.1]]
 
+
*[[OSARIS#osaris | OSARIS ]]
[[OSARIS#osaris | OSARIS ]]
 
  
 
|- valign="top" align="left"
 
|- valign="top" align="left"
 
| style="background:silver" | Associated functional requirements
 
| style="background:silver" | Associated functional requirements
 
|  
 
|  
[[FNC-2.5.1 | FNC-2.5.1 Identify units of description]]
+
*[[FNC-2.5.1 | FNC-2.5.1 Identify units of description]]
  
 
|- valign="top" align="left"
 
|- valign="top" align="left"
 
| style="background:silver" | Associated quality requirements
 
| style="background:silver" | Associated quality requirements
 
|  
 
|  
Separate database IDs (automatically generated by the application and hidden from user) and reference codes (assigned by the archivist and meaningful to users).
+
The application should be able to:
 +
 
 +
*Keep database IDs (automatically generated by the application and hidden from user) separate from reference codes (assigned by the archivist and meaningful to users).
  
Support auto-entry of next available reference code upon record creation.
+
*Support auto-entry of next available reference code upon record creation.
  
Automatically concantenate repository's institution and country identifiers with the description reference code to generate a unique identifier in a multi-repository system (user should not have to manually key institution and country codes).
+
*Automatically concantenate a repository's institution and country identifiers with the description reference code to ensure unique identifiers in a multi-repository system (user should not have to manually enter institution and country codes).
  
 
|- valign="top" align="left"
 
|- valign="top" align="left"
Line 53: Line 53:
 
| style="background:silver" | ICA-AtoM fields
 
| style="background:silver" | ICA-AtoM fields
 
|  
 
|  
<span class="dbElement">information_object::id</span>
+
*<span class="dbElement">information_object::id</span>
<span class="dbElement">information_object::identifier</span>
+
*<span class="dbElement">information_object::identifier</span>
  
 
|- valign="top" align="left"
 
|- valign="top" align="left"
 
| style="background:silver" | ICA-AtoM implementation
 
| style="background:silver" | ICA-AtoM implementation
 
|  
 
|  
ICA-AtoM automatically assigns each record a unqiue database ID (<span class="dbElement">id</span>); this value is invisible to users.
+
*ICA-AtoM automatically assigns each record a unqiue database ID (<span class="dbElement">id</span>); this value is invisible to users.
  
Users enter their own <span class="field">Reference code</span> (<span class="dbElement">identifier</span>). ICA-AtoM allows any type of value in this field (numbers, text, alpha-numeric code) to accommodate any institutional system for assigning identifiers.
+
*Users enter their own <span class="field">Reference code</span> (<span class="dbElement">identifier</span>). ICA-AtoM allows any type of value in this field (numbers, text, alpha-numeric code) to accommodate any institutional system for assigning identifiers.
  
 
|- valign="top" align="left"
 
|- valign="top" align="left"
 
| style="background:silver" | Known issues
 
| style="background:silver" | Known issues
 
|  
 
|  
ICA-AtoM (v0.6) cannot currently auto-generate next sequential reference code / number.
+
*ICA-AtoM (v0.6) cannot currently auto-generate next sequential reference code / number.
  
 
|- valign="top" align="left"
 
|- valign="top" align="left"
 
| style="background:silver" | Use cases
 
| style="background:silver" | Use cases
 
|  
 
|  
[[USC- | USC- ]]
 
  
 
|- valign="top" align="left"
 
|- valign="top" align="left"
 
| style="background:silver" | User Manual sections
 
| style="background:silver" | User Manual sections
 
|  
 
|  
[[Add / edit content]] >
+
*[[Add / edit archival descriptions#Identity area | Add / edit content > Archival descriptions > Edit screen (data entry) > Identity area]]
 
 
[[Add / edit content#Add / edit archival descriptions | Add / edit archival descriptions]] >  
 
 
 
[[Add / edit content#Identity area || Identity area]], step 1.
 
  
 
|}
 
|}

Latest revision as of 17:30, 5 May 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


Assign unique identifiers to a description

Requirement number MTD-1.1.1
Requirement name Assign unique identifiers to a description.
Requirement specification

The application must be able to:

  • Assign one or more unique identifiers (codes) to descriptions.
  • Include in the identifier components that represent the institution that is responsible for the description and its country of origin.
Source quotation
Associated functional requirements
Associated quality requirements

The application should be able to:

  • Keep database IDs (automatically generated by the application and hidden from user) separate from reference codes (assigned by the archivist and meaningful to users).
  • Support auto-entry of next available reference code upon record creation.
  • Automatically concantenate a repository's institution and country identifiers with the description reference code to ensure unique identifiers in a multi-repository system (user should not have to manually enter institution and country codes).
Associated technical requirements
ICA-AtoM fields
  • information_object::id
  • information_object::identifier
ICA-AtoM implementation
  • ICA-AtoM automatically assigns each record a unqiue database ID (id); this value is invisible to users.
  • Users enter their own Reference code (identifier). ICA-AtoM allows any type of value in this field (numbers, text, alpha-numeric code) to accommodate any institutional system for assigning identifiers.
Known issues
  • ICA-AtoM (v0.6) cannot currently auto-generate next sequential reference code / number.
Use cases
User Manual sections