docuteam:feeder-steps_340
Unterschiede
Hier werden die Unterschiede zwischen zwei Versionen angezeigt.
Beide Seiten der vorigen RevisionVorhergehende ÜberarbeitungNächste Überarbeitung | Vorhergehende ÜberarbeitungLetzte ÜberarbeitungBeide Seiten der Revision | ||
docuteam:feeder-steps_340 [2017/10/20 14:38] – [Quality Assurance: fixity check (md5)] Andreas Nef | docuteam:feeder-steps_340 [2019/09/04 10:47] – [Submission: CreateSIPsFromFileOrFolder] penelope | ||
---|---|---|---|
Zeile 77: | Zeile 77: | ||
< | < | ||
- | Usage: java ch.docuteam.feeder.ingest.CreateEADFile [path/ | + | Usage: java ch.docuteam.feeder.ingest.CreateEADFile [path/ |
Parameters: | Parameters: | ||
[path/ | [path/ | ||
+ | optional, name of the output file; defaults to EAD.xml within the SIP's subfolder in nthe location defined by the ' | ||
</ | </ | ||
Zeile 101: | Zeile 102: | ||
</ | </ | ||
- | ==== Ingest: remove SIP ==== | ||
- | |||
- | Die Funktion SIP RemoveFromInbox löscht ein vorhandenes SIP aus der Inbox und legt dieses dann in den gegebenen Ordner ab oder löscht es sofern kein Zielordner gegeben ist. | ||
- | |||
- | < | ||
- | Usage: java ch.docuteam.feeder.ingest.SIPRemoveFromInbox [path/ | ||
- | Parameters: | ||
- | [path/ | ||
- | [targetFolder]: | ||
- | </ | ||
==== Ingest: Remove SIP from Inbox ==== | ==== Ingest: Remove SIP from Inbox ==== | ||
Zeile 163: | Zeile 154: | ||
Parameters: | Parameters: | ||
/ | / | ||
+ | maxAllowedFilePathLength: | ||
+ | </ | ||
+ | |||
+ | ==== Quality Assurance: sip path length check ==== | ||
+ | |||
+ | Prüft die Dateipfadlängen innerhalb eines SIPs gegen einen anzugebenden Grenzwert. | ||
+ | |||
+ | < | ||
+ | Usage: java ch.docuteam.feeder.qualityassurance.SIPPathLengthCheck [path/ | ||
+ | Parameters: | ||
+ | [path/ | ||
maxAllowedFilePathLength: | maxAllowedFilePathLength: | ||
</ | </ | ||
Zeile 177: | Zeile 179: | ||
</ | </ | ||
+ | ==== Quality Assurance: convert to safe filenames ==== | ||
+ | |||
+ | Benennt Dateien mit Spezialzeichen um. Sichere Dateinamen beinhalten nur Zeichen aus A-Z, a-z, 0-9, und " | ||
+ | |||
+ | < | ||
+ | Usage: java ch.docuteam.feeder.qualityassurance.SIPConvertToSafeFileNames [path/ | ||
+ | Parameters: | ||
+ | [path/ | ||
+ | </ | ||
+ | |||
+ | ==== Quality Assurance: delete backup files ==== | ||
+ | |||
+ | Löscht Dateien aus dem SIP die einem bestimmten Namensmuster entsprechen. | ||
+ | |||
+ | < | ||
+ | Usage: java ch.docuteam.feeder.qualityassurance.SIPDeleteBackupFiles [path/ | ||
+ | Parameters: | ||
+ | [path/ | ||
+ | [filenamePattern filenamePattern ...]: a list of filename patterns (NOT case-sensitive, | ||
+ | </ | ||
==== Quality Assurance: SIPSubmissionAgreementCheck ==== | ==== Quality Assurance: SIPSubmissionAgreementCheck ==== | ||
Prüft ob die Dateiformate mit den Vorgaben aus dem Submission Agreement übereinstimmen. Es gibt zwei Modis: im ersten Modus (removeBadFiles = false), wird jede Datei welche über keine Übereinstimmung mit dem Submission Agreement hat aufgelistet (verwendet werden hierzu die WARN log Einträge) und zudem wir dein Fehlercode ausgegeben.\\ | Prüft ob die Dateiformate mit den Vorgaben aus dem Submission Agreement übereinstimmen. Es gibt zwei Modis: im ersten Modus (removeBadFiles = false), wird jede Datei welche über keine Übereinstimmung mit dem Submission Agreement hat aufgelistet (verwendet werden hierzu die WARN log Einträge) und zudem wir dein Fehlercode ausgegeben.\\ | ||
Zeile 194: | Zeile 216: | ||
< | < | ||
- | Usage: java ch.docuteam.feeder.qualityassurance.SIPVirusCheck [path/ | + | Usage: java ch.docuteam.feeder.qualityassurance.SIPVirusCheck [path/ |
- | [path/ | + | Parameters: |
- | deleteInfected: | + | [path/ |
+ | deleteInfected: | ||
</ | </ | ||
Zeile 234: | Zeile 257: | ||
Usage: java ch.docuteam.feeder.storage.DIPDeliverer[' | Usage: java ch.docuteam.feeder.storage.DIPDeliverer[' | ||
Parameters: | Parameters: | ||
- | [' | + | [' |
- | [PID|PUID] (PID = fedora persistent unique identifier, PUID = pronom persistent unique identifier) | + | [PID|PUID] (PID = fedora persistent unique identifier, PUID = pronom persistent unique identifier) |
Optional Parameters: | Optional Parameters: | ||
[targetLocation]: | [targetLocation]: | ||
Zeile 273: | Zeile 296: | ||
[withEAD]: whether to include EAD as descriptive metadata and create a datastream in the fedora objects; defaults to false | [withEAD]: whether to include EAD as descriptive metadata and create a datastream in the fedora objects; defaults to false | ||
</ | </ | ||
+ | |||
+ | ==== Storage: PID assigner ==== | ||
+ | |||
+ | Weisst allen Knoten eines SIPs eine PID ab Fedora zu. | ||
+ | |||
+ | < | ||
+ | Usage: java ch.docuteam.feeder.storage.PIDAssigner [path/ | ||
+ | Parameters: | ||
+ | [path/ | ||
+ | </ | ||
+ | |||
+ | ==== Storage: PIDListPublisher ==== | ||
+ | |||
+ | The PIDListPublisher saves/sends the file ' | ||
+ | |||
+ | < | ||
+ | Parameters: | ||
+ | [path/ | ||
+ | receiverURL: | ||
+ | |||
+ | ==== Storage: RenameSIPasAIPforIaas ==== | ||
+ | |||
+ | The operation RenameSIPasAIPforIaas renames an SIP using the pid of the root element of the mets file as prefix. Needs ' | ||
+ | |||
+ | < | ||
+ | Parameters: | ||
+ | [path/ | ||
+ | [targetFolder]: | ||
+ | |||
+ | ==== Storage: UpdateExcelWithPID ==== | ||
+ | |||
+ | This class will write PIDs from an SIP's nodes into excel sheet(s). The excel | ||
+ | sheet(s) must have a column with a label of either ' | ||
+ | the first row. PIDs will be written into the column with the header string | ||
+ | ' | ||
+ | |||
+ | < | ||
+ | Parameters: | ||
+ | [path/ | ||
+ | path/ | ||
+ | |||
+ | ==== Storage: WebgateDigitalObjectUpdater ==== | ||
+ | |||
+ | The WebgateDigitalObjectUpdater checks one or several curator databases for | ||
+ | units with digital objects and whether they should be (de-)published on a | ||
+ | given Fedora instance according to docuteamFeeder.properties. | ||
+ | It will use the FEEDER_JAVA system variable to locate configuration files. | ||
+ | |||
+ | < | ||
+ | Parameters: | ||
+ | {*|db1, | ||
+ | Optional Parameters: | ||
+ | [targetDirectory]: | ||
+ | </ | ||
+ | |||
+ | ====== Submission ====== | ||
+ | ==== Submission: AgreementsOverviewGenerator ==== | ||
+ | |||
+ | Creates a simple overview of submission agreements located in a given folder. | ||
+ | This is done by XSL transformations, | ||
+ | submission agreement files in the given directory and lists them in a simple | ||
+ | xml structure: | ||
+ | < | ||
+ | <sa_1 /> | ||
+ | <sa_2 /> | ||
+ | ... | ||
+ | <sa_x /> | ||
+ | </ | ||
+ | |||
+ | < | ||
+ | Parameters: | ||
+ | agreements_directory: | ||
+ | type: one of { Hierarchy | Flat | CSV }, defining the structure of the resulting overview file | ||
+ | output_directory: | ||
+ | |||
+ | ==== Submission: CheckFolder ==== | ||
+ | |||
+ | Check if sip size and size of each file in folder and file paths within the SIP exceeds the maximal allowed provided value. \\ | ||
+ | Any file or folder exceeding the maximal allowed size will be logged. | ||
+ | |||
+ | < | ||
+ | Parameters: | ||
+ | [/ | ||
+ | maxTotalSize: | ||
+ | maxSingleFileSize: | ||
+ | maxFilePathLength: | ||
+ | |||
+ | ==== Submission: CreateSIPFromExcel ==== | ||
+ | |||
+ | Creates a SIP according to the Matterhorn METS profile, getting structure and descriptive metadata from an Excel sheet. | ||
+ | |||
+ | Preconditions are | ||
+ | |||
+ | * The first excel sheet in an excel workbook is asumed to be the sheet to be read in | ||
+ | * This sheet must have a column named '' | ||
+ | * The paths can be relativ or absolute, it is not allowed to mix relativ and absolute paths, either these are relative or absolute | ||
+ | * A column with name levelOfDescription is expected. Only levels that exist in levels.xml are allowed | ||
+ | * Only metadata elements defined in levels.xml for the respective level are allowed, not defined metadata elements are reported as as a warn message in logging | ||
+ | |||
+ | < | ||
+ | Parameters: | ||
+ | | ||
+ | saID: string that is used to reference a submission agreement | ||
+ | | ||
+ | | ||
+ | |||
+ | ==== Submission: CreateSIPsFromFileOrFolder ==== | ||
+ | |||
+ | The CreateSIPsFromFileOrFolder operation will create SIPs from a given file | ||
+ | or folder. If the source is a folder, a parameter will define whether a | ||
+ | single SIP or separate SIPs for each child should be created. | ||
+ | |||
+ | < | ||
+ | Parameters: | ||
+ | source: file or folder for which an SIP should be generated | ||
+ | split: if ' | ||
+ | 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 ' | ||
+ | [outputDir]: | ||
+ | |||
+ | ==== Submission: SubmitSIPsFromFolder ==== | ||
+ | |||
+ | The SubmitSIPsFromFolder will use the given arguments for selecting SIPs in a | ||
+ | folder and submitting them to a number of workflows using the feeder | ||
+ | REST-interface. | ||
+ | |||
+ | < | ||
+ | Parameters: | ||
+ | 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: | ||
+ | workflows: comma separated list of workflows to execute on each SIP | ||
+ | user: username for feeder | ||
+ | password: password for feeder | ||
+ | useAbsolutePaths: | ||
+ | checkEmptyQueue: | ||
+ | [maxNumberSIPs] (optional): maximum number of SIPs to send to feeder; if omitted, all SIPs matching the filter string will be submitted</ | ||
+ | |||
+ | ==== Submission: WebjaxeAgreementCollector ==== | ||
+ | |||
+ | The WebjaxeAgreementCollector will look for the any submission agreements created within the | ||
+ | webjaxe editor and copy them to a given directory. | ||
+ | |||
+ | < | ||
+ | Parameters: | ||
+ | target_directory: | ||
+ | [webjaxe_home]: | ||
+ | |||
+ | ===== Util ===== | ||
+ | |||
+ | ==== Util: MailSender ==== | ||
+ | |||
+ | This MailSender operation sends an email to the given recipient with optional attachments. | ||
+ | |||
+ | < | ||
+ | Parameters: | ||
+ | receiver: the receiver' | ||
+ | subject: the mail subject | ||
+ | text: the message text | ||
+ | attachments: | ||