TRADACOMSValidator Class
Properties Methods Events Config Settings Errors
TRADACOMSValidator is a lightweight EDI validation class designed for simple document validation.
Class Name
IPWorksEDI_TRADACOMSValidator
Procedural Interface
ipworksedi_tradacomsvalidator_open(); ipworksedi_tradacomsvalidator_close($res); ipworksedi_tradacomsvalidator_register_callback($res, $id, $function); ipworksedi_tradacomsvalidator_get_last_error($res); ipworksedi_tradacomsvalidator_get_last_error_code($res); ipworksedi_tradacomsvalidator_set($res, $id, $index, $value); ipworksedi_tradacomsvalidator_get($res, $id, $index); ipworksedi_tradacomsvalidator_do_compileschema($res, $xsdschema, $binschema); ipworksedi_tradacomsvalidator_do_config($res, $configurationstring); ipworksedi_tradacomsvalidator_do_displayschemainfo($res); ipworksedi_tradacomsvalidator_do_displayxmlinfo($res); ipworksedi_tradacomsvalidator_do_flush($res); ipworksedi_tradacomsvalidator_do_loadschema($res, $filename); ipworksedi_tradacomsvalidator_do_reset($res); ipworksedi_tradacomsvalidator_do_validate($res);
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 class depends largely on the schema's definition.
When the Validate method is called the class 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 class 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 class 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 class 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 | Fired when information is available 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 class with short descriptions. Click on the links for further details.
ComponentDelimiter | The delimiter separating classes. |
CrossFieldValidationEnabled | Enables cross-field validation rules. |
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 class. |
HasXPath | Determines if the specified XPath exists. |
ISA11IsRepetitionSeparator | Specifies whether the ISA11 value is treated as a Repetition Separator or Standard Identifier. |
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. |
ProcessIdleEvents | Whether the class uses its internal event loop to process events when the main thread is idle. |
SelectWaitMillis | The length of time in milliseconds the class will wait when DoEvents is called if there are no events to process. |
UseFIPSCompliantAPI | Tells the class whether or not to use FIPS certified APIs. |
UseInternalSecurityAPI | Whether or not to use the system security libraries or an internal implementation. |
EDIStandardVersion Property (IPWorksEDI_TRADACOMSValidator Class)
The version of the EDI specification.
Object Oriented Interface
public function getEDIStandardVersion();
Procedural Interface
ipworksedi_tradacomsvalidator_get($res, 1 );
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 (IPWorksEDI_TRADACOMSValidator Class)
The data to parse.
Object Oriented Interface
public function getInputData(); public function setInputData($value);
Procedural Interface
ipworksedi_tradacomsvalidator_get($res, 2 ); ipworksedi_tradacomsvalidator_set($res, 2, $value );
Default Value
''
Remarks
This property specifies the data to be parsed.
Input Properties
The class 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 (IPWorksEDI_TRADACOMSValidator Class)
The file to parse.
Object Oriented Interface
public function getInputFile(); public function setInputFile($value);
Procedural Interface
ipworksedi_tradacomsvalidator_get($res, 3 ); ipworksedi_tradacomsvalidator_set($res, 3, $value );
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 class 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 (IPWorksEDI_TRADACOMSValidator Class)
The format of the schema file.
Object Oriented Interface
public function getSchemaFormat(); public function setSchemaFormat($value);
Procedural Interface
ipworksedi_tradacomsvalidator_get($res, 4 ); ipworksedi_tradacomsvalidator_set($res, 4, $value );
Default Value
0
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) | JSON |
Data Type
Integer
ValidationErrorCount Property (IPWorksEDI_TRADACOMSValidator Class)
The number of records in the ValidationError arrays.
Object Oriented Interface
public function getValidationErrorCount();
Procedural Interface
ipworksedi_tradacomsvalidator_get($res, 5 );
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 (IPWorksEDI_TRADACOMSValidator Class)
The column number in the EDI document where the error occurred.
Object Oriented Interface
public function getValidationErrorColumn($validationerrorindex);
Procedural Interface
ipworksedi_tradacomsvalidator_get($res, 6 , $validationerrorindex);
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 (IPWorksEDI_TRADACOMSValidator Class)
The error code which may be used in the IK403 property of a 999.
Object Oriented Interface
public function getValidationErrorElementErrorCode($validationerrorindex);
Procedural Interface
ipworksedi_tradacomsvalidator_get($res, 7 , $validationerrorindex);
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 (IPWorksEDI_TRADACOMSValidator Class)
This property holds the position of the element where the error occurred.
Object Oriented Interface
public function getValidationErrorElementPosition($validationerrorindex);
Procedural Interface
ipworksedi_tradacomsvalidator_get($res, 8 , $validationerrorindex);
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 (IPWorksEDI_TRADACOMSValidator Class)
The ErrorCode property contains the type of error encountered.
Object Oriented Interface
public function getValidationErrorErrorCode($validationerrorindex);
Procedural Interface
ipworksedi_tradacomsvalidator_get($res, 9 , $validationerrorindex);
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 (IPWorksEDI_TRADACOMSValidator Class)
The line number in the EDI document where the error occurred.
Object Oriented Interface
public function getValidationErrorLine($validationerrorindex);
Procedural Interface
ipworksedi_tradacomsvalidator_get($res, 10 , $validationerrorindex);
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 (IPWorksEDI_TRADACOMSValidator Class)
Message is a textual description of the error.
Object Oriented Interface
public function getValidationErrorMessage($validationerrorindex);
Procedural Interface
ipworksedi_tradacomsvalidator_get($res, 11 , $validationerrorindex);
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 (IPWorksEDI_TRADACOMSValidator Class)
The error code which may be used in the IK304 property of a 999.
Object Oriented Interface
public function getValidationErrorSegmentErrorCode($validationerrorindex);
Procedural Interface
ipworksedi_tradacomsvalidator_get($res, 12 , $validationerrorindex);
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 (IPWorksEDI_TRADACOMSValidator Class)
This property is the index of the segment where the error occurred.
Object Oriented Interface
public function getValidationErrorSegmentNumber($validationerrorindex);
Procedural Interface
ipworksedi_tradacomsvalidator_get($res, 13 , $validationerrorindex);
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 (IPWorksEDI_TRADACOMSValidator Class)
This property specifies the tag name of the segment where the error occurred.
Object Oriented Interface
public function getValidationErrorSegmentTag($validationerrorindex);
Procedural Interface
ipworksedi_tradacomsvalidator_get($res, 14 , $validationerrorindex);
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 (IPWorksEDI_TRADACOMSValidator Class)
This property holds a technical error code that helps identify structural issues with the document.
Object Oriented Interface
public function getValidationErrorTechnicalErrorCode($validationerrorindex);
Procedural Interface
ipworksedi_tradacomsvalidator_get($res, 15 , $validationerrorindex);
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 (IPWorksEDI_TRADACOMSValidator Class)
Compiles an existing XSD schema into an optimized binary representation.
Object Oriented Interface
public function doCompileSchema($xsdschema, $binschema);
Procedural Interface
ipworksedi_tradacomsvalidator_do_compileschema($res, $xsdschema, $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 (IPWorksEDI_TRADACOMSValidator Class)
Sets or retrieves a configuration setting.
Object Oriented Interface
public function doConfig($configurationstring);
Procedural Interface
ipworksedi_tradacomsvalidator_do_config($res, $configurationstring);
Remarks
Config is a generic method available in every class. It is used to set and retrieve configuration settings for the class.
These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, 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 (IPWorksEDI_TRADACOMSValidator Class)
Returns a string showing the structure of the schema defining the document.
Object Oriented Interface
public function doDisplaySchemaInfo();
Procedural Interface
ipworksedi_tradacomsvalidator_do_displayschemainfo($res);
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:
ST[0,1] BIG[0,1] NTE[0,100] CUR[0,1] REF[0,12] YNQ[0,10] PER[0,3] N1Loop1[0,200] N1[0,1] N2[0,2] N3[0,2] N4[0,1] REF_2[0,12] PER_2[0,3] DMG[0,1] ITD[0,999999] DTM[0,10] FOB[0,1] PID[0,200] MEA[0,40] PWK[0,25] PKG[0,25] L7[0,1] BAL[0,999999] INC[0,1] PAM[0,999999] LMLoop1[0,10] LM[0,1] LQ[0,100] N9Loop1[0,1] N9[0,1] MSG[0,10] V1Loop1[0,999999] V1[0,1] R4[0,999999] DTM_2[0,999999] FA1Loop1[0,999999] FA1[0,1] FA2[0,999999] IT1Loop1[0,200000] IT1[0,1] CRC[0,1] QTY[0,5] CUR_2[0,1] IT3[0,5] TXI[0,10] CTP[0,25] PAM_2[0,10] MEA_2[0,40] PIDLoop1[0,1000] PID_2[0,1] MEA_3[0,10] PWK_2[0,25] PKG_2[0,25] PO4[0,1] ITD_2[0,2] REF_3[0,999999] YNQ_2[0,10] PER_3[0,5] SDQ[0,500] DTM_3[0,10] CAD[0,999999] L7_2[0,999999] SR[0,1] SACLoop1[0,25] SAC[0,1] TXI_2[0,10] SLNLoop1[0,1000] SLN[0,1] DTM_4[0,1] REF_4[0,999999] PID_3[0,1000] SAC_2[0,25] TC2[0,2] TXI_3[0,10] N1Loop2[0,200] N1_2[0,1] N2_2[0,2] N3_2[0,2] N4_2[0,1] REF_5[0,12] PER_4[0,3] DMG_2[0,1] LMLoop2[0,10] LM_2[0,1] LQ_2[0,100] V1Loop2[0,999999] V1_2[0,1] R4_2[0,999999] DTM_5[0,999999] FA1Loop2[0,999999] FA1_2[0,1] FA2_2[0,999999] TDS[0,1] TXI_4[0,10] CAD_2[0,1] AMT[0,999999] SACLoop2[0,25] SAC_3[0,1] TXI_5[0,10] ISSLoop1[0,999999] ISS[0,1] PID_4[0,1] CTT[0,1] SE[0,1]
DisplayXMLInfo Method (IPWorksEDI_TRADACOMSValidator Class)
Returns a string showing the structure of the parsed document as XML.
Object Oriented Interface
public function doDisplayXMLInfo();
Procedural Interface
ipworksedi_tradacomsvalidator_do_displayxmlinfo($res);
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="ISA" ISA01="00" ISA02=" " ISA03="00" ISA04=" " ISA05="ZZ" ISA06="ACME " ISA07="ZZ" ISA08="WAYNE_TECH " ISA09="160707" ISA10="1544" ISA11="U" ISA12="00401" ISA13="000000006" ISA14="0" ISA15="T" ISA16=">"> <FG tag="GS" GS01="IN" GS02="ACME" GS03="WAYNE_TECH" GS04="20160707" GS05="1544" GS06="6" GS07="T" GS08="004010"> <TX tag="ST" ST01="810" ST02="0001"> <BIG tag="BIG" BIG01="20150708" BIG02="3003014445" BIG03="" BIG04="0476553272" BIG05="" BIG06="" BIG07="DR"/> <CUR tag="CUR" CUR01="SE" CUR02="USD"/> <REF tag="REF" REF01="8M" REF02="0056"/> <N1Loop1> <N1 tag="N1" N101="BY" N102="Company" N103="92" N104="544380"/> <N3 tag="N3" N301="Address"/> <N4 tag="N4" N401="City" N402="CA" N403="Postal Code"/> </N1Loop1> <N1Loop1> <N1 tag="N1" N101="ST" N102="Name" N103="92" N104="0607047800010"/> <N3 tag="N3" N301="Address"/> <N4 tag="N4" N401="City" N402="" N403="200131" N404="US"/> </N1Loop1> <N1Loop1> <N1 tag="N1" N101="RE" N102="Name" N103="92" N104="5095956"/> <N3 tag="N3" N301="Address"/> <N4 tag="N4" N401="City" N402="IL" N403="Postal Code"/> </N1Loop1> <IT1Loop1> <IT1 tag="IT1" IT101="20" IT102="2500" IT103="EA" IT104="36.96" IT105="" IT106="BP" IT107="335S0594"/> <REF_3 tag="REF" REF01="KK" REF02="0099778154"/> <REF_3 tag="REF" REF01="PO" REF02="0476553272" REF03="20"/> </IT1Loop1> <TDS tag="TDS" TDS01="9240000"/> <CTT tag="CTT" CTT01="1"/> </TX> </FG> </IX>
Flush Method (IPWorksEDI_TRADACOMSValidator Class)
Flushes the parser and checks its end state.
Object Oriented Interface
public function doFlush();
Procedural Interface
ipworksedi_tradacomsvalidator_do_flush($res);
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 (IPWorksEDI_TRADACOMSValidator Class)
Loads a schema file describing a Transaction Set.
Object Oriented Interface
public function doLoadSchema($filename);
Procedural Interface
ipworksedi_tradacomsvalidator_do_loadschema($res, $filename);
Remarks
This method parses the File and loads it into an internal schema list. The class will attempt to automatically detect the SchemaFormat.
If the schema file does not exist or cannot be parsed as an EDI schema, the class fails with an error.
Reset Method (IPWorksEDI_TRADACOMSValidator Class)
Resets the parser.
Object Oriented Interface
public function doReset();
Procedural Interface
ipworksedi_tradacomsvalidator_do_reset($res);
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 (IPWorksEDI_TRADACOMSValidator Class)
Validates the specified EDI document.
Object Oriented Interface
public function doValidate();
Procedural Interface
ipworksedi_tradacomsvalidator_do_validate($res);
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 class depends largely on the schema's definition.
When the Validate method is called the class 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 (IPWorksEDI_TRADACOMSValidator Class)
Fires whenever a control segment is read that marks the end of an interchange.
Object Oriented Interface
public function fireEndFunctionalGroup($param);
Procedural Interface
ipworksedi_tradacomsvalidator_register_callback($res, 1, array($this, 'fireEndFunctionalGroup'));
Parameter List
'tag'
'controlnumber'
'count'
'fullsegment'
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 (IPWorksEDI_TRADACOMSValidator Class)
Fires whenever a control segment is read that marks the end of an interchange.
Object Oriented Interface
public function fireEndInterchange($param);
Procedural Interface
ipworksedi_tradacomsvalidator_register_callback($res, 2, array($this, 'fireEndInterchange'));
Parameter List
'tag'
'controlnumber'
'fullsegment'
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 (IPWorksEDI_TRADACOMSValidator Class)
Fires when the end of a loop is detected in a transaction set.
Object Oriented Interface
public function fireEndLoop($param);
Procedural Interface
ipworksedi_tradacomsvalidator_register_callback($res, 3, array($this, 'fireEndLoop'));
Parameter List
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 (IPWorksEDI_TRADACOMSValidator Class)
Fires whenever a control segment is read that marks the end of a transaction.
Object Oriented Interface
public function fireEndTransaction($param);
Procedural Interface
ipworksedi_tradacomsvalidator_register_callback($res, 4, array($this, 'fireEndTransaction'));
Parameter List
'tag'
'controlnumber'
'count'
'fullsegment'
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 (IPWorksEDI_TRADACOMSValidator Class)
Fired when information is available about errors during data delivery.
Object Oriented Interface
public function fireError($param);
Procedural Interface
ipworksedi_tradacomsvalidator_register_callback($res, 5, array($this, 'fireError'));
Parameter List
'errorcode'
'description'
Remarks
The Error event is fired in case of exceptional conditions during message processing. Normally the class fails with an error.
The ErrorCode parameter contains an error code, and the Description parameter 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 class fails with an error.
The ErrorCode parameter contains an error code, and the Description parameter 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 (IPWorksEDI_TRADACOMSValidator Class)
Fires whenever a new transaction set is encountered and no schema is found for it.
Object Oriented Interface
public function fireResolveSchema($param);
Procedural Interface
ipworksedi_tradacomsvalidator_register_callback($res, 6, array($this, 'fireResolveSchema'));
Parameter List
'transactioncode'
'standardversion'
Remarks
The ResolveSchema event will fire when a the class 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 class that can be used to parse the transaction.
After the event fires, if the class still doesn't have a matching schema, then it will attempt schema-less parsing of the transaction set.
Segment Event (IPWorksEDI_TRADACOMSValidator Class)
Fires whenever a data segment in a transaction set is read.
Object Oriented Interface
public function fireSegment($param);
Procedural Interface
ipworksedi_tradacomsvalidator_register_callback($res, 7, array($this, 'fireSegment'));
Parameter List
'tag'
'name'
'loopname'
'fullsegment'
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 (IPWorksEDI_TRADACOMSValidator Class)
Fires whenever a control segment is read that marks the start of a functional group.
Object Oriented Interface
public function fireStartFunctionalGroup($param);
Procedural Interface
ipworksedi_tradacomsvalidator_register_callback($res, 8, array($this, 'fireStartFunctionalGroup'));
Parameter List
'tag'
'controlnumber'
'fullsegment'
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 (IPWorksEDI_TRADACOMSValidator Class)
Fires whenever a control segment is read that marks the start of an interchange.
Object Oriented Interface
public function fireStartInterchange($param);
Procedural Interface
ipworksedi_tradacomsvalidator_register_callback($res, 9, array($this, 'fireStartInterchange'));
Parameter List
'tag'
'controlnumber'
'fullsegment'
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 (IPWorksEDI_TRADACOMSValidator Class)
Fires when the starting of a loop is detected in a transaction set.
Object Oriented Interface
public function fireStartLoop($param);
Procedural Interface
ipworksedi_tradacomsvalidator_register_callback($res, 10, array($this, 'fireStartLoop'));
Parameter List
'name'
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 (IPWorksEDI_TRADACOMSValidator Class)
Fires whenever a control segment is read that marks the start of a transaction.
Object Oriented Interface
public function fireStartTransaction($param);
Procedural Interface
ipworksedi_tradacomsvalidator_register_callback($res, 11, array($this, 'fireStartTransaction'));
Parameter List
'tag'
'controlnumber'
'code'
'fullsegment'
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 (IPWorksEDI_TRADACOMSValidator Class)
Fires whenever a validation error is encountered.
Object Oriented Interface
public function fireValidationError($param);
Procedural Interface
ipworksedi_tradacomsvalidator_register_callback($res, 12, array($this, 'fireValidationError'));
Parameter List
'errorcode'
'message'
'segmentnumber'
'segmenttag'
'technicalerrorcode'
'segmenterrorcode'
'elementerrorcode'
'elementposition'
'line'
'column'
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 classes 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 (TRADACOMSValidator Class)
The class 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 class, access to these internal properties is provided through the Config method.TRADACOMSValidator Config Settings
This configuration option may be set in the StartInterchange event to specify the delimiter to be used.
Note, Bots Schema Files do not support syntax rules, therefore CrossFieldValidation rules will never execute for these schemas.
This configuration option may be set in the StartInterchange event to specify the delimiter to be used.
Console.WriteLine(edireader.Config("HasXPath=IX/FG/TX/IT1Loop1/[2]"));
This configuration option may be set in the StartInterchange event to specify the escape character to be used.
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:
reader.XPath = "/[1]/[1]/[1]/[10]";
Console.WriteLine(reader.XPath);
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:
reader.XPath = "IX/FG/TX/IT1Loop1";
Console.WriteLine(reader.XPath);
This is useful in cases where the full XPath including indices is needed for future processing.
This configuration option may be set in the StartInterchange event to specify the delimiter to be used.
0 (Ignore) | All validation warnings will be ignored. Warning will not fire with warnings. |
1 (Warn - default) | The Warning event will fire with all validation warnings. |
2 (Error) | All validation warnings are treated as errors and will cause an exception. Processing will stop immediately. |
Base Config Settings
The following is a list of valid code page identifiers:
Identifier | Name |
037 | IBM EBCDIC - U.S./Canada |
437 | OEM - United States |
500 | IBM EBCDIC - International |
708 | Arabic - ASMO 708 |
709 | Arabic - ASMO 449+, BCON V4 |
710 | Arabic - Transparent Arabic |
720 | Arabic - Transparent ASMO |
737 | OEM - Greek (formerly 437G) |
775 | OEM - Baltic |
850 | OEM - Multilingual Latin I |
852 | OEM - Latin II |
855 | OEM - Cyrillic (primarily Russian) |
857 | OEM - Turkish |
858 | OEM - Multilingual Latin I + Euro symbol |
860 | OEM - Portuguese |
861 | OEM - Icelandic |
862 | OEM - Hebrew |
863 | OEM - Canadian-French |
864 | OEM - Arabic |
865 | OEM - Nordic |
866 | OEM - Russian |
869 | OEM - Modern Greek |
870 | IBM EBCDIC - Multilingual/ROECE (Latin-2) |
874 | ANSI/OEM - Thai (same as 28605, ISO 8859-15) |
875 | IBM EBCDIC - Modern Greek |
932 | ANSI/OEM - Japanese, Shift-JIS |
936 | ANSI/OEM - Simplified Chinese (PRC, Singapore) |
949 | ANSI/OEM - Korean (Unified Hangul Code) |
950 | ANSI/OEM - Traditional Chinese (Taiwan; Hong Kong SAR, PRC) |
1026 | IBM EBCDIC - Turkish (Latin-5) |
1047 | IBM EBCDIC - Latin 1/Open System |
1140 | IBM EBCDIC - U.S./Canada (037 + Euro symbol) |
1141 | IBM EBCDIC - Germany (20273 + Euro symbol) |
1142 | IBM EBCDIC - Denmark/Norway (20277 + Euro symbol) |
1143 | IBM EBCDIC - Finland/Sweden (20278 + Euro symbol) |
1144 | IBM EBCDIC - Italy (20280 + Euro symbol) |
1145 | IBM EBCDIC - Latin America/Spain (20284 + Euro symbol) |
1146 | IBM EBCDIC - United Kingdom (20285 + Euro symbol) |
1147 | IBM EBCDIC - France (20297 + Euro symbol) |
1148 | IBM EBCDIC - International (500 + Euro symbol) |
1149 | IBM EBCDIC - Icelandic (20871 + Euro symbol) |
1200 | Unicode UCS-2 Little-Endian (BMP of ISO 10646) |
1201 | Unicode UCS-2 Big-Endian |
1250 | ANSI - Central European |
1251 | ANSI - Cyrillic |
1252 | ANSI - Latin I |
1253 | ANSI - Greek |
1254 | ANSI - Turkish |
1255 | ANSI - Hebrew |
1256 | ANSI - Arabic |
1257 | ANSI - Baltic |
1258 | ANSI/OEM - Vietnamese |
1361 | Korean (Johab) |
10000 | MAC - Roman |
10001 | MAC - Japanese |
10002 | MAC - Traditional Chinese (Big5) |
10003 | MAC - Korean |
10004 | MAC - Arabic |
10005 | MAC - Hebrew |
10006 | MAC - Greek I |
10007 | MAC - Cyrillic |
10008 | MAC - Simplified Chinese (GB 2312) |
10010 | MAC - Romania |
10017 | MAC - Ukraine |
10021 | MAC - Thai |
10029 | MAC - Latin II |
10079 | MAC - Icelandic |
10081 | MAC - Turkish |
10082 | MAC - Croatia |
12000 | Unicode UCS-4 Little-Endian |
12001 | Unicode UCS-4 Big-Endian |
20000 | CNS - Taiwan |
20001 | TCA - Taiwan |
20002 | Eten - Taiwan |
20003 | IBM5550 - Taiwan |
20004 | TeleText - Taiwan |
20005 | Wang - Taiwan |
20105 | IA5 IRV International Alphabet No. 5 (7-bit) |
20106 | IA5 German (7-bit) |
20107 | IA5 Swedish (7-bit) |
20108 | IA5 Norwegian (7-bit) |
20127 | US-ASCII (7-bit) |
20261 | T.61 |
20269 | ISO 6937 Non-Spacing Accent |
20273 | IBM EBCDIC - Germany |
20277 | IBM EBCDIC - Denmark/Norway |
20278 | IBM EBCDIC - Finland/Sweden |
20280 | IBM EBCDIC - Italy |
20284 | IBM EBCDIC - Latin America/Spain |
20285 | IBM EBCDIC - United Kingdom |
20290 | IBM EBCDIC - Japanese Katakana Extended |
20297 | IBM EBCDIC - France |
20420 | IBM EBCDIC - Arabic |
20423 | IBM EBCDIC - Greek |
20424 | IBM EBCDIC - Hebrew |
20833 | IBM EBCDIC - Korean Extended |
20838 | IBM EBCDIC - Thai |
20866 | Russian - KOI8-R |
20871 | IBM EBCDIC - Icelandic |
20880 | IBM EBCDIC - Cyrillic (Russian) |
20905 | IBM EBCDIC - Turkish |
20924 | IBM EBCDIC - Latin-1/Open System (1047 + Euro symbol) |
20932 | JIS X 0208-1990 & 0121-1990 |
20936 | Simplified Chinese (GB2312) |
21025 | IBM EBCDIC - Cyrillic (Serbian, Bulgarian) |
21027 | Extended Alpha Lowercase |
21866 | Ukrainian (KOI8-U) |
28591 | ISO 8859-1 Latin I |
28592 | ISO 8859-2 Central Europe |
28593 | ISO 8859-3 Latin 3 |
28594 | ISO 8859-4 Baltic |
28595 | ISO 8859-5 Cyrillic |
28596 | ISO 8859-6 Arabic |
28597 | ISO 8859-7 Greek |
28598 | ISO 8859-8 Hebrew |
28599 | ISO 8859-9 Latin 5 |
28605 | ISO 8859-15 Latin 9 |
29001 | Europa 3 |
38598 | ISO 8859-8 Hebrew |
50220 | ISO 2022 Japanese with no halfwidth Katakana |
50221 | ISO 2022 Japanese with halfwidth Katakana |
50222 | ISO 2022 Japanese JIS X 0201-1989 |
50225 | ISO 2022 Korean |
50227 | ISO 2022 Simplified Chinese |
50229 | ISO 2022 Traditional Chinese |
50930 | Japanese (Katakana) Extended |
50931 | US/Canada and Japanese |
50933 | Korean Extended and Korean |
50935 | Simplified Chinese Extended and Simplified Chinese |
50936 | Simplified Chinese |
50937 | US/Canada and Traditional Chinese |
50939 | Japanese (Latin) Extended and Japanese |
51932 | EUC - Japanese |
51936 | EUC - Simplified Chinese |
51949 | EUC - Korean |
51950 | EUC - Traditional Chinese |
52936 | HZ-GB2312 Simplified Chinese |
54936 | Windows XP: GB18030 Simplified Chinese (4 Byte) |
57002 | ISCII Devanagari |
57003 | ISCII Bengali |
57004 | ISCII Tamil |
57005 | ISCII Telugu |
57006 | ISCII Assamese |
57007 | ISCII Oriya |
57008 | ISCII Kannada |
57009 | ISCII Malayalam |
57010 | ISCII Gujarati |
57011 | ISCII Punjabi |
65000 | Unicode UTF-7 |
65001 | Unicode UTF-8 |
Identifier | Name |
1 | ASCII |
2 | NEXTSTEP |
3 | JapaneseEUC |
4 | UTF8 |
5 | ISOLatin1 |
6 | Symbol |
7 | NonLossyASCII |
8 | ShiftJIS |
9 | ISOLatin2 |
10 | Unicode |
11 | WindowsCP1251 |
12 | WindowsCP1252 |
13 | WindowsCP1253 |
14 | WindowsCP1254 |
15 | WindowsCP1250 |
21 | ISO2022JP |
30 | MacOSRoman |
10 | UTF16String |
0x90000100 | UTF16BigEndian |
0x94000100 | UTF16LittleEndian |
0x8c000100 | UTF32String |
0x98000100 | UTF32BigEndian |
0x9c000100 | UTF32LittleEndian |
65536 | Proprietary |
- Product: The product the license is for.
- Product Key: The key the license was generated from.
- License Source: Where the license was found (e.g., RuntimeLicense, License File).
- License Type: The type of license installed (e.g., Royalty Free, Single Server).
- Last Valid Build: The last valid build number for which the license will work.
This setting only works on these classes: AS3Receiver, AS3Sender, Atom, Client(3DS), FTP, FTPServer, IMAP, OFTPClient, SSHClient, SCP, Server(3DS), Sexec, SFTP, SFTPServer, SSHServer, TCPClient, TCPServer.
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 classes 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.
Setting this configuration setting to true tells the class to use the internal implementation instead of using the system security libraries.
On Windows, this setting is set to false by default. On Linux/macOS, this setting is set to true by default.
To use the system security libraries for Linux, OpenSSL support must be enabled. For more information on how to enable OpenSSL, please refer to the OpenSSL Notes section.
Trappable Errors (TRADACOMSValidator Class)
TRADACOMSValidator 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. |