IBM DataPower Operations Dashboard v1.0.7.1

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 NameFunctionality
Application DataVisible on the 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

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:
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 Extended Transactions page.

Valid values: Correlation ids of extended transactions.

Device

Only show information related to the selected device(s).

Valid values:

  • Every device the user has permission to access through DPOD;
  • Enter a comma-separated list of device names in the input box to display multiple devices.
Domain

Only show information related to the selected domain(s).

Valid values:

  • Every domain the user has permission to access through DPOD;
  • Enter a comma-separated list of domain names in the input box to display multiple domains
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 multiple fields at once (depends on the dashboard)
Starting to type in the filter will highlight all the filters that will be searched, 
For example, in the transactions dashboard, the Device, Domain, Service, TX ID and Client IP will be searched.
All values are case sensitive, except for the raw messages' message content, where you can enter text in any case.

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 Service URI Calls only.
The URI that clients use to invoke transactions.
In URLVisible on Extended Transactions and Service URL Calls dash board 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 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. 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 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)
  • 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 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
term typed in the input box for this filter.

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.

IBM DataPower Operations Dashboard (DPOD) v1.0.7.1