VDAValidator Component
Properties Methods Events Config Settings Errors
VDAValidator is a lightweight EDI validation component designed for simple document validation.
Syntax
TeditranslatorVDAValidator
Remarks
This component provides a simple way to validate an EDI document and obtain details about any validation errors.
EDI Validation
Before calling Validate set SchemaFormat and call LoadSchema to load the schema for the document to be validated. The schema defines many validation rules such as minimum and maximum lengths, minimum and maximum occurrences, and more. The validation performed by the component depends largely on the schema's definition.
When the Validate method is called the component will attempt to validate the document. If errors are found during validation the ValidationError event will fire with details about each error as it is encountered. After the document has been validated the ValidationErrors property will be populated with details of each error.
Inspect the ValidationErrors property for information on any errors that were encountered.
Validation Example
validator.InputFile = "files/EDIDocuments/MyEDIDoc.txt";
validator.LoadSchema("my_schemas/00501/RSSBus_005010X222A1_837.json");
validator.Validate();
foreach (ValidationErrorDetail error in validator.ValidationErrors) {
Console.WriteLine(error.ErrorCode + ": " + error.Message);
}
Property List
The following is the full list of the properties of the component with short descriptions. Click on the links for further details.
EDIStandardVersion | The version of the EDI specification. |
InputData | The data to parse. |
InputFile | The file to parse. |
SchemaFormat | The format of the schema file. |
ValidationErrorCount | The number of records in the ValidationError arrays. |
ValidationErrorColumn | The column number in the EDI document where the error occurred. |
ValidationErrorElementErrorCode | The error code which may be used in the IK403 property of a 999. |
ValidationErrorElementPosition | This property holds the position of the element where the error occurred. |
ValidationErrorErrorCode | The ErrorCode property contains the type of error encountered. |
ValidationErrorLine | The line number in the EDI document where the error occurred. |
ValidationErrorMessage | Message is a textual description of the error. |
ValidationErrorSegmentErrorCode | The error code which may be used in the IK304 property of a 999. |
ValidationErrorSegmentNumber | This property is the index of the segment where the error occurred. |
ValidationErrorSegmentTag | This property specifies the tag name of the segment where the error occurred. |
ValidationErrorTechnicalErrorCode | This property holds a technical error code that helps identify structural issues with the document. |
Method List
The following is the full list of the methods of the component with short descriptions. Click on the links for further details.
CompileSchema | Compiles an existing XSD schema into an optimized binary representation. |
Config | Sets or retrieves a configuration setting. |
DisplaySchemaInfo | Returns a string showing the structure of the schema defining the document. |
DisplayXMLInfo | Returns a string showing the structure of the parsed document as XML. |
Flush | Flushes the parser and checks its end state. |
LoadSchema | Loads a schema file describing a Transaction Set. |
Reset | Resets the parser. |
Validate | Validates the specified EDI document. |
Event List
The following is the full list of the events fired by the component with short descriptions. Click on the links for further details.
EndFunctionalGroup | Fires whenever a control segment is read that marks the end of an interchange. |
EndInterchange | Fires whenever a control segment is read that marks the end of an interchange. |
EndLoop | Fires when the end of a loop is detected in a transaction set. |
EndTransaction | Fires whenever a control segment is read that marks the end of a transaction. |
Error | Information about errors during data delivery. |
ResolveSchema | Fires whenever a new transaction set is encountered and no schema is found for it. |
Segment | Fires whenever a data segment in a transaction set is read. |
StartFunctionalGroup | Fires whenever a control segment is read that marks the start of a functional group. |
StartInterchange | Fires whenever a control segment is read that marks the start of an interchange. |
StartLoop | Fires when the starting of a loop is detected in a transaction set. |
StartTransaction | Fires whenever a control segment is read that marks the start of a transaction. |
ValidationError | Fires whenever a validation error is encountered. |
Config Settings
The following is a list of config settings for the component with short descriptions. Click on the links for further details.
ComponentDelimiter | The delimiter separating components. |
CrossFieldValidationEnabled | Enables cross-field validation rules. |
EDIStandard | The document format. |
ElementDelimiter | The delimiter character separating data elements. |
Encoding | The character encoding to be applied when reading and writing data. |
ExtraData | Extra data that has not been parsed by the component. |
HasXPath | Determines if the specified XPath exists. |
MaxValidationErrors | The maximum number of errors to save in the ValidationErrors property. |
ReleaseChar | The character used to escape delimiters within values. |
ResolveXPathOnSet | Determines whether or not the XPath is resolved when set. |
SegmentDelimiter | The delimiter character separating segments within the EDI document. |
StrictSchemaValidation | Specifies the behavior during schema validation. |
BuildInfo | Information about the product's build. |
CodePage | The system code page used for Unicode to Multibyte translations. |
LicenseInfo | Information about the current license. |
MaskSensitive | Whether sensitive data is masked in log messages. |
UseFIPSCompliantAPI | Tells the component whether or not to use FIPS certified APIs. |
UseInternalSecurityAPI | Tells the component whether or not to use the system security libraries or an internal implementation. |
EDIStandardVersion Property (VDAValidator Component)
The version of the EDI specification.
Syntax
__property String EDIStandardVersion = { read=FEDIStandardVersion };
Default Value
""
Remarks
This property will be populated after parsing begins and the correct version string for is located via the schema, such as 004010 for X12.
This property is read-only and not available at design time.
Data Type
String
InputData Property (VDAValidator Component)
The data to parse.
Syntax
__property String InputData = { read=FInputData, write=FSetInputData };
Default Value
""
Remarks
This property specifies the data to be parsed.
Input Properties
The component will determine the source of the input based on which properties are set.
The order in which the input properties are checked is as follows:
- InputFile
- InputData
Data Type
String
InputFile Property (VDAValidator Component)
The file to parse.
Syntax
__property String InputFile = { read=FInputFile, write=FSetInputFile };
Default Value
""
Remarks
This property specifies the file to be processed. Set this property to the full or relative path to the file which will be processed.
Input Properties
The component will determine the source of the input based on which properties are set.
The order in which the input properties are checked is as follows:
- InputFile
- InputData
This property is not available at design time.
Data Type
String
SchemaFormat Property (VDAValidator Component)
The format of the schema file.
Syntax
__property TeditranslatorVDAValidatorSchemaFormats SchemaFormat = { read=FSchemaFormat, write=FSetSchemaFormat };
enum TeditranslatorVDAValidatorSchemaFormats { schemaAutomatic=0, schemaBinary=1, schemaBizTalk=2, schemaSEF=3, schemaBOTS=4, schemaAltova=5, schemaJSON=6 };
Default Value
schemaAutomatic
Remarks
Set SchemaFormat before calling the LoadSchema method to specify the loading schema format.
The following schema formats are supported:
0 (schemaAutomatic - default) | The schema type is automatically determined based on file extension. |
1 (schemaBinary) | A binary schema that was previously compiled by calling CompileSchema. |
2 (schemaBizTalk) | BizTalk (XSD): http://msdn.microsoft.com/en-us/library/aa559426(v=BTS.70).aspx |
3 (schemaSEF) | TIBCO Standard Exchange Format (SEF): https://docs.tibco.com/products/tibco-foresight-edisim-6-18-0 |
5 (schemaAltova) | Altova: http://www.altova.com/ |
6 (schemaJSON - recommended) | ArcESB JSON: https://arc.cdata.com/ |
Data Type
Integer
ValidationErrorCount Property (VDAValidator Component)
The number of records in the ValidationError arrays.
Syntax
__property int ValidationErrorCount = { read=FValidationErrorCount };
Default Value
0
Remarks
This property controls the size of the following arrays:
- ValidationErrorColumn
- ValidationErrorElementErrorCode
- ValidationErrorElementPosition
- ValidationErrorErrorCode
- ValidationErrorLine
- ValidationErrorMessage
- ValidationErrorSegmentErrorCode
- ValidationErrorSegmentNumber
- ValidationErrorSegmentTag
- ValidationErrorTechnicalErrorCode
This property is read-only and not available at design time.
Data Type
Integer
ValidationErrorColumn Property (VDAValidator Component)
The column number in the EDI document where the error occurred.
Syntax
__property int ValidationErrorColumn[int ValidationErrorIndex] = { read=FValidationErrorColumn };
Default Value
0
Remarks
The column number in the EDI document where the error occurred. This value may be used in conjunction with the ValidationErrorLine property to determine the exact location within the EDI document where the error occurred.
The ValidationErrorIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ValidationErrorCount property.
This property is read-only and not available at design time.
Data Type
Integer
ValidationErrorElementErrorCode Property (VDAValidator Component)
The error code which may be used in the IK403 property of a 999.
Syntax
__property String ValidationErrorElementErrorCode[int ValidationErrorIndex] = { read=FValidationErrorElementErrorCode };
Default Value
""
Remarks
The error code which may be used in the IK403 field of a 999.
Note: This property is specific to X12 documents and is not applicable to other document types.
The ValidationErrorIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ValidationErrorCount property.
This property is read-only and not available at design time.
Data Type
String
ValidationErrorElementPosition Property (VDAValidator Component)
This property holds the position of the element where the error occurred.
Syntax
__property int ValidationErrorElementPosition[int ValidationErrorIndex] = { read=FValidationErrorElementPosition };
Default Value
0
Remarks
This property holds the position of the element where the error occurred.
The ValidationErrorIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ValidationErrorCount property.
This property is read-only and not available at design time.
Data Type
Integer
ValidationErrorErrorCode Property (VDAValidator Component)
The ErrorCode property contains the type of error encountered.
Syntax
__property int ValidationErrorErrorCode[int ValidationErrorIndex] = { read=FValidationErrorErrorCode };
Default Value
0
Remarks
The ValidationErrorErrorCode property contains the type of error encountered. Possible values are:
0 | The component is not required but is present. |
1 | Invalid segment count. |
2 | Invalid transaction count. |
3 | Invalid group count. |
4 | Invalid interchange control number. |
5 | Invalid group control number. |
6 | Invalid transaction control number. |
10 | A required data element is missing. |
11 | Invalid field length. |
12 | Invalid field value. |
13 | A required component is missing. |
14 | The data element is not defined but is present. |
30 | Required segment is missing. |
31 | Required loop is missing. |
32 | Occurrences exceeds the schema defined limit. |
33 | Occurrences is less than the schema defined minimum. |
40 | Paired rule validation failed, the pair of elements must be present. |
41 | At least one of element is required, see message for list of elements. |
42 | Exclusion validation failed, only one of the elements can be present. |
43 | Conditional rule validation failed. |
44 | List conditional rule validation failed. |
45 | First then none validation failed. The presence of an element requires that other specific elements must not be present. |
46 | Only one or none of the elements can be present. |
The ValidationErrorIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ValidationErrorCount property.
This property is read-only and not available at design time.
Data Type
Integer
ValidationErrorLine Property (VDAValidator Component)
The line number in the EDI document where the error occurred.
Syntax
__property int ValidationErrorLine[int ValidationErrorIndex] = { read=FValidationErrorLine };
Default Value
0
Remarks
The line number in the EDI document where the error occurred. This value may be used in conjunction with the ValidationErrorColumn property to determine the exact location within the EDI document where the error occurred.
The ValidationErrorIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ValidationErrorCount property.
This property is read-only and not available at design time.
Data Type
Integer
ValidationErrorMessage Property (VDAValidator Component)
Message is a textual description of the error.
Syntax
__property String ValidationErrorMessage[int ValidationErrorIndex] = { read=FValidationErrorMessage };
Default Value
""
Remarks
ValidationErrorMessage is a textual description of the error.
The ValidationErrorIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ValidationErrorCount property.
This property is read-only and not available at design time.
Data Type
String
ValidationErrorSegmentErrorCode Property (VDAValidator Component)
The error code which may be used in the IK304 property of a 999.
Syntax
__property String ValidationErrorSegmentErrorCode[int ValidationErrorIndex] = { read=FValidationErrorSegmentErrorCode };
Default Value
""
Remarks
The error code which may be used in the IK304 field of a 999.
Note: This property is specific to X12 documents and is not applicable to other document types.
The ValidationErrorIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ValidationErrorCount property.
This property is read-only and not available at design time.
Data Type
String
ValidationErrorSegmentNumber Property (VDAValidator Component)
This property is the index of the segment where the error occurred.
Syntax
__property int ValidationErrorSegmentNumber[int ValidationErrorIndex] = { read=FValidationErrorSegmentNumber };
Default Value
0
Remarks
This property is the index of the segment where the error occurred.
The ValidationErrorIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ValidationErrorCount property.
This property is read-only and not available at design time.
Data Type
Integer
ValidationErrorSegmentTag Property (VDAValidator Component)
This property specifies the tag name of the segment where the error occurred.
Syntax
__property String ValidationErrorSegmentTag[int ValidationErrorIndex] = { read=FValidationErrorSegmentTag };
Default Value
""
Remarks
This property specifies the tag name of the segment where the error occurred.
The ValidationErrorIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ValidationErrorCount property.
This property is read-only and not available at design time.
Data Type
String
ValidationErrorTechnicalErrorCode Property (VDAValidator Component)
This property holds a technical error code that helps identify structural issues with the document.
Syntax
__property String ValidationErrorTechnicalErrorCode[int ValidationErrorIndex] = { read=FValidationErrorTechnicalErrorCode };
Default Value
""
Remarks
This property holds a technical error code that helps identify structural issues with the document. For instance when parsing an X12 document this will hold values that may be used for TA1 error codes.
Note: This property is specific to X12 documents and is not applicable to other document types.
Possible values are:
001 | The Interchange Control Numbers in the header ISA 13 and trailer IEA02 do not match. |
014 | Invalid interchange date value (non-numeric characters or wrong length). |
015 | Invalid interchange time value (non-numeric characters or wrong length). |
022 | The ISA segment is missing elements (invalid control structure). |
024 | Invalid interchange content (e.g., Invalid GS segment). |
The ValidationErrorIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ValidationErrorCount property.
This property is read-only and not available at design time.
Data Type
String
CompileSchema Method (VDAValidator Component)
Compiles an existing XSD schema into an optimized binary representation.
Syntax
void __fastcall CompileSchema(String XsdSchema, String BinSchema);
Remarks
This method parses XsdSchema and generates an optimized binary representation that is saved into the path referenced by BinSchema. Binary schemas are smaller and require less resources when loading later using LoadSchema
If the schema file does not exists or cannot be parsed as an EDI schema, the component throws an exception.
Config Method (VDAValidator Component)
Sets or retrieves a configuration setting.
Syntax
String __fastcall Config(String ConfigurationString);
Remarks
Config is a generic method available in every component. It is used to set and retrieve configuration settings for the component.
These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the component, access to these internal properties is provided through the Config method.
To set a configuration setting named PROPERTY, you must call Config("PROPERTY=VALUE"), where VALUE is the value of the setting expressed as a string. For boolean values, use the strings "True", "False", "0", "1", "Yes", or "No" (case does not matter).
To read (query) the value of a configuration setting, you must call Config("PROPERTY"). The value will be returned as a string.
DisplaySchemaInfo Method (VDAValidator Component)
Returns a string showing the structure of the schema defining the document.
Syntax
String __fastcall DisplaySchemaInfo();
Remarks
After calling LoadSchema this may be called to obtain information about the structure of the schema defining the document. If the desired XPath is not known this helps determine the structure so that the correct XPath can be built.
Note: A valid schema must be loaded via LoadSchema.
For instance:
Console.WriteLine(component.DisplaySchemaInfo());
Will output text like:
UNH[0,1] BGM[0,1] DTM[0,35] PAI[0,1] ALI[0,5] IMD[0,1] FTX[0,10] LOC[0,10] GIS[0,10] DGS[0,1] RFFLoop1[0,99] RFF[0,1] DTM_2[0,5] GIR[0,5] LOC_2[0,2] MEA[0,5] QTY[0,2] FTX_2[0,5] MOA[0,2] NADLoop1[0,99] NAD[0,1] LOC_3[0,25] FII[0,5] RFFLoop2[0,9999] RFF_2[0,1] DTM_3[0,5] DOCLoop1[0,5] DOC[0,1] DTM_4[0,5] CTALoop1[0,5] CTA[0,1] COM[0,5] TAXLoop1[0,5] TAX[0,1] MOA_2[0,1] LOC_4[0,5] CUXLoop1[0,5] CUX[0,1] DTM_5[0,5] PATLoop1[0,10] PAT[0,1] DTM_6[0,5] PCD[0,1] MOA_3[0,1] PAI_2[0,1] FII_2[0,1] TDTLoop1[0,10] TDT[0,1] TSR[0,1] LOCLoop1[0,10] LOC_5[0,1] DTM_7[0,5] RFFLoop3[0,9999] RFF_3[0,1] DTM_8[0,5] TODLoop1[0,5] TOD[0,1] LOC_6[0,2] PACLoop1[0,1000] PAC[0,1] MEA_2[0,5] EQD[0,1] PCILoop1[0,5] PCI[0,1] RFF_4[0,1] DTM_9[0,5] GIN[0,5] ALCLoop1[0,9999] ALC[0,1] ALI_2[0,5] FTX_3[0,1] RFFLoop4[0,5] RFF_5[0,1] DTM_10[0,5] QTYLoop1[0,1] QTY_2[0,1] RNG[0,1] PCDLoop1[0,1] PCD_2[0,1] RNG_2[0,1] MOALoop1[0,2] MOA_4[0,1] RNG_3[0,1] CUX_2[0,1] DTM_11[0,1] RTELoop1[0,1] RTE[0,1] RNG_4[0,1] TAXLoop2[0,5] TAX_2[0,1] MOA_5[0,1] RCSLoop1[0,100] RCS[0,1] RFF_6[0,5] DTM_12[0,5] FTX_4[0,5] AJTLoop1[0,1] AJT[0,1] FTX_5[0,5] INPLoop1[0,1] INP[0,1] FTX_6[0,5] LINLoop1[0,9999999] LIN[0,1] PIA[0,25] IMD_2[0,10] MEA_3[0,5] QTY_3[0,5] PCD_3[0,1] ALI_3[0,5] DTM_13[0,35] GIN_2[0,1000] GIR_2[0,1000] QVR[0,1] EQD_2[0,1] FTX_7[0,5] DGS_2[0,1] MOALoop2[0,10] MOA_6[0,1] CUX_3[0,1] PATLoop2[0,10] PAT_2[0,1] DTM_14[0,5] PCD_4[0,1] MOA_7[0,1] PRILoop1[0,25] PRI[0,1] CUX_4[0,1] APR[0,1] RNG_5[0,1] DTM_15[0,5] RFFLoop5[0,10] RFF_7[0,1] DTM_16[0,5] PACLoop2[0,10] PAC_2[0,1] MEA_4[0,10] EQD_3[0,1] PCILoop2[0,10] PCI_2[0,1] RFF_8[0,1] DTM_17[0,5] GIN_3[0,10] LOCLoop2[0,9999] LOC_7[0,1] QTY_4[0,100] DTM_18[0,5] TAXLoop3[0,99] TAX_3[0,1] MOA_8[0,1] LOC_8[0,5] NADLoop2[0,99] NAD_2[0,1] LOC_9[0,5] RFFLoop6[0,5] RFF_9[0,1] DTM_19[0,5] DOCLoop2[0,5] DOC_2[0,1] DTM_20[0,5] CTALoop2[0,5] CTA_2[0,1] COM_2[0,5] ALCLoop2[0,30] ALC_2[0,1] ALI_4[0,5] DTM_21[0,5] FTX_8[0,1] QTYLoop2[0,1] QTY_5[0,1] RNG_6[0,1] PCDLoop2[0,1] PCD_5[0,1] RNG_7[0,1] MOALoop3[0,2] MOA_9[0,1] RNG_8[0,1] CUX_5[0,1] DTM_22[0,1] RTELoop2[0,1] RTE_2[0,1] RNG_9[0,1] TAXLoop4[0,5] TAX_4[0,1] MOA_10[0,1] TDTLoop2[0,10] TDT_2[0,1] LOCLoop3[0,10] LOC_10[0,1] DTM_23[0,5] TODLoop2[0,5] TOD_2[0,1] LOC_11[0,2] RCSLoop2[0,100] RCS_2[0,1] RFF_10[0,5] DTM_24[0,5] FTX_9[0,5] GISLoop1[0,10] GIS_2[0,1] RFF_11[0,1] DTM_25[0,5] GIR_3[0,5] LOC_12[0,2] MEA_5[0,5] QTY_6[0,2] FTX_10[0,5] MOA_11[0,2] UNS[0,1] CNT[0,10] MOALoop4[0,100] MOA_12[0,1] RFFLoop7[0,1] RFF_12[0,1] DTM_26[0,5] TAXLoop5[0,10] TAX_5[0,1] MOA_13[0,2] ALCLoop3[0,15] ALC_3[0,1] ALI_5[0,1] MOA_14[0,2] FTX_11[0,1] UNT[0,1]
DisplayXMLInfo Method (VDAValidator Component)
Returns a string showing the structure of the parsed document as XML.
Syntax
String __fastcall DisplayXMLInfo();
Remarks
After the EDI document has been parsed this method may be called to obtain information about the document structure.
The parsed data is represented as XML when queried. This shows all parsed data and may be useful for testing and debugging purposes.
For instance:
Console.WriteLine(component.DisplayXMLInfo());
Will output text like:
<IX tag="UNB" UNB1="UNOB:1" UNB2="WAYNE_TECH" UNB3="ACME" UNB4="160707:1547" UNB5="000000002" UNB6="" UNB7="1234" UNB8="" UNB9="" UNB10="" UNB11="1"> <TX tag="UNH" UNH1="509010117" UNH2="INVOIC:D:97A:UN"> <BGM tag="BGM" BGM01="380:::TAX INVOICE" BGM02="0013550417" BGM03="9"/> <DTM tag="DTM" DTM01="3:20070926:102"/> <DTM tag="DTM" DTM01="4:20061123:102"/> <FTX tag="FTX" FTX01="AAI" FTX02="1"/> <TAXLoop1> <TAX tag="TAX" TAX01="7" TAX02="VAT" TAX03="" TAX04="" TAX05=":::10072.14" TAX06="S"/> </TAXLoop1> <CUXLoop1> <CUX tag="CUX" CUX01="2:EUR:4" CUX02="" CUX03="0.67529"/> </CUXLoop1> <PATLoop1> <PAT tag="PAT" PAT01="1"/> <DTM_6 tag="DTM" DTM01="10:20070926:102"/> <PCD tag="PCD" PCD01="2:0:13"/> </PATLoop1> <LINLoop1> <LIN tag="LIN" LIN01="000030" LIN02=""/> <PIA tag="PIA" PIA01="1" PIA02="2265S13:BP::92"/> <PIA tag="PIA" PIA01="1" PIA02="5029766832002:UP::92"/> <IMD_2 tag="IMD" IMD01="F" IMD02=""/> <QTY_3 tag="QTY" QTY01="47:50.000:EA"/> <DTM_13 tag="DTM" DTM01="11:20070926:102"/> <MOALoop2> <MOA_6 tag="MOA" MOA01="203:19150.00"/> </MOALoop2> <PRILoop1> <PRI tag="PRI" PRI01="INV:383.00:TU"/> </PRILoop1> <TAXLoop3> <TAX_3 tag="TAX" TAX01="7" TAX02="VAT" TAX03="" TAX04="" TAX05=":::17.500" TAX06="S"/> <MOA_8 tag="MOA" MOA01="125:19150.45"/> </TAXLoop3> <ALCLoop2> <ALC_2 tag="ALC" ALC01="C" ALC02="0.45" ALC03="" ALC04="" ALC05="FC"/> <MOALoop3> <MOA_9 tag="MOA" MOA01="8:0.45"/> </MOALoop3> </ALCLoop2> </LINLoop1> <LINLoop1> <LIN tag="LIN" LIN01="000040" LIN02=""/> <PIA tag="PIA" PIA01="1" PIA02="2269F22:BP::92"/> <PIA tag="PIA" PIA01="1" PIA02="5051254078241:UP::92"/> <IMD_2 tag="IMD" IMD01="F" IMD02=""/> <QTY_3 tag="QTY" QTY01="47:20.000:EA"/> <DTM_13 tag="DTM" DTM01="11:20070926:102"/> <MOALoop2> <MOA_6 tag="MOA" MOA01="203:21060.00"/> </MOALoop2> <PRILoop1> <PRI tag="PRI" PRI01="INV:1053.00:TU"/> </PRILoop1> <TAXLoop3> <TAX_3 tag="TAX" TAX01="7" TAX02="VAT" TAX03="" TAX04="" TAX05=":::17.500" TAX06="S"/> <MOA_8 tag="MOA" MOA01="125:21060.50"/> </TAXLoop3> <ALCLoop2> <ALC_2 tag="ALC" ALC01="C" ALC02="0.50" ALC03="" ALC04="" ALC05="FC"/> <MOALoop3> <MOA_9 tag="MOA" MOA01="8:0.50"/> </MOALoop3> </ALCLoop2> </LINLoop1> <LINLoop1> <LIN tag="LIN" LIN01="000170" LIN02=""/> <PIA tag="PIA" PIA01="1" PIA02="2269F10:BP::92"/> <PIA tag="PIA" PIA01="1" PIA02="5051254078326:UP::92"/> <IMD_2 tag="IMD" IMD01="F" IMD02=""/> <QTY_3 tag="QTY" QTY01="47:10.000:EA"/> <DTM_13 tag="DTM" DTM01="11:20070926:102"/> <MOALoop2> <MOA_6 tag="MOA" MOA01="203:6950.00"/> </MOALoop2> <PRILoop1> <PRI tag="PRI" PRI01="INV:695.00:TU"/> </PRILoop1> <TAXLoop3> <TAX_3 tag="TAX" TAX01="7" TAX02="VAT" TAX03="" TAX04="" TAX05=":::17.500" TAX06="S"/> <MOA_8 tag="MOA" MOA01="125:6950.16"/> </TAXLoop3> <ALCLoop2> <ALC_2 tag="ALC" ALC01="C" ALC02="0.16" ALC03="" ALC04="" ALC05="FC"/> <MOALoop3> <MOA_9 tag="MOA" MOA01="8:0.16"/> </MOALoop3> </ALCLoop2> </LINLoop1> <LINLoop1> <LIN tag="LIN" LIN01="000190" LIN02=""/> <PIA tag="PIA" PIA01="1" PIA02="2269F26:BP::92"/> <PIA tag="PIA" PIA01="1" PIA02="5051254051190:UP::92"/> <IMD_2 tag="IMD" IMD01="F" IMD02=""/> <QTY_3 tag="QTY" QTY01="47:5.000:EA"/> <DTM_13 tag="DTM" DTM01="11:20070926:102"/> <MOALoop2> <MOA_6 tag="MOA" MOA01="203:2375.00"/> </MOALoop2> <PRILoop1> <PRI tag="PRI" PRI01="INV:475.00:TU"/> </PRILoop1> <TAXLoop3> <TAX_3 tag="TAX" TAX01="7" TAX02="VAT" TAX03="" TAX04="" TAX05=":::17.500" TAX06="S"/> <MOA_8 tag="MOA" MOA01="125:2375.06"/> </TAXLoop3> <ALCLoop2> <ALC_2 tag="ALC" ALC01="C" ALC02="0.06" ALC03="" ALC04="" ALC05="FC"/> <MOALoop3> <MOA_9 tag="MOA" MOA01="8:0.06"/> </MOALoop3> </ALCLoop2> </LINLoop1> <LINLoop1> <LIN tag="LIN" LIN01="000200" LIN02=""/> <PIA tag="PIA" PIA01="1" PIA02="2265S24:BP::92"/> <PIA tag="PIA" PIA01="1" PIA02="5029766000685:UP::92"/> <IMD_2 tag="IMD" IMD01="F" IMD02=""/> <QTY_3 tag="QTY" QTY01="47:3.000:EA"/> <DTM_13 tag="DTM" DTM01="11:20070926:102"/> <MOALoop2> <MOA_6 tag="MOA" MOA01="203:957.00"/> </MOALoop2> <PRILoop1> <PRI tag="PRI" PRI01="INV:319.00:TU"/> </PRILoop1> <TAXLoop3> <TAX_3 tag="TAX" TAX01="7" TAX02="VAT" TAX03="" TAX04="" TAX05=":::17.500" TAX06="S"/> <MOA_8 tag="MOA" MOA01="125:957.02"/> </TAXLoop3> <ALCLoop2> <ALC_2 tag="ALC" ALC01="C" ALC02="0.02" ALC03="" ALC04="" ALC05="FC"/> <MOALoop3> <MOA_9 tag="MOA" MOA01="8:0.02"/> </MOALoop3> </ALCLoop2> </LINLoop1> <LINLoop1> <LIN tag="LIN" LIN01="000210" LIN02=""/> <PIA tag="PIA" PIA01="1" PIA02="2263T95:BP::92"/> <PIA tag="PIA" PIA01="1" PIA02="5029766699575:UP::92"/> <IMD_2 tag="IMD" IMD01="F" IMD02=""/> <QTY_3 tag="QTY" QTY01="47:3.000:EA"/> <DTM_13 tag="DTM" DTM01="11:20070926:102"/> <MOALoop2> <MOA_6 tag="MOA" MOA01="203:2085.00"/> </MOALoop2> <PRILoop1> <PRI tag="PRI" PRI01="INV:695.00:TU"/> </PRILoop1> <TAXLoop3> <TAX_3 tag="TAX" TAX01="7" TAX02="VAT" TAX03="" TAX04="" TAX05=":::17.500" TAX06="S"/> <MOA_8 tag="MOA" MOA01="125:2085.05"/> </TAXLoop3> <ALCLoop2> <ALC_2 tag="ALC" ALC01="C" ALC02="0.05" ALC03="" ALC04="" ALC05="FC"/> <MOALoop3> <MOA_9 tag="MOA" MOA01="8:0.05"/> </MOALoop3> </ALCLoop2> </LINLoop1> <LINLoop1> <LIN tag="LIN" LIN01="000250" LIN02=""/> <PIA tag="PIA" PIA01="1" PIA02="2269F15:BP::92"/> <PIA tag="PIA" PIA01="1" PIA02="5051254080091:UP::92"/> <IMD_2 tag="IMD" IMD01="F" IMD02=""/> <QTY_3 tag="QTY" QTY01="47:3.000:EA"/> <DTM_13 tag="DTM" DTM01="11:20070926:102"/> <MOALoop2> <MOA_6 tag="MOA" MOA01="203:4977.00"/> </MOALoop2> <PRILoop1> <PRI tag="PRI" PRI01="INV:1659.00:TU"/> </PRILoop1> <TAXLoop3> <TAX_3 tag="TAX" TAX01="7" TAX02="VAT" TAX03="" TAX04="" TAX05=":::17.500" TAX06="S"/> <MOA_8 tag="MOA" MOA01="125:4977.12"/> </TAXLoop3> <ALCLoop2> <ALC_2 tag="ALC" ALC01="C" ALC02="0.12" ALC03="" ALC04="" ALC05="FC"/> <MOALoop3> <MOA_9 tag="MOA" MOA01="8:0.12"/> </MOALoop3> </ALCLoop2> </LINLoop1> <UNS tag="UNS" UNS01="S"/> <CNT tag="CNT" CNT01="4:7"/> <MOALoop4> <MOA_12 tag="MOA" MOA01="9:67627.50"/> </MOALoop4> <MOALoop4> <MOA_12 tag="MOA" MOA01="79:57554.00"/> </MOALoop4> <TAXLoop5> <TAX_5 tag="TAX" TAX01="7" TAX02="VAT" TAX03="" TAX04="" TAX05=":::17.500" TAX06="S"/> <MOA_13 tag="MOA" MOA01="125:57555.36:EUR:3"/> <MOA_13 tag="MOA" MOA01="124:10072.14:EUR:3"/> </TAXLoop5> <ALCLoop3> <ALC_3 tag="ALC" ALC01="C" ALC02="1.36" ALC03="" ALC04="" ALC05="FC"/> <MOA_14 tag="MOA" MOA01="8:1.36"/> </ALCLoop3> </TX> </IX>
Flush Method (VDAValidator Component)
Flushes the parser and checks its end state.
Syntax
void __fastcall Flush();
Remarks
When Flush is called, the parser flushes all its buffers, firing events as necessary, and then checks its end state.
Any extra un-parsed data will be populated in the ExtraData property after this method is called.
LoadSchema Method (VDAValidator Component)
Loads a schema file describing a Transaction Set.
Syntax
void __fastcall LoadSchema(String FileName);
Remarks
This method parses the File and loads it into an internal schema list. The component will attempt to automatically detect the SchemaFormat.
If the schema file does not exist or cannot be parsed as an EDI schema, the component raises an exception.
Reset Method (VDAValidator Component)
Resets the parser.
Syntax
void __fastcall Reset();
Remarks
When called, the parser flushes all its buffers, firing events as necessary, and then initializes itself to its default state.
Reset must also be used as signal to the parser that the current stream of text has terminated.
Validate Method (VDAValidator Component)
Validates the specified EDI document.
Syntax
void __fastcall Validate();
Remarks
This method validates the EDI document specified by InputFile or InputData.
Before calling Validate set SchemaFormat and call LoadSchema to load the schema for the document to be validated. The schema defines many validation rules such as minimum and maximum lengths, minimum and maximum occurrences, and more. The validation performed by the component depends largely on the schema's definition.
When the Validate method is called the component will attempt to validate the document. If errors are found during validation the ValidationError event will fire with details about each error as it is encountered. After the document has been validated the ValidationErrors property will be populated with details of each error.
Inspect the ValidationErrors property for information on any errors that were encountered.
Validation Example
validator.InputFile = "files/EDIDocuments/MyEDIDoc.txt";
validator.LoadSchema("my_schemas/00501/RSSBus_005010X222A1_837.json");
validator.Validate();
foreach (ValidationErrorDetail error in validator.ValidationErrors) {
Console.WriteLine(error.ErrorCode + ": " + error.Message);
}
EndFunctionalGroup Event (VDAValidator Component)
Fires whenever a control segment is read that marks the end of an interchange.
Syntax
typedef struct { String Tag; String ControlNumber; int Count; String FullSegment; } TeditranslatorVDAValidatorEndFunctionalGroupEventParams; typedef void __fastcall (__closure *TeditranslatorVDAValidatorEndFunctionalGroupEvent)(System::TObject* Sender, TeditranslatorVDAValidatorEndFunctionalGroupEventParams *e); __property TeditranslatorVDAValidatorEndFunctionalGroupEvent OnEndFunctionalGroup = { read=FOnEndFunctionalGroup, write=FOnEndFunctionalGroup };
Remarks
The EndFunctionalGroup event will fire when a control segment marking the end of a functional group is read. The Tag parameter contains the tag of the segment, such as GE. ControlNumber contains the control number associated with the segment, and links this event with the corresponding StartFunctionalGroup event. Count contains the value of the count element included in the closing segment, which identifies the number of transactions in a functional group.
EndInterchange Event (VDAValidator Component)
Fires whenever a control segment is read that marks the end of an interchange.
Syntax
typedef struct { String Tag; String ControlNumber; String FullSegment; } TeditranslatorVDAValidatorEndInterchangeEventParams; typedef void __fastcall (__closure *TeditranslatorVDAValidatorEndInterchangeEvent)(System::TObject* Sender, TeditranslatorVDAValidatorEndInterchangeEventParams *e); __property TeditranslatorVDAValidatorEndInterchangeEvent OnEndInterchange = { read=FOnEndInterchange, write=FOnEndInterchange };
Remarks
The EndInterchange event will fire when a control segment marking the end of an interchange is read. The Tag parameter contains the tag of the segment, such as IEA. ControlNumber contains the control number associated with the segment, and links this event with the corresponding StartInterchange event.
EndLoop Event (VDAValidator Component)
Fires when the end of a loop is detected in a transaction set.
Syntax
typedef struct { } TeditranslatorVDAValidatorEndLoopEventParams; typedef void __fastcall (__closure *TeditranslatorVDAValidatorEndLoopEvent)(System::TObject* Sender, TeditranslatorVDAValidatorEndLoopEventParams *e); __property TeditranslatorVDAValidatorEndLoopEvent OnEndLoop = { read=FOnEndLoop, write=FOnEndLoop };
Remarks
The EndLoop event will fire after the last segment in a loop is read. Each EndLoop event is paired with one StartLoop event.
EndTransaction Event (VDAValidator Component)
Fires whenever a control segment is read that marks the end of a transaction.
Syntax
typedef struct { String Tag; String ControlNumber; int Count; String FullSegment; } TeditranslatorVDAValidatorEndTransactionEventParams; typedef void __fastcall (__closure *TeditranslatorVDAValidatorEndTransactionEvent)(System::TObject* Sender, TeditranslatorVDAValidatorEndTransactionEventParams *e); __property TeditranslatorVDAValidatorEndTransactionEvent OnEndTransaction = { read=FOnEndTransaction, write=FOnEndTransaction };
Remarks
The EndTransaction event will fire when a control segment marking the end of a transaction is read. The Tag parameter contains the tag of the segment, such as SE. ControlNumber contains the control number associated with the segment, and links this event with the corresponding StartTransaction event. Count contains the value of the count element included in the closing segment, which identifies the number of segments in a transaction set.
Error Event (VDAValidator Component)
Information about errors during data delivery.
Syntax
typedef struct { int ErrorCode; String Description; } TeditranslatorVDAValidatorErrorEventParams; typedef void __fastcall (__closure *TeditranslatorVDAValidatorErrorEvent)(System::TObject* Sender, TeditranslatorVDAValidatorErrorEventParams *e); __property TeditranslatorVDAValidatorErrorEvent OnError = { read=FOnError, write=FOnError };
Remarks
The Error event is fired in case of exceptional conditions during message processing. Normally the component raises an exception.
ErrorCode contains an error code and Description contains a textual description of the error. For a list of valid error codes and their descriptions, please refer to the Error Codes section.
The Error event is fired in case of exceptional conditions during message processing. Normally the component raises an exception.
ErrorCode contains an error code and Description contains a textual description of the error. For a list of valid error codes and their descriptions, please refer to the Error Codes section.
ResolveSchema Event (VDAValidator Component)
Fires whenever a new transaction set is encountered and no schema is found for it.
Syntax
typedef struct { String TransactionCode; String StandardVersion; } TeditranslatorVDAValidatorResolveSchemaEventParams; typedef void __fastcall (__closure *TeditranslatorVDAValidatorResolveSchemaEvent)(System::TObject* Sender, TeditranslatorVDAValidatorResolveSchemaEventParams *e); __property TeditranslatorVDAValidatorResolveSchemaEvent OnResolveSchema = { read=FOnResolveSchema, write=FOnResolveSchema };
Remarks
The ResolveSchema event will fire when a the component encounters the header segment of a new transaction set, but it finds no schema corresponding to it already loaded.
TransactionCode contains the code of the transaction, such as "810" or "APERAK".
StandardVersion contains the version of the transaction, such as "004010" or "D95A".
When processing this event, the caller can use LoadSchema() to load a new schema into the component that can be used to parse the transaction.
After the event fires, if the component still doesn't have a matching schema, then it will attempt schema-less parsing of the transaction set.
Segment Event (VDAValidator Component)
Fires whenever a data segment in a transaction set is read.
Syntax
typedef struct { String Tag; String Name; String LoopName; String FullSegment; } TeditranslatorVDAValidatorSegmentEventParams; typedef void __fastcall (__closure *TeditranslatorVDAValidatorSegmentEvent)(System::TObject* Sender, TeditranslatorVDAValidatorSegmentEventParams *e); __property TeditranslatorVDAValidatorSegmentEvent OnSegment = { read=FOnSegment, write=FOnSegment };
Remarks
The Segment event will fire when a data segment is read. The Tag parameter contains the tag of the segment. Name contains the name of the segment as defined in the associated transaction set schema. LoopName contains the name of the loop or group this segment is present in (such as N1Loop1).
StartFunctionalGroup Event (VDAValidator Component)
Fires whenever a control segment is read that marks the start of a functional group.
Syntax
typedef struct { String Tag; String ControlNumber; String FullSegment; } TeditranslatorVDAValidatorStartFunctionalGroupEventParams; typedef void __fastcall (__closure *TeditranslatorVDAValidatorStartFunctionalGroupEvent)(System::TObject* Sender, TeditranslatorVDAValidatorStartFunctionalGroupEventParams *e); __property TeditranslatorVDAValidatorStartFunctionalGroupEvent OnStartFunctionalGroup = { read=FOnStartFunctionalGroup, write=FOnStartFunctionalGroup };
Remarks
The StartFunctionalGroup event will fire when a control segment marking the start of a functional group structure is read. The Tag parameter contains the tag of the segment, such as GS. ControlNumber contains the control number associated with the segment.
StartInterchange Event (VDAValidator Component)
Fires whenever a control segment is read that marks the start of an interchange.
Syntax
typedef struct { String Tag; String ControlNumber; String FullSegment; } TeditranslatorVDAValidatorStartInterchangeEventParams; typedef void __fastcall (__closure *TeditranslatorVDAValidatorStartInterchangeEvent)(System::TObject* Sender, TeditranslatorVDAValidatorStartInterchangeEventParams *e); __property TeditranslatorVDAValidatorStartInterchangeEvent OnStartInterchange = { read=FOnStartInterchange, write=FOnStartInterchange };
Remarks
The StartInterchange event will fire when a control segment marking the start of an interchange structure is read. The Tag parameter contains the tag of the segment, such as ISA. ControlNumber contains the control number associated with the segment.
StartLoop Event (VDAValidator Component)
Fires when the starting of a loop is detected in a transaction set.
Syntax
typedef struct { String Name; } TeditranslatorVDAValidatorStartLoopEventParams; typedef void __fastcall (__closure *TeditranslatorVDAValidatorStartLoopEvent)(System::TObject* Sender, TeditranslatorVDAValidatorStartLoopEventParams *e); __property TeditranslatorVDAValidatorStartLoopEvent OnStartLoop = { read=FOnStartLoop, write=FOnStartLoop };
Remarks
The StartLoop event will fire when the tag of a loop trigger segment is read. The Name parameter contains the schema-provided name of the loop, such as "N1Loop1".
StartTransaction Event (VDAValidator Component)
Fires whenever a control segment is read that marks the start of a transaction.
Syntax
typedef struct { String Tag; String ControlNumber; String Code; String FullSegment; } TeditranslatorVDAValidatorStartTransactionEventParams; typedef void __fastcall (__closure *TeditranslatorVDAValidatorStartTransactionEvent)(System::TObject* Sender, TeditranslatorVDAValidatorStartTransactionEventParams *e); __property TeditranslatorVDAValidatorStartTransactionEvent OnStartTransaction = { read=FOnStartTransaction, write=FOnStartTransaction };
Remarks
The StartTransaction event will fire when a control segment marking the start of a transaction is read. The Tag parameter contains the tag of the segment, such as ST. ControlNumber contains the control number associated with the segment. Code contains the transaction code (such as 810).
ValidationError Event (VDAValidator Component)
Fires whenever a validation error is encountered.
Syntax
typedef struct { int ErrorCode; String Message; int SegmentNumber; String SegmentTag; String TechnicalErrorCode; String SegmentErrorCode; String ElementErrorCode; int ElementPosition; int Line; int Column; } TeditranslatorVDAValidatorValidationErrorEventParams; typedef void __fastcall (__closure *TeditranslatorVDAValidatorValidationErrorEvent)(System::TObject* Sender, TeditranslatorVDAValidatorValidationErrorEventParams *e); __property TeditranslatorVDAValidatorValidationErrorEvent OnValidationError = { read=FOnValidationError, write=FOnValidationError };
Remarks
This event will fire with errors as the EDI document is validated. The ErrorCode parameter contains the type of error encountered. Message is a textual description of the problem. SegmentNumber is the index of the segment where the problem was found. SegmentTag holds the tag name of the segment. ElementPosition is the position of the element where the error occurred.
The Line and Column parameters identify the location within the EDI document where the error occurred.
Possible ErrorCode values are:
0 | The component is not required but is present. |
1 | Invalid segment count. |
2 | Invalid transaction count. |
3 | Invalid group count. |
4 | Invalid interchange control number. |
5 | Invalid group control number. |
6 | Invalid transaction control number. |
10 | A required data element is missing. |
11 | Invalid field length. |
12 | Invalid field value. |
13 | A required component is missing. |
14 | The data element is not defined but is present. |
30 | Required segment is missing. |
31 | Required loop is missing. |
32 | Occurrences exceeds the schema defined limit. |
33 | Occurrences is less than the schema defined minimum. |
40 | Paired rule validation failed, the pair of elements must be present. |
41 | At least one of element is required, see message for list of elements. |
42 | Exclusion validation failed, only one of the elements can be present. |
43 | Conditional rule validation failed. |
44 | List conditional rule validation failed. |
45 | First then none validation failed. The presence of an element requires that other specific elements must not be present. |
46 | Only one or none of the elements can be present. |
X12 Specific Parameters
The following parameters are available in all validator components but are only applicable to X12 document validation at this time.
SegmentErrorCode holds the error code that may be used in the IK304 field of a 999. ElementErrorCode holds the error code that may be used in the IK403 field of a 999.
TechnicalErrorCode holds a technical error code that helps identify structural issues with the document. For instance when parsing an X12 document this will hold values that may be used for TA1 error codes. When parsing X12 documents the following codes are applicable:
001 | The Interchange Control Numbers in the header ISA 13 and trailer IEA02 do not match. |
014 | Invalid interchange date value (non-numeric characters or wrong length). |
015 | Invalid interchange time value (non-numeric characters or wrong length). |
022 | The ISA segment is missing elements (invalid control structure). |
024 | Invalid interchange content (e.g., Invalid GS segment). |
Config Settings (VDAValidator Component)
The component accepts one or more of the following configuration settings. Configuration settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the component, access to these internal properties is provided through the Config method.X12Validator Config Settings | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
ComponentDelimiter:
The delimiter separating components.After parsing an EDI document, this configuration option will return the delimiter used to separate components within data elements of the EDI document.
This configuration option may be set in the StartInterchange event to specify the delimiter to be used. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
CrossFieldValidationEnabled:
Enables cross-field validation rules.If true (default), cross-field validation rules present in the document schema will be checked.
Note, Bots Schema Files do not support syntax rules, therefore CrossFieldValidation rules will never execute for these schemas. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
EDIStandard:
The document format.This property specifies standard that the document follows. Possible values are:
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
ElementDelimiter:
The delimiter character separating data elements.After parsing an EDI document, this configuration option will return the delimiter used to separate data elements within segments of the EDI document.
This configuration option may be set in the StartInterchange event to specify the delimiter to be used. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Encoding: The character encoding to be applied when reading and writing data.If the data contains non-ASCII characters this setting should be specified so characters are properly preserved. This value should be set to a valid character set such as "UTF-8" or "ISO-8859-1". | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
ExtraData: Extra data that has not been parsed by the component.This setting will only be populated after the Flush method has been called and data exists in the internal parser which has not been processed. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
HasXPath:
Determines if the specified XPath exists.This setting can be used to query if an XPath exists before setting XPath. For instance:
Console.WriteLine(edireader.Config("HasXPath=IX/FG/TX/IT1Loop1/[2]"));
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
MaxValidationErrors: The maximum number of errors to save in the ValidationErrors property.This setting specifies the maximum number of errors that will be kept in the ValidationErrors property. Once this limit is exceeded the ValidationError event will continue to fire but details will not be saved in the ValidationErrors property. The default value is 200. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
ReleaseChar:
The character used to escape delimiters within values.After parsing an EDI document, this configuration option will return the escape character used to escape delimiters within values within the EDI document.
This configuration option may be set in the StartInterchange event to specify the escape character to be used. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
ResolveXPathOnSet:
Determines whether or not the XPath is resolved when set.When true, the component will fully resolve a detailed path when XPath is specified. In this case, the XPath property will contain the XSegment s name as well as the indices when queried after being set.
If this value is set to false, the exact string will be returned when the XPath property is queried from the last time it was set. For example, the following code will print the string "/[1]/[1]/[1]/[10]"
when this value is false, and would print "/IX[1]/FG[1]/TX[1]/IT1Loop1[4]" when this value is true:
In another example, the following code sample will print "IX/FG/TX/IT1Loop1"
when false and would print "/IX[1]/FG[1]/TX[1]/IT1Loop1[1]" when true:
This is useful in cases where the full XPath including indices is needed for future processing. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
SegmentDelimiter:
The delimiter character separating segments within the EDI document.After parsing an EDI document, this configuration option will return the delimiter used to separate segments within the EDI document.
This configuration option may be set in the StartInterchange event to specify the delimiter to be used. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
StrictSchemaValidation:
Specifies the behavior during schema validation.This setting specifies what happens when performing schema validation and a validation
warning occurs. By default this value is set to 1 (Warn) and the Warning event will fire, but processing
will not stop. See the WarnCode parameter list in the Warning event for details about
possible validation warnings. Possible values for this setting are:
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Base Config Settings | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
BuildInfo: Information about the product's build.When queried, this setting will return a string containing information about the product's build. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
CodePage:
The system code page used for Unicode to Multibyte translations.The default code page is Unicode UTF-8 (65001).
The following is a list of valid code page identifiers:
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
LicenseInfo:
Information about the current license.When queried, this setting will return a string containing information about the license this instance of a component is using. It will return the following information:
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
MaskSensitive:
Whether sensitive data is masked in log messages.In certain circumstances it may be beneficial to mask sensitive data, like passwords, in log messages. Set this to true to mask sensitive data. The default is false.
This setting only works on these components: AS3Receiver, AS3Sender, Atom, Client(3DS), FTP, FTPServer, IMAP, OFTPClient, SSHClient, SCP, Server(3DS), Sexec, SFTP, SFTPServer, SSHServer, TCPClient, TCPServer. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
UseFIPSCompliantAPI:
Tells the component whether or not to use FIPS certified APIs.When set to true, the component will utilize the underlying operating system's certified APIs. Java editions, regardless of OS, utilize Bouncy Castle FIPS, while all the other Windows editions make use of Microsoft security libraries.
FIPS mode can be enabled by setting the UseFIPSCompliantAPI configuration setting to true. This is a static setting which applies to all instances of all components of the toolkit within the process. It is recommended to enable or disable this setting once before the component has been used to establish a connection. Enabling FIPS while an instance of the component is active and connected may result in unexpected behavior. For more details please see the FIPS 140-2 Compliance article. Note: This setting is only applicable on Windows. Note: Enabling FIPS-compliance requires a special license; please contact sales@nsoftware.com for details. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
UseInternalSecurityAPI:
Tells the component whether or not to use the system security libraries or an internal implementation.
When set to false, the component will use the system security libraries by default to perform cryptographic functions where applicable.
Setting this setting to true tells the component to use the internal implementation instead of using the system security libraries. This setting is set to false by default on all platforms. |
Trappable Errors (VDAValidator Component)
X12Validator Errors
1000 Input/Output error | |
1001 No stream or file name were specified for the component | |
1002 Unexpected end of file (EOF). | |
1003 Segment not found. | |
1004 Segment not found in schema. | |
1005 Schema not found. | |
1010 Invalid Writer state. | |
1011 Segment does not have the specified element or component. | |
1012 Invalid XPath. | |
1013 DOM tree unavailable (set BuildDOM and reparse). | |
1014 Document contains incomplete segments. | |
1015 Document contains an open EDI structure (interchange, functional group or transaction) with no matching footer segment. | |
1044 Error while reading schema file. | |
1100 Component is busy. | |
1099 Unexpected error. |