Vitam logo
Programme interministériel archivage numérique

Anciennes documentations

Est ici présentée la documentation des anciennes versions. Elle couvre à la fois les sujets métiers, d’architecture, ainsi que la documentation de développement.

Version 5.RC

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) avec les fichiers d’exemple utiles (zip)
  • Présentation de la solution logicielle - mode de développement, vision générale fonctionnelle et technique de la solution (pdf)

Télécharger toute la documentation métier et Vitam UI

Télécharger toute la documentation métier

Documentation métier

  • Manuel utilisateur (pdf)
  • 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)
  • Gestion des archives et des arborescences (ancienne documentation “Arbre de positionement et plan de classement” (pdf)
  • Règles de gestion - présentation du principe des règles de gestion et de leur héritage (pdf)
  • Services producteurs - présentation des fonctionnalités associées à la notion de service producteur (pdf)
  • Eliminations - présentation des fonctionnalités de mise en oeuvre des éliminations d’archives avec la solution logicielle Vitam (pdf)
  • Préservation - présentation des fonctionnalités de mise en oeuvre de la préservation à long-terme des archives avec la solution logicielle Vitam (pdf)
  • Profils d’archivage - éléments sur la notion de profil d’archivage (SEDA) (pdf)
  • Profils d’unité archivistique - éléments sur la notion de profil d’unité archivistique (pdf)
  • Ontologie - éléments sur la notion d’ontologie (pdf)
  • Conservation de la valeur probante - présentation de la sécurisation des journaux (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)
  • Modèle de workflow
    -> partie 1 : référentiels (pdf - partie 1)
    -> partie 2 : gestion du cycle de vie des archives (pdf - partie 2)
    -> partie 3 : préservation et intégrité (pdf - partie 3)
  • Gestion de multiples stratégies de stockage - présentation des fonctionnalités associées à la gestion et à la réalisation d’opérations de préservation numérique (pdf)
  • Le transfert avec la solution logicielle Vitam (pdf)
  • Le gel d’archives avec la solution logicielle Vitam (pdf)

Documentation des tests

  • Vitam UI : jeu de tests pour 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 à partir du front-office Vitam UI (zip)

  • 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 à partir de l’IHM Démo (pdf) avec les fichiers d’exemple utiles (zip)

  • Manuel IHM recette et Scenarii de tests métier (pdf)
  • Cahier de tests métier - liste des tests manuels sur les IHM aux formats Calc (ods) | et Excel (xlsx) avec les fichiers de tests associés (zip)

Documentation technique

  • Vitam back-office : dossier d’architecture technique (DAT) (pdf | html)

  • Vitam back-office : dossier d’installation (DIN) (pdf | html)

  • Vitam back-office : dossier d’exploitation (DEX) (pdf | html)

  • Vitam UI : dossier d’installation (html)

  • Vitam UI : dossier d’exploitation (html)

  • Documentation de montées de version (DMV) (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)
  • 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)

Documentation Vitam UI

Naviguer dans la documentation par domaine :

Documentation générale

  • Vitam UI : documentation produit (pdf)
  • Vitam UI : guide de prise en main (pdf)
  • Vitam UI : jeu de tests pour prise en main (zip)

Guide de lecture de la documentation Vitam UI

Domaine : organisation et droits utilisateurs
Ordre d'exécution Je souhaite... Je suis... APP Vitam UI
1.1 (obligatoire) ... créer une nouvelle organisation utilisatrice de Vitam UI et lui associer 1 ou plusieurs coffre(s) administrateur d'instance (si vous exposez Vitam UI en tant que service), administrateur technique VitamUI (si vous utilisez Vitam UI hébergé en propre) Organisation
1.2 (obligatoire) ... créer le compte nominatif de l'administrateur fonctionnel d'une organisation à des fins d'activation et prendre la main sur la session d'un utilisateur à des fins de support administrateur d'instance (si vous exposez Vitam UI en tant que service), administrateur technique VitamUI (si vous utilisez Vitam UI hébergé en propre) Subrogation
1.2 (facultatif) ... définir des droits fins sur les utilisateurs de mon organisation en créant un nouveau profil de droits administrateur fonctionnel Vitam UI Profil APP Utilisateur
1.3 (obligatoire sauf si le groupe existe déjà) ... définir des regroupements de droits sur les APPs Vitam UI pour mes utilisateurs en créant un nouveau groupe de profils administrateur fonctionnel Vitam UI Groupes de profils
1.4 (obligatoire sauf si le groupe existe déjà) ... créer mes utilisateurs et leur attribuer des droits administrateur fonctionnel Vitam UI Utilisateur
1.5 (facultatif) ... paramétrer des profils de droits permettant d’associer un contrat d’accès à un utilisateur administrateur fonctionnel Vitam UI Profil APP Paramétrages externes
Domaine : référentiels
Ordre d'exécution Je souhaite... Je suis... APP Vitam UI
2.1 (obligatoire) ... déclarer un nouveau service producteur ou un nouveau service versant dans Vitam UI administrateur fonctionnel Vitam UI Services agents
2.2 (Règles de gestion) ... déclarer des nouvelles règles de gestion administrateur fonctionnel Vitam UI Règles de gestion
2.2 (facultatif) ... déclarer un nouveau format non présent dans le référentiel PRONOM administrateur technique Vitam UI Formats de fichier
2.3 (facultatif) ... déclarer un nouveau vocabulaire non présent dans l'ontologie SEDA administrateur technique Vitam UI Ontologie
2.4 (facultatif) ... importer un arbre de positionnement ou un plan de classement administrateur fonctionnel Vitam UI Arbres et plans
Domaine : sécurité et droits applicatifs
Ordre d'exécution Je souhaite... Je suis... APP Vitam UI
3.1 (obligatoire sauf si le contrat existe déjà) ... paramétrer des droits pour le versement d'archives dans un coffre par une nouvelle application administrateur fonctionnel Vitam UI Contrat d'entrée
3.2 (obligatoire sauf si le contrat existe déjà) ... paramétrer des droits pour la consultation ou mise à jour d'archives dans un coffre par une nouvelle application administrateur fonctionnel Vitam UI Contrat d'accès
3.3 (obligatoire sauf si le contrat existe déjà) ... définir les droits d'une nouvelle application sur les services exposés par Vitam administrateur technique Vitam UI Profil de sécurité
3.4 (obligatoire sauf si le contrat existe déjà) ... authentifier une nouvelle application interconnectée avec Vitam et lui attribuer des droits administrateur technique Vitam UI Contexte applicatif
</table>
Domaine : supervision et audit
Ordre d'exécution Je souhaite... Je suis... APP Vitam UI
NA ... consulter le journal des opérations VITAM (entrées, éliminations et données de base) administrateur technique Vitam UI ou administrateur fonctionnel Vitam UI Journal des opérations
NA ... visualiser les opérations de sécurisation et accéder aux journaux du cycle de vie des objets administrateur technique Vitam UI Opérations de sécurisation
NA ... effectuer des requêtes complexes sur les bases de données documentaires en vue de retrouver des objets administrateur technique Vitam UI Requêtes DSL
NA ... vérifier la conformité de la conservation de mes archives administrateur fonctionnel Vitam UI, super-archiviste Audit
NA ... produire un relevé de valeur probante sur une ou plusieurs de mes archives électroniques administrateur fonctionnel Vitam UI, super-archiviste Relevé de valeur probante
NA ... gérer des opérations et interagir sur les étapes du workflow des opérations administrateur fonctionnel Vitam UI, super-archiviste Gestion des opérations
</table>
Domaine : versement et consultation
Ordre d'exécution Je souhaite... Je suis... APP Vitam UI
NA ... déposer un lot d'archives dans le SAE et en visualiser l'entrée archiviste Dépôt et suivi des versements
NA ... rechercher et télécharger des unités archivistiques contenues dans le SAE archiviste Recherche et consultation des archives
NA ...consulter et rechercher dans le registre des fonds archiviste Registre des fonds