VDAReader Class

Properties   Methods   Events   Config Settings   Errors  

The VDAReader class is optimized for VDA documents, providing a simple way to parse VDA documents.

Syntax

VDAReader

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.

Method List

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

Event List

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

Config Settings

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

BuildDOM Property (VDAReader Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetBuildDOM();
int SetBuildDOM(int iBuildDOM);

Unicode (Windows)
INT GetBuildDOM();
INT SetBuildDOM(INT iBuildDOM);

BD_ENTIRE_DOCUMENT(0), 
BD_INTERCHANGE(1), 
BD_TRANSACTION(2), 
BD_NONE(3)

int ipworksedi_vdareader_getbuilddom(void* lpObj);
int ipworksedi_vdareader_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 (VDAReader Class)

The version of the EDI specification.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetEDIStandardVersion();

Unicode (Windows)
LPWSTR GetEDIStandardVersion();

char* ipworksedi_vdareader_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 (VDAReader Class)

Extra data that has not been parsed by the class.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetExtraData();

Unicode (Windows)
LPWSTR GetExtraData();

char* ipworksedi_vdareader_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 (VDAReader Class)

The data to parse.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetInputData();
int SetInputData(const char* lpszInputData);

Unicode (Windows)
LPWSTR GetInputData();
INT SetInputData(LPCWSTR lpszInputData);

char* ipworksedi_vdareader_getinputdata(void* lpObj);
int ipworksedi_vdareader_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:

• InputFile
• InputData

Data Type

String

InputFile Property (VDAReader Class)

The file to parse.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetInputFile();
int SetInputFile(const char* lpszInputFile);

Unicode (Windows)
LPWSTR GetInputFile();
INT SetInputFile(LPCWSTR lpszInputFile);

char* ipworksedi_vdareader_getinputfile(void* lpObj);
int ipworksedi_vdareader_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:

• InputFile
• InputData

This property is not available at design time.

Data Type

String

Offset Property (VDAReader Class)

Current offset of the document being parsed.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int64 GetOffset();

Unicode (Windows)
LONG64 GetOffset();

int64 ipworksedi_vdareader_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 (VDAReader Class)

The format of the schema file.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSchemaFormat();
int SetSchemaFormat(int iSchemaFormat);

Unicode (Windows)
INT GetSchemaFormat();
INT SetSchemaFormat(INT iSchemaFormat);

SCHEMA_AUTOMATIC(0), 
SCHEMA_BINARY(1), 
SCHEMA_BIZ_TALK(2), 
SCHEMA_SEF(3), 
SCHEMA_BOTS(4), 
SCHEMA_ALTOVA(5), 
SCHEMA_JSON(6)

int ipworksedi_vdareader_getschemaformat(void* lpObj);
int ipworksedi_vdareader_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:

Data Type

Integer

XChildren Property (VDAReader Class)

Number of child elements of the current segment.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetXChildren();

Unicode (Windows)
INT GetXChildren();

int ipworksedi_vdareader_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 (VDAReader Class)

The number of records in the Element arrays.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetElementCount();

Unicode (Windows)
INT GetElementCount();

int ipworksedi_vdareader_getelementcount(void* lpObj);

int GetElementCount();

Default Value

0

Remarks

This property controls the size of the following arrays:

• ElementComponentCount
• ElementComponentIndex
• ElementComponentName
• ElementComponentSchemaDesc
• ElementComponentSchemaName
• ElementComponentType
• ElementComponentValue
• ElementDataType
• ElementName
• ElementRepeatCount
• ElementRepeatIndex
• ElementSchemaDesc
• ElementSchemaName
• ElementValue

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 (VDAReader Class)

Number of classes in the current element.

Syntax

• C++
• C
• Qt

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

Unicode (Windows)
INT GetElementComponentCount(INT iElementIndex);

int ipworksedi_vdareader_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 (VDAReader Class)

The index of the selected class of the current element.

Syntax

• C++
• C
• Qt

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 ipworksedi_vdareader_getelementcomponentindex(void* lpObj, int elementindex);
int ipworksedi_vdareader_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 (VDAReader Class)

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

Syntax

• C++
• C
• Qt

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

Unicode (Windows)
LPWSTR GetElementComponentName(INT iElementIndex);

char* ipworksedi_vdareader_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 (VDAReader Class)

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

Syntax

• C++
• C
• Qt

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

Unicode (Windows)
LPWSTR GetElementComponentSchemaDesc(INT iElementIndex);

char* ipworksedi_vdareader_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 (VDAReader Class)

The name of the class as taken from the schema.

Syntax

• C++
• C
• Qt

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

Unicode (Windows)
LPWSTR GetElementComponentSchemaName(INT iElementIndex);

char* ipworksedi_vdareader_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 (VDAReader Class)

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

Syntax

• C++
• C
• Qt

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

Unicode (Windows)
LPWSTR GetElementComponentType(INT iElementIndex);

char* ipworksedi_vdareader_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:

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 (VDAReader Class)

The value of the class selected by ClassIndex .

Syntax

• C++
• C
• Qt

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

Unicode (Windows)
LPWSTR GetElementComponentValue(INT iElementIndex);

char* ipworksedi_vdareader_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 (VDAReader Class)

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

Syntax

• C++
• C
• Qt

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

Unicode (Windows)
LPWSTR GetElementDataType(INT iElementIndex);

char* ipworksedi_vdareader_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:

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 (VDAReader Class)

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

Syntax

• C++
• C
• Qt

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

Unicode (Windows)
LPWSTR GetElementName(INT iElementIndex);

char* ipworksedi_vdareader_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 (VDAReader Class)

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

Syntax

• C++
• C
• Qt

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

Unicode (Windows)
INT GetElementRepeatCount(INT iElementIndex);

int ipworksedi_vdareader_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 (VDAReader Class)

The index of the selected instance of this repeatable element.

Syntax

• C++
• C
• Qt

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 ipworksedi_vdareader_getelementrepeatindex(void* lpObj, int elementindex);
int ipworksedi_vdareader_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 (VDAReader Class)

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

Syntax

• C++
• C
• Qt

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

Unicode (Windows)
LPWSTR GetElementSchemaDesc(INT iElementIndex);

char* ipworksedi_vdareader_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 (VDAReader Class)

The name of the element as taken from the schema.

Syntax

• C++
• C
• Qt

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

Unicode (Windows)
LPWSTR GetElementSchemaName(INT iElementIndex);

char* ipworksedi_vdareader_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 (VDAReader Class)

The value directly associated with this EDI element.

Syntax

• C++
• C
• Qt

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

Unicode (Windows)
LPWSTR GetElementValue(INT iElementIndex);

char* ipworksedi_vdareader_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 (VDAReader Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetXPath();
int SetXPath(const char* lpszXPath);

Unicode (Windows)
LPWSTR GetXPath();
INT SetXPath(LPCWSTR lpszXPath);

char* ipworksedi_vdareader_getxpath(void* lpObj);
int ipworksedi_vdareader_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:

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

Example (Setting XPath)

Data Type

String

XSegment Property (VDAReader Class)

The name of the current segment.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetXSegment();

Unicode (Windows)
LPWSTR GetXSegment();

char* ipworksedi_vdareader_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 (VDAReader Class)

The number of the current segment.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetXSegmentNumber();

Unicode (Windows)
INT GetXSegmentNumber();

int ipworksedi_vdareader_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 (VDAReader Class)

Indicates the current segment type.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetXSegmentType();

Unicode (Windows)
INT GetXSegmentType();

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 ipworksedi_vdareader_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 (VDAReader Class)

The tag of the current segment.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetXTag();

Unicode (Windows)
LPWSTR GetXTag();

char* ipworksedi_vdareader_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 (VDAReader Class)

The transaction code of the current segment.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetXTransactionCode();

Unicode (Windows)
LPWSTR GetXTransactionCode();

char* ipworksedi_vdareader_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 (VDAReader Class)

Compiles an existing XSD schema into an optimized binary representation.

Syntax

• C++
• C
• Qt

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

Unicode (Windows)
INT CompileSchema(LPCWSTR lpszXsdSchema, LPCWSTR lpszBinSchema);

int ipworksedi_vdareader_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 (VDAReader Class)

Sets or retrieves a configuration setting.

Syntax

• C++
• C
• Qt

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

Unicode (Windows)
LPWSTR Config(LPCWSTR lpszConfigurationString);

char* ipworksedi_vdareader_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 (VDAReader Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* DisplaySchemaInfo();

Unicode (Windows)
LPWSTR DisplaySchemaInfo();

char* ipworksedi_vdareader_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:

  ST[0,1]
  BIG[0,1]
  NTE[0,100]
  CUR[0,1]
  REF[0,12]
  YNQ[0,10]
  PER[0,3]
  N1Loop1[0,200]
    N1[0,1]
    N2[0,2]
    N3[0,2]
    N4[0,1]
    REF_2[0,12]
    PER_2[0,3]
    DMG[0,1]
  ITD[0,999999]
  DTM[0,10]
  FOB[0,1]
  PID[0,200]
  MEA[0,40]
  PWK[0,25]
  PKG[0,25]
  L7[0,1]
  BAL[0,999999]
  INC[0,1]
  PAM[0,999999]
  LMLoop1[0,10]
    LM[0,1]
    LQ[0,100]
  N9Loop1[0,1]
    N9[0,1]
    MSG[0,10]
  V1Loop1[0,999999]
    V1[0,1]
    R4[0,999999]
    DTM_2[0,999999]
  FA1Loop1[0,999999]
    FA1[0,1]
    FA2[0,999999]
  IT1Loop1[0,200000]
    IT1[0,1]
    CRC[0,1]
    QTY[0,5]
    CUR_2[0,1]
    IT3[0,5]
    TXI[0,10]
    CTP[0,25]
    PAM_2[0,10]
    MEA_2[0,40]
    PIDLoop1[0,1000]
      PID_2[0,1]
      MEA_3[0,10]
    PWK_2[0,25]
    PKG_2[0,25]
    PO4[0,1]
    ITD_2[0,2]
    REF_3[0,999999]
    YNQ_2[0,10]
    PER_3[0,5]
    SDQ[0,500]
    DTM_3[0,10]
    CAD[0,999999]
    L7_2[0,999999]
    SR[0,1]
    SACLoop1[0,25]
      SAC[0,1]
      TXI_2[0,10]
    SLNLoop1[0,1000]
      SLN[0,1]
      DTM_4[0,1]
      REF_4[0,999999]
      PID_3[0,1000]
      SAC_2[0,25]
      TC2[0,2]
      TXI_3[0,10]
    N1Loop2[0,200]
      N1_2[0,1]
      N2_2[0,2]
      N3_2[0,2]
      N4_2[0,1]
      REF_5[0,12]
      PER_4[0,3]
      DMG_2[0,1]
    LMLoop2[0,10]
      LM_2[0,1]
      LQ_2[0,100]
    V1Loop2[0,999999]
      V1_2[0,1]
      R4_2[0,999999]
      DTM_5[0,999999]
    FA1Loop2[0,999999]
      FA1_2[0,1]
      FA2_2[0,999999]
  TDS[0,1]
  TXI_4[0,10]
  CAD_2[0,1]
  AMT[0,999999]
  SACLoop2[0,25]
    SAC_3[0,1]
    TXI_5[0,10]
  ISSLoop1[0,999999]
    ISS[0,1]
    PID_4[0,1]
  CTT[0,1]
  SE[0,1]

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 (VDAReader Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* DisplayXMLInfo();

Unicode (Windows)
LPWSTR DisplayXMLInfo();

char* ipworksedi_vdareader_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="ISA" ISA01="00" ISA02="          " ISA03="00" ISA04="          " ISA05="ZZ" ISA06="ACME           " ISA07="ZZ" ISA08="WAYNE_TECH     " ISA09="160707" ISA10="1544" ISA11="U" ISA12="00401" ISA13="000000006" ISA14="0" ISA15="T" ISA16=">">
  <FG tag="GS" GS01="IN" GS02="ACME" GS03="WAYNE_TECH" GS04="20160707" GS05="1544" GS06="6" GS07="T" GS08="004010">
    <TX tag="ST" ST01="810" ST02="0001">
      <BIG tag="BIG" BIG01="20150708" BIG02="3003014445" BIG03="" BIG04="0476553272" BIG05="" BIG06="" BIG07="DR"/>
      <CUR tag="CUR" CUR01="SE" CUR02="USD"/>
      <REF tag="REF" REF01="8M" REF02="0056"/>
      <N1Loop1>
        <N1 tag="N1" N101="BY" N102="Company" N103="92" N104="544380"/>
        <N3 tag="N3" N301="Address"/>
        <N4 tag="N4" N401="City" N402="CA" N403="Postal Code"/>
      </N1Loop1>
      <N1Loop1>
        <N1 tag="N1" N101="ST" N102="Name" N103="92" N104="0607047800010"/>
        <N3 tag="N3" N301="Address"/>
        <N4 tag="N4" N401="City" N402="" N403="200131" N404="US"/>
      </N1Loop1>
      <N1Loop1>
        <N1 tag="N1" N101="RE" N102="Name" N103="92" N104="5095956"/>
        <N3 tag="N3" N301="Address"/>
        <N4 tag="N4" N401="City" N402="IL" N403="Postal Code"/>
      </N1Loop1>
      <IT1Loop1>
        <IT1 tag="IT1" IT101="20" IT102="2500" IT103="EA" IT104="36.96" IT105="" IT106="BP" IT107="335S0594"/>
        <REF_3 tag="REF" REF01="KK" REF02="0099778154"/>
        <REF_3 tag="REF" REF01="PO" REF02="0476553272" REF03="20"/>
      </IT1Loop1>
      <TDS tag="TDS" TDS01="9240000"/>
      <CTT tag="CTT" CTT01="1"/>
    </TX>
  </FG>
</IX>

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 (VDAReader Class)

Flushes the parser and checks its end state.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int Flush();

Unicode (Windows)
INT Flush();

int ipworksedi_vdareader_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 (VDAReader Class)

Generates an EDI acknowledgement.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GenerateAck();

Unicode (Windows)
LPWSTR GenerateAck();

char* ipworksedi_vdareader_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 (VDAReader Class)

Determines whether a specific element exists in the document.

Syntax

• C++
• C
• Qt

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

Unicode (Windows)
INT HasXPath(LPCWSTR lpszXPath);

int ipworksedi_vdareader_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 (VDAReader Class)

Loads a schema file describing a Transaction Set.

Syntax

• C++
• C
• Qt

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

Unicode (Windows)
INT LoadSchema(LPCWSTR lpszFileName);

int ipworksedi_vdareader_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 (VDAReader Class)

Parse the specified input data.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int Parse();

Unicode (Windows)
INT Parse();

int ipworksedi_vdareader_parse(void* lpObj);

int Parse();

Remarks

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

During parsing the following events may fire:

• StartInterchange
• StartFunctionalGroup
• StartTransaction
• Segment
• StartLoop
• EndLoop
• EndTransaction
• EndFunctionalGroup
• EndInterchange

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:

• InputFile
• InputData

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 (VDAReader Class)

Resets the parser.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int Reset();

Unicode (Windows)
INT Reset();

int ipworksedi_vdareader_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 (VDAReader Class)

Navigates to the specified XPath if it exists.

Syntax

• C++
• C
• Qt

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

Unicode (Windows)
INT TryXPath(LPCWSTR lpszxpath);

int ipworksedi_vdareader_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 (VDAReader Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireEndFunctionalGroup(VDAReaderEndFunctionalGroupEventParams *e);

typedef struct {
  const char *Tag;
  const char *ControlNumber;
  int Count;
  const char *FullSegment;
  int reserved;
} VDAReaderEndFunctionalGroupEventParams;


Unicode (Windows)
virtual INT FireEndFunctionalGroup(VDAReaderEndFunctionalGroupEventParams *e);

typedef struct {
  LPCWSTR Tag;
  LPCWSTR ControlNumber;
  INT Count;
  LPCWSTR FullSegment;
  INT reserved;
} VDAReaderEndFunctionalGroupEventParams;

#define EID_VDAREADER_ENDFUNCTIONALGROUP 1

virtual INT IPWORKSEDI_CALL FireEndFunctionalGroup(LPSTR &lpszTag, LPSTR &lpszControlNumber, INT &iCount, LPSTR &lpszFullSegment);

class VDAReaderEndFunctionalGroupEventParams {
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(VDAReaderEndFunctionalGroupEventParams *e);

// Or, subclass VDAReader and override this emitter function.
virtual int FireEndFunctionalGroup(VDAReaderEndFunctionalGroupEventParams *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 (VDAReader Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireEndInterchange(VDAReaderEndInterchangeEventParams *e);

typedef struct {
  const char *Tag;
  const char *ControlNumber;
  const char *FullSegment;
  int reserved;
} VDAReaderEndInterchangeEventParams;


Unicode (Windows)
virtual INT FireEndInterchange(VDAReaderEndInterchangeEventParams *e);

typedef struct {
  LPCWSTR Tag;
  LPCWSTR ControlNumber;
  LPCWSTR FullSegment;
  INT reserved;
} VDAReaderEndInterchangeEventParams;

#define EID_VDAREADER_ENDINTERCHANGE 2

virtual INT IPWORKSEDI_CALL FireEndInterchange(LPSTR &lpszTag, LPSTR &lpszControlNumber, LPSTR &lpszFullSegment);

class VDAReaderEndInterchangeEventParams {
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(VDAReaderEndInterchangeEventParams *e);

// Or, subclass VDAReader and override this emitter function.
virtual int FireEndInterchange(VDAReaderEndInterchangeEventParams *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 (VDAReader Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireEndLoop(VDAReaderEndLoopEventParams *e);

typedef struct {
  int reserved;
} VDAReaderEndLoopEventParams;


Unicode (Windows)
virtual INT FireEndLoop(VDAReaderEndLoopEventParams *e);

typedef struct {
  INT reserved;
} VDAReaderEndLoopEventParams;

#define EID_VDAREADER_ENDLOOP 3

virtual INT IPWORKSEDI_CALL FireEndLoop();

class VDAReaderEndLoopEventParams {
public:
  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void EndLoop(VDAReaderEndLoopEventParams *e);

// Or, subclass VDAReader and override this emitter function.
virtual int FireEndLoop(VDAReaderEndLoopEventParams *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 (VDAReader Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireEndTransaction(VDAReaderEndTransactionEventParams *e);

typedef struct {
  const char *Tag;
  const char *ControlNumber;
  int Count;
  const char *FullSegment;
  int reserved;
} VDAReaderEndTransactionEventParams;


Unicode (Windows)
virtual INT FireEndTransaction(VDAReaderEndTransactionEventParams *e);

typedef struct {
  LPCWSTR Tag;
  LPCWSTR ControlNumber;
  INT Count;
  LPCWSTR FullSegment;
  INT reserved;
} VDAReaderEndTransactionEventParams;

#define EID_VDAREADER_ENDTRANSACTION 4

virtual INT IPWORKSEDI_CALL FireEndTransaction(LPSTR &lpszTag, LPSTR &lpszControlNumber, INT &iCount, LPSTR &lpszFullSegment);

class VDAReaderEndTransactionEventParams {
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(VDAReaderEndTransactionEventParams *e);

// Or, subclass VDAReader and override this emitter function.
virtual int FireEndTransaction(VDAReaderEndTransactionEventParams *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 (VDAReader Class)

Fired when information is available about errors during data delivery.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireError(VDAReaderErrorEventParams *e);

typedef struct {
  int ErrorCode;
  const char *Description;
  int reserved;
} VDAReaderErrorEventParams;


Unicode (Windows)
virtual INT FireError(VDAReaderErrorEventParams *e);

typedef struct {
  INT ErrorCode;
  LPCWSTR Description;
  INT reserved;
} VDAReaderErrorEventParams;

#define EID_VDAREADER_ERROR 5

virtual INT IPWORKSEDI_CALL FireError(INT &iErrorCode, LPSTR &lpszDescription);

class VDAReaderErrorEventParams {
public:
  int ErrorCode();

  const QString &Description();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void Error(VDAReaderErrorEventParams *e);

// Or, subclass VDAReader and override this emitter function.
virtual int FireError(VDAReaderErrorEventParams *e) {...}

Remarks

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

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

ResolveSchema Event (VDAReader Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireResolveSchema(VDAReaderResolveSchemaEventParams *e);

typedef struct {
  const char *TransactionCode;
  const char *StandardVersion;
  int reserved;
} VDAReaderResolveSchemaEventParams;


Unicode (Windows)
virtual INT FireResolveSchema(VDAReaderResolveSchemaEventParams *e);

typedef struct {
  LPCWSTR TransactionCode;
  LPCWSTR StandardVersion;
  INT reserved;
} VDAReaderResolveSchemaEventParams;

#define EID_VDAREADER_RESOLVESCHEMA 6

virtual INT IPWORKSEDI_CALL FireResolveSchema(LPSTR &lpszTransactionCode, LPSTR &lpszStandardVersion);

class VDAReaderResolveSchemaEventParams {
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(VDAReaderResolveSchemaEventParams *e);

// Or, subclass VDAReader and override this emitter function.
virtual int FireResolveSchema(VDAReaderResolveSchemaEventParams *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 (VDAReader Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireSegment(VDAReaderSegmentEventParams *e);

typedef struct {
  const char *Tag;
  const char *Name;
  const char *LoopName;
  const char *FullSegment;
  int reserved;
} VDAReaderSegmentEventParams;


Unicode (Windows)
virtual INT FireSegment(VDAReaderSegmentEventParams *e);

typedef struct {
  LPCWSTR Tag;
  LPCWSTR Name;
  LPCWSTR LoopName;
  LPCWSTR FullSegment;
  INT reserved;
} VDAReaderSegmentEventParams;

#define EID_VDAREADER_SEGMENT 7

virtual INT IPWORKSEDI_CALL FireSegment(LPSTR &lpszTag, LPSTR &lpszName, LPSTR &lpszLoopName, LPSTR &lpszFullSegment);

class VDAReaderSegmentEventParams {
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(VDAReaderSegmentEventParams *e);

// Or, subclass VDAReader and override this emitter function.
virtual int FireSegment(VDAReaderSegmentEventParams *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 (VDAReader Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireStartFunctionalGroup(VDAReaderStartFunctionalGroupEventParams *e);

typedef struct {
  const char *Tag;
  const char *ControlNumber;
  const char *FullSegment;
  int reserved;
} VDAReaderStartFunctionalGroupEventParams;


Unicode (Windows)
virtual INT FireStartFunctionalGroup(VDAReaderStartFunctionalGroupEventParams *e);

typedef struct {
  LPCWSTR Tag;
  LPCWSTR ControlNumber;
  LPCWSTR FullSegment;
  INT reserved;
} VDAReaderStartFunctionalGroupEventParams;

#define EID_VDAREADER_STARTFUNCTIONALGROUP 8

virtual INT IPWORKSEDI_CALL FireStartFunctionalGroup(LPSTR &lpszTag, LPSTR &lpszControlNumber, LPSTR &lpszFullSegment);

class VDAReaderStartFunctionalGroupEventParams {
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(VDAReaderStartFunctionalGroupEventParams *e);

// Or, subclass VDAReader and override this emitter function.
virtual int FireStartFunctionalGroup(VDAReaderStartFunctionalGroupEventParams *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 (VDAReader Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireStartInterchange(VDAReaderStartInterchangeEventParams *e);

typedef struct {
  const char *Tag;
  const char *ControlNumber;
  const char *FullSegment;
  int reserved;
} VDAReaderStartInterchangeEventParams;


Unicode (Windows)
virtual INT FireStartInterchange(VDAReaderStartInterchangeEventParams *e);

typedef struct {
  LPCWSTR Tag;
  LPCWSTR ControlNumber;
  LPCWSTR FullSegment;
  INT reserved;
} VDAReaderStartInterchangeEventParams;

#define EID_VDAREADER_STARTINTERCHANGE 9

virtual INT IPWORKSEDI_CALL FireStartInterchange(LPSTR &lpszTag, LPSTR &lpszControlNumber, LPSTR &lpszFullSegment);

class VDAReaderStartInterchangeEventParams {
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(VDAReaderStartInterchangeEventParams *e);

// Or, subclass VDAReader and override this emitter function.
virtual int FireStartInterchange(VDAReaderStartInterchangeEventParams *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 (VDAReader Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireStartLoop(VDAReaderStartLoopEventParams *e);

typedef struct {
  const char *Name;
  int reserved;
} VDAReaderStartLoopEventParams;


Unicode (Windows)
virtual INT FireStartLoop(VDAReaderStartLoopEventParams *e);

typedef struct {
  LPCWSTR Name;
  INT reserved;
} VDAReaderStartLoopEventParams;

#define EID_VDAREADER_STARTLOOP 10

virtual INT IPWORKSEDI_CALL FireStartLoop(LPSTR &lpszName);

class VDAReaderStartLoopEventParams {
public:
  const QString &Name();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void StartLoop(VDAReaderStartLoopEventParams *e);

// Or, subclass VDAReader and override this emitter function.
virtual int FireStartLoop(VDAReaderStartLoopEventParams *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 (VDAReader Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireStartTransaction(VDAReaderStartTransactionEventParams *e);

typedef struct {
  const char *Tag;
  const char *ControlNumber;
  const char *Code;
  const char *FullSegment;
  int reserved;
} VDAReaderStartTransactionEventParams;


Unicode (Windows)
virtual INT FireStartTransaction(VDAReaderStartTransactionEventParams *e);

typedef struct {
  LPCWSTR Tag;
  LPCWSTR ControlNumber;
  LPCWSTR Code;
  LPCWSTR FullSegment;
  INT reserved;
} VDAReaderStartTransactionEventParams;

#define EID_VDAREADER_STARTTRANSACTION 11

virtual INT IPWORKSEDI_CALL FireStartTransaction(LPSTR &lpszTag, LPSTR &lpszControlNumber, LPSTR &lpszCode, LPSTR &lpszFullSegment);

class VDAReaderStartTransactionEventParams {
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(VDAReaderStartTransactionEventParams *e);

// Or, subclass VDAReader and override this emitter function.
virtual int FireStartTransaction(VDAReaderStartTransactionEventParams *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 (VDAReader Class)

Fires whenever a validation warning is encountered.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireWarning(VDAReaderWarningEventParams *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;
} VDAReaderWarningEventParams;


Unicode (Windows)
virtual INT FireWarning(VDAReaderWarningEventParams *e);

typedef struct {
  INT WarnCode;
  LPCWSTR Message;
  INT SegmentNumber;
  LPCWSTR SegmentTag;
  LPCWSTR TechnicalErrorCode;
  LPCWSTR SegmentErrorCode;
  LPCWSTR ElementErrorCode;
  INT ElementPosition;
  INT reserved;
} VDAReaderWarningEventParams;

#define EID_VDAREADER_WARNING 12

virtual INT IPWORKSEDI_CALL FireWarning(INT &iWarnCode, LPSTR &lpszMessage, INT &iSegmentNumber, LPSTR &lpszSegmentTag, LPSTR &lpszTechnicalErrorCode, LPSTR &lpszSegmentErrorCode, LPSTR &lpszElementErrorCode, INT &iElementPosition);

class VDAReaderWarningEventParams {
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(VDAReaderWarningEventParams *e);

// Or, subclass VDAReader and override this emitter function.
virtual int FireWarning(VDAReaderWarningEventParams *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:

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:

Config Settings (VDAReader Class)

VDAREADER Config Settings

Base Config Settings

Trappable Errors (VDAReader 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.

VDAReader Errors