Documentation Vitam

Table des matières

• 1. Présentation du programme Vitam
  • 1.1. Phase projet
  • 1.2. Phase maintenance et amélioration continue
  • 1.3. Licence
• 2. Ontologie
  • 2.1. Documents de référence
  • 2.2. Présentation du document
  • 2.3. Présentation de la notion d’ontologie
    • 2.3.1. Qu’est-ce qu’une ontologie ?
    • 2.3.2. Pourquoi une ontologie ?
  • 2.4. Formalisation des vocabulaires ontologiques
    • 2.4.1. Dans un fichier JSON
    • 2.4.2. Dans la solution logicielle Vitam
    • 2.4.3. Dans le Standard d’échange de données pour l’archivage (SEDA)
• 3. Le gel d’archives avec la solution logicielle Vitam
  • 3.1. Résumé
    • 3.1.1. Présentation du document
  • 3.2. Definitions
  • 3.3. Détermination de la règle de gel et de son application sur une unité archivistique avec la solution logicielle Vitam
    • 3.3.1. Le gel dans le référentiel des règles de gestion
    • 3.3.2. Formalisation du gel dans le Standard d’échanges de données pour l’archivage (SEDA)
    • 3.3.3. Formalisation du gel dans la solution logicielle Vitam
  • 3.4. Mécanismes mis en œuvre dans la solution logicielle Vitam
    • 3.4.1. Réalisation du gel d’archives
      • 3.4.1.1. Action de gel
      • 3.4.1.2. Impacts du gel sur les traitements de masse
    • 3.4.2. Réalisation du dégel d’archives
      • 3.4.2.1. Action de dégel
      • 3.4.2.2. Impacts du dégel sur les traitements de masse
  • 3.5. Conseils de mise en œuvre
    • 3.5.1. Comment intégrer des règles de gel dans le référentiel des règles de gestion ?
    • 3.5.2. Quand et comment bloquer le reclassement d’archives gelées ?
  • 3.6. Annexe 1 : Exemple de message ArchiveTransfer mettant en œuvre les différentes possibilités d’utilisation des règles de gestion
  • 3.7. Annexe 2 : Exemple de requête pour geler et dégeler des archives
• 4. Modèle de données
  • 4.1. Introduction
    • 4.1.1. Avertissement
    • 4.1.2. Objectif du document
    • 4.1.3. Création des index
    • 4.1.4. Généralités
      • 4.1.4.1. Collections et bases
      • 4.1.4.2. Cardinalité
      • 4.1.4.3. Nommage des champs
      • 4.1.4.4. Identifiants
      • 4.1.4.5. Dates
      • 4.1.4.6. Limite de caractères acceptés dans les champs
      • 4.1.4.7. Type d’indexation dans ElasticSearch
  • 4.2. Base Identity
    • 4.2.1. Collection Certificate
      • 4.2.1.1. Utilisation de la collection Certificate
      • 4.2.1.2. Exemple de JSON stocké en base comprenant l’exhaustivité des champs
      • 4.2.1.3. Détail des champs du JSON stocké dans la collection
    • 4.2.2. Collection PersonalCertificate
      • 4.2.2.1. Utilisation de la collection PersonalCertificate
      • 4.2.2.2. Exemple de JSON stocké en base comprenant l’exhaustivité des champs
      • 4.2.2.3. Détail des champs du JSON stocké dans la collection
  • 4.3. Base Logbook
    • 4.3.1. Collection LogbookOperation
      • 4.3.1.1. Utilisation de la collection LogbookOperation
      • 4.3.1.2. Exemple de JSON stocké en base comprenant l’exhaustivité des champs de la collection LogbookOperation
      • 4.3.1.3. Détail des champs du JSON stocké dans la collection
      • 4.3.1.4. Champs présents dans les events
      • 4.3.1.5. Détail des champs du JSON stocké en base spécifiques à une opération de sécurisation des journaux d’opération et de cycle de vie
    • 4.3.2. Collection LogbookLifeCycleUnit
      • 4.3.2.1. Exemple de JSON stocké en base comprenant l’exhaustivité des champs de la collection LogbookLifeCycleUnit
      • 4.3.2.2. Détail des champs du JSON stocké en base
      • 4.3.2.3. Champs présents dans les events
      • 4.3.2.4. Détail des champs du JSON stocké en base spécifiques à une mise à jour
    • 4.3.3. Collection LogbookLifeCycleObjectGroup
      • 4.3.3.1. Utilisation de la collection LogbookLifeCycleObjectGroup
      • 4.3.3.2. Extrait d’un JSON stocké en base comprenant l’exhaustivité des champs
      • 4.3.3.3. Détail des champs du JSON stocké en base
    • 4.3.4. Collection Offset
      • 4.3.4.1. Utilisation de la collection
      • 4.3.4.2. Exemple de JSON stocké en base comprenant l’exhaustivité des champs
      • 4.3.4.3. Détail des champs
  • 4.4. Base MetaData
    • 4.4.1. Collection Unit
      • 4.4.1.1. Utilisation de la collection Unit
      • 4.4.1.2. Exemple de XML en entrée
      • 4.4.1.3. Exemple de JSON stocké dans la collection Unit
      • 4.4.1.4. Détail du JSON
    • 4.4.2. Collection ObjectGroup
      • 4.4.2.1. Utilisation de la collection ObjectGroup
      • 4.4.2.2. Exemple de XML
      • 4.4.2.3. Exemple de JSON stocké en base
      • 4.4.2.4. Détail des champs du JSON
    • 4.4.3. Collection Offset
      • 4.4.3.1. Utilisation de la collection
      • 4.4.3.2. Exemple de JSON stocké en base comprenant l’exhaustivité des champs
      • 4.4.3.3. Détail des champs
  • 4.5. Base metadataCollect
    • 4.5.1. Collection Unit
      • 4.5.1.1. Utilisation de la collection Unit
      • 4.5.1.2. Exemple de JSON stocké dans la collection Unit
      • 4.5.1.3. Détail du JSON
    • 4.5.2. Collection ObjectGroup
      • 4.5.2.1. Utilisation de la collection ObjectGroup
      • 4.5.2.2. Exemple de JSON stocké en base
      • 4.5.2.3. Détail des champs du JSON
  • 4.6. Base collect
    • 4.6.1. Collection Collect
      • 4.6.1.1. Utilisation de la collection Collect
      • 4.6.1.2. Exemple de JSON stocké dans la collection Collect
      • 4.6.1.3. Détail du JSON
  • 4.7. Base MasterData
    • 4.7.1. Collection AccessContract
      • 4.7.1.1. Utilisation de la collection AccessContract
      • 4.7.1.2. Exemple d’un fichier d’import de contrat d’accès
      • 4.7.1.3. Détail des champs
    • 4.7.2. Collection AccessionRegisterDetail
      • 4.7.2.1. Utilisation de la collection AccessionRegisterDetail
      • 4.7.2.2. Exemple de la description dans le XML d’entrée
      • 4.7.2.3. Exemple de JSON stocké en base comprenant l’exhaustivité des champs
      • 4.7.2.4. Détail des champs
    • 4.7.3. Collection AccessionRegisterSummary
      • 4.7.3.1. Utilisation de la collection
      • 4.7.3.2. Exemple de JSON stocké en base comprenant l’exhaustivité des champs
      • 4.7.3.3. Détail des champs
    • 4.7.4. Collection AccessionRegisterSymbolic
      • 4.7.4.1. Utilisation de la collection
      • 4.7.4.2. Détail des champs
    • 4.7.5. Collection ArchiveUnitProfile
      • 4.7.5.1. Utilisation de la collection
      • 4.7.5.2. Exemple d’un fichier d’import de profils d’unité archivistique
      • 4.7.5.3. Exemple de JSON stocké en base comprenant l’exhaustivité des champs de la collection ArchiveUnitProfile
      • 4.7.5.4. Détail des champs de la collection ArchiveUnitProfile
    • 4.7.6. Collection Agencies
      • 4.7.6.1. Utilisation de la collection Agencies
      • 4.7.6.2. Exemple de JSON stocké en base comprenant l’exhaustivité des champs de la collection Agencies
      • 4.7.6.3. Détail des champs
    • 4.7.7. Collection Context
      • 4.7.7.1. Utilisation de la collection
      • 4.7.7.2. Exemple d’un fichier d’import de contexte applicatif
      • 4.7.7.3. Exemple de JSON stocké en base comprenant l’exhaustivité des champs de la collection Context
      • 4.7.7.4. Détail des champs
    • 4.7.8. Collection FileFormat
      • 4.7.8.1. Utilisation de la collection FileFormat
      • 4.7.8.2. Exemple de la description d’un format dans le XML d’entrée
      • 4.7.8.3. Exemple de JSON stocké en base comprenant l’exhaustivité des champs de la collection FileFormat
      • 4.7.8.4. Détail des champs du JSON stocké en base
    • 4.7.9. Collection FileRules
      • 4.7.9.1. Utilisation de la collection FileRules
      • 4.7.9.2. Exemple de JSON stocké en base comprenant l’exhaustivité des champs de la collection FileRules
      • 4.7.9.3. Détail des champs
    • 4.7.10. Collection Griffin
      • 4.7.10.1. Utilisation de la collection Griffin
      • 4.7.10.2. Exemple d’un fichier d’import de griffon
      • 4.7.10.3. Exemple de JSON stocké en base comprenant l’exhaustivité des champs de la collection Griffins
      • 4.7.10.4. Détail des champs
    • 4.7.11. Collection IngestContract
      • 4.7.11.1. Utilisation de la collection
      • 4.7.11.2. Exemple d’un fichier d’import de contrat
      • 4.7.11.3. Exemple de JSON stocké en base comprenant l’exhaustivité des champs de la collection IngestContract
      • 4.7.11.4. Détail des champs de la collection IngestContract
    • 4.7.12. Collection ManagementContract
      • 4.7.12.1. Utilisation de la collection ManagementContract
      • 4.7.12.2. Exemple d’un fichier d’import de contrat de gestion
      • 4.7.12.3. Exemple de JSON stocké en base comprenant l’exhaustivité des champs de la collection ManagementContract
      • 4.7.12.4. Détail des champs
    • 4.7.13. Collection Ontology
      • 4.7.13.1. Utilisation de la collection
      • 4.7.13.2. Exemple d’un fichier d’import d’ontology
      • 4.7.13.3. Détail des champs de la collection Ontology
    • 4.7.14. Collection PreservationScenario
      • 4.7.14.1. Utilisation de la collection PreservationScenario
      • 4.7.14.2. Exemple d’un fichier d’import de scénario de préservation
      • 4.7.14.3. Exemple de JSON stocké en base comprenant l’exhaustivité des champs de la collection PreservationScenario
      • 4.7.14.4. Détail des champs
    • 4.7.15. Collection Profile
      • 4.7.15.1. Utilisation de la collection Profile
      • 4.7.15.2. Exemple de JSON stocké en base comprenant l’exhaustivité des champs de la collection Profile
      • 4.7.15.3. Détail des champs
    • 4.7.16. Collection SecurityProfile
      • 4.7.16.1. Utilisation de la collection
      • 4.7.16.2. Exemple de JSON stocké en base comprenant l’exhaustivité des champs
      • 4.7.16.3. Détail des champs
    • 4.7.17. Collection VitamSequence
      • 4.7.17.1. Utilisation de la collection
      • 4.7.17.2. Exemple de JSON stocké en base comprenant l’exhaustivité des champs
      • 4.7.17.3. Détail des champs
    • 4.7.18. Collection Offset
      • 4.7.18.1. Utilisation de la collection
      • 4.7.18.2. Exemple de JSON stocké en base comprenant l’exhaustivité des champs
      • 4.7.18.3. Détail des champs
  • 4.8. Base Report
    • 4.8.1. Collection AuditObjectGroup
      • 4.8.1.1. Utilisation de la collection
      • 4.8.1.2. Détail des champs
    • 4.8.2. Collection EliminationActionUnit
      • 4.8.2.1. Utilisation de la collection
      • 4.8.2.2. Détail des champs
    • 4.8.3. Collection EliminationActionObjectGroup
      • 4.8.3.1. Utilisation de la collection
      • 4.8.3.2. Détail des champs
    • 4.8.4. Collection PreservationReport
      • 4.8.4.1. Utilisation de la collection
      • 4.8.4.2. Détail des champs
  • 4.9. Base Offer
    • 4.9.1. Collection OfferLog
      • 4.9.1.1. Utilisation de la collection OfferLog
      • 4.9.1.2. Exemple de JSON stocké en base comprenant l’exhaustivité des champs
      • 4.9.1.3. Détail des champs du JSON stocké dans la collection
    • 4.9.2. Collection CompactedOfferLog
      • 4.9.2.1. Utilisation de la collection CompactedOfferLog
      • 4.9.2.2. Exemple de JSON stocké en base comprenant l’exhaustivité des champs
      • 4.9.2.3. Détail des champs du JSON stocké dans la collection
    • 4.9.3. Collection OfferSequence
      • 4.9.3.1. Utilisation de la collection OfferSequence
      • 4.9.3.2. Exemple de JSON stocké en base comprenant l’exhaustivité des champs
      • 4.9.3.3. Détail des champs du JSON stocké dans la collection
    • 4.9.4. Collection TapeCatalog (offre froide)
      • 4.9.4.1. Utilisation de la collection TapeCatalog
      • 4.9.4.2. Exemple de JSON stocké en base comprenant l’exhaustivité des champs
      • 4.9.4.3. Détail des champs du JSON stocké dans la collection
    • 4.9.5. Collections TapeQueueMessage (offre froide)
      • 4.9.5.1. Utilisation de la collection TapeQueueMessage
      • 4.9.5.2. Exemples de JSON stockés en base comprenant l’exhaustivité des champs
      • 4.9.5.3. Détail des champs du JSON stocké dans la collection
    • 4.9.6. Collection TapeObjectReferential (offre froide)
      • 4.9.6.1. Utilisation de la collection TapeObjectReferential
      • 4.9.6.2. Exemple de JSON stocké en base comprenant l’exhaustivité des champs
      • 4.9.6.3. Détail des champs du JSON stocké dans la collection
    • 4.9.7. Collection TapeArchiveReferential (offre froide)
      • 4.9.7.1. Utilisation de la collection TapeArchiveReferential
      • 4.9.7.2. Exemples de JSON stockés en base comprenant les différents cas possibles
      • 4.9.7.3. Détail des champs du JSON stocké dans la collection
    • 4.9.8. Collection TapeAccessRequestReferential (offre froide)
      • 4.9.8.1. Utilisation de la collection TapeAccessRequestReferential
      • 4.9.8.2. Exemples de JSON stockés en base comprenant l’exhaustivité des champs
      • 4.9.8.3. Détail des champs du JSON stocké dans la collection
  • 4.10. Annexe 1 : Valeurs possibles pour le champ evType du LogBook Operation
  • 4.11. Annexe 2 : Valeurs possibles pour le champ evType du LogBook LifeCycle
  • 4.12. Annexe 3: Valeurs possibles pour le champ evTypeProc (type de processus)
  • 4.13. Annexe 4 : Catégories de règles possibles
  • 4.14. Annexe 5 : Valeurs possibles pour le champ Status de la collection AccessionRegisterDetail
  • 4.15. Annexe 6 : Valeurs possibles pour le champ Name de la collection VitamSequence
  • 4.16. Annexe 7 : Type d’indexation des chaînes de caractères dans ElasticSearch par collection et par champ
  • 4.17. Annexe 8 : Correspondances des champs spéciaux dans Vitam
• 5. Description des workflows et des opérations
  • 5.1. Objectif du document
  • 5.2. gestion du cycle de vie des archives
    • 5.2.1. Ingest
      • 5.2.1.1. Processus des contrôles préalables à l’entrée (STP_SANITY_CHECK_SIP)
        • 5.2.1.1.1. Contrôle sanitaire du SIP SANITY_CHECK_SIP (IngestExternalImpl.java)
        • 5.2.1.1.2. Contrôle du format du conteneur du SIP CHECK_CONTAINER (IngestExternalImpl.java)
        • 5.2.1.1.3. Contrôle du nom du bordereau de transfert MANIFEST_FILE_NAME_CHECK (IngestExternalImpl.java)
        • 5.2.1.1.4. Vérification de l’intégrité du bordereau de transfert MANIFEST_DIGEST_CHECK (IngestExternalImpl.java)
      • 5.2.1.2. Processus de réception du SIP dans Vitam STP_UPLOAD_SIP (IngestInternalResource.java)
      • 5.2.1.3. Processus de contrôle du SIP (STP_INGEST_CONTROL_SIP)
        • 5.2.1.3.1. Vérification globale du CHECK_SEDA (CheckSedaActionHandler.java)
        • 5.2.1.3.2. Vérification de l’en-tête du bordereau de transfert CHECK_HEADER (CheckHeaderActionHandler.java)
        • 5.2.1.3.3. Vérification de la présence et contrôle des services agents CHECK_HEADER.CHECK_AGENT
        • 5.2.1.3.4. Vérification de la présence et contrôle du contrat d’entrée CHECK_HEADER.CHECK_CONTRACT_INGEST
        • 5.2.1.3.5. Vérification de la relation entre le contrat d’entrée et le profil d’archivage CHECK_HEADER.CHECK_IC_AP_RELATION
        • 5.2.1.3.6. Vérification de la conformité du bordereau de transfert par le profil d’archivage CHECK_HEADER.CHECK_ARCHIVEPROFILE
        • 5.2.1.3.7. Préparation des informations de stockage PREPARE_STORAGE_INFO (PrepareStorageInfoActionHandler.java)
        • 5.2.1.3.8. Vérification des objets et groupes d’objets CHECK_DATAOBJECTPACKAGE
        • 5.2.1.3.9. Vérification des usages des groupes d’objets CHECK_DATAOBJECTPACKAGE.CHECK_MANIFEST_DATAOBJECT_VERSION (CheckVersionActionHandler.java)
        • 5.2.1.3.10. Vérification du nombre d’objets CHECK_DATAOBJECTPACKAGE.CHECK_MANIFEST_OBJECTNUMBER (CheckObjectsNumberActionHandler.java)
        • 5.2.1.3.11. Vérification de la cohérence du bordereau de transfert CHECK_DATAOBJECTPACKAGE.CHECK_MANIFEST (ExtractSedaActionHandler.java)
        • 5.2.1.3.12. Vérification de la cohérence entre objets, groupes d’objets et unités archivistiques CHECK_DATAOBJECTPACKAGE.CHECK_CONSISTENCY (CheckObjectUnitConsistencyActionHandler.java)
        • 5.2.1.3.13. Vérification du rattachement à un groupe d’objets ou une unité archivistique entrés sans erreur CHECK_ATTACHEMENT (CheckAttachementActionHandler.java)
      • 5.2.1.4. Processus de contrôle et traitement des objets (STP_OG_CHECK_AND_TRANSFORME)
        • 5.2.1.4.1. Vérification de l’intégrité des objets CHECK_DIGEST (CheckConformityActionPlugin.java)
      • 5.2.1.5. Processus de contrôle et traitement des unités archivistiques (STP_UNIT_CHECK_AND_PROCESS)
        • 5.2.1.5.1. Vérification du profil d’unité archivistique CHECK_ARCHIVE_UNIT_PROFILE (CheckArchiveUnitProfileActionPlugin.java)
        • 5.2.1.5.2. Application des règles de gestion et calcul des dates d’échéances UNITS_RULES_COMPUTE (UnitsRulesComputePlugin.java)
      • 5.2.1.6. Processus de vérification préalable à la prise en charge (STP_STORAGE_AVAILABILITY_CHECK)
        • 5.2.1.6.1. Vérification de la disponibilité de l’offre de stockage STORAGE_AVAILABILITY_CHECK.STORAGE_AVAILABILITY_CHECK (CheckStorageAvailabilityActionHandler.java)
      • 5.2.1.7. Processus d’écriture et indexation des objets et groupes d’objets (STP_OBJ_STORING)
        • 5.2.1.7.1. Écriture des objets sur l’offre de stockage OBJ_STORAGE (StoreObjectActionHandler.java)
        • 5.2.1.7.2. Indexation des métadonnées des groupes d’objets et objets OG_METADATA_INDEXATION (IndexObjectGroupActionPlugin.java)
      • 5.2.1.8. Processus d’indexation des unités archivistiques (STP_UNIT_METADATA)
      • 5.2.1.9. Processus d’enregistrement et écriture des métadonnées des objets et groupes d’objets (STP_OG_STORING)
        • 5.2.1.9.1. Enregistrement des journaux du cycle de vie des groupes d’objets COMMIT_LIFE_CYCLE_OBJECT_GROUP (CommitLifeCycleObjectGroupActionHandler.java)
        • 5.2.1.9.2. Écriture des métadonnées du groupe d’objets et objets sur l’offre de stockage OG_METADATA_STORAGE (StoreMetaDataObjectGroupActionPlugin)
      • 5.2.1.10. Processus d’enregistrement et écriture des unités archivistiques (STP_UNIT_STORING)
        • 5.2.1.10.1. Écriture des métadonnées de l’unité archivistique sur l’offre de stockage UNIT_METADATA_STORAGE (AccessInternalModuleImpl.java)
      • 5.2.1.11. Processus de mise à jour des groupes d’objets (STP_UPDATE_OBJECT_GROUP)
        • 5.2.1.11.1. Mise à jour des groupes d’objets OBJECT_GROUP_UPDATE (AccessInternalModuleImpl.java)
      • 5.2.1.12. Processus d’alimentation du registre des fonds (STP_ACCESSION_REGISTRATION)
        • 5.2.1.12.1. Alimentation du registre des fonds ACCESSION_REGISTRATION
      • 5.2.1.13. Processus de finalisation de l’entrée (STP_INGEST_FINALISATION)
        • 5.2.1.13.1. Notification de la fin de l’opération d’entrée ATR_NOTIFICATION (TransferNotificationActionHandler.java)
        • 5.2.1.13.2. Mise en cohérence des journaux du cycle de vie ROLL_BACK (RollBackActionHandler.java)
      • 5.2.1.14. Le cas du processus d’entrée « test à blanc »
      • 5.2.1.15. Structure du Workflow de l’entrée
    • 5.2.2. Mise à jour unitaire (Update)
      • 5.2.2.1. Workflow de mise à jour unitaire des unités archivistiques
      • 5.2.2.2. Mise à jour d’une unité archivistique (vision métier)

Indices and tables

• Index

• Search Page