Benutzer-Werkzeuge

Webseiten-Werkzeuge


docuteam:feeder_steps

Unterschiede

Hier werden die Unterschiede zwischen zwei Versionen angezeigt.

Link zu dieser Vergleichsansicht

Nächste Überarbeitung
Vorhergehende Überarbeitung
docuteam:feeder_steps [2015/04/20 15:41]
christian angelegt
docuteam:feeder_steps [2019/01/07 11:24] (aktuell)
Zeile 1: Zeile 1:
 ====== Allgemein ======= ====== Allgemein =======
- 
-Die Liste der Operationen kann über targets im build.xml erstellt werden: ''​listOperationUsagePublic''​ und ''​listOperationUsage''​ 
  
 ==== 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:​ 1.0.0i (17.02.2015)</​code>​ AIPCreatorETH:​ 1.0.0i (17.02.2015)</​code>​
- 
-===== Access ===== 
- 
-==== FedoraExporter ==== 
- 
-The FedoraExporter class gets the record of a given PID with all its child objects, if there ary any. 
- 
-<​code>​Usage:​ java ch.docuteam.feeder.access.FedoraExporter PID[,​PID...] [/​output/​to/​]folder [zip] 
-Parameters: 
- PID[,​PID...]:​ comma separated list of PIDs you want to export 
- [/​output/​to/​]folder:​ location of the folder where to put the exported object as DIP 
- [zip]: if '​true',​ the DIP is zipped; defaults to '​false'</​code>​ 
- 
-===== 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"​ folder on the same level as the dropbox, i.e.: 
-  config/ 
-    levels.xml 
-  dropbox/ 
-    [sip]/ 
-      mets.xml 
- 
-<​code>​Usage:​ java ch.docuteam.feeder.eth.CreateAIP ​ SIPPath ​ executionId ​ [testMode] 
-Parameters: 
- SIPPath: Absolute path to the SIP to convert 
- executionId:​ The execution id 
- [testMode]:​ Optional: if '​true',​ make this run repeatable by deleting the destination AIP and clearing some rows in the DB beforehand</​code>​ 
- 
-==== GetIngestFeedback ==== 
- 
-The GetIngestFeedback operation gets feedback about the stored AIP. 
- 
-<​code>​Usage:​ java ch.docuteam.feeder.eth.GetIngestFeedback ​ SIPPath ​ executionId 
-Parameters: 
- SIPPath: Absolute path to the SIP to convert 
- executionId:​ The execution id</​code>​ 
  
 ===== Ingest ===== ===== Ingest =====
Zeile 127: Zeile 87:
  [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 feeder.workbench.dropbox property  [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 feeder.workbench.dropbox property
  [targetFolder]:​ directory where to move the SIP to; if omitted, the SIP will be deleted</​code>​  [targetFolder]:​ directory where to move the SIP to; if omitted, the SIP will be deleted</​code>​
- 
-===== LIPDA ===== 
- 
-==== Confirmation ==== 
- 
-The Confirmation class will send a GET request to the LIPDA website with the PIDs for a given publication. 
- 
-<​code>​Usage:​ java ch.docuteam.feeder.lipda.Confirmation sip lipda_url [proxyHost proxyPort] 
-Parameters: 
- sip: name of the sip to process 
- lipda_url: URL pointing to the LIPDA main page, e.g. http://​archives.memovs.ch/​lipda 
- proxyHost: Hostname or IP of the proxy to use 
- proxyPort: Port of the proxy to use</​code>​ 
- 
-==== 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. 
- 
-<​code>​Usage:​ java ch.docuteam.feeder.lipda.Preparation lipda_url no_sips agreement [proxyHost proxyPort] 
-Parameters: 
- lipda_url: URL pointing to the LIPDA main page, e.g. http://​archives.memovs.ch/​lipda 
- 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]:​ Hostname or IP of the proxy to use for the LIPDA site 
- [proxyPort]:​ Port of the proxy to use for the LIPDA site</​code>​ 
- 
-===== 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. 
- 
-<​code>​Usage:​ java ch.docuteam.feeder.poyry.CreateSIPsFromFileOrFolder source recursive saID dssID author [dropbox] 
-Parameters: 
- 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 
- [dropbox]: optional location where to put the SIPs; if omitted the property '​feeder.workbench.dropbox'​ defined in the docuteamFeeder.properties will be used</​code>​ 
  
 ===== Quality Assurance ===== ===== Quality Assurance =====
Zeile 246: Zeile 162:
  [path/​to/​]SIP:​ name of the SIP; if not path is given, it will be expected to be in the location defined by the feeder.workbench.workdir property  [path/​to/​]SIP:​ name of the SIP; if not path is given, it will be expected to be in the location defined by the feeder.workbench.workdir property
  maxAllowedFilePathLength:​ the max allowed number of characters of the canonical file path</​code>​  maxAllowedFilePathLength:​ the max allowed number of characters of the canonical file path</​code>​
- 
-==== SIPRootRemover ​ (DEPRECATED!) ==== 
- 
-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. 
- 
-<​code>​DEPRECATED! Usage: java ch.docuteam.feeder.qualityassurance.SIPRootRemover [path/​to/​]SIP 
-Parameters: 
- [path/​to/​]SIP:​ name of the SIP; if not path is given, it will be expected to be in the location defined by the feeder.workbench.workdir property</​code>​ 
  
 ==== 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 '​feeder.workbench.dropbox'​ defined in the docuteamFeeder.properties will be used</​code>​  [dropbox]: optional location where to put the SIPs; if omitted the property '​feeder.workbench.dropbox'​ defined in the docuteamFeeder.properties will be used</​code>​
- 
-==== CreateSIPsFromFolderContent (DEPRECATED!) ==== 
- 
-The CreateSIPsFromFolderContent is deprecated and superseded by the CreateSIPsFromFileOrFolder which offers enhanced functionality. 
- 
-<​code>​DEPRECATED! Usage: java ch.docuteam.feeder.submission.CreateSIPsFromFolderContent source saID dssID author singleSIPs dropbox 
-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:​ if '​true'​ and the source is a folder, a separate SIP is created for each file within the folder (and its subfolders) 
- dropbox: optional location where to put the SIPs</​code>​ 
  
 ==== SubmitSIPsFromFolder ==== ==== SubmitSIPsFromFolder ====
Zeile 499: Zeile 392:
  text: the message text  text: the message text
  attachments:​ filepaths to attachments;​ if the first attachment is '​zip',​ all attachments will be zipped into a single attachment</​code>​  attachments:​ filepaths to attachments;​ if the first attachment is '​zip',​ all attachments will be zipped into a single attachment</​code>​
- 
  
docuteam/feeder_steps.1429537278.txt.gz · Zuletzt geändert: 2019/01/07 11:12 (Externe Bearbeitung)