Adding a File Definition

Adding a File Definition allows creating a library to handle file parsing, validation, and generation.

The following file formats are accepted:

Dilimited
Fixed Width
JSON
Value Constraints

Adding a File Definition

In the Left Side panel, click Add File Definition.

Fill in the required fields:

File Definition Name: Enter a name for the file definition.
Entity Type: Select the entity type. At the moment, only "Code Source" is available.
File Type: From the drop-down, select the file type.
Description: Enter a meaningful description for the file definition

Enter File Definition (JSON): Enter the JSON representing the file definition.

Example of Delimited File Definition:

{
  "Delimiter": ",",
  "Columns": [
    {
      "name": "src",
      "header": "Proprietary",
      "dataType": "string"    },
    {
      "name": "network",
      "header": "Network Code",
      "dataType": "string"    },
    {
      "name": "abc",
      "header": "ABC Explanation Code",
      "dataType": "string"    }
  ],
  "RowDelimiter": "LF"}

Example of Fixed Width File Definition:

{
  "fields": [
    {
      "fill": " ",
      "name": "GroupId",
      "align": "Left",
      "start": 1,
      "width": 20,
      "required": true,
      "fieldType": "string",
      "constraints": {}
    },
    {
      "fill": " ",
      "name": "EmployeeSsn",
      "align": "Left",
      "start": 21,
      "width": 9,
      "required": true,
      "fieldType": "string",
      "constraints": {}
    },
    {
      "fill": " ",
      "name": "AlternateMemberId",
      "align": "Left",
      "start": 30,
      "width": 15,
      "required": false,
      "fieldType": "string",
      "constraints": {}
    },
    {
      "fill": " ",
      "name": "DependentSsn",
      "align": "Left",
      "start": 45,
      "width": 9,
      "required": false,
      "fieldType": "string",
      "constraints": {}
    },
    {
      "fill": " ",
      "name": "LastName",
      "align": "Left",
      "start": 54,
      "width": 30,
      "required": true,
      "fieldType": "string",
      "constraints": {}
    },
    {
      "fill": " ",
      "name": "FirstName",
      "align": "Left",
      "start": 84,
      "width": 15,
      "required": true,
      "fieldType": "string",
      "constraints": {}
    },
    {
      "fill": " ",
      "name": "MiddleInitial",
      "align": "Left",
      "start": 99,
      "width": 1,
      "required": false,
      "fieldType": "string",
      "constraints": {}
    }

Example of JSON File Definition:

{}

Metadata: Enter any supplementary information for the file definition such as to identify which column in a file represents codes to use in a code source for SNIP level 5 validations.

Click Save.
The File Definitiion is added and information about the File Definition version number and ID are displayed.
Tip
Hovering over the question mark allows giving a preview of the JSON.