Output (-o)

The -o parameter allows you to query a more specific output using one of the different metrics. For example, you can query data for metrics like process, version, user information, database information, etc.

When querying data for a metric, all data for that metric is retrieved. However, you can add filters to your query such that data for only a particular process, or instance, or queue is retrieved.

The following table lists metrics and filters which you can use to query data and syntax examples for each metric and filter:

Output Parameter Metrics

Metric

Description

Applicable for Frequency

PROCESS

Allows you to query data specific to one or multiple processes. The following is an example to query data for all processes:

swadm METRICS -m -o PROCESS

Name Filter

The following is an example to query data for a single process:

swadm METRICS -m -o PROCESS{"NAME=WIS"}

The following is a sample output for this command:

To query data for more than one process, separate the processes by an OR operator (|). For example:

swadm METRICS -m -o PROCESS{"NAME=WIS|BG"}

The following is a sample output for this command:

Instance Filter

You can also specify a particular instance of a process in your query. For example:

swadm METRICS -m -o PROCESS{"NAME=BG,INSTANCE=2"}

The following is a sample output for this command:

All

MESSAGE

Allows you to query data specific to messages in one or multiple queues. The following is an example to query data for all messages:

swadm METRICS -d -o MESSAGE

Queue Filter

You can also query data from a specific queue by defining the queue name. For example:

swadm METRICS -d -o MESSAGE{"NAME=BGMBOX1"}

The following is a sample output for this command:

All

USERINFO1

Allows you to query data for iProcess Engine users. The following is an example syntax of this command:

swadm METRICS -h -o USERINFO

The following is a sample output for this command:

All

EVENT1

Allows you to query data specific to events. The following is an example syntax of this command:

swadm METRICS -h -o EVENT

The following is a sample output for this command:

Hourly

PROCINFO1

Allows you to query procedure information. The following is an example syntax of this command:

swadm METRICS -d -o PROCINFO

The following is a sample output for this command:

Daily

PROCVERS1

Allows you to query information specific to procedure versions. The following is an example syntax of this command:

swadm METRICS -d -o PROCVERS

The following is a sample output for this command:

Daily

CASEINFO1

Allows you to query data specific to cases. The following is an example syntax of this command:

swadm METRICS -h -o CASEINFO

The following is a sample output for this command:

Daily and hourly

WISINFO1

Allows you to query data for the Work Item Server like the number of queues, items, queue name, etc. The following is an example syntax of this command:

swadm METRICS -m -o WISINFO

The following is a sample output for this command:

Hourly and per minute

DBINFO1

Allows you to query information about the database server. The following is an example syntax of this command:

swadm METRICS -d -o DBINFO

The following is a sample output for this command:

Daily and hourly

VERSION1

Allows you to query version information for iProcess Engine. The following is an example syntax of this command:

swadm METRICS -m -o VERSION

The following is a sample output for this command:

Daily