IBM DataPower Operations Dashboard v1.0.13.0

A newer version of this product documentation is available.

You are viewing an older version. View latest at IBM DPOD Documentation.

Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 33 Next »

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 NameFunctionality
Application DataVisible on the Deprecated Extended Transactions screen only, it is used to search user data.
The use of this filter requires XSLT modification

B2B Message ID
B2B From Partner ID
B2B To Partner ID
B2B From Partner Profile
B2B To Partner Profile

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:
The filter's list is pre-populated with some built-in values.
Users may enter their own values as free text 

CauseVisible in the Restarts dashboard only.
The restart cause (device initiated, user initiated, etc.)
Catalog NameAPI Connect dashboards only.

Client IP

Only show messages and transactions originating on one or more client IPs.
The client IP may be either the origin of the message or the load balancer.

Valid values: Valid IP Addresses

Corr. Id

Only show information related to one or more correlation ids.
This filter only applies to the Deprecated Extended Transactions page.

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).

Asterisk wildcard is supported. e.g. "Prod*" will match all domains that starts with "Prod".

Downtime StartedVisible 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 in multiple fields at once (depends on the page where the filter exists).
Starting to type in the filter will highlight (using a shadow) all other filters that will be searched for the value entered in the Free Text filter.
For example, in DataPower Transactions, the Device, Domain, Service, Transaction ID and Client IP information will be searched for the value entered in the Free Text filter.
All values are case sensitive, except for the raw messages' message content (which is case insensitive).

Front-Side Handler

Only show services going through the specific Front-side handler(s).

Valid values:

  • Front Side Handlers in the system (Configuration Only)

Front URI

The URL the service exposes (Configuration Only)
Global Trans. IDThe Global Tansaction ID
In URIVisible on Extended Transactions and Service URI Calls only.
The URI that clients use to invoke transactions.
In URLVisible on Deprecated Extended Transactions and Service URL Calls only.
The URL that clients use to invoke transactions.
Message
Message CodeMessage 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 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

Min Response

Filter the displayed transactions by minimum 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. NameObject Name as reported from a log target of a monitored device.
Normally contains service Name or front side handler
Obj. TypeObject Type as reported from a log target of a monitored device.
OperationService 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.

PayloadWS-M payload recorded on monitored devices.
Service

Only include transactions on the selected service(s).
Enter either a single service name or multiple names as a comma-separated list. 

Valid values: Any service name(s) in the system

The available values list will change according to the context:
In the Investigate section - Raw  Messages, Transactions or Extended Transactions pages, the list of values will only show services that actually run on the monitroed devices.
In the Explore section - Service Configuration and DevOps services portal, the list of values will show all the services on the monitroed devices, even if they never executed.
You may, enter any value into the filter, even if it doesn't appear in the list of available values.

Service TypeMulti Protocol or Web Service Proxy (Configuration Only)
SeveritySeverity as reported from a log target of a monitored device.
Status

Only include transactions with the selected status(es).

Valid values:

  • OK
  • ERROR
  • IN PROCESS
Time

Filter display by time interval.

Valid values:

  • Last 5 minutes
  • Last 10 Minutes
  • Last 15 Minutes
  • Last 30 Minutes
  • Last Hour
  • Last 24 Hours
  • Last 7 Days
  • Last 30 Days

  • Today (Since midnight)
  • This Week (Since midnight on Monday)
  • This Month (Since midnight on the first day of the month)
  • Yesterday (24 hours ending at midnight of previous day)
  • Last Week (7 days ending at midnight of previous day)
  • Last Month (Midnight 1st of previous month to Midnight 1st of current month)

  • User-defined Interval
Trans. Direction

Filter display by the transaction’s direction.

Valid values:

  • Request
  • Response
  • Error
Trans. ID

Filter display by the id(s) of one or more transactions.

Valid values: Transaction ids

Additional Filters in APIC View

Filter NameFunctionality
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.
ProductFilter 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.
App NameFilter 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.
In URL 

Filter the displayed transactions by the URL that was activated by the client.

In URIFilter the displayed transactions by the URI that was activated by the client.
FE 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.
BE HTTP Res. Code (Back-End HTTP Response Code) Filter the displayed transactions by the HTTP response code that the APIC received from the back-end.
Consumer Org NameFilter the displayed transactions by the consumer organization name that the client who activated the API call belongs to.
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 IPFilter 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.
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 transaction 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 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 NameFilter the displayed transactions by the policy name of the element in API diagram/assembly.
Gateway TypeFilter the displayed transactions by the gateway type - DataPower Gateway (API Connect v5 and compatibility mode) or DataPower API Gateway (API Connect v6 and up)
  • No labels