Vitam logo
Programme interministériel archivage numérique

Documentation

Est ici présentée la documentation de la version publiée R5-0.26.x et des précédentes. Elle couvre à la fois les sujets métiers, d’architecture, ainsi que la documentation de développement.

Première approche

  • Guide de lecture de la documentation - guide d’orientation dans la documentation : quels documents pouvez-vous lire selon votre rôle et vos attentes ?… avec une description de chaque document (pdf)
  • Guide de prise en main - guide vous permettant d’effectuer les premiers paramétrages et une première entrée d’archives dans la solution logicielle Vitam (pdf)
  • Présentation du projet solution logicielle - mode de développement, vision générale fonctionnelle et technique de la solution (pdf)

Documentation métier

  • Manuel utilisateur (pdf | html)
  • Organisation de l’information - présentation des exigences fonctionnelles et des objets métiers utilisés par la solution logicielle Vitam (pdf)
  • Spécification des SIP - recommandations sur la construction des paquets à archiver (pdf)
  • Structuration des DIP - éléments sur la construction paquets d’archives transmis par le système d’archivage pour consultation (pdf)
  • Profils d’archivage - éléments sur la notion de profil d’archivage (SEDA) (pdf)
  • Gestion des habilitations - présentation des fonctionnalités associées à la gestion et à l’utilisation des habilitations (gestion des utilisateurs applicatifs et de leurs droits) (pdf)
  • Services producteurs - présentation des fonctionnalités associées à la notion de service producteur (pdf)
  • Arbre de positionement et plan de classement - description des principes d’organisation et de classement des unités archivistiques (pdf)
  • Mise à jour des unités archivistiques - description des principes de rattachement d’archives à des ensembles d’archives déjà versés (pdf)| html)
  • Règles de gestion - présentation du principe des règles de gestion et de leur héritage (pdf)
  • Modèle de workflow - description de la décompositon et du séquencement des opérations (pdf | html)
  • Conservation de la valeur probante - présentation de la sécurisation des journaux (pdf)
  • Présentation du générateur SEDA - présentation de l’outil complémentaire Générateur SEDA (pdf)
  • Présentation du générateur arbres et plans - présentation de l’outil de génération des arbres et plans (pdf)

Documentation des tests

  • Manuel IHM recette (pdf | html)
  • Scenarii de tests métier - description de la stratégie des tests (pdf | html)
  • Cahier de tests métier - liste des tests manuels sur les IHM - A VENIR
  • Configuration des tests de non régression automatique (pdf | html)

Documentation technique

  • Dossier d’architecture technique (DAT) (pdf | html)
  • Dossier d’exploitation (DEX) (pdf | html)
  • Dossier d’installation (DIN) (pdf | html)

Documentation développeur

  • Javadoc (html)
  • Manuel d’intégration applicative - présentation des principes de d’usage des interfaces (pdf | html)
  • Modèle de données - description des collections et des champs standards
    (pdf | html)
  • Documentation d’API externes - description des API REST externes en HTML (html)
  • Manuel de développement - éléments d’architecture interne et de méthode utiles aux développements de la solution logicielle VITAM (pdf | html)
  • Documentation d’API internes - description des API REST internes en HTML et RAML (html&raml)