Submission

Schritte im Zusammenhang mit der SIP-Bildung

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

Submission: generate agreements overview

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

java ch.docuteam.feeder.submission.AgreementsOverviewGenerator \
     agreements_directory output_type output_directory
Parameter Beschreibung
agreements_directory location where the collection of submission agreements can be found
output_type one of { Hierarchy\|Flat\|CSV }, defining the structure of the resulting overview file
output_directory target location for the created overview file, defaults to the directory, where the agreements are located

Submission: check folder

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

java ch.docuteam.feeder.submission.CheckFolder \
     [/path/to/]folder maxTotalSize maxSingleFileSize maxFilePathLength
Parameter Beschreibung
/path/to/]folder path of the folder to check; if no path is given, it will be expected to be in the location defined by the feeder.workbench.work property
maxTotalSize the max allowed size the folder may have
maxSingleFileSize the max allowed size any of the files contained by the sip
maxFilePathLength the max allowed length of file paths within the folder

Submission: create SIP from Excel

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/absoluten Pfaden.
  • Das Blatt muss ebenfall eine Spalte levelOfDescription enthalten. Hier dürfen nur Werte eingetragen werden, die in der Datei levels.xml als erlaubt angegebn 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.feeder.submission.CreateSIPFromExcel \
     [path/to/]Excelfile saID dssID [path/to/target/directory]
Parameter Beschreibung
[path/to/]Excelfile name or path without file extension to the excel file; defaults to feeder.workbench.preparation if path is omitted
saID string that is used to reference a submission agreement
dssID string that is used to reference a data submission session within the submission agreement
[path/to/target/directory] path to the directory, where the SIP should be placed; optional, defaults to feeder.workbench.preparation

Submission: create SIPs from file or folder

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 in diesem Ordner.

java ch.docuteam.feeder.submission.CreateSIPsFromFileOrFolder \
     source recursive saID dssID author zipped [outputDir]
Parameter Beschreibung
source file or folder for which an SIP should be generated
split if true, a separate SIP will be created for each file/folder within the source (assuming the source is a folder)
saID value to use for referencing a submission agreement in the SIP
dssID value to use for referencing a data submission session of the respective submission agreement
author value to use as the creator for the SIP
zipped if true, create zipped SIPs
[outputDir] optional location where to put the SIPs; if omitted the property feeder.workbench.work will be used

Submission: rename by date and owner

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

java ch.docuteam.feeder.submission.RenameByDateAndOwner \
     [/path/to/]folder
Parameter Beschreibung
[/path/to/]folder name of the folder to rename; if no path or a relative path is given, it will be expected to be in the location defined by the feeder.workbench.inbox property"

Submission: submit SIPs from folder

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

java ch.docuteam.feeder.submission.SubmitSIPsFromFolder \
     inbox errorbox filter feeder_url workflows user password \
     useAbsolutePaths checkEmptyQueue [maxNumberSIPs]
Parameter Beschreibung
inbox path to the folder containing the SIPs
errorbox path to the folder where to put unsuccessful SIPs
filter regex filter string for the SIPs within the dropbox; put the regex expression into quotation marks!
feeder_url URL pointing to the feeder main page, e.g. http://localhost/feeder
workflows comma separated list of workflows to execute on each SIP
user username for feeder
password password for feeder
useAbsolutePaths true/false, indicating whether to submit SIPs by absolute paths or just their filenames
checkEmptyQueue true/false, indicating whether to check if the queue is empty before submitting new SIPs
[maxNumberSIPs] (optional): maximum number of SIPs to send to feeder; if omitted, all SIPs matching the filter string will be submitted
Administration
Quality Assurance