After installing the plugin and the associated database, the plugin must also be configured. This takes place within the configuration file plugin_intranda_administration_archive_management.xml and is structured as follows as an example:
<config_plugin> <export><!-- configure export for a specific inventory --> <filename="sample.xml"> <folder>/opt/digiverso/viewer/hotfolder/</folder> </file><!-- default export for all inventories without a specific --> <filename="*"> <folder>/opt/digiverso/viewer/hotfolder/</folder> </file> </export> <backup><!-- backup folder --> <folder>CHANGEME</folder><!-- number of backups for each inventory --> <numberOfFiles>10</numberOfFiles><!-- tool to create the backup files --> <tool>/usr/bin/mysqldump</tool><!-- database password. The user name, database name, tables etc. can be recognized automatically, but the password must be entered.--><!-- Leave it empty if access is possible without authentication (e.g. configured in ~/.my.cnf) --> <password></password> </backup> <config><!-- define the name(s) of all archives for the plugin --> <archive>*</archive><!-- default title for a new node --> <nodeDefaultTitle>Document</nodeDefaultTitle><!-- configurations for generating process titles --><!-- maximum length of the body token that will be used to generate a new process title --><!-- the specifically set HEAD token and TAIL token will not be affected by this limit --><!-- if the limit is positively configured, then CAMEL_CASE_LENGTH_LIMITED will be applied upon every body token, otherwise CAMEL_CASE will be applied --> <lengthLimit>0</lengthLimit><!-- separator string that will be used to combine the tokens --> <separator>_</separator><!-- use id from parent node instead of id from node --> <useIdFromParent>false</useIdFromParent><!-- Optional title generation, if nothing is configured, process titles are built based on the node ID --><!-- attribute value: contains a static text. If it is empty, it is assumed that a metadata value is being searched for --><!-- attribute name: contains the metadata name to use --><!-- attribute type: can be NORMAL (use text as it is), CAMEL_CASE (each word begins with an upper case letter), AFTER_LAST_SEPARATOR (insert at the end), BEFORE_FIRST_SEPARATOR (insert in front) --><!-- <title name="shelfmarksource" type="NORMAL" /> <title name="static" type="CAMEL_CASE" value="STATIC TEXT" /> <title name="CatalogIDDigital" type="AFTER_LAST_SEPARATOR" /> --><!-- // configurations for generating process titles // --><!-- configuration for node/process mapping --><!-- it will be used during ead import or when the button to update references is used --><!-- nodeIdentifierField contains the identifying value of the node processIdentifierField contains the name of the metadata where the node value is stored If both fields contain the same value, a link between node and process is created --><!-- <nodeIdentifierField>id</nodeIdentifierField> <processIdentifierField>NodeId</processIdentifierField> --><!-- define metadata fields. All fields are displayed on the UI based on the level and the order within this file. - @name: contains the internal name of the field. The value can be used to translate the field in the messages files. The field must start with a letter and can not contain any white spaces. - @level: metadata level, allowed values are 1-7: * 1: metadata for Identity Statement Area * 2: Context Area * 3: Content and Structure Area * 4: Condition of Access and Use Area * 5: Allied Materials Area * 6: Note Area * 7: Description Control Area - @xpath: contains a relative path to the ead value. The root of the xpath is either the <ead> element or the <c> element - @xpathType: type of the xpath return value, can be text, attribute, element (default) - @repeatable: defines if the field can exist once or multiple times, values can be true/false, default is false - @visible: defines if the field is displayed on the UI, values can be true/false, default is true - @showField: defines if the field is displayed as input field (true) or badge (false, default), affects only visible metadata - @fieldType: defines the type of the input field. Posible values are input (default), textarea, dropdown, multiselect, vocabulary, nodelink, gnd, geonames, viaf - @rulesetName: internal name of the metadata in ruleset. If missing or empty, field is not imported into process metadata - @importMetadataInChild: defines if the field is imported or skipped in processes for child elements - @validationType: defines a validation rule, allowed values are unique, required, regex, date, list or any combined values (e.g. date+required) - @regularExpression defines a regular expression that gets used for validation type regex - validationError: message to display in case of validation errors - value: list of possible values for dropdown and multiselect lists - vocabulary: name of the vocabulary - searchParameter: distinct the vocabulary list by the given condition. Syntax is fieldname=value, field is repeatable --><!-- internal fields, not visible on the UI --> <metadataxpath="./ead:control/ead:maintenancestatus/@value"xpathType="attribute"name="maintenancestatus"level="1"repeatable="false"visible="false" /> <metadataxpath="./ead:control/ead:maintenanceagency/ead:agencyname"xpathType="element"name="agencycode"level="1"repeatable="false"fieldType="input" /><!-- repository data group --> <metadataxpath="./ead:archdesc/ead:did/ead:repository"group="true"name="repository"level="1"repeatable="true"visible="false"fieldType="group"rulesetName="Repository"> <metadataxpath="@label"xpathType="attribute"name="repositoryLabel"level="1"repeatable="false"visible="true"rulesetName="RepositoryLabel" /> <metadataxpath="ead:address/ead:addressline"xpathType="element"name="repositoryaddressline"level="1"repeatable="true"visible="true"rulesetName="RepositoryAddress" /> <metadataxpath="ead:extref/@href"xpathType="attribute"name="extrefhref"level="1"repeatable="true"visible="true"rulesetName="RepositoryLink" /> <metadataxpath="ead:extref"xpathType="element"name="extref"level="1"repeatable="true"visible="true"rulesetName="RepositoryLinkName" /> </metadata><!-- Identity Statement Area --> <metadataxpath="./ead:control/ead:recordid"xpathType="element"name="recordid"level="1"repeatable="false"fieldType="input"rulesetName="RecordID" /> <metadataxpath="./ead:control/ead:filedesc/ead:titlestmt/ead:titleproper"xpathType="element"name="titleproper"level="1"repeatable="false"visible="true" /> <metadataxpath="./ead:control/ead:eadid"xpathType="element"name="eadid"level="1"repeatable="false"showField="false"fieldType="input"rulesetName="EADID" /> <metadataxpath="(./ead:archdesc/ead:did/ead:unitid[not(@type)] | ./ead:did/ead:unitid[not(@type)])[1]"xpathType="element"name="unitid"level="1"repeatable="false"showField="false"fieldType="input"rulesetName="UnitID" /> <metadataxpath="./ead:did/ead:unitid[@type='shelfmark']"xpathType="element"name="Shelfmark"level="1"repeatable="true"rulesetName="shelfmarksource"validationType="unique"> <validationError>The value has already been used.</validationError> </metadata> <metadataxpath="(./ead:archdesc/ead:did/ead:unittitle | ./ead:did/ead:unittitle)[1]"xpathType="element"name="unittitle"level="1"repeatable="false"fieldType="textarea"rulesetName="TitleDocMain"importMetadataInChild="false"searchable="true"showField="true" /> <metadataxpath="(./ead:archdesc/ead:did/ead:unitdate | ./ead:did/ead:unitdate)"xpathType="element"name="unitdate"level="1"repeatable="false"rulesetName="PublicationYear"importMetadataInChild="false"validationType="date"searchable="true"showField="true"> <validationError>The value must be entered either as a year in the format YYYY or as a date in the format YYYY-MM-DD.</validationError> </metadata> <metadataxpath="(./ead:archdesc/ead:did/ead:unitdatestructured | ./ead:did/ead:unitdatestructured)[1]"xpathType="element"name="unitdatestructured"level="1"repeatable="false"validationType="date"rulesetName="DateOfOrigin"showField="true"> <validationError>The value must be entered either as a year in the format YYYY or as a date in the format YYYY-MM-DD.</validationError> </metadata> <metadataxpath="(./ead:archdesc/@level | ./@level)[1]"xpathType="attribute"name="descriptionLevel"level="1"repeatable="false"fieldType="dropdown"validationType="list"> <value>collection</value> <value>fonds</value> <value>class</value> <value>recordgrp</value> <value>series</value> <value>subfonds</value> <value>subgrp</value> <value>subseries</value> <value>file</value> <value>item</value> <value>otherlevel</value> </metadata> <metadataxpath="(./ead:archdesc/ead:did/ead:physdescstructured|./ead:did/ead:physdescstructured)"xpathType="element"name="physdescstructured"level="1"repeatable="true"rulesetName="physdesc"group="true"fieldType="group"visible="true"> <metadataxpath="ead:quantity"xpathType="element"name="physdescquantity"level="1"repeatable="false"rulesetName="Quantity"visible="true" /> <metadataxpath="ead:unittype"xpathType="element"name="physdescunittype"level="1"repeatable="false"rulesetName="Unittype"visible="true" /> </metadata> <metadataxpath="(./ead:archdesc/ead:did/ead:physdesc/ead:extent|./ead:did/ead:physdesc/ead:extent)"xpathType="element"name="physdesc"level="1"repeatable="false"rulesetName="physicalDescriptionExtent" /><!-- Context Area --> <metadataxpath="(./ead:archdesc/ead:did/ead:origination[@label='Creator']/ead:persname|./ead:did/ead:origination[@label='Creator']/ead:persname)[1]"xpathType="element"name="origination"level="2"repeatable="true"rulesetName="Provenience" /> <metadataxpath="(./ead:archdesc/ead:did/ead:origination[@label='Creator']/ead:corpname|./ead:did/ead:origination[@label='Creator']/ead:corpname)[1]"xpathType="element"name="originationcorpname"level="2"repeatable="true"rulesetName="Provenience" /> <metadataxpath="(./ead:archdesc/ead:odd|./ead:odd)"xpathType="element"name="oddnote"level="2"repeatable="true"visible="true"group="true"fieldType="group"> <metadataxpath="ead:head"xpathType="element"name="role"level="2"repeatable="false"visible="true"fieldType="input" /> <metadataxpath="ead:p"xpathType="element"name="person"level="2"visible="true"repeatable="false"fieldType="input" /> </metadata> <metadataxpath="(./ead:archdesc/ead:bioghist/ead:p | ./ead:bioghist/ead:p)[1]"xpathType="element"name="bioghist"level="2"repeatable="true"fieldType="textarea"rulesetName="BiographicalInformation" /> <metadataxpath="(./ead:archdesc/ead:custodhist/ead:p|./ead:custodhist/ead:p)"group="true"name="custodhist"level="2"repeatable="true"visible="true"fieldType="group"rulesetName="InventoryHistoryGroup"> <metadataxpath="ead:head"xpathType="element"name="AcquisitionMethod"level="2"repeatable="false"visible="false"fieldType="input"rulesetName="AcquisitionMethod" /> <metadataxpath="ead:list/ead:item"xpathType="element"name="AcquisitionAgent"level="2"repeatable="false"visible="false"fieldType="input"rulesetName="AcquisitionAgent" /> <metadataxpath="ead:p"xpathType="element"name="AcquisitionNotes"level="2"repeatable="false"visible="false"fieldType="textarea"rulesetName="AcquisitionNotes" /> </metadata><!-- Content and Structure Area --> <metadataxpath="(./ead:archdesc/ead:scopecontent/ead:p | ./ead:scopecontent/ead:p)[1]"xpathType="element"name="scopecontent"level="3"repeatable="false"fieldType="textarea"rulesetName="ContentDescription" /> <metadataxpath="(./ead:archdesc/ead:appraisal/ead:p | ./ead:appraisal/ead:p)[1]"xpathType="element"name="appraisal"level="3"repeatable="false"fieldType="textarea"rulesetName="AppraisalInformation" /> <metadataxpath="(./ead:archdesc/ead:arrangement/ead:p | ./ead:arrangement/ead:p)[1]"xpathType="element"name="arrangement"level="3"repeatable="false"fieldType="textarea"rulesetName="Arrangement" /><!-- accruals group--> <metadataxpath="(./ead:archdesc/ead:accruals|./ead:accruals)"group="true"name="accruals"level="3"repeatable="true"visible="true"fieldType="group"rulesetName="AccrualsGroup"> <metadataxpath="ead:head"xpathType="element"name="accruals_head"level="3"repeatable="false"visible="true"rulesetName="Title" /> <metadataxpath="ead:p"xpathType="element"name="accruals_p"level="3"repeatable="false"visible="true"rulesetName="Description" /> <metadataxpath="ead:chronlist/ead:chronitem/ead:datesingle"xpathType="element"name="accruals_date"level="3"repeatable="false"visible="true"rulesetName="Date"validationType="date" /> </metadata><!-- Condition of Access and Use Area --> <metadataxpath="(./ead:archdesc/ead:accessrestrict|./ead:accessrestrict)"group="true"name="accessrestrict"level="4"repeatable="true"visible="true"fieldType="group"rulesetName="AccessRestrictGroup"> <metadataxpath="(ead:p|ead:p)"xpathType="element"name="accessrestrict_value"level="4"repeatable="false"fieldType="dropdown"rulesetName="RestrictionOnAccessLicense"importMetadataInChild="true"> <value>open access</value> <value>restricted</value> </metadata> <metadataxpath="ead:chronlist/ead:chronitem/ead:datesingle"xpathType="element"name="accessrestrict_date"level="3"repeatable="false"visible="true"rulesetName="Date"validationType="date" /> </metadata> <metadataxpath="(./ead:archdesc/ead:userestrict/ead:p | ./ead:userestrict/ead:p)[1]"xpathType="element"name="userestrict"level="4"repeatable="false"fieldType="dropdown"importMetadataInChild="true"rulesetName="UseRestriction"> <value>CC0 1.0</value> <value>CC BY 4.0</value> <value>CC BY-SA 4.0</value> <value>CC BY-ND 4.0</value> <value>CC BY-NC 4.0</value> <value>CC BY-NC-SA 4.0</value> <value>CC BY-NC-ND 4.0</value> </metadata> <metadataxpath="./ead:did/ead:langmaterial/ead:language"xpathType="element"name="langmaterial"level="4"repeatable="true"fieldType="textarea"rulesetName="DocLanguage"importMetadataInChild="false"> <value>ger</value> <value>eng</value> <value>fre</value> <value>ita</value> <value>lat</value> <value>spa</value> <value>ara</value> <value>heb</value> </metadata> <metadataxpath="(./ead:archdesc/ead:did/ead:langmaterial[@label='font'] | ./ead:did/ead:langmaterial[@label='font'])[1]"xpathType="element"name="font"level="4"repeatable="false"fieldType="multiselect"rulesetName="FontType"importMetadataInChild="false"> <value>antiqua</value> <value>fracture</value> <value>handwritten</value> <value>mixed</value> <value>no text</value> </metadata> <metadataxpath="(./ead:archdesc/ead:phystech/ead:p | ./ead:phystech/ead:p)"xpathType="element"name="phystech"level="4"repeatable="false"fieldType="textarea"rulesetName="PhysTech" /> <metadataxpath="(./ead:archdesc/ead:otherfindaid|./ead:otherfindaid)"group="true"name="otherfindaid"level="4"repeatable="true"visible="true"fieldType="group"rulesetName="OtherFindAidGroup"> <metadataxpath="(ead:head|ead:head)"xpathType="element"name="otherfindaid_type"level="4"repeatable="false"fieldType="input"rulesetName="Type" /> <metadataxpath="ead:p/ead:ref"xpathType="element"name="otherfindaid_link"level="4"repeatable="false"fieldType="input"rulesetName="OtherFindAid" /> <metadataxpath="ead:p/ead:ptr"xpathType="element"name="otherfindaid_node"level="4"repeatable="false"fieldType="nodelink"rulesetName="OtherFindAid" /> </metadata><!-- Allied Materials Area --><!-- Location of Originals group--> <metadataxpath="(./ead:archdesc/ead:originalsloc|./ead:originalsloc)"group="true"name="originalsloc"level="5"repeatable="true"visible="true"fieldType="group"rulesetName="OriginalsLocationGroup"> <metadataxpath="ead:p/ead:name"xpathType="element"name="originalsloc_person"level="5"repeatable="false"visible="true"rulesetName="Person"fieldType="input" /> <metadataxpath="ead:p/ead:subject"xpathType="element"name="originalsloc_shelfmark"level="5"repeatable="false"visible="true"rulesetName="shelfmarksource" /> <metadataxpath="ead:p/ead:ref"xpathType="element"name="originalsloc_link"level="4"repeatable="false"fieldType="input"rulesetName="RepositoryLink" /> </metadata><!-- Alternative Form Available group--> <metadataxpath="(./ead:archdesc/ead:relatedmaterial|./ead:relatedmaterial)"group="true"name="altformavail"level="5"repeatable="true"visible="true"fieldType="group"rulesetName="CopyLocationGroup"> <metadataxpath="ead:p/ead:name"xpathType="element"name="altformavail_person"level="5"repeatable="false"visible="true"rulesetName="Person"fieldType="input" /> <metadataxpath="ead:p/ead:subject"xpathType="element"name="altformavail_shelfmark"level="5"repeatable="false"visible="true"rulesetName="shelfmarksource" /> <metadataxpath="ead:p/ead:ref"xpathType="element"name="altformavail_link"level="4"repeatable="false"fieldType="input"rulesetName="RepositoryLink" /> </metadata> <metadataxpath="(./ead:archdesc/ead:separatedmaterial/ead:p|./ead:separatedmaterial/ead:p)[1]"xpathType="element"name="separatedmaterial"level="5"repeatable="true"rulesetName="SeparatedMaterial"fieldType="nodelink" /> <metadataxpath="(./ead:archdesc/ead:bibliography|./ead:bibliography)[1]"xpathType="element"name="bibliography"level="5"repeatable="false"rulesetName="BibliographicCitation" /><!-- Note Area --> <metadataxpath="(./ead:archdesc/ead:note/ead:p|./ead:note/ead:p)[1]"xpathType="element"name="didnote"level="6"repeatable="true"fieldType="textarea"rulesetName="DidNote" /> <metadataxpath="./ead:control/ead:localtypedeclaration"xpathType="element"name="Conventions"level="6"repeatable="false"fieldType="textarea"rulesetName="ConventionDeclaration" /> <metadataxpath="./ead:processinfo/ead:chronlist/ead:chronitem/ead:datesingle"xpathType="element"name="DescriptionDates"level="6"repeatable="false"fieldType="textarea"rulesetName="DescriptionDates" /><!-- Description Control Area --> <metadataxpath="./ead:archdesc/ead:processinfo/ead:list/ead:item"xpathType="element"name="editorName"level="7"repeatable="true"fieldType="textarea"visible="false" /> <metadataxpath="./ead:processinfo/ead:p"xpathType="element"name="ArchivistNote"level="7"repeatable="false"fieldType="textarea"rulesetName="ArchivistNote" /> <metadataxpath="./ead:control/ead:conventiondeclaration/ead:abbr"xpathType="element"name="conventiondeclaration"level="7"repeatable="false"fieldType="multiselect"> <value>ISAD(G)</value> <value>NCARules</value> <value>ISO 8601</value> <value>DACS</value> </metadata> <metadataxpath="./ead:control/ead:maintenancehistory/ead:maintenanceevent"group="true"name="maintenancehistory"level="7"repeatable="true"visible="false"fieldType="group"> <metadataxpath="ead:eventtype"xpathType="element"name="eventtype"level="1"repeatable="false"visible="false" /> <metadataxpath="ead:agent"xpathType="element"name="agent"level="1"repeatable="false"visible="false" /> <metadataxpath="ead:eventdescription"xpathType="element"name="eventdescription"level="1"repeatable="false"visible="false" /> <metadataxpath="ead:eventdatetime"xpathType="element"name="eventdatetime"level="1"repeatable="false"visible="false" /> </metadata><!-- viaf sample <metadata xpath="./ead:archdesc/ead:index/ead:indexentry/ead:corpname/ead:part" xpathType="element" name="Corporate" level="7" repeatable="true" searchable="true" showField="true" fieldType="viaf" searchFields="210__a; 111__a; 100__a; 110__a; 150__a; 151__a;" displayFields="001=NORM_IDENTIFIER; 0247_a=URI; 1001_a=NORM_NAME; 1001_d=NORM_LIFEPERIOD; 1001_q=NORM_SEX; 375__a=NORM_SEX;" /> --><!-- geonames sample <metadata xpath="./ead:archdesc/ead:index/ead:indexentry/ead:geogname/ead:part[@localtype='place']" xpathType="element" name="Place" level="7" repeatable="true" fieldType="geonames" visible="true" /> --><!-- gnd sample <metadata xpath="./ead:archdesc/ead:index/ead:indexentry/ead:persname/ead:part" xpathType="element" name="Person" level="7" repeatable="true" fieldType="gnd" visible="true" /> --><!-- extend configured areas --> <showGrouplevel="1" /><!-- <showGroup level="2" /> <showGroup level="3" /> <showGroup level="4" /> <showGroup level="5" /> <showGroup level="6" /> <showGroup level="7" /> --> <treeView><!-- tree view: display/hide node id--> <showNodeId>false</showNodeId> </treeView><!-- enables template and project name selection in process creation area --> <showProjectSelection>false</showProjectSelection><!-- possible namespaces: ead2: urn:isbn:1-931666-22-9 ead3: http://ead3.archivists.org/schema/ ead4: https://archivists.org/ns/ead/v4 --> <eadNamespaceRead>http://ead3.archivists.org/schema/</eadNamespaceRead> <eadNamespaceWrite>http://ead3.archivists.org/schema/</eadNamespaceWrite> <nodename="file"ruleset="File"icon="fa fa-file-text-o"processTemplateId="456" /> <nodename="folder"ruleset="Folder"icon="fa fa-folder-open-o"processTemplateId="456" /> <nodename="image"ruleset="Picture"icon="fa fa-file-image-o"processTemplateId="456" /> <nodename="audio"ruleset="Audio"icon="fa fa-file-audio-o"processTemplateId="456" /> <nodename="video"ruleset="Video"icon="fa fa-file-video-o"processTemplateId="456" /> <nodename="other"ruleset="Other"icon="fa fa-file-o"processTemplateId="456" /> </config> <config> <archive>ead2 sample</archive> <processTemplateId>2</processTemplateId> <nodeDefaultTitle>Document</nodeDefaultTitle> <lengthLimit>25</lengthLimit> <separator>_</separator> <useIdFromParent>false</useIdFromParent> <useShelfmarkAsId>false</useShelfmarkAsId> <metadataxpath="./ead:eadheader[@countryencoding='iso3166-1'][@dateencoding='iso8601'][@langencoding='iso639-2b'][@repositoryencoding='iso15511'][@scriptencoding='iso15924']/ead:eadid/@mainagencycode"xpathType="attribute"name="mainagencycode"level="1"repeatable="false"visible="false"/> <metadataxpath="./ead:eadheader/ead:profiledesc/ead:creation/@normal"xpathType="attribute"name="normalcreationdate"level="1"repeatable="false"visible="false"/> <metadataxpath="./ead:eadheader/ead:profiledesc/ead:creation"xpathType="element"name="creationdate"level="1"repeatable="false"visible="false"/> <metadataxpath="./ead:eadheader/ead:filedesc/ead:titlestmt/ead:titleproper"xpathType="element"name="titlestmt"level="1"repeatable="false"visible="false"/><!-- Identity Statement Area --> <metadataxpath="./ead:control/ead:maintenanceagency/ead:agencycode"xpathType="element"name="agencycode"level="1"repeatable="false"fieldType="input"/> <metadataxpath="./ead:eadheader/ead:eadid"xpathType="element"name="eadid"level="1"repeatable="false"showField="false"fieldType="input"rulesetName="EADID"/> <metadataxpath="./ead:control/ead:recordid"xpathType="element"name="recordid"level="1"repeatable="false"fieldType="input"rulesetName="RecordID"/> <metadataxpath="(./ead:archdesc/ead:did/ead:unitid[not(@type)] | ./ead:did/ead:unitid[not(@type)])[1]"xpathType="element"name="unitid"level="1"repeatable="false"showField="false"fieldType="input"rulesetName="UnitID"/> <metadataxpath="./ead:did/ead:unitid[@type='Vorl. Nr.']"xpathType="element"name="Number"level="1"repeatable="true" /> <metadataxpath="./ead:did/ead:unitid[@type='Altsignatur']"xpathType="element"name="Shelfmark"level="1"repeatable="true"rulesetName="shelfmarksource"validationType="unique"> <validationError>Der Wert wurde an anderer Stelle bereits verwendet</validationError> </metadata> <metadataxpath="(./ead:archdesc/ead:did/ead:unittitle | ./ead:did/ead:unittitle)[1]"xpathType="element"name="unittitle"level="1"repeatable="false"fieldType="textarea"rulesetName="TitleDocMain"importMetadataInChild="false" /> <metadataxpath="(./ead:archdesc/ead:did/ead:unitdate | ./ead:did/ead:unitdate)[1]"xpathType="element"name="unitdate"level="1"repeatable="false"rulesetName="PublicationYear"importMetadataInChild="false"regularExpression="\\d{4}"validationType="regex"> <validationError>Der Wert ist keine vierstellige Jahreszahl</validationError> </metadata> <metadataxpath="(./ead:archdesc/ead:did/ead:unitdatestructured | ./ead:did/ead:unitdatestructured)[1]"xpathType="element"name="unitdatestructured"level="1"repeatable="false"rulesetName="DateOfOrigin"/> <metadataxpath="(./ead:archdesc/@level | ./@level)[1]"xpathType="attribute"name="descriptionLevel"level="1"repeatable="false"fieldType="dropdown"> <value>collection</value> <value>fonds</value> <value>class</value> <value>recordgrp</value> <value>series</value> <value>subfonds</value> <value>subgrp</value> <value>subseries</value> <value>file</value> <value>item</value> <value>otherlevel</value> </metadata> <metadataxpath="(./ead:archdesc/ead:did/ead:physdesc | ./ead:did/ead:physdesc)[1]"xpathType="element"name="physdesc"level="1"repeatable="false"rulesetName="Format" /> <metadataxpath="(./ead:archdesc/ead:did/ead:physdescstructured | ./ead:did/ead:physdescstructured)[1]"xpathType="element"name="physdescstructured"level="1"repeatable="false"rulesetName="physicalDescriptionExtent" /><!-- Context Area --> <metadataxpath="(./ead:archdesc/ead:did/ead:origination | ./ead:did/ead:origination)[1]"xpathType="element"name="origination"level="2"repeatable="true"rulesetName="Provenience"/> <metadataxpath="(./ead:archdesc/ead:odd/ead:head | ./ead:odd/ead:head)[1]"xpathType="element"name="role"level="2"repeatable="false"fieldType="vocabulary"> <vocabulary>Rollen</vocabulary><!--<searchParameter>type=visible</searchParameter>--> </metadata> <metadataxpath="(./ead:archdesc/ead:odd/ead:p | ./ead:odd/ead:p)[1]"xpathType="element"name="person"level="2"repeatable="false"/> <metadataxpath="(./ead:archdesc/ead:dsc/ead:bioghist | ./ead:dsc/ead:bioghist)[1]"xpathType="element"name="bioghist"level="2"repeatable="true"fieldType="textarea"rulesetName="BiographicalInformation" /> <metadataxpath="(./ead:archdesc/ead:dsc/ead:custodhist | ./ead:dsc/ead:custodhist)[1]"xpathType="element"name="custodhist"level="2"repeatable="false"fieldType="textarea"rulesetName="InventoryHistory"/> <metadataxpath="(./ead:archdesc/ead:dsc/ead:acqinfo | ./ead:dsc/ead:acqinfo)[1]"xpathType="element"name="acqinfo"level="2"repeatable="false"fieldType="dropdown"rulesetName="AquisitionInformation" > <value>value 1</value> <value>value 2</value> <value>...</value> </metadata><!-- Content and Structure Area --> <metadataxpath="(./ead:archdesc/ead:dsc/ead:scopecontent | ./ead:dsc/ead:scopecontent)[1]"xpathType="element"name="scopecontent"level="3"repeatable="false"fieldType="textarea"rulesetName="ContentDescription"/> <metadataxpath="(./ead:archdesc/ead:dsc/ead:appraisal | ./ead:dsc/ead:appraisal)[1]"xpathType="element"name="appraisal"level="3"repeatable="false"fieldType="textarea"rulesetName="AppraisalInformation"/> <metadataxpath="(./ead:archdesc/ead:dsc/ead:accruals | ./ead:dsc/ead:accruals)[1]"xpathType="element"name="accruals"level="3"repeatable="true"fieldType="textarea"rulesetName="Additions"/> <metadataxpath="(./ead:archdesc/ead:dsc/ead:arrangement | ./ead:dsc/ead:arrangement)[1]"xpathType="element"name="arrangement"level="3"repeatable="false"fieldType="textarea"rulesetName="Arrangement"/><!-- Condition of Access and Use Area --> <metadataxpath="(./ead:archdesc/ead:dsc/ead:accessrestrict | ./ead:dsc/ead:accessrestrict)[1]"xpathType="element"name="accessrestrict"level="4"repeatable="false"fieldType="dropdown"rulesetName="RestrictionOnAccessLicense"importMetadataInChild="true"> <value>open access</value> <value>restricted</value> <value>required registration</value> </metadata> <metadataxpath="(./ead:archdesc/ead:dsc/ead:userestrict | ./ead:dsc/ead:userestrict)[1]"xpathType="element"name="userestrict"level="4"repeatable="false"fieldType="dropdown"importMetadataInChild="true"rulesetName="UseRestriction"> <value>damaged</value> <value>good condition</value> </metadata> <metadataxpath="(./ead:archdesc/ead:did/ead:langmaterial[@label='Language']/ead:language | ./ead:did/ead:langmaterial[@label='Language']/ead:language)[1]"xpathType="element"name="langmaterial"level="4"repeatable="false"fieldType="multiselect"rulesetName="DocLanguage"importMetadataInChild="false"> <value>eng</value> <value>ger</value> <value>dut</value> <value>fre</value> <value>esp</value> <value>ita</value> <value>lat</value> <value>pol</value> <value>rus</value> <value>swe</value> </metadata> <metadataxpath="(./ead:archdesc/ead:did/ead:langmaterial[@label='font'] | ./ead:did/ead:langmaterial[@label='font'])[1]"xpathType="element"name="font"level="4"repeatable="false"fieldType="multiselect"rulesetName="FontType"importMetadataInChild="false"> <value>antiqua</value> <value>fracture</value> <value>handwritten</value> <value>mixed</value> <value>no text</value> </metadata> <metadataxpath="(./ead:archdesc/ead:dsc/ead:phystech | ./ead:dsc/ead:phystech)[1]"xpathType="element"name="phystech"level="4"repeatable="false"fieldType="textarea"rulesetName="PhysTech" /> <metadataxpath="(./ead:archdesc/ead:dsc/ead:otherfindaid | ./ead:dsc/ead:otherfindaid)[1]"xpathType="element"name="otherfindaid"level="4"repeatable="false"fieldType="textarea"rulesetName="OtherFindAid"/><!-- Allied Materials Area --> <metadataxpath="(./ead:archdesc/ead:dsc/ead:originalsloc | ./ead:dsc/ead:originalsloc)[1]"xpathType="element"name="originalsloc"level="5"repeatable="false"fieldType="dropdown"rulesetName="OriginalsLocation"> <value>value 1</value> <value>value 2</value> </metadata> <metadataxpath="(./ead:archdesc/ead:dsc/ead:altformavail | ./ead:dsc/ead:altformavail)[1]"xpathType="element"name="altformavail"level="5"repeatable="false"fieldType="dropdown"rulesetName="AlternativeFormAvailable"> <value>value 1</value> <value>value 2</value> </metadata> <metadataxpath="(./ead:archdesc/ead:dsc/ead:relatedmaterial/ead:separatedmaterial | ./ead:dsc/ead:relatedmaterial/ead:separatedmaterial)[1]"xpathType="element"name="separatedmaterial"level="5"repeatable="false"rulesetName="SeparatedMaterial"/> <metadataxpath="(./ead:archdesc/ead:dsc/ead:bibliography | ./ead:dsc/ead:bibliography)[1]"xpathType="element"name="bibliography"level="5"repeatable="false"rulesetName="BibliographicCitation"/><!-- Note Area --> <metadataxpath="(./ead:archdesc/ead:did/ead:didnote | ./ead:did/ead:didnote)[1]"xpathType="element"name="didnote"level="6"repeatable="false"fieldType="textarea"rulesetName="DidNote"/> <metadataxpath="(./ead:archdesc/ead:dsc/ead:odd | ./ead:dsc/ead:odd)[1]"xpathType="element"name="oddnote"level="6"repeatable="false"fieldType="textarea"rulesetName="Odd" /><!-- Description Control Area --> <metadataxpath="./ead:control/ead:conventiondeclaration"xpathType="element"name="conventiondeclaration"level="7"repeatable="false"fieldType="multiselect"rulesetName="ConventionDeclaration"> <value>val 1</value> <value>val 2</value> <value>val 3</value> <value>val 4</value> </metadata> <eadNamespaceRead>urn:isbn:1-931666-22-9</eadNamespaceRead> <eadNamespaceWrite>urn:isbn:1-931666-22-9</eadNamespaceWrite> <nodename="file"ruleset="File"icon="fa fa-file-text-o"processTemplateId="309544" /> <nodename="folder"ruleset="Folder"icon="fa fa-folder-open-o"processTemplateId="309544"/> <nodename="image"ruleset="Picture"icon="fa fa-file-image-o"processTemplateId="309544" /> <nodename="audio"ruleset="Audio"icon="fa fa-file-audio-o"processTemplateId="309544"/> <nodename="video"ruleset="Video"icon="fa fa-file-video-o"processTemplateId="309544"/> <nodename="other"ruleset="Other"icon="fa fa-file-o"processTemplateId="309544" /> </config></config_plugin>
General configuration
The connection to the Goobi viewer is configured in the <export> area. The location to which an export as EAD-XML is to be made and which inventories are to be exported are defined here. The export takes place automatically at regular intervals or can be started manually from the user interface.
In the second area <backup> an automatic backup of the individual inventories can be configured. A separate file is created for each inventory. You can define how many backups should be kept and which tool should be used to create the backups. If a password is required for database access, this can also be configured here.
This is followed by a repeatable <config> block. The repeatable <archive> element can be used to specify which files the <config> block should apply to. If there is to be a default block that applies to all documents, * can be used.
The <processTemplateId> is used to specify the production template on the basis of which the Goobi processes are to be created.
Configuration of the generation of task titles
The parameters <lengthLimit><separator><useIdFromParent> and <title> are used to configure the naming of the task to be generated:
The value <lengthLimit> sets a length limit for all tokens except the manually set prefix and suffix. The default setting is 0, i.e. it does not limit the length.
The parameter <separator> defines the separator to be used to combine all separate tokens. The default setting is _.
The parameter <useIdFromParent> configures whose ID should be used to create the task title. If it is set to true, the ID of the parent node is used. Otherwise, the ID of the current node is used.
The <title> parameter configures which metadata should be used for the title generation. The value attribute can contain a static text or the name attribute can contain the name of a metadata field. The type is used to control what should happen with the value NORMAL inserts the field unchanged, CAMEL_CASE replaces spaces and starts each word with a capital letter, AFTER_LAST_SEPARATOR always inserts the field at the end, BEFORE_FIRST_SEPARATOR always inserts it at the beginning. If no title has been configured, the process title is formed on the basis of the node ID.
Configuration of the reference between node and process
The two parameters <nodeIdentifierField> and <processIdentifierField> are used to link the node and the process. The <nodeIdentifierField> field contains the name of the field that contains the identifier of the node. Any configured field can be used. Unless otherwise specified, id is used. The <processIdentifierField> contains the metadata in which the identifier of the node is to be saved. This is usually NodeId.
If a new EAD file is imported or the ‘ Update references to processes ’ button is used, the configured metadata is searched for in all processes. The system then compares whether the metadata contains the value that is entered in the field in a node. If this is the case, a link is created between the node and the process. For all nodes for which no match was found, any existing links are removed.
Configuration of the metadata fields
This is followed by a list of <metadata> elements. This controls which fields are displayed, can be imported, how they should behave and whether there are validation rules.
Mandatory information
Each metadata field consists of at least the following mandatory information:
Value
Description
name
This value is used to identify the field. It must therefore contain a unique name. If the value has not been configured separately in the messages files, it is also used as the label of the field.
level
This defines the area in which the metadata is inserted. The numbers 1-7 are permitted: 1. identification, 2. context, 3. content and internal organisation, 4. conditions of access and use, 5. related documents, 6. notes, 7. directory control.
Optional information
There are also a number of other optional details:
Value
Description
xpath
Defines an XPath expression that is used both for reading from existing EAD files and for writing the EAD file. In the case of the main element, the path is relative to the <ead> element; for all other nodes, it is always relative to the <c> element.
@xpathType
This defines whether the XPath expression returns an element (default), an attribute or a text.
@visible
This can be used to control whether the metadata is displayed in the mask or hidden. The field may contain the two values true (default) and false.
@repeatable
Defines whether the field is repeatable. The field may contain the two values true and false (default).
@showField
Defines whether the field is displayed open in the detail display, even if no value is yet available. The field may contain the two values true and false (default).
@rulesetName
A metadata from the rule set can be specified here. When a Goobi process is created for the node, the configured metadata is created.
@importMetadataInChild
This can be used to control whether the metadata should also be created in Goobi processes of child nodes. The field may contain the two values true and false (default).
@fieldType
Controls the behaviour of the field. Possible are input (default) , textarea, dropdown, multiselect, vocabulary, nodelink, gnd, geonames, viaf
value
This sub-element is only used for the two types ‘dropdown’ and ‘multiselect’ and contains the possible values that are to be available for selection.
vocabulary
This sub-element contains the name of the vocabulary to be used. It is only evaluated if vocabulary, dropdown or multiselect is set in the field type and no <value> elements have been configured. The selection list contains the main value of each record.
searchParameter
This repeatable subfield can be used to define search parameters with which the vocabulary is filtered, the syntax is fieldname=value.
@validationType
Here you can set whether the field should be validated. Different rules are possible, which can be combined. unique checks that the content of the field has not been used elsewhere, required ensures that the field contains a value. The type regex can be used to check whether the value filled in corresponds to a regular expression, date checks whether the value corresponds to an EDTF date and list tests whether the value used is contained in the configured list.
Several validation rules can also be combined, for example unique+required, regex+required, regex+unique or date+required. In this case, all specified rules must be fulfilled.
@regularExpression
The regular expression to be used for regex validation is specified here. IMPORTANT: the backslash must be masked by a second backslash. A class is therefore not defined by \w, but by \w.
validationError
This subfield contains a text that is displayed if the field content violates the validation rules.
@searchable
This can be used to control whether the metadata should be offered as a field in the advanced search. The field may contain the two values true and false (default).
<metadataxpath="(./ead:archdesc/ead:did/ead:unitdate | ./ead:did/ead:unitdate)[1]"xpathType="element"name="unitdate"level="1"repeatable="false"rulesetName="PublicationYear"importMetadataInChild="false"regularExpression="^([0-9]{4}\\-[0-9]{2}\\-[0-9]{2}|[0-9]{4})(\\s?\\-\s?([0-9]{4}\\-[0-9]{2}\\-[0-9]{2}|[0-9]{4}))?$"validationType="regex"> <validationError>Der Wert ist keine Datumsangabe. Erlaubte Werte sind entweder Jahreszahlen (YYYY), exakte Datumsangaben (YYYY-MM-DD) oder Zeiträume (YYYY - YYYY, YYYY-MM-DD-YYYY-MM-DD)</validationError></metadata>
Validation of dates in EDTF format
<metadataxpath="(./ead:archdesc/ead:did/ead:unitdate | ./ead:did/ead:unitdate)[1]"xpathType="element"name="unitdate"level="1"repeatable="false"rulesetName="PublicationYear"importMetadataInChild="false"validationType="date"> <validationError>Der Wert ist keine Datumsangabe</validationError></metadata>
In the default setting, the individual sections 1 Identification, 2 Context, 3 Content and internal organisation, 4 Access and usage conditions, 5 Related documents, 6 Notes and 7 Directory control are collapsed for reasons of space and are not displayed. The element <showGroup level=‘1’ /> can be used so that they are already expanded and displayed when a node is selected. The ordinal number in the level attribute is used to control which area is expanded. The attribute <showField=‘true’ can be used within the <metadata> definition to display unfilled metadata immediately without adding it using a badge.
Configuration of the XML namespace
The two elements <eadNamespaceRead> and <eadNamespaceWrite> define which XML namespaces are to be used for reading and writing EAD documents. Usually both contain the same value. However, EAD2 documents can also be read and exported as EAD3 documents. In this case, the corresponding namespaces must be defined and care must be taken in the xpath expressions of the individual metadata to ensure that both variants are specified. It is therefore easier to use the enclosed converter and convert from EAD2 to EAD3 before importing the documents.
Namespace for ead2 (deprecated): urn:isbn:1-931666-22-9
Namespace for ead3 (current): http://ead3.archivists.org/schema/
Namespace for ead4 (in draft status): https://archivists.org/ns/ead/v4
