Message body

The message body is formatted as specified by the XML schema specified for the message. In order for the data handler to find and use the correct XML schema for formatting a message, the following three names must be the same:

The message formats and the settings for particular properties for the different types of messages exchanged by the connector framework and WebSphere MQ Integrator are listed in the tables below.

Table 15. Format and property settings of event delivery messages from the connector framework to a WebSphere message broker.

MQMD Contains no relevant information.
RFH2 message header In the <mcd> folder, the following fields contain information that identifies the message, its format, and how it needs to be parsed:
  • Message domain is set to mrmby default. This specifies that the integration broker should use the parser specifically for MRM-managed messages (those that are fully modelled in the message repository). This setting can be changed to xml by changing the RHF2MessageDomain standard connector configuration property. Refer to "Appendix C, Standard configuration properties for connectors" for more information.
  • Message type identifies the name of the highest-level business object represented by the message.
  • Message set identifies the message set this specific message is associated with. A separate message set is created for each type of business object.
  • Message format is set to CwXML.
Message body Contains an XML instance document that conforms to the XML schema and the imported message broker message set definition for the business object specified by the message type in the RFH2 header.


Table 16. Format and property settings of request messages from the connector framework to a WebSphere message broker.

MQMD Reply-to information is located in two fields: ReplyToQ and ReplyToQMgr. They contain the queue name and queue manager name to which the integration broker needs to direct the response message. In JMS messages, these fields specify the JMSReplyTo destination on the request message. MessageID (JMSMessageID) contains a unique value, which is copied to the CorrelID property field on the response message.
RFH2 message header In the <mcd> folder, the following fields contain information that identifies the message, its format, and how it needs to be parsed:
  • Message domain is set to mrm by default. This specifies that the integration broker should use the parser specifically for MRM-managed messages (those that are fully modelled in the message repository).This setting can be changed to xml by changing the RHF2MessageDomain standard connector configuration property. Refer to "Appendix C, Standard configuration properties for connectors" for more information.
  • Message type identifies the name of the highest-level business object represented by the message.
  • Message set identifies the message set this specific message is associated with. A separate message set is created for each type of business object.
  • Message format is set to CwXML.

In the <jms> folder, the Rto (JMSReplyTo) field contains a URI that encodes the queue name and queue manager name to which the integration broker needs to direct the response message. See WebSphere MQ: Using Java for information about how this URI is specified. The reply-to information in Rto and in ReplyToQ/ReplyToQMgr in the MQMD are the same.

Message body Contains an XML instance document that conforms to the XML schema and the imported message broker message set definition for the business object specified by the message type in the RFH2 header.


Table 17. Format and property settings of response messages from a WebSphere message broker to the connector framework.

MQMD The CorrelID field contains the message ID of the request to which the integration broker is responding. For JMS messages, this field is used to define JMSCorrelationID.
RFH2 message header In the <mcd> folder, the following fields contain information that identifies the message, its format, and how it needs to be parsed:
  • Message domain is set to mrm by default. This specifies that the integration broker should use the parser specifically for MRM-managed messages (those that are fully modelled in the message repository). This setting can be changed to xml by changing the RHF2MessageDomain standard connector configuration property. Refer to "Appendix C, Standard configuration properties for connectors" for more information.
  • Message type identifies the name of the highest-level business object represented by the message.
  • Message set identifies the message set this specific message is associated with. A separate message set is created for each type of business object.
  • Message format is set to CwXML.

In the <usr> folder, the following fields contain return status information:

  • Status field contains a string with return status information.

    Possible string values are:

    -1:
    The requested operation failed.
    0:
    The requested operation succeeded.
    1:
    The requested operation succeeded. The application has returned a changed business object.

  • Description field - When status is set to -1, it contains an extended error string with the message sent by the integration broker.
Message body Contains an XML instance document that conforms to the XML schema and the imported message broker message set definition for the business object specified by the message type in the RFH2 header.

Table 18. Format and property settings for request messages sent from a WebSphere message broker to the connector framework.

MQMD Reply-to information is located in two fields: ReplyToQ and ReplyToQMgr. They contains the queue name and queue manager name to which the integration broker needs to direct the response message. In JMS messages, these fields specify the JMSReplyTo destination on the request message. If the ReplyToQ and ReplyToQMgr fields are left blank, the connector framework is not expected to provide a response. If a response is required, messages can also specify reply-to information in the Rto property field of the message header. MessageID (JMSMessageID) contains a unique value, which is copied to the CorrelID property field on the response message.
RFH2 message header In the <mcd> folder, the following fields contain information that identifies the message, its format, and how it needs to be parsed:
  • Message domain is set to mrm. This specifies that the integration broker should use the parser specifically for MRM-managed messages (those that are fully modelled in the message repository).This setting can be changed to xml by changing the RHF2MessageDomain standard connector configuration property. Refer to "Appendix C, Standard configuration properties for connectors" for more information.
  • Message type identifies the name of the highest-level business object represented by the message.
  • Message set identifies the message set this specific message is associated with. A separate message set is created for each type of business object.
  • Message format is set to CwXML.
In the <jms> folder, the Rto (JMSReplyTo) property field can optionally contain the queue name and queue manager name to which the connector framework needs to direct the response message.
Message body Contains an XML instance document that conforms to the XML schema and the imported message broker message set definition for the business object specified by the message type in the RFH2 header.

Table 19. Format and property settings for response messages sent from the connector framework to a WebSphere message broker.

MQMD The CorrelID property field contains the message ID of the request to which the connector framework is responding.
RFH2 message header In the <mcd> folder, the following fields contain information that identifies the message, its format, and how it needs to be parsed:
  • Message domain is set to mrm. This specifies that the integration broker should use the parser specifically for MRM-managed messages (those that are fully modelled in the message repository).This setting can be changed to xml by changing the RHF2MessageDomain standard connector configuration property. Refer to "Appendix C, Standard configuration properties for connectors" for more information.
  • Message type identifies the name of the highest-level business object represented by the message.
  • Message set identifies the message set this specific message is associated with. A separate message set is created for each type of business object.
  • Message format is set to CwXML.
In the <usr> folder, the following fields contain return status information:
  • Status field contains a string with a return status indicator.

    Possible string values are:

    -1:
    The requested operation failed.
    0:
    The requested operation succeeded.
    1:
    The requested operation succeeded. The application has returned a changed business object.
  • Description property field - When status is set to -1, it contains an extended error string with the message sent by the connector framework.
Message body Contains an XML instance document that conforms to the XML schema and the imported message broker message set definition for the business object specified by the message type in the RFH2 header.

Table 20. Format and property settings for administrative messages sent from the connector framework to a WebSphere message broker.

MQMD Contains no relevant information.
RFH2 message header In the <mcd> folder, the following fields contain information that identifies the message, its format, and how it needs to be parsed:
  • Message domain is set to xml to indicate that the message should be parsed by the WebSphere message broker's generic XML parser.
Message body See Appendix D, Connector startup options for information about message body content.

Table 21. Format and property settings for administrative messages sent from a WebSphere message broker to the connector framework

MQMD If the administrative message is Stop Connector, the Format property is set to: MQC.MQFMT_STRING and the Expiry (JMSExpiration) property field is set to one minute.
Message body See Appendix D, Connector startup options for information about message body content.

Copyright IBM Corp. 1997, 2004