Unité d'archive

Description

L'objet ArchiveUnit décrit une unité d'archive dans les messages d'échange.

Schéma

Nom de la propriété Type Description
identifier string Identifiant métier utilisé par les acteurs du système pour accéder à l'unité d'archive
displayName string Nom affiché aux utilisateurs
refDate date Date de référence, servant par exemple pour le calul des règles de gestion ou l'identification d'unité d'archive ayant des noms similaires et aucun identifiant métier
profile string Obligatoire. Identifiant du profil d'archive *
description mixed Information de contexte, dont la structure dépend du profil
filing Objet ArchiveUnitFilingMetadata Information de classement.
management Objet ArchiveUnitManagementMetadata Information de gestion applicable l'unité d'archive
relationships Liste d'objets ArchiveUnitReference Relations d'association avec d'autres unités d'archives
dataObjectReferences string[] Relations avec des objets-données internes au message ou présents dans le système
archiveUnits Objets ArchiveUnit Unités d'archives contenues
security Objet Security Information de sécurité d'accès à l'unité d'archive
control Objet Control Lecture seule. Information de contrôle gérée par le système
logBook Liste d'objets Event Historique des événement des objets-données et unité d'archives échangés.

* Le profil d'archive fournit un ensemble d'informations sur la structure des données et des métadonnées de l'archive, dont

  • le schéma de description
  • le niveau dans le plan de classement (file ou item)
  • les métadonnées de gestion
  • les droits des utilisateurs à verser ou non ce type d'unité d'archive

Chacune de ces informations peut être précisée unitairement lors du versement, si aucun profil n'est utilisé. A l'inverse, si un profil est utilisé, les informations éventuellement précisée pourront provoquer une erreur si elles sont en contradiction avec le profil. Attention à ne pas confondre avec le profil de versement précisé dans l'accord de versement et dans les métadonneés de gestion globales applicables aux transferts.

Information de classement

L'object ArchiveUnitFilingMetadata fournit l'information sur le classement de l'unité d'archive et la manière dont elle se positionne et se structure au sein de l'Archive.

Nom de la propriété Type Description
level string Niveau dans le classement, soit file soit item
originator string Identifiant d'organisme d'origine (producteur)
activity string Identifiant d'activité de rattachement
folder string Interdit si container est renseigné. Soit un chemin de dossier dans l'activité, soit un identifiant de dossier existant.
container string Interdit si folder est renseigné. Identifiant d'unité d'archive conteneur, qui doit être de niveau file.

Information de gestion

L'objet ArchiveUnitManagementMetadata fournit les règles de gestion applicables à une unité d'archive, et par héritage à ses contenus si aucune règle locale ne s'y applique.

Nom de la propriété Type Description
preservationStatus string Statut de conservation (preserved, transfered, frozen...)
processingStatus string Statut de traitement métier
serviceLevel string Identifiant du niveau de service applicable
appraisalRule Objet ArchiveUnitAppraisalRule Règle de sort final, peut être calculée à partir de l'application du profil
accessRule Objet ArchiveUnitAccessRule Règle de communicabilité, peut être récupérée du profil
classificationRule Objet ArchiveUnitClassificationRule Règle de confidentialité

Relations d'association

L'objet ArchiveUnitReference déclare une relation d'association entre deux unités d'archives échangées ou une unité d'archive échangée et une interne au système.

Nom de la propriété Type Description
type string Obligatoire. Type de relation : isVersionOf, isSourceOf, follows, preceeds...
refId string Obligatoire. Identifiant de l'unité d'archive associée *
displayName string Nom affiché pour l'association
description string Information de contexte de la relation

* L'identifiant peut être interne au message ou externe, c'est-à-dire faire référence à une unité d'archive présente dans le système d'archivage mais pas dans le message d'échange.

Exemple

{
    "identifier" : "F2019-001",
    "displayName" : "Facture F2019-001 du 29 janvier 2019",
    "profile" : "facture-client",
    "originator" : "ACME",
    "activity" : "FACCLI",
    "filingLevel" : "item",
    "description" : {
        "num" : "F2019-001",
        "date" : "2019-01-29",
        "custnum" : "ACC274365",
        "amount" : 736,98
    },
    "management" : {
        "appraisalRule" : {
            "code" : "COM10",
            "startDate" : "2019-01-30"
        }
    }

}

results matching ""

    No results matching ""