ACH Module Version 6.1.September 2006 | Understanding and Using webMethods ACH Module | Installing and Using ACH Module | Services | Summary of Services | wm.ip.persist.util:query
 
wm.ip.persist.util:query
WmIPPersist. Retrieves a list of messages from the ACH Module persistence store based on search criteria specified.
Input Parameters
productKey
String Identifier representing the product. When using ACH Module, the product key must be ACH.
msgType
String Type of the ACH message. When using ACH Module, 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.
version
String Version of the ACH message. 1.0 is the only valid value.
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.
maxResults
String Maximum number of messages to be retrieved from ACH Module persistence store.
Output Parameters
resultInfo
IData[ ] List of message headers containing message keys.
resultCount
String Number of messages retrieved matching the criteria.
resultMessage
String Message describing the nature of result.
Usage Notes
Before using the additionalQueryFields parameter for querying, ensure that the additionalQueryFields parameter is 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 use the 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. The wm.ip.persist.util:query service adds the additional fields in the pipeline to additionalQueryFields. If you do not want the service to add the additional fields in the pipeline to additionalQueryFields, ensure that you clear the pipeline before executing the wm.ip.persist.util:query service.
See Also
wm.ip.persist.util:add
Examples
None.