X12Translator Class

Properties   Methods   Events   Config Settings   Errors  

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

Syntax

ipworkseditranslator.x12translator()

Remarks

The X12Translator class provides a simple way to convert X12 to XML or JSON and vice versa.

Getting Started

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

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

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

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

Input and Output Properties

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

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

• InputFile
• InputData

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

Example - Translating X12 to XML

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

The code above creates an XML document with content like:

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

Example - Translating X12 to JSON

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

The code above creates a JSON document with content like:

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

Property List

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

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.

X12Translator.InputData Property

The data to translate.

Syntax

getInputData(): string;
setInputData(inputData: string): void;

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.

X12Translator.InputFile Property

The file to translate.

Syntax

getInputFile(): string;
setInputFile(inputFile: string): void;

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.

X12Translator.InputFormat Property

The format of the input data.

Syntax

getInputFormat(): X12translatorInputFormats;
setInputFormat(inputFormat: X12translatorInputFormats): void;

enum X12translatorInputFormats {
  xifXML,
  xifJSON,
  xifX12
}

Default Value

3

Remarks

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

Possible values are:

• 0 (ifXML)
• 1 (ifJSON)
• 3 (ifX12)

This property is not available at design time.

X12Translator.OutputData Property

The translated data.

Syntax

getOutputData(): string;
setOutputData(outputData: string): void;

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.

X12Translator.OutputFile Property

The file to which the translated data will be written.

Syntax

getOutputFile(): string;
setOutputFile(outputFile: string): void;

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.

X12Translator.OutputFormat Property

The format of the output data.

Syntax

getOutputFormat(): X12translatorOutputFormats;
setOutputFormat(outputFormat: X12translatorOutputFormats): void;

enum X12translatorOutputFormats {
  xofXML,
  xofJSON,
  xofX12
}

Default Value

0

Remarks

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

Possible values are:

• 0 (ofXML)
• 1 (ofJSON)
• 3 (ofX12)

This property is not available at design time.

X12Translator.Overwrite Property

Whether to overwrite the file.

Syntax

isOverwrite(): boolean;
setOverwrite(overwrite: boolean): void;

Default Value

FALSE

Remarks

This property specifies whether the file is overwritten. If set to False (default) the class 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

X12Translator.RenamingRule Property

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

Syntax

getRenamingRule(): string;
setRenamingRule(renamingRule: string): void;

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.

X12Translator.RenamingRuleCount Property

The number of renaming rules.

Syntax

getRenamingRuleCount(): number;

Default Value

0

Remarks

This property returns the current number of renaming rules.

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

X12Translator.RenamingRuleIndex Property

The index of the current renaming rule.

Syntax

getRenamingRuleIndex(): number;
setRenamingRuleIndex(renamingRuleIndex: number): void;

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.

X12Translator.SchemaFormat Property

The format of the schema file.

Syntax

getSchemaFormat(): X12translatorSchemaFormats;
setSchemaFormat(schemaFormat: X12translatorSchemaFormats): void;

enum X12translatorSchemaFormats {
  schemaAutomatic,
  schemaBinary,
  schemaBizTalk,
  schemaSEF,
  schemaBOTS,
  schemaAltova,
  schemaJSON
}

Default Value

0

Remarks

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

The following schema formats are supported:

X12Translator.Suffix Property

What to append after each segment delimiter.

Syntax

getSuffix(): X12translatorSuffixes;
setSuffix(suffix: X12translatorSuffixes): void;

enum X12translatorSuffixes {
  suffixNone,
  suffixCR,
  suffixLF,
  suffixCRLF
}

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.

X12Translator.UseSchemaName Property

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

Syntax

isUseSchemaName(): boolean;
setUseSchemaName(useSchemaName: boolean): void;

Default Value

FALSE

Remarks

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

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

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

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

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

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

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

<N1Loop1 type="Loop">
<N1 type="Segment" desc="Name">
<N101 desc="Entity Identifier Code_98">BY</N101>
<N102 desc="Name_93">Apple Inc.</N102>
<N103 desc="Identification Code Qualifier_66">92</N103>
<N104 desc="Identification Code_67">544380</N104>
</N1>

X12Translator.addRenamingRule Method

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

Syntax

async x12translator.addRenamingRule(rule : string): Promise<void>

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.

X12Translator.config Method

Sets or retrieves a configuration setting.

Syntax

async x12translator.config(configurationString : string): Promise<string>

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.

X12Translator.displaySchemaInfo Method

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

Syntax

async x12translator.displaySchemaInfo(): Promise<string>

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]

X12Translator.exportXMLSchema Method

Exports a XML schema.

Syntax

async x12translator.exportXMLSchema(schemaFile : string): Promise<void>

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.

X12Translator.generateAck Method

Generates an EDI acknowledgement.

Syntax

async x12translator.generateAck(): Promise<string>

Remarks

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

X12Translator.loadRenamingRules Method

Loads a set of renaming rules from file.

Syntax

async x12translator.loadRenamingRules(ruleFile : string): Promise<void>

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.

X12Translator.loadSchema Method

Loads a schema file describing a Transaction Set.

Syntax

async x12translator.loadSchema(fileName : string): Promise<void>

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 .

X12Translator.reset Method

Resets the state of the control.

Syntax

async x12translator.reset(): Promise<void>

Remarks

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

X12Translator.saveRenamingRules Method

Saves the current renaming rule set to a file.

Syntax

async x12translator.saveRenamingRules(ruleFile : string): Promise<void>

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.

X12Translator.translate Method

Translates the specified data.

Syntax

async x12translator.translate(): Promise<void>

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

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

The code above creates an XML document with content like:

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

Example - Translating X12 to JSON

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

The code above creates a JSON document with content like:

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

X12Translator.EndFunctionalGroup Event

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

Syntax

x12translator.on('EndFunctionalGroup', listener: (e: {readonly tag: string, readonly controlNumber: string, readonly count: number, readonly fullSegment: string}) => void )

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.

X12Translator.EndInterchange Event

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

Syntax

x12translator.on('EndInterchange', listener: (e: {readonly tag: string, readonly controlNumber: string, readonly fullSegment: string}) => void )

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.

X12Translator.EndLoop Event

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

Syntax

x12translator.on('EndLoop', listener: (e: {}) => void )

Remarks

The EndLoop event will fire after the last segment in a loop is read. Each EndLoop event is paired with one StartLoop event.

X12Translator.EndTransaction Event

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

Syntax

x12translator.on('EndTransaction', listener: (e: {readonly tag: string, readonly controlNumber: string, readonly count: number, readonly fullSegment: string}) => void )

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.

X12Translator.Error Event

Fired when information is available about errors during data delivery.

Syntax

x12translator.on('Error', listener: (e: {readonly errorCode: number, readonly description: string}) => void )

Remarks

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

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.

X12Translator.ResolveSchema Event

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

Syntax

x12translator.on('ResolveSchema', listener: (e: {readonly transactionCode: string, readonly standardVersion: string}) => void )

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.

X12Translator.Segment Event

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

Syntax

x12translator.on('Segment', listener: (e: {readonly tag: string, readonly name: string, readonly loopName: string, readonly fullSegment: string}) => void )

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

X12Translator.StartFunctionalGroup Event

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

Syntax

x12translator.on('StartFunctionalGroup', listener: (e: {readonly tag: string, readonly controlNumber: string, readonly fullSegment: string}) => void )

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.

X12Translator.StartInterchange Event

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

Syntax

x12translator.on('StartInterchange', listener: (e: {readonly tag: string, readonly controlNumber: string, readonly fullSegment: string}) => void )

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.

X12Translator.StartLoop Event

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

Syntax

x12translator.on('StartLoop', listener: (e: {readonly name: string}) => void )

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

X12Translator.StartTransaction Event

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

Syntax

x12translator.on('StartTransaction', listener: (e: {readonly tag: string, readonly controlNumber: string, readonly code: string, readonly fullSegment: string}) => void )

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

X12Translator.Warning Event

Fires whenever a validation warning is encountered.

Syntax

x12translator.on('Warning', listener: (e: {readonly warnCode: number, readonly message: string, readonly segmentNumber: number, readonly segmentTag: string, readonly technicalErrorCode: string, readonly segmentErrorCode: string, readonly elementErrorCode: string, readonly elementPosition: number}) => void )

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 (class ipworkseditranslator.x12translator)

X12Translator 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 (class ipworkseditranslator.x12translator)

X12Translator Errors