IBM DataPower Operations Dashboard v1.0.15.0
A newer version of this product documentation is available.
You are viewing an older version. View latest at IBM DPOD Documentation.
Available Filters
- Copy Page Tree
- Amit Munwes
- Former user (Deleted)
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 |
|---|---|
B2B Message ID | Visible in the Raw Message screen only. The B2B Message ID, From Partner ID, To Partner ID, From Partner Profile and To Partner Profile. |
| 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). |
| Domain | Only show information related to the selected domain(s). |
| 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 in multiple fields at once (depends on the page where the filter exists). |
| 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 |
| URI | Visible on Extended Transactions and Service URI Calls only. The URI that clients use to invoke transactions. |
| URL | Visible on Service URL Calls only. The URL that clients use to invoke transactions. |
| Message | |
| Message Code | Message code as reported from a log target of a monitored device. |
| Elapsed Time | Filter the displayed transactions by elapsed time (in ms). Valid values: Non-negative integers |
| Request Size | Filter the displayed transactions by request size (in bytes). Valid values: Non-negative integers Available since IDG firmware 7.6.0.8 and 7.7.1.2 for transactions of traditional IDG services |
| Response Size | Filter the displayed transactions by response size (in bytes). Valid values: Non-negative integers Available since IDG firmware 7.6.0.8 and 7.7.1.2 for transactions of traditional IDG services |
| 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. |
| 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).
|
| Time | Filter display by time interval. Valid values:
Click the left arrow next to the filter to move to the previous interval (for example, previous 15 minutes), or the right arrow to move the the next interval (for example, next 15 minutes).
|
| 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 |
|---|---|
| Provider Org Name | Filter the displayed transactions by the provider organization name that was used during the API call. |
| Catalog | Filter the displayed transactions by the name of the catalog that was used during the API call. |
| Space | Filter the displayed transactions by the name of the space that was used during the API call. |
| Product | Filter the displayed transactions by the product name that was consumed by the API call. |
| Plan | Filter the displayed transactions by the name 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. |
| Consumer Org Name | Filter the displayed transactions by the consumer organization name that was used during the API call. |
| App Name | Filter the displayed transactions by the name of the consumer application that made the API call. |
| HTTP Method | Filter the displayed transactions by the HTTP method that was used in the API call HTTP request. |
| URLÂ | Filter the displayed transactions by the URL that was activated by the client. |
| URI | Filter the displayed transactions by the URI that was activated by the client. |
| HTTP Res. Code | (Front-End HTTP Response Code) Filter the displayed transactions by the HTTP response code that the APIC sent back to the client. |
| Client ID | Filter the displayed transactions by the ID of the client that activated the API call. Client IDs are generated by the API Management server during client registration. |
| Client IP | Filter the displayed transactions by the client IP address or load balancer address of the consumer that made 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 until. |
| Elapsed Time | Filter the displayed transactions by the elapsed time that the API transaction took till a response was returned to the client (in ms). |
| Request Size | Filter the displayed transactions by the size of the request (in bytes). |
| Response Size | Filter the displayed transactions by the size of the response (in bytes). |
| 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. |
| Error Message | Filter the display to only show transactions that failed, where the error message contains the term typed in the input box for this filter. |
| Policy Name | Filter the displayed transactions by the policy name of the element in API diagram/assembly. |
| Gateway Type | Filter the displayed transactions by the gateway type - DataPower Gateway (API Connect v5 and compatibility mode) or DataPower API Gateway (API Connect v6 and up) |
| Payload | Filter the displayed transactions by the payload that was sent/received as part of the API call. Enter *Â for any payload. Only available if API-C Analytics data is collected via Payload Capture. |
| Header Name | Filter the displayed transactions by the header name that was sent/received as part of the API call. Only available if API-C Analytics data is collected via Payload Capture. |
| Header Value | Filter the displayed transactions by the header value that was sent/received as part of the API call. Only available if API-C Analytics data is collected via Payload Capture. |