VDATranslator Class

Properties   Methods   Events   Config Settings   Errors  

The VDATranslator class is optimized for VDA translation, providing a simple way to convert VDA documents to and from XML or JSON.

Syntax

VDATranslator

Remarks

The class provides a way to convert VDA to XML or JSON and vice versa.

Getting Started

The class will convert a document from the format specified by InputFormat to the format specified by OutputFormat. In practice this allows for converting to XML or JSON from EDI and vice versa.

Before translating from EDI to XML or JSON it is recommended to load a schema using the LoadSchema method. This ensures additional information can be included in the XML or JSON document. If a schema is specified the XML or JSON will include types and descriptions as element attributes which are useful for interpreting the data.

EDI elements may optionally be renamed when creating XML. To define how an element is renamed add a renaming rule by calling AddRenamingRule.

After calling Translate the resulting output will contain the EDI, XML or JSON data as defined by OutputFormat. If the output data is XML the ExportXMLSchema method may be called to export a schema (.xsd) defining the structure of a valid XML document. XML documents which adhere to this document may be translated from XML to EDI.

Input and Output Properties

The class will determine the source and destination of the input and output based on which properties are set.

The order in which the input properties are checked is as follows:

• InputFile
• InputData

• OutputFile
• OutputData: The output data is written to this property if no other destination is specified.

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.

InputData Property (VDATranslator Class)

The data to translate.

Syntax

• C++
• C
• Qt

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

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

char* ipworkseditranslator_vdatranslator_getinputdata(void* lpObj);
int ipworkseditranslator_vdatranslator_setinputdata(void* lpObj, const char* lpszInputData);

QString GetInputData();
int SetInputData(QString qsInputData);

Default Value

""

Remarks

This property specifies the data to be translated. This may be set to EDI data or XML/JSON data. To specify the type of data held by the property set InputFormat.

Input and Output Properties

The class will determine the source and destination of the input and output based on which properties are set.

The order in which the input properties are checked is as follows:

• InputFile
• InputData

• OutputFile
• OutputData: The output data is written to this property if no other destination is specified.

This property is not available at design time.

Data Type

String

InputFile Property (VDATranslator Class)

The file to translate.

Syntax

• C++
• C
• Qt

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

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

char* ipworkseditranslator_vdatranslator_getinputfile(void* lpObj);
int ipworkseditranslator_vdatranslator_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. To specify the type of data in the input file set InputFormat.

Input and Output Properties

The class will determine the source and destination of the input and output based on which properties are set.

The order in which the input properties are checked is as follows:

• InputFile
• InputData

• OutputFile
• OutputData: The output data is written to this property if no other destination is specified.

This property is not available at design time.

Data Type

String

InputFormat Property (VDATranslator Class)

The format of the input data.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetInputFormat();
int SetInputFormat(int iInputFormat);

Unicode (Windows)
INT GetInputFormat();
INT SetInputFormat(INT iInputFormat);

VIF_XML(0), 
VIF_JSON(1), 
VIF_VDA(5)

int ipworkseditranslator_vdatranslator_getinputformat(void* lpObj);
int ipworkseditranslator_vdatranslator_setinputformat(void* lpObj, int iInputFormat);

int GetInputFormat();
int SetInputFormat(int iInputFormat);

Default Value

5

Remarks

This property specifies the format of the input data. The value set here, along with OutputFormat, determines how the data is converted when Translate is called.

Possible values are:

• 0 (ifXML)
• 1 (ifJSON)
• 5 (ifVDA)

This property is not available at design time.

Data Type

Integer

OutputData Property (VDATranslator Class)

The translated data.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetOutputData();
int SetOutputData(const char* lpszOutputData);

Unicode (Windows)
LPWSTR GetOutputData();
INT SetOutputData(LPCWSTR lpszOutputData);

char* ipworkseditranslator_vdatranslator_getoutputdata(void* lpObj);
int ipworkseditranslator_vdatranslator_setoutputdata(void* lpObj, const char* lpszOutputData);

QString GetOutputData();
int SetOutputData(QString qsOutputData);

Default Value

""

Remarks

This property will be populated with the translated data after calling Translate if OutputFile and SetOutputStream are not set.

Input and Output Properties

The class will determine the source and destination of the input and output based on which properties are set.

The order in which the input properties are checked is as follows:

• InputFile
• InputData

• OutputFile
• OutputData: The output data is written to this property if no other destination is specified.

This property is not available at design time.

Data Type

String

OutputFile Property (VDATranslator Class)

The file to which the translated data will be written.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetOutputFile();
int SetOutputFile(const char* lpszOutputFile);

Unicode (Windows)
LPWSTR GetOutputFile();
INT SetOutputFile(LPCWSTR lpszOutputFile);

char* ipworkseditranslator_vdatranslator_getoutputfile(void* lpObj);
int ipworkseditranslator_vdatranslator_setoutputfile(void* lpObj, const char* lpszOutputFile);

QString GetOutputFile();
int SetOutputFile(QString qsOutputFile);

Default Value

""

Remarks

This property specifies the file to which the translated data will be written. This may be set to an absolute or relative path. This should be set before calling Translate.

Input and Output Properties

The class will determine the source and destination of the input and output based on which properties are set.

The order in which the input properties are checked is as follows:

• InputFile
• InputData

• OutputFile
• OutputData: The output data is written to this property if no other destination is specified.

This property is not available at design time.

Data Type

String

OutputFormat Property (VDATranslator Class)

The format of the output data.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetOutputFormat();
int SetOutputFormat(int iOutputFormat);

Unicode (Windows)
INT GetOutputFormat();
INT SetOutputFormat(INT iOutputFormat);

VOF_XML(0), 
VOF_JSON(1), 
VOF_VDA(5)

int ipworkseditranslator_vdatranslator_getoutputformat(void* lpObj);
int ipworkseditranslator_vdatranslator_setoutputformat(void* lpObj, int iOutputFormat);

int GetOutputFormat();
int SetOutputFormat(int iOutputFormat);

Default Value

0

Remarks

This property specifies the format of the output data. The value set here, along with InputFormat, determines how the data is converted when Translate is called.

Possible values are:

• 0 (ofXML)
• 1 (ofJSON)
• 5 (ofVDA)

This property is not available at design time.

Data Type

Integer

Overwrite Property (VDATranslator Class)

Whether to overwrite the file.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetOverwrite();
int SetOverwrite(int bOverwrite);

Unicode (Windows)
BOOL GetOverwrite();
INT SetOverwrite(BOOL bOverwrite);

int ipworkseditranslator_vdatranslator_getoverwrite(void* lpObj);
int ipworkseditranslator_vdatranslator_setoverwrite(void* lpObj, int bOverwrite);

bool GetOverwrite();
int SetOverwrite(bool bOverwrite);

Default Value

FALSE

Remarks

This property specifies whether the file is overwritten. If set to False (default) the class fails with an error when attempting to write to a file which already exists. If set to True the class will overwrite the existing file. This property is applicable to the following methods:

• SaveRenamingRules
• Translate
• ExportXMLSchema

Data Type

Boolean

RenamingRule Property (VDATranslator Class)

The rule defining how EDI elements are renamed when translating to XML or JSON.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetRenamingRule();
int SetRenamingRule(const char* lpszRenamingRule);

Unicode (Windows)
LPWSTR GetRenamingRule();
INT SetRenamingRule(LPCWSTR lpszRenamingRule);

char* ipworkseditranslator_vdatranslator_getrenamingrule(void* lpObj);
int ipworkseditranslator_vdatranslator_setrenamingrule(void* lpObj, const char* lpszRenamingRule);

QString GetRenamingRule();
int SetRenamingRule(QString qsRenamingRule);

Default Value

""

Remarks

The renaming rule specified by RenamingRuleIndex. Renaming rules are optional.

The renaming rule defines how EDI elements are renamed when translating to XML or JSON. The format is:

ediname:xmlanme

Note: Renaming rules are not required when converting from XML or JSON to EDI.

This property is not available at design time.

Data Type

String

RenamingRuleCount Property (VDATranslator Class)

The number of renaming rules.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetRenamingRuleCount();

Unicode (Windows)
INT GetRenamingRuleCount();

int ipworkseditranslator_vdatranslator_getrenamingrulecount(void* lpObj);

int GetRenamingRuleCount();

Default Value

0

Remarks

This property returns the current number of renaming rules.

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

Data Type

Integer

RenamingRuleIndex Property (VDATranslator Class)

The index of the current renaming rule.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetRenamingRuleIndex();
int SetRenamingRuleIndex(int iRenamingRuleIndex);

Unicode (Windows)
INT GetRenamingRuleIndex();
INT SetRenamingRuleIndex(INT iRenamingRuleIndex);

int ipworkseditranslator_vdatranslator_getrenamingruleindex(void* lpObj);
int ipworkseditranslator_vdatranslator_setrenamingruleindex(void* lpObj, int iRenamingRuleIndex);

int GetRenamingRuleIndex();
int SetRenamingRuleIndex(int iRenamingRuleIndex);

Default Value

-1

Remarks

This property specifies the current renaming rule. Valid values are from 0 to RenamingRuleCount - 1.

When set RenamingRule is populated with the renaming rule identified by the index.

This property is not available at design time.

Data Type

Integer

SchemaFormat Property (VDATranslator 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 ipworkseditranslator_vdatranslator_getschemaformat(void* lpObj);
int ipworkseditranslator_vdatranslator_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

Suffix Property (VDATranslator Class)

What to append after each segment delimiter.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSuffix();
int SetSuffix(int iSuffix);

Unicode (Windows)
INT GetSuffix();
INT SetSuffix(INT iSuffix);

SUFFIX_NONE(0), 
SUFFIX_CR(1), 
SUFFIX_LF(2), 
SUFFIX_CRLF(3)

int ipworkseditranslator_vdatranslator_getsuffix(void* lpObj);
int ipworkseditranslator_vdatranslator_setsuffix(void* lpObj, int iSuffix);

int GetSuffix();
int SetSuffix(int iSuffix);

Default Value

3

Remarks

If Suffix is different from suffixNone, trailing (suffix) characters are appended after each segment delimiter. This is useful if you want to have a carriage return/line feed after each segment to make the document more readable.

This property is not available at design time.

Data Type

Integer

UseSchemaName Property (VDATranslator Class)

Whether the output XML uses element names based on name defined in the schema.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetUseSchemaName();
int SetUseSchemaName(int bUseSchemaName);

Unicode (Windows)
BOOL GetUseSchemaName();
INT SetUseSchemaName(BOOL bUseSchemaName);

int ipworkseditranslator_vdatranslator_getuseschemaname(void* lpObj);
int ipworkseditranslator_vdatranslator_setuseschemaname(void* lpObj, int bUseSchemaName);

bool GetUseSchemaName();
int SetUseSchemaName(bool bUseSchemaName);

Default Value

FALSE

Remarks

This setting specifies whether the XML element name written to output is taken from the Id of the element defined in the schema. It is only applicable to ArcESB JSON schemas. For instance, given an EDIFACT document with the segment:

BGM+380:::TAX INVOICE

When this setting is True the XML generated may look like:

<BGM type="Segment">
<C002 type="Composite" desc="DOCUMENT/MESSAGE NAME">
<_1001 desc="Document/message name, coded">380</_1001>
<_1131 desc="Code list qualifier"></_1131>
<_3055 desc="Code list responsible agency, coded"></_3055>
<_1000 desc="Document/message name">TAX INVOICE</_1000>
</C002>

Where the elements "_1001", "C002", etc. are taken from the Id values of the EDI elements in the schema files.

Note: In order to produce valid XML, elements that would begin with a digit are prefixed with the "_" character.

In contrast if False (default) the XML generated may look like:

<BGM type="Segment">
<BGM01 type="Composite" desc="DOCUMENT/MESSAGE NAME">
<BGM0101 desc="Document/message name, coded">380</BGM0101>
<BGM0102 desc="Code list qualifier"></BGM0102>
<BGM0103 desc="Code list responsible agency, coded"></BGM0103>
<BGM0104 desc="Document/message name">TAX INVOICE</BGM0104>
</BGM01>

Data Type

Boolean

AddRenamingRule Method (VDATranslator Class)

This method adds a renaming rule to define how an EDI element is renamed when translating to XML.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int AddRenamingRule(const char* lpszRule);

Unicode (Windows)
INT AddRenamingRule(LPCWSTR lpszRule);

int ipworkseditranslator_vdatranslator_addrenamingrule(void* lpObj, const char* lpszRule);

int AddRenamingRule(const QString& qsRule);

Remarks

This method adds a renaming rule. The rule defining how EDI elements are renamed when translating to XML. Renaming rules are optional.

The renaming rule defines how EDI elements are renamed when translating to XML or JSON. The format is:

ediname:xmlanme

Note: Renaming rules are not required when converting from XML or JSON to EDI.

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 (VDATranslator 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* ipworkseditranslator_vdatranslator_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 (VDATranslator 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* ipworkseditranslator_vdatranslator_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.

ExportXMLSchema Method (VDATranslator Class)

Exports a XML schema.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int ExportXMLSchema(const char* lpszSchemaFile);

Unicode (Windows)
INT ExportXMLSchema(LPCWSTR lpszSchemaFile);

int ipworkseditranslator_vdatranslator_exportxmlschema(void* lpObj, const char* lpszSchemaFile);

int ExportXMLSchema(const QString& qsSchemaFile);

Remarks

This method exports a XML schema describing the valid format of the XML document.

After translating a document from EDI to XML, this method may be called to export a schema (.xsd) describing the structure of a valid XML documents. XML documents which adhere to this document may be translated from XML to EDI.

This method is helpful if XML will be generated outside of the class and later converted to EDI by the class.

The SchemaFile parameter specifies the absolute or relative path to the file on disk.

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

Generates an EDI acknowledgement.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GenerateAck();

Unicode (Windows)
LPWSTR GenerateAck();

char* ipworkseditranslator_vdatranslator_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.

LoadRenamingRules Method (VDATranslator Class)

Loads a set of renaming rules from file.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int LoadRenamingRules(const char* lpszRuleFile);

Unicode (Windows)
INT LoadRenamingRules(LPCWSTR lpszRuleFile);

int ipworkseditranslator_vdatranslator_loadrenamingrules(void* lpObj, const char* lpszRuleFile);

int LoadRenamingRules(const QString& qsRuleFile);

Remarks

This method loads a set of renaming rules from a file on disk. The RenamingRuleCount will reflect the number of rules that were loaded. When loading a rule file all previously loaded rules will be replaced.

The RuleFile parameter specifies the absolute or relative path to the file on disk.

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

LoadSchema Method (VDATranslator 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 ipworkseditranslator_vdatranslator_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.)

Reset Method (VDATranslator Class)

Resets the state of the control.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int Reset();

Unicode (Windows)
INT Reset();

int ipworkseditranslator_vdatranslator_reset(void* lpObj);

int Reset();

Remarks

Reset resets the state of the class. All properties will be set to their default values.

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

SaveRenamingRules Method (VDATranslator Class)

Saves the current renaming rule set to a file.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int SaveRenamingRules(const char* lpszRuleFile);

Unicode (Windows)
INT SaveRenamingRules(LPCWSTR lpszRuleFile);

int ipworkseditranslator_vdatranslator_saverenamingrules(void* lpObj, const char* lpszRuleFile);

int SaveRenamingRules(const QString& qsRuleFile);

Remarks

This method saves the current renaming rule set specified by RenamingRule, RenamingRuleIndex, and RenamingRuleCount to a file on disk. These rules may be reloaded at a later time by calling LoadRenamingRules.

The RuleFile parameter specifies the absolute or relative path to the file on disk.

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

Translate Method (VDATranslator Class)

Translates the specified data.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int Translate();

Unicode (Windows)
INT Translate();

int ipworkseditranslator_vdatranslator_translate(void* lpObj);

int Translate();

Remarks

This method translates the specified data.

The class will convert a document from the format specified by InputFormat to the format specified by OutputFormat. In practice this allows for converting to XML or JSON from EDI and vice versa.

Before translating from EDI to XML or JSON it is recommended to load a schema using the LoadSchema method. This ensures additional information can be included in the XML or JSON document. If a schema is specified the XML or JSON will include types and descriptions as element attributes which are useful for interpreting the data.

EDI elements may optionally be renamed when creating XML. To define how an element is renamed add a renaming rule by calling AddRenamingRule.

After calling Translate the resulting output will contain the EDI, XML or JSON data as defined by OutputFormat. If the output data is XML the ExportXMLSchema method may be called to export a schema (.xsd) defining the structure of a valid XML document. XML documents which adhere to this document may be translated from XML to EDI.

Input and Output Properties

The class will determine the source and destination of the input and output based on which properties are set.

The order in which the input properties are checked is as follows:

• InputFile
• InputData

• OutputFile
• OutputData: The output data is written to this property if no other destination is specified.

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

EndFunctionalGroup Event (VDATranslator 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(VDATranslatorEndFunctionalGroupEventParams *e);

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


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

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

#define EID_VDATRANSLATOR_ENDFUNCTIONALGROUP 1

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

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

// Or, subclass VDATranslator and override this emitter function.
virtual int FireEndFunctionalGroup(VDATranslatorEndFunctionalGroupEventParams *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 (VDATranslator 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(VDATranslatorEndInterchangeEventParams *e);

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


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

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

#define EID_VDATRANSLATOR_ENDINTERCHANGE 2

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

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

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

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

Syntax

• C++
• C
• Qt

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

typedef struct {
  int reserved;
} VDATranslatorEndLoopEventParams;


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

typedef struct {
  INT reserved;
} VDATranslatorEndLoopEventParams;

#define EID_VDATRANSLATOR_ENDLOOP 3

virtual INT IPWORKSEDITRANSLATOR_CALL FireEndLoop();

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

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

// Or, subclass VDATranslator and override this emitter function.
virtual int FireEndLoop(VDATranslatorEndLoopEventParams *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 (VDATranslator 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(VDATranslatorEndTransactionEventParams *e);

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


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

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

#define EID_VDATRANSLATOR_ENDTRANSACTION 4

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

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

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

Fired when information is available about errors during data delivery.

Syntax

• C++
• C
• Qt

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

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


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

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

#define EID_VDATRANSLATOR_ERROR 5

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

class VDATranslatorErrorEventParams {
public:
  int ErrorCode();

  const QString &Description();

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

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

// Or, subclass VDATranslator and override this emitter function.
virtual int FireError(VDATranslatorErrorEventParams *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 (VDATranslator 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(VDATranslatorResolveSchemaEventParams *e);

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


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

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

#define EID_VDATRANSLATOR_RESOLVESCHEMA 6

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

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

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

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

Syntax

• C++
• C
• Qt

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

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


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

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

#define EID_VDATRANSLATOR_SEGMENT 7

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

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

// Or, subclass VDATranslator and override this emitter function.
virtual int FireSegment(VDATranslatorSegmentEventParams *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 (VDATranslator 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(VDATranslatorStartFunctionalGroupEventParams *e);

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


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

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

#define EID_VDATRANSLATOR_STARTFUNCTIONALGROUP 8

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

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

// Or, subclass VDATranslator and override this emitter function.
virtual int FireStartFunctionalGroup(VDATranslatorStartFunctionalGroupEventParams *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 (VDATranslator 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(VDATranslatorStartInterchangeEventParams *e);

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


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

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

#define EID_VDATRANSLATOR_STARTINTERCHANGE 9

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

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

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

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

Syntax

• C++
• C
• Qt

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

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


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

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

#define EID_VDATRANSLATOR_STARTLOOP 10

virtual INT IPWORKSEDITRANSLATOR_CALL FireStartLoop(LPSTR &lpszName);

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

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

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

// Or, subclass VDATranslator and override this emitter function.
virtual int FireStartLoop(VDATranslatorStartLoopEventParams *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 (VDATranslator 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(VDATranslatorStartTransactionEventParams *e);

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


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

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

#define EID_VDATRANSLATOR_STARTTRANSACTION 11

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

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

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

Fires whenever a validation warning is encountered.

Syntax

• C++
• C
• Qt

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


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

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

#define EID_VDATRANSLATOR_WARNING 12

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

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

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

VDATranslator Config Settings

PYT+8+COLLECT:::+25'

PYT+8+COLLECT+25'

{
	"@meta": {
		"@type": "Interchange",
		"ISA01": {
			"@desc": "Authorization Information Qualifier",
			"@value": "00"
		},

<!--Entity Identifier Code-->
<N101><!--Ship To-->ST</N101>

<N101 desc="Entity Identifier Code">ST</N101>

<N101>ST</N101>

Base Config Settings

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

VDATranslator Errors