Trace-route message data

Trace-route message data

The content of trace-route message data depends on the Accumulate parameter from the TraceRoute PCF group, see Trace-route message data format. Trace-route message data consists of the TraceRoute PCF group, and zero or more Activity PCF groups. The TraceRoute PCF group is detailed below. For details of the Activity PCF group, see Activity report message data and Operation-specific activity report message data.
Trace-route message data contains the following parameters:

TraceRoute

Description: Grouped parameters specifying attributes of the trace-route message. For a trace-route message, some of these parameters can be altered to control how it is processed.
Identifier: MQGACF_TRACE_ROUTE.
Datatype: MQCFGR.
Contained in PCF group: None.
Parameters in group:

Detail
RecordedActivities
UnrecordedActivities
DiscontinuityCount
MaxActivities
Accumulate
Forward
Deliver

Detail

Description: The detail level that will be recorded for the activity.
Identifier: MQIACF_ROUTE_DETAIL.
Datatype: MQCFIN.
Contained in PCF group: TraceRoute.
Values:

MQROUTE_DETAIL_LOW

Activities performed by user-written application are recorded.

MQROUTE_DETAIL_MEDIUM

Activities specified in MQROUTE_DETAIL_LOW are recorded. Additionally, activities performed by MCAs are recorded.

MQROUTE_DETAIL_HIGH

Activities specified in MQROUTE_DETAIL_LOW, and MQROUTE_DETAIL_MEDIUM are recorded. MCAs do not record any further activity information at this level of detail. This option is only available to user-written applications that are to record further activity information.

RecordedActivities

Description: The number of activities that the trace-route message has caused, where information was recorded.
Identifier: MQIACF_RECORDED_ACTIVITIES.
Datatype: MQCFIN.
Contained in PCF group: TraceRoute.

UnrecordedActivities

Description: The number of activities that the trace-route message has caused, where information was not recorded.
Identifier: MQIACF_UNRECORDED_ACTIVITIES.
Datatype: MQCFIN.
Contained in PCF group: TraceRoute.

DiscontinuityCount

Description: The number of times a trace-route message has been received from a queue manager that does not support trace-route messaging.
Identifier: MQIACF_DISCONTINUITY_COUNT.
Datatype: MQCFIN.
Contained in PCF group: TraceRoute.

MaxActivities

Description: The maximum number of activities the trace-route message can be involved in before it stops being processed.
Identifier: MQIACF_MAX_ACTIVITIES.
Datatype: MQCFIN.
Contained in PCF group: TraceRoute.
Value:

A positive integer

The maximum number of activities.

MQROUTE_UNLIMITED_ACTIVITIES

An unlimited number of activities.

Accumulate

Description: Specifies whether activity information is accumulated within the trace-route message, and whether a reply message containing the accumulated activity information is generated before the trace-route message is discarded or is put on a non-transmission queue.
Identifier: MQIACF_ROUTE_ACCUMULATION.
Datatype: MQCFIN.
Contained in PCF group: TraceRoute.
Value:

MQROUTE_ACCUMULATE_NONE

Activity information is not accumulated in the message data of the trace-route message.

MQROUTE_ACCUMULATE_IN_MSG

Activity information is accumulated in the message data of the trace-route message.

MQROUTE_ACCUMULATE_AND_REPLY

Activity information is accumulated in the message data of the trace-route message, and a trace-route reply message will be generated.

Forward

Description: Specifies queue managers that the trace-route message can be forwarded to. Queue managers use an algorithm when determining whether to forward a message to a remote queue manager. For details of this algorithm, see Forwarding.
Identifier: MQIACF_ROUTE_FORWARDING.
Datatype: MQCFIN.
Contained in PCF group: TraceRoute.
Value:

MQROUTE_FORWARD_IF_SUPPORTED

The trace-route message is only forwarded to queue managers that will honor the value of the Deliver parameter from the TraceRoute group.

MQROUTE_FORWARD_ALL

The trace-route message is forwarded to any queue manager, regardless of whether the value of the Deliver parameter will be honored.

Deliver

Description: Specifies the action to be taken if the trace-route message arrives at the destination queue successfully.
Identifier: MQIACF_ROUTE_DELIVERY.
Datatype: MQCFIN.
Contained in PCF group: TraceRoute.
Value:

MQROUTE_DELIVER_YES

On arrival, the trace-route message is put on the target queue. Any application performing a destructive get on the target queue can receive the trace-route message.

MQROUTE_DELIVER_NO

On arrival, the trace-route message is discarded.

For details of the Activity PCF group, see Activity report message data and Operation-specific activity report message data.

Description:	Grouped parameters specifying attributes of the trace-route message. For a trace-route message, some of these parameters can be altered to control how it is processed.
Identifier:	MQGACF_TRACE_ROUTE.
Datatype:	MQCFGR.
Contained in PCF group:	None.
Parameters in group:	Detail RecordedActivities UnrecordedActivities DiscontinuityCount MaxActivities Accumulate Forward Deliver

Description:	The detail level that will be recorded for the activity.
Identifier:	MQIACF_ROUTE_DETAIL.
Datatype:	MQCFIN.
Contained in PCF group:	TraceRoute.
Values:	MQROUTE_DETAIL_LOW Activities performed by user-written application are recorded. MQROUTE_DETAIL_MEDIUM Activities specified in MQROUTE_DETAIL_LOW are recorded. Additionally, activities performed by MCAs are recorded. MQROUTE_DETAIL_HIGH Activities specified in MQROUTE_DETAIL_LOW, and MQROUTE_DETAIL_MEDIUM are recorded. MCAs do not record any further activity information at this level of detail. This option is only available to user-written applications that are to record further activity information.

Description:	The number of activities that the trace-route message has caused, where information was recorded.
Identifier:	MQIACF_RECORDED_ACTIVITIES.
Datatype:	MQCFIN.
Contained in PCF group:	TraceRoute.

Description:	The number of times a trace-route message has been received from a queue manager that does not support trace-route messaging.
Identifier:	MQIACF_DISCONTINUITY_COUNT.
Datatype:	MQCFIN.
Contained in PCF group:	TraceRoute.

Description:	The maximum number of activities the trace-route message can be involved in before it stops being processed.
Identifier:	MQIACF_MAX_ACTIVITIES.
Datatype:	MQCFIN.
Contained in PCF group:	TraceRoute.
Value:	A positive integer The maximum number of activities. MQROUTE_UNLIMITED_ACTIVITIES An unlimited number of activities.

Description:	Specifies whether activity information is accumulated within the trace-route message, and whether a reply message containing the accumulated activity information is generated before the trace-route message is discarded or is put on a non-transmission queue.
Identifier:	MQIACF_ROUTE_ACCUMULATION.
Datatype:	MQCFIN.
Contained in PCF group:	TraceRoute.
Value:	MQROUTE_ACCUMULATE_NONE Activity information is not accumulated in the message data of the trace-route message. MQROUTE_ACCUMULATE_IN_MSG Activity information is accumulated in the message data of the trace-route message. MQROUTE_ACCUMULATE_AND_REPLY Activity information is accumulated in the message data of the trace-route message, and a trace-route reply message will be generated.

Description:	Specifies queue managers that the trace-route message can be forwarded to. Queue managers use an algorithm when determining whether to forward a message to a remote queue manager. For details of this algorithm, see Forwarding.
Identifier:	MQIACF_ROUTE_FORWARDING.
Datatype:	MQCFIN.
Contained in PCF group:	TraceRoute.
Value:	MQROUTE_FORWARD_IF_SUPPORTED The trace-route message is only forwarded to queue managers that will honor the value of the Deliver parameter from the TraceRoute group. MQROUTE_FORWARD_ALL The trace-route message is forwarded to any queue manager, regardless of whether the value of the Deliver parameter will be honored.

Description:	Specifies the action to be taken if the trace-route message arrives at the destination queue successfully.
Identifier:	MQIACF_ROUTE_DELIVERY.
Datatype:	MQCFIN.
Contained in PCF group:	TraceRoute.
Value:	MQROUTE_DELIVER_YES On arrival, the trace-route message is put on the target queue. Any application performing a destructive get on the target queue can receive the trace-route message. MQROUTE_DELIVER_NO On arrival, the trace-route message is discarded.