HomeGuides
Log In
Guides

EDIFACTReader

Short Description

EDIFACTReader reads data in EDIFACT format. All EDIFACT versions from D.93A to D.21A are supported.
EDIFACTReader is currently only available in certain plans. To find out more about licensing requirements, please contact [email protected].

COMPONENTDATA SOURCEINPUT PORTSOUTPUT PORTSEACH TO ALL INPUTSDIFFERENT TO DIFFERENT OUTPUTSTRANSFORMATIONTRANSF. REQ.JAVACTLAUTO-PROPAGATED METADATA
EDIFACTReaderEDIFACT file0-11-nxxxxxx

Ports

PORT TYPENUMBERREQUIREDDESCRIPTIONMETADATA
Input0-1xFor port reading. See Reading from Input Port in Supported File URL Formats for Readers.One field (byte, cbyte, string) for specifying an input of the component.
Output0For correct data recordsAny ck:
1-n[blFor correct data recordsAny ck: (each port can have different metadata).

[1] Metadata on each output port does not need to be the same. Each metadata can use Autofilling Functions.
[2] Other output ports are required if the mapping requires it.

Metadata

EDIFACTReader does not propagate metadata.
EDIFACTReader has a metadata template on its output port available.
Metadata on optional input port must contain string, byte or cbyte field.
Metadata on each output port does not need to be the same.
Each metadata can use Autofilling Functions.

EDIFACTReader Attributes

ATTRIBUTEREQ.DESCRIPTIONPOSSIBLE VALUES
Basic
File URLyesAttribute specifying what data source(s) will be read (EDIFACT file, input port, dictionary). See Reading from Input Port in Supported File URL Formats for Readers.
EDIFACT versionAttribute specifying version of EDIFACT message.
EDIFACT messageAttribute specifying type of EDIFACT message. Possible values depend on selected EDIFACT version.
Mapping[blMapping of the input EDIFACT structure to output ports. For more information, see XMLExtract Mapping Definition.
Mapping URL[blName of an external file, including its path which defines mapping of the input EDIFACT structure to output ports. For more information, see XMLExtract Mapping Definition.
Advanced
Strict validationEnables strict validation of the incoming values, their sizes and data types. Also checks that composite elements are not present in places where only simple elements are allowed. Produces error if any validation check finds a problem.true (default) | false

[1] One of these must be specified if EDIFACT version and EDIFACT message are used. If both are specified, Mapping URL has higher priority.

Details

EDIFACTReader reads data from EDIFACT files using SAX technology.
EDIFACTReader can read individual values or entire subtrees of the EDIFACT structure. Individual values can be converted to any field type. Subtrees can be converted to variant fields. When reading into variant fields, all data types in the field will be string type.
Using EDIFACTReader is very similar to XMLExtract. Attributes EDIFACT version and EDIFACT message define the expected structure (schema) of the input data. The schema is generated automatically.
Specifying EDIFACT version and EDIFACT message is optional. You can leave both attributes empty, in which case EDIFACTReader will read entire input data into a single variant field on first output port. Defining a mapping is not possible in this case.

EDIFACTReader Mapping Editor and Message Schema

EDIFACTReader Mapping Editor serves to define mapping from EDIFACT message structure to one or more output ports by drag and drop.
To be able to use the editor you have to specify EDIFACT version and EDIFACT message. The schema is created internally and cannot be modified.
Any other operations to set up mapping are described in above mentioned XMLExtract.
In EDIFACTReader, you can map input fields to the output in the same way as you map message fields. The input field mapping works in all three processing modes.

Examples

Mapping parts of EDIFACT message onto output metadata. It is possible to map a whole message or its part onto variant field or to map individual values to fields of other data types.

See also

EDIFACTWriter
X12Reader
Common Properties of Components
Specific Attribute Types
Common Properties of Readers