Difference between revisions of "Metadata requirements: archival descriptions"

From ICA-AtoM
Jump to navigation Jump to search
Line 199: Line 199:
 
---
 
---
  
<span id="MR-1.A.3></span>
+
<span id="MR-1.1.3></span>
 
 
 
==== Identify the level of description ====
 
==== Identify the level of description ====
  
Line 207: Line 206:
 
|- valign="top" align="left" style="background:#00008B; color:white"
 
|- valign="top" align="left" style="background:#00008B; color:white"
 
!width="250" | Requirement number
 
!width="250" | Requirement number
!width="700" | Number
+
!width="700" | MR-1.1.3
  
 
|- valign="top" align="left"
 
|- valign="top" align="left"
 
| style="background:silver" | Requirement name
 
| style="background:silver" | Requirement name
|  
+
| Identify the level of description.
  
 
|- valign="top" align="left"
 
|- valign="top" align="left"
 
| style="background:silver"  | Requirement specification
 
| style="background:silver"  | Requirement specification
 
| The system must:
 
| The system must:
*Requirement.
+
*Identify the level in the hierarchy of arrangement and description to which to the current description applies.
 +
*Link the current description to related description within the same hierarchy.
  
 
|- valign="top" align="left"
 
|- valign="top" align="left"
 
| style="background:silver" | Requirement quotation
 
| style="background:silver" | Requirement quotation
 
|
 
|
 +
*[[ISAD(G)#ISAD3.1.4 | ISAD(G) 3.1.4
  
 
|- valign="top" align="left"
 
|- valign="top" align="left"
 
| style="background:silver" | Associated functional requirements
 
| style="background:silver" | Associated functional requirements
 
|
 
|
 +
*FR-1.1, Support multi-level description.
 +
*FR-4.4, Ensure that infromation at higher and lower levels of description are consistent.
  
 
|- valign="top" align="left"
 
|- valign="top" align="left"
 
| style="background:silver" | Associated quality requirements
 
| style="background:silver" | Associated quality requirements
 
|
 
|
 
+
*Provide drop-down value list menus.
 +
*Provide context-specific pick lists.
  
 
|- valign="top" align="left"
 
|- valign="top" align="left"
Line 244: Line 248:
 
| style="background:silver" | ICA-AtoM implementation
 
| style="background:silver" | ICA-AtoM implementation
 
|  
 
|  
 +
*ICA-AtoM includes the <span class="field">Level of description</span> field with a drop-down list for selecting values. Value list can be customized by the system administrator to include only levels employed by the institution. The value themselves reside in a separate database table (<span class="button">term</span>).
  
 +
*ICA-AtoM links the current description with others in the hierarchy of arrangement through the <span class="field">Next upper level of description</span> field in which the user selects the "parent" description; leave field blank if the description represents the highest level.
  
 
|- valign="top" align="left"
 
|- valign="top" align="left"
 
| style="background:silver" | Known issues
 
| style="background:silver" | Known issues
 
|  
 
|  
 
+
*Need to be able to filter drop-down list in <span class="field">Next upper level of description</span> so that it is more manageable.
  
 
|- valign="top" align="left"
 
|- valign="top" align="left"
 
| style="background:silver" | User Manual sections
 
| style="background:silver" | User Manual sections
 
|  
 
|  
 
+
*[[Add / edit content#ISADIdentity | Add / edit content  > Add / edit archival descriptions > Identity area]]
  
 
|}
 
|}

Revision as of 20:12, 24 January 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 > Archival descriptions

Describe units of archival materials

Requirement number MR-1
Requirement name Describe units of archival materials
Requirement specification The system must:
  • Include an entity representing an archival description.
Sub-requirements
  • 1.A Identify unit / object of description.
  • 1.B Describe the context (origin and custody) of material.
  • 1.C Describe content and structure of material.
  • 1.D Describe conditions governing access and use of material.
  • 1.E Identify related archvial materials.
  • 1.F Control description record.

---

Identify unit / object of description

Requirement number MR-1.1
Requirement name Identify unit / object of description
Requirement specification The system must:
  • Uniquely identify each description.
Sub-requirements
  • 1.1.1 Identify unit / object of description.
  • 1.1.2 Name unit / object of description.
  • 1.1.3 Identify the level of description.
  • 1.1.4 Indicate the dates of the material described.
  • 1.1.5 Indicate the extent of the material described.

---

Identify unit / object of description

Requirement number MR-1.1.1
Requirement name Identify unit / object of description
Requirement specification The system must:
  • Assign one or more unique identifier (codes) to each description such that the description can be linked to the object of description.
Requirement quotation
Associated functional requirements
  • FR-3.B, Assign unique identifiers to descriptions.
Associated quality requirements
  • Auto-enter values.
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
  • Cannot currently auto-generate next sequential reference code / number.
User Manual sections

---

Name unit / object of description

Requirement number MR-1.1.2
Requirement name Name unit / object of description
Requirement specification The system must:
  • Assign titles to archival descriptions.
  • Accommodate multiple titles (variants, title changes).
  • Support explanatory notes on titles.
Requirement quotation
Associated functional requirements
  • FR-3.2, Assign unique identifiers to descriptions.
  • FR-4.1, Support description of the intellectual and physical characteristics of archival materials.
Associated quality requirements
Associated technical requirements
ICA-AtoM fields
  • information_object::title
  • information_object::alternate_title
  • note::note_content
  • note::note_type
ICA-AtoM implementation
  • ICA-AtoM includes fields for Title (title) and Alternate title (alternate_title).
  • ICA-AtoM does not impose any rules on formatting titles.
  • Users can add as many Title notes as required (stored in a separate *note database table).
Known issues
  • Need to allow multiple alternate titles (currently only allows 1 alternate).
  • Need to allow assignment of date ranges to titles for previous names of descriptive unit.
User Manual sections

---

Identify the level of description

Requirement number MR-1.1.3
Requirement name Identify the level of description.
Requirement specification The system must:
  • Identify the level in the hierarchy of arrangement and description to which to the current description applies.
  • Link the current description to related description within the same hierarchy.
Requirement quotation
  • [[ISAD(G)#ISAD3.1.4 | ISAD(G) 3.1.4
Associated functional requirements
  • FR-1.1, Support multi-level description.
  • FR-4.4, Ensure that infromation at higher and lower levels of description are consistent.
Associated quality requirements
  • Provide drop-down value list menus.
  • Provide context-specific pick lists.
Associated technical requirements


ICA-AtoM fields


ICA-AtoM implementation
  • ICA-AtoM includes the Level of description field with a drop-down list for selecting values. Value list can be customized by the system administrator to include only levels employed by the institution. The value themselves reside in a separate database table (term).
  • ICA-AtoM links the current description with others in the hierarchy of arrangement through the Next upper level of description field in which the user selects the "parent" description; leave field blank if the description represents the highest level.
Known issues
  • Need to be able to filter drop-down list in Next upper level of description so that it is more manageable.
User Manual sections

---

Indicate the dates of the material described

Requirement number Number
Requirement name
Requirement specification The system must:
  • Requirement.
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 Number
Requirement name
Requirement specification The system must:
  • Requirement.
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.
Requirement quotation
Associated functional requirements
Associated quality requirements


Associated technical requirements


ICA-AtoM fields


ICA-AtoM implementation


Known issues


User Manual sections


---