README.rst

Générateur SEDA

Cet outil permet de générer des SIP contenant des bordereaux sous forme de fichiers XML, conformes au standard SEDA 2.0 (`http://www.archivesdefrance.culture.gouv.fr/seda/`_) de manière semi-automatique (au delà d'editeurs XML comme oxygen ou Eclipse) à partir d'une arborescence normalisée de fichiers.

---

Contents

• 1   Prérequis
• 2   Lancement
  • 2.1   Lancement sous windows
  • 2.2   Lancement sous Linux
• 3   Fichiers d'entrée
  • 3.1   Arborescence d'entrée
  • 3.2   Fichiers de configuration
• 4   Fichiers de sortie
• 5   Compilation & Packaging

1   Prérequis

• Disposer d'au moins 1 Go de RAM sur son poste de travail
• Disposer de 50 Mo de disque disponible (+ espace nécessaire pour la génération des archives)
• Disposer d'un JRE 8 sur le poste de travail (testé avec la JRE Oracle sous Windows et JRE OpenJDK sous Linux)
• Sous Windows, ne pas avoir de processus écoutant sur le port 5138

2   Lancement

2.1   Lancement sous windows

La version Windows inclut l'outil d'identification de format Siegfried avec une liste de signature

Lancer le script run_generator.bat avec 1 paramètre : Répertoire de base de l'arborescence que l'on désire scanner (ce doit être un répertoire et non un fichier seul).

Ceci peut notamment être fait avec un drag-and-drop dans l'explorateur windows en faisant "glisser" un répertoire sur le fichier run_generator.bat

Sous Windows, le script inclut le démarrage de Siegfried en mode serveur (port 5138) puis arrête Siegfried à la fin de l'exécution

2.2   Lancement sous Linux

La version Linux a besoin comme pré-requis de l'outil d'identification de format Siegfried :

• Pour une distribution basée sur des packages deb en 64 bits , suivre la procédure décrite sur la page `https://github.com/richardlehane/siegfried#ubuntudebian-64-bit`_.
• Pour une distribution RPM, il n'y a pas pour l'instant de version compilée

Lors du 1er lancement, il faut récupérer le fichier de signature : sf -update (accès HTTP sans proxy sur Internet nécessaire)

Lors de chaque lancement :

• Lancer siegfried en mode serveur sur le port 5138 : sf -serve localhost:5138
• Lancer le script run_generator.sh avec 1 paramètre : Répertoire de base de l'arborescence que l'on désire scanner

3   Fichiers d'entrée

3.1   Arborescence d'entrée

.. seealso:: Voir le fichier `doc/Arborescence.rst`_ pour les spécification de l'arborescence d'entrée.

3.2   Fichiers de configuration

Dans le répertoire conf :

• logback.xml : fichier de configuration logback standard
• ArchiveUnitTransfer.json : métadonnées globales de l'ArchiveTransfer (Comment, MessageIdentifier, ArchivalAgreement, CodeListVersions, ArchivalAgency, TransferringAgency, OriginatingAgencyIdentifier, SubmissionAgencyIdentifier)
• playbook_BinaryDataObject.json : Définition du "workflow" des différentes étapes pour un BinaryDataObject

.. seealso:: Voir le fichier `doc/Configuration.rst`_ pour plus de détails

4   Fichiers de sortie

2 fichiers :

• Un fichier horodaté ZIP (pkZIP) avec les fichiers suivants (SIP-yyyyMMddHHmmss.zip) :

  • Un fichier SEDA généré qui est valide par rapport au schéma SEDA 2.0 (MEDONA) : l'affichage des ArchiveUnit est dans l'ordre du parcours en profondeur de l'arborescence
  • Un répertoire Content qui contient l'ensemble des BinaryDataObject décrits dans le fichier SEDA. Chaque fichier a pour nom son ID dans le bordereau Seda

• Un fichier avec la liste des fichiers rejetés (SIP-yyyyMMddHHmmss.rejected)

5   Compilation & Packaging

Pour le packaging, il faut :

• lancer la compilation des classes : mvn clean package
• se positionner dans le répertoire scripts et lancer sh generate_package.sh. Le résultat est dans dans le répertoire scripts/build