X12Reader Class

Properties   Methods   Events   Config Settings   Errors  

The X12Reader class is optimized for X12 documents, providing a simple way to parse X12 documents.

Syntax

X12Reader

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 BuildDOM 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 BuildDOM 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 LoadSchema 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 InputFile or InputData and calling Parse.
  3. If BuildDOM 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 DisplaySchemaInfo. 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.

BuildDOMWhen True, an internal object model of the EDI document is created.
EDIStandardVersionThe version of the EDI specification.
ExtraDataExtra data that has not been parsed by the class.
InputDataThe data to parse.
InputFileThe file to parse.
OffsetCurrent offset of the document being parsed.
SchemaFormatThe format of the schema file.
XChildrenNumber of child elements of the current segment.
ElementCountThe number of records in the Element arrays.
ElementComponentCountNumber of classes in the current element.
ElementComponentIndexThe index of the selected class of the current element.
ElementComponentNameThe name of the class selected by ClassIndex , according to the Transaction Set schema.
ElementComponentSchemaDescThe textual description of the class from the loaded ArcESB JSON schema.
ElementComponentSchemaNameThe name of the class as taken from the schema.
ElementComponentTypeThe data type of class selected by ClassIndex , according to the Transaction Set Schema.
ElementComponentValueThe value of the class selected by ClassIndex .
ElementDataTypeThe data type of this EDI element, according to the Transaction Set Schema.
ElementNameThe name of this EDI element, according to the Transaction Set schema.
ElementRepeatCountThe number of times this element is repeated in the in the segment.
ElementRepeatIndexThe index of the selected instance of this repeatable element.
ElementSchemaDescThe textual description of the element from the loaded ArcESB JSON schema.
ElementSchemaNameThe name of the element as taken from the schema.
ElementValueThe value directly associated with this EDI element.
XPathProvides a way to point to a specific segment in the document.
XSegmentThe name of the current segment.
XSegmentNumberThe number of the current segment.
XSegmentTypeIndicates the current segment type.
XTagThe tag of the current segment.
XTransactionCodeThe transaction code of the current segment.

Method List


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

CompileSchemaCompiles an existing XSD schema into an optimized binary representation.
ConfigSets or retrieves a configuration setting.
DisplaySchemaInfoReturns a string showing the structure of the schema defining the document.
DisplayXMLInfoReturns a string showing the structure of the parsed document as XML.
FlushFlushes the parser and checks its end state.
GenerateAckGenerates an EDI acknowledgement.
HasXPathDetermines whether a specific element exists in the document.
LoadSchemaLoads a schema file describing a Transaction Set.
ParseParse the specified input data.
ResetResets the parser.
TryXPathNavigates to the specified XPath if it exists.

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.

EndFunctionalGroupFires whenever a control segment is read that marks the end of an interchange.
EndInterchangeFires whenever a control segment is read that marks the end of an interchange.
EndLoopFires when the end of a loop is detected in a transaction set.
EndTransactionFires whenever a control segment is read that marks the end of a transaction.
ErrorInformation about errors during data delivery.
ResolveSchemaFires whenever a new transaction set is encountered and no schema is found for it.
SegmentFires whenever a data segment in a transaction set is read.
StartFunctionalGroupFires whenever a control segment is read that marks the start of a functional group.
StartInterchangeFires whenever a control segment is read that marks the start of an interchange.
StartLoopFires when the starting of a loop is detected in a transaction set.
StartTransactionFires whenever a control segment is read that marks the start of a transaction.
WarningFires whenever a validation warning 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.
HasXPathDetermines if the specified XPath exists.
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.
UseInternalSecurityAPITells the class whether or not to use the system security libraries or an internal implementation.

BuildDOM Property (X12Reader Class)

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

Syntax

ANSI (Cross Platform)
int GetBuildDOM();
int SetBuildDOM(int iBuildDOM); Unicode (Windows) INT GetBuildDOM();
INT SetBuildDOM(INT iBuildDOM);

Possible Values

BD_ENTIRE_DOCUMENT(0), 
BD_INTERCHANGE(1),
BD_TRANSACTION(2),
BD_NONE(3)
int ipworkseditranslator_x12reader_getbuilddom(void* lpObj);
int ipworkseditranslator_x12reader_setbuilddom(void* lpObj, int iBuildDOM);
int GetBuildDOM();
int SetBuildDOM(int iBuildDOM);

Default Value

0

Remarks

Set BuildDOM 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.

Data Type

Integer

EDIStandardVersion Property (X12Reader Class)

The version of the EDI specification.

Syntax

ANSI (Cross Platform)
char* GetEDIStandardVersion();

Unicode (Windows)
LPWSTR GetEDIStandardVersion();
char* ipworkseditranslator_x12reader_getedistandardversion(void* lpObj);
QString GetEDIStandardVersion();

Default Value

""

Remarks

This property will be populated after parsing begins and the correct version string for is located via the schema, such as 004010 for X12.

This property is read-only and not available at design time.

Data Type

String

ExtraData Property (X12Reader Class)

Extra data that has not been parsed by the class.

Syntax

ANSI (Cross Platform)
char* GetExtraData();

Unicode (Windows)
LPWSTR GetExtraData();
char* ipworkseditranslator_x12reader_getextradata(void* lpObj);
QString GetExtraData();

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 and not available at design time.

Data Type

String

InputData Property (X12Reader Class)

The data to parse.

Syntax

ANSI (Cross Platform)
char* GetInputData();
int SetInputData(const char* lpszInputData); Unicode (Windows) LPWSTR GetInputData();
INT SetInputData(LPCWSTR lpszInputData);
char* ipworkseditranslator_x12reader_getinputdata(void* lpObj);
int ipworkseditranslator_x12reader_setinputdata(void* lpObj, const char* lpszInputData);
QString GetInputData();
int SetInputData(QString qsInputData);

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.

Data Type

String

InputFile Property (X12Reader Class)

The file to parse.

Syntax

ANSI (Cross Platform)
char* GetInputFile();
int SetInputFile(const char* lpszInputFile); Unicode (Windows) LPWSTR GetInputFile();
INT SetInputFile(LPCWSTR lpszInputFile);
char* ipworkseditranslator_x12reader_getinputfile(void* lpObj);
int ipworkseditranslator_x12reader_setinputfile(void* lpObj, const char* lpszInputFile);
QString GetInputFile();
int SetInputFile(QString qsInputFile);

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.

This property is not available at design time.

Data Type

String

Offset Property (X12Reader Class)

Current offset of the document being parsed.

Syntax

ANSI (Cross Platform)
int64 GetOffset();

Unicode (Windows)
LONG64 GetOffset();
int64 ipworkseditranslator_x12reader_getoffset(void* lpObj);
qint64 GetOffset();

Default Value

0

Remarks

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

This property is read-only and not available at design time.

Data Type

Long64

SchemaFormat Property (X12Reader Class)

The format of the schema file.

Syntax

ANSI (Cross Platform)
int GetSchemaFormat();
int SetSchemaFormat(int iSchemaFormat); Unicode (Windows) INT GetSchemaFormat();
INT SetSchemaFormat(INT iSchemaFormat);

Possible Values

SCHEMA_AUTOMATIC(0), 
SCHEMA_BINARY(1),
SCHEMA_BIZ_TALK(2),
SCHEMA_SEF(3),
SCHEMA_BOTS(4),
SCHEMA_ALTOVA(5),
SCHEMA_JSON(6)
int ipworkseditranslator_x12reader_getschemaformat(void* lpObj);
int ipworkseditranslator_x12reader_setschemaformat(void* lpObj, int iSchemaFormat);
int GetSchemaFormat();
int SetSchemaFormat(int iSchemaFormat);

Default Value

0

Remarks

Set SchemaFormat before calling the LoadSchema method to specify the loading schema format.

The following schema formats are supported:

0 (schemaAutomatic - default) The schema type is automatically determined based on file extension.
1 (schemaBinary) A binary schema that was previously compiled by calling CompileSchema.
2 (schemaBizTalk) BizTalk (XSD): http://msdn.microsoft.com/en-us/library/aa559426(v=BTS.70).aspx
3 (schemaSEF) TIBCO Standard Exchange Format (SEF): https://docs.tibco.com/products/tibco-foresight-edisim-6-18-0
5 (schemaAltova) Altova: http://www.altova.com/
6 (schemaJSON - recommended) ArcESB JSON: https://arc.cdata.com/

Data Type

Integer

XChildren Property (X12Reader Class)

Number of child elements of the current segment.

Syntax

ANSI (Cross Platform)
int GetXChildren();

Unicode (Windows)
INT GetXChildren();
int ipworkseditranslator_x12reader_getxchildren(void* lpObj);
int GetXChildren();

Default Value

0

Remarks

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

This property is read-only and not available at design time.

Data Type

Integer

ElementCount Property (X12Reader Class)

The number of records in the Element arrays.

Syntax

ANSI (Cross Platform)
int GetElementCount();

Unicode (Windows)
INT GetElementCount();
int ipworkseditranslator_x12reader_getelementcount(void* lpObj);
int GetElementCount();

Default Value

0

Remarks

This property controls the size of the following arrays:

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

This property is read-only and not available at design time.

Data Type

Integer

ElementComponentCount Property (X12Reader Class)

Number of classes in the current element.

Syntax

ANSI (Cross Platform)
int GetElementComponentCount(int iElementIndex);

Unicode (Windows)
INT GetElementComponentCount(INT iElementIndex);
int ipworkseditranslator_x12reader_getelementcomponentcount(void* lpObj, int elementindex);
int GetElementComponentCount(int iElementIndex);

Default Value

0

Remarks

Number of components in the current element.

The ElementIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ElementCount property.

This property is read-only and not available at design time.

Data Type

Integer

ElementComponentIndex Property (X12Reader Class)

The index of the selected class of the current element.

Syntax

ANSI (Cross Platform)
int GetElementComponentIndex(int iElementIndex);
int SetElementComponentIndex(int iElementIndex, int iElementComponentIndex); Unicode (Windows) INT GetElementComponentIndex(INT iElementIndex);
INT SetElementComponentIndex(INT iElementIndex, INT iElementComponentIndex);
int ipworkseditranslator_x12reader_getelementcomponentindex(void* lpObj, int elementindex);
int ipworkseditranslator_x12reader_setelementcomponentindex(void* lpObj, int elementindex, int iElementComponentIndex);
int GetElementComponentIndex(int iElementIndex);
int SetElementComponentIndex(int iElementIndex, int iElementComponentIndex);

Default Value

1

Remarks

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

The ElementIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ElementCount property.

This property is not available at design time.

Data Type

Integer

ElementComponentName Property (X12Reader Class)

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

Syntax

ANSI (Cross Platform)
char* GetElementComponentName(int iElementIndex);

Unicode (Windows)
LPWSTR GetElementComponentName(INT iElementIndex);
char* ipworkseditranslator_x12reader_getelementcomponentname(void* lpObj, int elementindex);
QString GetElementComponentName(int iElementIndex);

Default Value

""

Remarks

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

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

See ElementComponentSchemaName for additional details.

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

The ElementIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ElementCount property.

This property is read-only and not available at design time.

Data Type

String

ElementComponentSchemaDesc Property (X12Reader Class)

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

Syntax

ANSI (Cross Platform)
char* GetElementComponentSchemaDesc(int iElementIndex);

Unicode (Windows)
LPWSTR GetElementComponentSchemaDesc(INT iElementIndex);
char* ipworkseditranslator_x12reader_getelementcomponentschemadesc(void* lpObj, int elementindex);
QString GetElementComponentSchemaDesc(int iElementIndex);

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

This property is read-only and not available at design time.

Data Type

String

ElementComponentSchemaName Property (X12Reader Class)

The name of the class as taken from the schema.

Syntax

ANSI (Cross Platform)
char* GetElementComponentSchemaName(int iElementIndex);

Unicode (Windows)
LPWSTR GetElementComponentSchemaName(INT iElementIndex);
char* ipworkseditranslator_x12reader_getelementcomponentschemaname(void* lpObj, int elementindex);
QString GetElementComponentSchemaName(int iElementIndex);

Default Value

""

Remarks

The name of the component as taken from the schema.

ElementComponentName holds positional (ref) value like "DTM0101". ElementComponentSchemaName 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 ElementComponentSchemaName is used this will use the name from the schema and will output values like:

2005: 137
2005: 137
2380: 201612151441

In contrast, if ElementComponentName 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 ElementIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ElementCount property.

This property is read-only and not available at design time.

Data Type

String

ElementComponentType Property (X12Reader Class)

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

Syntax

ANSI (Cross Platform)
char* GetElementComponentType(int iElementIndex);

Unicode (Windows)
LPWSTR GetElementComponentType(INT iElementIndex);
char* ipworkseditranslator_x12reader_getelementcomponenttype(void* lpObj, int elementindex);
QString GetElementComponentType(int iElementIndex);

Default Value

""

Remarks

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

Possible values are:

ANAlphaNumeric
IDIdentifier; allowed values might be defined by the transaction set schema
NNumeric
RFloating-point number
DTDateTime
TMTime
NoneType is unknown or not provided by the schema
CompositeThis element has multiple components

The ElementIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ElementCount property.

This property is read-only and not available at design time.

Data Type

String

ElementComponentValue Property (X12Reader Class)

The value of the class selected by ClassIndex .

Syntax

ANSI (Cross Platform)
char* GetElementComponentValue(int iElementIndex);

Unicode (Windows)
LPWSTR GetElementComponentValue(INT iElementIndex);
char* ipworkseditranslator_x12reader_getelementcomponentvalue(void* lpObj, int elementindex);
QString GetElementComponentValue(int iElementIndex);

Default Value

""

Remarks

The value of the component selected by ElementComponentIndex.

The ElementIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ElementCount property.

This property is read-only and not available at design time.

Data Type

String

ElementDataType Property (X12Reader Class)

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

Syntax

ANSI (Cross Platform)
char* GetElementDataType(int iElementIndex);

Unicode (Windows)
LPWSTR GetElementDataType(INT iElementIndex);
char* ipworkseditranslator_x12reader_getelementdatatype(void* lpObj, int elementindex);
QString GetElementDataType(int iElementIndex);

Default Value

""

Remarks

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

Possible values are:

ANAlphaNumeric
IDIdentifier; allowed values might be defined by the transaction set schema
NNumeric
RFloating-point number
DTDateTime
TMTime
NoneType is unknown or not provided by the schema
CompositeThis element has multiple components

The ElementIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ElementCount property.

This property is read-only and not available at design time.

Data Type

String

ElementName Property (X12Reader Class)

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

Syntax

ANSI (Cross Platform)
char* GetElementName(int iElementIndex);

Unicode (Windows)
LPWSTR GetElementName(INT iElementIndex);
char* ipworkseditranslator_x12reader_getelementname(void* lpObj, int elementindex);
QString GetElementName(int iElementIndex);

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 ElementSchemaName for additional details.

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

The ElementIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ElementCount property.

This property is read-only and not available at design time.

Data Type

String

ElementRepeatCount Property (X12Reader Class)

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

Syntax

ANSI (Cross Platform)
int GetElementRepeatCount(int iElementIndex);

Unicode (Windows)
INT GetElementRepeatCount(INT iElementIndex);
int ipworkseditranslator_x12reader_getelementrepeatcount(void* lpObj, int elementindex);
int GetElementRepeatCount(int iElementIndex);

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

The ElementIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ElementCount property.

This property is read-only and not available at design time.

Data Type

Integer

ElementRepeatIndex Property (X12Reader Class)

The index of the selected instance of this repeatable element.

Syntax

ANSI (Cross Platform)
int GetElementRepeatIndex(int iElementIndex);
int SetElementRepeatIndex(int iElementIndex, int iElementRepeatIndex); Unicode (Windows) INT GetElementRepeatIndex(INT iElementIndex);
INT SetElementRepeatIndex(INT iElementIndex, INT iElementRepeatIndex);
int ipworkseditranslator_x12reader_getelementrepeatindex(void* lpObj, int elementindex);
int ipworkseditranslator_x12reader_setelementrepeatindex(void* lpObj, int elementindex, int iElementRepeatIndex);
int GetElementRepeatIndex(int iElementIndex);
int SetElementRepeatIndex(int iElementIndex, int iElementRepeatIndex);

Default Value

1

Remarks

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

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

The ElementIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ElementCount property.

This property is not available at design time.

Data Type

Integer

ElementSchemaDesc Property (X12Reader Class)

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

Syntax

ANSI (Cross Platform)
char* GetElementSchemaDesc(int iElementIndex);

Unicode (Windows)
LPWSTR GetElementSchemaDesc(INT iElementIndex);
char* ipworkseditranslator_x12reader_getelementschemadesc(void* lpObj, int elementindex);
QString GetElementSchemaDesc(int iElementIndex);

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

This property is read-only and not available at design time.

Data Type

String

ElementSchemaName Property (X12Reader Class)

The name of the element as taken from the schema.

Syntax

ANSI (Cross Platform)
char* GetElementSchemaName(int iElementIndex);

Unicode (Windows)
LPWSTR GetElementSchemaName(INT iElementIndex);
char* ipworkseditranslator_x12reader_getelementschemaname(void* lpObj, int elementindex);
QString GetElementSchemaName(int iElementIndex);

Default Value

""

Remarks

The name of the element as taken from the schema.

ElementName holds positional (ref) value like "N101". ElementSchemaName 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 ElementSchemaName 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 ElementName 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 ElementIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ElementCount property.

This property is read-only and not available at design time.

Data Type

String

ElementValue Property (X12Reader Class)

The value directly associated with this EDI element.

Syntax

ANSI (Cross Platform)
char* GetElementValue(int iElementIndex);

Unicode (Windows)
LPWSTR GetElementValue(INT iElementIndex);
char* ipworkseditranslator_x12reader_getelementvalue(void* lpObj, int elementindex);
QString GetElementValue(int iElementIndex);

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 ElementComponentName, ElementComponentType, and ElementComponentValue properties.

The ElementIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ElementCount property.

This property is read-only and not available at design time.

Data Type

String

XPath Property (X12Reader Class)

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

Syntax

ANSI (Cross Platform)
char* GetXPath();
int SetXPath(const char* lpszXPath); Unicode (Windows) LPWSTR GetXPath();
INT SetXPath(LPCWSTR lpszXPath);
char* ipworkseditranslator_x12reader_getxpath(void* lpObj);
int ipworkseditranslator_x12reader_setxpath(void* lpObj, const char* lpszXPath);
QString GetXPath();
int SetXPath(QString qsXPath);

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:

IXRefers to the Interchange (root) node
FGRefers to a Functional Group node
TXRefers to a Transaction Set node
'name'The first segment or loop of the current container with the given schema name
name[i]The i-th segment of the current container with the given schema-name
[i]The i-th segment of the current container
[last()]The last segment of the current container
[last()-i]The segment located at the last location minus i in the current container
..The parent of the current container
When XPath is set to a valid path, XSegment points to the name of the segment, with XTag, XSegmentType, and XChildren providing other properties of the segment. The elements of the current segment are provided in the XElements properties.

BuildDOM must be set to bdEntireDocument or bdTransaction prior to parsing the document for the XPath functionality to be available.

Example (Setting XPath)

Document root (Interchange)EDIReaderControl.XPath = "/"
N1 segment in the first transactionEDIReaderControl.XPath = "/IX/FG/TX/N1Loop1/N1"
3-th instance of the N2 segmentEDIReaderControl.XPath = "/IX/FG/TX/N1Loop1/N2[3]"

Data Type

String

XSegment Property (X12Reader Class)

The name of the current segment.

Syntax

ANSI (Cross Platform)
char* GetXSegment();

Unicode (Windows)
LPWSTR GetXSegment();
char* ipworkseditranslator_x12reader_getxsegment(void* lpObj);
QString GetXSegment();

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 and not available at design time.

Data Type

String

XSegmentNumber Property (X12Reader Class)

The number of the current segment.

Syntax

ANSI (Cross Platform)
int GetXSegmentNumber();

Unicode (Windows)
INT GetXSegmentNumber();
int ipworkseditranslator_x12reader_getxsegmentnumber(void* lpObj);
int GetXSegmentNumber();

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 and not available at design time.

Data Type

Integer

XSegmentType Property (X12Reader Class)

Indicates the current segment type.

Syntax

ANSI (Cross Platform)
int GetXSegmentType();

Unicode (Windows)
INT GetXSegmentType();

Possible Values

ST_NONE(0), 
ST_INTERCHANGE(1),
ST_FUNCTIONAL_GROUP(2),
ST_TRANSACTION(3),
ST_INTERCHANGE_HEADER(4),
ST_FUNCTIONAL_GROUP_HEADER(5),
ST_TRANSACTION_HEADER(6),
ST_TRANSACTION_SEGMENT(7),
ST_TRANSACTION_LOOP(8),
ST_TRANSACTION_FOOTER(9),
ST_FUNCTIONAL_GROUP_FOOTER(10),
ST_INTERCHANGE_FOOTER(11)
int ipworkseditranslator_x12reader_getxsegmenttype(void* lpObj);
int GetXSegmentType();

Default Value

0

Remarks

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

This property is read-only and not available at design time.

Data Type

Integer

XTag Property (X12Reader Class)

The tag of the current segment.

Syntax

ANSI (Cross Platform)
char* GetXTag();

Unicode (Windows)
LPWSTR GetXTag();
char* ipworkseditranslator_x12reader_getxtag(void* lpObj);
QString GetXTag();

Default Value

""

Remarks

The current segment is specified via the XPath property.

This property is read-only and not available at design time.

Data Type

String

XTransactionCode Property (X12Reader Class)

The transaction code of the current segment.

Syntax

ANSI (Cross Platform)
char* GetXTransactionCode();

Unicode (Windows)
LPWSTR GetXTransactionCode();
char* ipworkseditranslator_x12reader_getxtransactioncode(void* lpObj);
QString GetXTransactionCode();

Default Value

""

Remarks

The current segment is specified via the XPath property.

This property is read-only and not available at design time.

Data Type

String

CompileSchema Method (X12Reader Class)

Compiles an existing XSD schema into an optimized binary representation.

Syntax

ANSI (Cross Platform)
int CompileSchema(const char* lpszXsdSchema, const char* lpszBinSchema);

Unicode (Windows)
INT CompileSchema(LPCWSTR lpszXsdSchema, LPCWSTR lpszBinSchema);
int ipworkseditranslator_x12reader_compileschema(void* lpObj, const char* lpszXsdSchema, const char* lpszBinSchema);
int CompileSchema(const QString& qsXsdSchema, const QString& qsBinSchema);

Remarks

This method parses XsdSchema and generates an optimized binary representation that is saved into the path referenced by BinSchema. Binary schemas are smaller and require less resources when loading later using LoadSchema

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

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

Config Method (X12Reader Class)

Sets or retrieves a configuration setting.

Syntax

ANSI (Cross Platform)
char* Config(const char* lpszConfigurationString);

Unicode (Windows)
LPWSTR Config(LPCWSTR lpszConfigurationString);
char* ipworkseditranslator_x12reader_config(void* lpObj, const char* lpszConfigurationString);
QString Config(const QString& qsConfigurationString);

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.

Error Handling (C++)

This method returns a String value; after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.

DisplaySchemaInfo Method (X12Reader Class)

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

Syntax

ANSI (Cross Platform)
char* DisplaySchemaInfo();

Unicode (Windows)
LPWSTR DisplaySchemaInfo();
char* ipworkseditranslator_x12reader_displayschemainfo(void* lpObj);
QString DisplaySchemaInfo();

Remarks

After calling LoadSchema this may be called to obtain information about the structure of the schema defining the document. If the desired XPath is not known this helps determine the structure so that the correct XPath can be built.

Note: A valid schema must be loaded via LoadSchema.

For instance: Console.WriteLine(component.DisplaySchemaInfo()); Will output text like:

UNH[0,1]
  BGM[0,1]
  DTM[0,35]
  PAI[0,1]
  ALI[0,5]
  IMD[0,1]
  FTX[0,10]
  LOC[0,10]
  GIS[0,10]
  DGS[0,1]
  RFFLoop1[0,99]
    RFF[0,1]
    DTM_2[0,5]
    GIR[0,5]
    LOC_2[0,2]
    MEA[0,5]
    QTY[0,2]
    FTX_2[0,5]
    MOA[0,2]
  NADLoop1[0,99]
    NAD[0,1]
    LOC_3[0,25]
    FII[0,5]
    RFFLoop2[0,9999]
      RFF_2[0,1]
      DTM_3[0,5]
    DOCLoop1[0,5]
      DOC[0,1]
      DTM_4[0,5]
    CTALoop1[0,5]
      CTA[0,1]
      COM[0,5]
  TAXLoop1[0,5]
    TAX[0,1]
    MOA_2[0,1]
    LOC_4[0,5]
  CUXLoop1[0,5]
    CUX[0,1]
    DTM_5[0,5]
  PATLoop1[0,10]
    PAT[0,1]
    DTM_6[0,5]
    PCD[0,1]
    MOA_3[0,1]
    PAI_2[0,1]
    FII_2[0,1]
  TDTLoop1[0,10]
    TDT[0,1]
    TSR[0,1]
    LOCLoop1[0,10]
      LOC_5[0,1]
      DTM_7[0,5]
    RFFLoop3[0,9999]
      RFF_3[0,1]
      DTM_8[0,5]
  TODLoop1[0,5]
    TOD[0,1]
    LOC_6[0,2]
  PACLoop1[0,1000]
    PAC[0,1]
    MEA_2[0,5]
    EQD[0,1]
    PCILoop1[0,5]
      PCI[0,1]
      RFF_4[0,1]
      DTM_9[0,5]
      GIN[0,5]
  ALCLoop1[0,9999]
    ALC[0,1]
    ALI_2[0,5]
    FTX_3[0,1]
    RFFLoop4[0,5]
      RFF_5[0,1]
      DTM_10[0,5]
    QTYLoop1[0,1]
      QTY_2[0,1]
      RNG[0,1]
    PCDLoop1[0,1]
      PCD_2[0,1]
      RNG_2[0,1]
    MOALoop1[0,2]
      MOA_4[0,1]
      RNG_3[0,1]
      CUX_2[0,1]
      DTM_11[0,1]
    RTELoop1[0,1]
      RTE[0,1]
      RNG_4[0,1]
    TAXLoop2[0,5]
      TAX_2[0,1]
      MOA_5[0,1]
  RCSLoop1[0,100]
    RCS[0,1]
    RFF_6[0,5]
    DTM_12[0,5]
    FTX_4[0,5]
  AJTLoop1[0,1]
    AJT[0,1]
    FTX_5[0,5]
  INPLoop1[0,1]
    INP[0,1]
    FTX_6[0,5]
  LINLoop1[0,9999999]
    LIN[0,1]
    PIA[0,25]
    IMD_2[0,10]
    MEA_3[0,5]
    QTY_3[0,5]
    PCD_3[0,1]
    ALI_3[0,5]
    DTM_13[0,35]
    GIN_2[0,1000]
    GIR_2[0,1000]
    QVR[0,1]
    EQD_2[0,1]
    FTX_7[0,5]
    DGS_2[0,1]
    MOALoop2[0,10]
      MOA_6[0,1]
      CUX_3[0,1]
    PATLoop2[0,10]
      PAT_2[0,1]
      DTM_14[0,5]
      PCD_4[0,1]
      MOA_7[0,1]
    PRILoop1[0,25]
      PRI[0,1]
      CUX_4[0,1]
      APR[0,1]
      RNG_5[0,1]
      DTM_15[0,5]
    RFFLoop5[0,10]
      RFF_7[0,1]
      DTM_16[0,5]
    PACLoop2[0,10]
      PAC_2[0,1]
      MEA_4[0,10]
      EQD_3[0,1]
      PCILoop2[0,10]
        PCI_2[0,1]
        RFF_8[0,1]
        DTM_17[0,5]
        GIN_3[0,10]
    LOCLoop2[0,9999]
      LOC_7[0,1]
      QTY_4[0,100]
      DTM_18[0,5]
    TAXLoop3[0,99]
      TAX_3[0,1]
      MOA_8[0,1]
      LOC_8[0,5]
    NADLoop2[0,99]
      NAD_2[0,1]
      LOC_9[0,5]
      RFFLoop6[0,5]
        RFF_9[0,1]
        DTM_19[0,5]
      DOCLoop2[0,5]
        DOC_2[0,1]
        DTM_20[0,5]
      CTALoop2[0,5]
        CTA_2[0,1]
        COM_2[0,5]
    ALCLoop2[0,30]
      ALC_2[0,1]
      ALI_4[0,5]
      DTM_21[0,5]
      FTX_8[0,1]
      QTYLoop2[0,1]
        QTY_5[0,1]
        RNG_6[0,1]
      PCDLoop2[0,1]
        PCD_5[0,1]
        RNG_7[0,1]
      MOALoop3[0,2]
        MOA_9[0,1]
        RNG_8[0,1]
        CUX_5[0,1]
        DTM_22[0,1]
      RTELoop2[0,1]
        RTE_2[0,1]
        RNG_9[0,1]
      TAXLoop4[0,5]
        TAX_4[0,1]
        MOA_10[0,1]
    TDTLoop2[0,10]
      TDT_2[0,1]
      LOCLoop3[0,10]
        LOC_10[0,1]
        DTM_23[0,5]
    TODLoop2[0,5]
      TOD_2[0,1]
      LOC_11[0,2]
    RCSLoop2[0,100]
      RCS_2[0,1]
      RFF_10[0,5]
      DTM_24[0,5]
      FTX_9[0,5]
    GISLoop1[0,10]
      GIS_2[0,1]
      RFF_11[0,1]
      DTM_25[0,5]
      GIR_3[0,5]
      LOC_12[0,2]
      MEA_5[0,5]
      QTY_6[0,2]
      FTX_10[0,5]
      MOA_11[0,2]
  UNS[0,1]
  CNT[0,10]
  MOALoop4[0,100]
    MOA_12[0,1]
    RFFLoop7[0,1]
      RFF_12[0,1]
      DTM_26[0,5]
  TAXLoop5[0,10]
    TAX_5[0,1]
    MOA_13[0,2]
  ALCLoop3[0,15]
    ALC_3[0,1]
    ALI_5[0,1]
    MOA_14[0,2]
    FTX_11[0,1]
  UNT[0,1]

Error Handling (C++)

This method returns a String value; after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.

DisplayXMLInfo Method (X12Reader Class)

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

Syntax

ANSI (Cross Platform)
char* DisplayXMLInfo();

Unicode (Windows)
LPWSTR DisplayXMLInfo();
char* ipworkseditranslator_x12reader_displayxmlinfo(void* lpObj);
QString DisplayXMLInfo();

Remarks

After the EDI document has been parsed this method may be called to obtain information about the document structure. The parsed data is represented as XML when queried. This shows all parsed data and may be useful for testing and debugging purposes. For instance: Console.WriteLine(component.DisplayXMLInfo()); Will output text like:

<IX tag="UNB" UNB1="UNOB:1" UNB2="WAYNE_TECH" UNB3="ACME" UNB4="160707:1547" UNB5="000000002" UNB6="" UNB7="1234" UNB8="" UNB9="" UNB10="" UNB11="1">
  <TX tag="UNH" UNH1="509010117" UNH2="INVOIC:D:97A:UN">
    <BGM tag="BGM" BGM01="380:::TAX INVOICE" BGM02="0013550417" BGM03="9"/>
    <DTM tag="DTM" DTM01="3:20070926:102"/>
    <DTM tag="DTM" DTM01="4:20061123:102"/>
    <FTX tag="FTX" FTX01="AAI" FTX02="1"/>
    <TAXLoop1>
      <TAX tag="TAX" TAX01="7" TAX02="VAT" TAX03="" TAX04="" TAX05=":::10072.14" TAX06="S"/>
    </TAXLoop1>
    <CUXLoop1>
      <CUX tag="CUX" CUX01="2:EUR:4" CUX02="" CUX03="0.67529"/>
    </CUXLoop1>
    <PATLoop1>
      <PAT tag="PAT" PAT01="1"/>
      <DTM_6 tag="DTM" DTM01="10:20070926:102"/>
      <PCD tag="PCD" PCD01="2:0:13"/>
    </PATLoop1>
    <LINLoop1>
      <LIN tag="LIN" LIN01="000030" LIN02=""/>
      <PIA tag="PIA" PIA01="1" PIA02="2265S13:BP::92"/>
      <PIA tag="PIA" PIA01="1" PIA02="5029766832002:UP::92"/>
      <IMD_2 tag="IMD" IMD01="F" IMD02=""/>
      <QTY_3 tag="QTY" QTY01="47:50.000:EA"/>
      <DTM_13 tag="DTM" DTM01="11:20070926:102"/>
      <MOALoop2>
        <MOA_6 tag="MOA" MOA01="203:19150.00"/>
      </MOALoop2>
      <PRILoop1>
        <PRI tag="PRI" PRI01="INV:383.00:TU"/>
      </PRILoop1>
      <TAXLoop3>
        <TAX_3 tag="TAX" TAX01="7" TAX02="VAT" TAX03="" TAX04="" TAX05=":::17.500" TAX06="S"/>
        <MOA_8 tag="MOA" MOA01="125:19150.45"/>
      </TAXLoop3>
      <ALCLoop2>
        <ALC_2 tag="ALC" ALC01="C" ALC02="0.45" ALC03="" ALC04="" ALC05="FC"/>
        <MOALoop3>
          <MOA_9 tag="MOA" MOA01="8:0.45"/>
        </MOALoop3>
      </ALCLoop2>
    </LINLoop1>
    <LINLoop1>
      <LIN tag="LIN" LIN01="000040" LIN02=""/>
      <PIA tag="PIA" PIA01="1" PIA02="2269F22:BP::92"/>
      <PIA tag="PIA" PIA01="1" PIA02="5051254078241:UP::92"/>
      <IMD_2 tag="IMD" IMD01="F" IMD02=""/>
      <QTY_3 tag="QTY" QTY01="47:20.000:EA"/>
      <DTM_13 tag="DTM" DTM01="11:20070926:102"/>
      <MOALoop2>
        <MOA_6 tag="MOA" MOA01="203:21060.00"/>
      </MOALoop2>
      <PRILoop1>
        <PRI tag="PRI" PRI01="INV:1053.00:TU"/>
      </PRILoop1>
      <TAXLoop3>
        <TAX_3 tag="TAX" TAX01="7" TAX02="VAT" TAX03="" TAX04="" TAX05=":::17.500" TAX06="S"/>
        <MOA_8 tag="MOA" MOA01="125:21060.50"/>
      </TAXLoop3>
      <ALCLoop2>
        <ALC_2 tag="ALC" ALC01="C" ALC02="0.50" ALC03="" ALC04="" ALC05="FC"/>
        <MOALoop3>
          <MOA_9 tag="MOA" MOA01="8:0.50"/>
        </MOALoop3>
      </ALCLoop2>
    </LINLoop1>
    <LINLoop1>
      <LIN tag="LIN" LIN01="000170" LIN02=""/>
      <PIA tag="PIA" PIA01="1" PIA02="2269F10:BP::92"/>
      <PIA tag="PIA" PIA01="1" PIA02="5051254078326:UP::92"/>
      <IMD_2 tag="IMD" IMD01="F" IMD02=""/>
      <QTY_3 tag="QTY" QTY01="47:10.000:EA"/>
      <DTM_13 tag="DTM" DTM01="11:20070926:102"/>
      <MOALoop2>
        <MOA_6 tag="MOA" MOA01="203:6950.00"/>
      </MOALoop2>
      <PRILoop1>
        <PRI tag="PRI" PRI01="INV:695.00:TU"/>
      </PRILoop1>
      <TAXLoop3>
        <TAX_3 tag="TAX" TAX01="7" TAX02="VAT" TAX03="" TAX04="" TAX05=":::17.500" TAX06="S"/>
        <MOA_8 tag="MOA" MOA01="125:6950.16"/>
      </TAXLoop3>
      <ALCLoop2>
        <ALC_2 tag="ALC" ALC01="C" ALC02="0.16" ALC03="" ALC04="" ALC05="FC"/>
        <MOALoop3>
          <MOA_9 tag="MOA" MOA01="8:0.16"/>
        </MOALoop3>
      </ALCLoop2>
    </LINLoop1>
    <LINLoop1>
      <LIN tag="LIN" LIN01="000190" LIN02=""/>
      <PIA tag="PIA" PIA01="1" PIA02="2269F26:BP::92"/>
      <PIA tag="PIA" PIA01="1" PIA02="5051254051190:UP::92"/>
      <IMD_2 tag="IMD" IMD01="F" IMD02=""/>
      <QTY_3 tag="QTY" QTY01="47:5.000:EA"/>
      <DTM_13 tag="DTM" DTM01="11:20070926:102"/>
      <MOALoop2>
        <MOA_6 tag="MOA" MOA01="203:2375.00"/>
      </MOALoop2>
      <PRILoop1>
        <PRI tag="PRI" PRI01="INV:475.00:TU"/>
      </PRILoop1>
      <TAXLoop3>
        <TAX_3 tag="TAX" TAX01="7" TAX02="VAT" TAX03="" TAX04="" TAX05=":::17.500" TAX06="S"/>
        <MOA_8 tag="MOA" MOA01="125:2375.06"/>
      </TAXLoop3>
      <ALCLoop2>
        <ALC_2 tag="ALC" ALC01="C" ALC02="0.06" ALC03="" ALC04="" ALC05="FC"/>
        <MOALoop3>
          <MOA_9 tag="MOA" MOA01="8:0.06"/>
        </MOALoop3>
      </ALCLoop2>
    </LINLoop1>
    <LINLoop1>
      <LIN tag="LIN" LIN01="000200" LIN02=""/>
      <PIA tag="PIA" PIA01="1" PIA02="2265S24:BP::92"/>
      <PIA tag="PIA" PIA01="1" PIA02="5029766000685:UP::92"/>
      <IMD_2 tag="IMD" IMD01="F" IMD02=""/>
      <QTY_3 tag="QTY" QTY01="47:3.000:EA"/>
      <DTM_13 tag="DTM" DTM01="11:20070926:102"/>
      <MOALoop2>
        <MOA_6 tag="MOA" MOA01="203:957.00"/>
      </MOALoop2>
      <PRILoop1>
        <PRI tag="PRI" PRI01="INV:319.00:TU"/>
      </PRILoop1>
      <TAXLoop3>
        <TAX_3 tag="TAX" TAX01="7" TAX02="VAT" TAX03="" TAX04="" TAX05=":::17.500" TAX06="S"/>
        <MOA_8 tag="MOA" MOA01="125:957.02"/>
      </TAXLoop3>
      <ALCLoop2>
        <ALC_2 tag="ALC" ALC01="C" ALC02="0.02" ALC03="" ALC04="" ALC05="FC"/>
        <MOALoop3>
          <MOA_9 tag="MOA" MOA01="8:0.02"/>
        </MOALoop3>
      </ALCLoop2>
    </LINLoop1>
    <LINLoop1>
      <LIN tag="LIN" LIN01="000210" LIN02=""/>
      <PIA tag="PIA" PIA01="1" PIA02="2263T95:BP::92"/>
      <PIA tag="PIA" PIA01="1" PIA02="5029766699575:UP::92"/>
      <IMD_2 tag="IMD" IMD01="F" IMD02=""/>
      <QTY_3 tag="QTY" QTY01="47:3.000:EA"/>
      <DTM_13 tag="DTM" DTM01="11:20070926:102"/>
      <MOALoop2>
        <MOA_6 tag="MOA" MOA01="203:2085.00"/>
      </MOALoop2>
      <PRILoop1>
        <PRI tag="PRI" PRI01="INV:695.00:TU"/>
      </PRILoop1>
      <TAXLoop3>
        <TAX_3 tag="TAX" TAX01="7" TAX02="VAT" TAX03="" TAX04="" TAX05=":::17.500" TAX06="S"/>
        <MOA_8 tag="MOA" MOA01="125:2085.05"/>
      </TAXLoop3>
      <ALCLoop2>
        <ALC_2 tag="ALC" ALC01="C" ALC02="0.05" ALC03="" ALC04="" ALC05="FC"/>
        <MOALoop3>
          <MOA_9 tag="MOA" MOA01="8:0.05"/>
        </MOALoop3>
      </ALCLoop2>
    </LINLoop1>
    <LINLoop1>
      <LIN tag="LIN" LIN01="000250" LIN02=""/>
      <PIA tag="PIA" PIA01="1" PIA02="2269F15:BP::92"/>
      <PIA tag="PIA" PIA01="1" PIA02="5051254080091:UP::92"/>
      <IMD_2 tag="IMD" IMD01="F" IMD02=""/>
      <QTY_3 tag="QTY" QTY01="47:3.000:EA"/>
      <DTM_13 tag="DTM" DTM01="11:20070926:102"/>
      <MOALoop2>
        <MOA_6 tag="MOA" MOA01="203:4977.00"/>
      </MOALoop2>
      <PRILoop1>
        <PRI tag="PRI" PRI01="INV:1659.00:TU"/>
      </PRILoop1>
      <TAXLoop3>
        <TAX_3 tag="TAX" TAX01="7" TAX02="VAT" TAX03="" TAX04="" TAX05=":::17.500" TAX06="S"/>
        <MOA_8 tag="MOA" MOA01="125:4977.12"/>
      </TAXLoop3>
      <ALCLoop2>
        <ALC_2 tag="ALC" ALC01="C" ALC02="0.12" ALC03="" ALC04="" ALC05="FC"/>
        <MOALoop3>
          <MOA_9 tag="MOA" MOA01="8:0.12"/>
        </MOALoop3>
      </ALCLoop2>
    </LINLoop1>
    <UNS tag="UNS" UNS01="S"/>
    <CNT tag="CNT" CNT01="4:7"/>
    <MOALoop4>
      <MOA_12 tag="MOA" MOA01="9:67627.50"/>
    </MOALoop4>
    <MOALoop4>
      <MOA_12 tag="MOA" MOA01="79:57554.00"/>
    </MOALoop4>
    <TAXLoop5>
      <TAX_5 tag="TAX" TAX01="7" TAX02="VAT" TAX03="" TAX04="" TAX05=":::17.500" TAX06="S"/>
      <MOA_13 tag="MOA" MOA01="125:57555.36:EUR:3"/>
      <MOA_13 tag="MOA" MOA01="124:10072.14:EUR:3"/>
    </TAXLoop5>
    <ALCLoop3>
      <ALC_3 tag="ALC" ALC01="C" ALC02="1.36" ALC03="" ALC04="" ALC05="FC"/>
      <MOA_14 tag="MOA" MOA01="8:1.36"/>
    </ALCLoop3>
  </TX>
</IX>

Error Handling (C++)

This method returns a String value; after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.

Flush Method (X12Reader Class)

Flushes the parser and checks its end state.

Syntax

ANSI (Cross Platform)
int Flush();

Unicode (Windows)
INT Flush();
int ipworkseditranslator_x12reader_flush(void* lpObj);
int Flush();

Remarks

When Flush is called, the parser flushes all its buffers, firing events as necessary, and then checks its end state.

Any extra un-parsed data will be populated in the ExtraData property after this method is called.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

GenerateAck Method (X12Reader Class)

Generates an EDI acknowledgement.

Syntax

ANSI (Cross Platform)
char* GenerateAck();

Unicode (Windows)
LPWSTR GenerateAck();
char* ipworkseditranslator_x12reader_generateack(void* lpObj);
QString GenerateAck();

Remarks

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

Error Handling (C++)

This method returns a String value; after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.

HasXPath Method (X12Reader Class)

Determines whether a specific element exists in the document.

Syntax

ANSI (Cross Platform)
int HasXPath(const char* lpszXPath);

Unicode (Windows)
INT HasXPath(LPCWSTR lpszXPath);
int ipworkseditranslator_x12reader_hasxpath(void* lpObj, const char* lpszXPath);
bool HasXPath(const QString& qsXPath);

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.

Error Handling (C++)

This method returns a Boolean value; after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.

LoadSchema Method (X12Reader Class)

Loads a schema file describing a Transaction Set.

Syntax

ANSI (Cross Platform)
int LoadSchema(const char* lpszFileName);

Unicode (Windows)
INT LoadSchema(LPCWSTR lpszFileName);
int ipworkseditranslator_x12reader_loadschema(void* lpObj, const char* lpszFileName);
int LoadSchema(const QString& qsFileName);

Remarks

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

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

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

Parse Method (X12Reader Class)

Parse the specified input data.

Syntax

ANSI (Cross Platform)
int Parse();

Unicode (Windows)
INT Parse();
int ipworkseditranslator_x12reader_parse(void* lpObj);
int Parse();

Remarks

This method parsed the input data specified by InputFile or InputData.

During parsing the following events may fire:

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:

When a valid source is found the search stops.

InputData Notes

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

When the parser is finally reset via the Reset method, all buffered text is flushed out through the ExtraData 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.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

Reset Method (X12Reader Class)

Resets the parser.

Syntax

ANSI (Cross Platform)
int Reset();

Unicode (Windows)
INT Reset();
int ipworkseditranslator_x12reader_reset(void* lpObj);
int Reset();

Remarks

When called, the parser flushes all its buffers, firing events as necessary, and then initializes itself to its default state.

Reset must also be used as signal to the parser that the current stream of text has terminated.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

TryXPath Method (X12Reader Class)

Navigates to the specified XPath if it exists.

Syntax

ANSI (Cross Platform)
int TryXPath(const char* lpszxpath);

Unicode (Windows)
INT TryXPath(LPCWSTR lpszxpath);
int ipworkseditranslator_x12reader_tryxpath(void* lpObj, const char* lpszxpath);
bool TryXPath(const QString& qsxpath);

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.

Error Handling (C++)

This method returns a Boolean value; after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.

EndFunctionalGroup Event (X12Reader Class)

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

Syntax

ANSI (Cross Platform)
virtual int FireEndFunctionalGroup(X12ReaderEndFunctionalGroupEventParams *e);
typedef struct {
const char *Tag;
const char *ControlNumber;
int Count;
const char *FullSegment; int reserved; } X12ReaderEndFunctionalGroupEventParams;
Unicode (Windows) virtual INT FireEndFunctionalGroup(X12ReaderEndFunctionalGroupEventParams *e);
typedef struct {
LPCWSTR Tag;
LPCWSTR ControlNumber;
INT Count;
LPCWSTR FullSegment; INT reserved; } X12ReaderEndFunctionalGroupEventParams;
#define EID_X12READER_ENDFUNCTIONALGROUP 1

virtual INT IPWORKSEDITRANSLATOR_CALL FireEndFunctionalGroup(LPSTR &lpszTag, LPSTR &lpszControlNumber, INT &iCount, LPSTR &lpszFullSegment);
class X12ReaderEndFunctionalGroupEventParams {
public:
  const QString &Tag();

  const QString &ControlNumber();

  int Count();

  const QString &FullSegment();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};
// To handle, connect one or more slots to this signal. void EndFunctionalGroup(X12ReaderEndFunctionalGroupEventParams *e);
// Or, subclass X12Reader and override this emitter function. virtual int FireEndFunctionalGroup(X12ReaderEndFunctionalGroupEventParams *e) {...}

Remarks

The EndFunctionalGroup event will fire when a control segment marking the end of a functional group is read. The Tag parameter contains the tag of the segment, such as GE. ControlNumber contains the control number associated with the segment, and links this event with the corresponding StartFunctionalGroup event. Count contains the value of the count element included in the closing segment, which identifies the number of transactions in a functional group.

EndInterchange Event (X12Reader Class)

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

Syntax

ANSI (Cross Platform)
virtual int FireEndInterchange(X12ReaderEndInterchangeEventParams *e);
typedef struct {
const char *Tag;
const char *ControlNumber;
const char *FullSegment; int reserved; } X12ReaderEndInterchangeEventParams;
Unicode (Windows) virtual INT FireEndInterchange(X12ReaderEndInterchangeEventParams *e);
typedef struct {
LPCWSTR Tag;
LPCWSTR ControlNumber;
LPCWSTR FullSegment; INT reserved; } X12ReaderEndInterchangeEventParams;
#define EID_X12READER_ENDINTERCHANGE 2

virtual INT IPWORKSEDITRANSLATOR_CALL FireEndInterchange(LPSTR &lpszTag, LPSTR &lpszControlNumber, LPSTR &lpszFullSegment);
class X12ReaderEndInterchangeEventParams {
public:
  const QString &Tag();

  const QString &ControlNumber();

  const QString &FullSegment();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};
// To handle, connect one or more slots to this signal. void EndInterchange(X12ReaderEndInterchangeEventParams *e);
// Or, subclass X12Reader and override this emitter function. virtual int FireEndInterchange(X12ReaderEndInterchangeEventParams *e) {...}

Remarks

The EndInterchange event will fire when a control segment marking the end of an interchange is read. The Tag parameter contains the tag of the segment, such as IEA. ControlNumber contains the control number associated with the segment, and links this event with the corresponding StartInterchange event.

EndLoop Event (X12Reader Class)

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

Syntax

ANSI (Cross Platform)
virtual int FireEndLoop(X12ReaderEndLoopEventParams *e);
typedef struct { int reserved; } X12ReaderEndLoopEventParams;
Unicode (Windows) virtual INT FireEndLoop(X12ReaderEndLoopEventParams *e);
typedef struct { INT reserved; } X12ReaderEndLoopEventParams;
#define EID_X12READER_ENDLOOP 3

virtual INT IPWORKSEDITRANSLATOR_CALL FireEndLoop();
class X12ReaderEndLoopEventParams {
public:
  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};
// To handle, connect one or more slots to this signal. void EndLoop(X12ReaderEndLoopEventParams *e);
// Or, subclass X12Reader and override this emitter function. virtual int FireEndLoop(X12ReaderEndLoopEventParams *e) {...}

Remarks

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

EndTransaction Event (X12Reader Class)

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

Syntax

ANSI (Cross Platform)
virtual int FireEndTransaction(X12ReaderEndTransactionEventParams *e);
typedef struct {
const char *Tag;
const char *ControlNumber;
int Count;
const char *FullSegment; int reserved; } X12ReaderEndTransactionEventParams;
Unicode (Windows) virtual INT FireEndTransaction(X12ReaderEndTransactionEventParams *e);
typedef struct {
LPCWSTR Tag;
LPCWSTR ControlNumber;
INT Count;
LPCWSTR FullSegment; INT reserved; } X12ReaderEndTransactionEventParams;
#define EID_X12READER_ENDTRANSACTION 4

virtual INT IPWORKSEDITRANSLATOR_CALL FireEndTransaction(LPSTR &lpszTag, LPSTR &lpszControlNumber, INT &iCount, LPSTR &lpszFullSegment);
class X12ReaderEndTransactionEventParams {
public:
  const QString &Tag();

  const QString &ControlNumber();

  int Count();

  const QString &FullSegment();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};
// To handle, connect one or more slots to this signal. void EndTransaction(X12ReaderEndTransactionEventParams *e);
// Or, subclass X12Reader and override this emitter function. virtual int FireEndTransaction(X12ReaderEndTransactionEventParams *e) {...}

Remarks

The EndTransaction event will fire when a control segment marking the end of a transaction is read. The Tag parameter contains the tag of the segment, such as SE. ControlNumber contains the control number associated with the segment, and links this event with the corresponding StartTransaction event. Count contains the value of the count element included in the closing segment, which identifies the number of segments in a transaction set.

Error Event (X12Reader Class)

Information about errors during data delivery.

Syntax

ANSI (Cross Platform)
virtual int FireError(X12ReaderErrorEventParams *e);
typedef struct {
int ErrorCode;
const char *Description; int reserved; } X12ReaderErrorEventParams;
Unicode (Windows) virtual INT FireError(X12ReaderErrorEventParams *e);
typedef struct {
INT ErrorCode;
LPCWSTR Description; INT reserved; } X12ReaderErrorEventParams;
#define EID_X12READER_ERROR 5

virtual INT IPWORKSEDITRANSLATOR_CALL FireError(INT &iErrorCode, LPSTR &lpszDescription);
class X12ReaderErrorEventParams {
public:
  int ErrorCode();

  const QString &Description();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};
// To handle, connect one or more slots to this signal. void Error(X12ReaderErrorEventParams *e);
// Or, subclass X12Reader and override this emitter function. virtual int FireError(X12ReaderErrorEventParams *e) {...}

Remarks

The Error event is fired in case of exceptional conditions during message processing. Normally the class fails with an error.

ErrorCode contains an error code and Description contains a textual description of the error. For a list of valid error codes and their descriptions, please refer to the Error Codes section.

ResolveSchema Event (X12Reader Class)

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

Syntax

ANSI (Cross Platform)
virtual int FireResolveSchema(X12ReaderResolveSchemaEventParams *e);
typedef struct {
const char *TransactionCode;
const char *StandardVersion; int reserved; } X12ReaderResolveSchemaEventParams;
Unicode (Windows) virtual INT FireResolveSchema(X12ReaderResolveSchemaEventParams *e);
typedef struct {
LPCWSTR TransactionCode;
LPCWSTR StandardVersion; INT reserved; } X12ReaderResolveSchemaEventParams;
#define EID_X12READER_RESOLVESCHEMA 6

virtual INT IPWORKSEDITRANSLATOR_CALL FireResolveSchema(LPSTR &lpszTransactionCode, LPSTR &lpszStandardVersion);
class X12ReaderResolveSchemaEventParams {
public:
  const QString &TransactionCode();

  const QString &StandardVersion();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};
// To handle, connect one or more slots to this signal. void ResolveSchema(X12ReaderResolveSchemaEventParams *e);
// Or, subclass X12Reader and override this emitter function. virtual int FireResolveSchema(X12ReaderResolveSchemaEventParams *e) {...}

Remarks

The ResolveSchema event will fire when a the class encounters the header segment of a new transaction set, but it finds no schema corresponding to it already loaded.

TransactionCode contains the code of the transaction, such as "810" or "APERAK".

StandardVersion contains the version of the transaction, such as "004010" or "D95A".

When processing this event, the caller can use LoadSchema() to load a new schema into the class that can be used to parse the transaction.

After the event fires, if the class still doesn't have a matching schema, then it will attempt schema-less parsing of the transaction set.

Segment Event (X12Reader Class)

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

Syntax

ANSI (Cross Platform)
virtual int FireSegment(X12ReaderSegmentEventParams *e);
typedef struct {
const char *Tag;
const char *Name;
const char *LoopName;
const char *FullSegment; int reserved; } X12ReaderSegmentEventParams;
Unicode (Windows) virtual INT FireSegment(X12ReaderSegmentEventParams *e);
typedef struct {
LPCWSTR Tag;
LPCWSTR Name;
LPCWSTR LoopName;
LPCWSTR FullSegment; INT reserved; } X12ReaderSegmentEventParams;
#define EID_X12READER_SEGMENT 7

virtual INT IPWORKSEDITRANSLATOR_CALL FireSegment(LPSTR &lpszTag, LPSTR &lpszName, LPSTR &lpszLoopName, LPSTR &lpszFullSegment);
class X12ReaderSegmentEventParams {
public:
  const QString &Tag();

  const QString &Name();

  const QString &LoopName();

  const QString &FullSegment();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};
// To handle, connect one or more slots to this signal. void Segment(X12ReaderSegmentEventParams *e);
// Or, subclass X12Reader and override this emitter function. virtual int FireSegment(X12ReaderSegmentEventParams *e) {...}

Remarks

The Segment event will fire when a data segment is read. The Tag parameter contains the tag of the segment. Name contains the name of the segment as defined in the associated transaction set schema. LoopName contains the name of the loop or group this segment is present in (such as N1Loop1).

StartFunctionalGroup Event (X12Reader Class)

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

Syntax

ANSI (Cross Platform)
virtual int FireStartFunctionalGroup(X12ReaderStartFunctionalGroupEventParams *e);
typedef struct {
const char *Tag;
const char *ControlNumber;
const char *FullSegment; int reserved; } X12ReaderStartFunctionalGroupEventParams;
Unicode (Windows) virtual INT FireStartFunctionalGroup(X12ReaderStartFunctionalGroupEventParams *e);
typedef struct {
LPCWSTR Tag;
LPCWSTR ControlNumber;
LPCWSTR FullSegment; INT reserved; } X12ReaderStartFunctionalGroupEventParams;
#define EID_X12READER_STARTFUNCTIONALGROUP 8

virtual INT IPWORKSEDITRANSLATOR_CALL FireStartFunctionalGroup(LPSTR &lpszTag, LPSTR &lpszControlNumber, LPSTR &lpszFullSegment);
class X12ReaderStartFunctionalGroupEventParams {
public:
  const QString &Tag();

  const QString &ControlNumber();

  const QString &FullSegment();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};
// To handle, connect one or more slots to this signal. void StartFunctionalGroup(X12ReaderStartFunctionalGroupEventParams *e);
// Or, subclass X12Reader and override this emitter function. virtual int FireStartFunctionalGroup(X12ReaderStartFunctionalGroupEventParams *e) {...}

Remarks

The StartFunctionalGroup event will fire when a control segment marking the start of a functional group structure is read. The Tag parameter contains the tag of the segment, such as GS. ControlNumber contains the control number associated with the segment.

StartInterchange Event (X12Reader Class)

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

Syntax

ANSI (Cross Platform)
virtual int FireStartInterchange(X12ReaderStartInterchangeEventParams *e);
typedef struct {
const char *Tag;
const char *ControlNumber;
const char *FullSegment; int reserved; } X12ReaderStartInterchangeEventParams;
Unicode (Windows) virtual INT FireStartInterchange(X12ReaderStartInterchangeEventParams *e);
typedef struct {
LPCWSTR Tag;
LPCWSTR ControlNumber;
LPCWSTR FullSegment; INT reserved; } X12ReaderStartInterchangeEventParams;
#define EID_X12READER_STARTINTERCHANGE 9

virtual INT IPWORKSEDITRANSLATOR_CALL FireStartInterchange(LPSTR &lpszTag, LPSTR &lpszControlNumber, LPSTR &lpszFullSegment);
class X12ReaderStartInterchangeEventParams {
public:
  const QString &Tag();

  const QString &ControlNumber();

  const QString &FullSegment();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};
// To handle, connect one or more slots to this signal. void StartInterchange(X12ReaderStartInterchangeEventParams *e);
// Or, subclass X12Reader and override this emitter function. virtual int FireStartInterchange(X12ReaderStartInterchangeEventParams *e) {...}

Remarks

The StartInterchange event will fire when a control segment marking the start of an interchange structure is read. The Tag parameter contains the tag of the segment, such as ISA. ControlNumber contains the control number associated with the segment.

StartLoop Event (X12Reader Class)

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

Syntax

ANSI (Cross Platform)
virtual int FireStartLoop(X12ReaderStartLoopEventParams *e);
typedef struct {
const char *Name; int reserved; } X12ReaderStartLoopEventParams;
Unicode (Windows) virtual INT FireStartLoop(X12ReaderStartLoopEventParams *e);
typedef struct {
LPCWSTR Name; INT reserved; } X12ReaderStartLoopEventParams;
#define EID_X12READER_STARTLOOP 10

virtual INT IPWORKSEDITRANSLATOR_CALL FireStartLoop(LPSTR &lpszName);
class X12ReaderStartLoopEventParams {
public:
  const QString &Name();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};
// To handle, connect one or more slots to this signal. void StartLoop(X12ReaderStartLoopEventParams *e);
// Or, subclass X12Reader and override this emitter function. virtual int FireStartLoop(X12ReaderStartLoopEventParams *e) {...}

Remarks

The StartLoop event will fire when the tag of a loop trigger segment is read. The Name parameter contains the schema-provided name of the loop, such as "N1Loop1".

StartTransaction Event (X12Reader Class)

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

Syntax

ANSI (Cross Platform)
virtual int FireStartTransaction(X12ReaderStartTransactionEventParams *e);
typedef struct {
const char *Tag;
const char *ControlNumber;
const char *Code;
const char *FullSegment; int reserved; } X12ReaderStartTransactionEventParams;
Unicode (Windows) virtual INT FireStartTransaction(X12ReaderStartTransactionEventParams *e);
typedef struct {
LPCWSTR Tag;
LPCWSTR ControlNumber;
LPCWSTR Code;
LPCWSTR FullSegment; INT reserved; } X12ReaderStartTransactionEventParams;
#define EID_X12READER_STARTTRANSACTION 11

virtual INT IPWORKSEDITRANSLATOR_CALL FireStartTransaction(LPSTR &lpszTag, LPSTR &lpszControlNumber, LPSTR &lpszCode, LPSTR &lpszFullSegment);
class X12ReaderStartTransactionEventParams {
public:
  const QString &Tag();

  const QString &ControlNumber();

  const QString &Code();

  const QString &FullSegment();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};
// To handle, connect one or more slots to this signal. void StartTransaction(X12ReaderStartTransactionEventParams *e);
// Or, subclass X12Reader and override this emitter function. virtual int FireStartTransaction(X12ReaderStartTransactionEventParams *e) {...}

Remarks

The StartTransaction event will fire when a control segment marking the start of a transaction is read. The Tag parameter contains the tag of the segment, such as ST. ControlNumber contains the control number associated with the segment. Code contains the transaction code (such as 810).

Warning Event (X12Reader Class)

Fires whenever a validation warning is encountered.

Syntax

ANSI (Cross Platform)
virtual int FireWarning(X12ReaderWarningEventParams *e);
typedef struct {
int WarnCode;
const char *Message;
int SegmentNumber;
const char *SegmentTag;
const char *TechnicalErrorCode;
const char *SegmentErrorCode;
const char *ElementErrorCode;
int ElementPosition; int reserved; } X12ReaderWarningEventParams;
Unicode (Windows) virtual INT FireWarning(X12ReaderWarningEventParams *e);
typedef struct {
INT WarnCode;
LPCWSTR Message;
INT SegmentNumber;
LPCWSTR SegmentTag;
LPCWSTR TechnicalErrorCode;
LPCWSTR SegmentErrorCode;
LPCWSTR ElementErrorCode;
INT ElementPosition; INT reserved; } X12ReaderWarningEventParams;
#define EID_X12READER_WARNING 12

virtual INT IPWORKSEDITRANSLATOR_CALL FireWarning(INT &iWarnCode, LPSTR &lpszMessage, INT &iSegmentNumber, LPSTR &lpszSegmentTag, LPSTR &lpszTechnicalErrorCode, LPSTR &lpszSegmentErrorCode, LPSTR &lpszElementErrorCode, INT &iElementPosition);
class X12ReaderWarningEventParams {
public:
  int WarnCode();

  const QString &Message();

  int SegmentNumber();

  const QString &SegmentTag();

  const QString &TechnicalErrorCode();

  const QString &SegmentErrorCode();

  const QString &ElementErrorCode();

  int ElementPosition();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};
// To handle, connect one or more slots to this signal. void Warning(X12ReaderWarningEventParams *e);
// Or, subclass X12Reader and override this emitter function. virtual int FireWarning(X12ReaderWarningEventParams *e) {...}

Remarks

The 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 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 Warning event when the event fires.

Possible WarnCode 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.

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

Config Settings (X12Reader Class)

The class accepts one or more of the following configuration settings. Configuration settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, access to these internal properties is provided through the Config method.

X12READER Config Settings

ComponentDelimiter:   The delimiter separating components.

After parsing an EDI document, this configuration option will return the delimiter used to separate components within data elements of the EDI document.

This configuration option may be set in the StartInterchange event to specify the delimiter to be used.

CrossFieldValidationEnabled:   Enables cross-field validation rules.

If true, cross-field validation rules present in the document schema will be checked. The default value is false. 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 StartInterchange event to specify the delimiter to be used.

Encoding:   The character encoding to be applied when reading and writing data.

If the data contains non-ASCII characters this setting should be specified so characters are properly preserved. This value should be set to a valid character set such as "UTF-8" or "ISO-8859-1".

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]"));

ReleaseChar:   The character used to escape delimiters within values.

After parsing an EDI document, this configuration option will return the escape character used to escape delimiters within values within the EDI document.

This configuration option may be set in the StartInterchange event to specify the escape character to be used.

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

When true, the class will fully resolve a detailed path when XPath is specified. In this case, the XPath property will contain the XSegment s name as well as the indices when queried after being set.

If this value is set to false, the exact string will be returned when the XPath property is queried from the last time it was set.

For example, the following code will print the string "/[1]/[1]/[1]/[10]" when this value is false, and would print "/IX[1]/FG[1]/TX[1]/IT1Loop1[4]" when this value is true: 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 StartInterchange event to specify the delimiter to be used.

StrictSchemaValidation:   Specifies the behavior during schema validation.

This setting specifies what happens when performing schema validation and a validation warning occurs. By default this value is set to 1 (Warn) and the Warning event will fire, but processing will not stop. See the WarnCode parameter list in the Warning event for details about possible validation warnings. Possible values for this setting are:

0 (Ignore) All validation warnings will be ignored. Warning will not fire with warnings.
1 (Warn - default) The Warning event will fire with all validation warnings.
2 (Error) All validation warnings are treated as errors and will cause an exception. Processing will stop immediately.

Base Config Settings

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 DoEvents 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:   Tells the class 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 setting to true tells the class to use the internal implementation instead of using the system security libraries.

On Windows, this setting is set to false by default. On Linux/macOS, this setting is set to true by default.

To use the system security libraries for Linux, OpenSSL support must be enabled. For more information on how to enable OpenSSL, please refer to the OpenSSL Notes section.

Trappable Errors (X12Reader Class)

Error Handling (C++)

Call the GetLastErrorCode() method to obtain the last called method's result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. Known error codes are listed below. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.

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