DPL message structure for the CICS-WebSphere MQ bridge

These examples show the different structures that you can use for request messages from a non-CICS application to run CICS® DPL programs through the CICS-WebSphere MQ bridge.

In the simplest case, the message data consists only of the name of a DPL program to be run. Follow this by COMMAREA data or with DFHREQUEST container data if you want to make data available to the DPL program (the user program) when it starts.

If you want to run more than one DPL program in a unit of work, or you prefer a specific transaction code (overwriting the default CKBP), or you require certain levels of authorization to run the DPL program, or utilise the channels and containers (by using the CKBC or equivalent transaction to run program DFHMQBP3), you must supply information in an MQCIH. The MQCIH must precede the DPL program name and any DPL program data that you send.

  • Use this structure when your non-CICS application runs a single CICS DPL program using default processing options and does not send or receive any DPL program data:
    ┌──────┬──────────┐
    │ MQMD │
    ProgName
    │
    └──────┴──────────┘
    The program specified by ProgName is called by CICS as a DPL program.
  • Use this structure when your non-CICS application runs a single DPL program using default processing options and sends and receives COMMAREA data:
    ┌──────┬──────────┬──────────────┐
    │ MQMD │
    ProgName
    │
    CommareaData
    │
    └──────┴──────────┴──────────────┘
  • Use this structure when your non-CICS application runs one or more DPL programs in a unit of work, or needs specific authorization to run the program, but does not send or receive any DPL program data:
    ┌──────┬───────┬──────────┐
    │ MQMD │ MQCIH │
    ProgName
    │
    └──────┴───────┴──────────┘
  • Use this structure when your non-CICS application runs one or more DPL programs in a unit of work, or needs specific authorization to run the program, and sends and receives COMMAREA data or sends DFHREQUEST container data, and receives DFHRESPONSE container data:
    ┌──────┬───────┬──────────┬──────────────────┐
    │ MQMD │ MQCIH │
    ProgName
    │
    DPL program data
    │
    └──────┴───────┴──────────┴──────────────────┘
Note: When you send only a program name and no COMMAREA data to the CICS-WebSphere MQ bridge, the program name must be 8 characters long. It must not be a name that is padded to the right with spaces; if it is the CICS-WebSphere MQ bridge reports a COMMAREA negative length error. When you do send COMMAREA data, or DFHREQUEST container data you must pad the program name with spaces to the right, to give a total length of 8 characters.

Optionally, additional headers with format names beginning MQH, and containing standard link fields, can precede the MQCIH header. Such headers are returned unmodified in the output message because the CICS-WebSphere MQ bridge makes no use of data in the headers.

Reply message structure

If a CICS-WebSphere MQ bridge task running a DPL program ends abnormally, it returns a message to the reply queue with the following structure, whether or not the inbound message preceding the failure contains an MQCIH:
┌──────┬───────┬────────────────┐
│ MQMD │ MQCIH │
DFHMQ* message
│
└──────┴───────┴────────────────┘
DFHMQ* message represents an error message that indicates the error type. The value of the MQCIH.Format field is set to MQFMT_STRING, so that the message can be properly converted if the final destination uses a different CCSID and encoding. The MQCIH also contains other fields that you can use to diagnose the problem.


fg15440_.html | Timestamp icon Last updated: Monday, 5 June 2017