IBM DataPower Operations Dashboard v1.0.6.0
A newer version of this product documentation is available.
You are viewing an older version. View latest at IBM DPOD Documentation.
Available Filters
The following table lists the available filters within DPOD.
Most sections of DPOD display only a subset of this list, as applicable to the data displayed in different sections.
Filters in IDG View
Filter Name | Functionality |
---|---|
Application Data | Visible on the Extended Transactions screen only, it is used to search user data. The use of this filter requires XSLT modification |
B2B Message ID | Visible in the Raw Message screen only. The B2B Message ID, From Partner ID and To Partner ID. |
Category | Only show messages of the selected category or categories. Valid values: |
Cause | Visible in the Restarts dashboard only. The restart cause (device initiated, user initiated, etc.) |
Catalog Name | API Connect dashboards only. |
Client IP | Only show messages and transactions originating on one or more client IPs. Valid values: Valid IP Addresses |
Corr. Id | Only show information related to one or more correlation ids. Valid values: Correlation ids of extended transactions. |
Device | Only show information related to the selected device(s). Valid values:
|
Domain | Only show information related to the selected domain(s). Valid values:
|
Downtime Started | Visible in the Restarts dashboard only. The estimated time where the device was not available |
Error Message | Only show transactions that failed, where the error message contains the term entered into the input box for this filter. Valid values: Free text |
Free Text | Enter a value to search multiple fields at once (depends on the dashboard) |
Front-Side Handler | Only show services going through the specific Front-side handler(s). Valid values:
|
Front URI | The URL the service exposes (Configuration Only) |
Global Trans. ID | The Global Tansaction ID |
In URI | Visible on Service URI Calls only. The URI that clients use to invoke transactions. |
In URL | Visible on Extended Transactions and Service URL Calls dash board only. The URL that clients use to invoke transactions. |
Message | Â |
Message Code | Message code as reported from a log target of a monitored device. |
Min Elapsed | Filter the displayed transactions by minimum elapsed time (in ms). Valid values: Non-negative integers |
Min Request | Filter the displayed transactions by minimum request time (in ms). Valid values: Non-negative integers |
Min Response | Filter the displayed transactions by minimum response time (in ms). Valid values: Non-negative integers |
Obj. Name | Object Name as reported from a log target of a monitored device. Normally contains service Name or front side handler |
Obj. Type | Object Type as reported from a log target of a monitored device. |
Operation | Service Operation name - only applies for Web-Service Proxy service type. |
Out URL | Visible on Extended Transactions only. The URL that the transaction invoked at the back end. |
Payload | WS-M payload recorded on monitored devices. |
Service | Only include transactions on the selected service(s). Valid values: Any service name(s) in the system The available values list will change according to the context: |
Service Type | Multi Protocol or Web Service Proxy (Configuration Only) |
Severity | Severity as reported from a log target of a monitored device. |
Status | Only include transactions with the selected status(es). Valid values:
|
Time | Filter display by time interval. Valid values:
|
Trans. Direction | Filter display by the transaction’s direction. Valid values:
|
Trans. ID | Filter display by the id(s) of one or more transactions. Valid values: Transaction ids |
Additional Filters in APIC View
Filter Name | Functionality |
---|---|
Catalog Name | Filter the displayed transactions by the name of the Catalog that was used during the API call. |
Space Name | Filter the displayed transactions by the name of the Space that was used during the API call. |
Plan Name | Filter the displayed transactions by the name of the Plan that was used during the API call. |
Plan ID | Filter the displayed transactions by the ID of the Plan that was used during the API call. |
API Name | Filter the displayed transactions by the name of the API that was activated. |
API Version | Filter the displayed transactions by the version of the API that was activated. |
Path URLÂ | Filter the displayed transactions by the URL that was activated by the client. |
HTTP Method | Filter the displayed transactions by the HTTP Method that was used in the API call HTTP request |
Operation ID | Filter the displayed transactions by the ID of the operation that was activated during the API call. |
Client ID | Filter the displayed transactions by the ID of the client that activated the API call. Client IDs are generated by the API Managment Server during client registation. |
Product ID | Filter the displayed transactions by the ID of the product that was consumed by the API call. |
OAuth Scope | Filter the displayed transactions by the Scope of the OAuth Token that was delivered by the client in the API call. |
OAuth Resource Owner | Filter the displayed transactions by the Resource Owner of the OAuth Token that was delivered by the client in the API call. |
OAuth Token Valid From | Filter the displayed transactions by the time that the OAuth Token is valid from. |
OAuth Token Valid Until | Filter the displayed transactions by the time that the OAuth Token is valid to. |
Min. Request Latency | Filter the displayed transactions by the minimum time it took to process the request (in ms). |
Min. Response Latency | Filter the displayed transactions by the minimum time it took to process the response (in ms). |
Min. Back-End Latency | Filter the displayed transactions by the minimum time it took to wait for the backend server to reply (in ms). |
Min. Total Latency | Filter the displayed transactions by the minimum time that the API tarnsaction took till a response was returned to the client (in ms). |
Min Request Size | Filter the displayed transactions by the minimum size of the request. |
Min Response Size | Filter the displayed transactions by the minimum size of the response. |
Error Message | Filter the display to only show transactions that failed, where the error message contains the |
Error Reason | Filter the display to only show transactions that failed, where the error reason contains the term typed in the input box for this filter. |
Consumer Org ID | Filter the displayed transactions by the ID of the Organization that the client who activated the API call belongs to. Organization IDs are generated by the API Managment Server at registration. |
Front-End HTTP Response Code | Filter the displayed transactions by the HTTP Response Code that the APIC sent back to the client. |
Back-End HTTP Response Code | Filter the displayed transactions by the HTTP Response Code that the APIC recieved from the backend. |