ACH Deenvelope Service

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

Note: ACH Deenvelope service will detect if incoming ACH data contains non-numeric data in cumulative fields and end processing with an appropriate error message.
Service name
DeenvelopeACH
Graphical Process Modeler (GPM) categories
All Services, EDI > ACH
Description
Deenvelopes entry detail records for any ACH SEC code while extracting the associated addenda records
Business usage
Support for the ACH translation standard.
Usage example
This service may convert ACH data into IBM® Sterling B2B Integrator format and invoke a BP on it.
Preconfigured?
Yes.
Requires third party files?
No
Platform availability
All supported application platforms.
Related services
For SEC codes that contain compressed X12 or EDIFACT messages, the appropriate deenveloping service will typically be invoked.

Related BPs: ACH Deenvelope BP; EDI Deenvelope

Application requirements
None
Initiates business processes
This service can invoke a business process if the ACH batch envelope is configured to do so. There are no special business process requirements for this service; however, you cannot use the service outside a business process.
Invocation
You must configure a business process or envelope to call the predefined deenveloping business process. The event calling this service must provide the ACH file as the primary document.
Business process context considerations
Deenveloping details are written to process data.
Returned status values
The Advanced Status message will indicate the de-enveloping error and the status report will give additional information about the error.

If an error occurs, a parameter called "ERROR_CODE" is written to the process data. This parameter can be used by the appropriate business process to determine the type of error that occurred and take the appropriate action. If an interchange level error occurs, this error code is written to the process data of the parent business process. If a batch level error occurs, the error code is written to the process data of the business process invoked when the 820 document was extracted, or to the error business process.

The ERROR_CODE parameter can have one of the following values:

Interchange level error codes (and descriptions):

  • NO_PRIMARY_DOCUMENT (Primary document was not supplied to the service)
  • INVALID_ACH_HEADER (ACH Header is invalid)
  • INVALID_ACH_TRAILER (ACH Trailer is invalid)

Batch level error codes (and descriptions):

  • 820_TRANSLATION_ERROR 820 (Error while translating the extracted 820)
  • ACH_820_DISCREPANCY (Discrepancy between data in ACH and extracted 820.)
  • ACH_VALIDATION_ERROR (ACH document does not conform to specification)
  • ENVELOPE_NOT_FOUND (ACH Envelope was not found)
  • AMBIGUOUS_ENVELOPES (More than one matching ACH envelopes were found)
  • SUCCESS_BPNAME_ERROR (Error determining the BP name to be invoked on extracted 820)
  • DUPLICATE_FILEID_MODIFIER (File ID Modifier of the ACH document was previously recorded.)
Restrictions
The ACH Deenvelope supports ACH batch level rejection as follows: if an incoming message contains multiple batches, but some batches are non-compliant, only those non-compliant batches are rejected. The remaining (compliant) batches are processed.
Persistence level
Full persistence (default)
Testing considerations
Need a valid version ACH message. Need ACH file level and batch level inbound envelopes created. For debug messages to be logged, the system log needs to be turned on.

Parameters Passed from Service to Business Process


Parameter Name
Description
ExtractedFields
Batch header record fields are put into “Extracted Fields/ACHBatchHeaderRecord”. File header records are put into “ExtractedFields/ACHFileHeaderRecord”

Business Process Example

This process de-envelopes the ACH interchange contained in the primary document. It then writes the resultant X12 820 message to the file system.