Altova MapForce 2022 Enterprise Edition

EDI Component Settings

Home Prev Top Next

After you add an EDI component to the mapping area, you can configure the settings applicable to it from the Component Settings dialog box. You can open the Component settings dialog box in one of the following ways:


First, select an EDI component on the mapping, and then, on the Component menu, select Properties.

Double-click the EDI component's title bar on the mapping.

Right-click the EDI component's title bar, and then click Properties.


EDI Component Settings dialog box

The available settings are listed below. Note that some settings are not available if the currently selected component does not support them.


Component name

The component name is automatically generated when you create the component. However, you can change the name at any time.


The component name can contain spaces and full stop characters. It may not contain slashes, backslashes, colons, double quotes, leading or trailing spaces. If you want to change the name of the component, be aware of the following:


If you intend to deploy the mapping to FlowForce Server, the component name must be unique.

It is recommended to use only characters that can be entered at the command line. National characters may have a different encoding in Windows and at the command line.

Input EDI file

Specifies the EDI source file from which MapForce will read data. This field is meaningful for a source component and is filled when you first create the component and assign to it an EDI instance file.

Output EDI file

Specifies the EDI target file to which MapForce will write data. This field is meaningful for a target component.

Input/Output Encoding

Allows you specify the following settings of the output instance file:


Encoding name

Byte order

Whether the byte order mark (BOM) character should be included.


By default, any new components have the encoding defined in the Default encoding for new components option. You can access this option from Tools | Options, General tab.

EDI Settings

This group of settings enable you to define custom EDI delimiters, separators and terminators (note the settings are available only if supported by the EDI format).


The EDI separators entered in this dialog box always take effect when writing EDI files. When reading in EDI files, the separators only take effect if the input file does not define/contain its own separators (for example, EDIFACT files without the UNA "service string advice" segment).


If an EDI input component/file contains separator definitions (for example, an X12 file with an ISA segment), then the existing separators override any separators defined in the Component Settings dialog box for that file.


You can use non-printable characters as separators by typing "x" followed by the hexadecimal ASCII character code into one of the combo boxes, for example, "x1e" for the RS control character (ASCII record separator, decimal code 30).


The Subcomponent Separator applies to the HL7 standard. The default value of this separator is ampersand ( & ).

Write content in XML format

Selecting this check box is meaningful only for a target EDI component. It modifies the component so that it generates XML output instead of EDI output, see Example: Switch between XML and EDI Output.

Auto-complete missing fields

This option applies to target EDI components. When this check box is selected, MapForce fills in the values of some data fields automatically.


This applies only to those fields where this operation would not contradict the specification of the currently selected EDI format. To disable such behavior, clear this check box.


See also:


ASC X12 Automatic Data Completion Rules

UN/EDIFACT Automatic Data Completion Rules

Begin new line after each segment

This option applies to target EDI components.  When the check box is selected, MapForce adds a CR/LF (carriage return / line feed) character after each EDI segment.


The EDI standard ignores these lines if present in a message.


Opens a dialog box where you can define additional settings for the current EDI component. The available settings vary by EDI component kind.


Opens a dialog box where you can define the validation settings for the current EDI component, see EDI Component Validation.

EDI Configuration

Provides information about the EDI configuration used by the current component, see How MapForce resolves EDI configurations.

Enable input processing optimizations based on min/maxOccurs

This option allows special handling for sequences that are known to contain exactly one item, such as required attributes or child elements with minOccurs and maxOccurs="1". In this case the first item of the sequence is extracted, then the item is directly processed as an atomic value (and not as a sequence).


If the input data is not valid against the schema, an empty sequence might be encountered in a mapping, which stops the mapping with an error message. To allow the processing of such invalid input, clear this check box.

Save all file paths relative to MFD file

When this option is enabled, MapForce saves the file paths displayed on the Component Settings dialog box relative to the location of the MapForce Design (.mfd) file. This setting affects the following files:


The input EDI file (if present)

The output EDI file (if present)


See also Using Relative Paths on a Component.

© 2016-2022 Altova GmbH