Defining and loading an XML schema for a MQRFH2 header

To include additional metadata or parameters in an MQ message, you must define an MQRFH2 header that defines the your parameters. Typically, these parameters are specific to an application but do not occur in the data of the message itself.

About this task

Each parameter, which MQ calls a folder, is passed as an XML fragment along with other MQRFH2 header data. Each parameter can have its own unique XML structure.

Because the Integration Appliance works with XML messages, each of these parameter fragments must be extracted from the MQRFH2 header. The fragments are consolidated into one fragment and passed as the MQRFH2 parameter to the Integration Appliance.

To make these parameters accessible, both Studio and the Integration Appliance need access to an XML Schema that defines the structures of all the parameters. Complete the following procedure to create that XML Schema and load it into the project.

Procedure

  1. Create an XML Schema that defines the parameters of your MQRFH2 header using an XML Schema editor or text editor. For an example XML Schema, see MQRFH2 XML data and schema examples. Your XML Schema must be customized for your application's parameters.
    Create the XML Schema according to the following guidelines:
    • Define the consolidated structure as a single NameValueData element.
    • List all the parameters, in the order they occur in the MQRFH2 header, as elements inside NameValueData element.
    • Parameter names must be unique.
    • Parameter, group, and property names must be valid XML names. See the XML specification or MQ documentation for more information.
    • Each parameter must be wrapped in a single element. MQ documentation refers to this parameter element as a folder.
    • Parameters may contain properties, groups, or both.
    • Groups and properties may repeat.
    • Groups can nest inside other groups.
    • Properties must be defined as type MQRFHQPropertyType.
  2. Add this XML Schema to the project. See Uploading Files into a Project for more information.
  3. The XML Schema is now available in the Browse for Schema Type Element dialog box. In the Configure pane of the MQ activities, this dialog box appears when you click the Schema Fragment for MQRFH2 Header check box and then click [..]. In the Browse For Schema Type Element dialog box find the XML Schema that defines the header, select NameValueData element in that XML Schema, and click OK.



Feedback | Notices


Timestamp icon Last updated: Tuesday, 27 September 2016


https://www.ibm.com/support/knowledgecenter/en/SS3LC4_7.5.3/com.ibm.wci.doc/MQ_Define_and_Load_a_Schema_Fragment_for_the_MQRFH2_Header.html