Submission

Das Package submission beinhaltet Schritte im Zusammenhang mit der Bildung und Anlieferung von SIPs.

Submission: Übersicht der Agreements generieren

Generiert eine Übersicht über die Submission Agreements in einem bestimmten Ordner.

java ch.docuteam.actions.submission.AgreementsOverviewGenerator \
     agreements_directory output_type output_directory

Parameter	Beschreibung
agreements_directory	Ort, wo sich die Submission Agreements befinden
output_type	Eines der drei: { Hierarchy|Flat|CSV }, definiert die Struktur der resultierenden Übersichtsdatei
output_directory	Zielort für die erstellte Übersichtsdatei. Default ist der Ordner, in welchem sich die Agreements befinden.

Submission: Ordner überprüfen

Überprüft, ob die Grösse eines SIPs, die Dateigrössen und die Dateipfade einen maximalen Wert nicht überschreiten.

java ch.docuteam.actions.submission.CheckFolder \
     [/path/to/]folder maxTotalSize maxSingleFileSize maxFilePathLength

Parameter	Beschreibung
/path/to/]folder	Pfad des zu überprüfenden Ordners. Wenn kein Pfad angegeben wird, wird angenommen, dass der Pfad durch actions.workbench.work bestimmt wird.
maxTotalSize	Die maximal erlaubte Grösse, die der Ordner haben kann
maxSingleFileSize	Die maximal erlaubte Grösse, die eine Datei im SIP haben kann
maxFilePathLength	Die maximal erlaubte Länge der Dateipfade im Ordner

Submission: SIP aus CSV erstellen

Erstellt ein SIP gemäss dem Matterhorn METS-Profil anhand der Struktur und der beschreibenden Metadaten in einer CSV-Datei.

Die Anforderungen zur Parametrisierung sowie der CSV-Datei sind in der analogen Aktion von docuteam packer beschrieben.

java ch.docuteam.actions.submission.CreateSIPFromCSV \
     --csv=[path/to/CSV] --mappingFile=[path/to/mappingFile] --submissionAgreement=[path/to/submissionAgreement] --dataSubmissionSession=[data submission session id] --outputFolder=[/path/to/folder]

Parameter	Beschreibung
--csv	Pfad zum CSV, mit welchem das SIP erstellt werden soll
--mappingFile	Datei, welche das Mapping enthält
--submissionAgreement	Submission Agreement Datei
--dataSubmissionSession	ID der Submission Session
--outputFolder	optional, gibt den Output-Ordner an. Default: actions.workbench.inbox
--checksum	optional, gibt an, ob die Checksummen im erstellten SIP mit den Checksummen im csv verglichen werden soll. Default: false
--skipLevelValidation	optional, gibt an, ob die Validierung nach levels.xml übersprungen werden soll. Default: false

Submission: SIP aus Excel erstellen

Erstellt ein SIP gemäss dem Matterhorn METS-Profil anhand der Struktur und der beschreibenden Metadaten in einem Excel-Tabellenblatt.

Voraussetzungen:

• Es wird das erste Tabellenblatt berücksichtigt.
• Dieses Blatt muss eine Spalte path enthalten, die alle Dateien und Ordner auflistet, die in das SIP verpackt werden sollen.
• Die Datei- und Ordnerpfade können entweder absolut oder relativ angegeben werden. Nicht erlaubt ist eine gemischte Angabe von relativen und absoluten Pfaden.
• Das Blatt muss ebenfalls eine Spalte levelOfDescription enthalten. Hier dürfen nur Werte eingetragen werden, die in der Datei levels.xml als erlaubt angegeben sind.
• Es dürfen nur Metadatenfelder angegeben werden, die in der Datei levels.xml für die entsprechende Beschreibungsstufe vorgesehen sind. Undefinierte Metadatenfelder werden als Warnung geloggt.

java ch.docuteam.actions.submission.CreateSIPFromExcel \
     [path/to/]Excelfile saID dssID [path/to/target/directory]

Parameter	Beschreibung
[path/to/]Excelfile	Name oder Pfad der Excel-Datei ohne Dateiendung. Default wenn der Pfad weggelassen wird: actions.workbench.preparation
saID	String der gebraucht wird, um auf ein Submission Agreement zu verweisen
dssID	String der gebraucht wird, um auf eine Data Submission Session im Submission Agreement zu verweisen
[path/to/target/directory]	Pfad zum Ordner, wo das SIP platziert werden soll. Optional. Default: actions.workbench.preparation

Submission: SIP von Datei oder Ordner erstellen

Generiert ein SIP aus einer Datei oder einem Ordner. Falls ein Ordner angegeben ist, kann über einen Parameter gesteuert werden, ob ein SIP für den ganzen Ordner kreiert werden soll oder je ein SIP für jede einzelne Datei oder Unterordner in diesem Ordner. Die Action arbeitet rekursiv und fügt dem SIP auch Dateien in Unterordnern hinzu.

java ch.docuteam.actions.submission.CreateSIPsFromFileOrFolder \
     source split saID dssID author zipped [outputDir]

Parameter	Beschreibung
source	Datei oder Ordner aus welchem ein SIP generiert werden soll. Ist ein relativer Pfad gegeben, wird angenommen, dass das Ziel sich im Ordner befindet, der von actions.workbench.preparation definiert wird.
split	Falls true, wird für jede Datei / Ordner in der source ein separates SIP erstellt (angenommen, source ist ein Ordner)
saID	Wert, der gebraucht wird, um auf ein Submission Agreement in einem SIP zu verweisen. Die Aktion wird Dateiformate überspringen, welche im Submission Agreement nicht erlaubt sind.
dssID	Wert, der gebraucht wird, um auf eine Data Submission Session des zugehörigen Submission agreements zu verweisen
author	Ersteller:in des SIP
zipped	Falls true, erstelle gezippte SIPs
[outputDir]	optionaler Ort, wo die SIPs gespeichert werden sollen. Falls weggelassen, wird actions.workbench.work verwendet.

Submission: umbenennen nach Datum und Eigentümer:in

Benennt einen Ordner um. Dem Ordnername wird Datum und Eigentümer in der Form "yyyyMMdd_[file owner]_" vorangestellt.

java ch.docuteam.actions.submission.RenameByDateAndOwner \
     [/path/to/]folder

Parameter	Beschreibung
[/path/to/]folder	Namen des Ordners, der umbenannt werden soll. Falls kein Pfad gegeben wird, wird angenommen, dass der Standort durch actions.workbench.inbox gegeben ist.

Submission: SIPs von Ordner submitten

Wählt SIPs aus und übergibt diese über die REST-Schnittstelle an docuteam feeder-Workflows.

java ch.docuteam.actions.submission.SubmitSIPsFromFolder \
     inbox errorbox filter feeder_url workflows user password \
     useAbsolutePaths checkEmptyQueue [maxNumberSIPs]

Parameter	Beschreibung
inbox	Pfad zum Ordner, der die SIPs enthält
errorbox	Pfad zum Ordner, der fehlerhafte SIPs enthalten soll
filter	Regex filter String für die SIPs in der Inbox, die Regex-Expression muss in Anführungszeichen geschrieben werden!
feeder_url	URL zur Seite von feeder, z.B. http://localhost/feeder
workflows	Komma separierte Liste von Workflows, welche auf jedem SIP ausgeführt werden sollen
user	Username für feeder
password	Password für feeder
useAbsolutePaths	true/false, gibt an ob die SIPs mit absoluten Pfaden oder nur durch ihren Dateinamen submitted werden sollen
checkEmptyQueue	true/false, gibt an ob überprüft werden soll, dass die Queue leer ist, bevor neue SIPs submittet werden
[maxNumberSIPs]	(optional): maximale Anzahl SIPs, die man an feeder senden kann. Falls nicht angegeben, werden alle SIPs, welche dem Filter entsprechen, submittet.