Usage - _INFO file

Usage > _INFO file

Table Of Contents

• Table Of Contents
• Description
• Validation
• Additional Information

Description

File named _INFO placed within the source directory together with the raw data is a JSON file tracking control measures via Atum. Example how the file should contain can be found in the code.

Validation

The _INFO file verification consists of checking that it has an array field of name checkpoints. The array has to have at least two objects one named (field name) “Raw” and one “Source”. Each of them has to have an array field controls. This array has to contain a control of type count ("controlType": "controlType.Count") with control value (field controlValue) containing a positive integer.

E.g.

{
  ...
  "checkpoints": [
    {
      "name": "Source",
      "processStartTime": "??? (timestamp)",
      "processEndTime": "??? (timestamp)",
      "workflowName": "Source",
      "order": "??? (positive integer)",
      "controls": [
        {
          "controlName": "recordCount",
          "controlType": "controlType.Count",
          "controlCol": "???",
          "controlValue": "??? (positive integer)"
        }
      ]
    },
    {
      "name": "Raw",
      "processStartTime": "??? (timestamp)",
      "processEndTime": "??? (timestamp)",
      "workflowName": "Raw",
      "order": "???",
      "controls": [
        {
          "controlName": "recordCount",
          "controlType": "controlType.Count",
          "controlCol": "???",
          "controlValue": "??? (positive integer)"
        }
      ]
    }
  ]
}

For a fully expanded example go here.

Additional Information

Additional information regarding the processing of information is added into the _INFO file during Standardization and Conformance.