Difference between revisions of "Metadata requirements: archival descriptions"

From ICA-AtoM
Jump to navigation Jump to search
Line 128: Line 128:
  
 
<span id="MR-1.A.2"></span>
 
<span id="MR-1.A.2"></span>
 +
==== Name unit / object of description ====
  
=== Template ===
+
{| border="1" cellpadding="2"
 +
 
 +
|- valign="top" align="left" style="background:#00008B; color:white"
 +
!width="250" | Requirement number
 +
!width="700" | Number
 +
 
 +
|- valign="top" align="left"
 +
| style="background:silver" | Requirement name
 +
|
 +
 
 +
|- valign="top" align="left"
 +
| style="background:silver"  | Requirement specification
 +
| The system must:
 +
*Requirement.
 +
 
 +
|- valign="top" align="left"
 +
| style="background:silver" | Requirement quotation
 +
|
 +
 
 +
|- valign="top" align="left"
 +
| style="background:silver" | Associated functional requirements
 +
|
 +
 
 +
|- valign="top" align="left"
 +
| style="background:silver" | Associated quality requirements
 +
|
 +
 
 +
 
 +
|- valign="top" align="left"
 +
| style="background:silver" | Associated technical requirements
 +
|
 +
 
 +
 
 +
|- valign="top" align="left"
 +
| style="background:silver" | ICA-AtoM fields
 +
|
 +
 
 +
 
 +
|- valign="top" align="left"
 +
| style="background:silver" | ICA-AtoM implementation
 +
|
 +
 
 +
 
 +
|- valign="top" align="left"
 +
| style="background:silver" | Known issues
 +
|
 +
 
 +
 
 +
|- valign="top" align="left"
 +
| style="background:silver" | User Manual sections
 +
|
 +
 
 +
 
 +
|}
 +
 
 +
---
 +
 
 +
<span id="MR-1.A.3></span>
 +
==== Identify the level of description ====
 +
 
 +
{| border="1" cellpadding="2"
 +
 
 +
|- valign="top" align="left" style="background:#00008B; color:white"
 +
!width="250" | Requirement number
 +
!width="700" | Number
 +
 
 +
|- valign="top" align="left"
 +
| style="background:silver" | Requirement name
 +
|
 +
 
 +
|- valign="top" align="left"
 +
| style="background:silver"  | Requirement specification
 +
| The system must:
 +
*Requirement.
 +
 
 +
|- valign="top" align="left"
 +
| style="background:silver" | Requirement quotation
 +
|
 +
 
 +
|- valign="top" align="left"
 +
| style="background:silver" | Associated functional requirements
 +
|
 +
 
 +
|- valign="top" align="left"
 +
| style="background:silver" | Associated quality requirements
 +
|
 +
 
 +
 
 +
|- valign="top" align="left"
 +
| style="background:silver" | Associated technical requirements
 +
|
 +
 
 +
 
 +
|- valign="top" align="left"
 +
| style="background:silver" | ICA-AtoM fields
 +
|
 +
 
 +
 
 +
|- valign="top" align="left"
 +
| style="background:silver" | ICA-AtoM implementation
 +
|
 +
 
 +
 
 +
|- valign="top" align="left"
 +
| style="background:silver" | Known issues
 +
|
 +
 
 +
 
 +
|- valign="top" align="left"
 +
| style="background:silver" | User Manual sections
 +
|
 +
 
 +
 
 +
|}
 +
 
 +
---
 +
 
 +
<span id="MR-1.A.4></span>
 +
==== Indicate the dates of the material described ====
 +
 
 +
{| border="1" cellpadding="2"
 +
 
 +
|- valign="top" align="left" style="background:#00008B; color:white"
 +
!width="250" | Requirement number
 +
!width="700" | Number
 +
 
 +
|- valign="top" align="left"
 +
| style="background:silver" | Requirement name
 +
|
 +
 
 +
|- valign="top" align="left"
 +
| style="background:silver"  | Requirement specification
 +
| The system must:
 +
*Requirement.
 +
 
 +
|- valign="top" align="left"
 +
| style="background:silver" | Requirement quotation
 +
|
 +
 
 +
|- valign="top" align="left"
 +
| style="background:silver" | Associated functional requirements
 +
|
 +
 
 +
|- valign="top" align="left"
 +
| style="background:silver" | Associated quality requirements
 +
|
 +
 
 +
 
 +
|- valign="top" align="left"
 +
| style="background:silver" | Associated technical requirements
 +
|
 +
 
 +
 
 +
|- valign="top" align="left"
 +
| style="background:silver" | ICA-AtoM fields
 +
|
 +
 
 +
 
 +
|- valign="top" align="left"
 +
| style="background:silver" | ICA-AtoM implementation
 +
|
 +
 
 +
 
 +
|- valign="top" align="left"
 +
| style="background:silver" | Known issues
 +
|
 +
 
 +
 
 +
|- valign="top" align="left"
 +
| style="background:silver" | User Manual sections
 +
|
 +
 
 +
 
 +
|}
 +
 
 +
---
 +
 
 +
<span id="MR-1.A.5"></span>
 +
==== Indicate the extent of the material described ====
 +
 
 +
{| border="1" cellpadding="2"
 +
 
 +
|- valign="top" align="left" style="background:#00008B; color:white"
 +
!width="250" | Requirement number
 +
!width="700" | Number
 +
 
 +
|- valign="top" align="left"
 +
| style="background:silver" | Requirement name
 +
|
 +
 
 +
|- valign="top" align="left"
 +
| style="background:silver"  | Requirement specification
 +
| The system must:
 +
*Requirement.
 +
 
 +
|- valign="top" align="left"
 +
| style="background:silver" | Requirement quotation
 +
|
 +
 
 +
|- valign="top" align="left"
 +
| style="background:silver" | Associated functional requirements
 +
|
 +
 
 +
|- valign="top" align="left"
 +
| style="background:silver" | Associated quality requirements
 +
|
 +
 
 +
 
 +
|- valign="top" align="left"
 +
| style="background:silver" | Associated technical requirements
 +
|
 +
 
 +
 
 +
|- valign="top" align="left"
 +
| style="background:silver" | ICA-AtoM fields
 +
|
 +
 
 +
 
 +
|- valign="top" align="left"
 +
| style="background:silver" | ICA-AtoM implementation
 +
|
 +
 
 +
 
 +
|- valign="top" align="left"
 +
| style="background:silver" | Known issues
 +
|
 +
 
 +
 
 +
|- valign="top" align="left"
 +
| style="background:silver" | User Manual sections
 +
|
 +
 
 +
 
 +
|}
 +
 
 +
---
 +
 
 +
---
 +
 
 +
Template
  
 
{| border="1" cellpadding="2"
 
{| border="1" cellpadding="2"

Revision as of 19:51, 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.A
Requirement name Identify unit / object of description
Requirement specification The system must:
  • Uniquely identify each description.
Sub-requirements
  • 1.A.1 Identify unit / object of description.
  • 1.A.2 Name unit / object of description.
  • 1.A.3 Identify the level of description.
  • 1.A.4 Indicate the dates of the material described.
  • 1.A.5 Indicate the extent of the material described.

---

Identify unit / object of description

Requirement number MR-1.A.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 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


---

Identify the level of description

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 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


---