This is a technical documentation for the YerushaAim25 Goobi workflow plugin. It checks AIM25 for new EAD datasets, downloads them and creates Goobi processes for them.
Installation
In order to use the plugin, the following files must be installed:
To use this plugin, the user must have the correct role authorisation.
Therefore, please assign the role Plugin_workflow_yerusha_aim25 to the group.
Overview and functionality
If the plugin has been installed and configured correctly, it can be found under the Workflow menu item.
On the page of the plugin, when the button is clicked, the list of datasets in AIM25 is requested, and for any datasets which have not already been given goobi processes, the datasets are downloaded and converted to goobi processes, based on the template specified in the config file. Here the EAD file is searched using the specified xpath expressions, with corresponding metadata created for the goobi process.
Configuration
The plugin is configured in the file plugin_intranda_workflow_yerusha_aim25.xml as shown here:
<?xml version="1.0" encoding="UTF-8"?><config_plugin><!-- The template used for new processes --> <templateTitle>AIM25_Workflow</templateTitle><!-- digital collection --> <digitalCollection>AIM_25</digitalCollection><!-- Document type for imported documents --> <documenttypeisanchor="false">Collection</documenttype><!-- For testing: if this is not empty, then only this number of datasets will be downloaded each time the plugin is carried out--> <importNumber>2</importNumber> <mapping> <metadataname="CatalogIDSource"xpath="//ead:eadid/@identifier"level="topstruct"xpathType="Attribute"/> <metadataname="Country"xpath="//ead:eadid/@countrycode"level="topstruct"xpathType="Attribute"/> <metadataname="originalInstitution"xpath="//ead:publisher"level="topstruct"xpathType="Element"/> <metadataname="InstitutionOfficial"xpath="//ead:publisher"level="topstruct"xpathType="Element"/> <metadataname="LanguageInstitution"xpath="//ead:language/@langcode"level="topstruct"xpathType="Attribute"/> <metadataname="ContactPhone"xpath="//ead:publicationstmt/ead:address/ead:addressline[starts-with(., 'Telephone')]"level="topstruct"xpathType="Element"/> <metadataname="ContactWeb"xpath="//ead:publicationstmt/ead:address/ead:addressline[starts-with(., 'http')]"level="topstruct"xpathType="Element"/> <metadataname="ContactEmail"xpath="//ead:publicationstmt/ead:address/ead:addressline[starts-with(., 'Email')]"level="topstruct"xpathType="Element"/> <metadataname="ContactPostal"xpath="//ead:publicationstmt/ead:address/ead:addressline[not(starts-with(., 'Email')) and not(starts-with(., 'http')) and not(starts-with(., 'Telephone'))]"level="topstruct"xpathType="Element"/> <metadataname="ReferenceNumber"xpath="//ead:eadid"level="topstruct"xpathType="Element"/> <metadataname="TitleDocMain"xpath="//ead:titlestmt/ead:titleproper"level="topstruct"xpathType="Element"/> <metadataname="_TitleDocMainOfficial"xpath="//ead:titlestmt/ead:titleproper"level="topstruct"xpathType="Element"/> <metadataname="CreatorYerusha"xpath="//ead:origination/ead:persname"level="topstruct"xpathType="Element"/> <metadataname="CreatorYerusha"xpath="//ead:origination/ead:name"level="topstruct"xpathType="Element"/> <metadataname="DateOfOrigin"xpath="//ead:unitdate/@normal"level="topstruct"xpathType="Attribute"/> <metadataname="DocLanguage"xpath="//ead:language/@langcode"level="topstruct"xpathType="Attribute"/> <metadataname="Extent"xpath="//ead:physdesc"level="topstruct"xpathType="Element"/> <metadataname="ScopeContent"xpath="//ead:scopecontent/ead:p"level="topstruct"xpathType="Element"/> <metadataname="ArchivalHistory"xpath="//ead:custodhist/ead:p"level="topstruct"xpathType="Element"/> <metadataname="AdministrativeHistory"xpath="//ead:bioghist/ead:note/ead:p"level="topstruct"xpathType="Element"/> <metadataname="originalAccessLocations"xpath="//ead:controlaccess/ead:geogname"level="topstruct"xpathType="Element"/> <metadataname="originalAccessPersons"xpath="//ead:controlaccess/ead:persname"level="topstruct"xpathType="Element"/> <metadataname="originalAccessCorporate"xpath="//ead:controlaccess/ead:corpname"level="topstruct"xpathType="Element"/> <metadataname="Arrangement"xpath="//ead:arrenagement/ead:p"level="topstruct"xpathType="Element"/> <metadataname="AccessRestrictions"xpath="//ead:accessrestrict/ead:p"level="topstruct"xpathType="Element"/> <metadataname="FindingAids"xpath="//ead:otherfindaid/ead:p"level="topstruct"xpathType="Element"/> <metadataname="Copies"xpath="//ead:altformavail/ead:p"level="topstruct"xpathType="Element"/> <metadataname="Originals"xpath="//ead:originalsloc/ead:p"level="topstruct"xpathType="Element"/> <metadataname="AuthorOfDescription"xpath="//ead:archdesc/ead:processinfo/ead:p[not(ead:date)]"level="topstruct"xpathType="Element"/> </mapping></config_plugin>
The following table contains a summary of the parameters and their descriptions:
Parameter
Explanation
templateTitle
This parameter specifies the title of the workflow template to be used when creating new processes.
documenttype
This parameter defines the goobi DocType for imported documents.
importFolder
A folder where data can be temporarily written.
importNumber
For testing: if this is not empty or 0, then only this number of datasets will be imported each time the plugin is carried out.
mapping
Xpath mappings from the EAD files to goobi metadata.
