EDI Configuration Files

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

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

EDI Configuration Files

An EDI collection (directory) may contain any of the following configuration files:

 

File

Purpose

EDI.Collection

The EDI.Collection file defines all message types present in the custom EDI collection that you are implementing. You can edit this file to add or remove message types that should be available for selection in MapForce (on the "Browse EDI Collections" dialog box). See also Adding or Removing Message Types.

Envelope.Config

The Envelope.config file defines the structure of the EDI mapping component in MapForce (that is, elements that are surrounded by the Envelope sequence). Under normal circumstances, this file should not be edited manually.

<Message>.Config

The EDI collection directory must include one or several <Message>.Config files. One such file corresponds to an EDI message type, and contains the group and segment definitions used in that message. The <Message>.Config files are referenced from the EDI.Collection file.

 

You can modify the <Message>.Config files if you want to alter the structure or validation rules applicable to fields of a particular message. Note that changes to these files are considered local customizations (that is, they apply only to that specific message). For examples, see Customizing an EDIFACT message and Customizing an ANSI X12 transaction.

<Filename>.Segment

This file defines the data elements, segments, composites, and subcomposites of the EDI files, and is used when parsing the EDI file.

 

You can modify the .segment files if you want to alter the structure or validation rules applicable to a field (data element) in all messages where it may occur. Changes made to this file are global customizations.

<Filename>.Codelist

This file defines EDI code values used by MapForce to validate the EDI input and output files in MapForce. In general, the code values defined here correspond to those defined by the respective EDI standard. Exception to this rule are some edge cases where the standard relies on external code values and does not fully enforce the list of possible values (see also EDI component validation).

 

You can modify .codelist files if you need to change the default validation rules (for example, in order to relax validation, or add new codes that are not already defined in the EDI code list). For more information, see Relaxing Field Validation and Adapting Code Values from External Sources.

ParserErrors.Config

This file is applicable to the X12 and HIPAA X12 standards only. It defines the structure of "ParserErrors_Message" and "ParserErrors_Group" items on the EDI component in MapForce. These items contain information about parsing errors encountered during file processing and can be used to produce X12 997 (Functional Acknowledgement) and X12 999 (Implementation Acknowledgement) messages.

 

All of the files above are XML files and can be edited in an XML editor such as XMLSpy. They all refer to some XML schema (see EDI Configuration Schemas), with the exception of the EDI.Collection file. The EDI.Collection file has no explicit schema defined but is validated internally by MapForce.


© 2019 Altova GmbH