ACH Envelope Service

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

Service name
EnvelopeACH
Graphical Process Modeler (GPM) categories
All Services, EDI > ACH
Description
Envelope ACH messages including any associated addenda records.
Business usage
Support for the ACH translation standard in the Sterling Platform.
Usage example
Allows the system to envelope an ACH message, including any addenda records which may be in the ACH or other ACH approved standards syntax, using specified envelopes.
Preconfigured?
Yes
Requires third party files?
No
Platform availability
Available for all platforms.
Related services
EDI Envelope Service

BPs: EDI Envelope BP

EDIEncoder service should be called first to get the enveloping parameters.

Application requirements
None
Initiates business processes?
This service can invoke a business process if the selected ACH outbound envelope is configured to do so. There are no special business process requirements for this service. This service cannot be used outside a business process.
Invocation
If there is an associated addenda doc, then the BP calling this service must provide the data necessary to generate the addenda doc message inside the primary document.
Business process context considerations
None
Returned status values
Enter the possible status values that can be returned from this service.
  • Status: Description
  • Error: The Advanced Status message will indicate the error and the status report will give additional information.
Restrictions
None
Persistence level
Default
Testing considerations
  • Need a valid version 003020 X12 820 message to work with CCD and CTX message types. For other message types, need valid maps that will convert data from IBM® Sterling B2B Integrator format to ACH format. Need ACH Batch and File level outbound envelopes created. For debug messages to be logged, the system log needs to be turned on.

Business Process Example

This process uses EDIEncoder to get the envelope settings. It then envelopes the data in the primary document into an ACH message. It then writes the resultant ACH to the file system.

<process name="ACHEnvelopeTest1">
	<sequence>

		<operation>
			<participant name="EDIEncoder"/>
			<output message="EDIEncoderTypeInputMessage1">
				<assign to="." from="*"></assign>
				<assign to="AccepterLookupAlias">CIE</assign>
				<assign to="ReceiverID">111111111</assign>
				<assign to="SenderID">222222222</assign>
				<assign to="EDIStandard">ACH</assign>
			</output>
			<input message="inmsg">
				<assign to="." from="*"></assign>
			</input>
		</operation>

		<operation>
			<participant name="EnvelopeACH"/>
			<output message="EDIEnvelopeTypeInputMessage">
				<assign to="." from="*"></assign>
			</output>
			<input message="inmsg">
				<assign to="." from="*"></assign>
			</input>
		</operation>

		<operation>
			<participant name="EDITEST"/>
			<output message="FileSystemInputMessage">
				<assign to="." from="*"></assign>
				<assign to="Action">FS_EXTRACT</assign>
				<assign to="extractionFolder">/server/tests/scripts/edi/ach/resultdata/	</assign>
							<assign to="assignFilename">true</assign>
				<assign to="assignedFilename">ACHEnvelopeTest1.out</assign>
			</output>
			<input message="inmsg">
				<assign to="." from="*"></assign>
				</input>
			</operation>
		</sequence>
</process>

Using Wildcards when Creating Envelopes

As a way to help reduce the number of envelopes you need to create and use, the ACH Envelope service supports use of an asterisk (*) as a wildcard character in mandatory envelope fields. By using wildcards, you can create one set of envelopes that can be used for multiple trading partners. Then, when the ACH envelope service runs, it will replace the wildcards with correlation values. If certain trading partners have specific requirements, you can still have envelopes that pertain just to them, and the ACH 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.

The following list contains the correlation values that need to be set inside of process data in order to support wildcards:

  • ACHEnvelopeParms/Out_DestinationIdentification
  • ACHEnvelopeParms/Out_OriginIdentification
  • ACHEnvelopeParms/Out_DestinationName
  • ACHEnvelopeParms/Out_OriginName
  • ACHEnvelopeParms/Out_CompanyDiscretionaryData
  • ACHEnvelopeParms/Out_DiscretionaryData
  • ACHEnvelopeParms/Out_ReferenceCode

The following example shows how you might set correlation values in a business process:


<!-- Set up generic envelope correlation data -->
     <assign name="Assign" 
to="/ProcessData/ACHEnvelopeParms/Out_DestinationIdentification">
       111111111</assign>
     <assign name="Assign" 
to="/ProcessData/ACHEnvelopeParms/Out_OriginIdentification">
       222222222</assign>
     <assign name="Assign" 
to="/ProcessData/ACHEnvelopeParms/Out_DestinationName">
       WildcardDestName</assign>
     <assign name="Assign" to="/ProcessData/ACHEnvelopeParms/Out_OriginName">
       WildcardOriginName</assign>
     <assign name="Assign" 
to="/ProcessData/ACHEnvelopeParms/Out_ServiceClassCode">
       999</assign>
     <assign name="Assign" 
to="/ProcessData/ACHEnvelopeParms/Out_CompanyDiscretionaryData">
       WildcardCDD</assign>
     <assign name="Assign" 
to="/ProcessData/ACHEnvelopeParms/Out_DiscretionaryData">
       WC</assign>
     <assign name="Assign" to="/ProcessData/ACHEnvelopeParms/Out_ReferenceCode">
       RefCode</assign>
Note: All EDI services assign a Unique ID to each log message.