Options records for MQRecords

Each MQRecord is associated with five options records, which EGL uses as arguments in the hidden calls to WebSphere® MQ.

The following options records are available:
MQGMO
Get options record (referenced in the getOptionsRecord property)
MQPMO
Put options record (referenced in the putOptionsRecord property)
MQOO
Open options record (referenced in the openOptionsRecord property)
MQMD
Message descriptor record (referenced in the msgDescriptorRecord property)
MQOD
Get options record (referenced in the queueDescriptorRecord property)
MQSD
subscription descriptor record (referenced in the subDescriptorRecord property)

For more information on individual records, see the individual topics for the related properties.

When you specify an options record as a property of a WebSphere® MQ record, you are referring to a variable that is based on a predefined BasicRecord part (such as MQOD). The part resides in an EGL file that is provided with the product, as described in WebSphere MQ message queue access. Instead of using the Record part as is, you can copy it into your own EGL file and customize it.

If you do not indicate that a given options record is in use, EGL builds a default record and assigns values, as described in the following sections. However, the default options records are not available when you access WebSphere® MQ without using MQRecords.

Many of the values that are assigned to fields in these records are WebSphere® MQ constants, such as MQOT_Q or MQOO_FAIL_IF_QUIESCING. There are hundreds of these constants, far too many to document here. For a complete list, see your WebSphere® MQ documentation.

Queue descriptor record

You can create a queue descriptor record that is based on the MQSeries® Object Descriptor (MQOD), which is an argument on MQSeries® MQOPEN and MQCLOSE calls. If you do not declare a queue descriptor record, EGL automatically builds a default named MQOD, and your generated program does the following:
  • Initializes the queue descriptor record; for those initial values, see Data initialization.
  • Sets OBJECTTYPE in that record to MQOT_Q.
  • Sets OBJECTMGRNAME to the queue manager name that is specified in the record.resourceAssociation system variable; but if record.resourceAssociation does not reference the queue manager name, OBJECTQMGRNAME has no value.
  • Sets OBJECTNAME to the queue name in record.resourceAssociation.