Examples of recording additional information

This section contains two examples of how a user application can record additional information when performing an activity on behalf of a trace-route message. In both examples, the WebSphere MQ display route application is used to generate a trace-route message, and display the activity information returned to it.

  1. In Example 1, additional activity information is recorded by a user application in a format where the parameter identifier is not recognized by the WebSphere MQ display route application.

  2. In Example 2, additional activity information is recorded by a user application in a format where the parameter identifier is recognized by the WebSphere MQ display route application.

 

Example 1

  1. The WebSphere MQ display route application is used to generate and put a trace-route message into a queue manager network. The necessary options are set to request the following:

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

    • On arrival at the target queue the trace-route message is discarded, and a trace-route reply message is generated and delivered to a specified reply-to queue.

    • On receipt of the trace-route reply message, the WebSphere MQ display route application displays the accumulated activity information.

    The trace-route message is put into the queue manager network.

  2. As the trace-route message is routed through the queue manager network a user application, that is enabled for trace-route messaging, performs a low detail activity on behalf of the message. In addition to writing the standard activity information to the trace-route message, the user application writes the following PCF parameter to the end of the Activity group:

    ColorValue

    Identifier: 65536.
    Datatype: MQCFST.
    Value: 'Red'
    This additional PCF parameter gives further information about the activity that was performed, however it is written in a format where the parameter identifier will not be recognized by the WebSphere MQ display route application.

  3. The trace-route messages reaches the target queue and a trace-route reply message is returned to the WebSphere MQ display route application. The additional activity information is displayed as follows: 

    65536: 'Red'
    The WebSphere MQ display route application does not recognize the parameter identifier of the PCF parameter and displays it as a numerical value. The context of the additional information is not clear.

    For an example of when the WebSphere MQ display route application does recognize the parameter identifier of the PCF parameter, see Example 2.

 

Example 2

  1. The WebSphere MQ display route application is used to generate and put a trace-route message into a queue manager network in the same fashion as in Example 1.

  2. As the trace-route message is routed through the queue manager network a user application, that is enabled for trace-route messaging, performs a low detail activity on behalf of the message. In addition to writing the standard activity information to the trace-route message, the user application writes the following PCF parameters to the end of the Activity group:

    ColorInfo

    Description: Grouped parameters specifying information about a color.
    Identifier: MQGACF_VALUE_NAMING.
    Datatype: MQCFGR.
    Parameters in group:

    • ColorName

    • ColorValue

    ColorName

    Description: Contains the name to be displayed by the WebSphere MQ display route application which puts the value of ColorValue into context.
    Identifier: MQCA_VALUE_NAME.
    Datatype: MQCFST.
    Included in PCF group: ColorInfo.
    Value: 'Color'

    ColorValue

    Description: Contains the value to be displayed by the WebSphere MQ display route application.
    Identifier: 65536.
    Datatype: MQCFST.
    Included in PCF group: ColorInfo.
    Value: 'Red'
    These additional PCF parameters gives further information about the activity that was performed. These PCF parameters are written in a format where the parameter identifier will be recognized by the WebSphere MQ display route application.

  3. The trace-route messages reaches the target queue and a trace-route reply message is returned to the WebSphere MQ display route application. The additional activity information is displayed as follows: 

    Color: 'Red'
    The WebSphere MQ display route application recognizes that the parameter identifier of the PCF structure containing the value of the additional activity information has a corresponding name. The corresponding name is displayed instead of the numerical value.