Storage

The package "storage" contains steps that interact with a Fedora Repository.

Storage: check checksums in Fedora

deprecated

Compares the objects from the ORIGINAL datastream in Fedora with the generated checksum.

java ch.docuteam.actions.storage.ChecksumChecker \
     -e "[mailto:]<recipient>" \
     [-s subjectOk|subjectError|subjectNoConnection] \
     [-n namespace..]

Parameter	Description
-e (or --email) <recipient>	URL of type mailto:recipient@example.com. If protocol is omitted it is automatically prepended to the email address
`-s (or --subject) subjectOk	<br/> subjectError
-n (or --namespace) [namespace] [namespace] ...	(optional): Fedora namespaces separated by space; if no namespace is given, all namespaces are checked.

Storage: create Fedora objects

deprecated

Converts a METS package into a Fedora Object (FOXML) file

java ch.docuteam.actions.storage.FOXMLCreator \
     [path/to/]SIP

Parameter	Description
[path/to/]SIP	name of the SIP. If no path is given, it will be expected to be in the location defined by the actions.workbench.work property

Storage: deliver DIP

deprecated

Fetches the objects from the repository using a PID (fedora persistent unique identifier) or a PUID (pronom persistent unique identifier), generates and delivers a DIP using docuteam rservices.

java ch.docuteam.actions.storage.DIPDeliverer \
     ['pid'|'puid'] [PID|PUID] [targetLocation]

Parameter	Description
`['pid'	'puid']`
`[PID	PUID]`
[targetLocation]	(optional): Location where to save the DIP

Storage: transfer Fedora objects to repository

deprecated

Transfers Fedora objects to a Fedora repository.

java ch.docuteam.actions.storage.FOXMLIngester \
     [path/to/]SIP [keepFOXML]

Parameter	Description
[path/to/]SIP	name of the SIP. If no path is given, it will be expected to be in the location defined by the actions.workbench.storage property
keepFOXML	(optional): One of `true

Storage: update Fedora object

deprecated

Stores new object versions in the Fedora repository.

java ch.docuteam.actions.storage.FedoraObjectUpdater \
     [path/to/]SIP

Parameter	Description
[path/to/]SIP	name of the SIP. If no path is given, it will be expected to be in the location defined by the actions.workbench.work property

Storage: validate METS

deprecated

Validates the mets.xml file with the associated schema and adds the root element namespace to the elements. This is a necessary preparation in case the mets.xml needs to be split into different parts. This is the case, for example, when different Fedora object files are to be created from one SIP.

java ch.docuteam.actions.storage.METSValidator \
     [path/to/]SIP [withEAD]

Parameter	Description
[path/to/]SIP	path of the SIP; if no path is given, it will be expected to be in the location defined by the actions.workbench.work property
[withEAD]	whether to include EAD as descriptive metadata and create a datastream in the fedora objects; defaults to false

Storage: assign PIDs

deprecated

Assigns a Fedora generated PID to all nodes of a SIP.

java ch.docuteam.actions.storage.PIDAssigner \
     [path/to/]SIP

Parameter	Description
[path/to/]SIP	name of the SIP. If no path is given, it will be expected to be in the location defined by the actions.workbench.work property

Storage: add PIDs from docuteam box

Assigns a PID generated by docuteam box to every node of a SIP. A PID is minted using a prefix and a incremented number, concatenated using a colon in between.

java ch.docuteam.actions.storage.pid.AddPIDsFromBox \
     --sip=[path/to/]SIP [--prefix=PID-prefix]

Parameter	Description
--sip	Name of the SIP; if no path is given, it will be expected to be in the location defined by the actions.workbench.work property
--prefix	Prefix of the PIDs to mint; optional, defaults to the ISIL code of the SIP's submission agreement

Storage: save or send PID list

deprecated

Saves the file PIDs.txt or sends it to a URL. This file is a result of the step 'Storage: transfer Fedora objects to repository'.

java ch.docuteam.actions.storage.PIDListPublisher \
     [path/to/]SIP receiverURL

Parameter	Description
[path/to/]SIP	path of the SIP; if no path is given, it will be expected to be in the location defined by the actions.workbench.storage property
receiverURL	An URL in the style of `file:

Storage: rename SIP

Renames a SIP using the PID of the root element in mets.xml file as a prefix. This step requires PID as the accessorName in the levels.xml file.

java ch.docuteam.actions.storage.RenameSIPasAIPforIaaS \
     [path/to/]SIP [targetFolder]

Parameter	Description
[path/to/]SIP	path of the SIP; if only the name is given, it will be expected to be in the location defined by the actions.workbench.inbox property
[targetFolder]	directory where to put the AIP to; if omitted, the AIP will be copied to the location defined by the actions.workbench.output property

Storage: update excel with PID

Writes PIDs of a SIP to an Excel spreadsheet. The table must have a column marked 'identifier' or 'id' in the first row. The PIDs are written in the column marked 'PID' or - if such a column is missing - in the next free column.

java ch.docuteam.actions.storage.UpdateExcelWithPID \
     [path/to/]SIP path/to/folder/with/excel

Parameter	Description
[path/to/]SIP	path to the SIP; if relative path is given, try to find it in actions.workbench.work
path/to/folder/with/excel	path to the excel files to be updated