Submission

Le paquet submission contient les étapes liées à la création et à la livraison des SIP.

Submission: générer un aperçu des accords

Génère un aperçu des accords de soumission dans un dossier spécifique.

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

Paramètre	Description
agreements_directory	lieu où se trouvent les accords de soumission
output_type	l'un des éléments { Hierarchy|Flat|CSV }, définissant la structure du fichier récapitulatif résultant
output_directory	Emplacement cible pour le fichier de synthèse créé, par défaut le répertoire où se trouvent les accords

Submission: vérifier le dossier

Vérifie que la taille d'un SIP, la taille des fichiers et les chemins d'accès aux fichiers ne dépassent pas une valeur maximale.

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

Paramètre	Description
/path/to/]folder	chemin d'accès au dossier à vérifier ; si aucun chemin n'est indiqué, il sera recherché à l'emplacement défini par la propriété actions.workbench.work.
maxTotalSize	la taille maximale autorisée pour le dossier
maxSingleFileSize	la taille maximale autorisée pour tous les fichiers contenus dans le sip
maxFilePathLength	la longueur maximale autorisée des chemins d'accès aux fichiers dans le dossier

Submission: créer un paquet SIP à partir d'un fichier CSV

Crée un SIP conformément au profil METS Matterhorn à l'aide de la structure et des métadonnées descriptives contenues dans un fichier CSV.

Exigences:

Les exigences relatives aux paramètres ainsi qu'au fichier source CSV sont les mêmes que pour l'action correspondante de docuteam packer.

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]

Paramètre	Description
--csv	emplacement du fichier CSV à partir duquel créer un SIP
--mappingFile	fichier à partir duquel lire le mapping
--submissionAgreement	fichier d'accord de submission
--dataSubmissionSession	id de la session de submission
--outputFolder	facultatif, indiquez le dossier de sortie; la valeur par défaut est actions.workbench.inbox
--checksum	facultatif, indique si les sommes de contrôle dans le SIP créé doivent être comparées aux sommes de contrôle fournies dans le fichier CSV ; la valeur par défaut est false.
--skipLevelValidation	facultatif, indique s'il faut ignorer la validation selon levels.xml; défaut: false

Submission: créer un fichier SIP à partir d'Excel

Crée un SIP conformément au profil METS Matterhorn à l'aide de la structure et des métadonnées descriptives d'une feuille de calcul Excel.

Exigences:

• Seule la première feuille de calcul est prise en compte.
• Cette feuille doit contenir une colonne path qui répertorie tous les fichiers et dossiers à compresser dans un SIP.
• Les chemins d'accès aux fichiers et dossiers peuvent être spécifiés de manière absolue ou relative. Une spécification mixte de chemins relatifs/absolus n'est pas autorisée.
• La feuille doit également contenir une colonne levelOfDescription. Seules les valeurs spécifiées comme autorisées dans le fichier levels.xml peuvent être saisies ici.
• Seuls les champs de métadonnées fournis dans le fichier levels.xml pour le niveau de description correspondant peuvent être saisis. Les champs de métadonnées non définis sont consignés sous forme d'avertissement.

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

Paramètre	Description
[path/to/]Excelfile	nom ou chemin d'accès sans extension de fichier vers le fichier Excel ; la valeur par défaut est actions.workbench.preparation si le chemin d'accès est omis.
saID	string utilisée pour référencer un accord de soumission
dssID	string utilisée pour référencer une session de soumission de données dans le cadre de l'accord de soumission
[path/to/target/directory]	chemin d'accès au répertoire où le SIP doit être placé ; facultatif, la valeur par défaut est actions.workbench.preparation

Submission: créer des SIP à partir d'un fichier ou d'un dossier

Crée un SIP à partir d'un fichier ou d'un dossier. Si un dossier est spécifié, un paramètre peut être utilisé pour contrôler si un SIP doit être créé pour l'ensemble du dossier ou un SIP pour chaque fichier ou sous-dossier individuel dans ce dossier. Cette action fonctionne de manière récursive et ajoute également les fichiers des sous-dossiers au SIP.

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

Paramètre	Description
source	fichier ou dossier pour lequel un SIP doit être généré ; si un chemin relatif est indiqué, il est supposé se trouver dans le dossier défini par la propriété actions.workbench.preparation
split	si true, un SIP distinct sera créé pour chaque fichier/dossier dans la source (en supposant que la source soit un dossier).
saID	valeur à utiliser pour référencer un accord de soumission dans le SIP. L'action ignorera les formats de fichiers non autorisés dans l'accord de soumission.
dssID	valeur à utiliser pour référencer une session de soumission de données de l'accord de soumission correspondant
author	valeur à utiliser comme créateur pour le SIP
zipped	si true, créer des SIP compressés
[outputDir]	emplacement facultatif où placer les SIP ; s'il est omis, la propriété actions.workbench.work sera utilisée

Submission: renommer par date et propriétaire

Renomme un dossier. Le nom du dossier est précédé de la date et du nom du propriétaire sous la forme " aaaaMMMjj_[propriétaire du fichier]_ ".

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

Paramètre	Description
[/path/to/]folder	nom du dossier à renommer ; si aucun chemin ou chemin relatif n'est indiqué, il sera supposé se trouver à l'emplacement défini par la propriété actions.workbench.inbox.

Submission: soumettre les SIP à partir du dossier

Sélectionne les SIP et les transfère via l'interface REST vers les workflows docuteam feeder.

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

Paramètre	Description
inbox	chemin d'accès au dossier contenant les SIP
errorbox	chemin d'accès au dossier où placer les SIP ayant échoué
filter	chaîne de filtre regex pour les SIP dans la boîte de réception; placez l'expression regex entre guillemets!
feeder_url	URL pointant vers la page principale du flux, par exemple http://localhost/feeder
workflows	liste séparée par des virgules des flux de travail à exécuter sur chaque SIP
user	username pour feeder
password	password pour feeder
useAbsolutePaths	true/false, indiquant s'il faut soumettre les SIP par chemins absolus ou simplement par leurs noms de fichiers
checkEmptyQueue	true/false, indiquant s'il faut vérifier si la file d'attente est vide avant d'envoyer de nouveaux SIP
[maxNumberSIPs]	(facultatif) : nombre maximal de SIP à envoyer au distributeur ; si cette option est omise, tous les SIP correspondant à la chaîne de filtrage seront soumis.