Versions Compared

Version Old Version 47 New Version 48
Changes made by

Amit Munwes

Amit Munwes

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.

Filters in IDG View

Filter Name

Relevant to

Functionality

Added By

Only show information related to the selected added by('s).

Gateways

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

  • User

    • 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

    Raw Messages of B2B transactions

    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:

    Raw Messages

    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 Name

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

    Cloud Agent

    Only show information related to the selected cloud agent(s). (FFU)

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

    Form Factor

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

    • Physical

    • Virtual

    • Container

    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

    Available since IDG firmware 7.6.0.8 and 7.7.1.2 for

    transactions

    transactions of traditional IDG services

    Response Size

    Filter the displayed transactions by response size (in bytes).

    Valid values: Non-negative integers

    Available since

    Available since IDG firmware 7.6.0.8 and 7.7.1.2 for

    transactions

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

    • OK

    • ERROR

    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

    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.

    Rate Limit Name

    Filter the displayed transactions by the rate limit name was sent/received as part of 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.