Service Request - (Query)
The Service Request – (Query) page allows you to view the results of processed Web Banking Interface requests, eDeposit Integration service requests, Foreign Currency Exchange service requests, Data Perfection service requests, and transmitted data files sent from the CS Receive application to the Transaction Gateway. Depending on which data you wish to view, you can either search for a specific request (or request element or operation contained within a request) by request ID number, a specific data file by deposit instance ID, or construct a query to search for a range of request documents (or request elements or operations) or data files.
To display a specific request:
- If your environment is configured to support multiple services, select the service you wish to query by choosing the appropriate entry from the Service drop-down menu.
- Enter the identification number assigned to the request or data file in the Request ID field.
- For Web Banking Interface queries, use the string value provided in the
<RequestDocumentId>
element of the request document. - For eDeposit Integration service queries, use the string value provided in the
requestId
attribute of the request. - For CS Receive-transmitted data files and Foreign Currency Exchange service requests, enter the instance ID of the specific deposit.
- For Data Perfection service queries, enter the ID of the request document.
- Click the Search button.
The request and all request elements included in the request document matching your entered Request ID number appear in the table at the bottom of the page.
- To view the complete document structure for a request (with all included elements), click the Document element type row in the table.
- To view a specific request element within the document, click the corresponding table row.
- To sort the table, click one of the column headings.
- To reset the Request ID field before searching for another request, click the Clear button.
To display requests using a query:
- If your environment is configured to support multiple services, select the service you wish to query by choosing the appropriate entry from the Service drop-down menu.
- Construct your query using the following guidelines:
- To limit requests to a specific type, select the request type from the Element type drop-down menu.
Note: If your system is configured to log document-level requests only, you may not be able to select a specific request type (and the Element type drop-down menu may not appear). Depending on your system configuration, document-level requests may be filterable if a specific request type was assigned to the request document as an optional <RequestType>
element included in the submitted request.
- For CS Receive-transmitted data files, select CS XML data to restrict your query to transaction data files sent from the CS Receive application, CS Image XML data to restrict your query to image data files sent from the CS Receive application, or <All> to query both data file types.
- For Foreign Currency Exchange service requests, select Accept Exchange Rate to restrict your query to Accept Exchange Rate requests, Cancel Exchange Rate to restrict your query to Cancel Exchange Rate requests, Get Exchange Rate to restrict your query to Get Exchange Rate requests, or <All> to query all request types.
- For Data Perfection service requests, select Request to restrict your query to request documents, Unit of Work to restrict your query to unit of work-level records, Deposit to restrict your query to deposit-level records, or <All> to include all levels in your query.
Unit of Work ID – After selecting Deposit or Unit of Work from the Element type menu, you can restrict your query to a specific unit of work by entering the string provided in the <uowID>
element for the associated unit of work in the request document.
Deposit ID – After selecting Deposit from the Element type menu, you can restrict your query to a specific deposit by entering the string provided in the <depositID>
element for the associated deposit in the request document.
- To limit requests to a specific processing status, select one of the following items from the Status drop-down menu:
For Web Banking Interface and eDeposit Integration service queries:
- Failed – Restrict your query to requests that were could not be processed by eDeposit. Failed requests occur if one or more requests contained within a request document could not be processed successfully, or if a system error or database connection issue prevented the request from being processed.
- Fatal – Not well-formed – Restrict your query to requests that could not be fully processed by eDeposit because of XML syntax errors.
- Success – Restrict your query to requests that were processed successfully by eDeposit.
- Success – With ignored error(s) – Restrict your query to requests that, while processed successfully, contained one or more processing errors that were ignored (for example, in environments configured to allow Put Deposit or Send Deposit processing to continue if the associated call to the Deposit Notification service failed).
For CS Receive application queries:
- Success – Restrict your query to data files that were sent to Transaction Gateway.
For Foreign Currency Exchange service queries:
- Success – Restrict your query to requests that were successfully received and processed by the bank-hosted Foreign Currency Exchange service
- Service unavailable – Restrict your query to requests that could not be processed because the service could not be contacted
- Fatal – Not well-formed – Restrict your query to requests that could not be fully processed by the service because of XML syntax errors, or Failed to restrict your query to requests that could not be processed by the service for other reasons.
For Data Perfection service queries:
- Success – Restrict your query to requests that were processed successfully by eDeposit.
- Success - With failed deposits – Restrict your query to requests that, while processed successfully, contained one or more deposits with associated errors (this selection is not available if you selected Deposit or Unit of Work from the Element type menu).
- Fatal - Not well-formed – Restrict your query to requests that could not be fully processed by eDeposit because of XML syntax errors.
- Failed – Restrict your query to requests that could not be processed by eDeposit.
- To limit requests to a specific bank, enter the bank name in the Bank ID field.
- To limit requests to a specific customer, enter the customer name in the Customer UID field, or click the Find Customer link to locate the desired customer.
- To limit requests to a specific user, enter the user name in the User ID field, or click the Find User link (displayed after a customer is selected) to locate the desired user.
- To limit requests by date range, use the Start date and End date controls to specify the desired range:
- Click the Search button.
The requests matching your search criteria appear in the table at the bottom of the page.
- To view the complete document structure for a request (with all included elements), click the Document element type row in the table.
- To view a specific request element, click the corresponding table row.
- To sort the table, click one of the column headings.
- To reset the query fields before searching for another request, click the Clear button.