EDI mapping
XML tag
Tag name for the root XML element.
Required
Documentation
Documentation describing this EDI mapping.
Optional
The different types of segments ("records" / "lines") that can appear in the EDI message.
These segments must appear in the order indicated before any of the segment groups.
If multiple segments should be grouped together because they can repeat within the EDI message, use a segment group instead.
In the following example, HEADER should be defined as a segment, while ORDER & PICKUP & DELIVERY should be defined as one segment group:
HEADER ... ORDER ... PICKUP ... DELIVERY ... ORDER ... PICKUP ... DELIVERY ... ORDER ... PICKUP ... DELIVERY ...
The different segment groups that can appear in the EDI message.
These segment groups must appear in the order indicated after any of the segments.
In the following example, HEADER should be defined as a segment, while ORDER & PICKUP & DELIVERY should be defined as one segment group:
HEADER ... ORDER ... PICKUP ... DELIVERY ... ORDER ... PICKUP ... DELIVERY ... ORDER ... PICKUP ... DELIVERY ...
XML tag
Tag name for the root XML element.
Required
Documentation
Documentation describing this EDI mapping.
Optional
The different types of segments ("records" / "lines") that can appear in the EDI message.
These segments must appear in the order indicated before any of the segment groups.
If multiple segments should be grouped together because they can repeat within the EDI message, use a segment group instead.
In the following example, HEADER should be defined as a segment, while ORDER & PICKUP & DELIVERY should be defined as one segment group:
HEADER ... ORDER ... PICKUP ... DELIVERY ... ORDER ... PICKUP ... DELIVERY ... ORDER ... PICKUP ... DELIVERY ...
The different segment groups that can appear in the EDI message.
These segment groups must appear in the order indicated after any of the segments.
In the following example, HEADER should be defined as a segment, while ORDER & PICKUP & DELIVERY should be defined as one segment group:
HEADER ... ORDER ... PICKUP ... DELIVERY ... ORDER ... PICKUP ... DELIVERY ... ORDER ... PICKUP ... DELIVERY ...
Name
(Descriptive) name for this EDI mapping.
Required
Version
The version of this EDI mapping, e.g. 1.0.
Required
Namespace
Optional XML namespace for this EDI mapping. When provided, all XML elements defined in this EDI mapping will use this namespace, otherwise they will be namespace-less.
Optional
Name
(Descriptive) name for this EDI mapping.
Required
Version
The version of this EDI mapping, e.g. 1.0.
Required
Namespace
Optional XML namespace for this EDI mapping. When provided, all XML elements defined in this EDI mapping will use this namespace, otherwise they will be namespace-less.
Optional
Segment
Delimiter character(s) separating segments ("records" / "lines") in the EDI format.
The special suffix !$ can be added to this delimiter to indicate that the carriage return and life feed characters should be ignored when parsing the segments.
This field supports Java String rules for entering special characters, e.g. \r\n is a "Windows enter".
Required
Field
Delimiter character(s) separating fields (within segments) in the EDI format.
This field supports Java String rules for entering special characters, e.g. \t is a tab character.
Required
Component
Delimiter character(s) separating components (within fields) in the EDI format.
This field supports Java String rules for entering special characters, e.g. \u00A0 is a non-breaking space (using the unicode character notation).
Required
Sub-component
Delimiter character(s) separating sub-components (within components) in the EDI format. This is an optional level in the EDI mapping hierarchy.
This field supports Java String rules for entering special characters.
Optional
Field repeat
Delimiter character(s) indicating that a field is repeating multiple times within a segment.
This field supports Java String rules for entering special characters.
Optional
Escape
Character(s) used to escape any of the other delimiter characters when these appear in the actual data.
This field supports Java String rules for entering special characters, e.g. \ is a backslash.
Optional
Segment
Delimiter character(s) separating segments ("records" / "lines") in the EDI format.
The special suffix !$ can be added to this delimiter to indicate that the carriage return and life feed characters should be ignored when parsing the segments.
This field supports Java String rules for entering special characters, e.g. \r\n is a "Windows enter".
Required
Field
Delimiter character(s) separating fields (within segments) in the EDI format.
This field supports Java String rules for entering special characters, e.g. \t is a tab character.
Required
Component
Delimiter character(s) separating components (within fields) in the EDI format.
This field supports Java String rules for entering special characters, e.g. \u00A0 is a non-breaking space (using the unicode character notation).
Required
Sub-component
Delimiter character(s) separating sub-components (within components) in the EDI format. This is an optional level in the EDI mapping hierarchy.
This field supports Java String rules for entering special characters.
Optional
Field repeat
Delimiter character(s) indicating that a field is repeating multiple times within a segment.
This field supports Java String rules for entering special characters.
Optional
Escape
Character(s) used to escape any of the other delimiter characters when these appear in the actual data.
This field supports Java String rules for entering special characters, e.g. \ is a backslash.
Optional