TRADACOMSReader Class

Properties   Methods   Events   Config Settings   Errors  

The TRADACOMSReader class is optimized for TRADACOMS documents, providing a simple way to parse TRADACOMS documents.

Syntax

class ipworksedi.TRADACOMSReader

Remarks

The class allows you to parse an incoming EDI document. This class works in two states, loading an entire document at once, or streaming portions of the document. These states are controlled by the BuildDOM property. By default BuildDOM is set to bdEntireDocument which parses the entire document at once, allowing you to use the xpath property to navigate the document.

To save memory for larger documents, you can choose to parse only sections of the document, instead of the entire document. When build_dom is set to per interchange (bdInterchange ) or per transaction (bdTransaction), the respective section of the document will be available for use with xpath from within the corresponding Start and End events. Finally, you may choose to set build_dom to bdNone, which means no DOM will be built and all data will be available only through events, but also will use very little memory. Below are example steps to parse an entire document:

1. First, use load_schema to load a schema file into the class. (Only necessary when preserving document structure).
2. Open an EDI document or stream by setting input via input_file or input_data and calling parse.
3. If build_dom is set to bdEntireDocument, the events of the class will fire as the document is parsed, and xpath may be set to access any part of the document.

   If bdInterchange or bdTransaction are specified, parse is called the entire document will be parsed, with only the specified section being saved in memory at any given time. This means if you wish to set xpath to navigate within the section of the document, you will need to do so within the events of the class to prevent further processing of the document while you access the section. When parsing is completely, only the most recently parsed section will be available for use with xpath

   If bdNone is specified, then all document information must be obtained through the events fired during parsing.

During parsing, the class performs basic validation of the incoming document. If validation fails, a warning is generated (fired as an event).

The XPath navigation is done through the xpath property. For example: EDIReader.XPath = "/IX[1]/FG[1]/TX[2]/N1Loop1[1]/N1[1]"; This example path means the following: Select the first N1 segment within the first iteration of the N1Loop1, within second transaction in the first functional group and interchange.

You can also make use of XPath conditional statements to locate the first element which matches a name=value. For example, you could use the following XPath to locate the path of the first element within any N1Loop1 that has a name=N101 and value=BT: EDIReader.XPath = "IX[1]/FG[1]/TX[1]/N1Loop1[N101='BT']";

Note that the conditional statements will search the children, but not the grand children of the element on which the conditional statement is applied. For instance in the above example the children of N1Loop1 will be searched, but the grandchildren will not.

Additionally if the schema loaded is a ArcESB JSON schema the element Id (from the schema) can be used in the conditional statement. For instance instead of N101 the following is also acceptable: EDIReader.XPath = "IX[1]/FG[1]/TX[1]/N1Loop1[98='BT']";

To display the structure of the parsed document use display_schema_info. This is helpful when deciding how to navigate the document.

Property List

---

The following is the full list of the properties of the class with short descriptions. Click on the links for further details.

Method List

---

The following is the full list of the methods of the class with short descriptions. Click on the links for further details.

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.

Config Settings

---

The following is a list of config settings for the class with short descriptions. Click on the links for further details.

build_dom Property

When True, an internal object model of the EDI document is created.

Syntax

def get_build_dom() -> int: ...
def set_build_dom(value: int) -> None: ...

build_dom = property(get_build_dom, set_build_dom)

Default Value

0

Remarks

Set build_dom to bdEntireDocument (0) when you need to browse the current document through xpath.

Use bdInterchange (1) when parsing large documents to tell the class to only hold an internal object model of the current Interchange being parsed. When this value is used, and a new Interchange is encountered during parsing, the old interchange is cleared from memory. If the input contains a single Interchange, this is equivalent to using bdEntireDocument.

Use bdTransaction (2) when parsing large documents to tell the class to only hold an internal object model of the current transaction being parsed. When this value is used, and a new transaction is encountered during parsing, the old transaction is cleared from memory.

A value of bdNone (3) will tell the class to not save any internal state of the document being parsed, and thus xpath will be unavailable.

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.

extra_data Property

Extra data that has not been parsed by the class.

Syntax

def get_extra_data() -> str: ...

extra_data = property(get_extra_data, None)

Default Value

""

Remarks

This property will only be populated after the flush method has been called and data exists in the internal parser which has not been processed.

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:

• input_file
• input_data

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:

• input_file
• input_data

When a valid source is found the search stops.

offset Property

Current offset of the document being parsed.

Syntax

def get_offset() -> int: ...

offset = property(get_offset, None)

Default Value

0

Remarks

This property is useful for determining the location of possible EDI errors in the document.

This property is read-only.

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:

x_children Property

Number of child elements of the current segment.

Syntax

def get_x_children() -> int: ...

x_children = property(get_x_children, None)

Default Value

0

Remarks

This property describes the number of children of the current segment in the parsed document.

This property is read-only.

element_count Property

The number of records in the Element arrays.

Syntax

def get_element_count() -> int: ...

element_count = property(get_element_count, None)

Default Value

0

Remarks

This property controls the size of the following arrays:

• element_component_count
• element_component_index
• element_component_name
• element_component_schema_desc
• element_component_schema_name
• element_component_type
• element_component_value
• element_data_type
• element_name
• element_repeat_count
• element_repeat_index
• element_schema_desc
• element_schema_name
• element_value

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

This property is read-only.

element_component_count Property

Number of classes in the current element.

Syntax

def get_element_component_count(element_index: int) -> int: ...

Default Value

0

Remarks

Number of components in the current element.

The element_index parameter specifies the index of the item in the array. The size of the array is controlled by the element_count property.

This property is read-only.

element_component_index Property

The index of the selected class of the current element.

Syntax

def get_element_component_index(element_index: int) -> int: ...
def set_element_component_index(element_index: int, value: int) -> None: ...

Default Value

1

Remarks

The index of the selected component of the current element. element_component_index valid values are from 0 to (element_component_count - 1).

The element_index parameter specifies the index of the item in the array. The size of the array is controlled by the element_count property.

element_component_name Property

The name of the class selected by ClassIndex , according to the Transaction Set schema.

Syntax

def get_element_component_name(element_index: int) -> str: ...

Default Value

""

Remarks

The name of the component selected by element_component_index, according to the Transaction Set schema.

The name is based on the position of the element within the segment. For instance "DTM0101".

See element_component_schema_name for additional details.

Note: This property is only applicable when a ArcESB JSON schema is loaded.

The element_index parameter specifies the index of the item in the array. The size of the array is controlled by the element_count property.

This property is read-only.

element_component_schema_desc Property

The textual description of the class from the loaded ArcESB JSON schema.

Syntax

def get_element_component_schema_desc(element_index: int) -> str: ...

Default Value

""

Remarks

The textual description of the component from the loaded ArcESB JSON schema.

This property holds a human readable description of the component as obtained from the ArcESB JSON schema.

Note: This property is only applicable when a ArcESB JSON schema is loaded.

The element_index parameter specifies the index of the item in the array. The size of the array is controlled by the element_count property.

This property is read-only.

element_component_schema_name Property

The name of the class as taken from the schema.

Syntax

def get_element_component_schema_name(element_index: int) -> str: ...

Default Value

""

Remarks

The name of the component as taken from the schema.

element_component_name holds positional (ref) value like "DTM0101". element_component_schema_name holds the Id taken from the schema.

For instance: reader.XPath = "/IX/TX/DTM"; for (int i = 0; i < reader.XElements[0].ComponentCount; i++) { reader.XElements[0].ComponentIndex = i; Console.WriteLine(reader.XElements[i].ComponentSchemaName + ": " + reader.XElements[i].ComponentValue); }

When element_component_schema_name is used this will use the name from the schema and will output values like:

2005: 137
2005: 137
2380: 201612151441

In contrast, if element_component_name was used the output would look like:

DTM0101: 137
DTM0101: 137
DTM0102: 201612151441

Note: This property is only applicable when a ArcESB JSON schema is loaded.

The element_index parameter specifies the index of the item in the array. The size of the array is controlled by the element_count property.

This property is read-only.

element_component_type Property

The data type of class selected by ClassIndex , according to the Transaction Set Schema.

Syntax

def get_element_component_type(element_index: int) -> str: ...

Default Value

""

Remarks

The data type of component selected by element_component_index, according to the Transaction Set Schema.

Possible values are:

The element_index parameter specifies the index of the item in the array. The size of the array is controlled by the element_count property.

This property is read-only.

element_component_value Property

The value of the class selected by ClassIndex .

Syntax

def get_element_component_value(element_index: int) -> str: ...

Default Value

""

Remarks

The value of the component selected by element_component_index.

The element_index parameter specifies the index of the item in the array. The size of the array is controlled by the element_count property.

This property is read-only.

element_data_type Property

The data type of this EDI element, according to the Transaction Set Schema.

Syntax

def get_element_data_type(element_index: int) -> str: ...

Default Value

""

Remarks

The data type of this EDI element, according to the Transaction Set Schema.

Possible values are:

The element_index parameter specifies the index of the item in the array. The size of the array is controlled by the element_count property.

This property is read-only.

element_name Property

The name of this EDI element, according to the Transaction Set schema.

Syntax

def get_element_name(element_index: int) -> str: ...

Default Value

""

Remarks

The name of this EDI element, according to the Transaction Set schema. The name is based on the position of the element within the segment. For instance "N101".

See element_schema_name for additional details.

Note: This property is only applicable when a ArcESB JSON schema is loaded.

The element_index parameter specifies the index of the item in the array. The size of the array is controlled by the element_count property.

This property is read-only.

element_repeat_count Property

The number of times this element is repeated in the in the segment.

Syntax

def get_element_repeat_count(element_index: int) -> int: ...

Default Value

1

Remarks

The number of times this element is repeated in the in the segment. If the element is not repeated this will return 0.

To access the repeated element values set element_repeat_index.

The element_index parameter specifies the index of the item in the array. The size of the array is controlled by the element_count property.

This property is read-only.

element_repeat_index Property

The index of the selected instance of this repeatable element.

Syntax

def get_element_repeat_index(element_index: int) -> int: ...
def set_element_repeat_index(element_index: int, value: int) -> None: ...

Default Value

1

Remarks

The index of the selected instance of this repeatable element. element_repeat_index valid values are from 0 to (element_repeat_count - 1).

Setting element_repeat_index will affect the value reported by all other properties.

The element_index parameter specifies the index of the item in the array. The size of the array is controlled by the element_count property.

element_schema_desc Property

The textual description of the element from the loaded ArcESB JSON schema.

Syntax

def get_element_schema_desc(element_index: int) -> str: ...

Default Value

""

Remarks

The textual description of the element from the loaded ArcESB JSON schema.

This property holds a human readable description of the element as obtained from the ArcESB JSON schema.

Note: This property is only applicable when a ArcESB JSON schema is loaded.

The element_index parameter specifies the index of the item in the array. The size of the array is controlled by the element_count property.

This property is read-only.

element_schema_name Property

The name of the element as taken from the schema.

Syntax

def get_element_schema_name(element_index: int) -> str: ...

Default Value

""

Remarks

The name of the element as taken from the schema.

element_name holds positional (ref) value like "N101". element_schema_name holds the Id taken from the schema.

For instance: reader.XPath = "/IX/FG/TX/N1Loop1[1]/N1"; for (int i = 0; i < reader.XElements.Count; i++) { Console.WriteLine(reader.XElements[i].SchemaName + ": " + reader.XElements[i].Value); }

When element_schema_name is used this will use the name from the schema and will output values like:

98: ST
93: BUYSNACKS PORT
66: 9
67: 1223334445

In contrast, if element_name was used the output would look like:

N101: ST
N102: BUYSNACKS PORT
N103: 9
N104: 1223334445

Note: This property is only applicable when a ArcESB JSON schema is loaded.

The element_index parameter specifies the index of the item in the array. The size of the array is controlled by the element_count property.

This property is read-only.

element_value Property

The value directly associated with this EDI element.

Syntax

def get_element_value(element_index: int) -> str: ...

Default Value

""

Remarks

The value directly associated with this EDI element.

Note that this property will be populated with the entire element contents when a composite element exists. The components of the composite element will also be parsed out into the element_component_name, element_component_type, and element_component_value properties.

The element_index parameter specifies the index of the item in the array. The size of the array is controlled by the element_count property.

This property is read-only.

xpath Property

Provides a way to point to a specific segment in the document.

Syntax

def get_xpath() -> str: ...
def set_xpath(value: str) -> None: ...

xpath = property(get_xpath, set_xpath)

Default Value

""

Remarks

The path is a series of one or more segment accessors separated by '/'. The path can be absolute (starting with '/') or relative to the current xpath location.

The following are possible values for an element accessor:

When xpath is set to a valid path, x_segment points to the name of the segment, with x_tag, x_segment_type, and x_children providing other properties of the segment. The elements of the current segment are provided in the x_elements properties.

build_dom must be set to bdEntireDocument or bdTransaction prior to parsing the document for the xpath functionality to be available.

Example (Setting XPath)

x_segment Property

The name of the current segment.

Syntax

def get_x_segment() -> str: ...

x_segment = property(get_x_segment, None)

Default Value

""

Remarks

The name of the current segment according to the schema. The current segment is specified via the xpath property.

This property is read-only.

x_segment_number Property

The number of the current segment.

Syntax

def get_x_segment_number() -> int: ...

x_segment_number = property(get_x_segment_number, None)

Default Value

0

Remarks

The number of the current segment according to the schema. The current segment is specified via the xpath property.

This property is read-only.

x_segment_type Property

Indicates the current segment type.

Syntax

def get_x_segment_type() -> int: ...

x_segment_type = property(get_x_segment_type, None)

Default Value

0

Remarks

The current segment will be a control segment footer/header or a transaction data segment.

This property is read-only.

x_tag Property

The tag of the current segment.

Syntax

def get_x_tag() -> str: ...

x_tag = property(get_x_tag, None)

Default Value

""

Remarks

The current segment is specified via the xpath property.

This property is read-only.

x_transaction_code Property

The transaction code of the current segment.

Syntax

def get_x_transaction_code() -> str: ...

x_transaction_code = property(get_x_transaction_code, None)

Default Value

""

Remarks

The current segment is specified via the xpath 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:

  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]

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="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

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.

generate_ack Method

Generates an EDI acknowledgement.

Syntax

def generate_ack() -> str: ...

Remarks

This functionality is not yet implemented and is reserved for future use.

has_xpath Method

Determines whether a specific element exists in the document.

Syntax

def has_xpath(xpath: str) -> bool: ...

Remarks

This method determines whether a particular XPath exists within the document. This may be used to check if a path exists before setting it via xpath.

This method returns True if the xpath exists, False if not.

See xpath for details on the XPath syntax.

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.

parse Method

Parse the specified input data.

Syntax

def parse() -> None: ...

Remarks

This method parsed the input data specified by input_file or input_data.

During parsing the following events may fire:

• on_start_interchange
• on_start_functional_group
• on_start_transaction
• on_segment
• on_start_loop
• on_end_loop
• on_end_transaction
• on_end_functional_group
• on_end_interchange

After parse returns the document may be traversed by setting the xpath property. The XPath navigation is done through the xpath property. For example: EDIReader.XPath = "/IX[1]/FG[1]/TX[2]/N1Loop1[1]/N1[1]"; This example path means the following: Select the first N1 segment within the first iteration of the N1Loop1, within second transaction in the first functional group and interchange.

You can also make use of XPath conditional statements to locate the first element which matches a name=value. For example, you could use the following XPath to locate the path of the first element within any N1Loop1 that has a name=N101 and value=BT: EDIReader.XPath = "IX[1]/FG[1]/TX[1]/N1Loop1[N101='BT']";

Note that the conditional statements will search the children, but not the grand children of the element on which the conditional statement is applied. For instance in the above example the children of N1Loop1 will be searched, but the grandchildren will not.

Additionally if the schema loaded is a ArcESB JSON schema the element Id (from the schema) can be used in the conditional statement. For instance instead of N101 the following is also acceptable: EDIReader.XPath = "IX[1]/FG[1]/TX[1]/N1Loop1[98='BT']";

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:

• input_file
• input_data

When a valid source is found the search stops.

InputData Notes

When setting data to parse via input_data fragments or complete documents may be specified. To parse data in chunks set input_data and call parse for each fragment.

When the parser is finally reset via the reset method, all buffered text is flushed out through the extra_data property.

Since the class can be used to parse EDI data fragments, the internal buffer will not be cleared until reset is called. If you plan to use this method to parse multiple complete EDI documents be sure to call reset between calls.

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.

try_xpath Method

Navigates to the specified XPath if it exists.

Syntax

def try_xpath(xpath: str) -> bool: ...

Remarks

This method will attempt to navigate to the specified XPath parameter if it exists within the document.

If the XPath exists the xpath property will be updated and this method returns True.

If the XPath does not exist the xpath property is not updated and this method returns False.

on_end_functional_group Event

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

Syntax

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

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

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

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

# In class TRADACOMSReader:
@property
def on_end_functional_group() -> Callable[[TRADACOMSReaderEndFunctionalGroupEventParams], None]: ...
@on_end_functional_group.setter
def on_end_functional_group(event_hook: Callable[[TRADACOMSReaderEndFunctionalGroupEventParams], 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 TRADACOMSReaderEndInterchangeEventParams(object):
  @property
  def tag() -> str: ...

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

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

# In class TRADACOMSReader:
@property
def on_end_interchange() -> Callable[[TRADACOMSReaderEndInterchangeEventParams], None]: ...
@on_end_interchange.setter
def on_end_interchange(event_hook: Callable[[TRADACOMSReaderEndInterchangeEventParams], 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 TRADACOMSReaderEndLoopEventParams(object):
# In class TRADACOMSReader:
@property
def on_end_loop() -> Callable[[TRADACOMSReaderEndLoopEventParams], None]: ...
@on_end_loop.setter
def on_end_loop(event_hook: Callable[[TRADACOMSReaderEndLoopEventParams], 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 TRADACOMSReaderEndTransactionEventParams(object):
  @property
  def tag() -> str: ...

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

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

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

# In class TRADACOMSReader:
@property
def on_end_transaction() -> Callable[[TRADACOMSReaderEndTransactionEventParams], None]: ...
@on_end_transaction.setter
def on_end_transaction(event_hook: Callable[[TRADACOMSReaderEndTransactionEventParams], 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 TRADACOMSReaderErrorEventParams(object):
  @property
  def error_code() -> int: ...

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

# In class TRADACOMSReader:
@property
def on_error() -> Callable[[TRADACOMSReaderErrorEventParams], None]: ...
@on_error.setter
def on_error(event_hook: Callable[[TRADACOMSReaderErrorEventParams], 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.

on_resolve_schema Event

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

Syntax

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

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

# In class TRADACOMSReader:
@property
def on_resolve_schema() -> Callable[[TRADACOMSReaderResolveSchemaEventParams], None]: ...
@on_resolve_schema.setter
def on_resolve_schema(event_hook: Callable[[TRADACOMSReaderResolveSchemaEventParams], 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 TRADACOMSReaderSegmentEventParams(object):
  @property
  def tag() -> str: ...

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

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

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

# In class TRADACOMSReader:
@property
def on_segment() -> Callable[[TRADACOMSReaderSegmentEventParams], None]: ...
@on_segment.setter
def on_segment(event_hook: Callable[[TRADACOMSReaderSegmentEventParams], 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 TRADACOMSReaderStartFunctionalGroupEventParams(object):
  @property
  def tag() -> str: ...

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

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

# In class TRADACOMSReader:
@property
def on_start_functional_group() -> Callable[[TRADACOMSReaderStartFunctionalGroupEventParams], None]: ...
@on_start_functional_group.setter
def on_start_functional_group(event_hook: Callable[[TRADACOMSReaderStartFunctionalGroupEventParams], 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 TRADACOMSReaderStartInterchangeEventParams(object):
  @property
  def tag() -> str: ...

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

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

# In class TRADACOMSReader:
@property
def on_start_interchange() -> Callable[[TRADACOMSReaderStartInterchangeEventParams], None]: ...
@on_start_interchange.setter
def on_start_interchange(event_hook: Callable[[TRADACOMSReaderStartInterchangeEventParams], 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 TRADACOMSReaderStartLoopEventParams(object):
  @property
  def name() -> str: ...

# In class TRADACOMSReader:
@property
def on_start_loop() -> Callable[[TRADACOMSReaderStartLoopEventParams], None]: ...
@on_start_loop.setter
def on_start_loop(event_hook: Callable[[TRADACOMSReaderStartLoopEventParams], 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 TRADACOMSReaderStartTransactionEventParams(object):
  @property
  def tag() -> str: ...

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

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

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

# In class TRADACOMSReader:
@property
def on_start_transaction() -> Callable[[TRADACOMSReaderStartTransactionEventParams], None]: ...
@on_start_transaction.setter
def on_start_transaction(event_hook: Callable[[TRADACOMSReaderStartTransactionEventParams], 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_warning Event

Fires whenever a validation warning is encountered.

Syntax

class TRADACOMSReaderWarningEventParams(object):
  @property
  def warn_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: ...

# In class TRADACOMSReader:
@property
def on_warning() -> Callable[[TRADACOMSReaderWarningEventParams], None]: ...
@on_warning.setter
def on_warning(event_hook: Callable[[TRADACOMSReaderWarningEventParams], None]) -> None: ...

Remarks

The on_warning event will fire during parsing of a segment of an EDI document. The WarnCode parameter contains the type of warning 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. 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. ElementPosition is the position of the element where the error occurred.

It's very important to note that segment validation happens right in the middle of the parsing process. Because of this, the on_warning event will usually fire long before the validated segment becomes the current segment for the parser state. This means you cannot access the parser properties to examine the current segment in relation with the on_warning event when the event fires.

Possible WarnCode values are:

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:

TRADACOMSReader 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.

TRADACOMSREADER Config Settings

Base Config Settings

TRADACOMSReader Errors

TRADACOMSReader 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.