docuteam:feeder_steps
Unterschiede
Hier werden die Unterschiede zwischen zwei Versionen angezeigt.
Nächste Überarbeitung | Vorhergehende ÜberarbeitungLetzte ÜberarbeitungBeide Seiten der Revision | ||
docuteam:feeder_steps [2015/04/20 15:41] – angelegt christian | docuteam:feeder_steps [2019/01/07 11:24] – Externe Bearbeitung 127.0.0.1 | ||
---|---|---|---|
Zeile 1: | Zeile 1: | ||
====== Allgemein ======= | ====== Allgemein ======= | ||
- | |||
- | Die Liste der Operationen kann über targets im build.xml erstellt werden: '' | ||
==== Hilfe-Output ==== | ==== Hilfe-Output ==== | ||
Zeile 26: | Zeile 24: | ||
docuteam tools: 1.10.6 (25.02.2015) | docuteam tools: 1.10.6 (25.02.2015) | ||
AIPCreatorETH: | AIPCreatorETH: | ||
- | |||
- | ===== Access ===== | ||
- | |||
- | ==== FedoraExporter ==== | ||
- | |||
- | The FedoraExporter class gets the record of a given PID with all its child objects, if there ary any. | ||
- | |||
- | < | ||
- | Parameters: | ||
- | PID[, | ||
- | [/ | ||
- | [zip]: if ' | ||
- | |||
- | ===== ETH ===== | ||
- | |||
- | ==== CreateAIP ==== | ||
- | |||
- | The CreateAIP operation will create Rosetta Objects out of a SIP. The operation looks for a specific levels.xml file in a " | ||
- | config/ | ||
- | levels.xml | ||
- | dropbox/ | ||
- | [sip]/ | ||
- | mets.xml | ||
- | |||
- | < | ||
- | Parameters: | ||
- | SIPPath: Absolute path to the SIP to convert | ||
- | executionId: | ||
- | [testMode]: | ||
- | |||
- | ==== GetIngestFeedback ==== | ||
- | |||
- | The GetIngestFeedback operation gets feedback about the stored AIP. | ||
- | |||
- | < | ||
- | Parameters: | ||
- | SIPPath: Absolute path to the SIP to convert | ||
- | executionId: | ||
===== Ingest ===== | ===== Ingest ===== | ||
Zeile 127: | Zeile 87: | ||
[path/ | [path/ | ||
[targetFolder]: | [targetFolder]: | ||
- | |||
- | ===== LIPDA ===== | ||
- | |||
- | ==== Confirmation ==== | ||
- | |||
- | The Confirmation class will send a GET request to the LIPDA website with the PIDs for a given publication. | ||
- | |||
- | < | ||
- | Parameters: | ||
- | sip: name of the sip to process | ||
- | lipda_url: URL pointing to the LIPDA main page, e.g. http:// | ||
- | proxyHost: Hostname or IP of the proxy to use | ||
- | proxyPort: Port of the proxy to use</ | ||
- | |||
- | ==== Preparation ==== | ||
- | |||
- | The Preparation operation checks the ingest.lipda page of the LIPDA website | ||
- | for newly transfered documents. For each one, it will download the respective | ||
- | content and create a SIP based on a given submission agreement. | ||
- | |||
- | < | ||
- | Parameters: | ||
- | lipda_url: URL pointing to the LIPDA main page, e.g. http:// | ||
- | no_sips: maximum number of SIPs to process; 0 = all | ||
- | agreement: ID of the submission agreement to use, e.g. sa_mv-4330-02 | ||
- | [proxyHost]: | ||
- | [proxyPort]: | ||
- | |||
- | ===== POYRY ===== | ||
- | |||
- | ==== 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 | ||
- | [dropbox]: optional location where to put the SIPs; if omitted the property ' | ||
===== Quality Assurance ===== | ===== Quality Assurance ===== | ||
Zeile 246: | Zeile 162: | ||
[path/ | [path/ | ||
maxAllowedFilePathLength: | maxAllowedFilePathLength: | ||
- | |||
- | ==== SIPRootRemover | ||
- | |||
- | Remove the root node and set its child as the new root node. \\ | ||
- | This operation has only been used during early development | ||
- | and never been used in production environments. | ||
- | |||
- | < | ||
- | Parameters: | ||
- | [path/ | ||
==== SIPSubmissionAgreementCheck ==== | ==== SIPSubmissionAgreementCheck ==== | ||
Zeile 444: | Zeile 350: | ||
author: value to use as the creator for the SIP | author: value to use as the creator for the SIP | ||
[dropbox]: optional location where to put the SIPs; if omitted the property ' | [dropbox]: optional location where to put the SIPs; if omitted the property ' | ||
- | |||
- | ==== CreateSIPsFromFolderContent (DEPRECATED!) ==== | ||
- | |||
- | The CreateSIPsFromFolderContent is deprecated and superseded by the CreateSIPsFromFileOrFolder which offers enhanced functionality. | ||
- | |||
- | < | ||
- | Parameters: | ||
- | source: file or folder for which an SIP should be generated | ||
- | 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 | ||
- | singleSIPs: | ||
- | dropbox: optional location where to put the SIPs</ | ||
==== SubmitSIPsFromFolder ==== | ==== SubmitSIPsFromFolder ==== | ||
Zeile 499: | Zeile 392: | ||
text: the message text | text: the message text | ||
attachments: | attachments: | ||
- | |||