Fichier manifeste

Les processus en mode batch qui créent des fichiers, par exemple ceux liés à l'exportation de données, peuvent créer un ou plusieurs fichiers dans chaque thread de traitement. Les applications externes qui consomment ces fichiers n'ont besoin de les traiter que lorsque l'intégralité du processus en mode batch s'est terminée avec succès. Pour automatiser la consommation de ces fichiers, l'application externe peut exploiter une fonction qui se déclenchera lors de la création d'un fichier manifeste pour traiter tous les fichiers référencés par le manifeste. Le fichier manifeste inclut des détails tels que la valeur de hachage du contenu, les informations de taille de fichier, etc., qui peuvent confirmer que le contenu du fichier est complet et n'a pas été altéré avant le traitement des fichiers.

Les sections suivantes fournissent des informations supplémentaires sur les fichiers manifestes.

Paramètre de batch Option de manifeste

La création de fichier manifeste est uniquement prise en charge par certains contrôles de batch de l'installation standard liés à l'extraction. Ces contrôles de batch incluent le paramètre de batch Option de manifeste qui contrôle si un fichier manifeste doit être créé ou non une fois le processus en mode batch terminé. Vous pouvez utiliser le portail Requête de contrôle de batch pour rechercher tous les contrôles de batch prenant en charge cette option.

Informations contenues dans le fichier manifeste

Le contenu du fichier manifeste est fourni au format JSON et comprend les informations suivantes :

Version de la structure des détails du manifeste.
Code de contrôle de batch, numéro d'exécution et numéro de réexécution identifiant l'exécution de batch produisant les fichiers.
Nombre total de fichiers créés par l'exécution de batch.
Nombre total d'enregistrements traités par l'exécution de batch.
Horodatage de la création du manifeste au format ISO.
Le numéro de l'exécution de batch précédemment terminée, le cas échéant.
Le fichier de manifeste généré par l'exécution de batch précédemment terminée, le cas échéant. Il peut être utilisé pour garantir que les fichiers sont traités dans un ordre approprié et faciliter la détection de situations potentielles de fichiers manquants.
Liste des fichiers créés par l'exécution de batch qui inclut les détails suivants pour chaque fichier : le nom du fichier, sa taille en octets et la valeur de hachage SHA-256 du contenu du fichier.

Le nom du fichier manifeste est construit comme suit :

[batch control]_[batch run number]_[batch rerun number]_manifest.json

Voici un exemple de structure de fichier manifeste.

{
  "version": 1,
  "batchCode": "HD-PDE",
  "batchRunNumber": 106,
  "batchRerunNumber": 0,
  "totalFiles": 3,
  "recordsProcessed": 10,
  "timeStamp": "2020-05-02T16:55:43.000353Z",
  "previousBatchRunNumber":"105"
  "previousManifestFileName":"HD-PDE_105_0_manifest.json",
  "fileDetails": [
    {
      "fileName": "SOME_FILE_NAME_001.json.gz",
      "fileSize": 1543,
      "hashAlgorithm": "SHA-256",
      "hashValue": "ff7d4e466f93cadc4a18ab009080916baff631e03b728e2f2684c4a4f92ccbe1"
    },
    {
      "fileName": "SOME_FILE_NAME_002.json.gz",
      "fileSize": 1182,
      "hashAlgorithm": "SHA-256",
      "hashValue": "78869e7ce971f28a70f5b35693a05726ba66109fecf492edb60291a62ae1ba9f"
    },
    {
      "fileName": "SOME_FILE_NAME_003.json.gz",
      "fileSize": 1182,
      "hashAlgorithm": "SHA-256",
      "hashValue": "78869e7ce971f28a70f5b35693a05726ba66109fecf492edb60291a62ae1ba9f"
    }
  ]
}{

Vérifier le fichier manifeste

Le service Web Vérifier le fichier manifeste peut être utilisé par un système externe pour valider que le fichier manifeste qu'il a reçu pour une exécution de batch spécifique n'est pas endommagé ni altéré. Le service renvoie le nom du fichier manifeste et la valeur de hachage de son contenu pour l'exécution de batch demandée, ce qui permet à l'appelant de comparer les détails de son fichier avec les valeurs renvoyées.