Generic Deenvelope Service

Note: This is an internal service that should not be used externally for steps in creating business processes because it is subject to change without notice, and use may cause unpredictable results and loss of data. This section is intended for information purposes only.

The following table provides an overview of the Generic Deenvelope service:

System name
GenericDeenvelope
Graphical Process Modeler (GPM) categories
All Services, EDI
Description
Parses a SWIFT, CHIPS, Fedwire, TRADACOMS, VDA, or RND envelope; checks it for compliance; and extracts the transaction sets that it contains so they can be further processed by the IBM® Sterling B2B Integrator.
Note: In previous releases, the document lifespan default was zero so that when the workflow expired, all associated documents were purged/archived with the workflow. Now the lifespan is configurable for documents awaiting acknowledgement (the default is 30 days) and standards that use the Generic Deenvelope and Generic Envelope services. You can change the default lifespan by editing the document.lifespan property in the enveloping.properties file. The document lifespan of the outbound document is automatically reset to zero after the acknowledgement for the document is received or if the user manually accepts the acknowledgement.
Business usage
Used within the SWIFT Deenvelope, CHIPS Deenvelope, Fedwire Deenvelope, TRADACOMS Deenvelope, VDADeenvelope, and RNDDeenvelope business processes to deenvelope the data.
Note: The Generic Deenvelope service assumes that SWIFT expects a starting CRLF (carriage return/line feed) but not an ending CRLF.
Usage example
A typical scenario is one where SWIFT, CHIPS, Fedwire, TRADACOMS, VDA, or RND data must be received from a trading partner. The data must be deenveloped in order to extract identifying batch and interchange data. The SWIFT Deenvelope, CHIPS Deenvelope, Fedwire Deenvelope, TRADACOMS Deenvelope, RNDDeenvelope, or VDADeenvelope business process calls GenericDeenvelope to provide these enveloping services.
Preconfigured?
Yes
Requires third party files?
No
Platform availability
All supported application platforms
Invocation
Currently run only by the SWIFT Deenvelope, CHIPS Deenvelope, Fedwire Deenvelope, TRADACOMS Deenvelope, RNDDeenvelope, and VDADeenvelope business processes.
Business process context considerations
Translation occurs using the SWIFT_Deenvelope, CHIPS_Deenvelope, Fedwire_Deenvelope, TRADACOMS_Deenvelope, RNDDeenvelope, or VDA_Deenvelope map. That map updates ProcessData with the SenderId, ReceiverId, MessageType, EnvelopeType, and ControlNumber. The service extracts this information from ProcessData using the business process context and finds the associated envelope definition. The envelope definition provides the name of another map used for compliance checking and translation.

Document Tracking Levels and Performance

You can improve EDI performance in the IBM Sterling B2B Integrator by using the TRACKING_LEVEL parameter to adjust the tracking level for business processes.

You set the default global settings for the TRACKING_LEVEL parameter in the enveloping.properties file. However, these global settings can be overridden for certain EDI-related services by using the BPML-only TRACKING_LEVEL parameter. This enables you to obtain maximum EDI performance in some business processes and maximum search and tracking functionality in others. This parameter can be set for the following services:

Inbound Services

  • CII Deenvelope service
  • EDIFACT Deenvelope service
  • EDI Post Processor service
  • X12 Deenvelope service
  • Generic Deenvelope service

Outbound Services

  • EDI Encoder service
  • CII Envelope service
  • EDIFACT Envelope service
  • Envelope Generic service
  • X12 Envelope service

This performance improvement is done at the expense of Tracking and Search functionality. The tracking level setting affects the following EDI functionality:

  • EDI Correlation Search
  • EDI Document Tracking
  • EDI Reporting

The TRACKING_LEVEL parameter is not available in the IBM Sterling B2B Integrator service configuration or in the GPM; it must be added manually to the BPML. Use the TRACKING_LEVEL parameter with one of the following settings:

Note: Document tracking is turned off by default in the system-defined EDI business processes. If you define an EDI business process and turn Document Tracking on, that will override the TRACKING_LEVEL settings in both the enveloping.properties file and the EDI service parameter.
Setting
Description
none
Provides the best EDI performance with the least tracking and search functionality. EDI Correlation Search, EDI Document Tracking, and EDI Reporting are nonfunctional.
basic
Provides a good EDI performance while also providing search functionality. EDI Correlation Search is functional. EDI Document Tracking, and EDI Reporting are nonfunctional.
full
Default setting. Provides the lowest EDI performance with the highest search and tracking functionality. EDI Correlation Search, EDI Document Tracking, and EDI Reporting are fully functional.

Adding Translation Map Name to Process Data

The Generic Deenvelope service automatically adds the name of the map used by the translator (as specified when building the envelope) in an inbound or outbound translation to process data. The Generic Deenvelope service writes the map name into the process data regardless of the reason the translator was invoked; that is, for a compliance check only, or for both compliance check and translation.The map name in process data enables enhanced configuration possibilities for your business process models. For example, you can configure business processes to use the map name for tracking or cross reference purposes, configure decisions in your process models to choose a subprocess according to the map that was run, or to create a report when there are translation errors.

Splitting Documents in a Delimited EDI File

When you use the Document Extraction service to split documents in a delimited EDI file, only one set of delimiters is supported. The input file cannot contain multiple documents that each use a different set of delimiters. Therefore, if you have multiple documents using different delimiters, you must first send the data through the EDI Deenvelope service (in Document mode) to split out the individual documents that use differing delimiters. When you invoke the EDI Deenvelope service, the Mode service parameter must be set to Document. This instructs the EDI Deenvelope service not to bootstrap a business process after it finishes splitting the input file. You must also update the customer_overrides.properties file to include the START and END tag of the documents to be extracted, as well as the delimiters (or the location of delimiters) to use.