Arquivo de Manifesto

Os processos em batch que criam arquivos, por exemplo, processos em batch relacionados à exportação de dados, podem criar um ou mais arquivos em cada encadeamento de processamento. Os aplicativos externos que consomem esses arquivos só precisam processá-los quando todo o processo em batch é concluído com êxito. Para automatizar o consumo desses arquivos, o aplicativo externo pode usar uma função a ser acionada na criação de um arquivo de manifesto para processar todos os arquivos referenciados pelo manifesto. O arquivo de manifesto inclui detalhes como valor de hash de conteúdo, informações de tamanho de arquivo, entre outras, que ajudam a confirmar se o conteúdo do arquivo foi concluído e não foi adulterado antes do processamento dos arquivos.

As seções a seguir contém informações adicionais sobre arquivos de manifesto.

O Parâmetro de Batch da Opção de Manifesto

A criação do arquivo de manifesto é compatível apenas com determinados controles batch relacionados à extração do produto base. Esses controles de batch incluem o parâmetro de batch Opção de Manifesto que controla se um arquivo de manifesto deve ser criado ou não após a conclusão com êxito do processo em batch. É possível usar o portal Consulta de Controle de Batch para localizar todos os controles de batch que aceitam essa opção.

Informações do Arquivo de Manifesto

O conteúdo do arquivo de manifesto é fornecido no formato JSON e inclui as seguintes informações:
  • A versão da estrutura de detalhes do manifesto.

  • O código de controle batch, o número de execução e o número de nova execução que identificam a execução em batch que produz os arquivos

  • Número total de arquivos criados pela execução em batch.

  • Número total de registros processados pela execução em batch.

  • A hora/data de criação do manifesto no formato ISO.

  • O número de execução em batch concluído anteriormente, se houver.

  • O arquivo de manifesto produzido pela execução em batch concluída anteriormente, se houver. Isso pode ser usado para garantir que os arquivos sejam processados em uma ordem adequada e para ajudar na detecção de situações potenciais de arquivos ausentes.

  • Uma lista de arquivos criados pela execução em batch que inclui os seguintes detalhes para cada arquivo: o nome do arquivo, o tamanho em bytes e o valor de hash SHA-256 do conteúdo do arquivo.

O nome do arquivo de manifesto é construído da seguinte forma:
[batch control]_[batch run number]_[batch rerun number]_manifest.json

Veja a seguir um exemplo da estrutura do arquivo de manifesto.

{
  "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"
    }
  ]
}{

Verificando o Arquivo de Manifesto

O serviço Web Verificar Arquivo de Manifesto pode ser usado por um sistema externo para validar se o arquivo de manifesto recebido por uma execução em batch específica não está corrompido ou adulterado. O serviço retorna o nome do arquivo de manifesto e o valor de hash do seu conteúdo para a execução em batch solicitada, permitindo que o chamador compare os detalhes do arquivo com os valores retornados.