Activity report message data
Use this page to view the parameters contained by the Activity PCF group in an activity report message. Some parameters are returned only when specific operations have been performed.
Activity report message data consists of the Activity PCF group and, if generated for a trace-route message, the TraceRoute PCF group. The Activity PCF group is detailed in this topic.
Some parameters, which are described as Operation-specific activity report message data, are returned only when specific operations have been performed.
For an activity report, the activity report message data contains the following parameters:
- Activity
-
Description: |
Grouped parameters describing the activity. |
Identifier: |
MQGACF_ACTIVITY. |
Data type: |
MQCFGR. |
Included in PCF group: |
None. |
Parameters in PCF group: |
- ActivityApplName
- ActivityApplType
- ActivityDescription
- Operation
- TraceRoute
|
Returned: |
Always. |
- ActivityApplName
-
Description: |
Name of application that performed the activity. |
Identifier: |
MQCACF_APPL_NAME. |
Data type: |
MQCFST. |
Included in PCF group: |
Activity. |
Maximum length: |
MQ_APPL_NAME_LENGTH. |
Returned: |
Always. |
- ActivityApplType
-
Description: |
Type of application that performed the activity. |
Identifier: |
MQIA_APPL_TYPE. |
Data type: |
MQCFIN. |
Included in PCF group: |
Activity. |
Returned: |
Always. |
- ActivityDescription
-
Description: |
Description of activity performed by the application. |
Identifier: |
MQCACF_ACTIVITY_DESCRIPTION. |
Data type: |
MQCFST. |
Included in PCF group: |
Activity. |
Maximum length: |
64 |
Returned: |
Always. |
- Operation
-
Description: |
Grouped parameters describing an operation of the activity. |
Identifier: |
MQGACF_OPERATION. |
Data type: |
MQCFGR. |
Included in PCF group: |
Activity. |
Parameters in PCF group: |
- OperationType
- OperationDate
- OperationTime
- Message
- QMgrName
- QSGName
Note: Additional parameters are returned in this group depending on the operation type. These additional parameters are described as Operation-specific activity report message data.
|
Returned: |
One Operation PCF group per operation in the activity. |
- OperationType
-
Description: |
Type of operation performed. |
Identifier: |
MQIACF_OPERATION_TYPE. |
Data type: |
MQCFIN. |
Included in PCF group: |
Operation. |
Values: |
MQOPER_*. |
Returned: |
Always. |
- OperationDate
-
Description: |
Date when the operation was performed. |
Identifier: |
MQCACF_OPERATION_DATE. |
Data type: |
MQCFST. |
Included in PCF group: |
Operation. |
Maximum length: |
MQ_DATE_LENGTH. |
Returned: |
Always. |
- OperationTime
-
Description: |
Time when the operation was performed. |
Identifier: |
MQCACF_OPERATION_TIME. |
Data type: |
MQCFST. |
Included in PCF group: |
Operation. |
Maximum length: |
MQ_TIME_LENGTH. |
Returned: |
Always. |
- Message
-
Description: |
Grouped parameters describing the message that caused the activity. |
Identifier: |
MQGACF_MESSAGE. |
Data type: |
MQCFGR. |
Included in PCF group: |
Operation. |
Parameters in group: |
- MsgLength
- MQMD
- EmbeddedMQMD
|
Returned: |
Always, except for Excluded Publish operations. |
- MsgLength
-
Description: |
Length of the message that caused the activity, before the activity occurred. |
Identifier: |
MQIACF_MSG_LENGTH. |
Data type: |
MQCFIN. |
Included in PCF group: |
Message. |
Returned: |
Always. |
- MQMD
-
Description: |
Grouped parameters related to the message descriptor of the message that caused the activity. |
Identifier: |
MQGACF_MQMD. |
Data type: |
MQCFGR. |
Included in PCF group: |
Message. |
Parameters in group: |
- StrucId
- Version
- Report
- MsgType
- Expiry
- Feedback
- Encoding
- CodedCharSetId
- Format
- Priority
- Persistence
- MsgId
- CorrelId
- BackoutCount
- ReplyToQ
- ReplyToQMgr
- UserIdentifier
- AccountingToken
- ApplIdentityData
- PutApplType
- PutApplName
- PutDate
- PutTime
- ApplOriginData
- GroupId
- MsgSeqNumber
- Offset
- MsgFlags
- OriginalLength
|
Returned: |
Always, except for Excluded Publish operations. |
- EmbeddedMQMD
-
Description: |
Grouped parameters describing the message descriptor embedded within a message on a transmission queue. |
Identifier: |
MQGACF_EMBEDDDED_MQMD. |
Data type: |
MQCFGR. |
Included in PCF group: |
Message. |
Parameters in group: |
- StrucId
- Version
- Report
- MsgType
- Expiry
- Feedback
- Encoding
- CodedCharSetId
- Format
- Priority
- Persistence
- MsgId
- CorrelId
- BackoutCount
- ReplyToQ
- ReplyToQMgr
- UserIdentifier
- AccountingToken
- ApplIdentityData
- PutApplType
- PutApplName
- PutDate
- PutTime
- ApplOriginData
- GroupId
- MsgSeqNumber
- Offset
- MsgFlags
- OriginalLength
|
Returned: |
For Get operations where the queue resolves to a transmission queue. |
- StrucId
-
Description: |
Structure identifier |
Identifier: |
MQCACF_STRUC_ID. |
Data type: |
MQCFST. |
Included in PCF group: |
MQMD or EmbeddedMQMD. |
Maximum length: |
4. |
Returned: |
Always, except for Excluded Publish operations and in MQMD for Publish and Discarded Publish operations. |
- Version
-
Description: |
Structure version number. |
Identifier: |
MQIACF_VERSION. |
Data type: |
MQCFIN. |
Included in PCF group: |
MQMD or EmbeddedMQMD. |
Returned: |
Always, except for Excluded Publish operations and in MQMD for Publish and Discarded Publish operations. |
- Report
-
Description: |
Options for report messages. |
Identifier: |
MQIACF_REPORT. |
Data type: |
MQCFIN. |
Included in PCF group: |
MQMD or EmbeddedMQMD. |
Returned: |
Always, except for Excluded Publish operations and in MQMD for Publish and Discarded Publish operations. |
- MsgType
-
Description: |
Indicates type of message. |
Identifier: |
MQIACF_MSG_TYPE. |
Data type: |
MQCFIN. |
Included in PCF group: |
MQMD or EmbeddedMQMD. |
Returned: |
Always, except for Excluded Publish operations and in MQMD for Publish and Discarded Publish operations. |
- Expiry
-
Description: |
Message lifetime. |
Identifier: |
MQIACF_EXPIRY. |
Data type: |
MQCFIN. |
Included in PCF group: |
MQMD or EmbeddedMQMD. |
Returned: |
Always, except for Excluded Publish operations and in MQMD for Publish and Discarded Publish operations. |
- Feedback
-
Description: |
Feedback or reason code. |
Identifier: |
MQIACF_FEEDBACK. |
Data type: |
MQCFIN. |
Included in PCF group: |
MQMD or EmbeddedMQMD. |
Returned: |
Always, except for Excluded Publish operations and in MQMD for Publish and Discarded Publish operations. |
- Encoding
-
Description: |
Numeric encoding of message data. |
Identifier: |
MQIACF_ENCODING. |
Data type: |
MQCFIN. |
Included in PCF group: |
MQMD or EmbeddedMQMD. |
Returned: |
Always, except for Excluded Publish operations and in MQMD for Publish and Discarded Publish operations. |
- CodedCharSetId
-
Description: |
Character set identifier of message data. |
Identifier: |
MQIA_CODED_CHAR_SET_ID. |
Data type: |
MQCFIN. |
Included in PCF group: |
MQMD or EmbeddedMQMD. |
Returned: |
Always, except for Excluded Publish operations and in MQMD for Publish and Discarded Publish operations. |
- Format
-
Description: |
Format name of message data |
Identifier: |
MQCACH_FORMAT_NAME. |
Data type: |
MQCFST. |
Included in PCF group: |
MQMD or EmbeddedMQMD. |
Maximum length: |
MQ_FORMAT_LENGTH. |
Returned: |
Always, except for Excluded Publish operations. |
- Priority
-
Description: |
Message priority. |
Identifier: |
MQIACF_PRIORITY. |
Data type: |
MQCFIN. |
Included in PCF group: |
MQMD or EmbeddedMQMD. |
Returned: |
Always, except for Excluded Publish operations. |
- Persistence
-
Description: |
Message persistence. |
Identifier: |
MQIACF_PERSISTENCE. |
Data type: |
MQCFIN. |
Included in PCF group: |
MQMD or EmbeddedMQMD. |
Returned: |
Always, except for Excluded Publish operations. |
- MsgId
-
Description: |
Message identifier. |
Identifier: |
MQBACF_MSG_ID. |
Data type: |
MQCFBS. |
Included in PCF group: |
MQMD or EmbeddedMQMD. |
Maximum length: |
MQ_MSG_ID_LENGTH. |
Returned: |
Always, except for Excluded Publish operations. |
- CorrelId
-
Description: |
Correlation identifier. |
Identifier: |
MQBACF_CORREL_ID. |
Data type: |
MQCFBS. |
Included in PCF group: |
MQMD or EmbeddedMQMD. |
Maximum length: |
MQ_CORREL_ID_LENGTH. |
Returned: |
Always, except for Excluded Publish operations. |
- BackoutCount
-
Description: |
Backout counter. |
Identifier: |
MQIACF_BACKOUT_COUNT. |
Data type: |
MQCFIN. |
Included in PCF group: |
MQMD or EmbeddedMQMD. |
Returned: |
Always, except for Excluded Publish operations and in MQMD for Publish and Discarded Publish operations. |
- ReplyToQ
-
Description: |
Name of reply queue. |
Identifier: |
MQCACF_REPLY_TO_QUEUE. |
Data type: |
MQCFST. |
Included in PCF group: |
MQMD or EmbeddedMQMD. |
Maximum length: |
MQ_Q_NAME_LENGTH. |
Returned: |
Always, except for Excluded Publish Operations and in MQMD for Publish and Discarded Publish operations. |
- ReplyToQMgr
-
Description: |
Name of reply queue manager. |
Identifier: |
MQCACF_REPLY_TO_Q_MGR. |
Data type: |
MQCFST. |
Included in PCF group: |
MQMD or EmbeddedMQMD. |
Maximum length: |
MQ_Q_MGR_NAME_LENGTH. |
Returned: |
Always, except for Excluded Publish Operations and in MQMD for Publish and Discarded Publish Operations. |
- UserIdentifier
-
Description: |
The user identifier of the application that originated the message. |
Identifier: |
MQCACF_USER_IDENTIFIER. |
Data type: |
MQCFST. |
Included in PCF group: |
MQMD or EmbeddedMQMD. |
Maximum length: |
MQ_USER_ID_LENGTH. |
Returned: |
Always, except for Excluded Publish Operations. |
- AccountingToken
-
Description: |
Accounting token that allows an application to charge for work done as a result of the message. |
Identifier: |
MQBACF_ACCOUNTING_TOKEN. |
Data type: |
MQCFBS. |
Included in PCF group: |
MQMD or EmbeddedMQMD. |
Maximum length: |
MQ_ACCOUNTING_TOKEN_LENGTH. |
Returned: |
Always, except for Excluded Publish Operations. |
- ApplIdentityData
-
Description: |
Application data relating to identity. |
Identifier: |
MQCACF_APPL_IDENTITY_DATA. |
Data type: |
MQCFST. |
Included in PCF group: |
MQMD or EmbeddedMQMD. |
Maximum length: |
MQ_APPL_IDENTITY_DATA_LENGTH. |
Returned: |
Always, except for Excluded Publish Operations. |
- PutApplType
-
Description: |
Type of application that put the message. |
Identifier: |
MQIA_APPL_TYPE. |
Data type: |
MQCFIN. |
Included in PCF group: |
MQMD or EmbeddedMQMD. |
Returned: |
Always, except for Excluded Publish Operations and in MQMD for Publish and Discarded Publish Operations. |
- PutApplName
-
Description: |
Name of application that put the message. |
Identifier: |
MQCACF_APPL_NAME. |
Data type: |
MQCFST. |
Included in PCF group: |
MQMD or EmbeddedMQMD. |
Maximum length: |
MQ_APPL_NAME_LENGTH. |
Returned: |
Always, except for Excluded Publish Operations and in MQMD for Publish and Discarded Publish Operations. |
- PutDate
-
Description: |
Date when message was put. |
Identifier: |
MQCACF_PUT_DATE. |
Data type: |
MQCFST. |
Included in PCF group: |
MQMD or EmbeddedMQMD. |
Maximum length: |
MQ_PUT_DATE_LENGTH. |
Returned: |
Always, except for Excluded Publish Operations and in MQMD for Publish and Discarded Publish Operations. |
- PutTime
-
Description: |
Time when message was put. |
Identifier: |
MQCACF_PUT_TIME. |
Data type: |
MQCFST. |
Included in PCF group: |
MQMD or EmbeddedMQMD. |
Maximum length: |
MQ_PUT_TIME_LENGTH. |
Returned: |
Always, except for Excluded Publish Operations and in MQMD for Publish and Discarded Publish Operations. |
- ApplOriginData
-
Description: |
Application data relating to origin. |
Identifier: |
MQCACF_APPL_ORIGIN_DATA. |
Data type: |
MQCFST. |
Included in PCF group: |
MQMD or EmbeddedMQMD. |
Maximum length: |
MQ_APPL_ORIGIN_DATA_LENGTH. |
Returned: |
Always, except for Excluded Publish Operations and in MQMD for Publish and Discarded Publish Operations. |
- GroupId
-
Description: |
Identifies to which message group or logical message the physical message belongs. |
Identifier: |
MQBACF_GROUP_ID. |
Data type: |
MQCFBS. |
Included in PCF group: |
MQMD or EmbeddedMQMD. |
Maximum length: |
MQ_GROUP_ID_LENGTH. |
Returned: |
If the Version is specified as MQMD_VERSION_2. Not returned in Excluded Publish Operations and in MQMD for Publish and Discarded Publish Operations. |
- MsgSeqNumber
-
Description: |
Sequence number of logical message within group. |
Identifier: |
MQIACH_MSG_SEQUENCE_NUMBER. |
Data type: |
MQCFIN. |
Included in PCF group: |
MQMD or EmbeddedMQMD. |
Returned: |
If Version is specified as MQMD_VERSION_2. Not returned in Excluded Publish Operations and in MQMD for Publish and Discarded Publish Operations. |
- Offset
-
Description: |
Offset of data in physical message from start of logical message. |
Identifier: |
MQIACF_OFFSET. |
Data type: |
MQCFIN. |
Included in PCF group: |
MQMD or EmbeddedMQMD. |
Returned: |
If Version is specified as MQMD_VERSION_2. Not returned in Excluded Publish Operations and in MQMD for Publish and Discarded Publish Operations. |
- MsgFlags
-
Description: |
Message flags that specify attributes of the message or control its processing. |
Identifier: |
MQIACF_MSG_FLAGS. |
Data type: |
MQCFIN. |
Included in PCF group: |
MQMD or EmbeddedMQMD. |
Returned: |
If Version is specified as MQMD_VERSION_2. Not returned in Excluded Publish Operations and in MQMD for Publish and Discarded Publish Operations. |
- OriginalLength
-
Description: |
Length of original message. |
Identifier: |
MQIACF_ORIGINAL_LENGTH. |
Data type: |
MQCFIN. |
Included in PCF group: |
MQMD or EmbeddedMQMD. |
Returned: |
If Version is specified as MQMD_VERSION_2. Not returned in Excluded Publish Operations and in MQMD for Publish and Discarded Publish Operations. |
- QMgrName
-
Description: |
Name of the queue manager where the activity was performed. |
Identifier: |
MQCA_Q_MGR_NAME. |
Data type: |
MQCFST. |
Included in PCF group: |
Operation. |
Maximum length: |
MQ_Q_MGR_NAME_LENGTH |
Returned: |
Always. |
- QSGName
-
Description: |
Name of the queue sharing group to which the queue manager where the activity was performed belongs. |
Identifier: |
MQCA_QSG_NAME. |
Data type: |
MQCFST. |
Included in PCF group: |
Operation. |
Maximum length: |
MQ_QSG_NAME_LENGTH |
Returned: |
If the activity was performed on an IBM MQ for z/OSĀ® queue manager. |
- TraceRoute
-
Description: |
Grouped parameters specifying attributes of the trace-route message. |
Identifier: |
MQGACF_TRACE_ROUTE. |
Data type: |
MQCFGR. |
Contained in PCF group: |
Activity. |
Parameters in group: |
- Detail
- RecordedActivities
- UnrecordedActivities
- DiscontinuityCount
- MaxActivities
- Accumulate
- Forward
- Deliver
|
Returned: |
If the activity was performed on behalf of the trace-route message. |
The values of the parameters in the TraceRoute PCF group are those from the trace-route message at the time the activity report was generated.