EDIFACTReader 64x64

    Short Description



    EDIFACTReader Attributes


    EDIFACTReader Mapping Editor and Message Schema


    See also

    Short Description

    EDIFACTReader reads data in EDIFACT format. All EDIFACT versions from D.93A to D.2~A are supported.

    Please note that EDIFACTReader component is only available in certain CloverDX plans. To find out more about licensing requirements, please contact

    Data source Input ports Output ports Each to all outputs Different to different outputs Transformation Transf. req. Java CTL Auto-propagated metadata

    EDIFACT file




    Port type Number Required Description Metadata



    For port reading. See Reading from Input Port.

    One field (byte, cbyte, string) for specifying an input of the component.



    For correct data records




    For correct data records

    Any [1] (each port can have different metadata).


     Metadata on each output port does not need to be the same. Each metadata can use Autofilling Functions.


     Other output ports are required if the mapping requires it.


    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

    Attribute Req Description Possible values


    File URL


    Attribute specifying what data source(s) will be read (EDIFACT file, input port, dictionary). See Supported File URL Formats for Readers.

    EDIFACT version

    Attribute specifying version of EDIFACT message.

    EDIFACT message

    Attribute specifying type of EDIFACT message. Possible values depend on selected EDIFACT version.



    Mapping of the input EDIFACT structure to output ports. For more information, see XMLExtract Mapping Definition.

    Mapping URL


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


    Strict validation

    Enables 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


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


    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.


    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.

    EDIFACTReader example 01
    Figure 340. EDIFACTReader - mapping part of a message
    EDIFACTReader example 02
    Figure 341. EDIFACTReader - mapping fields of a message


    Version Compatibility Notice


    EDIFACTReader is available since 5.13.0.