X12Translator Class

Properties   Methods   Events   Config Settings   Errors  

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

Syntax

X12Translator

Remarks

The X12Translator class provides a simple way to convert X12 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:

When a valid source is found the search stops. The order in which the output properties are checked is as follows:
  • OutputFile
  • OutputData: The output data is written to this property if no other destination is specified.

Example - Translating X12 to XML

X12translator translator = new X12translator(); translator.InputFormat = X12translatorInputFormats.ifX12; translator.OutputFormat = X12translatorOutputFormats.ofXML; translator.InputFile = "810.edi"; translator.OutputFile = "X12_810.xml"; translator.UseSchemaName = true; translator.SchemaFormat = X12translatorSchemaFormats.schemaJSON; translator.LoadSchema("RSSBus_00401_810.json"); translator.Translate();

The code above creates an XML document with content like:

<Interchange xmlns="http://www.nsoftware.com" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
    <Meta>
        <ISA01 desc="Authorization Information Qualifier">00</ISA01>
        <ISA02 desc="Authorization Information">          </ISA02>
        <ISA03 desc="Security Information Qualifer">00</ISA03>
        <ISA04 desc="Security Information">          </ISA04>
        <ISA05 desc="Interchange ID Qualifier">14</ISA05>
        <ISA06 desc="Interchange Sender ID">060704780001900</ISA06>
        <ISA07 desc="Interchange ID Qualifier">ZZ</ISA07>
        <ISA08 desc="Interchange Receiver ID">HYNIXEDI       </ISA08>
        <ISA09 desc="Interchange Date">130428</ISA09>
        <ISA10 desc="Interchange Time">2033</ISA10>
        <ISA11 desc="Interchange Control Standards Identifier">U</ISA11>
        <ISA12 desc="Interchange Control Version Number Code">00401</ISA12>
        <ISA13 desc="Inter Control Number">000040161</ISA13>
        <ISA14 desc="Acknowlegment Requested Code">1</ISA14>
        <ISA15 desc="Interchange Usage Indicator Code">T</ISA15>
        <ISA16 desc="Component Element Separator">&gt;</ISA16>
    </Meta>
    <FunctionalGroup>
        <Meta>
            <GS01 desc="Functional Identifier Code">IN</GS01>
            <GS02 desc="Application Sender&apos;s Code">060704780500</GS02>
            <GS03 desc="Application Receiver&apos;s Code">HYNIXEDI</GS03>
            <GS04 desc="Date">20130428</GS04>
            <GS05 desc="Time">2033</GS05>
            <GS06 desc="Group Control Number">000040161</GS06>
            <GS07 desc="Responsible Agency Code">X</GS07>
            <GS08 desc="Version / Release / Industry Identifier Code">004010</GS08>
        </Meta>
        <TransactionSet>
            <TX-00401-810 type="TransactionSet">
                <Meta>
                    <ST01 desc="Transaction Set Identifier Code">810</ST01>
                    <ST02 desc="Transaction Set Control Number">0001</ST02>
                </Meta>
                <BIG type="Segment">
                    <BIG01 desc="Date">20090629</BIG01>
                    <BIG02 desc="Invoice Number">3003014445</BIG02>
                    <BIG03 desc="Date" xsi:nil="true"/>
                    <BIG04 desc="Purchase Order Number">0476553272</BIG04>
                    <BIG05 desc="Release Number" xsi:nil="true"/>
                    <BIG06 desc="Change Order Sequence Number" xsi:nil="true"/>
                    <BIG07 desc="Transaction Type Code">DR</BIG07>
                </BIG>
...                

Example - Translating X12 to JSON

X12translator translator = new X12translator(); translator.InputFormat = X12translatorInputFormats.ifX12; translator.OutputFormat = X12translatorOutputFormats.ofJSON; translator.InputFile = "810.edi"; translator.OutputFile = "X12_810.json"; translator.UseSchemaName = true; translator.SchemaFormat = X12translatorSchemaFormats.schemaJSON; translator.LoadSchema("RSSBus_00401_810.json"); translator.Translate();

The code above creates a JSON document with content like:

{
	"meta": {
		"type": "Interchange",
		"ISA01": {
			"desc": "Authorization Information Qualifier",
			"value": "00"
		},
		"ISA02": {
			"desc": "Authorization Information",
			"value": "          "
		},
		"ISA03": {
			"desc": "Security Information Qualifer",
			"value": "00"
		},
		"ISA04": {
			"desc": "Security Information",
			"value": "          "
		},
		"ISA05": {
			"desc": "Interchange ID Qualifier",
			"value": "14"
		},
		"ISA06": {
			"desc": "Interchange Sender ID",
			"value": "060704780001900"
		},
		"ISA07": {
			"desc": "Interchange ID Qualifier",
			"value": "ZZ"
		},
		"ISA08": {
			"desc": "Interchange Receiver ID",
			"value": "HYNIXEDI       "
		},
		"ISA09": {
			"desc": "Interchange Date",
			"value": "130428"
		},
		"ISA10": {
			"desc": "Interchange Time",
			"value": "2033"
		},
		"ISA11": {
			"desc": "Interchange Control Standards Identifier",
			"value": "U"
		},
		"ISA12": {
			"desc": "Interchange Control Version Number Code",
			"value": "00401"
		},
		"ISA13": {
			"desc": "Inter Control Number",
			"value": "000040161"
		},
		"ISA14": {
			"desc": "Acknowlegment Requested Code",
			"value": "1"
		},
		"ISA15": {
			"desc": "Interchange Usage Indicator Code",
			"value": "T"
		},
		"ISA16": {
			"desc": "Component Element Separator",
			"value": ">"
		}
	},
	"functionalgroups": [{
		"meta": {
			"type": "FunctionalGroup",
			"GS01": {
				"desc": "Functional Identifier Code",
				"value": "IN"
			},
			"GS02": {
				"desc": "Application Sender's Code",
				"value": "060704780500"
			},
			"GS03": {
				"desc": "Application Receiver's Code",
				"value": "HYNIXEDI"
			},
			"GS04": {
				"desc": "Date",
				"value": "20130428"
			},
			"GS05": {
				"desc": "Time",
				"value": "2033"
			},
			"GS06": {
				"desc": "Group Control Number",
				"value": "000040161"
			},
			"GS07": {
				"desc": "Responsible Agency Code",
				"value": "X"
			},
			"GS08": {
				"desc": "Version \/ Release \/ Industry Identifier Code",
				"value": "004010"
			}
		},
		"transactionsets": [{
			"meta": {
				"type": "TransactionSet",
				"ST01": {
					"desc": "Transaction Set Identifier Code",
					"value": "810"
				},
				"ST02": {
					"desc": "Transaction Set Control Number",
					"value": "0001"
				}
			},
			"segments": [{
				"type": "Segment",
				"name": "BIG",
				"BIG01": {
					"desc": "Date",
					"value": "20090629"
				},
				"BIG02": {
					"desc": "Invoice Number",
					"value": "3003014445"
				},
				"BIG03": {
					"desc": "Date",
					"value": null
				},
				"BIG04": {
					"desc": "Purchase Order Number",
					"value": "0476553272"
				},
				"BIG05": {
					"desc": "Release Number",
					"value": null
				},
				"BIG06": {
					"desc": "Change Order Sequence Number",
					"value": null
				},
				"BIG07": {
					"desc": "Transaction Type Code",
					"value": "DR"
				}
			},
...            

Property List


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

InputDataThe data to translate.
InputFileThe file to translate.
InputFormatThe format of the input data.
OutputDataThe translated data.
OutputFileThe file to which the translated data will be written.
OutputFormatThe format of the output data.
OverwriteWhether to overwrite the file.
RenamingRuleThe rule defining how EDI elements are renamed when translating to XML or JSON.
RenamingRuleCountThe number of renaming rules.
RenamingRuleIndexThe index of the current renaming rule.
SchemaFormatThe format of the schema file.
SuffixWhat to append after each segment delimiter.
UseSchemaNameWhether the output XML uses element names based on name defined in the schema.

Method List


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

AddRenamingRuleThis method adds a renaming rule to define how an EDI element is renamed when translating to XML.
ConfigSets or retrieves a configuration setting.
DisplaySchemaInfoReturns a string showing the structure of the schema defining the document.
ExportXMLSchemaExports a XML schema.
GenerateAckGenerates an EDI acknowledgement.
LoadRenamingRulesLoads a set of renaming rules from file.
LoadSchemaLoads a schema file describing a Transaction Set.
ResetResets the state of the control.
SaveRenamingRulesSaves the current renaming rule set to a file.
TranslateTranslates the specified data.

Event List


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

EndFunctionalGroupFires whenever a control segment is read that marks the end of an interchange.
EndInterchangeFires whenever a control segment is read that marks the end of an interchange.
EndLoopFires when the end of a loop is detected in a transaction set.
EndTransactionFires whenever a control segment is read that marks the end of a transaction.
ErrorInformation about errors during data delivery.
ResolveSchemaFires whenever a new transaction set is encountered and no schema is found for it.
SegmentFires whenever a data segment in a transaction set is read.
StartFunctionalGroupFires whenever a control segment is read that marks the start of a functional group.
StartInterchangeFires whenever a control segment is read that marks the start of an interchange.
StartLoopFires when the starting of a loop is detected in a transaction set.
StartTransactionFires whenever a control segment is read that marks the start of a transaction.
WarningFires whenever a validation warning is encountered.

Config Settings


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

ComponentDelimiterThe delimiter character to use to separate classes.
CrossFieldValidationEnabledEnables cross-field validation rules.
EDIStandardThe document format.
ElementDelimiterThe delimiter character to use to separate data elements.
EncodingThe character encoding to be applied when reading and writing data.
IncludeEmptyElementsWhether to include empty data elements in a composite element.
IncludeFootersWhether to include footer information in the XML.
IncludeUNAWhether to include the UNA segment in the output.
JSONElementPrefixAn optional prefix for reserved names when translating to JSON.
LastIXControlNumberThe control number of the most recently parsed interchange.
LastTransactionControlNumberThe control number of the most recently parsed transaction.
ReleaseCharThe character to use to escape delimiters within values.
RenamingRulesDataThe renaming rules data.
RepetitionCharThe repetition character.
SegmentDelimiterThe delimiter character to use to separate segments.
StrictSchemaValidationSpecifies the behavior during schema validation.
UseXMLCommentsWhether the human readable description is stored as an attribute or XML comments.
BuildInfoInformation about the product's build.
CodePageThe system code page used for Unicode to Multibyte translations.
LicenseInfoInformation about the current license.
MaskSensitiveWhether sensitive data is masked in log messages.
ProcessIdleEventsWhether the class uses its internal event loop to process events when the main thread is idle.
SelectWaitMillisThe length of time in milliseconds the class will wait when DoEvents is called if there are no events to process.
UseFIPSCompliantAPITells the class whether or not to use FIPS certified APIs.
UseInternalSecurityAPITells the class whether or not to use the system security libraries or an internal implementation.

InputData Property (X12Translator Class)

The data to translate.

Syntax

ANSI (Cross Platform)
char* GetInputData();
int SetInputData(const char* lpszInputData); Unicode (Windows) LPWSTR GetInputData();
INT SetInputData(LPCWSTR lpszInputData);
char* ipworkseditranslator_x12translator_getinputdata(void* lpObj);
int ipworkseditranslator_x12translator_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:

When a valid source is found the search stops. The order in which the output properties are checked is as follows:
  • 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 (X12Translator Class)

The file to translate.

Syntax

ANSI (Cross Platform)
char* GetInputFile();
int SetInputFile(const char* lpszInputFile); Unicode (Windows) LPWSTR GetInputFile();
INT SetInputFile(LPCWSTR lpszInputFile);
char* ipworkseditranslator_x12translator_getinputfile(void* lpObj);
int ipworkseditranslator_x12translator_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:

When a valid source is found the search stops. The order in which the output properties are checked is as follows:
  • 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 (X12Translator Class)

The format of the input data.

Syntax

ANSI (Cross Platform)
int GetInputFormat();
int SetInputFormat(int iInputFormat); Unicode (Windows) INT GetInputFormat();
INT SetInputFormat(INT iInputFormat);

Possible Values

XIF_XML(0), 
XIF_JSON(1),
XIF_X12(3)
int ipworkseditranslator_x12translator_getinputformat(void* lpObj);
int ipworkseditranslator_x12translator_setinputformat(void* lpObj, int iInputFormat);
int GetInputFormat();
int SetInputFormat(int iInputFormat);

Default Value

3

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)
  • 3 (ifX12)
Before calling Translate, both InputFormat and OutputFormat must be specified. Translation from XML or JSON to EDI and vice versa are supported. If InputFormat is ifXML or ifJSON, OutputFormat must be an EDI format. Similarly, if InputFormat is an EDI format, OutputFormat must be ofXML or ofJSON.

This property is not available at design time.

Data Type

Integer

OutputData Property (X12Translator Class)

The translated data.

Syntax

ANSI (Cross Platform)
char* GetOutputData();
int SetOutputData(const char* lpszOutputData); Unicode (Windows) LPWSTR GetOutputData();
INT SetOutputData(LPCWSTR lpszOutputData);
char* ipworkseditranslator_x12translator_getoutputdata(void* lpObj);
int ipworkseditranslator_x12translator_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:

When a valid source is found the search stops. The order in which the output properties are checked is as follows:
  • 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 (X12Translator Class)

The file to which the translated data will be written.

Syntax

ANSI (Cross Platform)
char* GetOutputFile();
int SetOutputFile(const char* lpszOutputFile); Unicode (Windows) LPWSTR GetOutputFile();
INT SetOutputFile(LPCWSTR lpszOutputFile);
char* ipworkseditranslator_x12translator_getoutputfile(void* lpObj);
int ipworkseditranslator_x12translator_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:

When a valid source is found the search stops. The order in which the output properties are checked is as follows:
  • 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 (X12Translator Class)

The format of the output data.

Syntax

ANSI (Cross Platform)
int GetOutputFormat();
int SetOutputFormat(int iOutputFormat); Unicode (Windows) INT GetOutputFormat();
INT SetOutputFormat(INT iOutputFormat);

Possible Values

XOF_XML(0), 
XOF_JSON(1),
XOF_X12(3)
int ipworkseditranslator_x12translator_getoutputformat(void* lpObj);
int ipworkseditranslator_x12translator_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)
  • 3 (ofX12)
Before calling Translate, both InputFormat and OutputFormat must be specified. Translation from XML or JSON to EDI and vice versa are supported. If InputFormat is ifXML or ifJSON, OutputFormat must be an EDI format. Similarly, if InputFormat is an EDI format, OutputFormat must be ofXML or ofJSON.

This property is not available at design time.

Data Type

Integer

Overwrite Property (X12Translator Class)

Whether to overwrite the file.

Syntax

ANSI (Cross Platform)
int GetOverwrite();
int SetOverwrite(int bOverwrite); Unicode (Windows) BOOL GetOverwrite();
INT SetOverwrite(BOOL bOverwrite);
int ipworkseditranslator_x12translator_getoverwrite(void* lpObj);
int ipworkseditranslator_x12translator_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:

Data Type

Boolean

RenamingRule Property (X12Translator Class)

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

Syntax

ANSI (Cross Platform)
char* GetRenamingRule();
int SetRenamingRule(const char* lpszRenamingRule); Unicode (Windows) LPWSTR GetRenamingRule();
INT SetRenamingRule(LPCWSTR lpszRenamingRule);
char* ipworkseditranslator_x12translator_getrenamingrule(void* lpObj);
int ipworkseditranslator_x12translator_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
For instance: "UNH1:MsgRefNumber".

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

The number of renaming rules.

Syntax

ANSI (Cross Platform)
int GetRenamingRuleCount();

Unicode (Windows)
INT GetRenamingRuleCount();
int ipworkseditranslator_x12translator_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 (X12Translator Class)

The index of the current renaming rule.

Syntax

ANSI (Cross Platform)
int GetRenamingRuleIndex();
int SetRenamingRuleIndex(int iRenamingRuleIndex); Unicode (Windows) INT GetRenamingRuleIndex();
INT SetRenamingRuleIndex(INT iRenamingRuleIndex);
int ipworkseditranslator_x12translator_getrenamingruleindex(void* lpObj);
int ipworkseditranslator_x12translator_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 (X12Translator Class)

The format of the schema file.

Syntax

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

Possible Values

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

Default Value

0

Remarks

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

The following schema formats are supported:

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

Data Type

Integer

Suffix Property (X12Translator Class)

What to append after each segment delimiter.

Syntax

ANSI (Cross Platform)
int GetSuffix();
int SetSuffix(int iSuffix); Unicode (Windows) INT GetSuffix();
INT SetSuffix(INT iSuffix);

Possible Values

SUFFIX_NONE(0), 
SUFFIX_CR(1),
SUFFIX_LF(2),
SUFFIX_CRLF(3)
int ipworkseditranslator_x12translator_getsuffix(void* lpObj);
int ipworkseditranslator_x12translator_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 (X12Translator Class)

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

Syntax

ANSI (Cross Platform)
int GetUseSchemaName();
int SetUseSchemaName(int bUseSchemaName); Unicode (Windows) BOOL GetUseSchemaName();
INT SetUseSchemaName(BOOL bUseSchemaName);
int ipworkseditranslator_x12translator_getuseschemaname(void* lpObj);
int ipworkseditranslator_x12translator_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 X12 document with the segment:

N1*BY*Apple Inc.*92*544380~

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

<N1Loop1 type="Loop">
<N1 type="Segment">
<_98 desc="Entity Identifier Code_98">BY</_98>
<_93 desc="Name_93">Apple Inc.</_93>
<_66 desc="Identification Code Qualifier_66">92</_66>
<_67 desc="Identification Code_67">544380</_67>
</N1>

Where the elements "_98", "_93", 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:

<N1Loop1 type="Loop">
<N1 type="Segment" desc="Name">
<N101 desc="Entity Identifier Code_98">BY</N101>
<N102 desc="Name_93">Apple Inc.</N102>
<N103 desc="Identification Code Qualifier_66">92</N103>
<N104 desc="Identification Code_67">544380</N104>
</N1>
The default value is False. This setting is only applicable when using ArcESB JSON schemas.

Data Type

Boolean

AddRenamingRule Method (X12Translator Class)

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

Syntax

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

Unicode (Windows)
INT AddRenamingRule(LPCWSTR lpszRule);
int ipworkseditranslator_x12translator_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
For instance: "UNH1:MsgRefNumber".

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

Sets or retrieves a configuration setting.

Syntax

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

Unicode (Windows)
LPWSTR Config(LPCWSTR lpszConfigurationString);
char* ipworkseditranslator_x12translator_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 (X12Translator Class)

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

Syntax

ANSI (Cross Platform)
char* DisplaySchemaInfo();

Unicode (Windows)
LPWSTR DisplaySchemaInfo();
char* ipworkseditranslator_x12translator_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 (X12Translator Class)

Exports a XML schema.

Syntax

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

Unicode (Windows)
INT ExportXMLSchema(LPCWSTR lpszSchemaFile);
int ipworkseditranslator_x12translator_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 (X12Translator Class)

Generates an EDI acknowledgement.

Syntax

ANSI (Cross Platform)
char* GenerateAck();

Unicode (Windows)
LPWSTR GenerateAck();
char* ipworkseditranslator_x12translator_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 (X12Translator Class)

Loads a set of renaming rules from file.

Syntax

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

Unicode (Windows)
INT LoadRenamingRules(LPCWSTR lpszRuleFile);
int ipworkseditranslator_x12translator_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 (X12Translator Class)

Loads a schema file describing a Transaction Set.

Syntax

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

Unicode (Windows)
INT LoadSchema(LPCWSTR lpszFileName);
int ipworkseditranslator_x12translator_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 (X12Translator Class)

Resets the state of the control.

Syntax

ANSI (Cross Platform)
int Reset();

Unicode (Windows)
INT Reset();
int ipworkseditranslator_x12translator_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 (X12Translator Class)

Saves the current renaming rule set to a file.

Syntax

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

Unicode (Windows)
INT SaveRenamingRules(LPCWSTR lpszRuleFile);
int ipworkseditranslator_x12translator_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 (X12Translator Class)

Translates the specified data.

Syntax

ANSI (Cross Platform)
int Translate();

Unicode (Windows)
INT Translate();
int ipworkseditranslator_x12translator_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:

When a valid source is found the search stops. The order in which the output properties are checked is as follows:
  • OutputFile
  • OutputData: The output data is written to this property if no other destination is specified.

Example - Translating X12 to XML

X12translator translator = new X12translator(); translator.InputFormat = X12translatorInputFormats.ifX12; translator.OutputFormat = X12translatorOutputFormats.ofXML; translator.InputFile = "810.edi"; translator.OutputFile = "X12_810.xml"; translator.UseSchemaName = true; translator.SchemaFormat = X12translatorSchemaFormats.schemaJSON; translator.LoadSchema("RSSBus_00401_810.json"); translator.Translate();

The code above creates an XML document with content like:

<Interchange xmlns="http://www.nsoftware.com" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
    <Meta>
        <ISA01 desc="Authorization Information Qualifier">00</ISA01>
        <ISA02 desc="Authorization Information">          </ISA02>
        <ISA03 desc="Security Information Qualifer">00</ISA03>
        <ISA04 desc="Security Information">          </ISA04>
        <ISA05 desc="Interchange ID Qualifier">14</ISA05>
        <ISA06 desc="Interchange Sender ID">060704780001900</ISA06>
        <ISA07 desc="Interchange ID Qualifier">ZZ</ISA07>
        <ISA08 desc="Interchange Receiver ID">HYNIXEDI       </ISA08>
        <ISA09 desc="Interchange Date">130428</ISA09>
        <ISA10 desc="Interchange Time">2033</ISA10>
        <ISA11 desc="Interchange Control Standards Identifier">U</ISA11>
        <ISA12 desc="Interchange Control Version Number Code">00401</ISA12>
        <ISA13 desc="Inter Control Number">000040161</ISA13>
        <ISA14 desc="Acknowlegment Requested Code">1</ISA14>
        <ISA15 desc="Interchange Usage Indicator Code">T</ISA15>
        <ISA16 desc="Component Element Separator">&gt;</ISA16>
    </Meta>
    <FunctionalGroup>
        <Meta>
            <GS01 desc="Functional Identifier Code">IN</GS01>
            <GS02 desc="Application Sender&apos;s Code">060704780500</GS02>
            <GS03 desc="Application Receiver&apos;s Code">HYNIXEDI</GS03>
            <GS04 desc="Date">20130428</GS04>
            <GS05 desc="Time">2033</GS05>
            <GS06 desc="Group Control Number">000040161</GS06>
            <GS07 desc="Responsible Agency Code">X</GS07>
            <GS08 desc="Version / Release / Industry Identifier Code">004010</GS08>
        </Meta>
        <TransactionSet>
            <TX-00401-810 type="TransactionSet">
                <Meta>
                    <ST01 desc="Transaction Set Identifier Code">810</ST01>
                    <ST02 desc="Transaction Set Control Number">0001</ST02>
                </Meta>
                <BIG type="Segment">
                    <BIG01 desc="Date">20090629</BIG01>
                    <BIG02 desc="Invoice Number">3003014445</BIG02>
                    <BIG03 desc="Date" xsi:nil="true"/>
                    <BIG04 desc="Purchase Order Number">0476553272</BIG04>
                    <BIG05 desc="Release Number" xsi:nil="true"/>
                    <BIG06 desc="Change Order Sequence Number" xsi:nil="true"/>
                    <BIG07 desc="Transaction Type Code">DR</BIG07>
                </BIG>
...                

Example - Translating X12 to JSON

X12translator translator = new X12translator(); translator.InputFormat = X12translatorInputFormats.ifX12; translator.OutputFormat = X12translatorOutputFormats.ofJSON; translator.InputFile = "810.edi"; translator.OutputFile = "X12_810.json"; translator.UseSchemaName = true; translator.SchemaFormat = X12translatorSchemaFormats.schemaJSON; translator.LoadSchema("RSSBus_00401_810.json"); translator.Translate();

The code above creates a JSON document with content like:

{
	"meta": {
		"type": "Interchange",
		"ISA01": {
			"desc": "Authorization Information Qualifier",
			"value": "00"
		},
		"ISA02": {
			"desc": "Authorization Information",
			"value": "          "
		},
		"ISA03": {
			"desc": "Security Information Qualifer",
			"value": "00"
		},
		"ISA04": {
			"desc": "Security Information",
			"value": "          "
		},
		"ISA05": {
			"desc": "Interchange ID Qualifier",
			"value": "14"
		},
		"ISA06": {
			"desc": "Interchange Sender ID",
			"value": "060704780001900"
		},
		"ISA07": {
			"desc": "Interchange ID Qualifier",
			"value": "ZZ"
		},
		"ISA08": {
			"desc": "Interchange Receiver ID",
			"value": "HYNIXEDI       "
		},
		"ISA09": {
			"desc": "Interchange Date",
			"value": "130428"
		},
		"ISA10": {
			"desc": "Interchange Time",
			"value": "2033"
		},
		"ISA11": {
			"desc": "Interchange Control Standards Identifier",
			"value": "U"
		},
		"ISA12": {
			"desc": "Interchange Control Version Number Code",
			"value": "00401"
		},
		"ISA13": {
			"desc": "Inter Control Number",
			"value": "000040161"
		},
		"ISA14": {
			"desc": "Acknowlegment Requested Code",
			"value": "1"
		},
		"ISA15": {
			"desc": "Interchange Usage Indicator Code",
			"value": "T"
		},
		"ISA16": {
			"desc": "Component Element Separator",
			"value": ">"
		}
	},
	"functionalgroups": [{
		"meta": {
			"type": "FunctionalGroup",
			"GS01": {
				"desc": "Functional Identifier Code",
				"value": "IN"
			},
			"GS02": {
				"desc": "Application Sender's Code",
				"value": "060704780500"
			},
			"GS03": {
				"desc": "Application Receiver's Code",
				"value": "HYNIXEDI"
			},
			"GS04": {
				"desc": "Date",
				"value": "20130428"
			},
			"GS05": {
				"desc": "Time",
				"value": "2033"
			},
			"GS06": {
				"desc": "Group Control Number",
				"value": "000040161"
			},
			"GS07": {
				"desc": "Responsible Agency Code",
				"value": "X"
			},
			"GS08": {
				"desc": "Version \/ Release \/ Industry Identifier Code",
				"value": "004010"
			}
		},
		"transactionsets": [{
			"meta": {
				"type": "TransactionSet",
				"ST01": {
					"desc": "Transaction Set Identifier Code",
					"value": "810"
				},
				"ST02": {
					"desc": "Transaction Set Control Number",
					"value": "0001"
				}
			},
			"segments": [{
				"type": "Segment",
				"name": "BIG",
				"BIG01": {
					"desc": "Date",
					"value": "20090629"
				},
				"BIG02": {
					"desc": "Invoice Number",
					"value": "3003014445"
				},
				"BIG03": {
					"desc": "Date",
					"value": null
				},
				"BIG04": {
					"desc": "Purchase Order Number",
					"value": "0476553272"
				},
				"BIG05": {
					"desc": "Release Number",
					"value": null
				},
				"BIG06": {
					"desc": "Change Order Sequence Number",
					"value": null
				},
				"BIG07": {
					"desc": "Transaction Type Code",
					"value": "DR"
				}
			},
...            

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

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

Syntax

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

virtual INT IPWORKSEDITRANSLATOR_CALL FireEndFunctionalGroup(LPSTR &lpszTag, LPSTR &lpszControlNumber, INT &iCount, LPSTR &lpszFullSegment);
class X12TranslatorEndFunctionalGroupEventParams {
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(X12TranslatorEndFunctionalGroupEventParams *e);
// Or, subclass X12Translator and override this emitter function. virtual int FireEndFunctionalGroup(X12TranslatorEndFunctionalGroupEventParams *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 (X12Translator Class)

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

Syntax

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

virtual INT IPWORKSEDITRANSLATOR_CALL FireEndInterchange(LPSTR &lpszTag, LPSTR &lpszControlNumber, LPSTR &lpszFullSegment);
class X12TranslatorEndInterchangeEventParams {
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(X12TranslatorEndInterchangeEventParams *e);
// Or, subclass X12Translator and override this emitter function. virtual int FireEndInterchange(X12TranslatorEndInterchangeEventParams *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 (X12Translator Class)

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

Syntax

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

virtual INT IPWORKSEDITRANSLATOR_CALL FireEndLoop();
class X12TranslatorEndLoopEventParams {
public:
  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};
// To handle, connect one or more slots to this signal. void EndLoop(X12TranslatorEndLoopEventParams *e);
// Or, subclass X12Translator and override this emitter function. virtual int FireEndLoop(X12TranslatorEndLoopEventParams *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 (X12Translator Class)

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

Syntax

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

virtual INT IPWORKSEDITRANSLATOR_CALL FireEndTransaction(LPSTR &lpszTag, LPSTR &lpszControlNumber, INT &iCount, LPSTR &lpszFullSegment);
class X12TranslatorEndTransactionEventParams {
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(X12TranslatorEndTransactionEventParams *e);
// Or, subclass X12Translator and override this emitter function. virtual int FireEndTransaction(X12TranslatorEndTransactionEventParams *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 (X12Translator Class)

Information about errors during data delivery.

Syntax

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

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

  const QString &Description();

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

Remarks

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

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

ResolveSchema Event (X12Translator Class)

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

Syntax

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

virtual INT IPWORKSEDITRANSLATOR_CALL FireResolveSchema(LPSTR &lpszTransactionCode, LPSTR &lpszStandardVersion);
class X12TranslatorResolveSchemaEventParams {
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(X12TranslatorResolveSchemaEventParams *e);
// Or, subclass X12Translator and override this emitter function. virtual int FireResolveSchema(X12TranslatorResolveSchemaEventParams *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 (X12Translator Class)

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

Syntax

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

virtual INT IPWORKSEDITRANSLATOR_CALL FireSegment(LPSTR &lpszTag, LPSTR &lpszName, LPSTR &lpszLoopName, LPSTR &lpszFullSegment);
class X12TranslatorSegmentEventParams {
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(X12TranslatorSegmentEventParams *e);
// Or, subclass X12Translator and override this emitter function. virtual int FireSegment(X12TranslatorSegmentEventParams *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 (X12Translator Class)

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

Syntax

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

virtual INT IPWORKSEDITRANSLATOR_CALL FireStartFunctionalGroup(LPSTR &lpszTag, LPSTR &lpszControlNumber, LPSTR &lpszFullSegment);
class X12TranslatorStartFunctionalGroupEventParams {
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(X12TranslatorStartFunctionalGroupEventParams *e);
// Or, subclass X12Translator and override this emitter function. virtual int FireStartFunctionalGroup(X12TranslatorStartFunctionalGroupEventParams *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 (X12Translator Class)

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

Syntax

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

virtual INT IPWORKSEDITRANSLATOR_CALL FireStartInterchange(LPSTR &lpszTag, LPSTR &lpszControlNumber, LPSTR &lpszFullSegment);
class X12TranslatorStartInterchangeEventParams {
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(X12TranslatorStartInterchangeEventParams *e);
// Or, subclass X12Translator and override this emitter function. virtual int FireStartInterchange(X12TranslatorStartInterchangeEventParams *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 (X12Translator Class)

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

Syntax

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

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

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};
// To handle, connect one or more slots to this signal. void StartLoop(X12TranslatorStartLoopEventParams *e);
// Or, subclass X12Translator and override this emitter function. virtual int FireStartLoop(X12TranslatorStartLoopEventParams *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 (X12Translator Class)

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

Syntax

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

virtual INT IPWORKSEDITRANSLATOR_CALL FireStartTransaction(LPSTR &lpszTag, LPSTR &lpszControlNumber, LPSTR &lpszCode, LPSTR &lpszFullSegment);
class X12TranslatorStartTransactionEventParams {
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(X12TranslatorStartTransactionEventParams *e);
// Or, subclass X12Translator and override this emitter function. virtual int FireStartTransaction(X12TranslatorStartTransactionEventParams *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 (X12Translator Class)

Fires whenever a validation warning is encountered.

Syntax

ANSI (Cross Platform)
virtual int FireWarning(X12TranslatorWarningEventParams *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; } X12TranslatorWarningEventParams;
Unicode (Windows) virtual INT FireWarning(X12TranslatorWarningEventParams *e);
typedef struct {
INT WarnCode;
LPCWSTR Message;
INT SegmentNumber;
LPCWSTR SegmentTag;
LPCWSTR TechnicalErrorCode;
LPCWSTR SegmentErrorCode;
LPCWSTR ElementErrorCode;
INT ElementPosition; INT reserved; } X12TranslatorWarningEventParams;
#define EID_X12TRANSLATOR_WARNING 12

virtual INT IPWORKSEDITRANSLATOR_CALL FireWarning(INT &iWarnCode, LPSTR &lpszMessage, INT &iSegmentNumber, LPSTR &lpszSegmentTag, LPSTR &lpszTechnicalErrorCode, LPSTR &lpszSegmentErrorCode, LPSTR &lpszElementErrorCode, INT &iElementPosition);
class X12TranslatorWarningEventParams {
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(X12TranslatorWarningEventParams *e);
// Or, subclass X12Translator and override this emitter function. virtual int FireWarning(X12TranslatorWarningEventParams *e) {...}

Remarks

The Warning event will fire during parsing of a segment of an EDI document. The WarnCode parameter contains the type of warning encountered. Message is a textual description of the problem. SegmentNumber is the index of the segment where the problem was found.

SegmentTag holds the tag name of the segment. SegmentErrorCode holds the error code that may be used in the IK304 field of a 999. ElementErrorCode holds the error code that may be used in the IK403 field of a 999. ElementPosition is the position of the element where the error occurred.

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

Possible WarnCode values are:

0 The component is not required but is present.
1 Invalid segment count.
2 Invalid transaction count.
3 Invalid group count.
4 Invalid interchange control number.
5 Invalid group control number.
6 Invalid transaction control number.
10 A required data element is missing.
11 Invalid field length.
12 Invalid field value.
13 A required component is missing.
14 The data element is not defined but is present.
30 Required segment is missing.
31 Required loop is missing.
32 Occurrences exceeds the schema defined limit.
33 Occurrences is less than the schema defined minimum.
40 Paired rule validation failed, the pair of elements must be present.
41 At least one of element is required, see message for list of elements.
42 Exclusion validation failed, only one of the elements can be present.
43 Conditional rule validation failed.
44 List conditional rule validation failed.
45 First then none validation failed. The presence of an element requires that other specific elements must not be present.
46 Only one or none of the elements can be present.

TechnicalErrorCode holds a technical error code that helps identify structural issues with the document. For instance when parsing an X12 document this will hold values that may be used for TA1 error codes. When parsing X12 documents the following codes are applicable:

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

Config Settings (X12Translator Class)

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

X12Translator Config Settings

ComponentDelimiter:   The delimiter character to use to separate components.

When set, this changes the default delimiter to use to separate components within a data element. The default value depends on the EDI specification being used.

CrossFieldValidationEnabled:   Enables cross-field validation rules.

If true, cross-field validation rules present in the document schema will be checked. The default value is false. Note, Bots Schema Files do not support syntax rules, therefore CrossFieldValidation rules will never execute for these schemas.

EDIStandard:   The document format.

This property specifies standard that the document follows. Possible values are:

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

ElementDelimiter:   The delimiter character to use to separate data elements.

When set, this changes the default delimiter to use to separate data elements within a segment. The default value depends on the EDI specification being used.

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

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

IncludeEmptyElements:   Whether to include empty data elements in a composite element.

When translating to EDIFACT or X12 this setting specifies whether empty data elements of a composite element will be included. For instance when set to True (default) a segment may look like:

PYT+8+COLLECT:::+25'
When set to False empty data elements are not include and a segment may look like:
PYT+8+COLLECT+25'
IncludeFooters:   Whether to include footer information in the XML.

This setting specifies whether footer information is included in the translated XML. For EDIFACT this includes UNT, UNE, and UNZ. For X12 this include GE, SE, and IEA. The default value is True.

IncludeUNA:   Whether to include the UNA segment in the output.

This setting controls whether the output EDIFACT document contains the UNA segment. The default value is True. This may be set to False if there is a specific reason to not include the UNA segment.

JSONElementPrefix:   An optional prefix for reserved names when translating to JSON.

This setting optionally specifies a prefix to prepend to the meta, type, desc, and value JSON elements when translating to JSON. This may be set to any ASCII character if desired. For instance:

//use the '@' character translator.Config("JSONElementPrefix=@"); Will result in JSON like:

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

The default value is empty string and no prefix is used.

LastIXControlNumber:   The control number of the most recently parsed interchange.

This setting may be queried from within events. For instance from within the Warning event it may be desirable to know which interchange control number the warning applies to; in that case querying this setting from within Warning will return the expected value.

LastTransactionControlNumber:   The control number of the most recently parsed transaction.

This setting may be queried from within events. For instance from within the Warning event it may be desirable to know which transaction control number the warning applies to; in that case querying this setting from within Warning will return the expected value.

ReleaseChar:   The character to use to escape delimiters within values.

When set, this changes the default escape character. The default value depends on the EDI specification being used.

RenamingRulesData:   The renaming rules data.

This setting may be used to get or set renaming rules without using a file on disk. When calling SaveRenamingRules or LoadRenamingRules set the RuleFile parameter of the method to empty string to use the value in this setting instead of a file on disk. For instance: //Save Renaming Rules editranslator.SaveRenamingRules(""); string ruleData = editranslator.Config("RenamingRulesData");

//Load Renaming Rules editranslator.Config("RenamingRulesData=" + ruleData); editranslator.LoadRenamingRules("");

RepetitionChar:   The repetition character.

When set, this changes the default repetition character. The default value depends on the EDI specification being used.

SegmentDelimiter:   The delimiter character to use to separate segments.

When set, this changes the default delimiter to use to separate segments within an EDI document. The default value depends on the EDI specification being used.

StrictSchemaValidation:   Specifies the behavior during schema validation.

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

0 (Ignore) All validation warnings will be ignored. Warning will not fire with warnings.
1 (Warn - default) The Warning event will fire with all validation warnings.
2 (Error) All validation warnings are treated as errors and will cause an exception. Processing will stop immediately.
UseXMLComments:   Whether the human readable description is stored as an attribute or XML comments.

When translating to XML the human readable description of the element will be included in the output. This setting specifies whether the description is present as an attribute of the XML element, or preceding the XML element as a XML comment. For instance:

UseXMLComments is True or 1:

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

UseXMLComments is False or 0 (default):

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

The special value 2 tells the class to omit all comments. For instance:

UseXMLComments is 2:

<N101>ST</N101>
This setting is False (0) by default.

Base Config Settings

BuildInfo:   Information about the product's build.

When queried, this setting will return a string containing information about the product's build.

CodePage:   The system code page used for Unicode to Multibyte translations.

The default code page is Unicode UTF-8 (65001).

The following is a list of valid code page identifiers:

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

LicenseInfo:   Information about the current license.

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

  • Product: The product the license is for.
  • Product Key: The key the license was generated from.
  • License Source: Where the license was found (e.g., RuntimeLicense, License File).
  • License Type: The type of license installed (e.g., Royalty Free, Single Server).
  • Last Valid Build: The last valid build number for which the license will work.
MaskSensitive:   Whether sensitive data is masked in log messages.

In certain circumstances it may be beneficial to mask sensitive data, like passwords, in log messages. Set this to true to mask sensitive data. The default is true.

This setting only works on these classes: AS3Receiver, AS3Sender, Atom, Client(3DS), FTP, FTPServer, IMAP, OFTPClient, SSHClient, SCP, Server(3DS), Sexec, SFTP, SFTPServer, SSHServer, TCPClient, TCPServer.

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

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

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

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

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

When set to true, the class will utilize the underlying operating system's certified APIs. Java editions, regardless of OS, utilize Bouncy Castle FIPS, while all the other Windows editions make use of Microsoft security libraries.

FIPS mode can be enabled by setting the UseFIPSCompliantAPI configuration setting to true. This is a static setting which applies to all instances of all classes of the toolkit within the process. It is recommended to enable or disable this setting once before the component has been used to establish a connection. Enabling FIPS while an instance of the component is active and connected may result in unexpected behavior.

For more details please see the FIPS 140-2 Compliance article.

Note: This setting is only applicable on Windows.

Note: Enabling FIPS-compliance requires a special license; please contact sales@nsoftware.com for details.

UseInternalSecurityAPI:   Tells the class whether or not to use the system security libraries or an internal implementation.

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

Setting this setting to true tells the class to use the internal implementation instead of using the system security libraries.

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

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

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

X12Translator Errors

304   The file exists and Overwrite is set to False.
1000   Input/Output error
1001   No stream or file name were specified for the component
1002   Unexpected end of file (EOF).
1003   Segment not found.
1004   Segment not found in schema.
1005   Schema not found.
1010   Invalid Writer state.
1011   Segment does not have the specified element or component.
1012   Invalid XPath.
1013   DOM tree unavailable (set BuildDOM and reparse).
1014   Document contains incomplete segments.
1015   Document contains an open EDI structure (interchange, functional group or transaction) with no matching footer segment.
1044   Error while reading schema file.
1100   Component is busy.
1099   Unexpected error.
1000   Input/Output error
1001   No stream or file name were specified for the component
1002   Unexpected end of file (EOF).
1003   Segment not found.
1004   Segment not found in schema.
1005   Schema not found.
1010   Invalid Writer state.
1011   Segment does not have the specified element or component.
1044   Error while reading schema file.
1099   Unexpected error.