User Guide : Designing and Executing Processes : Process Steps and Associated Components : Doc Validator Step
 
Share this page             
Doc Validator Step
The Doc Validator step allows you to validate a document against a specified schema. The schema types include EDI, EDIFACT, XML, HIPAA, SWIFT, IDOCS, UB92, and FIX.
 
The Doc Validator Step is only available for v9 compatible processes.
Doc Validator Step Properties
After adding a /download/attachments/25952290/DocValidator_step.png?version=1&modificationDate=1491996244363&api=v2 Doc Validator step from the 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.
Name
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 grayed-out.
This option is useful when troubleshooting a process, especially when there are numerous steps in the process.
Error Handling
Select either of the following:
Abort Process - All the steps after the current step are skipped or the entire process is stopped (depending on how you have set the error logging options) if this step stops due to an error.
Ignore Error - The remaining steps in the current process are executed even if this step stops due to an error. This is selected by default.
Validator Type
Select any of the following Doc Validator instance:
EDI
EDIFACT
FIX
HCFA1500
HIPAA
HL7
IDOC
SWIFT
TRADACOMS
UB92
XML (DTD)
XML Schema
Property
Depending on the type of the Doc Validator, the properties are displayed. Specify the values for the required properties. For more information, see Doc Validator Type Properties.
Document to validate
Type the location of the file or click Browse and specify the file that must be validated.
Treat Warnings as Errors
Select this option to consider any warnings generated by the Doc Validator as errors.
Doc Validator Type Properties
The following table lists the properties for the available Doc Validator types.
 
Field or Option
Default Value
Description
Validator Type
SchemaFile
-
Schema file that you want to use as the template to validate the document.
EDI, EDIFACT, FIX, HIPAA, HL7, IDOC, HCFA 1500, SWIFT, TRADACOMS, UB92
CodeSetFile
-
Code set file used to create the schema file. Code set files created in Document Schema Designer has a .dsc extension.
EDI, EDIFACT, HIPAA
Unicode
False
Indicate whether data is Unicode.
EDI, EDIFACT, FIX, HIPAA, HL7, IDOC, HCFA 1500, SWIFT, TRADACOMS, UB92
Skip
False
Allows you to skip segment mismatch errors if set to True.
EDI, EDIFACT, HIPAA
MaxSkipCount
Unlimited
Number of segment mismatch errors reached when Validator stops the process. If you want to use this option, you must set the Skip option to True.
Click the down arrow to choose 10, 20, 30, 40, 50, or Unlimited number of errors. You can also select the text and type your own value.
EDI, HIPAA
Cache Schema
False
Schema cached in memory. If set to true, schema is loaded only once for repeated validation. Otherwise, schema is re-loaded for every validation step.
EDI
Validation
0
Validate level
EDI
DecimalNotation
, (comma)
Sets the decimal notation.
EDIFACT
LineWrap
None
Sets the type of line wrap you want to use.
EDIFACT
SegmentTerminator
‘(apostrophe)
Specifies the character used to indicate the end of a record.
EDIFACT, HL7, TRADACOMS
StuffedLength
0
Length of the record after padding.
HL7
ReleaseIndicator
?
Specifies the character used to indicate that the following character should not be evaluated as a delimiter.
EDIFACT
ElementSeparator
+ (plus sign)
Specifies the character used to separate data fields within a record.
EDIFACT
SubElementSeparator
: (colon)
Specifies the character used to separate components of data within a composite data field. A composite data field is a field that consists of multiple sub-fields.
EDIFACT
RecordSeparator
CR-LF
The record separator to use when dividing the source into groups of records. This should be Unicode character(s).
IDOC
Version
4.x
SAP IDOC version number.
IDOC
Generating an Error File
When you test a source file against a schema, you can generate an XML file containing any errors found in the file. You can then use the XML file as the source in a map to generate a response. Use the response for determining the source file issues.
Unable to render embedded object: File (./images/proc.gif) not found.
To generate an XML error file:
1. Make sure the process file is closed.
2. Create a user environment variable called XMLOUTPUT with a value as 1.
3. Create a new process or open an existing process file.
4. For the Validator step, the OutputFile/URI property will appear. Enter the path and file name of the XML file that you want to generate.
If structural validation fails, the step creates the XML file. If the file is valid, proceed to the next step in the process.