MQWIH - Work information header
If a message is to be processed by the z/OS® workload manager (WLM), the message must begin with an MQWIH structure. This structure describes the information that must be present at the start of a message that is to be handled by WLM.
Availability
All IBM® MQ systems, plus IBM MQ clients connected to these systems.
Format name
MQFMT_WORK_INFO_HEADER.
Character set and encoding
The fields in the MQWIH structure are in the character set and encoding given by the
CodedCharSetId and Encoding
fields in the header structure that precedes MQWIH, or by those fields in the MQMD structure if the
MQWIH is at the start of the application message data.
The character set must be one that has single-byte characters for the characters that are valid in queue names.
Usage
For any IBM MQ supported platform you can create and transmit a message that includes the MQWIH structure, but only an IBM MQ for z/OS queue manager can interact with WLM. Therefore, for the message to get to WLM from a non-z/OS queue manager, your queue manager network must include at least one z/OS queue manager through which the message can be routed.
Fields
| Field name and description | Name of constant | Initial value (if any) of constant |
|---|---|---|
| StrucId (structure identifier) | MQWIH_STRUC_ID | 'WIH¬' |
| Version (structure version number) | MQWIH_VERSION_1 | 1 |
| StrucLength (length of MQWIH structure) | MQWIH_LENGTH_1 | 120 |
| Encoding (numeric encoding of data that follows MQWIH) | None | 0 |
| CodedCharSetId (character-set identifier of data that follows MQWIH) | MQCCSI_UNDEFINED | 0 |
| Format (format name of data that follows MQWIH) | MQFMT_NONE | Blanks |
| Flags (flags) | MQWIH_NONE | 0 |
| ServiceName (service name) | None | Blanks |
| ServiceStep (service step name) | None | Blanks |
| MsgToken (message token) | MQMTOK_NONE | Nulls |
| Reserved (reserved) | None | Blanks |
|
Notes:
|
||
Language declarations
C declaration for MQWIH
typedef struct tagMQWIH MQWIH;
struct tagMQWIH {
MQCHAR4 StrucId; /* Structure identifier */
MQLONG Version; /* Structure version number */
MQLONG StrucLength; /* Length of MQWIH structure */
MQLONG Encoding; /* Numeric encoding of data that follows
MQWIH */
MQLONG CodedCharSetId; /* Character-set identifier of data that
follows MQWIH */
MQCHAR8 Format; /* Format name of data that follows
MQWIH */
MQLONG Flags; /* Flags */
MQCHAR32 ServiceName; /* Service name */
MQCHAR8 ServiceStep; /* Service step name */
MQBYTE16 MsgToken; /* Message token */
MQCHAR32 Reserved; /* Reserved */
};
COBOL declaration for MQWIH
** MQWIH structure
10 MQWIH.
** Structure identifier
15 MQWIH-STRUCID PIC X(4).
** Structure version number
15 MQWIH-VERSION PIC S9(9) BINARY.
** Length of MQWIH structure
15 MQWIH-STRUCLENGTH PIC S9(9) BINARY.
** Numeric encoding of data that follows MQWIH
15 MQWIH-ENCODING PIC S9(9) BINARY.
** Character-set identifier of data that follows MQWIH
15 MQWIH-CODEDCHARSETID PIC S9(9) BINARY.
** Format name of data that follows MQWIH
15 MQWIH-FORMAT PIC X(8).
** Flags
15 MQWIH-FLAGS PIC S9(9) BINARY.
** Service name
15 MQWIH-SERVICENAME PIC X(32).
** Service step name
15 MQWIH-SERVICESTEP PIC X(8).
** Message token
15 MQWIH-MSGTOKEN PIC X(16).
** Reserved
15 MQWIH-RESERVED PIC X(32).
PL/I declaration for MQWIH
dcl
1 MQWIH based,
3 StrucId char(4), /* Structure identifier */
3 Version fixed bin(31), /* Structure version number */
3 StrucLength fixed bin(31), /* Length of MQWIH structure */
3 Encoding fixed bin(31), /* Numeric encoding of data that
follows MQWIH */
3 CodedCharSetId fixed bin(31), /* Character-set identifier of data
that follows MQWIH */
3 Format char(8), /* Format name of data that follows
MQWIH */
3 Flags fixed bin(31), /* Flags */
3 ServiceName char(32), /* Service name */
3 ServiceStep char(8), /* Service step name */
3 MsgToken char(16), /* Message token */
3 Reserved char(32); /* Reserved */
High Level Assembler declaration for MQWIH
MQWIH DSECT
MQWIH_STRUCID DS CL4 Structure identifier
MQWIH_VERSION DS F Structure version number
MQWIH_STRUCLENGTH DS F Length of MQWIH structure
MQWIH_ENCODING DS F Numeric encoding of data that follows
* MQWIH
MQWIH_CODEDCHARSETID DS F Character-set identifier of data that
* follows MQWIH
MQWIH_FORMAT DS CL8 Format name of data that follows MQWIH
MQWIH_FLAGS DS F Flags
MQWIH_SERVICENAME DS CL32 Service name
MQWIH_SERVICESTEP DS CL8 Service step name
MQWIH_MSGTOKEN DS XL16 Message token
MQWIH_RESERVED DS CL32 Reserved
*
MQWIH_LENGTH EQU *-MQWIH
ORG MQWIH
MQWIH_AREA DS CL(MQWIH_LENGTH)
Visual Basic declaration for MQWIH
Type MQWIH
StrucId As String*4 'Structure identifier'
Version As Long 'Structure version number'
StrucLength As Long 'Length of MQWIH structure'
Encoding As Long 'Numeric encoding of data that follows'
'MQWIH'
CodedCharSetId As Long 'Character-set identifier of data that'
'follows MQWIH'
Format As String*8 'Format name of data that follows MQWIH'
Flags As Long 'Flags'
ServiceName As String*32 'Service name'
ServiceStep As String*8 'Service step name'
MsgToken As MQBYTE16 'Message token'
Reserved As String*32 'Reserved'
End Type