Difference between revisions of "Add/edit archival descriptions"

From ICA-AtoM
Jump to navigation Jump to search
(New page: Main Page > User manual > UM-3 Add / edit content > UM-3.1 Add / edit archival descriptions == Add / edit archival descriptions == This page describes how to: *[[#crea...)
 
Line 14: Line 14:
  
 
'''Create new archival descriptions'''
 
'''Create new archival descriptions'''
 +
  
 
1. Click the [[Glossary#Add / edit tab|Add / edit tab]] on the [[Glossary#Main menu bar|Main menu bar]].
 
1. Click the [[Glossary#Add / edit tab|Add / edit tab]] on the [[Glossary#Main menu bar|Main menu bar]].
Line 31: Line 32:
  
 
6. Note that the behaviour of the [[Glossary#Cancel button|Cancel button]] changes after you first click the [[Glossary#Save button|Save button]]. Before saving, "Cancel" = "delete record". After the first save, a [[Glossary#Delete button|Delete button]] appears for deleting, while "Cancel" = "do not commit the data since the last save".
 
6. Note that the behaviour of the [[Glossary#Cancel button|Cancel button]] changes after you first click the [[Glossary#Save button|Save button]]. Before saving, "Cancel" = "delete record". After the first save, a [[Glossary#Delete button|Delete button]] appears for deleting, while "Cancel" = "do not commit the data since the last save".
 
  
  
Line 38: Line 38:
  
 
'''Edit an existing description'''
 
'''Edit an existing description'''
 +
  
 
1. Navigate to the description you want to edit.
 
1. Navigate to the description you want to edit.
Line 62: Line 63:
 
6. To save changes, click the <span class="button">Save</span> button; ICA-AtoM returns you to the <span class="screen">View</span> screen, all changes saved.
 
6. To save changes, click the <span class="button">Save</span> button; ICA-AtoM returns you to the <span class="screen">View</span> screen, all changes saved.
  
|width="40%" align="right"|
 
 
'''insertScreenshot'''
 
 
|}
 
 
 
== Edit screen (data entry) ==
 
 
{| border="0" cellpadding="2"
 
 
|- valign="top"
 
|width="60%" |
 
 
The <span class="screen">Edit archival description</span> screen is structured into six <span class="area">RecordAreas</span> based on ISAD(G)'s <span class="docElement">information areas</span>:
 
*[[#Identity area | Identity area]]
 
*[[#Context area | Context area]]
 
*[[#Content and structure area| Content and structure area]]
 
*[[#Conditions of access and use area | Conditions of access and use area]]
 
*[[#Access points | Access points]]
 
*[[#Description control area | Description control area]]
 
 
 
Click on a <span class="area">RecordArea</span> to expand it (display fields); click again to collapse it (hide fields). Note that whenever you save a record, ICA-AtoM collapses all <span class="area">RecordAreas</span>.
 
 
 
The following notes aim only to clarify ICA-AtoM procedures; for guidelines on what information to record in particular fields, consult [[ISAD(G)]] as the content standard. The notes are organized by field, with links to the applicable ISAD(G) section(s).
 
 
 
|width="40%" align="right"|
 
 
'''insertScreenshot'''
 
 
|}
 
 
 
=== Identity area ===
 
 
{| border="0" cellpadding="2"
 
 
|- valign="top"
 
|width="60%" |
 
 
The <span class="area">IdentityArea</span> contains fields that uniquely identify the archival description.
 
 
 
1. <span class="field">Reference code</span> ([[ISAD(G)#isad3.1.1 |ISAD(G) 3.1.1]]):
 
*Enter the reference code that uniquely identifies the archival unit under description.
 
 
 
2. <span class="field">Title</span> ([[ISAD(G)#isad3.1.2 |ISAD(G) 3.1.2]]):
 
*Enter the authorized title of the unit of description.
 
 
 
3. <span class="field">Alternate title</span> ([[ISAD(G)#isad3.1.2 |ISAD(G) 3.1.2]]):
 
*Enter an alternate title of the unit.
 
*In the current version of ICA-AtoM (v0.6) you can only register one alternate title; in future iterations, you should be able to register as many alternates as you need.
 
 
 
4. <span class="field">Title notes</span> ([[ISAD(G)#isad3.1.2 |ISAD(G) 3.1.2]], [[ISAD(G)#isad3.6.1 |ISAD(G) 3.6.1]]):
 
*Multi-value field displaying notes in a list form.
 
*Create as many title notes as you need.
 
*Notes that have already been entered appear with a red <span class="button">DeleteInfoIcon</span> beside them.
 
*Use the last row (with the green <span class="button">AddInfoIcon</span> beside it) to add a new note.
 
 
 
5. <span class="field">Note</span> ([[ISAD(G)#isad3.1.2 |ISAD(G) 3.1.2]], [[ISAD(G)#isad3.6.1 |ISAD(G) 3.6.1]]):
 
*Enter the note.
 
 
 
6. <span class="field">Note type</span> ([[ISAD(G)#isad3.6.1 |ISAD(G) 3.6.1]]):
 
*Defaults to "Title note" and cannot be changed: any note you create here will always be a "Title note".
 
*To create other types of notes, go to the <span class="area">Control</span> record area.
 
 
 
7. <span class="button">AddInfoIcon</span>:
 
*Click to register the new title note.
 
 
 
8. <span class="button">DeleteInfoIcon</span>:
 
*Click to delete an existing title note.
 
 
 
9. <span class="field">Level of description</span> ([[ISAD(G)#isad3.1.4 |ISAD(G) 3.1.4]]):
 
*Select the appropriate level of description from the drop-down list.
 
*List terms can be customized by <span class="role">Administrators</span> to suit their institution's arrangement system.
 
 
 
10. <span class="field">Next upper level of description</span>:
 
*Select the unit immediately above the current one in the hierarchy of arrangement ("parent record").
 
*Leave blank if the current unit represents the highest level of arrangement (e.g. a fonds).
 
 
 
11. <span class="field">Extent and medium</span> ([[ISAD(G)#3.1.5 |ISAD(G) 3.1.5]]):
 
*Enter information relating to the physical size, media, and formats.
 
*Structure data according to your institution's standards (e.g. separate entries by commas or separate lines).
 
 
 
|width="40%" align="right"|
 
 
''insertScreenshot''
 
 
|}
 
 
=== Context area ===
 
 
{| border="0" cellpadding="2"
 
 
|- valign="top"
 
|width="60%" |
 
 
The <span class="area">ContextArea</span> contains fields that provide information about the origins and custody of the archival material being described.
 
 
 
1. <span class="field">Creation context</span>:
 
*Multi-value field displaying creation events in a list form.
 
*A <span class="entity">creation event</span> captures dates of creation: an entity creating the archival materials being described over a certain date range.
 
*Register as many creation events as you need. ISAD(G) recognizes more than one type of date (e.g. dates of document creation vs dates of accumulation, see [[ISAD(G)#isad3.1.3 |ISAD(G) 3.1.3]]). And in some arrangement systems there may be more than one creator (e.g. in a series system, a series may be successively controlled by differen bodies over time).
 
*The first entry in the list (containing empty text boxes) is for registering a new creation event.
 
*Any subsequent entries show events already registered.
 
 
 
2. <span class="field">Creator</span> and <span class="field">Add new name</span>:
 
*Select the creator's name from the drop-down list in the <span class="field">Creator</span> field.
 
*ICA-AtoM generates the list from all existing authority records.
 
*If the creator's name does '''not''' appear in the list, use the <span class="field">Add new name</span> field to enter the creator's name.
 
*If you select a name from the drop-down list, ICA-AtoM will ignore any text you may have entered in the <span class="field">Add new name</span> field.
 
*Note that you can leave both of these field blank; in this case, the unit will inherit creator information from its parent record (next highest level of description).
 
*At the highest level of description, you should always include the creator; the <span class="field">Administrative history / biographical sketch</span> is drawn from the creator's authority record.
 
*Lower levels inherit creator information from higher levels: use only if creator is different than the creator of the parent record (next upper level of description).
 
 
 
3. <span class="field">Creation year / End year</span> ([[ISAD(G)#isad3.1.3 |ISAD(G) 3.1.3]]):
 
*Enter the opening and closing years of the date range.
 
*ICA-AtoM uses these values for sorting and searching purposes.
 
*Use only four-digit numbers.
 
*If the start and end years are the same, enter only in the start year and leave the end year blank.
 
*Complete at lower levels of description even if you are leaving the <span class="field">Creator name</span> field blank (e.g. when describing a series, you do not need to repeat the <span class="field">Creator name</span> from the fonds description, but you do need to enter the date range of the series).
 
*Do not use any qualifiers here (e.g. "ca.") or typographical symbols (e.g. "[194?]") to express uncertainty (see step4).
 
 
 
4. <span class="field">Date display</span> ([[ISAD(G)#isad3.1.3 | ISAD(G) 3.1.3]]):
 
*Enter the date range as you want it to appear to the viewer.
 
*Add any additional text to qualify date range (e.g. "ca. 1940-1980" or "[1940]-1980; predominant 1973-1980").
 
*Whereas <span class="field">Creation year</span> and <span class="field">End year</span> are used internally for database searching and sorting purposes, this field is for display purposes.
 
 
 
 
5. <span class="button">AddInfoIcon</span> (green +):
 
*Click to register the creation event.
 
*Behind the scenes, ICA-AtoM creates a related record in the <span class="entity">Event</span> table and displays it as the next entry in the list.
 
*If you selected an existing authority record as the <span class="field">Creator</span> field in step2, ICA-AtoM provides a link to the creator's <span class="entity">authority record</span> (blue text).
 
*If you entered a new name in the <span class="field">Add new name</span> field, ICA-AtoM creates a new authority record for that entity and provides a link to it (blue text).
 
 
 
6. <span class="button">DeleteInfoIcon</span> (red X):
 
*Click to delete an existing creation event.
 
 
 
7. <span class="field">Administrative / biographical history</span> ([[ISAD(G)#isad3.2.2 |ISAD(G) 3.2.2]]):
 
*Text block displaying data from the creator's <span class="entity">authority record</span>.
 
*If you have registered more than 1 creator in the creator events (see steps 1-5), the administrative histories / biographical sketches of each will appear here sequentially, separately by a line (horizontal rule).
 
*Because the data actually resides in another record in another table, it cannot be directly edited here; to edit, click the <span class="button">EditInfoIcon</span> (see step8 below).
 
 
 
8. <span class="button">EditInfoIcon</span> (pencil):
 
*Click to edit the <span class="field">Administrative / biographical history</span> field; ICA-AtoM routes you to the related authority record.
 
*Make changes and save; ICA-AtoM returns you to the <span class="screen">Edit archival description</span> screen.
 
*Note that upon return all <span class="area">RecordAreas</span> are collapsed.
 
 
 
9. <span class="field">Archival history</span> ([[ISAD(G)#isad3.2.3 |ISAD(G) 3.2.3]]):
 
*Enter information relating to the history of custody over the material being described.
 
 
 
10. <span class="field">Repository</span>:
 
*Select from the drop-down list the institution that holds the archival material under description.
 
*ICA-AtoM generates the list from existing <span class="entity">archival institution</span> records.
 
*Typically you need only enter this information at the highest level of description (e.g. the fonds or collection; series in a series system); it can be left blank at the lower levels if they are all stored in the same repository.
 
 
 
11. <span class="field">Immediate source of acquisition</span> ([[ISAD(G)#isad3.2.4 |ISAD(G) 3.2.4]]):
 
*Enter information relating to the circumstances leading to the acquisition of the material by the archival institution.
 
  
 +
<span id="delete">
 +
[[Image:um3-1Delete.png|500px|right|thumb|Delete an existing description]]
  
|width="40%" align="right"|
+
'''Delete an existing description'''
  
[[Image:Add ArchivalContext.png|400px|right]]
 
 
[[Image:Add ArchivalContext2.png|500px|right]]
 
 
|}
 
 
=== Content and structure area ===
 
 
{| border="0" cellpadding="2"
 
 
|- valign="top"
 
|width="60%" |
 
 
The <span class="area">ContentAndStructureArea</span> contains fields that provide information relating to the content and arrangement of the materials under description. These are all basic text fields. For practical purposes there are no limits on field length (fields can hold up 16 million characters); scroll arrows will appear if needed.
 
 
 
1. <span class="field">Scope and content</span> ([[ISAD(G)#isad3.3.1 |ISAD(G) 3.3.1]]):
 
*Enter information relating to scope and content as per ISAD(G) rule.
 
 
 
2. <span class="field">Appraisal, destruction and scheduling information</span> ([[ISAD(G)#isad3.3.2 |ISAD(G) 3.3.2]]):
 
*Enter information relating to appraisal, destruction and scheduling as per ISAD(G) rule.
 
 
 
3. <span class="field">Accruals</span> ([[ISAD(G)#isad3.3.3 |ISAD(G) 3.3.3]]):
 
*Enter information relating to future accruals as per ISAD(G) rule.
 
 
 
4. <span class="field">System of arrangement</span> ([[ISAD(G)#isad3.3.4 |ISAD(G) 3.3.4]]):
 
*Enter information relating to the system of arrangement as per ISAD(G) rule.
 
 
 
|width="40%" align="right"|
 
 
[[Image:ArchivalContent.png|500px|right]]
 
 
|}
 
 
=== Conditions of access and use area ===
 
 
{| border="0" cellpadding="2"
 
 
|- valign="top"
 
|width="60%" |
 
 
The <span class="area">ConditionsOfAccessAndUseArea</span> contains fields that provide information about the availability of the material being described. Most of the fields in this area are basic text fields; the exceptions are <span class="field">Languages</span> and <span class="field">Scripts</span> (see steps 3 below).
 
 
 
1. <span class="field">Conditions governing access</span> ([[ISAD(G)#isad3.4.1 |ISAD(G) 3.4.1]]):
 
*Enter information relating to conditions governing access as per ISAD(G) rule.
 
 
 
2. <span class="field">Conditions governing reproduction</span> ([[ISAD(G)#isad3.4.2 |ISAD(G) 3.4.2]]):
 
*Enter information relating to conditions governing reproduction as per ISAD(G) rule.
 
 
 
3. <span class="field">Language</span> ([[ISAD(G)#isad3.4.3 |ISAD(G) 3.4.3]]):
 
*Multi-value fields displaying in list form the language(s) and script(s) employed in the archival material under description.
 
*Select the language / script from the drop-down list.
 
*Click the <span class="button">Save</span> button.
 
*ICA-AtoM saves the records, collapsing the <span class="area">ConditionsOfAccessAndUseArea</span>; click to re-open.
 
*The selected language / script now appears in the list above the data entry field.
 
*Repeat for other languages / scripts if required.
 
*To delete a language / script from the list, click the red <span class="button">DeleteInfoIcon</span> beside it.
 
*Note that future releases of ICA-AtoM will normalize these fields to the standard behaviour of multi-value fields in the system (i.e. present to the user an <span class="button">AddInfoIcon</span> button for registering an entry rather than having to save the record).
 
 
 
4. <span class="field">Physical characteristics</span> ([[ISAD(G)#isad3.4.3 |ISAD(G) 3.4.3]]):
 
*Enter information relating to physical characteristics that affect access to the material or technical requirements needed to access it as per ISAD(G) rule.
 
 
 
5. <span class="field">Finding aids</span> ([[ISAD(G)#isad3.4.5 |ISAD(G) 3.4.5]]):
 
*Enter information relating to the existence of other finding aids to the material as per ISAD(G) rule.
 
 
 
6. <span class="field">Location of originals</span> ([[ISAD(G)#isad3.5.1 |ISAD(G) 3.5.1]]):
 
*Enter information relating to the location of the originals of the materials described (if they are copies) as per ISAD(G) rule.
 
*Note that in future releases of ICA-AtoM, this field should be moved to a new record area (<span class="area">AlliedMaterials</span> to better reflect the ISAD(G) standard.
 
 
 
7. <span class="field">Location of copies</span> ([[ISAD(G)#isad3.5.2 |ISAD(G) 3.5.2]]):
 
*Enter information relating to the location of copies of the materials described *In as per ISAD(G) rule.
 
*Note that in future releases of ICA-AtoM, this field should be moved to a new record area (<span class="area">AlliedMaterials</span> to better reflect the ISAD(G) standard.
 
 
 
8. <span class="field">Related units of description</span> ([[ISAD(G)#isad3.5.3 |ISAD(G) 3.5.3]]):
 
*Enter information relating to related units of description as per ISAD(G) rule.
 
*Note that in future releases of ICA-AtoM, this field should be moved to a new record area (<span class="area">AlliedMaterials</span> to better reflect the ISAD(G) standard.
 
 
 
|width="40%" align="right"|
 
 
[[Image:Add ArchivalAccess.png|400px|right]]
 
 
|}
 
 
=== Access points ===
 
{| border="0" cellpadding="2"
 
 
|- valign="top"
 
|width="60%" |
 
 
The <span class="area">AccessPoints</span> area links archival descriptions to terms drawn from controlled vocabularies as a means of facilitating acess and retrieval. As of version 0.5, ICA-AtoM can create <span class="field">Subject</span> access points; future releases should include <span class="field">Place</span> and <span class="field">Name</span> access points.
 
 
 
Access points are multi-value fields displaying terms in a list form. To create a new access point:
 
 
 
1. Select a term from the drop-down list.
 
 
 
2. Click the <span class="button">Save</span> button.
 
 
 
3. ICA-AtoM saves the record, collapsing the <span class="area">AccessPoints</span> area; click to re-open; the selected term now appears in the list above the data entry field.
 
 
 
4. Repeat for other terms as required.
 
 
 
5. To delete an access point from the list, click the red <span class="button">DeleteInfoIcon</span> beside it.
 
 
 
Note that future releases of ICA-AtoM will normalize these fields to the standard behaviour of multi-value fields in the system (i.e. present to the user an <span class="button">AddInfoIcon button</span> for registering an entry rather than having to save the record).
 
 
 
|width="40%" align="right"|
 
 
[[Image:AddArchivalAccessPoints1.png|500px|right]]
 
 
[[Image:AddArchivalAccessPoints2.png|500px|right]]
 
 
|}
 
 
=== Description control area ===
 
 
{| border="0" cellpadding="2"
 
 
|- valign="top"
 
|width="60%" |
 
 
The <span class="area">DescriptionControlArea</span> contains fields that provide information about the creation and maintenance of the description record.
 
 
 
1. <span class="field">Notes</span>: [[ISAD(G)#Notes area | ISAD(G) 3.6]]
 
*Multi-value field displaying notes as a list; there is no limit to the number of notes you can add.
 
*Enter the note, select the type and click the green <span class="button">AddInfoIcon</span> to register.
 
*To delete an existing note, click the red <span class="button">DeleteInfoIcon</span> beside it.
 
*See above [[#Multi-value fields | Multi-value fields]] for more information on the behaviour of multi-value fields.
 
 
 
2. <span class="field">Rules or conventions</span>: [[ISAD(G)#Rules or conventions | ISAD(G) 3.7.2]]
 
*Free text field.
 
 
 
3. <span class="field">Dates of description</span>: [[ISAD(G)#Date(s) of descriptions | ISAD(G) 3.7.3]]
 
*Not yet available (as of ICA-AtoM 0.4).
 
*[Multi-value field, registering the dates the description was originally created and subsequently revised.]
 
 
 
|width="40%" align="right"|
 
 
[[Image:Add ArchivalControl.png|400px|right]]
 
 
|}
 
 
== Delete archival descriptions ==
 
 
{| border="0" cellpadding="2"
 
 
|- valign="top"
 
|width="60%" |
 
  
 
Only <span class="role">Editors</span> and <span class="role">Administrators</span> can delete records in ICA-AtoM. To delete an archival description:
 
Only <span class="role">Editors</span> and <span class="role">Administrators</span> can delete records in ICA-AtoM. To delete an archival description:
Line 448: Line 96:
  
  
|width="40%" align="right"|
+
<span id="exit">
 
+
[[Image:um3-1Exit.png|500px|right|thumb|Exit the Edit screen]]
[[Image:AddDelete1.png|500px|right]]
 
 
 
[[Image:AddDelete2.png|500px|right]]
 
  
[[Image:AddDelete3.png|right]]
+
'''Exit the Edit screen'''
  
|}
+
To exit

Revision as of 19:55, 28 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 > User manual > UM-3 Add / edit content > UM-3.1 Add / edit archival descriptions

Add / edit archival descriptions

This page describes how to:


File:Um3-1Create.png
Create a new description

Create new archival descriptions


1. Click the Add / edit tab on the Main menu bar.


2. Click the "Archival description" sub-tab on the Main menu bar; ICA-AtoM takes you to the List screen showing all existing archival descriptions.


3. Click the Add new text that appears in the "Name" column header or the Add new button at the foot of the list; ICA-AtoM creates a new record and routes you to a blank Edit screen for data entry.


4. Enter data (see Data entry: archival descriptions for detailed instructions and notes on fields]]).


5. Click the Save button to commit the new record.


6. Note that the behaviour of the Cancel button changes after you first click the Save button. Before saving, "Cancel" = "delete record". After the first save, a Delete button appears for deleting, while "Cancel" = "do not commit the data since the last save".


File:Um3-1Edit.png
Edit an existing description

Edit an existing description


1. Navigate to the description you want to edit.

  • Either click the AddEdit > ArchivalDescriptions tab on the MainMenuBar and select the record from the list; or
  • Use the SearchBrowseBox to find the record you want to edit.


2. By any method, when you select a description from a List screen, ICA-AtoM displays the full record on the View screen, showing any fields in which information has already been entered. To begin editing, click the RecordTitleBar at the head of the record or the Edit button at the foot.


3. ICA-AtoM opens the record on the DataEntry screen. It displays the record with all RecordAreas closed; click on an area to access the fields contained under it.


4. Add / revise data as required (see below for detailed instructions and notes on fields).


5. To discard all changes, click the Cancel button; ICA-AtoM returns you to the View screen, with no changes saved.


6. To save changes, click the Save button; ICA-AtoM returns you to the View screen, all changes saved.


File:Um3-1Delete.png
Delete an existing description

Delete an existing description


Only Editors and Administrators can delete records in ICA-AtoM. To delete an archival description:


1. Navigate to the description you want to delete.


2. Switch from the View to the Edit screen by clicking the RecordTitleBar or Edit button.


3. Click the Delete button.


4. ICA-AtoM prompts you to confirm the delete request; click OK.


5. ICA-AtoM deletes the record and returns you to the List screen.


6. Note the following consequences of deleting an archival description:

  • If the record has lower-level descriptions registered to it (is a "parent record"), all the lower-level records are also deleted - e.g. if you delete a series, any sub-series, files or items that belong to the series will also be deleted.
  • Any access points assigned to the description are also deleted.
  • Any date events associated with the description are also deleted.
  • The authority record of the associated creator is not deleted.
  • The archival institution record of the associated repository is not deleted.


File:Um3-1Exit.png
Exit the Edit screen

Exit the Edit screen

To exit