TRADACOMSValidator Class

Properties   Methods   Events   Config Settings   Errors  

TRADACOMSValidator is a lightweight EDI validation class designed for simple document validation.

Syntax

class ipworkseditranslator.TRADACOMSValidator

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 schema_format and call load_schema 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 on_validation_error event will fire with details about each error as it is encountered. After the document has been validated the validation_errors property will be populated with details of each error.

Inspect the validation_errors 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.

edi_standard_versionThe version of the EDI specification.
input_dataThe data to parse.
input_fileThe file to parse.
schema_formatThe format of the schema file.
validation_error_countThe number of records in the ValidationError arrays.
validation_error_columnThe column number in the EDI document where the error occurred.
validation_error_element_error_codeThe error code which may be used in the IK403 property of a 999.
validation_error_element_positionThis property holds the position of the element where the error occurred.
validation_error_error_codeThe ErrorCode property contains the type of error encountered.
validation_error_lineThe line number in the EDI document where the error occurred.
validation_error_messageMessage is a textual description of the error.
validation_error_segment_error_codeThe error code which may be used in the IK304 property of a 999.
validation_error_segment_numberThis property is the index of the segment where the error occurred.
validation_error_segment_tagThis property specifies the tag name of the segment where the error occurred.
validation_error_technical_error_codeThis 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.

compile_schemaCompiles an existing XSD schema into an optimized binary representation.
configSets or retrieves a configuration setting.
display_schema_infoReturns a string showing the structure of the schema defining the document.
display_xml_infoReturns a string showing the structure of the parsed document as XML.
flushFlushes the parser and checks its end state.
load_schemaLoads a schema file describing a Transaction Set.
resetResets the parser.
validateValidates 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.

on_end_functional_groupFires whenever a control segment is read that marks the end of an interchange.
on_end_interchangeFires whenever a control segment is read that marks the end of an interchange.
on_end_loopFires when the end of a loop is detected in a transaction set.
on_end_transactionFires whenever a control segment is read that marks the end of a transaction.
on_errorFired when information is available about errors during data delivery.
on_resolve_schemaFires whenever a new transaction set is encountered and no schema is found for it.
on_segmentFires whenever a data segment in a transaction set is read.
on_start_functional_groupFires whenever a control segment is read that marks the start of a functional group.
on_start_interchangeFires whenever a control segment is read that marks the start of an interchange.
on_start_loopFires when the starting of a loop is detected in a transaction set.
on_start_transactionFires whenever a control segment is read that marks the start of a transaction.
on_validation_errorFires 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.

ComponentDelimiterThe delimiter separating classes.
CrossFieldValidationEnabledEnables cross-field validation rules.
EDIStandardThe document format.
ElementDelimiterThe delimiter character separating data elements.
EncodingThe character encoding to be applied when reading and writing data.
ExtraDataExtra data that has not been parsed by the class.
HasXPathDetermines if the specified XPath exists.
MaxValidationErrorsThe maximum number of errors to save in the ValidationErrors property.
ReleaseCharThe character used to escape delimiters within values.
ResolveXPathOnSetDetermines whether or not the XPath is resolved when set.
SegmentDelimiterThe delimiter character separating segments within the EDI document.
StrictSchemaValidationSpecifies the behavior during schema validation.
BuildInfoInformation about the product's build.
CodePageThe system code page used for Unicode to Multibyte translations.
LicenseInfoInformation about the current license.
MaskSensitiveWhether sensitive data is masked in log messages.
ProcessIdleEventsWhether the class uses its internal event loop to process events when the main thread is idle.
SelectWaitMillisThe length of time in milliseconds the class will wait when DoEvents is called if there are no events to process.
UseFIPSCompliantAPITells the class whether or not to use FIPS certified APIs.
UseInternalSecurityAPIWhether or not to use the system security libraries or an internal implementation.

edi_standard_version Property

The version of the EDI specification.

Syntax

def get_edi_standard_version() -> str: ...

edi_standard_version = property(get_edi_standard_version, None)

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.

input_data Property

The data to parse.

Syntax

def get_input_data() -> str: ...
def set_input_data(value: str) -> None: ...

input_data = property(get_input_data, set_input_data)

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:

When a valid source is found the search stops.

input_file Property

The file to parse.

Syntax

def get_input_file() -> str: ...
def set_input_file(value: str) -> None: ...

input_file = property(get_input_file, set_input_file)

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:

When a valid source is found the search stops.

schema_format Property

The format of the schema file.

Syntax

def get_schema_format() -> int: ...
def set_schema_format(value: int) -> None: ...

schema_format = property(get_schema_format, set_schema_format)

Default Value

0

Remarks

Set schema_format before calling the load_schema 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 compile_schema.
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

validation_error_count Property

The number of records in the ValidationError arrays.

Syntax

def get_validation_error_count() -> int: ...

validation_error_count = property(get_validation_error_count, None)

Default Value

0

Remarks

This property controls the size of the following arrays:

The array indices start at 0 and end at validation_error_count - 1.

This property is read-only.

validation_error_column Property

The column number in the EDI document where the error occurred.

Syntax

def get_validation_error_column(validation_error_index: int) -> int: ...

Default Value

0

Remarks

The column number in the EDI document where the error occurred. This value may be used in conjunction with the validation_error_line property to determine the exact location within the EDI document where the error occurred.

The validation_error_index parameter specifies the index of the item in the array. The size of the array is controlled by the validation_error_count property.

This property is read-only.

validation_error_element_error_code Property

The error code which may be used in the IK403 property of a 999.

Syntax

def get_validation_error_element_error_code(validation_error_index: int) -> str: ...

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 validation_error_index parameter specifies the index of the item in the array. The size of the array is controlled by the validation_error_count property.

This property is read-only.

validation_error_element_position Property

This property holds the position of the element where the error occurred.

Syntax

def get_validation_error_element_position(validation_error_index: int) -> int: ...

Default Value

0

Remarks

This property holds the position of the element where the error occurred.

The validation_error_index parameter specifies the index of the item in the array. The size of the array is controlled by the validation_error_count property.

This property is read-only.

validation_error_error_code Property

The ErrorCode property contains the type of error encountered.

Syntax

def get_validation_error_error_code(validation_error_index: int) -> int: ...

Default Value

0

Remarks

The validation_error_error_code 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 validation_error_index parameter specifies the index of the item in the array. The size of the array is controlled by the validation_error_count property.

This property is read-only.

validation_error_line Property

The line number in the EDI document where the error occurred.

Syntax

def get_validation_error_line(validation_error_index: int) -> int: ...

Default Value

0

Remarks

The line number in the EDI document where the error occurred. This value may be used in conjunction with the validation_error_column property to determine the exact location within the EDI document where the error occurred.

The validation_error_index parameter specifies the index of the item in the array. The size of the array is controlled by the validation_error_count property.

This property is read-only.

validation_error_message Property

Message is a textual description of the error.

Syntax

def get_validation_error_message(validation_error_index: int) -> str: ...

Default Value

""

Remarks

validation_error_message is a textual description of the error.

The validation_error_index parameter specifies the index of the item in the array. The size of the array is controlled by the validation_error_count property.

This property is read-only.

validation_error_segment_error_code Property

The error code which may be used in the IK304 property of a 999.

Syntax

def get_validation_error_segment_error_code(validation_error_index: int) -> str: ...

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 validation_error_index parameter specifies the index of the item in the array. The size of the array is controlled by the validation_error_count property.

This property is read-only.

validation_error_segment_number Property

This property is the index of the segment where the error occurred.

Syntax

def get_validation_error_segment_number(validation_error_index: int) -> int: ...

Default Value

0

Remarks

This property is the index of the segment where the error occurred.

The validation_error_index parameter specifies the index of the item in the array. The size of the array is controlled by the validation_error_count property.

This property is read-only.

validation_error_segment_tag Property

This property specifies the tag name of the segment where the error occurred.

Syntax

def get_validation_error_segment_tag(validation_error_index: int) -> str: ...

Default Value

""

Remarks

This property specifies the tag name of the segment where the error occurred.

The validation_error_index parameter specifies the index of the item in the array. The size of the array is controlled by the validation_error_count property.

This property is read-only.

validation_error_technical_error_code Property

This property holds a technical error code that helps identify structural issues with the document.

Syntax

def get_validation_error_technical_error_code(validation_error_index: int) -> str: ...

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:

001The Interchange Control Numbers in the header ISA 13 and trailer IEA02 do not match.
014Invalid interchange date value (non-numeric characters or wrong length).
015Invalid interchange time value (non-numeric characters or wrong length).
022The ISA segment is missing elements (invalid control structure).
024Invalid interchange content (e.g., Invalid GS segment).

The validation_error_index parameter specifies the index of the item in the array. The size of the array is controlled by the validation_error_count property.

This property is read-only.

compile_schema Method

Compiles an existing XSD schema into an optimized binary representation.

Syntax

def compile_schema(xsd_schema: str, bin_schema: str) -> None: ...

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 load_schema

If the schema file does not exists or cannot be parsed as an EDI schema, the component throws an exception.

config Method

Sets or retrieves a configuration setting.

Syntax

def config(configuration_string: str) -> str: ...

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.

display_schema_info Method

Returns a string showing the structure of the schema defining the document.

Syntax

def display_schema_info() -> str: ...

Remarks

After calling load_schema 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 load_schema.

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]

display_xml_info Method

Returns a string showing the structure of the parsed document as XML.

Syntax

def display_xml_info() -> str: ...

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

Flushes the parser and checks its end state.

Syntax

def flush() -> None: ...

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 extra_data property after this method is called.

load_schema Method

Loads a schema file describing a Transaction Set.

Syntax

def load_schema(file_name: str) -> None: ...

Remarks

This method parses the File and loads it into an internal schema list. The class will attempt to automatically detect the schema_format.

If the schema file does not exist or cannot be parsed as an EDI schema, the class fails with an error.

reset Method

Resets the parser.

Syntax

def reset() -> None: ...

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

Validates the specified EDI document.

Syntax

def validate() -> None: ...

Remarks

This method validates the EDI document specified by input_file or input_data.

Before calling validate set schema_format and call load_schema 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 on_validation_error event will fire with details about each error as it is encountered. After the document has been validated the validation_errors property will be populated with details of each error.

Inspect the validation_errors 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); }

on_end_functional_group Event

Fires whenever a control segment is read that marks the end of an interchange.

Syntax

class TRADACOMSValidatorEndFunctionalGroupEventParams(object):
  @property
  def tag() -> str: ...

  @property
  def control_number() -> str: ...

  @property
  def count() -> int: ...

  @property
  def full_segment() -> str: ...

# In class TRADACOMSValidator:
@property
def on_end_functional_group() -> Callable[[TRADACOMSValidatorEndFunctionalGroupEventParams], None]: ...
@on_end_functional_group.setter
def on_end_functional_group(event_hook: Callable[[TRADACOMSValidatorEndFunctionalGroupEventParams], None]) -> None: ...

Remarks

The on_end_functional_group 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 on_start_functional_group event. Count contains the value of the count element included in the closing segment, which identifies the number of transactions in a functional group.

on_end_interchange Event

Fires whenever a control segment is read that marks the end of an interchange.

Syntax

class TRADACOMSValidatorEndInterchangeEventParams(object):
  @property
  def tag() -> str: ...

  @property
  def control_number() -> str: ...

  @property
  def full_segment() -> str: ...

# In class TRADACOMSValidator:
@property
def on_end_interchange() -> Callable[[TRADACOMSValidatorEndInterchangeEventParams], None]: ...
@on_end_interchange.setter
def on_end_interchange(event_hook: Callable[[TRADACOMSValidatorEndInterchangeEventParams], None]) -> None: ...

Remarks

The on_end_interchange 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 on_start_interchange event.

on_end_loop Event

Fires when the end of a loop is detected in a transaction set.

Syntax

class TRADACOMSValidatorEndLoopEventParams(object):
# In class TRADACOMSValidator:
@property
def on_end_loop() -> Callable[[TRADACOMSValidatorEndLoopEventParams], None]: ...
@on_end_loop.setter
def on_end_loop(event_hook: Callable[[TRADACOMSValidatorEndLoopEventParams], None]) -> None: ...

Remarks

The on_end_loop event will fire after the last segment in a loop is read. Each on_end_loop event is paired with one on_start_loop event.

on_end_transaction Event

Fires whenever a control segment is read that marks the end of a transaction.

Syntax

class TRADACOMSValidatorEndTransactionEventParams(object):
  @property
  def tag() -> str: ...

  @property
  def control_number() -> str: ...

  @property
  def count() -> int: ...

  @property
  def full_segment() -> str: ...

# In class TRADACOMSValidator:
@property
def on_end_transaction() -> Callable[[TRADACOMSValidatorEndTransactionEventParams], None]: ...
@on_end_transaction.setter
def on_end_transaction(event_hook: Callable[[TRADACOMSValidatorEndTransactionEventParams], None]) -> None: ...

Remarks

The on_end_transaction 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 on_start_transaction event. Count contains the value of the count element included in the closing segment, which identifies the number of segments in a transaction set.

on_error Event

Fired when information is available about errors during data delivery.

Syntax

class TRADACOMSValidatorErrorEventParams(object):
  @property
  def error_code() -> int: ...

  @property
  def description() -> str: ...

# In class TRADACOMSValidator:
@property
def on_error() -> Callable[[TRADACOMSValidatorErrorEventParams], None]: ...
@on_error.setter
def on_error(event_hook: Callable[[TRADACOMSValidatorErrorEventParams], None]) -> None: ...

Remarks

The on_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 on_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.

on_resolve_schema Event

Fires whenever a new transaction set is encountered and no schema is found for it.

Syntax

class TRADACOMSValidatorResolveSchemaEventParams(object):
  @property
  def transaction_code() -> str: ...

  @property
  def standard_version() -> str: ...

# In class TRADACOMSValidator:
@property
def on_resolve_schema() -> Callable[[TRADACOMSValidatorResolveSchemaEventParams], None]: ...
@on_resolve_schema.setter
def on_resolve_schema(event_hook: Callable[[TRADACOMSValidatorResolveSchemaEventParams], None]) -> None: ...

Remarks

The on_resolve_schema 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 load_schema() 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.

on_segment Event

Fires whenever a data segment in a transaction set is read.

Syntax

class TRADACOMSValidatorSegmentEventParams(object):
  @property
  def tag() -> str: ...

  @property
  def name() -> str: ...

  @property
  def loop_name() -> str: ...

  @property
  def full_segment() -> str: ...

# In class TRADACOMSValidator:
@property
def on_segment() -> Callable[[TRADACOMSValidatorSegmentEventParams], None]: ...
@on_segment.setter
def on_segment(event_hook: Callable[[TRADACOMSValidatorSegmentEventParams], None]) -> None: ...

Remarks

The on_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).

on_start_functional_group Event

Fires whenever a control segment is read that marks the start of a functional group.

Syntax

class TRADACOMSValidatorStartFunctionalGroupEventParams(object):
  @property
  def tag() -> str: ...

  @property
  def control_number() -> str: ...

  @property
  def full_segment() -> str: ...

# In class TRADACOMSValidator:
@property
def on_start_functional_group() -> Callable[[TRADACOMSValidatorStartFunctionalGroupEventParams], None]: ...
@on_start_functional_group.setter
def on_start_functional_group(event_hook: Callable[[TRADACOMSValidatorStartFunctionalGroupEventParams], None]) -> None: ...

Remarks

The on_start_functional_group 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.

on_start_interchange Event

Fires whenever a control segment is read that marks the start of an interchange.

Syntax

class TRADACOMSValidatorStartInterchangeEventParams(object):
  @property
  def tag() -> str: ...

  @property
  def control_number() -> str: ...

  @property
  def full_segment() -> str: ...

# In class TRADACOMSValidator:
@property
def on_start_interchange() -> Callable[[TRADACOMSValidatorStartInterchangeEventParams], None]: ...
@on_start_interchange.setter
def on_start_interchange(event_hook: Callable[[TRADACOMSValidatorStartInterchangeEventParams], None]) -> None: ...

Remarks

The on_start_interchange 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.

on_start_loop Event

Fires when the starting of a loop is detected in a transaction set.

Syntax

class TRADACOMSValidatorStartLoopEventParams(object):
  @property
  def name() -> str: ...

# In class TRADACOMSValidator:
@property
def on_start_loop() -> Callable[[TRADACOMSValidatorStartLoopEventParams], None]: ...
@on_start_loop.setter
def on_start_loop(event_hook: Callable[[TRADACOMSValidatorStartLoopEventParams], None]) -> None: ...

Remarks

The on_start_loop 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".

on_start_transaction Event

Fires whenever a control segment is read that marks the start of a transaction.

Syntax

class TRADACOMSValidatorStartTransactionEventParams(object):
  @property
  def tag() -> str: ...

  @property
  def control_number() -> str: ...

  @property
  def code() -> str: ...

  @property
  def full_segment() -> str: ...

# In class TRADACOMSValidator:
@property
def on_start_transaction() -> Callable[[TRADACOMSValidatorStartTransactionEventParams], None]: ...
@on_start_transaction.setter
def on_start_transaction(event_hook: Callable[[TRADACOMSValidatorStartTransactionEventParams], None]) -> None: ...

Remarks

The on_start_transaction 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).

on_validation_error Event

Fires whenever a validation error is encountered.

Syntax

class TRADACOMSValidatorValidationErrorEventParams(object):
  @property
  def error_code() -> int: ...

  @property
  def message() -> str: ...

  @property
  def segment_number() -> int: ...

  @property
  def segment_tag() -> str: ...

  @property
  def technical_error_code() -> str: ...

  @property
  def segment_error_code() -> str: ...

  @property
  def element_error_code() -> str: ...

  @property
  def element_position() -> int: ...

  @property
  def line() -> int: ...

  @property
  def column() -> int: ...

# In class TRADACOMSValidator:
@property
def on_validation_error() -> Callable[[TRADACOMSValidatorValidationErrorEventParams], None]: ...
@on_validation_error.setter
def on_validation_error(event_hook: Callable[[TRADACOMSValidatorValidationErrorEventParams], None]) -> None: ...

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:

001The Interchange Control Numbers in the header ISA 13 and trailer IEA02 do not match.
014Invalid interchange date value (non-numeric characters or wrong length).
015Invalid interchange time value (non-numeric characters or wrong length).
022The ISA segment is missing elements (invalid control structure).
024Invalid interchange content (e.g., Invalid GS segment).

TRADACOMSValidator Config Settings

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

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 on_start_interchange 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:

  • 1 (EDIFACT - default)
  • 3 (TRADACOMS)

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 on_start_interchange 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 validation_errors property. Once this limit is exceeded the on_validation_error event will continue to fire but details will not be saved in the validation_errors 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 on_start_interchange event to specify the escape character to be used.

ResolveXPathOnSet:   Determines whether or not the XPath is resolved when set.

When true, the class will fully resolve a detailed path when xpath is specified. In this case, the xpath property will contain the x_segment 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: 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.

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 on_start_interchange 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 on_warning event will fire, but processing will not stop. See the WarnCode parameter list in the on_warning event for details about possible validation warnings. Possible values for this setting are:

0 (Ignore) All validation warnings will be ignored. on_warning will not fire with warnings.
1 (Warn - default) The on_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

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:

IdentifierName
037IBM EBCDIC - U.S./Canada
437OEM - United States
500IBM EBCDIC - International
708Arabic - ASMO 708
709Arabic - ASMO 449+, BCON V4
710Arabic - Transparent Arabic
720Arabic - Transparent ASMO
737OEM - Greek (formerly 437G)
775OEM - Baltic
850OEM - Multilingual Latin I
852OEM - Latin II
855OEM - Cyrillic (primarily Russian)
857OEM - Turkish
858OEM - Multilingual Latin I + Euro symbol
860OEM - Portuguese
861OEM - Icelandic
862OEM - Hebrew
863OEM - Canadian-French
864OEM - Arabic
865OEM - Nordic
866OEM - Russian
869OEM - Modern Greek
870IBM EBCDIC - Multilingual/ROECE (Latin-2)
874ANSI/OEM - Thai (same as 28605, ISO 8859-15)
875IBM EBCDIC - Modern Greek
932ANSI/OEM - Japanese, Shift-JIS
936ANSI/OEM - Simplified Chinese (PRC, Singapore)
949ANSI/OEM - Korean (Unified Hangul Code)
950ANSI/OEM - Traditional Chinese (Taiwan; Hong Kong SAR, PRC)
1026IBM EBCDIC - Turkish (Latin-5)
1047IBM EBCDIC - Latin 1/Open System
1140IBM EBCDIC - U.S./Canada (037 + Euro symbol)
1141IBM EBCDIC - Germany (20273 + Euro symbol)
1142IBM EBCDIC - Denmark/Norway (20277 + Euro symbol)
1143IBM EBCDIC - Finland/Sweden (20278 + Euro symbol)
1144IBM EBCDIC - Italy (20280 + Euro symbol)
1145IBM EBCDIC - Latin America/Spain (20284 + Euro symbol)
1146IBM EBCDIC - United Kingdom (20285 + Euro symbol)
1147IBM EBCDIC - France (20297 + Euro symbol)
1148IBM EBCDIC - International (500 + Euro symbol)
1149IBM EBCDIC - Icelandic (20871 + Euro symbol)
1200Unicode UCS-2 Little-Endian (BMP of ISO 10646)
1201Unicode UCS-2 Big-Endian
1250ANSI - Central European
1251ANSI - Cyrillic
1252ANSI - Latin I
1253ANSI - Greek
1254ANSI - Turkish
1255ANSI - Hebrew
1256ANSI - Arabic
1257ANSI - Baltic
1258ANSI/OEM - Vietnamese
1361Korean (Johab)
10000MAC - Roman
10001MAC - Japanese
10002MAC - Traditional Chinese (Big5)
10003MAC - Korean
10004MAC - Arabic
10005MAC - Hebrew
10006MAC - Greek I
10007MAC - Cyrillic
10008MAC - Simplified Chinese (GB 2312)
10010MAC - Romania
10017MAC - Ukraine
10021MAC - Thai
10029MAC - Latin II
10079MAC - Icelandic
10081MAC - Turkish
10082MAC - Croatia
12000Unicode UCS-4 Little-Endian
12001Unicode UCS-4 Big-Endian
20000CNS - Taiwan
20001TCA - Taiwan
20002Eten - Taiwan
20003IBM5550 - Taiwan
20004TeleText - Taiwan
20005Wang - Taiwan
20105IA5 IRV International Alphabet No. 5 (7-bit)
20106IA5 German (7-bit)
20107IA5 Swedish (7-bit)
20108IA5 Norwegian (7-bit)
20127US-ASCII (7-bit)
20261T.61
20269ISO 6937 Non-Spacing Accent
20273IBM EBCDIC - Germany
20277IBM EBCDIC - Denmark/Norway
20278IBM EBCDIC - Finland/Sweden
20280IBM EBCDIC - Italy
20284IBM EBCDIC - Latin America/Spain
20285IBM EBCDIC - United Kingdom
20290IBM EBCDIC - Japanese Katakana Extended
20297IBM EBCDIC - France
20420IBM EBCDIC - Arabic
20423IBM EBCDIC - Greek
20424IBM EBCDIC - Hebrew
20833IBM EBCDIC - Korean Extended
20838IBM EBCDIC - Thai
20866Russian - KOI8-R
20871IBM EBCDIC - Icelandic
20880IBM EBCDIC - Cyrillic (Russian)
20905IBM EBCDIC - Turkish
20924IBM EBCDIC - Latin-1/Open System (1047 + Euro symbol)
20932JIS X 0208-1990 & 0121-1990
20936Simplified Chinese (GB2312)
21025IBM EBCDIC - Cyrillic (Serbian, Bulgarian)
21027Extended Alpha Lowercase
21866Ukrainian (KOI8-U)
28591ISO 8859-1 Latin I
28592ISO 8859-2 Central Europe
28593ISO 8859-3 Latin 3
28594ISO 8859-4 Baltic
28595ISO 8859-5 Cyrillic
28596ISO 8859-6 Arabic
28597ISO 8859-7 Greek
28598ISO 8859-8 Hebrew
28599ISO 8859-9 Latin 5
28605ISO 8859-15 Latin 9
29001Europa 3
38598ISO 8859-8 Hebrew
50220ISO 2022 Japanese with no halfwidth Katakana
50221ISO 2022 Japanese with halfwidth Katakana
50222ISO 2022 Japanese JIS X 0201-1989
50225ISO 2022 Korean
50227ISO 2022 Simplified Chinese
50229ISO 2022 Traditional Chinese
50930Japanese (Katakana) Extended
50931US/Canada and Japanese
50933Korean Extended and Korean
50935Simplified Chinese Extended and Simplified Chinese
50936Simplified Chinese
50937US/Canada and Traditional Chinese
50939Japanese (Latin) Extended and Japanese
51932EUC - Japanese
51936EUC - Simplified Chinese
51949EUC - Korean
51950EUC - Traditional Chinese
52936HZ-GB2312 Simplified Chinese
54936Windows XP: GB18030 Simplified Chinese (4 Byte)
57002ISCII Devanagari
57003ISCII Bengali
57004ISCII Tamil
57005ISCII Telugu
57006ISCII Assamese
57007ISCII Oriya
57008ISCII Kannada
57009ISCII Malayalam
57010ISCII Gujarati
57011ISCII Punjabi
65000Unicode UTF-7
65001Unicode UTF-8
The following is a list of valid code page identifiers for Mac OS only:
IdentifierName
1ASCII
2NEXTSTEP
3JapaneseEUC
4UTF8
5ISOLatin1
6Symbol
7NonLossyASCII
8ShiftJIS
9ISOLatin2
10Unicode
11WindowsCP1251
12WindowsCP1252
13WindowsCP1253
14WindowsCP1254
15WindowsCP1250
21ISO2022JP
30MacOSRoman
10UTF16String
0x90000100UTF16BigEndian
0x94000100UTF16LittleEndian
0x8c000100UTF32String
0x98000100UTF32BigEndian
0x9c000100UTF32LittleEndian
65536Proprietary

LicenseInfo:   Information about the current license.

When queried, this setting will return a string containing information about the license this instance of a class is using. It will return the following information:

  • 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.
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 True.

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.

ProcessIdleEvents:   Whether the class uses its internal event loop to process events when the main thread is idle.

If set to False, the class will not fire internal idle events. Set this to False to use the class in a background thread on Mac OS. By default, this setting is True.

SelectWaitMillis:   The length of time in milliseconds the class will wait when DoEvents is called if there are no events to process.

If there are no events to process when do_events is called, the class will wait for the amount of time specified here before returning. The default value is 20.

UseFIPSCompliantAPI:   Tells the class whether or not to use FIPS certified APIs.

When set to True, the class 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 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.

UseInternalSecurityAPI:   Whether or not to use the system security libraries or an internal implementation.

When set to False, the class will use the system security libraries by default to perform cryptographic functions where applicable.

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.

TRADACOMSValidator Errors

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.