Skip to content

Usage@Sip profiles

Jan Tomášek edited this page Dec 15, 2020 · 7 revisions
  • Usecase: administration of SIP profiles

SIP profile is a structured file that contains rules for mapping of the compulsory and non-compulsory metadata contained in the original SIP to the ARCLibXml.

Attribute Description
Name name of the SIP profile used in the list of SIP packages
XSL transformation XSL stylesheet for transformation of metadata from SIP to ARCLibXml
Path to XML file with authorial ID specified by regular expression regular expression describing file path to the file storing the authorial ID
XPath to node with authorial ID in within XML file XPath 3.1 (without namespace prefixes) specifying the node with authorial ID in within the aforementioned file
Path to main metadata file of SIP (e.g. METS.xml) specified by regular expression regular expression describing path to main metadata file of SIP that is used in the XSL template as the starting point for ARClibXml generation
Editable True if the sip profile is able to be edited, false otherwise. Initial value is true (set upon creation of a new sip profile), switches to false automatically in the moment when the sip profile is used in a producer profile with the attribute debugging mode set to false (see https://github.com/LIBCAS/ARCLib/wiki/Usage:-Debug-Mode). A sip profile with the editable set to false cannot be edited anymore and the attribute editable cannot be switched back to true. The reason is that in the production environment the content of SIP profiles should not change, so that it was possible to track the exact configuration which was used for the past ingests using the given SIP profile.

Regular expressions should match the path starting with SIP name. For example to match a MetsXY.xml file in a SIP with name 0b8d8e11-092e-4424-8339-6a8d0f103ea2 the regex could be 0b8d8e11-092e-4424-8339-6a8d0f103ea2/MetsXY.xml or more generally (any SIP name) [^/]+/MetsXY.xml or more generally (any SIP name and any .xml file with mets prefix, ignoring case) [^/]+/(?i)mets.*.xml .. Expressions are evaluated directly by Java, online tool for debugging might be handy.

A template for creation of XSL transformation files for SIP profiles can be found at system/src/test/resources/sipProfiles/xslts/templateSipProfile.xsl. A sample XSL transformation file containing complete mapping of attributes is accessible at system/src/test/resources/sipProfiles/xslts/comprehensiveSipProfile.xsl.

Action Description
Create From the dashboard, user creates a new SIP profile.
Edit From the dashboard, user clicks on one SIP profile from list. On the SIP profile detail page the SIP profile can be edited. User clicks on the Save and close button to save the changes.
Delete From the dashboard, user clicks on the Delete button next to a list item.

[^/]/data/(?i)mets..xml

Clone this wiki locally