Use this connector to read or write EDIFACT documents in (or from) the canonical EDI message structure. This structure is a hierarchy of Java Map and List objects. You use either DataWeave or code to manipulate them. Each transaction has its own structure as defined in the schemas.
The message contains the following keys, some of which apply to either the Read operation or the Write operation, as indicated:
Key Name |
Description |
Delimiters |
An optional set of delimiters used in the message. If used in a Read operation, the delimiters are based on the most recent interchange processed by a Read operation. If used for a Write operation, the delimiters override the values in the module configuration. The characters in the string of delimiters are interpreted based on their position in string, in the following order: data element separator, component element separator, repetition separator, segment terminator, release character. |
Errors (read only) |
A list of errors that are associated either with the input as a whole or with interchanges that have no valid transaction sets. |
FunctionalAcksGenerated (read only) |
A list of CONTRL acknowledgments that are generated by the module during the Read operation. |
FunctionalAcksToSend (write only) |
A list of CONTRL acknowledgments that are sent by the module during the Write operation. |
Interchange (write only) |
Map of UNB interchange header segment values used as defaults during an interchange Write operation. |
Messages |
A hierarchy of messages that are either read by the module during a Read operation or sent by the module during a Write operation. The value of this top-level key is a map with standard versions as keys, in the form D96A . For example, if you are using version D96.A ORDERS and CUSRES messages, the Messages contain a map with one key, D96A . The value of this key is another map, one with two keys, ORDERS and CUSRES . Each of these contains a list of individual ORDERS and CUSRES messages that are processed. |
Individual messages have their own maps, with the following keys:
Key |
Description |
Detail |
Map of segments or loops from the detail section of the message. Values are maps for segments or loops that occur once. Lists of maps are for values that occur more than once. |
Errors (read only) |
A list of errors associated with the message. |
Heading |
A map of segments or loops from the heading section of the message. Values are maps for segments or loops that occur once. Lists of maps exist for values that occur more than once. |
Id |
The Message ID must match the key of the containing message list. |
Interchange |
A map of UNB interchange header segment values. For a Read message, the map is the actual data from the enclosing interchange. It is a single map linked from all messages in the interchange. For a Write message, the map value creates the enclosing interchange. For example, gathering messages with the same interchange values into a single interchange, regardless of whether the actual maps are the same. If there are no values for this map, then the default is the value taken from the Interchange map at the message level. |
Group |
A map that contains the UNG group header segment values:
-
For a read message, the map consists of data from the enclosing group. The map is a single map linked from all transaction sets in the group.
-
For a write message, the map value creates the enclosing group. If there are no values for the map, it consists of values taken from the group map at the message level by default.
|
MessageHeader |
Map of UNH message header segment values. This provides the actual header data for a Read operation, and enables you to provide overrides for Write operation configuration settings. |
Name |
Message name |
Summary |
Map of segments or loops from the summary section of the message. Values are maps for segments or loops that occur once. Lists of maps are for values that occur more than once. |
Generated CONTRL functional acknowledgment messages differ from Received messages in their handling of interchange information:
Key name |
Description |
Interchange |
For functional acknowledgments generated by Receive processing, this map is a copy of the data for the containing interchange with Sender and Receiver identification components (UNB2.1/UNB2.2 and UNB2.1/UNB3.2). For a Write message, these values are used for creating the enclosing interchange. For example, messages are gathered with the same interchange values into a single interchange, regardless of whether the actual maps are the same. If there are no values for this map, then the default is the value taken from the Interchange map at the message level. |