Back to Index

 

    The EDI File Data Object

** Note: The EDI data object requires a separate license, please contact us at:  vis@relationalsolutions.com for more information.

The EDI File data object is a generic object for reading EDI files based on a predefined EDI schema definition.  EDI schema definitions for specific EDI formats can be either be developed by the user (with the EDI Builder license), or can be obtained directly from Relational Solutions.

Properties

Alias

Alias identifier.  Aliases are used on all design objects to simplify coding and to ensure each object has a unique identifier.

ColumnLayout

The column layout (or file structure) of the resulting output from the EDI conversion.  With the EDI File object you cannot modify the ColumnLayout as it is defined by the EDI conversion process which can be modified using the EDIWizard property.

Comments

Comment area to give descriptive text about the data object and its purpose.

EDIDelimiterType

EDI Files use a delimiter to separate the elements of an EDI segment line.  Use this property to define the delimiter, or if it is not one of these commonly used delimiters, use the 'Other' option and specify the Ascii character code in the EDIDelimiterTypeOther property.

The example below shows a line from an EDI 852 document. The EDI Segment is N1 and each element of the line is delimited by the 'Star' character.

Ex:  N1*RL*THE HOME DEPOT~

Option

Description

Star

Star character (*)

Tab

Tab character  

Space

Space character

Comma

Comma character

Other

Other; specify the character used in the EDIDelimiterTypeOther property

EDIDelimiterTypeOther

If the Delimiter type is other than star, tab, space, or comma you should set the EDIDelimiterType to Other and specify the numeric ascii character code of the EDI files delimiter in this property.  For instance, if the delimiter is the # sign you would enter: 35  (see the Ascii Chart for common character codes)

EDIEOLMarker

The End-of-Line marker used in the EDI file.  EDI File segment lines are separated by an end-of-line marker.  This tells the EDI parser when a segment line ends and to look for a new segment line.

The example below shows a line from an EDI 852 document. The EDI Segment is N1 and each element of the line is delimited by the 'Star' character, then the end-of-line character is inserted to tell the EDI parser when the line ends.  In this case, it is the '~' character, or ascii character code: 126

Ex:  N1*RL*THE HOME DEPOT~

Option

Description

DOS

Carriage return / Line feed

UNIX

Line Feed

Other

If the end-of-line marker is not the DOS or UNIX end-of-line marker, then select the 'Other' option and specify the numeric ascii character code in the EDIEOLMarkerOther property

EDIEOLMarkerOther

If the EDI end-of-line marker is other than DOS or UNIX you should set the EDIEOLMarker to Other and specify the numeric ascii character code of the EDI files end-of-line marker in this property.  For instance, if the delimiter is the ~ character you would enter: 126  (see the Ascii Chart for common character codes)

EDIFilePath

The filename of the EDI file you want to read.  This represents the EDI filename and full path.  (Example:  c:\myedifiles\koller.edi)

EDISchema

The EDISchema is an XML schema definition for the type of EDI file you are reading.  (Ex: 852, 810, etc...) It defines the layout and structure of the EDI file and is used by the parser to understand how to read the EDI file.   Click the Ellipse (...) button to select a predefined EDI schema from the BlueSky Integration Studio server.  If you need additional EDI schema definitions, please contact Relational Solutions, Inc at:  vis@relationalsolutions.com

EDIWizard

The EDIWizard is a tool that allows you to change the mapping definition (how it will output to the text file), and also locally test your conversion and view the results before running your job.  Click the ellipse (...) button to bring up the EDIWizard dialog. For information on using the EDIWizard, see Using the EDI Data Object

Name

Descriptive name for this object.  You can enter any text to describe the object.

TextDelimiterType

The EDI object outputs to a readable, delimited text file.  Select the delimiter you would like the EDI object to use in the creation of your text file.

The example below shows a line from an output Text file.  The delimiter in this case is a comma (,)

Ex:  01102005,01142005,THE HOME DEPOT,SDQ,34930,45.67

Option

Description

Tab

Tab character  

Space

Space character

Comma

Comma character

Other

Other; specify the character used in the TextDelimiterTypeOther property

TextDelimiterTypeOther

If the Delimiter type is other than  tab, space, or comma you should set the TextDelimiterType to Other and specify the numeric ascii character code of the Text files delimiter in this property.  For instance, if the delimiter is the # sign you would enter: 35  (see the Ascii Chart for common character codes)

TextEOLMarker

The End-of-Line marker used in the Text file.  

Option

Description

DOS

Carriage return / Line feed

UNIX

Line Feed

TextOutputPath

TextOutputPath is the full filename and path to the location where you want the EDI parser to output the converted text file (Ex:  c:\myoutput\my852.txt)

 

See also: Using the EDI Data Object

 


© 2003 - 2007 Relational Solutions, Inc. - All rights reserved