Liquid XML Studio 2019
EDI Source
Data Mapping > Data Mapper Functions > By Category > EDI > EDI Source

Function Name
EDI Data Source
Category
EDI
Icon
Description
Allows data to be read from an EDI file.
Inputs
Filename The value will be treated as a filename and loaded into the EDI Document.
(can not be connected if 'EDI String' is connected)
EDI String The value will be treated as raw EDI data and parsed into the EDI Document.
(can not be connected if 'Filename' is connected)
Outputs
Data Items in source Segments and element corresponding to the structure of the selected EDI standard.
Properties
General Specify the name of the Source component
Structure Specify the EDI standard represented
Source Data Specify default filename to load if neither of the inputs are connected

Usage

The EDI Data source allows EDI documents to be used as a data source within the Data Mapper.

Inputs

The component has 2 inputs, 'Filename' and 'EDI String', only one of these can be used at a time (you can only connect one of them within a given transform).

If the 'Filename' input is connected then the value read from the connector will be treated as the filename for the EDI document to load (if the connector provides a sequence of filenames, then multiple EDI documents are loaded).

If the 'EDI String' input is connected then the value read from the connector will be treated as raw EDI data and loaded into the document (if the connector provides a sequence of values, then each is treated as a separate EDI document and multiple documents are loaded).

If neither of the inputs are connected then the filename is taken from the default filename (accessible via the properties window).

Creating an EDI data source

To begin, drag the EDI Source component from the EDI section of the Component Palette onto a new Data Mapper file.

This will cause the wizard to launch

This wizard page makes it possible to select the required EDI standard.

 

Once a standard has been selected the next button is enabled and we can move onto the next wizard page.

The default terminators and separators will be selected based on the standard selected on the previous page (i.e. EDIFACT or X12).

These are common default values, however the files you need to process may use different values. If you receive errors when reading the EDI documents you may wish to investigate changing these values as appropriate.

These values are set when you first run the Wizard, however you can change them inside the Data Mapper by selecting the Component and selecting Properties from the right click menu.

Ignore File Declared Markers

When checked, the parser exclusively uses the values set in this dialog and ignores any terminator and separator characters declared in the EDI document.

If it is not checked, the parser will use any terminator and separator characters declared in the EDI document and fall back to use the values set in this dialog if the markers are not found in the EDI document.

 

When the wizard is complete pressing the Finish button will created the EDI Source on the transform.

If multiple inputs files are opened (if multiple 'Filename' or 'EDI String' values are provided), then the root item will contain a sequence of documents, each one corresponding to the input source.

See Also

EDI