Difference between revisions of "Metadata requirements: archival descriptions"

From ICA-AtoM
Jump to navigation Jump to search
(Removing all content from page)
 
(19 intermediate revisions by the same user not shown)
Line 1: Line 1:
[[Main page]] > [[System Requirements]] > [[Metadata requirements]] > Archival descriptions
 
  
== Describe units of archival materials ==
 
 
{| border="1" cellpadding="2"
 
 
|- valign="top" align="left" style="background:#00008B; color:white"
 
!width="250" | Requirement number
 
!width="700" | MR-1
 
 
|- valign="top" align="left"
 
| style="background:silver" | Requirement name
 
| Describe units of archival materials
 
 
|- valign="top" align="left"
 
| style="background:silver"  | Requirement specification
 
| The system must:
 
*Include an entity representing an archival description.
 
 
|- valign="top" align="left"
 
| style="background:silver" | 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.
 
 
|}
 
 
---
 
 
<span id="MR-1.1"></span>
 
=== Identify unit / object of description ===
 
 
{| border="1" cellpadding="2"
 
 
|- valign="top" align="left" style="background:#00008B; color:white"
 
!width="250" | Requirement number
 
!width="700" | MR-1.1
 
 
|- valign="top" align="left"
 
| style="background:silver" | Requirement name
 
| Identify unit / object of description
 
 
|- valign="top" align="left"
 
| style="background:silver"  | Requirement specification
 
| The system must:
 
*Uniquely identify each description.
 
 
|- valign="top" align="left"
 
| style="background:silver" | 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.
 
 
|}
 
 
---
 
 
<span id="MR-1.1.1"></span>
 
==== Identify unit / object of description ====
 
 
{| border="1" cellpadding="2"
 
 
|- valign="top" align="left" style="background:#00008B; color:white"
 
!width="250" | Requirement number
 
!width="700" | MR-1.1.1
 
 
|- valign="top" align="left"
 
| style="background:silver" | Requirement name
 
| Identify unit / object of description
 
 
|- valign="top" align="left"
 
| style="background:silver"  | 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.
 
 
|- valign="top" align="left"
 
| style="background:silver" | Requirement quotation
 
|
 
*[[ISAD(G)#isad3.1.1 | ISAD(G) 3.1.1]]
 
 
|- valign="top" align="left"
 
| style="background:silver" | Associated functional requirements
 
|
 
*FR-3.B, Assign unique identifiers to descriptions.
 
 
|- valign="top" align="left"
 
| style="background:silver" | Associated quality requirements
 
|
 
*Auto-enter values.
 
 
|- valign="top" align="left"
 
| style="background:silver" | Associated technical requirements
 
|
 
 
|- valign="top" align="left"
 
| style="background:silver" | ICA-AtoM fields
 
|
 
*<span class="button">information_object::id</span>
 
*<span class="button">information_object:identifier</span>
 
 
|- valign="top" align="left"
 
| style="background:silver" | ICA-AtoM implementation
 
|
 
*ICA-AtoM automatically assigns each record a unqiue database ID (<span class="button">id</span>); this value is invisible to users.
 
 
*Users enter their own <span class="field">Reference code</span> (<span class="button>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"
 
| style="background:silver" | Known issues
 
|
 
*Cannot currently auto-generate next sequential reference code / number.
 
 
|- valign="top" align="left"
 
| style="background:silver" | User Manual sections
 
|
 
*[[Add / edit content#ISADIdentity | Add / edit content  > Add / edit archival descriptions > Identity area]]
 
 
|}
 
 
---
 
 
<span id="MR-1.1.2"></span>
 
==== Name unit / object of description ====
 
 
{| border="1" cellpadding="2"
 
 
|- valign="top" align="left" style="background:#00008B; color:white"
 
!width="250" | Requirement number
 
!width="700" | MR-1.1.2
 
 
|- valign="top" align="left"
 
| style="background:silver" | Requirement name
 
| Name unit / object of description
 
 
|- valign="top" align="left"
 
| style="background:silver"  | Requirement specification
 
| The system must:
 
*Assign titles to archival descriptions.
 
*Accommodate multiple titles (variants, title changes).
 
*Support explanatory notes on titles.
 
 
|- valign="top" align="left"
 
| style="background:silver" | Requirement quotation
 
|
 
*[[ISAD(G)#isad3.1.2 | ISAD(G) 3.1.2]]
 
 
|- valign="top" align="left"
 
| style="background:silver" | 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.
 
 
|- 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
 
|
 
*<span class="button">information_object::title</span>
 
*<span class="button">information_object::alternate_title</span>
 
*<span class="button">note::note_content</span>
 
*<span class="button">note::note_type</span>
 
 
|- valign="top" align="left"
 
| style="background:silver" | ICA-AtoM implementation
 
|
 
*ICA-AtoM includes fields for <span class="field">Title</span> (<span class="button">title</span>) and <span class="field">Alternate title</span> (<span class="button">alternate_title</span>).
 
 
*ICA-AtoM does not impose any rules on formatting titles.
 
 
*Users can add as many <span class="field">Title notes</span> as required (stored in a separate *<span class="button">note</span> database table).
 
 
|- valign="top" align="left"
 
| style="background:silver" | 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.
 
 
|- valign="top" align="left"
 
| style="background:silver" | User Manual sections
 
|
 
*[[Add / edit content#ISADIdentity | Add / edit content  > Add / edit archival descriptions > Identity area]]
 
 
|}
 
 
---
 
 
<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"
 
 
|- 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
 
|
 
 
 
|}
 
 
---
 

Latest revision as of 17:04, 25 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.