Version

    EDIFACTWriter

    Short Description
    Ports
    Metadata
    EDIFACTWriter Attributes
    Details
    Examples
    See also

    Short Description

    EDIFACTWriter writes data in the EDIFACT format. All EDIFACT versions from D.93A to D.21A are supported.

    EDIFACTWriter is currently only available to selected OEM partners. To find out more, please contact .

    ComponentData outputInput portsOutput portsTransformationTransf. req.JavaAuto-propagated metadata
    EDIFACTWriterEDIFACT interchange1-n0-1⨯⨯⨯⨯

    Ports

    Port typeNumberRequiredDescriptionMetadata
    Input0-NAt least oneInput records to be mapped into the EDIFACT message structure.Any (each port can have different metadata)
    Output0⨯For port writing. Only one field (byte, cbyte or string) is used. The field name is used in File URL to govern how the output records are processed - see Writing to Output Port

    Metadata

    EDIFACTWriter does not propagate metadata.

    EDIFACTWriter has no metadata template.

    EDIFACTWriter Attributes

    AttributeReqDescriptionPossible values
    Basic
    File URLyes

    The target file for the output EDIFACT message. See Supported File URL Formats for Writers.

    		 
    EDIFACT version 

    Attribute specifying version of EDIFACT message.

    		 
    EDIFACT message 

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

    		 
    Interchange sender identification 

    Attribute specifying default identification of EDIFACT interchange sender. When specified, the value is used as default for UNB segment.

    		 
    Interchange recipient identification 

    Attribute specifying default identification of EDIFACT interchange recipient. When specified, the value is used as default for UNB segment.

    		 
    Interchange control reference 

    Attribute specifying default identification of EDIFACT interchange. When specified, the value is used as default for UNB segment. In EDIFACT the interchange identification should be unique for every interchange exchanged between sender and recipient, therefore this attribute should not be used if multiple interchanges are written at the same time.

    		 
    Message reference number 

    Attribute specifying default identification of EDIFACT message. When specified, the value is used as default for UNH segment. In EDIFACT the message identification should be unique for every message exchanged between sender and recipient, therefore this attribute should not be used if multiple messages are written at the same time.

    		 
    Mapping[1]

    Defines how input data is mapped onto an output EDIFACT message. See Details.

    		 
    Mapping URL[1]External text file containing the mapping definition. 
    Advanced
    Strict validation 

    Enables strict validation of the written values, their sizes and data types. Also checks that composite elements are not written in places where only simple elements are allowed. Produces error if any validation check finds a problem.

    		true (default) | false
    Cache size 

    The size of the database used when caching data from ports to elements (the data is first processed then written). The larger your data is, the larger cache is needed to maintain fast processing.

    		auto (default) | e.g. 300MB, 1GB etc.
    Cache in Memory 

    Cache data records in memory instead of the JDBM's disk cache (default). Note that while it is possible to set the maximal size of the disk cache, this setting is ignored in case the in-memory cache is used. As a result, an OutOfMemoryError may occur when caching too many data records.

    		false (default) | true
    Sorted input 

    Tells EDIFACTWriter whether the input data is sorted. Setting the attribute to true declares you want to use the sort order defined in Sort keys, see below.

    		false (default) | true
    Sort keys 

    Tells EDIFACTWriter how the input data is sorted, thus enabling streaming. The sort order of fields can be given for each port in a separate tab. Working with Sort keys has been described in Sort Key.

    		 
    Max number of records 

    The maximum number of records written to all output files. See Selecting Output Records.

    		0-N
    Partitioning
    Records per file 

    The maximum number of records that are written to a single file. See Partitioning Output into Different Output Files

    		1-N
    Partition key 

    The key whose values control the distribution of records among multiple output files. For more information, see Partitioning Output into Different Output Files.

    		 
    Partition lookup table 

    The ID of a lookup table. The table serves for selecting records which should be written to the output file(s). For more information, see Partitioning Output into Different Output Files.

    		 
    Partition file tag 

    By default, output files are numbered. If this attribute is set to Key file tag, output files are named according to the values of Partition key or Partition output fields. For more information, see Partitioning Output into Different Output Files.

    		Number file tag (default) | Key file tag
    Partition output fields 

    The fields of Partition lookup table whose values serve for naming output file(s). For more information, see Partitioning Output into Different Output Files.

    		 
    Partition unassigned file name 

    The name of a file that the unassigned records should be written into (if there are any). If it is not given, the data records whose key values are not contained in Partition lookup table are discarded. For more information, see Partitioning Output into Different Output Files.

    		 
    Partition key sorted 

    In case partitioning into multiple output files is turned on, all output files are open at once. This could lead to an undesirable memory footprint for many output files (thousands). Moreover, for example unix-based OS usually have a very strict limitation of number of simultaneously open files (1,024) per process.

    In case you run into one of these limitations, consider sorting the data according a partition key using one of our standard sorting components and set this attribute to true. The partitioning algorithm does not need to keep open all output files, just the last one is open at one time. For more information, see Partitioning Output into Different Output Files.

    		false (default) | true

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

    Details

    EDIFACTWriter receives data from all connected input ports and converts records to EDIFACT message structure based on the mapping you define. Finally, the component writes the resulting tree structure of elements to the output: an EDIFACT message file, port or dictionary.

    Input data has to provide all mandatory data required by selected EDIFACT message format. When any mandatory element is missing the mapping editor produces a warning. Type of a message can be specified by EDIFACT version and EDIFACT message properties in the component.

    Individual fields of EDIFACT message can be filled by input fields of primitive types such as string or long. Entire subtrees of the target message can be filled by input variant fields. When using variant fields the structure of the input variant must match the schema of the target mapped element, otherwise the EDIFACTWriter will fail at runtime.

    Specifying EDIFACT version and EDIFACT message is optional. You can leave both attributes empty, in which case EDIFACTWriter expects a single variant field with entire interchange structure on first input port. The expected structure is the same as produced by EDIFACTReader. Defining a mapping is not possible in this case.

    Examples

    Mapping different ports on parts of an EDIFACT message format allows to insert multiple repeating segments into one EDIFACT message file.

    The example below creates one EDIFACT interchange for each record obtained from port 0 and one AUTHOR message for each record obtained from port 2.

    EDIFACTWriter - mapping input records on different parts of a message

    Figure 56.4. EDIFACTWriter - mapping input records on different parts of a message


    Compatibility

    VersionCompatibility Notice
    5.13

    EDIFACTWriter is available since 5.13.0.