EDI Deenveloping Service
The following table provides an overview of the EDI Deenveloping service:
- System name
- EDIDeenvelopeType
- Graphical Process Modeler (GPM) categories
- All Services, EDI
- Description
- Identifies the EDI interchanges (including VDA, SWIFTNet, and RND) contained within a message, extracts them to separate messages, and starts the appropriate business process to handle each one.
- Preconfigured?
- Yes
- Requires third party files?
- No
- Platform availability
- All supported application platforms
Implementing the EDI Deenveloping Service
To implement the EDI Deenveloping service, complete the following tasks:
- Create an EDI Deenveloping service configuration.
- Configure the EDI Deenveloping service. For information, see Configuring the EDI Deenveloping Service.
- Use the EDI Deenveloping service in a business process.
Configuring the EDI Deenveloping Service
To configure the EDI Deenveloping service, you must define following fields in the GPM:
- Field
- Description
- Config
- Name of the service configuration.
- InterchangeTypes
- Enables you to specify what interchange type is used when the service runs. Used only for ACH, CII, VDA, SWIFT, and RND. Optional. Valid values are ACH, CII, VDA, SWIFT, and RND.
Correlation Data
The EDI Enveloping service and EDI Deenveloping service automatically collect the following correlation information from EDI documents:
- Category
- Data Collected
- Sender ID
- InterchangeSenderID
- GroupSenderID
- TransactionSenderID
- Receiver ID
- InterchangeReceiverID
- GroupReceiverID
- TransactionReceiverID
- Control Numbers
- InterchangeControlNumber
- GroupControlNumber
- TransactionControlNumber
- Acknowledgement Requested
- InterchangeAckRequested
- GroupAckRequested
- Acknowledgement Status
- InterchangeAckStatus
- GroupAckStatus
- Standard
- Standard – values are CII, EDIFACT, VDA, RND, SWIFT, and X12
- ID
- FunctionalID
- TransactionSetID
- Versions
- InterchangeVersion
- GroupVersion
- TransactionVersion
- Date and Time
- InterchangeDateTime
- GroupDateTime
- Overdue Time
- InterchangeOverdueTime
- GroupOverdueTime
- Level
- Level – values are Interchange, Group, and Transaction
- Direction
- Direction – values are Inbound and Outbound
- Envelope Type
- InterchangeEnvelopeType
- GroupEnvelopeType
- TransactionEnvelopeType
- Envelope Name
- InterchangeEnvelopeName
- GroupEnvelopeName
- TransactionEnvelopeName
- Envelope Version
- InterchangeEnvelopeVersion
- GroupEnvelopeVersion
- TransactionEnvelopeVersion
- Compliance Status
- InterchangeComplianceStatus
- GroupComplianceStatus
- TransactionComplianceStatus
Values are OK and NOT OK
- Test Mode
- TestMode – values are Production, Test Data and Information
- Counts
- TransactionCount
- GroupCount
- Container Doc ID
- ContainerDocID
The information for these correlations is automatically collected at each envelope and deenvelope stage for a document, which facilitates the tracking of individual documents as they move through the IBM® Sterling B2B Integrator.
There is no setup required for using the correlation information collected by the EDI Enveloping and EDI Deenveloping services. After you use one of these services in a business process, the information is available through the Correlation Search option.
Using Wildcards in Enveloping and Deenveloping Services
As a way to help reduce the number of envelopes you need to create and use, the EDI Envelope and EDI Deenveloping services support use of an asterisk (*) as a wildcard character in mandatory envelope fields for X12 and EDIFACT only. By using wildcards, you can set up one set of envelopes that can be used for multiple trading partners. If certain trading partners have specific requirements, you can still have envelopes that pertain just to them, and the EDI Envelope service chooses the envelope that is the best match. In other words, the envelope that has the most matches to specific fields in the data (for example Receiver ID, Receiver ID Qualifier), is the one selected.
Configuring EDI Deenveloping to Indicate an Error When Processing Data With No Valid Interchanges
To configure EDI Deenvelope to indicate an error when you process data that does not contain valid interchanges, add the following lines to the EDIDeenvelope business process:
<assign to="ErrorOnUnrecognizedData">yes</assign>
<assign to="ProcessInterchangesDespiteError">yes</assign>
These parameters function as follows:
- Parameter
- Function
- ErrorOnUnrecognizedData
- If this option is set to Yes, the business processes fails if it encounters an interchange that is not a valid interchange (based on the interchange types in the enveloping.properties file.
- ProcessInterchangesDespite
Error - If this option is set to Yes, any valid interchanges continue to bootstrap the deenvelope process. If this option is set to No and one invalid interchange is found, none of the interchanges will bootstrap the deenvelope process.
Configuring EDI Deenveloping to Check for Missing End Tags
To configure EDI Deenvelope to indicate an error when end tags are missing, add the following lines to the EDIDeenvelope business process:
<assign to="BASIC_CHECK_FOR_MISSING_END_TAG">yes</assign>
<assign to="COMPREHENSIVE_CHECK_FOR_MISSING_END_TAG">yes</assign>
These parameters function as follows:
- Parameter
- Function
- BASIC_CHECK_FOR_MISSING_END_TAG
- If this option is set to Yes, the business process checks to see if any end tags are missing.
- COMPREHENSIVE_CHECK_
FOR_MISSING_END_TAG - If this option is set to Yes, the business process kicks off a comprehensive check to see if any end tags are missing.
Configuring the Number of Interchange Types Allowable with EDI Deenveloping
To configure EDI Deenvelope to override the default number of interchange types set in the enveloping.properties files, add the following line to the EDIDeenvelope business process:
<assign to="interchangetypes">15</assign>
This parameter functions as follows:
- Parameter
- Function
- InterchangeTypes
- Overrides the default set in the enveloping.properties file to specify the number of interchange types for deenveloping.
Configuring SWIFT FIN Extraction for ACK with Original Message
Depending on the configuration of SWIFTAlliance Access, FIN acknowledgments that are received by the IBM Sterling B2B Integrator may be accompanied by a full or partial copy of the corresponding original message, similar to the following:
{1:F21PTSCFRN0AXXX0208003695}{4:{177:1001131958}{451:0}{108:24}}{1:F01PTSCFRN0AXX
X0208003695}{2:I999PTSCFRN0XXXXN}{3:{108:24}}{5:{CHK:6F227EC3C468}{TNG:}{PDE:}}{S
:{CON:}{UNT:None}{USR:all_adm}}
By default, the EDI Deenveloping service breaks up this type of message into two separate documents for processing. To direct the service to keep the acknowledgment and the corresponding original message together in a single document for processing, you must set the workflow parameter SWIFT_FIN_EXTRACT_MESSAGE_WITH_ACK to Yes or True when you invoke the service. For example:
<assign to="SWIFT_FIN_EXTRACT_MESSAGE_WITH_ACK">true</assign>
This parameter functions as follows:
- Parameter
- Function
- SWIFT_FIN_EXTRACT_MESSAGE_WITH_ACK
- Set to True or Yes to process a SWIFT FIN acknowledgment and the corresponding original message as one document. The default for this parameter is False.