Difference between revisions of "Metadata requirements: archival descriptions"

From ICA-AtoM
Jump to navigation Jump to search
(Removing all content from page)
 
(9 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.1 Identify unit / object of description.
 
−
*1.2 Describe the context (origin and custody) of material.
 
−
*1.3 Describe content and structure of material.
 
−
*1.4 Describe conditions governing access and use of material.
 
−
*1.5 Identify related archvial materials.
 
−
*1.6 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.1.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" | MR-1.1.3
 
−
 
−
|- valign="top" align="left"
 
−
| style="background:silver" | Requirement name
 
−
| Identify the level of description.
 
−
 
−
|- valign="top" align="left"
 
−
| style="background:silver"  | 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.
 
−
 
−
|- valign="top" align="left"
 
−
| style="background:silver" | Requirement quotation
 
−
|
 
−
*[[ISAD(G)#ISAD3.1.4 | ISAD(G) 3.1.4
 
−
 
−
|- valign="top" align="left"
 
−
| 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"
 
−
| style="background:silver" | Associated quality requirements
 
−
|
 
−
*Provide drop-down value list menus.
 
−
*Provide context-specific pick lists.
 
−
 
−
|- 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
 
−
|
 
−
*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"
 
−
| 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"
 
−
| style="background:silver" | User Manual sections
 
−
|
 
−
*[[Add / edit content#ISADIdentity | Add / edit content  > Add / edit archival descriptions > Identity area]]
 
−
 
−
|}
 
−
 
−
---
 
−
 
−
<span id="MR-1.1.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" | 1.1.4
 
−
 
−
|- valign="top" align="left"
 
−
| style="background:silver" | Requirement name
 
−
| Indicate the dates of the material described.
 
−
 
−
|- valign="top" align="left"
 
−
| style="background:silver"  | Requirement specification
 
−
| The system must:
 
−
*Indicate the earliest and latest dates of the material described.
 
−
 
−
*Support multiple date types (date of creation vs date of accumulation).
 
−
 
−
|- valign="top" align="left"
 
−
| style="background:silver" | Requirement quotation
 
−
|
 
−
*[[ISAD(G)#isad3.1.3 | ISAD(G) 3.1.3 ]]
 
−
 
−
|- valign="top" align="left"
 
−
| style="background:silver" | Associated functional requirements
 
−
|
 
−
*FR-4.1, Support the description of the intellectual and physical characteristics of archival material.
 
−
 
−
*FR-4.4, Ensure that information at the higher and lower levels are consistent.
 
−
 
−
|- valign="top" align="left"
 
−
| style="background:silver" | Associated quality requirements
 
−
|
 
−
*Support multiple date formats.
 
−
 
−
*Calculate values at higher levels from data entered at lower levels.
 
−
 
−
|- 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
 
−
|
 
−
*ICA-AtoM handles mutliple dates through the <span class="button">event</span> table, linking a description to a creator over a specifc date range.
 
−
 
−
*Users register dates through the <span class="field">Creation context</span> fields in the <span class="area">ContextArea</span> and can enter as many dates as required.
 
−
 
−
*Users enter separate data for <span class="field">Creation year</span> and <span class="field">End year</span>; these are number fields used behind the scenes for searching and sorting.
 
−
 
−
*Users also enter the date range as a single text string in the <span class="field">Date display</span> field; here they can records dates in any format and apply any terms or typographic conventions to the qualify the dates (e.g. "March 1975"; "ca 1967-1968";  "[ 198?]"; "predominant dates: 1980-1995").
 
−
 
−
|- valign="top" align="left"
 
−
| style="background:silver" | Known issues
 
−
|
 
−
*<span class="field">Date display</span> should automatically default to the the <span class="field">Creation year</span> and the <span class="field">End year</span> so that the user need only modify this field if either of these dates requires qualification.
 
−
 
−
*ICA-AtoM does not enable higher levels to "calculate up" date ranges from lower levels (e.g. set dates at fonds level from related lower-level descriptions); nor does it enforce consistency between levels.
 
−
 
−
|- valign="top" align="left"
 
−
| style="background:silver" | User Manual sections
 
−
|
 
−
*[[Add / edit content#ISADContext | Add / edit content  > Add / edit archival descriptions > Context area]]
 
−
 
−
|}
 
−
 
−
---
 
−
 
−
<span id="MR-1.1.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" | MR-1.1.5
 
−
 
−
|- valign="top" align="left"
 
−
| style="background:silver" | Requirement name
 
−
| Indicate the extent of the material described.
 
−
 
−
|- valign="top" align="left"
 
−
| style="background:silver"  | Requirement specification
 
−
| The system must:
 
−
*Identify the logical or physical extent of the object.
 
−
*Describe the medium of the object.
 
−
 
−
|- valign="top" align="left"
 
−
| style="background:silver" | Requirement quotation
 
−
|
 
−
*[[ISAD(G)#isad3.1.5 | ISAD(G) 3.1.5]]
 
−
 
−
|- valign="top" align="left"
 
−
| style="background:silver" | Associated functional requirements
 
−
|
 
−
*FR-4.1 Support the description of the intellectual and physical characteristics of archival material.
 
−
 
−
*FR-4.4, Ensure that information at the higher and lower levels are consistent.
 
−
 
−
|- valign="top" align="left"
 
−
| style="background:silver" | Associated quality requirements
 
−
|
 
−
*Provide controlled vocabulary for media terms.
 
−
 
−
|- valign="top" align="left"
 
−
| style="background:silver" | Associated technical requirements
 
−
|
 
−
 
−
|- valign="top" align="left"
 
−
| style="background:silver" | ICA-AtoM fields
 
−
|
 
−
*<span class="area">information_object::extent_and_medium</span>
 
−
 
−
|- valign="top" align="left"
 
−
| style="background:silver" | ICA-AtoM implementation
 
−
|
 
−
*ICA-AtoM provides a text field for <span class="field">Extent and medium</span>.
 
−
 
−
|- valign="top" align="left"
 
−
| style="background:silver" | Known issues
 
−
|
 
−
*No support for drop-down lists for media types.
 
−
 
−
*ICA-AtoM does not enable higher levels to "calculate up" extents from lower levels (e.g. set dates at fonds level from related lower-level descriptions); nor does it enforce consistency between levels.
 
−
 
−
|- 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.2"></span>
 
−
=== Describe context of archival materials ===
 
−
 
−
{| border="1" cellpadding="2"
 
−
 
−
|- valign="top" align="left" style="background:#00008B; color:white"
 
−
!width="250" | Requirement number
 
−
!width="700" | MR-1.2
 
−
 
−
|- valign="top" align="left"
 
−
| style="background:silver" | Requirement name
 
−
| Describe context of archival materials.
 
−
 
−
|- valign="top" align="left"
 
−
| style="background:silver"  | Requirement specification
 
−
| The system must:
 
−
*Indicate the origins and custody of the archival materials being described.
 
−
 
−
|- valign="top" align="left"
 
−
| style="background:silver" | Sub-requirements
 
−
|
 
−
*1.2.1 Identify creator(s) of archival materials.
 
−
*1.2.2 Describe creator(s) of archival materials.
 
−
*1.2.3 Describe history of custody of archival materials.
 
−
 
−
|}
 
−
 
−
---
 
−
 
−
<span id="MR-1.2.1></span>
 
−
==== Identify creator(s) of archival materials ====
 
−
 
−
 
−
{| border="1" cellpadding="2"
 
−
 
−
|- valign="top" align="left" style="background:#00008B; color:white"
 
−
!width="250" | Requirement number
 
−
!width="700" | MR-1.2.1
 
−
 
−
|- valign="top" align="left"
 
−
| style="background:silver" | Identify creator(s) of archival materials.
 
−
|
 
−
 
−
|- valign="top" align="left"
 
−
| style="background:silver"  | Requirement specification
 
−
| The system must:
 
−
*Record the name of the the entity or entities responsible for the creation, accumulation, and maintenance of the material being described.
 
−
 
−
*Accommodate institutions that allow for multiple creators (e.g. in a series system approach linking a single series to different agencies at different times).
 
−
 
−
|- valign="top" align="left"
 
−
| style="background:silver" | Requirement quotation
 
−
|
 
−
*[[ISAD(G)#isad3.2.1 | ISAD(G) 3.2.1]]
 
−
 
−
|- valign="top" align="left"
 
−
| style="background:silver" | Associated functional requirements
 
−
|
 
−
*FR-4.2, Support the description of the context of archival materials.
 
−
 
−
|- valign="top" align="left"
 
−
| style="background:silver" | Associated quality requirements
 
−
|
 
−
*Provide controlled vocabulary drop-down lists (names).
 
−
 
−
|- valign="top" align="left"
 
−
| style="background:silver" | Associated technical requirements
 
−
|
 
−
 
−
|- valign="top" align="left"
 
−
| style="background:silver" | ICA-AtoM fields
 
−
|
 
−
*<span class="table">event::actor_id</span>.
 
−
 
−
|- valign="top" align="left"
 
−
| style="background:silver" | ICA-AtoM implementation
 
−
|
 
−
*ICA-AtoM links creators to archival materials via the <span class="table">event</span> table which registers the creation of archival material as "event" that occurs over a certain date range.
 
−
 
−
*Users select / enter a name in the <span class="field">Creator</span> field.
 
−
 
−
*Users enter the outside years in the <span class="field">Creation year</span> and <span class="field">End year</span> fields; these are number field used behind the scenes for sorting and searching.
 
−
 
−
*Users also enter  the date range as a single text string in the <span class="field">Date display</span> field; here they can apply any terms or typographic conventions to the qualify the dates (e.g. "ca 1967-1968",  "[ 198?]", "predominant dates: 1980-1995").
 
−
Users can registers as many creator events as required.
 
−
 
−
*ICA-AtoM provides a drop-down list in the <span class="field">Creator</span> field, showing names generated from the <span class="table">actor</span> authority file.
 
−
 
−
*If the required name does not appear in the list, users can directly enter the name and ICA-AtoM registers it in the <span class="table">actor</span> authority file.
 
−
 
−
|- valign="top" align="left"
 
−
| style="background:silver" | Known issues
 
−
|
 
−
*The drop-down list of names shows only the authorized headings and does not include variants (e.g. shows "Dr. Koenraad Kuiper" but not "Kuiper, Koenraad").
 
−
 
−
|- valign="top" align="left"
 
−
| style="background:silver" | User Manual sections
 
−
|
 
−
*[[Add / edit content#ISADContext | Add / edit content > Add / edit archival descriptions > Context area]]: steps 1-7.
 
−
 
−
|}
 
−
 
−
---
 
−
 
−
 
−
 
−
---
 
−
 
−
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.

Retrieved from "https://wiki.ica-atom.org/index.php?title=Metadata_requirements:_archival_descriptions&oldid=1890"