Designing and Executing Processes : Process Steps and Associated Components : Validator Step
 
Share this page                  
Validator Step
Validator steps allow you to validate a document against a supplied schema. These steps check data at a structural level, such as the loop repeat count, segment information, minimum and maximum field length, and field values. The validators do not provide conditional validation or validate the data itself.
Before creating a process using the Execute action, create and initialize a DJMessage process variable. Load the file to validate into the body of the new DJMessage. See DJMessage Object Type for more information.
Validator Step Properties
After adding a Validator Step from the Toolbox Palette to the canvas, you can double-click the step on the canvas and specify the following step properties in the Properties tab displayed at the bottom.
Setting
Description
Name
Unique name for the step.
Description
Description of the step (optional).
Enabled
Select this option to enable the step for execution. If it is not enabled, then the step on the canvas is greyed-out.
This option is useful when troubleshooting a process, especially when there are numerous steps in the process.
Error Handling
Select any of the following:
• Abort Process - All the steps after the current step are skipped or the entire process is aborted (depending on how you have set the error logging options) if this step aborts due to an error.
• Ignore Error - The remaining steps in the current process are executed even if this step aborts due to an error. This is selected by default.
Select Validator
Select a Validator instance. These instances are displayed when you add a Validator message component in the Configuration tab. For more information, see Adding Message Components in Configuring Processes.
Action
Select the action for the Validator instance.
Parameters
Parameters for the selected action. Specify the values for the parameters.
Properties
Properties for the selected action. Specify the values for the properties.
Note:  The Actions, Parameters, and Properties are specific to the component type. For information about this, based on the component instance selected in the Select Validator drop-down list, see the component type in Validator Step Components.
Validator Step Components
• TA1 Validator
• XML (DTD) Validator
• XML Schema Validator
TA1 Validator
The TA1 Validator validates the Interchange Control Header (ISA segment) and Interchange Control Trailer (IEA segment) of a HIPAA document against specific TA1 technical acknowledgement note codes. This validator automatically generates a TA1, which is an optional response message that a trading partner may require as confirmation that a HIPAA document has been received and accepted.
Note:  The TA1 Validator does not verify the functionality of a HIPAA document.
In addition to the interchange control number, date, and time from the incoming HIPAA document, the generated TA1 also contains the following two elements:
• Interchange Note Code - Three-digit error code that indicates the result of the HIPAA validation process.
• Interchange Acknowledgement Code (ACK) - Character code that indicates the status of the HIPAA document. The possible values are:
• A: Accepted)
• R: Rejected because of errors; requires the sender to resubmit)
• E: Accepted with errors; does not require sender to resubmit)
Note:  If the ISA segment of an incoming HIPAA document is invalid, the TA1 Validator generates an error output message instead of a TA1 message.
If there are multiple errors in the incoming HIPAA document, the TA1 output message contains only the first error.
The following are examples of TA1 output messages:
Example TA1: Accepted
TA1*000011135*020823*0841*A*000
In this example, the "A" and "000" indicate the HIPAA document was accepted with no errors.
Example TA1: Rejected
TA1*000011135*020823*0841*R*022
In this example, the "R" and "022" indicate the HIPAA document was rejected with note code 022, which references an invalid control structure. The sender would have to resubmit the HIPAA document.
TA1 Validator Properties
You can specify the following properties when you create an instance of this validator component in the Configuration tab > Message Components section.
Property Name
Description
Error Code Configuration
Allows you to set TA1 note codes to on (include) or off (exclude) to control which ones are shown in the TA1 output. Multiple values must be separated by a comma. By default, all codes are set to on. For information about the TA1 note codes, see TA1 Note Codes.
TA1 Note Codes
The TA1 Validator supports the following TA1 interchange note codes.
Note Code
ACK Code
Configurable?
Condition
000
A
No
Success (no error).
001
E
Yes
The Interchange Control Numbers in the header ISA 13 and trailer IEA02 do not match.
005
R
Yes
Invalid Interchange ID Qualifier for Sender.
007
R
Yes
Invalid Interchange ID Qualifier for Receiver.
010
R
Yes
Invalid Authorization Information Qualifier value.
012
R
Yes
Invalid Security Information Qualifier value.
014
R
Yes
Invalid Interchange Date value.
015
R
Yes
Invalid Interchange Time value.
017
R
Yes
Invalid Interchange Version ID value.
019
E
Yes
Invalid Interchange Version ID value.
020
E
Yes
Invalid Test Indicator value.
022
R
No
Invalid Control Structure is  missing ISA segment or two ISA/IEA combinations were submitted in one physical file.
024
R
Yes
Invalid Interchange Content is 1) missing GS segment, 2) GS02 (Application Sender’s Code) does not match ISA06, or 3) GS03 (Application Receiver’s Code) does not match.
Supported Actions
 
Action
Description
Execute
Validates the incoming HIPAA document and generates a TA1 response in .txt format.
Supported Action Parameters
 
Action
Parameter
Description
SourceMessage
Message
Required. The name of the DJMessage source object that references the incoming HIPAA document.
Target Message
Message
Required. The name of the DJMessage output object that references the outgoing TA1 report.
Supported Action Properties
There are no supported action properties.
Errors
The validator supports the following error conditions.
Error Code
Error Name
Description
0
ERR_OK
Indicates the TA1 validation was successful. Check the resulting TA1 error code to determine if the HIPAA document is valid.
4
ERR_READERR
Indicates there is no input EDI file or that the ISA segment is invalid.
XML (DTD) Validator
The XML (DTD) Validator validates the HIPAA document against any DTD that is declared inside the XML document. If DTD is not declared, then only a syntax check is performed.
XML (DTD) Validator Properties
This validator component does not have any instance properties that you can specify when you create an instance of this validator component in the Configuration tab > Message Components section
Supported Actions
 
Action
Description
Execute
Validates a XML document against a DTD.
Supported Action Parameters
Action
Parameter
Description
SourceMessage
Message
(Required) XML input source message name.
Target Message
Message
(Required) Target message name. Output is in XML format.
Supported Action Properties
There are no supported action properties.
XML Schema Validator
The XML Schema Validator checks the structure of an XML file against a supplied XSD (XML schema document) file.
XML Schema Validator Properties
You can specify the following properties when you create an instance of this validator component in the Configuration tab > Message Components section.
Property Name
Description
W3C XML Schema File
Path or URI to the XSD file.
Supported Actions
Action
Description
Execute
Validates a document against a schema. The output is in XML format.
Supported Action Parameters
Action
Parameter
Description
SourceMessage
Message
Required. XML input source message name.
TargetMessage
Message
Required. Target message name. Output is in XML format.
Supported Action Properties
There are no supported action properties.
Errors
The validator supports the following error conditions.
Error Code
Error Name
Description
46
LICENSING
A valid product license is not found.
50
UNSPECIFIED
An unknown error occurred while loading the validator.
4
READER
The XML is not well formed and cannot be parsed.