EDIFACTTranslator Class

Properties Methods Events Config Settings Errors

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

Syntax

EDIFACTTranslator

Remarks

The class provides a way to convert EDIFACT 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

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 EDIFACT to XML

Edifacttranslator translator = new Edifacttranslator(); translator.InputFormat = EdifacttranslatorInputFormats.ifEDIFACT; translator.OutputFormat = EdifacttranslatorOutputFormats.ofXML; translator.InputFile = "EDIFACT_D97A_INVOIC.edi"; translator.OutputFile = "EDIFACT_D97A_INVOIC.xml"; translator.SchemaFormat = EdifacttranslatorSchemaFormats.schemaJSON; translator.LoadSchema("RSSBus_D97A_INVOIC.json"); translator.Translate();

The code above creates an XML document with content like:

<Interchange Delimiters=":+.?*&apos;" xmlns="http://www.nsoftware.com" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
    <Meta>
        <UNB1 type="Composite" desc="SYNTAX IDENTIFIER">
            <UNB1.1 desc="Syntax identifier">UNOB</UNB1.1>
            <UNB1.2 desc="Syntax version number">1</UNB1.2>
        </UNB1>
        <UNB2 type="Composite" desc="INTERCHANGE SENDER">
            <UNB2.1 desc="Interchange sender identification">WAYNE_TECH</UNB2.1>
        </UNB2>
        <UNB3 type="Composite" desc="INTERCHANGE RECIPIENT">
            <UNB3.1 desc="Interchange recipient identification">ACME</UNB3.1>
        </UNB3>
        <UNB4 type="Composite" desc="DATE AND TIME OF PREPARATION">
            <UNB4.1 desc="Date">160707</UNB4.1>
            <UNB4.2 desc="Time">1547</UNB4.2>
        </UNB4>
        <UNB5 desc="Interchange control reference">000000002</UNB5>
        <UNB6 type="Composite" desc="RECIPIENT&apos;S REFERENCE/PASSWORD DETAILS">
            <UNB6.1 desc="Recipient reference/password"/>
        </UNB6>
        <UNB7 desc="Application reference">1234</UNB7>
        <UNB8 desc="Processing priority code"/>
        <UNB9 desc="Acknowledgement request"/>
        <UNB10 desc="Interchange agreement identifier"/>
        <UNB11 desc="Test indicator">1</UNB11>
    </Meta>
    <TransactionSet>
        <TX-D97A-INVOIC type="TransactionSet">
            <Meta>
                <UNH1 desc="MESSAGE REFERENCE NUMBER">509010117</UNH1>
                <UNH2 type="Composite" desc="MESSAGE IDENTIFIER">
                    <UNH2.1 desc="Message type identifier">INVOIC</UNH2.1>
                    <UNH2.2 desc="Message type version number">D</UNH2.2>
                    <UNH2.3 desc="Message type release number">97A</UNH2.3>
                    <UNH2.4 desc="Controlling agency">UN</UNH2.4>
                </UNH2>
            </Meta>
            <BGM type="Segment">
                <BGM01 type="Composite" desc="DOCUMENT/MESSAGE NAME">
                    <BGM0101 desc="Document/message name, coded">380</BGM0101>
                    <BGM0102 desc="Code list qualifier"/>
                    <BGM0103 desc="Code list responsible agency, coded"/>
                    <BGM0104 desc="Document/message name">TAX INVOICE</BGM0104>
                </BGM01>
...

Example - Translating EDIFACT to JSON

Edifacttranslator translator = new Edifacttranslator(); translator.InputFormat = EdifacttranslatorInputFormats.ifEDIFACT; translator.OutputFormat = EdifacttranslatorOutputFormats.ofJSON; translator.InputFile = "EDIFACT_D97A_INVOIC.edi"; translator.OutputFile = "EDIFACT_D97A_INVOIC.json"; translator.SchemaFormat = EdifacttranslatorSchemaFormats.schemaJSON; translator.LoadSchema("RSSBus_D97A_INVOIC.json"); translator.Translate();

The code above creates a JSON document with content like:

{
	"meta": {
		"type": "Interchange",
		"delimiters": ":+.?*'",
		"UNB1": {
			"type": "Composite",
			"desc": "SYNTAX IDENTIFIER",
			"UNB1.1": {
				"desc": "Syntax identifier",
				"value": "UNOB"
			},
			"UNB1.2": {
				"desc": "Syntax version number",
				"value": "1"
			}
		},
		"UNB2": {
			"type": "Composite",
			"desc": "INTERCHANGE SENDER",
			"UNB2.1": {
				"desc": "Interchange sender identification",
				"value": "WAYNE_TECH"
			}
		},
		"UNB3": {
			"type": "Composite",
			"desc": "INTERCHANGE RECIPIENT",
			"UNB3.1": {
				"desc": "Interchange recipient identification",
				"value": "ACME"
			}
		},
		"UNB4": {
			"type": "Composite",
			"desc": "DATE AND TIME OF PREPARATION",
			"UNB4.1": {
				"desc": "Date",
				"value": "160707"
			},
			"UNB4.2": {
				"desc": "Time",
				"value": "1547"
			}
		},
		"UNB5": {
			"desc": "Interchange control reference",
			"value": "000000002"
		},
		"UNB6": {
			"type": "Composite",
			"desc": "RECIPIENT'S REFERENCE\/PASSWORD DETAILS",
			"UNB6.1": {
				"desc": "Recipient reference\/password",
				"value": ""
			}
		},
		"UNB7": {
			"desc": "Application reference",
			"value": "1234"
		},
		"UNB8": {
			"desc": "Processing priority code",
			"value": ""
		},
		"UNB9": {
			"desc": "Acknowledgement request",
			"value": ""
		},
		"UNB10": {
			"desc": "Interchange agreement identifier",
			"value": ""
		},
		"UNB11": {
			"desc": "Test indicator",
			"value": "1"
		}
	},
	"transactionsets": [{
		"meta": {
			"type": "TransactionSet",
			"UNH1": {
				"desc": "MESSAGE REFERENCE NUMBER",
				"value": "509010117"
			},
			"UNH2": {
				"type": "Composite",
				"desc": "MESSAGE IDENTIFIER",
				"UNH2.1": {
					"desc": "Message type identifier",
					"value": "INVOIC"
				},
				"UNH2.2": {
					"desc": "Message type version number",
					"value": "D"
				},
				"UNH2.3": {
					"desc": "Message type release number",
					"value": "97A"
				},
				"UNH2.4": {
					"desc": "Controlling agency",
					"value": "UN"
				}
			}
		},
		"segments": [{
			"type": "Segment",
			"name": "BGM",
			"BGM01": {
				"type": "Composite",
				"desc": "DOCUMENT\/MESSAGE NAME",
				"BGM0101": {
					"desc": "Document\/message name, coded",
					"value": "380"
				},
				"BGM0102": {
					"desc": "Code list qualifier",
					"value": ""
				},
				"BGM0103": {
					"desc": "Code list responsible agency, coded",
					"value": ""
				},
				"BGM0104": {
					"desc": "Document\/message name",
					"value": "TAX INVOICE"
				}
			},
...

Property List

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


InputData	The data to translate.
InputFile	The file to translate.
InputFormat	The format of the input data.
OutputData	The translated data.
OutputFile	The file to which the translated data will be written.
OutputFormat	The format of the output data.
Overwrite	Whether to overwrite the file.
RenamingRule	The rule defining how EDI elements are renamed when translating to XML or JSON.
RenamingRuleCount	The number of renaming rules.
RenamingRuleIndex	The index of the current renaming rule.
SchemaFormat	The format of the schema file.
Suffix	What to append after each segment delimiter.
UseSchemaName	Whether 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.


AddRenamingRule	This method adds a renaming rule to define how an EDI element is renamed when translating to XML.
Config	Sets or retrieves a configuration setting.
DisplaySchemaInfo	Returns a string showing the structure of the schema defining the document.
ExportXMLSchema	Exports a XML schema.
GenerateAck	Generates an EDI acknowledgement.
LoadRenamingRules	Loads a set of renaming rules from file.
LoadSchema	Loads a schema file describing a Transaction Set.
Reset	Resets the state of the control.
SaveRenamingRules	Saves the current renaming rule set to a file.
Translate	Translates 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.


EndFunctionalGroup	Fires whenever a control segment is read that marks the end of an interchange.
EndInterchange	Fires whenever a control segment is read that marks the end of an interchange.
EndLoop	Fires when the end of a loop is detected in a transaction set.
EndTransaction	Fires whenever a control segment is read that marks the end of a transaction.
Error	Fired when information is available about errors during data delivery.
ResolveSchema	Fires whenever a new transaction set is encountered and no schema is found for it.
Segment	Fires whenever a data segment in a transaction set is read.
StartFunctionalGroup	Fires whenever a control segment is read that marks the start of a functional group.
StartInterchange	Fires whenever a control segment is read that marks the start of an interchange.
StartLoop	Fires when the starting of a loop is detected in a transaction set.
StartTransaction	Fires whenever a control segment is read that marks the start of a transaction.
Warning	Fires 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.


ComponentDelimiter	The delimiter character to use to separate classes.
CrossFieldValidationEnabled	Enables cross-field validation rules.
EDIStandard	The document format.
ElementDelimiter	The delimiter character to use to separate data elements.
Encoding	The character encoding to be applied when reading and writing data.
IncludeEmptyElements	Whether to include empty data elements in a composite element.
IncludeFooters	Whether to include footer information in the XML.
IncludeUNA	Whether to include the UNA segment in the output.
JSONElementPrefix	An optional prefix for reserved names when translating to JSON.
LastIXControlNumber	The control number of the most recently parsed interchange.
LastTransactionControlNumber	The control number of the most recently parsed transaction.
ReleaseChar	The character to use to escape delimiters within values.
RenamingRulesData	The renaming rules data.
RepetitionChar	The repetition character.
SegmentDelimiter	The delimiter character to use to separate segments.
StrictSchemaValidation	Specifies the behavior during schema validation.
UseXMLComments	Whether the human readable description is stored as an attribute or XML comments.
BuildInfo	Information about the product's build.
CodePage	The system code page used for Unicode to Multibyte translations.
LicenseInfo	Information about the current license.
MaskSensitive	Whether sensitive data is masked in log messages.
ProcessIdleEvents	Whether the class uses its internal event loop to process events when the main thread is idle.
SelectWaitMillis	The length of time in milliseconds the class will wait when DoEvents is called if there are no events to process.
UseFIPSCompliantAPI	Tells the class whether or not to use FIPS certified APIs.
UseInternalSecurityAPI	Whether or not to use the system security libraries or an internal implementation.

InputData Property (EDIFACTTranslator 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_edifacttranslator_getinputdata(void* lpObj);
int ipworkseditranslator_edifacttranslator_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

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 (EDIFACTTranslator 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_edifacttranslator_getinputfile(void* lpObj);
int ipworkseditranslator_edifacttranslator_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

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 (EDIFACTTranslator 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

EIF_XML(0), 
EIF_JSON(1), 
EIF_EDIFACT(2)

int ipworkseditranslator_edifacttranslator_getinputformat(void* lpObj);
int ipworkseditranslator_edifacttranslator_setinputformat(void* lpObj, int iInputFormat);

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

Default Value

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)
2 (ifEDIFACT)

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 (EDIFACTTranslator 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_edifacttranslator_getoutputdata(void* lpObj);
int ipworkseditranslator_edifacttranslator_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

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 (EDIFACTTranslator 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_edifacttranslator_getoutputfile(void* lpObj);
int ipworkseditranslator_edifacttranslator_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

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 (EDIFACTTranslator 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

EOF_XML(0), 
EOF_JSON(1), 
EOF_EDIFACT(2)

int ipworkseditranslator_edifacttranslator_getoutputformat(void* lpObj);
int ipworkseditranslator_edifacttranslator_setoutputformat(void* lpObj, int iOutputFormat);

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

Default Value

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)
2 (ofEDIFACT)

This property is not available at design time.

Data Type

Integer

Overwrite Property (EDIFACTTranslator 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_edifacttranslator_getoverwrite(void* lpObj);
int ipworkseditranslator_edifacttranslator_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 (EDIFACTTranslator 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_edifacttranslator_getrenamingrule(void* lpObj);
int ipworkseditranslator_edifacttranslator_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 (EDIFACTTranslator Class)

The number of renaming rules.

Syntax

ANSI (Cross Platform)
int GetRenamingRuleCount();

Unicode (Windows)
INT GetRenamingRuleCount();

int ipworkseditranslator_edifacttranslator_getrenamingrulecount(void* lpObj);

int GetRenamingRuleCount();

Default Value

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 (EDIFACTTranslator 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_edifacttranslator_getrenamingruleindex(void* lpObj);
int ipworkseditranslator_edifacttranslator_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 (EDIFACTTranslator 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_edifacttranslator_getschemaformat(void* lpObj);
int ipworkseditranslator_edifacttranslator_setschemaformat(void* lpObj, int iSchemaFormat);

int GetSchemaFormat();
int SetSchemaFormat(int iSchemaFormat);

Default Value

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

Data Type

Integer

Suffix Property (EDIFACTTranslator 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_edifacttranslator_getsuffix(void* lpObj);
int ipworkseditranslator_edifacttranslator_setsuffix(void* lpObj, int iSuffix);

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

Default Value

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 (EDIFACTTranslator 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_edifacttranslator_getuseschemaname(void* lpObj);
int ipworkseditranslator_edifacttranslator_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>

The default value is False. This setting is only applicable when using ArcESB JSON schemas.

Data Type

Boolean

AddRenamingRule Method (EDIFACTTranslator 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_edifacttranslator_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 (EDIFACTTranslator Class)

Sets or retrieves a configuration setting.

Syntax

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

Unicode (Windows)
LPWSTR Config(LPCWSTR lpszConfigurationString);

char* ipworkseditranslator_edifacttranslator_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 (EDIFACTTranslator 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_edifacttranslator_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++)

ExportXMLSchema Method (EDIFACTTranslator Class)

Exports a XML schema.

Syntax

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

Unicode (Windows)
INT ExportXMLSchema(LPCWSTR lpszSchemaFile);

int ipworkseditranslator_edifacttranslator_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++)

GenerateAck Method (EDIFACTTranslator Class)

Generates an EDI acknowledgement.

Syntax

ANSI (Cross Platform)
char* GenerateAck();

Unicode (Windows)
LPWSTR GenerateAck();

char* ipworkseditranslator_edifacttranslator_generateack(void* lpObj);

QString GenerateAck();

Remarks

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

Error Handling (C++)

LoadRenamingRules Method (EDIFACTTranslator 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_edifacttranslator_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++)

LoadSchema Method (EDIFACTTranslator 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_edifacttranslator_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++)

Reset Method (EDIFACTTranslator Class)

Resets the state of the control.

Syntax

ANSI (Cross Platform)
int Reset();

Unicode (Windows)
INT Reset();

int ipworkseditranslator_edifacttranslator_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++)

SaveRenamingRules Method (EDIFACTTranslator 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_edifacttranslator_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++)

Translate Method (EDIFACTTranslator Class)

Translates the specified data.

Syntax

ANSI (Cross Platform)
int Translate();

Unicode (Windows)
INT Translate();

int ipworkseditranslator_edifacttranslator_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.

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

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

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 EDIFACT to XML

The code above creates an XML document with content like:

<Interchange Delimiters=":+.?*&apos;" xmlns="http://www.nsoftware.com" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
    <Meta>
        <UNB1 type="Composite" desc="SYNTAX IDENTIFIER">
            <UNB1.1 desc="Syntax identifier">UNOB</UNB1.1>
            <UNB1.2 desc="Syntax version number">1</UNB1.2>
        </UNB1>
        <UNB2 type="Composite" desc="INTERCHANGE SENDER">
            <UNB2.1 desc="Interchange sender identification">WAYNE_TECH</UNB2.1>
        </UNB2>
        <UNB3 type="Composite" desc="INTERCHANGE RECIPIENT">
            <UNB3.1 desc="Interchange recipient identification">ACME</UNB3.1>
        </UNB3>
        <UNB4 type="Composite" desc="DATE AND TIME OF PREPARATION">
            <UNB4.1 desc="Date">160707</UNB4.1>
            <UNB4.2 desc="Time">1547</UNB4.2>
        </UNB4>
        <UNB5 desc="Interchange control reference">000000002</UNB5>
        <UNB6 type="Composite" desc="RECIPIENT&apos;S REFERENCE/PASSWORD DETAILS">
            <UNB6.1 desc="Recipient reference/password"/>
        </UNB6>
        <UNB7 desc="Application reference">1234</UNB7>
        <UNB8 desc="Processing priority code"/>
        <UNB9 desc="Acknowledgement request"/>
        <UNB10 desc="Interchange agreement identifier"/>
        <UNB11 desc="Test indicator">1</UNB11>
    </Meta>
    <TransactionSet>
        <TX-D97A-INVOIC type="TransactionSet">
            <Meta>
                <UNH1 desc="MESSAGE REFERENCE NUMBER">509010117</UNH1>
                <UNH2 type="Composite" desc="MESSAGE IDENTIFIER">
                    <UNH2.1 desc="Message type identifier">INVOIC</UNH2.1>
                    <UNH2.2 desc="Message type version number">D</UNH2.2>
                    <UNH2.3 desc="Message type release number">97A</UNH2.3>
                    <UNH2.4 desc="Controlling agency">UN</UNH2.4>
                </UNH2>
            </Meta>
            <BGM type="Segment">
                <BGM01 type="Composite" desc="DOCUMENT/MESSAGE NAME">
                    <BGM0101 desc="Document/message name, coded">380</BGM0101>
                    <BGM0102 desc="Code list qualifier"/>
                    <BGM0103 desc="Code list responsible agency, coded"/>
                    <BGM0104 desc="Document/message name">TAX INVOICE</BGM0104>
                </BGM01>
...

Example - Translating EDIFACT to JSON

Edifacttranslator translator = new Edifacttranslator(); translator.InputFormat = EdifacttranslatorInputFormats.ifEDIFACT; translator.OutputFormat = EdifacttranslatorOutputFormats.ofJSON; translator.InputFile = "EDIFACT_D97A_INVOIC.edi"; translator.OutputFile = "EDIFACT_D97A_INVOIC.json"; translator.SchemaFormat = EdifacttranslatorSchemaFormats.schemaJSON; translator.LoadSchema("RSSBus_D97A_INVOIC.json"); translator.Translate();

The code above creates a JSON document with content like:

{
	"meta": {
		"type": "Interchange",
		"delimiters": ":+.?*'",
		"UNB1": {
			"type": "Composite",
			"desc": "SYNTAX IDENTIFIER",
			"UNB1.1": {
				"desc": "Syntax identifier",
				"value": "UNOB"
			},
			"UNB1.2": {
				"desc": "Syntax version number",
				"value": "1"
			}
		},
		"UNB2": {
			"type": "Composite",
			"desc": "INTERCHANGE SENDER",
			"UNB2.1": {
				"desc": "Interchange sender identification",
				"value": "WAYNE_TECH"
			}
		},
		"UNB3": {
			"type": "Composite",
			"desc": "INTERCHANGE RECIPIENT",
			"UNB3.1": {
				"desc": "Interchange recipient identification",
				"value": "ACME"
			}
		},
		"UNB4": {
			"type": "Composite",
			"desc": "DATE AND TIME OF PREPARATION",
			"UNB4.1": {
				"desc": "Date",
				"value": "160707"
			},
			"UNB4.2": {
				"desc": "Time",
				"value": "1547"
			}
		},
		"UNB5": {
			"desc": "Interchange control reference",
			"value": "000000002"
		},
		"UNB6": {
			"type": "Composite",
			"desc": "RECIPIENT'S REFERENCE\/PASSWORD DETAILS",
			"UNB6.1": {
				"desc": "Recipient reference\/password",
				"value": ""
			}
		},
		"UNB7": {
			"desc": "Application reference",
			"value": "1234"
		},
		"UNB8": {
			"desc": "Processing priority code",
			"value": ""
		},
		"UNB9": {
			"desc": "Acknowledgement request",
			"value": ""
		},
		"UNB10": {
			"desc": "Interchange agreement identifier",
			"value": ""
		},
		"UNB11": {
			"desc": "Test indicator",
			"value": "1"
		}
	},
	"transactionsets": [{
		"meta": {
			"type": "TransactionSet",
			"UNH1": {
				"desc": "MESSAGE REFERENCE NUMBER",
				"value": "509010117"
			},
			"UNH2": {
				"type": "Composite",
				"desc": "MESSAGE IDENTIFIER",
				"UNH2.1": {
					"desc": "Message type identifier",
					"value": "INVOIC"
				},
				"UNH2.2": {
					"desc": "Message type version number",
					"value": "D"
				},
				"UNH2.3": {
					"desc": "Message type release number",
					"value": "97A"
				},
				"UNH2.4": {
					"desc": "Controlling agency",
					"value": "UN"
				}
			}
		},
		"segments": [{
			"type": "Segment",
			"name": "BGM",
			"BGM01": {
				"type": "Composite",
				"desc": "DOCUMENT\/MESSAGE NAME",
				"BGM0101": {
					"desc": "Document\/message name, coded",
					"value": "380"
				},
				"BGM0102": {
					"desc": "Code list qualifier",
					"value": ""
				},
				"BGM0103": {
					"desc": "Code list responsible agency, coded",
					"value": ""
				},
				"BGM0104": {
					"desc": "Document\/message name",
					"value": "TAX INVOICE"
				}
			},
...

Error Handling (C++)

EndFunctionalGroup Event (EDIFACTTranslator Class)

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

Syntax

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

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


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

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

#define EID_EDIFACTTRANSLATOR_ENDFUNCTIONALGROUP 1

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

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

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

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

Syntax

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

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


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

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

#define EID_EDIFACTTRANSLATOR_ENDINTERCHANGE 2

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

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

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

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

Syntax

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

typedef struct {
  int reserved;
} EDIFACTTranslatorEndLoopEventParams;


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

typedef struct {
  INT reserved;
} EDIFACTTranslatorEndLoopEventParams;

#define EID_EDIFACTTRANSLATOR_ENDLOOP 3

virtual INT IPWORKSEDITRANSLATOR_CALL FireEndLoop();

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

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

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

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

Syntax

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

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


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

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

#define EID_EDIFACTTRANSLATOR_ENDTRANSACTION 4

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

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

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

Fired when information is available about errors during data delivery.

Syntax

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

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


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

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

#define EID_EDIFACTTRANSLATOR_ERROR 5

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

class EDIFACTTranslatorErrorEventParams {
public:
  int ErrorCode();

  const QString &Description();

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

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

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

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

Syntax

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

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


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

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

#define EID_EDIFACTTRANSLATOR_RESOLVESCHEMA 6

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

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

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

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

Syntax

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

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


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

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

#define EID_EDIFACTTRANSLATOR_SEGMENT 7

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

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

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

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

Syntax

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

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


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

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

#define EID_EDIFACTTRANSLATOR_STARTFUNCTIONALGROUP 8

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

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

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

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

Syntax

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

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


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

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

#define EID_EDIFACTTRANSLATOR_STARTINTERCHANGE 9

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

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

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

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

Syntax

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

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


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

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

#define EID_EDIFACTTRANSLATOR_STARTLOOP 10

virtual INT IPWORKSEDITRANSLATOR_CALL FireStartLoop(LPSTR &lpszName);

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

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

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

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

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

Syntax

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

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


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

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

#define EID_EDIFACTTRANSLATOR_STARTTRANSACTION 11

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

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

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

Fires whenever a validation warning is encountered.

Syntax

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


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

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

#define EID_EDIFACTTRANSLATOR_WARNING 12

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

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

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


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

Config Settings (EDIFACTTranslator 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.

EDIFACTTranslator 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:


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

The following is a list of valid code page identifiers for Mac OS only:


Identifier	Name
1	ASCII
2	NEXTSTEP
3	JapaneseEUC
4	UTF8
5	ISOLatin1
6	Symbol
7	NonLossyASCII
8	ShiftJIS
9	ISOLatin2
10	Unicode
11	WindowsCP1251
12	WindowsCP1252
13	WindowsCP1253
14	WindowsCP1254
15	WindowsCP1250
21	ISO2022JP
30	MacOSRoman
10	UTF16String
0x90000100	UTF16BigEndian
0x94000100	UTF16LittleEndian
0x8c000100	UTF32String
0x98000100	UTF32BigEndian
0x9c000100	UTF32LittleEndian
65536	Proprietary

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: 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 configuration 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 (EDIFACTTranslator 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.

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