Validate reads an x9 file in industry defined formats and applies x9 data and image validations against the parsed records. Identified validation errors are written to an output CSV file.
The x9 configuration which is used for the validation process is provided on the command line. Since field level validations can vary widely across the various x9 specifications, the errors that are identified can vary substantially subject to which x9 specification is applied to the file. Generally, the x9.37 specification is the most lenient of standards, which means that it will generate the fewest number of errors against any given file. However, when running a validation, you need to consider and apply the specific x9 configuration which best meets your application requirements.
The following x9 configurations can be used for file validations:
| X9 Configuration | Usage |
|---|---|
| x9.dstu-no-field-validations | File level structural validations are applied with minimal field validations. |
| x9.37 | The DSTU x9.37 which was the first x9.37 standard originally defined in 2003 and is the most basic and commonly used standard throughout the industry. |
| x9.100-180-2006 | The x9.100-180-2006 standard which is very infrequently used within the industry due to more drastic changes that were implemented (including the type 52 image record) and the associated complexities that resulted from the technical direction that was taken. |
| x9.100-187-2008 | The x9.100-187-2008 standard which is widely accepted through the industry. |
| x9.100-187_UCD-2008 | The x9.100-187-2008 standard with the associated Universal Companion Document applied. This standard is widely accepted by many financial institutions. |
| x9.100-187-2016 | The x9.100-187-2016 standard which is increasingly accepted through the industry. This standard includes the type 62 credit record and was the first (beyond x9.100-180-2006) to add credit support. |
| x9.100-187_UCD-2018 | The x9.100-187-2016 standard with the associated Universal Companion Document applied. This standard is increasingly accepted by many financial institutions. |
| x9.CPA_015 | The Canadian CPA 015 standard which is based on x9.100-187-2006 and is implemented within Canada. |
| x9.Frb | The Federal Reserve Bank (FRB) standard which is accepted by a large number of institutions and processors. |
Exit Status
Validate will set the overall run exit status as follows:
- -3 = input file not found
- -2 = invalid function
- -1 = aborted
- 0 = run successfully with no errors
- 1 = run successfully with informational message(s)
- 2 = run successfully with warning message(s)
- 3 = run successfully with error message(s)
- 4 = run successfully with severe error message(s)
The following CSV file is created by validate as an indication of the errors which have been found within the x9 file:
| Column | Content | Notes |
|---|---|---|
| 1 | X9 record number | Record number within the x9 file where the error occurred. |
| 2 | Record type | X9 record type or 8888 if the error is related to an image within a type 52 record. |
| 3 | Field number | X9 field number or 9999 if the error. |
| 4 | Field name | Field name associated with the error. |
| 5 | Error name | Internally assign error name. A complete list of all errors can be found in /xml/messages/messages.xml. Be advised that that error messages and potentially their names can change from release to release of the SDK. |
| 6 | Error severity | Error severity (severe, error, warn, or info). |
| 7 | Message text | Error message text. |
| 8 | Supplemental Information | Supplemental information concerning this specific error. |