Generic Envelope 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 Envelope service:

System name
GenericEnvelope
Graphical Process Modeler (GPM) categories
All Services, EDI
Description
Applies a SWIFT, CHIPS, Fedwire, TRADACOMS, RND, or VDA envelope to the set of transaction set messages that it receives as input, according to the envelope definition contained in the EDI State extension of the messages that were originally placed on the enveloping business process.
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 Envelope, CHIPS Envelope, Fedwire Envelope, TRADACOMS Envelope, RNDEnvelope, and VDAEnvelope business processes to envelope the EDI transactions contained in the business process context with SWIFT/CHIPS/Fedwire/TRADACOMS/VDA/RND envelopes that have been preconfigured and saved as translation maps in the IBM® Sterling B2B Integrator.
Note: The Generic envelope 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, RND, or VDA data must be sent to a trading partner. In preparation of this, the data must be enveloped in order to provide identifying batch and interchange data. The SWIFT Envelope, CHIPS Envelope, Fedwire Envelope, TRADACOMS Envelope, RNDEnvelope, or VDAEnvelope business process calls GenericEnvelope to provide these enveloping services.
Preconfigured?
Yes
Platform availability
All supported application platforms
Related services
No
Application requirements
No
Invocation
Currently run only by the SWIFT Envelope, CHIPS Envelope, Fedwire Envelope, TRADACOMS Envelope, RNDEnvelope, and VDAEnvelope business processes.
Notes
Output messages:
  • No_Documents_To_Envelope – If EDIEncoder is not run prior to running EnvelopeGeneric service
  • EnvelopeMapName cannot be null – If EnvelopeMapName parameter is not defined in the envelope definition
  • No_Envelope_Defined – If the envelope defined has a Sender ID, Receiver ID, or AcceptorLookupAlias different from that in the EDIEncoder step of the business process
  • Document Translation Error – If the document translation step produced errors
  • Envelope Translation Error – If the envelope translation step produced errors

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 Envelope 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 Envelope 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.