MQSendXML function
The MQSENDXML function sends the data contained in msg-data to the WebSphere® MQ location specified by send-service using send-policy.
An optional user-defined message correlation identifier can also be specified by correl-id. The function returns a 1 if successful.
Syntax
Parameters
- msg-data
- An XML expression containing the data to be sent via WebSphere MQ.
- send-service
- A string containing the logical WebSphere MQ destination where the message will be sent. If specified, send-service refers to a service point defined in the DB2MQ.MQSERVICE table. A service point is a logical end-point from where a message is sent or received. Service point definitions include the name of the WebSphere MQ Queue Manager and Queue. If send-service is not specified, the DB2®.DEFAULT.SERVICE is used. The maximum size of send-service is 48 bytes.
- send-policy
- A string containing the MQSeries send policy used to handle this message. If specified, send-policy must refer to a policy defined in the DB2MQ.MQPOLICY table. A send policy defines a set of quality of service options that should be applied to this messaging operation. These options include message priority and message persistence. If send-policy is not specified, the default DB2.DEFAULT.POLICY is used. The maximum size of send-policy is 48 bytes.
- correl-id
- An optional string containing a correlation identifier associated with this message. The correl-id is often specified in request and reply scenarios to associate requests with replies. If not specified, no correlation ID is sent. The maximum size of correl-id is 24 bytes.
Results
A successful message results in a value of 1. A message containing msg-data will be sent to the location specified by send-service using the policy defined by send-policy.