Versions Compared

Version Old Version 25 New Version Current
Changes made by

Assaf Cohen (Deactivated)

Sara Weisz

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

The following table lists the available filters within in DPOD.
Most sections of DPOD display only a subset of this list, as applicable to the data displayed in the different sections.

...

Filter Name

Functionality

Application DataVisible on the Deprecated Extended Transactions screen only, it is used to search user data.
The use of this filter requires XSLT modification

Added By

The method in which the gateways were added to DPOD - manually by the user or automatically discovered by a Cloud Agent (FFU).

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

The value of 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 message category.
The filter's list is pre-populated with some built-in values.


Users may enter their own values as free text 

Cause

Visible 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

Cloud Agent

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.

to the selected cloud agent(s).

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

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

Form Factor

Only show information related to the selected form factor(s).

  • Physical

  • Virtual

  • Container

Global Trans. ID

The Global Tansaction ID

In

URI

Visible on Extended Transactions and Service URI Calls only.
The URI that clients use to invoke transactions.

In

URL

Visible on

Deprecated Extended Transactions and

Service URL Calls only.
The URL that clients use to invoke transactions.

Message

Filter the display to only show transactions where the message contains the
term typed in the input box for this filter.

Message Code

Message code as reported from a log target of a monitored device.

Min

Elapsed Time

Filter the displayed transactions by

minimum

elapsed time (in ms).

Valid values: Non-negative integers

Min

Request Size

Filter the displayed transactions by

minimum

request

time

size (in

ms

bytes).

Valid values: Non-negative integers

Min Response

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

minimum

response

time

size (in

ms

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

DataPower configuration Object Name

as reported from a log target of a monitored device

.


Normally contains service Name or front side handler

Obj. Type

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

Logs, Transactions or Extended Transactions pages, the list of values will only show services that actually run on the

monitroed

monitored devices.
In the Explore section - Service Configuration and DevOps services portal, the list of values will show all the services on the

monitroed

monitored 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 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:

  • 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

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

    • 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 Name

    Functionality

    Provider Org Name

    API 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

    API

    catalog that was

    activated

    used during the API call.

    API Version 

    Space 

    Filter the displayed transactions by the

    version

    name of the

    API

    space that was

    activated

    used during the API call.

    Back-End HTTP Response Code 

    Product

    Filter the displayed transactions

    by the HTTP Response Code that the APIC recieved from the backend.Catalog Name 

    by the product name that was consumed by the API call. 

    Plan 

    Filter the displayed transactions by the name of the

    Catalog

    plan that was used during the API call.

    Client ID 

    API Name 

    Filter the displayed transactions by the

    ID

    name of the

    client

    API that was activated

    the API call. 
    Client IDs are generated by the API Management Server during client registration

    .

    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 the client who activated the API call belongs to.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.Front-End HTTP Response Code 

    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

    response code that the APIC sent back to the client.

    HTTP Method 

    Client ID 

    Filter the displayed transactions by the ID of the

    HTTP Method that was used in

    client that activated the API call

    HTTP requestOperation ID 

    . 
    Client IDs are generated by the API Management server during client registration.

    Client IP

    Filter the displayed transactions by the

    ID

    client IP address or load balancer address of the

    operation

    consumer that

    was activated during

    made the API call.

     

    OAuth Scope 

    Filter the displayed transactions by the

    Scope

    scope of the OAuth

    Token

    token that was delivered by the client in the API call.

    OAuth Resource Owner 

    Filter the displayed transactions by the

    Resource Owner

    resource owner of the OAuth

    Token

    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

    token is valid from.

    OAuth Token Valid Until 

    Filter the displayed transactions by the time that the OAuth

    Token

    token is valid

    to

    until.

    Plan ID 

    Elapsed Time

    Filter the displayed transactions

    by the ID of the Plan that was used during the API call. Plan Name 

    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 name of the Plan that was used during the API call.Product Name

    by the size of the request (in bytes).

    Response Size 

    Filter the displayed transactions by the

    product name that was consumed by the API call. 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 

    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

    minimum time it took to wait for the backend server to reply (in ms).Min. Total Latency 

    policy name of the element in API diagram/assembly.

    Gateway Type

    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 

    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 minimum size of the request.Min Response Size 

    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

    minimum size of the response.Path URL 

    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

    URL

    header value that was

    activated by the client.Space Name 

    sent/received as part of the API call. Only available if API-C Analytics data is collected via Payload Capture.

    Rate Limit Name

    Filter the displayed transactions by the rate limit name was sent/received as part of

    the Space that was used during the API call

    the API call. Only available if API-C Analytics data is collected via Payload Capture.

    Rate Limit Utilization %

    Filter the displayed transactions by the rate limit utilization percentage that was sent/received as part of the API call. Only available if API-C Analytics data is collected via Payload Capture.

    Capture ID

    Filter the displayed transactions by the capture ID of the API probe capture.