Ingest

Le package ingest contient les étapes du processus d'ingestion.

Ingest: ajouter un événement personnalisé à SIP

Cette action ajoute un ou plusieurs événements PREMIS au SIP. Le paramètre nodeType définit les nœuds auxquels les événements sont ajoutés. Les valeurs suivantes sont prises en charge : all (tous les nœuds du SIP), root (dossier racine ou fichier racine), file (tous les nœuds de fichier du SIP, y compris le fichier racine), folder (tous les nœuds de dossier du SIP, y compris le dossier racine). L'autres paramètres peut être utilisé pour définir les détails de l'événement.

java ch.docuteam.actions.ingest.AddCustomPremisEvent \
     --sip=[/path/to/]SIP \
     --nodeType=nodeType \
     --eventType=eventType \
     --eventDetail=eventDetail \
     --eventOutcome=eventOutcome \
     [--eventOutcomeDetail=eventOutcomeDetail] \

Paramètre	Description
--sip=[path/to/]SIP	nom du SIP ; si aucun chemin n'est indiqué, il sera recherché à l'emplacement défini par la propriété actions.workbench.work.
--nodeType=nodeType	définit le type de nœud auquel les événements sont ajoutés.
--eventType=eventType	Type d'événement PREMIS (peut être choisi librement).
--eventDetail=eventDetail	Détails de l'événement PREMIS (peuvent être choisis librement).
--eventOutcome=eventOutcome	Résultat de l'événement PREMIS (doit être soit Success, soit Failure).
[--eventOutcomeDetail=eventOutcomeDetail]	Détails du résultat de l'événement PREMIS (facultatif, peut être choisi librement).

Ingest: add DNB URN to the root node of the SIP

This action uses the URN suggestion service of the German National Library (DNB) to generate an URN in the selected namespace and store it as a metadata element (accessor "URN") of the root node. If an URN is already present in the metadata, no new URN is generated. Optionally the URN ID (a substring of the URN without prefixes) can be stored in an additional element by filling out the urnIdAccessor parameter. If this field already contains a value, no URN ID is written. With the optional parameter onlyWriteUrnIdInAccessor it is possible to skip writing the URN in order to only write the URN ID.

java ch.docuteam.actions.ingest.AddDnbUrnToRootNode \
     --sip=[/path/to/]SIP \
     --urnNamespace=urnNamespace \
     [--urnIdAccessor=urnIdAccessor] \
     [--onlyWriteUrnIdInAccessor=false] \

Paramètre	Description
--sip=[path/to/]SIP	nom du SIP ; si aucun chemin n'est indiqué, il sera recherché à l'emplacement défini par la propriété actions.workbench.work.
--urnNamespace=urnNamespace	espace de noms pour lequel un URN sera généré.
[--urnIdAccessor=urnIdAccessor]	Accesseur EAD définissant quel champ EAD du nœud racine est utilisé pour stocker l'ID URN (URN sans préfixes). Si laissé vide, aucun ID URN n'est écrit.
[--onlyWriteUrnIdInAccessor=false]	{ true|false }, indiquant s'il faut uniquement écrire l'identifiant URN (valeur par défaut : false).

Ingest: convertir BAR-SIP

Convertit un BAR-SIP en un SIP conforme au profil Matterhorn.

java ch.docuteam.actions.ingest.BARSIPConverter \
     [path/to/]SIP [targetFolder]

Paramètre	Description
[path/to/]BAR-SIP	nom du SIP ; si aucun chemin n'est indiqué, il sera supposé se trouver à l'emplacement défini par la propriété actions.workbench.inbox.
[targetFolder]	répertoire dans lequel déplacer le SIP créé ; s'il est omis, le SIP sera déplacé vers l'emplacement défini par la propriété actions.workbench.work

Ingest: créer un SIP à partir de l'eCH-0160 SIP

Crée un SIP conforme au profil Matterhorn à partir d'un eCH-0160 SIP.

java ch.docuteam.actions.ingest.CreateSIPFromECH0160SIP \
     --sip=[path/to/]SIP \
     --levelsFilePath=/path/to/levels.xml \
     --[mappingFile=[path/to/]mappingFile] \
     --[output-folder=/path/to/folder]

Paramètre	Description
--sip=[path/to/]SIP	emplacement du SIP à convertir ; le dossier de recherche par défaut est actions.workbench.inbox
--levelsFilePath=/path/to/levels.xml	chemin d'accès au fichier levels.xml
--[mappingFile=[path/to/]mappingFile]	fichier à partir duquel lire le mappage ; par défaut, un fichier de mappage par défaut (défini par le module de mappage)
--[output-folder=/path/to/folder]	indiquez le dossier de sortie ; la valeur par défaut est actions.workbench.work

Ingest: vérifier workspace sur l'établi

Vérifie s'il y a suffisamment d'espace pour le traitement SIP (c'est-à-dire pour les copies de travail).

java ch.docuteam.actions.ingest.CheckWorkbenchSpace \
     [path/to/]SIP [numberOfCopies]

Paramètre	Description
[path/to/]SIP	nom du SIP. Si aucun chemin n'est indiqué, il sera recherché à l'emplacement défini par la propriété actions.workbench.work.
[numberOfCopies]	facultatif, nombre de copies à calculer ; la valeur par défaut est 3

Ingest: cleanup des copies de travail

Supprime les SIP existants dans actions.workbench.work. Vous pouvez également supprimer les SIP portant le même nom dans actions.workbench.preparation.

java ch.docuteam.actions.ingest.Cleanup \
     [path/to/]SIP [prep]

Paramètre	Description
[path/to/]SIP	nom du SIP. Si aucun chemin n'est indiqué, il sera supposé se trouver à l'emplacement défini par la propriété actions.workbench.work.
[prep]	Si true, les SIP du même nom dans actions.workbench.preparation seront également supprimés ; la valeur par défaut est false.

Ingest: créer un fichier EAD

Crée des données EAD à partir des nœuds individuels d'un SIP donné.

java ch.docuteam.actions.ingest.CreateEADFile \
     [path/to/]SIP [targetFilename]

Paramètre	Description
[path/to/]SIP	nom du SIP ; si aucun chemin n'est indiqué, il sera supposé se trouver à l'emplacement défini par la propriété actions.workbench.work.
[targetFilename]	facultatif, nom du fichier de sortie ; par défaut, EAD.xml dans le sous-dossier SIP à l'emplacement défini par la propriété actions.workbench.output

Ingest: calculateur d'étendue

Remplit le nombre de fichiers dans le champ de métadonnées Extent et l'unité sur la valeur par défaut Fichier(s).

java ch.docuteam.actions.ingest.ExtentCalculator \
     [path/to/]SIP

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

Ingest: migrer des fichiers

Migre les fichiers d'un SIP conformément aux spécifications de migration définies dans le fichier de configuration migration-config.xml.

java ch.docuteam.actions.ingest.SIPFileMigrator \
     [path/to/]SIP keepOriginals [path/to/migration-config.xml]

Paramètre	Description
[path/to/]SIP	nom du SIP ; si aucun chemin n'est indiqué, il sera supposé se trouver à l'emplacement défini par la propriété actions.workbench.work.
keepOriginals	{ true|false }, indiquant s'il faut conserver les fichiers d'origine après le processus de migration
[path/to/migration-config.xml]	facultatif, chemin d'accès à un fichier de configuration de migration spécifique (par défaut ./config/migration-config.xml)
[skipAlreadyMigratedFiles]	facultatif, { true|false }, indique s'il faut migrer les fichiers qui ont déjà été migrés auparavant; la valeur par défaut est true, c'est-à-dire que les fichiers qui ont déjà été migrés ne sont pas migrés à nouveau.

Ingest: Supprimer SIP de inbox

Déplace un SIP existant depuis actions.workbench.inbox vers un dossier spécifié ou le supprime si aucun dossier de destination n'est spécifié.

java ch.docuteam.actions.ingest.SIPRemoveFromInbox \
     [path/to/]SIP [targetFolder]

Paramètre	Description
[path/to/]SIP	chemin d'accès du SIP ; si aucun chemin d'accès n'est indiqué, il sera recherché à l'emplacement défini par la propriété actions.workbench.inbox.
[targetFolder]	répertoire vers lequel déplacer le SIP; s'il est omis, le SIP sera supprimé

Ingest: remplacer le fichier

Remplace un fichier dans un SIP. Les métadonnées sont conservées ou ajoutées. Actuellement, seuls les SIP contenant un seul fichier peuvent être traités avec cette étape.

java ch.docuteam.actions.ingest.ReplaceFile \
     [path/to/]SIP [targetFolder]

Paramètre	Description
[path/to/]SIP	chemin d'accès au SIP ; si aucun chemin d'accès n'est indiqué, il sera recherché à l'emplacement défini par la propriété actions.workbench.work.
[targetFolder]	chemin d'accès au fichier à utiliser en remplacement du contenu SIP actuel

Ingest: Obtenir MARC à partir de REST et l'ajouter à SIP

Pour chaque objet (fichier/dossier) d'un SIP, le processus obtient une description MARC à partir d'un service web REST et l'ajoute aux métadonnées descriptives.

L'URL du service web est configurée dans le fichier actions.properties avec la propriété aleph.webservice.url. L'URL doit contenir un espace réservé { documentNumber} qui est remplacé par le numéro de document spécifique. Ce dernier est extrait pour chaque objet en fonction de son nom de fichier :

• Pour un nom de fichier BAU_5_000000444.wav, le numéro de document 000000444 sera extrait.
• Pour un nom de dossier DIRECTORY_X_000000555, le numéro de document 000000555 sera extrait.

Si la requête HTTP échoue ou si le nom de fichier n'est pas valide, l'opération s'arrêtera et laissera le SIP inchangé. Les métadonnées MARC existantes seront écrasées par l'opération réussie.

java ch.docuteam.actions.marc.AddMarcFromRestByIdFromNodeName \
     --sip=[path/to/]SIP

Paramètre	Description
--sip=[path/to/]SIP	emplacement du SIP à convertir; le dossier de recherche par défaut est actions.workbench.work

Ingest: ajouter OAIDC à partir de REST par ID à partir du nom de fichier

Prend un SIP et ajoute les informations OAI DC à son dossier racine.

Les informations OAI DC sont demandées à un service web, défini par la propriété oai.webservice.url. L'URL doit comporter un espace réservé { identifiant} qui est remplacé par le nom du nœud racine, par exemple :

• Kürzel-SignaturTIFF par exemple bbb-0027TIFF devient { identifiant} bbb/0027

Si le nœud dans le SIP a un nom invalide ou si la demande d'informations OAI DC échoue, l'opération est interrompue et le fichier SIP n'est pas modifié. Lorsque l'opération est appelée sur un fichier SIP qui contient déjà des informations OAI DC, une exception est levée.

Les ressources de fichiers supplémentaires définies dans les métadonnées <dc:relation/> sont téléchargées et ajoutées au SIP dans un nouveau sous-dossier intitulé TEI-Handschriftenbeschreibungen.

java ch.docuteam.actions.oai_dc.AddOAIDCFromRESTByIDFromFilename \
     --sip=[path/to/]SIP

Paramètre	Description
--sip=[path/to/]SIP	nom du SIP ; si aucun chemin n'est indiqué, il sera supposé se trouver à l'emplacement défini par la propriété actions.workbench.work.

Ingest: convertir un paquet EDIDOC/EDIAKT en un paquet Matterhorn METS SIP.

Crée un SIP conforme au profil Matterhorn METS à partir d'un paquet EDIDOC/EDIAKT.

java ch.docuteam.actions.ingest.CreateSIPFromEdidocSIP \
     --sip=[path/to/]SIP \
     --levelsFilePath=path/to/levels.xml \
     [--mappingFile=path/to/mappingFile] \
     [--outputFolder=/path/to/folder] \
     [--steuerXml=/path/to/file]

Paramètre	Description
--sip=[path/to/]SIP	emplacement du paquet à convertir ; le dossier de recherche par défaut est actions.workbench.inbox
--levelsFilePath=path/to/levels.xml	chemin d'accès au fichier de configuration du niveau, à trouver dans le chemin de classe
[--mappingFile=path/to/mappingFile]	fichier à partir duquel lire le mappage ; par défaut ./config/edidoc-mapping.xml, à trouver dans le chemin de classe
[--outputFolder=/path/to/folder]	indiquez le dossier de sortie ; la valeur par défaut est actions.workbench.work
[--steuerXml=/path/to/file]	chemin d'accès au fichier XML d'extension des archives EDIDOC

Ingest: Importer ou télécharger un fichier MARCXML vers ou depuis Alma

L'action ImportOrDownloadMarcXmlIntoAlma importe un fichier MARCXML (qui doit être présent dans le SIP) dans Alma à l'aide de l'API REST Alma. Après l'importation, la réponse d'Alma (fichier MARCXML mis à jour) est utilisée pour mettre à jour le fichier MARCXML dans le SIP. Si le fichier n'est pas présent dans le SIP, l'action échouera ou (si le drapeau facultatif downloadIfMissing est activé) téléchargera le fichier MARCXML à partir de l'API Alma (en supposant que son ID MMS est stocké dans l'élément racine défini par le paramètre writeMmsIdRoot). En définissant un accesseur dans les paramètres writeMmsId et writeMmsIdRoot, l'ID MMS du fichier importé/téléchargé peut également être écrit dans les métadonnées mets.xml du nœud du fichier MARCXML (writeMmsId) et/ou du nœud racine du SIP (writeMmsIdRoot).

Les informations de connexion pour l'API REST Alma sont attendues dans le fichier actions.properties.

java ch.docuteam.actions.ingest.alma.ImportOrDownloadMarcXmlIntoAlma \
     --sip=[/path/to/]SIP \
     --marcxml=path/to/marc.xml \
     [--writeMmsId] \
     [--writeMmsIdRoot] \
     [--downloadIfMissing=false] \
     [--checkMatch=false] \
     [--fromCzMmsId] \
     [--fromNzMmsId] \
     [--importProfile] \
     [--normalization] \
     [--overrideWarning=true] \
     [--validate=false]

Paramètre	Description
--sip=[path/to/]SIP	nom du SIP ; si aucun chemin n'est indiqué, il sera recherché à l'emplacement défini par la propriété actions.workbench.work.
--marcxml=path/to/marc.xml	Chemin d'accès au fichier de métadonnées MARCXML (par rapport au nœud racine du SIP).
[--writeMmsId=refCode]	Accesseur EAD définissant l'élément de métadonnées du nœud de fichier MARCXML dans lequel l'ID MMS est écrit après l'importation. S'il est vide, aucun ID MMS ne sera écrit pour le nœud de fichier.
[--writeMmsIdRoot=refCode]	Accesseur EAD définissant l'élément de métadonnées du nœud racine dans lequel l'ID MMS est écrit après l'importation. S'il est vide, aucun ID MMS ne sera écrit pour le nœud racine.
[--downloadIfMissing=false]	Indique s'il faut télécharger un fichier MARCXML (basé sur l'ID MMS stocké dans l'élément défini par l'accesseur writeMmsIdRoot) depuis Alma si le chemin d'accès au fichier de métadonnées MARCXML ne pointe pas vers un fichier. Valeur par défaut : false.
[--checkMatch=false]	Indique s'il faut vérifier s'il existe une correspondance. Valeur par défaut : false (l'enregistrement sera sauvegardé même s'il existe une correspondance possible).
[--fromCzMmsId]	Le MMS_ID de l'enregistrement Community-Zone. Laissez ce champ vide lorsque vous créez un enregistrement local standard.
[--fromNzMmsId]	Le MMS_ID de l'enregistrement Network-Zone. Laissez ce champ vide lorsque vous créez un enregistrement local standard.
[--importProfile]	L'ID du profil d'importation à utiliser lors du traitement de l'enregistrement d'entrée. Notez que selon la configuration du profil, l'API peut dans certains cas mettre à jour un enregistrement existant.
[--normalization]	L'ID du profil de normalisation à exécuter.
[--overrideWarning=true]	Indique s'il faut ignorer les avertissements. Par défaut : true (l'enregistrement sera sauvegardé et les avertissements seront ajoutés à la sortie API).
[--validate=false]	Indique s'il faut valider le fichier MARC XML. Valeur par défaut : false.

Ingest: Renommer le nœud racine en fonction des métadonnées EAD

Cette action met à jour le nom du fichier ou du dossier du nœud racine d'un SIP en fonction des métadonnées EAD du nœud racine. Les caractères spéciaux sont normalisés. Si les éléments de métadonnées donnés existent plusieurs fois, la première instance est utilisée.

java ch.docuteam.actions.ingest.RenameRootNodeFromEad \
     --sip=[/path/to/]SIP \
     --accessorName=accessorName \

Paramètre	Description
--sip=[path/to/]SIP	nom du SIP ; si aucun chemin n'est indiqué, il sera supposé se trouver à l'emplacement défini par la propriété actions.workbench.work.
--accessorName=accessorName	Accesseur EAD définissant quel champ EAD du nœud racine est utilisé comme source du nouveau nom de fichier ou de dossier.

Ingest: update le fichier XML dans SIP à l'aide de xslt

À l'aide d'un fichier XSLT, cette action peut mettre à jour un fichier XML dans le SIP en appliquant cette transformation. L'action définit un paramètre xsl appelé pathToMets contenant le chemin d'accès au fichier mets.xml, afin qu'il puisse être lu pendant la transformation xsl.

java ch.docuteam.actions.ingest.ModifyFileWithXSL \
     --sip=[/path/to/]SIP \
     --xml=path/to/file.xml \
     --xsl=path/to/transformation.xsl

Paramètre	Description
--sip=[path/to/]SIP	nom du SIP ; si aucun chemin n'est indiqué, il sera supposé se trouver à l'emplacement défini par la propriété actions.workbench.work.
--xml=path/to/file.xml	Chemin d'accès au fichier XML dans le SIP à transformer (par rapport au nœud racine du SIP). Le chemin d'accès accepte un caractère générique (*) à la place du dossier racine.
--xsl=path/to/transformation.xsl	chemin d'accès au script xsl à utiliser dans la transformation (s'il est relatif, supposez que xsl se trouve dans $ACTIONS_HOME/xslt)