Quality Assurance

Le paquet qualityassurance contient des étapes visant à vérifier les SIP.

Quality Assurance: extraire SIP dans le dossier de travail

Extrait un fichier SIP compressé vers actions.workbench.work. Un deuxième paramètre facultatif peut être utilisé pour spécifier un autre dossier de destination.

java ch.docuteam.actions.qualityassurance.SIPExtractor \
     [path/to/]SIP [targetdir]

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.inbox
[targetdir]	répertoire cible ; chemin absolu du répertoire dans lequel décompresser le SIP. Facultatif, la valeur par défaut est actions.workbench.work

Quality Assurance: vérifier fixity du SIP

Vérifie la conformité des fichiers d'un SIP avec les sommes de contrôle stockées dans le fichier METS. Les résultats de la vérification sont enregistrés dans le fichier METS sous forme d'événements PREMIS.

java ch.docuteam.actions.qualityassurance.SIPFixityCheck \
     [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

Quality Assurance: vérifier la longueur du chemin d'accès au fichier

Vérifie si la longueur des chemins absolus d'un SIP est supérieure à une valeur spécifiée.

java ch.docuteam.actions.qualityassurance.FilePathLengthCheck \
     /absolute/path/to/folder maxAllowedFilePathLength

Paramètre	Description
/absolute/path/to/folder	chemin absolu du dossier à vérifier
maxAllowedFilePathLength	le nombre maximal autorisé de caractères dans le chemin d'accès canonique du fichier

Quality Assurance: vérifier la longueur du chemin sip

Vérifie la longueur des chemins d'accès aux fichiers dans un SIP par rapport à une limite spécifiée.

java ch.docuteam.actions.qualityassurance.SIPPathLengthCheck \
     [path/to/]SIP  maxAllowedFilePathLength

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
maxAllowedFilePathLength	le nombre maximal autorisé de caractères dans le chemin d'accès canonique du fichier

Quality Assurance: obtenir le PID

Se connecte à un référentiel Fedora et récupère un seul PID. Ce PID sert ensuite de base pour le stockage dans le référentiel. La valeur est stockée dans l'élément <mets:OBJID/>.

java ch.docuteam.actions.qualityassurance.SIPConfirmation \
     [path/to/]SIP [PIDNamespace[:###]]

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
[PID namespace[:###]]	namespace pour le nouveau PID ou PID complet à utiliser pour l'objet; s'il est omis, le namespace standard de l'accord de soumission sera utilisé; si l'accord de soumission est introuvable, le namespace par défaut du référentiel Fedora sera utilisé.

Quality Assurance: convertir en noms de fichiers sécurisés

Renomme les fichiers contenant des caractères spéciaux. Les noms de fichiers sécurisés ne contiennent que les caractères A-Z, a-z, 0-9 et "_.-".

java ch.docuteam.actions.qualityassurance.SIPConvertToSafeFileNames \
     [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

Quality Assurance: vérifier les extensions de fichiers

Vérifie que les extensions de fichier dans un SIP correspondent aux identifiants uniques PRONOM (PUID). Cette étape ne relance pas l'identification du format de fichier, mais utilise les PUID présents dans le fichier mets.xml.

Si un fichier n'a pas d'extension, l'action l'ajoute en fonction du PUID. Si un fichier a une extension incorrecte, l'action signale tous les fichiers avec des extensions incorrectes (par défaut) ou remplace l'extension (si --replaceExistingExtensions=true est défini). Si un fichier n'a pas de PUID, l'action signale cela comme une erreur ou ignore les fichiers sans PUID (si --ignoreUnidentifiedFiles=true est défini).

java ch.docuteam.actions.qualityassurance.SIPFileExtensionCheck \
     --sip=[path/to/]SIP [--replaceExistingExtensions=true|false] [--ignoreUnidentifiedFiles=true|false]

Paramètre	Description
--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
--replaceExistingExtensions	facultatif, `true
--ignoreUnidentifiedFiles	facultatif, `true

Quality Assurance: supprimer les fichiers de backup

Supprime les fichiers du SIP qui correspondent à un modèle de nom spécifique.

java ch.docuteam.actions.qualityassurance.SIPDeleteBackupFiles \
     [path/to/]SIP  [filenamePattern filenamePattern ...]

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
[filenamePattern filenamePattern ...]	une liste de modèles de noms de fichiers (sans distinction entre majuscules et minuscules, « * » est un caractère générique, mais n'est autorisé qu'au début ou à la fin du modèle). Les fichiers correspondant à l'un de ces modèles seront supprimés.

Quality Assurance: supprimer les fichiers vides

Supprime les fichiers vides (dont la taille est de 0 bytes) du SIP.

java ch.docuteam.actions.qualityassurance.SIPDeleteEmptyFiles \
     --sip=[path/to/]SIP [--additionalDeletionInformation=<message>]

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
--additionalDeletionInformation	facultatif ; texte ; informations supplémentaires sur la suppression des fichiers SIP qui sont ajoutées à eventDetail

Quality Assurance: vérifier le SIP par rapport à l'accord de soumission

Checks whether the file formats comply with the specifications in the submission agreement. There are two modes: in the first mode (removeBadFiles = false), every file which does not match the submission agreement is listed (using the WARN log entries) and an error code is displayed. In the second mode (removeBadFiles = true), every file which does not match the submission agreement will be deleted from the SIP. The modified mets.xml is saved (the original SIP remains unchanged as a backup).

java ch.docuteam.actions.qualityassurance.SIPSubmissionAgreementCheck \
     [path/to/]SIP [removeBadFiles] [operationSA] [operationDSS]

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
[removeBadFiles]	facultatif, `true
[operationSA]	facultatif, ID d'un accord de soumission externe à utiliser pour cette action (au lieu de l'accord qui fait partie du SIP)
[operationDSS]	facultatif, ID d'une section de soumission de données externes à utiliser pour cette action (au lieu de l'accord qui fait partie du SIP)

Quality Assurance: Vérification du virus SIP

Chaque fichier présent dans le SIP est analysé à la recherche de virus. Le scanner antivirus ClamAV est utilisé pour la vérification des virus.

La condition préalable à cette vérification est que le service ClamAV soit lancé. En fonction du deuxième argument, les fichiers infectés seront rejetés ou automatiquement supprimés. Le troisième argument facultatif permet de définir une taille maximale pour les fichiers. Seuls les fichiers dont la taille est inférieure à cette limite seront analysés. La limite peut être saisie dans l'un des formats suivants : 1B, 1KB, 1MB, 1GB, 1TB. Seuls les nombres entiers sont autorisés, les fractions (par exemple 1,5 Go) ne fonctionnent pas.

java ch.docuteam.actions.qualityassurance.SIPVirusCheck \
     [path/to/]SIP deleteInfected [maxSize]

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
deleteInfected	Si true, l'opération supprime automatiquement les fichiers infectés du SIP
[maxSize]	maxSize en B, KB, MB, GB ou TB, seuls les fichiers dont la taille est inférieure à cette limite seront analysés

Quality Assurance: supprimer par niveau de description

Supprime un certain niveau de description d'un SIP.

java ch.docuteam.actions.qualityassurance.RemoveByLevelOfDescription \
     [/path/to/]folder levelOfDescription

Paramètre	Description
[path/to/]folder	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
levelOfDescription	nom du niveau de description à supprimer du SIP

Quality Assurance: ajouter/mettre à jour les informations sur le format de fichier

Pour tous les fichiers du SIP, l'identification du format est effectuée et les informations obtenues sont ajoutées/mises à jour.

Un paramètre permet d'indiquer si les informations existantes doivent être remplacées ou conservées (valeur par défaut : false).

java ch.docuteam.actions.qualityassurance.SIPFormatIdentificationCheck \
     --sip=[path/to/]SIP [--replaceExistingFormatInfo=true|false]

Paramètre	Description
--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
--replaceExistingFormatInfo	facultatif, `true

Quality Assurance: supprimer les fichiers par format (type PUID ou MIME)

Supprime tous les fichiers SIP correspondant à un format de fichier donné. Les formats peuvent être indiqués soit par le type MIME, soit par les identifiants uniques Pronom (PUID).

java ch.docuteam.actions.qualityassurance.SIPDeleteFilesByFormat \
     --sip=[path/to/]SIP [--mimetype=...] [--puid=...]

Paramètre	Description
--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
--mimetype	facultatif ; liste séparée par des virgules des types MIME à supprimer de ce paquet
--puid	facultatif ; liste séparée par des virgules des identifiants PRONOM (PUID) à supprimer de ce paquet