Adding or Removing Message Types

www.altova.com Print this Topic Previous Page Up One Level Next page

Home >  Data Sources and Targets > EDI > Customizing EDI Structure >

Adding or Removing Message Types

To add custom EDI message types (or transaction types, in X12 terminology), follow the steps below:

 

1.In the directory where your custom EDI collection is stored, create a <Message>.Config file for each message (transaction) type to be added to the collection.
2.Modify the EDI.Collection file to make a reference to each available message (transaction) type.

 

To remove existing message types:

 

Comment out the required Message elements in the EDI.Collection file.

 

Adding and configuring the <Message>.Config file

Each <Message>.config file you create must be valid according to its configuration schema (see EDI Configuration Files). To avoid problems, pay special attention to the following elements in the body of each message configuration file:

 

Meta
Format
Include
Message

 

The Meta element indicates the specification version, release, and agency, for example:

 

  <Meta>
    <Version>D</Version>
    <Release>14B</Release>
    <Agency>UN</Agency>
  </Meta>

 

The Format element indicates the name of the base standard, for example:

 

<Format standard="EDIFACT"/>

 

The following values are valid:

 

Fixed
EDIFACT
X12
HL7
TRADACOMS (this value requires the EDIConfig4.xsd schema or later, see EDI Configuration Files and Schemas)

 

The Include element in a <Message>.Config file specifies references to any additional configuration files. For example, the code listing below includes a reference to two .segment files and one .codelist file. A .segment file stores all Segment, Composite, and Data Element definitions at a global level (this is to avoid repeating them in each message where they may occur). Likewise, a .codelist file defines validation rules applicable to each field, at a global level.

 

  <Include href="Admin.Segment"/>
  <Include href="EDSD.Segment"/>
  <Include href="UNCL.Codelist"/>

 

Any file referenced by the Include element must exist in the same directory as the <Message>.Config file.

 

The Message element in each <Message>.Config file defines the structure of the message (that is, the hierarchy of groups, segments, and data elements), as well as any code values used for validation (if applicable). For more information about the structure of a message, see Changing the Message Structure. For examples of altering existing messages, see the following topics:

 

Customizing an EDIFACT Message
Customizing an ANSI X12 Transaction
Defining Code Values at Message Level (Inline)

 

Modifying the EDI.Collection file

If you add a custom <Message>.Config file, a Message element must also be added to the EDI.Collection file. Each Message element must have the following attributes:

 

Type

Specifies the official code of the message type (for example "BALANC", "999").

File

Specifies the file name containing the specification of this particular message type. The actual file must exist in the same directory.

Description

Provides a description of this message type as it will appear in the MapForce graphical user interface.

 

For samples of valid EDI.Collection files, check any of the MapForce built-in EDI collections in the C:\Program Files\Altova\MapForce2019\MapForceEDI directory.


© 2019 Altova GmbH