Display of activity information

The IBM® MQ display route application can display activity information for a trace-route message that it has just put into a queue manager network, or it can display activity information for a previously generated trace-route message. It can also display additional information recorded by user-written applications.

To specify whether activity information returned for a trace-route message is displayed, specify the following parameter:

-n

Specifies that activity information returned for the trace-route message is not to be displayed.

If this parameter is accompanied by a request for a trace-route reply message, ( -ar ), or any of the report generating options from ( -ro ReportOption ), then a specific (non-model) reply-to queue must be specified using -rq ReplyToQ . By default, only activity report messages are requested.

After the trace-route message is put to the specified target queue, a 48 character hexadecimal string is displayed containing the message identifier of the trace-route message. The message identifier can be used by the IBM MQ display route application to display the activity information for the trace-route message at a later time, using the -i CorrelId parameter.

If you do not specify this parameter, activity information returned for the trace-route message is displayed in the form specified by the -v parameter.

When displaying activity information for a trace-route message that has just been put into a queue manager network, the following parameter can be specified:

-w WaitTime: Specifies the time, in seconds, that the IBM MQ display route application will wait for activity reports, or a trace-route reply message, to return to the specified reply-to queue.
If you do not specify this parameter, the wait time is specified as the expiry time of the trace-route message, plus 60 seconds.

When displaying previously accumulated activity information the following parameters must be set:

-q TargetQName: If the IBM MQ display route application is being used to view previously gathered activity information, TargetQName specifies the name of the queue where the activity information is stored.
-i CorrelId: This parameter is used when the IBM MQ display route application is used to display previously accumulated activity information only. There can be many activity reports and trace-route reply messages on the queue specified by -q TargetQName. CorrelId is used to identify the activity reports, or a trace-route reply message, related to a trace-route message. Specify the message identifier of the original trace-route message in CorrelId.
The format of CorrelId is a 48 character hexadecimal string.

The following parameters can be used when displaying previously accumulated activity information, or when displaying current activity information for a trace-route message:

-b

Specifies that the IBM MQ display route application will only browse activity reports or a trace-route reply message related to a message. This allows activity information to be displayed again at a later time.

If you do not specify this parameter, the IBM MQ display route application will destructively get activity reports or a trace-route reply message related to a message.

-v summary | all | none | outline DisplayOption

summary

The queues that the trace-route message was routed through are displayed.

all

All available information is displayed.

none

No information is displayed.

outline DisplayOption

Specifies display options for the trace-route message. Multiple display options can be specified using a comma as a separator.

If no values are supplied the following is displayed:

The application name
The type of each operation
Any operation specific parameters

Possible values for DisplayOption are:

activity: All non-PCF group parameters in Activity PCF groups are displayed.
identifiers: Values with parameter identifiers MQBACF_MSG_ID or MQBACF_CORREL_ID are displayed. This overrides msgdelta.
message: All non-PCF group parameters in Message PCF groups are displayed. When this value is specified, you cannot specify msgdelta.
msgdelta: All non-PCF group parameters in Message PCF groups, that have changed since the last operation, are displayed. When this value is specified, you cannot specify message.
operation: All non-PCF group parameters in Operation PCF groups are displayed.
traceroute: All non-PCF group parameters in TraceRoute PCF groups are displayed.

If you do not specify this parameter, a summary of the message route is displayed.

Display of additional information

As a trace-route message is routed through a queue manager network, user-written applications can record additional information by writing one or more additional PCF parameters to the message data of the trace-route message or to the message data of an activity report. For the IBM MQ display route application to display additional information in a readable form it must be recorded in a specific format, as described in Additional activity information.