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.

Class Name

IPWorksEDITranslator_EDIFACTTranslator

Procedural Interface

 ipworkseditranslator_edifacttranslator_open();
 ipworkseditranslator_edifacttranslator_close($res);
 ipworkseditranslator_edifacttranslator_register_callback($res, $id, $function);
 ipworkseditranslator_edifacttranslator_get_last_error($res);
 ipworkseditranslator_edifacttranslator_get_last_error_code($res);
 ipworkseditranslator_edifacttranslator_set($res, $id, $index, $value);
 ipworkseditranslator_edifacttranslator_get($res, $id, $index);
 ipworkseditranslator_edifacttranslator_do_addrenamingrule($res, $rule);
 ipworkseditranslator_edifacttranslator_do_config($res, $configurationstring);
 ipworkseditranslator_edifacttranslator_do_displayschemainfo($res);
 ipworkseditranslator_edifacttranslator_do_exportxmlschema($res, $schemafile);
 ipworkseditranslator_edifacttranslator_do_generateack($res);
 ipworkseditranslator_edifacttranslator_do_loadrenamingrules($res, $rulefile);
 ipworkseditranslator_edifacttranslator_do_loadschema($res, $filename);
 ipworkseditranslator_edifacttranslator_do_reset($res);
 ipworkseditranslator_edifacttranslator_do_saverenamingrules($res, $rulefile);
 ipworkseditranslator_edifacttranslator_do_translate($res);

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

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

Method List

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

Event List

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

Config Settings

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

InputData Property (IPWorksEDITranslator_EDIFACTTranslator Class)

The data to translate.

Object Oriented Interface

public function getInputData();


public function setInputData($value);

Procedural Interface

ipworkseditranslator_edifacttranslator_get($res, 1 );


ipworkseditranslator_edifacttranslator_set($res, 1, $value );

Default Value

''

Remarks

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

Input and Output Properties

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

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

• InputFile
• InputData

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

This property is not available at design time.

Data Type

String

InputFile Property (IPWorksEDITranslator_EDIFACTTranslator Class)

The file to translate.

Object Oriented Interface

public function getInputFile();


public function setInputFile($value);

Procedural Interface

ipworkseditranslator_edifacttranslator_get($res, 2 );


ipworkseditranslator_edifacttranslator_set($res, 2, $value );

Default Value

''

Remarks

This property specifies the file to be processed. Set this property to the full or relative path to the file which will be processed. To specify the type of data in the input file set InputFormat.

Input and Output Properties

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

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

• InputFile
• InputData

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

This property is not available at design time.

Data Type

String

InputFormat Property (IPWorksEDITranslator_EDIFACTTranslator Class)

The format of the input data.

Object Oriented Interface

public function getInputFormat();


public function setInputFormat($value);

Procedural Interface

ipworkseditranslator_edifacttranslator_get($res, 3 );


ipworkseditranslator_edifacttranslator_set($res, 3, $value );

Default Value

2

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)

This property is not available at design time.

Data Type

Integer

OutputData Property (IPWorksEDITranslator_EDIFACTTranslator Class)

The translated data.

Object Oriented Interface

public function getOutputData();


public function setOutputData($value);

Procedural Interface

ipworkseditranslator_edifacttranslator_get($res, 4 );


ipworkseditranslator_edifacttranslator_set($res, 4, $value );

Default Value

''

Remarks

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

Input and Output Properties

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

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

• InputFile
• InputData

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

This property is not available at design time.

Data Type

String

OutputFile Property (IPWorksEDITranslator_EDIFACTTranslator Class)

The file to which the translated data will be written.

Object Oriented Interface

public function getOutputFile();


public function setOutputFile($value);

Procedural Interface

ipworkseditranslator_edifacttranslator_get($res, 5 );


ipworkseditranslator_edifacttranslator_set($res, 5, $value );

Default Value

''

Remarks

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

Input and Output Properties

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

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

• InputFile
• InputData

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

This property is not available at design time.

Data Type

String

OutputFormat Property (IPWorksEDITranslator_EDIFACTTranslator Class)

The format of the output data.

Object Oriented Interface

public function getOutputFormat();


public function setOutputFormat($value);

Procedural Interface

ipworkseditranslator_edifacttranslator_get($res, 6 );


ipworkseditranslator_edifacttranslator_set($res, 6, $value );

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

This property is not available at design time.

Data Type

Integer

Overwrite Property (IPWorksEDITranslator_EDIFACTTranslator Class)

Whether to overwrite the file.

Object Oriented Interface

public function getOverwrite();


public function setOverwrite($value);

Procedural Interface

ipworkseditranslator_edifacttranslator_get($res, 7 );


ipworkseditranslator_edifacttranslator_set($res, 7, $value );

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

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

Object Oriented Interface

public function getRenamingRule();


public function setRenamingRule($value);

Procedural Interface

ipworkseditranslator_edifacttranslator_get($res, 8 );


ipworkseditranslator_edifacttranslator_set($res, 8, $value );

Default Value

''

Remarks

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

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

ediname:xmlanme

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

This property is not available at design time.

Data Type

String

RenamingRuleCount Property (IPWorksEDITranslator_EDIFACTTranslator Class)

The number of renaming rules.

Object Oriented Interface

public function getRenamingRuleCount();

Procedural Interface

ipworkseditranslator_edifacttranslator_get($res, 9 );

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

The index of the current renaming rule.

Object Oriented Interface

public function getRenamingRuleIndex();


public function setRenamingRuleIndex($value);

Procedural Interface

ipworkseditranslator_edifacttranslator_get($res, 10 );


ipworkseditranslator_edifacttranslator_set($res, 10, $value );

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

The format of the schema file.

Object Oriented Interface

public function getSchemaFormat();


public function setSchemaFormat($value);

Procedural Interface

ipworkseditranslator_edifacttranslator_get($res, 11 );


ipworkseditranslator_edifacttranslator_set($res, 11, $value );

Default Value

0

Remarks

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

The following schema formats are supported:

Data Type

Integer

Suffix Property (IPWorksEDITranslator_EDIFACTTranslator Class)

What to append after each segment delimiter.

Object Oriented Interface

public function getSuffix();


public function setSuffix($value);

Procedural Interface

ipworkseditranslator_edifacttranslator_get($res, 12 );


ipworkseditranslator_edifacttranslator_set($res, 12, $value );

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

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

Object Oriented Interface

public function getUseSchemaName();


public function setUseSchemaName($value);

Procedural Interface

ipworkseditranslator_edifacttranslator_get($res, 13 );


ipworkseditranslator_edifacttranslator_set($res, 13, $value );

Default Value

false

Remarks

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

BGM+380:::TAX INVOICE

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

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

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

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

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

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

Data Type

Boolean

AddRenamingRule Method (IPWorksEDITranslator_EDIFACTTranslator Class)

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

Object Oriented Interface

public function doAddRenamingRule($rule);

Procedural Interface

ipworkseditranslator_edifacttranslator_do_addrenamingrule($res, $rule);

Remarks

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

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

ediname:xmlanme

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

Config Method (IPWorksEDITranslator_EDIFACTTranslator Class)

Sets or retrieves a configuration setting.

Object Oriented Interface

public function doConfig($configurationstring);

Procedural Interface

ipworkseditranslator_edifacttranslator_do_config($res, $configurationstring);

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.

DisplaySchemaInfo Method (IPWorksEDITranslator_EDIFACTTranslator Class)

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

Object Oriented Interface

public function doDisplaySchemaInfo();

Procedural Interface

ipworkseditranslator_edifacttranslator_do_displayschemainfo($res);

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]

ExportXMLSchema Method (IPWorksEDITranslator_EDIFACTTranslator Class)

Exports a XML schema.

Object Oriented Interface

public function doExportXMLSchema($schemafile);

Procedural Interface

ipworkseditranslator_edifacttranslator_do_exportxmlschema($res, $schemafile);

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.

GenerateAck Method (IPWorksEDITranslator_EDIFACTTranslator Class)

Generates an EDI acknowledgement.

Object Oriented Interface

public function doGenerateAck();

Procedural Interface

ipworkseditranslator_edifacttranslator_do_generateack($res);

Remarks

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

LoadRenamingRules Method (IPWorksEDITranslator_EDIFACTTranslator Class)

Loads a set of renaming rules from file.

Object Oriented Interface

public function doLoadRenamingRules($rulefile);

Procedural Interface

ipworkseditranslator_edifacttranslator_do_loadrenamingrules($res, $rulefile);

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.

LoadSchema Method (IPWorksEDITranslator_EDIFACTTranslator Class)

Loads a schema file describing a Transaction Set.

Object Oriented Interface

public function doLoadSchema($filename);

Procedural Interface

ipworkseditranslator_edifacttranslator_do_loadschema($res, $filename);

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.

Reset Method (IPWorksEDITranslator_EDIFACTTranslator Class)

Resets the state of the control.

Object Oriented Interface

public function doReset();

Procedural Interface

ipworkseditranslator_edifacttranslator_do_reset($res);

Remarks

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

SaveRenamingRules Method (IPWorksEDITranslator_EDIFACTTranslator Class)

Saves the current renaming rule set to a file.

Object Oriented Interface

public function doSaveRenamingRules($rulefile);

Procedural Interface

ipworkseditranslator_edifacttranslator_do_saverenamingrules($res, $rulefile);

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.

Translate Method (IPWorksEDITranslator_EDIFACTTranslator Class)

Translates the specified data.

Object Oriented Interface

public function doTranslate();

Procedural Interface

ipworkseditranslator_edifacttranslator_do_translate($res);

Remarks

This method translates the specified data.

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

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

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

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

Input and Output Properties

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

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

• InputFile
• InputData

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

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"
				}
			},
...            

EndFunctionalGroup Event (IPWorksEDITranslator_EDIFACTTranslator Class)

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

Object Oriented Interface

public function fireEndFunctionalGroup($param);

Procedural Interface

ipworkseditranslator_edifacttranslator_register_callback($res, 1, array($this, 'fireEndFunctionalGroup'));

Parameter List

 'tag'
 'controlnumber'
 'count'
 'fullsegment'

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

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

Object Oriented Interface

public function fireEndInterchange($param);

Procedural Interface

ipworkseditranslator_edifacttranslator_register_callback($res, 2, array($this, 'fireEndInterchange'));

Parameter List

 'tag'
 'controlnumber'
 'fullsegment'

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

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

Object Oriented Interface

public function fireEndLoop($param);

Procedural Interface

ipworkseditranslator_edifacttranslator_register_callback($res, 3, array($this, 'fireEndLoop'));

Parameter List

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

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

Object Oriented Interface

public function fireEndTransaction($param);

Procedural Interface

ipworkseditranslator_edifacttranslator_register_callback($res, 4, array($this, 'fireEndTransaction'));

Parameter List

 'tag'
 'controlnumber'
 'count'
 'fullsegment'

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

Fired when information is available about errors during data delivery.

Object Oriented Interface

public function fireError($param);

Procedural Interface

ipworkseditranslator_edifacttranslator_register_callback($res, 5, array($this, 'fireError'));

Parameter List

 'errorcode'
 'description'

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

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

Object Oriented Interface

public function fireResolveSchema($param);

Procedural Interface

ipworkseditranslator_edifacttranslator_register_callback($res, 6, array($this, 'fireResolveSchema'));

Parameter List

 'transactioncode'
 'standardversion'

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

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

Object Oriented Interface

public function fireSegment($param);

Procedural Interface

ipworkseditranslator_edifacttranslator_register_callback($res, 7, array($this, 'fireSegment'));

Parameter List

 'tag'
 'name'
 'loopname'
 'fullsegment'

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

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

Object Oriented Interface

public function fireStartFunctionalGroup($param);

Procedural Interface

ipworkseditranslator_edifacttranslator_register_callback($res, 8, array($this, 'fireStartFunctionalGroup'));

Parameter List

 'tag'
 'controlnumber'
 'fullsegment'

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

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

Object Oriented Interface

public function fireStartInterchange($param);

Procedural Interface

ipworkseditranslator_edifacttranslator_register_callback($res, 9, array($this, 'fireStartInterchange'));

Parameter List

 'tag'
 'controlnumber'
 'fullsegment'

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

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

Object Oriented Interface

public function fireStartLoop($param);

Procedural Interface

ipworkseditranslator_edifacttranslator_register_callback($res, 10, array($this, 'fireStartLoop'));

Parameter List

 'name'

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

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

Object Oriented Interface

public function fireStartTransaction($param);

Procedural Interface

ipworkseditranslator_edifacttranslator_register_callback($res, 11, array($this, 'fireStartTransaction'));

Parameter List

 'tag'
 'controlnumber'
 'code'
 'fullsegment'

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

Fires whenever a validation warning is encountered.

Object Oriented Interface

public function fireWarning($param);

Procedural Interface

ipworkseditranslator_edifacttranslator_register_callback($res, 12, array($this, 'fireWarning'));

Parameter List

 'warncode'
 'message'
 'segmentnumber'
 'segmenttag'
 'technicalerrorcode'
 'segmenterrorcode'
 'elementerrorcode'
 'elementposition'

Remarks

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

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

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

Possible WarnCode values are:

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

Config Settings (EDIFACTTranslator Class)

EDIFACTTranslator Config Settings

PYT+8+COLLECT:::+25'

PYT+8+COLLECT+25'

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

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

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

<N101>ST</N101>

Base Config Settings

Trappable Errors (EDIFACTTranslator Class)

EDIFACTTranslator Errors