ACH Module Version 6.1.September 2006 | Understanding and Using webMethods ACH Module | Installing and Using ACH Module | Services | Summary of Services | wm.ach.queue:query
 
wm.ach.queue:query
WmACH. Returns a set of batch keys from the batch queue that matches the specified criteria.
Input Parameters
fromDate
String The earliest effective entry date the search is to return. If you leave this parameter blank, the search will consider the beginning of the date range to be open-ended.
The effective entry date is a field in the batch header record.
toDate
String The latest effective entry date the search is to return. If you leave this parameter blank, the search will consider the end of the date range to be open-ended.
The effective entry date is a field in the batch header record.
msgType
String Type of the ACH message. The message type must be one of the SEC codes listed in Standard Entry Class Codes.
If you leave this parameter blank, the search will return all message types except ADV.
senderId
String Origin of the ACH message. If you leave this parameter blank, the search will return all originator IDs.
receiverId
String Destination of the ACH message. If you leave this parameter blank, the search will return all receiver IDs.
additionalQueryFields
IData Additional keys used to narrow the search results. The keys must be one of the batch header fields. The query will consider an additional query field only if it was identified as an additional persistence query field at the time the batch was added to the batch queue.
Separate keys with commas. See usage notes below.
Output Parameters
batchId
String[ ] Batch IDs for batches retrieved from the queue.
resultCount
String Number of batches matching the criteria.
errors
String Any errors produced during invocation of service.
Usage Notes
Before using the additionalQueryFields parameter for querying, it must be configured through the wm.ip.config:setConfig service or the ACH Current Configuration page. Any number of batch header fields can be used. Queue services uses these additional index fields, along with the standard index fields (message type, message version, sender ID, receiver ID, and effective entry date), to create an index when queuing batches.
See Also
wm.ip.config:setConfig
Examples
None.