Difference between revisions of "Using ICA-AtoM v1.3.0 to create EAD/XML finding aids"

From Archives Portal Europe Wiki
Jump to: navigation, search
(Replaced content with "The content of this page has been integrated into the [https://www.archivesportaleurope.net/tools/for-content-providers/supporting-software/create-ead-using-atom/ website...")
Line 1: Line 1:
<div>__TOC__<br/><br/></div>
+
The content of this page has been integrated into the [https://www.archivesportaleurope.net/tools/for-content-providers/supporting-software/create-ead-using-atom/ website of Archives Portal Europe] now.
It is not the intention of this page to provide a full manual on all possibilities of ICA-AtoM. For that: please take a look at the official user manual of the software over here: https://www.ica-atom.org/doc/User_manual. The purpose of this page is to show how ICA-AtoM can be used to create finding aids in EAD/XML which subsequently can be uploaded to the Archives Portal Europe. Therefore this page will focus on how to start the software and - after a brief overview of the interface - on how to configure an archival institution/repository and how to create finding aids in EAD/XML for it.
+
 
+
 
+
 
+
= Starting ICA-AtoM =
+
 
+
Once you have installed Wamp server v2.2 and ICA-AtoM v1.3.0, you can start ICA-AtoM by first activating Wamp server on your computer via double clicking on the Wamp server desktop icon:
+
[[File:wamp_24.png|300px|thumb|left|Wamp server desktop icon]]
+
<br clear=all>
+
 
+
Then you can use two ways to start ICA-AtoM:
+
* 1) go to the Wamp server interface by clicking on the green "W"-icon on the right of the taskbar, then choose "Localhost" and click in the screen that opens on the link "icaatom-1.3.0" in the section "Your Projects", or
+
* 2) open your webbrowser and type "localhost/icaatom-1.3.0" directly in the url bar
+
Both ways will lead you to the start screen of ICA AtoM (figure 1):
+
[[File:ica-atom_12.png|300px|thumb|left|Using ICA-AtoM, figure 1]]
+
<br clear=all>
+
 
+
This is actually the front-end of ICA-AtoM via which information on archival material is published for end-users. If you want to enter information in ICA-AtoM to be published, you have to login and you can do that using the email address and password you provided for the administrator account when configuring ICA-AtoM  (figure 2):
+
[[File:ica-atom_13.png|300px|thumb|left|Using ICA-AtoM, figure 2]]
+
<br clear=all>
+
 
+
 
+
 
+
= The ICA-AtoM user interface =
+
 
+
Once logged in you have access to more menu options, such as: '''Add''', with as suboptions the possibility to add '''Accession records''', '''Archival descriptions''', '''Authority records''', '''Archival institutions''', '''Terms''' and '''Functions''' (figure 3):
+
[[File:ica-atom_14.png|300px|thumb|left|Using ICA-AtoM, figure 3]]
+
<br clear=all>
+
 
+
The menu option: '''Manage''', has as suboptions the possibility to manage '''Accessions''', '''Donors''', '''Physical storage''', '''Rights holders''' and '''Taxonomies''' (figure 4):
+
[[File:ica-atom_15.png|300px|thumb|left|Using ICA-AtoM, figure 4]]
+
<br clear=all>
+
 
+
The menu option: '''Import''', has as suboptions the possibility to import data as '''XML''' and '''CSV''' (figure 5):
+
[[File:ica-atom_16.png|300px|thumb|left|Using ICA-AtoM, figure 5]]
+
<br clear=all>
+
 
+
The menu option: '''Admin''', has as suboptions a variety of options to configure the software any further: '''Users''', '''Groups''', '''Static pages''', '''Menus''', '''Plugins''', '''Themes''', '''Settings''', '''Description updates''', '''Global search/replace'''  and '''Visible elements''' (figure 5):
+
[[File:ica-atom_17.png|300px|thumb|left|Using ICA-AtoM, figure 6]]
+
<br clear=all>
+
 
+
Furthermore it is important to know that the '''Language''' of the interface can be changed into the languages: '''French''', '''Spanish''', '''Dutch'''  and '''Portugese''' (figure 7):
+
[[File:ica-atom_18.png|300px|thumb|left|Using ICA-AtoM, figure 7]]
+
<br clear=all>
+
 
+
Finally the menu option '''Quick links''' gives access to some basic information about the software, the user's profile and the log out option (figure 8):
+
[[File:ica-atom_19.png|300px|thumb|left|Using ICA-AtoM, figure 8]]
+
<br clear=all>
+
 
+
And the last two options of the Quick links menu option are doubled for the '''Admin''' menu option (figure 9):
+
[[File:ica-atom_20.png|300px|thumb|left|Using ICA-AtoM, figure 9]]
+
<br clear=all>
+
 
+
 
+
 
+
= Creating an Archival institution =
+
 
+
Before we can create a finding aid, we have to define the archival institution to which is belongs, because ICA-AtoM is actually designed to act as a portal to publish information on archival material from several archival institutions. However for this tutorial, to show how you can use ICA-AtoM to create finding aids in EAD/XML which you can subsequently upload in the Archives Portal Europe, we only create one archival institution and when doing that we also just stick to the basics, so only enter the information in the mandatory fields.
+
 
+
 
+
* Once logged in, you can create an archival institution via the main menu option: '''Add''' and the submenu option: '''Archival institutions'''. The screen will show all options for entering information collapsed. Following the ISDIAH standard, these options are: '''Identity area''', '''Contact area''', '''Description area''', '''Access area''', '''Services area''' and '''Control area''' (figure 10):
+
[[File:ica-atom_21.png|300px|thumb|left|Using ICA-AtoM, figure 10]]
+
<br clear=all>
+
 
+
* Clicking on the name of an area, it will expand and show all fields that can contain information.  When you 'mouse-over' a field, an info box with an explanation of the information needed in that field is shown. Within the '''Identity area''', the field '''Identifier''' is mandatory (figure 11):
+
[[File:ica-atom_22.png|300px|thumb|left|Using ICA-AtoM, figure 11]]
+
<br clear=all>
+
 
+
* and also the field '''Authorized form of name''' (figure 12):
+
[[File:ica-atom_23.png|300px|thumb|left|Using ICA-AtoM, figure 12]]
+
<br clear=all>
+
 
+
* Within the '''Contact area''' it is mandatory to at least enter the information of one contact person. Click on the '''Add new''' link to enter the information of a contact person (figure 13):
+
[[File:ica-atom_24.png|300px|thumb|left|Using ICA-AtoM, figure 13]]
+
<br clear=all>
+
 
+
* a pop-up screen will be opened (figure 14):
+
[[File:ica-atom_25.png|300px|thumb|left|Using ICA-AtoM, figure 14]]
+
<br clear=all>
+
 
+
* in which you can enter the information of the contact person (figure 15):
+
[[File:ica-atom_26.png|300px|thumb|left|Using ICA-AtoM, figure 15]]
+
<br clear=all>
+
 
+
* Clicking on the '''Submit'''-button will save the information, close the pop-up window and return you to the '''Contact area''' where you will see that the contact person has been added. The '''Description area''', '''Access area''', '''Services area''' and '''Control area''' don't have mandatory fields, so you can now create the archival institution and save the information you have just entered by clicking on the '''Create'''-button (figure 16):
+
[[File:ica-atom_27.png|300px|thumb|left|Using ICA-AtoM, figure 16]]
+
<br clear=all>
+
 
+
* You now get an overview of the information of the archival institution you have just created. This information will be available whenever you click on '''Archival institutions''' in the '''Browse'''-navigation. If necessary you can add or change information by using the '''Pencil icon'''-buttons (figure 17):
+
[[File:ica-atom_28.png|300px|thumb|left|Using ICA-AtoM, figure 17]]
+
<br clear=all>
+
 
+
= Creating a Record creator =
+
 
+
Before we can create a finding aid, we also have to define one or more creators for the archival fonds it describes. In ICA-AtoM the information on creators of archival material are called '''Authority records'''.
+
 
+
Once logged in you can create a record for a creator of archival material via the main menu option: '''Add''' and the submenu option: '''Authority records'''. The screen will show all options for entering information collapsed. Following the ISAAR standard, these options are: '''Identity area''', '''Description area''', '''Relationships area''' and '''Control area''' (figure 18):
+
[[File:ica-atom_29.png|300px|thumb|left|Using ICA-AtoM, figure 18]]
+
<br clear=all>
+
 
+
* Clicking on the name of an area, it will expand and show all fields that can contain information. Again, when you 'mouse-over' a field, an info box with an explanation of the information needed is shown. Within the '''Identity area''', the field '''Type of entity''' is mandatory which provides a dropdown box with the values '''Corporate body''', '''Family''' and '''Person''' to choose from (figure 19):
+
[[File:ica-atom_30.png|300px|thumb|left|Using ICA-AtoM, figure 19]]
+
<br clear=all>
+
 
+
* and also the field '''Authorized form of name''' is mandatory (figure 20):
+
[[File:ica-atom_31.png|300px|thumb|left|Using ICA-AtoM, figure 20]]
+
<br clear=all>
+
 
+
* Within the '''Description area''' the field '''Dates of existence''' is mandatory (figure 21):
+
[[File:ica-atom_32.png|300px|thumb|left|Using ICA-AtoM, figure 21]]
+
<br clear=all>
+
 
+
* Within the '''Control area''' the field '''Description identifier''' is mandatory (figure 22):
+
[[File:ica-atom_33.png|300px|thumb|left|Using ICA-AtoM, figure 22]]
+
<br clear=all>
+
 
+
* The '''Relationships area''' and '''Control area''' don't have mandatory fields, so you can now create the authority records and save the information you have just entered by clicking on the '''Create'''-button (figure 23):
+
[[File:ica-atom_34.png|300px|thumb|left|Using ICA-AtoM, figure 23]]
+
<br clear=all>
+
 
+
* You now get an overview of the information of the authority record, i.e. the record creator, you have just entered. This information will be available whenever you click on '''Authority records''' in the '''Browse'''-navigation. If necessary you can add or change information by using the '''Pencil icon'''-buttons (figure 24):
+
[[File:ica-atom_35.png|300px|thumb|left|Using ICA-AtoM, figure 24]]
+
<br clear=all>
+
 
+
= Creating a Finding Aid =
+
 
+
Now you can start creating a finding aid and you can do that via the main menu option: Add and the submenu option: Archival descriptions. The screen will show all options for entering information collapsed. Following the ISAD standard, these options are: '''Identity area''', '''Context area''', '''Content and structure area''', '''Conditions of access and use area''', '''Allied materials area''', '''Notes area''', '''Access points''', '''Description control area''', '''Rights area''' and '''Administration area''' (figure 25):
+
[[File:ica-atom_36.png|300px|thumb|left|Using ICA-AtoM, figure 25]]
+
<br clear=all>
+
 
+
* Within the '''Identity area''' there are several mandatory fields: the '''Identifier''' of the archival fonds (figure 26):
+
[[File:ica-atom_37.png|300px|thumb|left|Using ICA-AtoM, figure 26]]
+
<br clear=all>
+
 
+
* the '''Title''' or name of the archival fonds, which will also be the title of the finding aid (figure 27):
+
[[File:ica-atom_38.png|300px|thumb|left|Using ICA-AtoM, figure 27]]
+
<br clear=all>
+
 
+
* the '''Date(s)''' information (figure 28):
+
[[File:ica-atom_39.png|300px|thumb|left|Using ICA-AtoM, figure 28]]
+
<br clear=all>
+
 
+
* the '''Level of description''' which can be derived from a dropdown list (figure 29):
+
[[File:ica-atom_40.png|300px|thumb|left|Using ICA-AtoM, figure 29]]
+
<br clear=all>
+
 
+
* within the '''Level of description''' it is possible to '''Add new child levels''' (figure 30):
+
[[File:ica-atom_41.png|300px|thumb|left|Using ICA-AtoM, figure 30]]
+
<br clear=all>
+
 
+
* via which a flat list or a hierarchical tree can be build (figure 31):
+
[[File:ica-atom_42.png|300px|thumb|left|Using ICA-AtoM, figure 31]]
+
<br clear=all>
+
 
+
* and finally the '''Extent and medium''' information, which can be entered as free text, is also mandatory (figure 32):
+
[[File:ica-atom_43.png|300px|thumb|left|Using ICA-AtoM, figure 32]]
+
<br clear=all>
+
 
+
* Within the Context area you can choose the record creator(s) and of course you can pick here the one you entered before (figure 33):
+
[[File:ica-atom_44.png|300px|thumb|left|Using ICA-AtoM, figure 33]]
+
<br clear=all>
+
 
+
* Within the Context area you can also choose the repository the archival fonds you describe belongs too en of course you can pick here the archival institution you created before (figure 34):
+
[[File:ica-atom_45.png|300px|thumb|left|Using ICA-AtoM, figure 34]]
+
<br clear=all>
+
 
+
* The '''Content and structure area''', '''Conditions of access and use area''', '''Allied materials area''', '''Notes area''', '''Access points''', '''Description control area''', '''Rights area''' and '''Administration area''' don't have mandatory fields, so yu can now create the finding aid and save the information you have just entered by clicking on the '''Create'''-button (figure 35):
+
[[File:ica-atom_46.png|300px|thumb|left|Using ICA-AtoM, figure 35]]
+
<br clear=all>
+
 
+
* You now get an overview of the information of the finding aid you have just created. This information will be available whenever you click on '''Archival descriptions''' in the '''Browse'''-navigation. If necessary you can add or change information by using the '''Pencil icon'''-buttons (figure 36):
+
[[File:ica-atom_47.png|300px|thumb|left|Using ICA-AtoM, figure 36]]
+
<br clear=all>
+
 
+
* If you click on the arrow in front of the finding aid's identifier and title in the '''Fonds'''-navigation, the tree with descriptive units will expand and their information will be displayed in the right part of the screen accordingly. Over there you can add or change information if necessary using the '''Pencil icon'''-buttons (figure 37):
+
[[File:ica-atom_48.png|300px|thumb|left|Using ICA-AtoM, figure 37]]
+
<br clear=all>
+
 
+
* In the same overview screen of the whole archival fonds description you can create an EAD/XML version of the finding aid by clicking on the '''EAD 2002 XML link''' in the '''Export'''-navigation (figure 38):
+
[[File:ica-atom_49.png|300px|thumb|left|Using ICA-AtoM, figure 38]]
+
<br clear=all>
+
 
+
* The EAD/XML file will be opened in your browser (figure 39):
+
[[File:ica-atom_50.png|300px|thumb|left|Using ICA-AtoM, figure 39]]
+
<br clear=all>
+
 
+
* and if you scroll down (figure 40):
+
[[File:ica-atom_51.png|300px|thumb|left|Using ICA-AtoM, figure 40]]
+
<br clear=all>
+
 
+
* you can see the whole EAD/XML code (figure 41):
+
[[File:ica-atom_52.png|300px|thumb|left|Using ICA-AtoM, figure 41]]
+
<br clear=all>
+
 
+
* By using the '''Save Page''' functionality of your browser, you can download the EAD/XML code to your harddrive (figure 42):
+
[[File:ica-atom_53.png|300px|thumb|left|Using ICA-AtoM, figure 42]]
+
<br clear=all>
+
 
+
* This EAD/XML file can be uploaded to the Archives Portal Europe (figure 43):
+
[[File:ica-atom_54.png|300px|thumb|left|Using ICA-AtoM, figure 43]]
+
<br clear=all>
+
 
+
* and can already be looked at via the '''Preview function''' of the Archives Portal Europe's Dashboard (figure 44):
+
[[File:ica-atom_55.png|300px|thumb|left|Using ICA-AtoM, figure 44]]
+
<br clear=all>
+
 
+
[[Category:APE_supporting_software]]
+

Revision as of 12:34, 28 October 2022

The content of this page has been integrated into the website of Archives Portal Europe now.