An EDI document is comprised of data elements, segments and envelopes that are formatted according to the rules of a particular EDI standard. When encoding data (e.g. a purchase order), in an EDI document, you must adhere to the formatting rules of the corresponding standard. These rules define exactly where and how each piece of information in the document will be found. This enables the receiving side to decode the information stored in every piece of data by its position and corresponding definition (e.g. company name, price, etc).
An EDI Configuration is an XML file that gives you the flexibility to define your own set of rules or use a format predefined by an existing EDI standard. Our clients have successfully used our EDI components to process 210, 271, 277, 810, 812, 820, 822, 832, 834, 835, 837, 850, 852, 855 X12 and D95B EDIFACT formats.
The XML configuration file has the following structure:
Parameters
XML Configuration File
The EDI source/destination configuration is an XML file, that can be validated by this XSD.
The configuration elements of the format are:
This is the top level root element of the XML document.
Element relationships
Relationship Element Parent elements <none> Child elements description, delimiters, segments This element contains a user-friendly description of the configuration file.
Attributes
Attribute Description name Description of the configuration file. version Version of the configuration file. Element relationships
Relationship Element Parent elements edimap Child elements <none> This element contains the EDI file delimiters for the segment, field, component and sub-component parts. Special characters like line feed character are specified using XML Character References.
Attributes
Attribute Description segment Segments delimiter character. field Fields delimiter character. component Components delimiter character. sub-component Sub-components delimiter character. Element relationships
Relationship Element Parent elements edimap Child elements <none> This element contains parameters for controlling the EDI parser.
Attributes
Attribute Description skipNewline 1.3 SR-4 Indicate that carriage return / line feed characters should be ignored. Starting from 1.4 SR-3 this option is replaced by the skipCharacters option below. To get the equivalent of specifying this option to true, set skipCharacters to " " undefinedFail 1.4 SR-2 Specify how to handle the appearance of new field, component and sub-component elements. If set to false the parser will ignore the new elements. skipCharacters 1.4 SR-3 Specify a list of characters to be ignored. escape 1.6 SR-4 Specify escape combination to handle special control symbols like segment delimiters used in the data. Element relationships
Relationship Element Parent elements edimap Child elements <none> This element specifies an EDI segment. The segment is represented as a separate Input (when used by EDI Destination) or Output (when used by EDI Source) in the SSIS data flow, if it repeats. If the segment repeats once, the segment elements are included as part of the parent segment to serve as context for other segments. You can specify multiple segments.
Attributes
Attribute Description segcode Code found in the EDI file, which establishes the mapping relationship to this segment. Starting from 1.3 SR-2, this attribute accepts a regular expression for matching complex segments. xmltag Name of the segment. truncatable If used by EDI Source, when set to true, the parser will not generate errors when the segment does not contain trailing fields, components, and sub-components, which are not required. In case of EDI Destination, the data flow component will not generate empty fields at the end of the segment. minOccurs Minimum amount of times this segment occurs. If not specified the default is 1. maxOccurs Maximum amount of times this segment occurs. Specify -1 if this segment may occur an unlimited number of times. If not specified, the default is 1. segid 1.4 SR-3 Optional attribute which, if specified, will create an additional field for the segment's data flow output. The field will contain a unique segment identifier. segname 2.0 Optional attribute which, if specified, will create an additional field for the segment's data flow output. The field will contain the segment name. Element relationships
Relationship Element Parent elements segments Child elements field This element specifies an EDI field. Each field is represented as a column in the SSIS data flow. You may specify multiple fields.
Attributes
Attribute Description xmltag Name of the field. truncatable When used by EDI Source and set to true, the parser will not generate errors when the field does not contain trailing components or sub-components which are not required. When used by EDI Destination and set to true, the data flow component will not generate non required, empty components at the end of the record. required Specifies whether or not the field is required. By default it is set to false indicating the field is not required. Element relationships
Relationship Element Parent elements segment Child elements component This element specifies an EDI component. Each component is represented as a column in the SSIS data flow. You may specify multiple components.
Attributes
Attribute Description xmltag Name of the component. truncatable When used by EDI Source and set to true, the parser will not generate errors when the component does not contain trailing sub-components which are not required. When used by EDI Destination and set to true, the data flow component will not generate non required, empty sub-components at the end of the record. required Specifies whether the component is required. By default it is set to false indicating the component is not required. Element relationships
Relationship Element Parent elements field Child elements sub-component This element specifies an EDI subcomponent. Each subcomponent is represented as a column in the SSIS data flow. You may specify multiple sub-components.
Attributes
Attribute Description xmltag Name of the subcomponent. required Specifies whether the subcomponent is required. By default it is set to false indicating the subcomponent is not required. Element relationships
Relationship Element Parent elements component Child elements <none>
Knowledge Base
Related documentation
COZYROC SSIS+ Components Suite is free for testing in your development environment.
A licensed version can be deployed on-premises, on Azure-SSIS IR and on COZYROC Cloud.