X12Translator Component

Properties   Methods   Events   Config Settings   Errors  

The X12Translator component converts X12 documents to XML and back, streamlining translation between formats.

Syntax

EDISDK.X12Translator

Remarks

The component will convert a document from the format specified by InputFormat to the format specified by OutputFormat. This allows for converting to XML from EDI and vice versa.

Before translating from EDI to XML 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 will include types and descriptions as element attributes which are useful for interpreting the data.

After calling Translate the resulting output will contain the EDI or XML data as defined by OutputFormat.

Input and Output Properties

The component 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.

Property List

---

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

Method List

---

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

Event List

---

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

Config Settings

---

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

Delimiters Property (X12Translator Component)

Contains the delimiters for the EDI Document.

Syntax

public X12Delimiters getDelimiters();

Remarks

This property contains the delimiters that will be used when parsing the X12 document. If the document uses delimiters other than the default, change the properties of this object to parse the document correctly.

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

Please refer to the X12Delimiters type for a complete list of fields.

FileWriteMode Property (X12Translator Component)

Determines how the output file is opened for writing.

Syntax

public int getFileWriteMode();
public void setFileWriteMode(int fileWriteMode);
Enumerated values:
  public final static int fwmCreate = 0;

  public final static int fwmOverwrite = 1;

  public final static int fwmAppend = 2;

Default Value

0

Remarks

When OutputFile is set, this property determines how the file will be opened.

This property is not available at design time.

InputData Property (X12Translator Component)

The EDI message, specified as a string.

Syntax

public String getInputData();
public void setInputData(String inputData);

Default Value

""

Remarks

Set this property to specify the input EDI message as a string. The message can then be parsed with Parse.

This property is not available at design time.

InputFile Property (X12Translator Component)

The file containing the EDI message.

Syntax

public String getInputFile();
public void setInputFile(String inputFile);

Default Value

""

Remarks

Set this property to specify the input EDI message as a file. The message can then be parsed with Parse.

If the file is not found or cannot be opened, an error will be returned.

Note: If both InputFile and InputData are set, InputData takes precedence.

This property is not available at design time.

InputFormat Property (X12Translator Component)

The format of the input data.

Syntax

public int getInputFormat();
public void setInputFormat(int inputFormat);
Enumerated values:
  public final static int ifEDI = 0;

  public final static int ifXML = 1;

Default Value

0

Remarks

The value set here, along with OutputFormat, determines how the data is converted when Translate is called.

Possible values are:

• 0 (ifEDI)
• 1 (ifXML)

This property is not available at design time.

OutputData Property (X12Translator Component)

The translated EDI data.

Syntax

public String getOutputData();
public void setOutputData(String outputData);

Default Value

""

Remarks

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

This property is not available at design time.

OutputFile Property (X12Translator Component)

The name of the file to write the translated EDI data to.

Syntax

public String getOutputFile();
public void setOutputFile(String outputFile);

Default Value

""

Remarks

This file specified by this property will be populated with the output after calling Translate if SetOutputStream is not set.

If a file with the specified name already exists Translate will fail unless FileWriteMode is set to "fwmOverwrite" or "fwmAppend".

This property is not available at design time.

OutputFormat Property (X12Translator Component)

The format of the output data.

Syntax

public int getOutputFormat();
public void setOutputFormat(int outputFormat);
Enumerated values:
  public final static int ofEDI = 0;

  public final static int ofXML = 1;

Default Value

0

Remarks

The value set here, along with InputFormat, determines how the data is converted when Translate is called.

Possible values are:

• 0 (ofEDI)
• 1 (ofXML)

This property is not available at design time.

SegmentSuffix Property (X12Translator Component)

The suffix that is appended to the end of a segment.

Syntax

public int getSegmentSuffix();
public void setSegmentSuffix(int segmentSuffix);
Enumerated values:
  public final static int ssNone = 0;

  public final static int ssCR = 1;

  public final static int ssLF = 2;

  public final static int ssCRLF = 3;

Default Value

3

Remarks

This property determines the suffix that is appended to the end of a segment.

Possible values are:

This property is not available at design time.

Config Method (X12Translator Component)

Sets or retrieves a configuration setting.

Syntax

public String config(String configurationString);

Remarks

Config is a generic method available in every component. It is used to set and retrieve configuration settings for the component.

These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the component, 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.

LoadSchema Method (X12Translator Component)

Loads schema information from a file or string data.

Syntax

public void loadSchema(String fileOrData, String messagename);

Remarks

This method loads schema information for use when parsing, validating, and translating messages.

The FileOrData parameter can be set to the path of a file containing schema data, or can be set to the contents of a schema file directly.

MessageName can be set to the name of a specific message to load only the specified message's schema information. If left empty or set to "*", the entire schema will be loaded.

Reset Method (X12Translator Component)

Resets all properties to their default values.

Syntax

public void reset();

Remarks

This method resets all properties of the component to their default values as specified in the property definitions.

SetInputStream Method (X12Translator Component)

The stream containing the EDI data.

Syntax

public void setInputStream(java.io.InputStream inputStream);

Remarks

Call this method to specify a stream to read the input EDI data from. The data can then be parsed with Parse.

SetOutputStream Method (X12Translator Component)

Sets the output stream where the translated data will be written.

Syntax

public void setOutputStream(java.io.OutputStream outputStream);

Remarks

This method sets the output stream for the component. The output stream must be writable. Calling Translate will write the translated EDI data to the specified output stream and close the stream when finished.

Translate Method (X12Translator Component)

Translates the specified data.

Syntax

public void translate();

Remarks

This method translates the specified data.

Error Event (X12Translator Component)

Fires when a parsing error occurs.

Syntax

public class DefaultX12TranslatorEventListener implements X12TranslatorEventListener {
  ...
  public void error(X12TranslatorErrorEvent e) {}
  ...
}

public class X12TranslatorErrorEvent {
  public int errorCode;

  public String description;

}

Remarks

This event fires when the component encounters a parsing error while processing a document.

ResolveSchema Event (X12Translator Component)

Fires to request schema information for a specific transaction set.

Syntax

public class DefaultX12TranslatorEventListener implements X12TranslatorEventListener {
  ...
  public void resolveSchema(X12TranslatorResolveSchemaEvent e) {}
  ...
}

public class X12TranslatorResolveSchemaEvent {
  public String versionNumber;

  public String transactionSetIDCode;

}

Remarks

LoadSchema can be called from within this event to load the schema information for the specified transaction set.

ValidateWarning Event (X12Translator Component)

Fires to warn about validation errors.

Syntax

public class DefaultX12TranslatorEventListener implements X12TranslatorEventListener {
  ...
  public void validateWarning(X12TranslatorValidateWarningEvent e) {}
  ...
}

public class X12TranslatorValidateWarningEvent {
  public long position;

  public int line;

  public int column;

  public String errorCode;

  public String errorMessage;

  public int errorType;

}

Remarks

When the component encounters a non-blocking error while validating a document, this event fires with information about the error.

X12Delimiters Type

The delimiters used in the X12 document.

Remarks

This type contains fields specifying the various delimiters used within the X12 document.

• Component
• Element
• Repetition
• Segment

Fields

Constructors

public X12Delimiters();

Config Settings (X12Translator Component)

The component 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 component, access to these internal properties is provided through the Config method.

X12Translator Config Settings

Trappable Errors (X12Translator Component)

X12Translator Errors