Creating message format of Message Queue reception

The JMS message to be handled in Message Queue reception consists of JMS header, property, and body.

The message format to be used in Message Queue reception is described here.

(a) Format of the header message

Set up the data specified in JMS header and property of JMS message in the header of the request message to be passed on to a business process from Message Queue reception.

The following table describes the request message format (for header variable) to be passed on to a business process from Message Queue reception. The name of the namespace is "http://www.hitachi.co.jp/soft/xml/cosminexus/csc/reception/mq/header".

Table 2-18 Request message format of the header message of Message Queue reception

Tag name			Type	Occurrence count	Description
<mq_header>			-	1 time	-
	<jms_header>		string	1 time	Contents of JMS header are set.
		<JMSDestination>	string	1 time	Name of the queue in which the message is set is set.
		<JMSDeliveryMode>	string	1 time	Value indicating persistence of the message is set.
		<JMSMessageID>	string	1 time	A message identifier that uniquely identifies each message sent by the provider is set.
		<JMSTimestamp>	string	1 time	A value indicating time of sending a message is set. (unit: milliseconds)
		<JMSExpiration>	string	1 time	A value indicating expiration period of a message is set. (unit: milliseconds)
		<JMSRedelivered>	string	1 time	A value indicating whether the message is being redelivered or not is set.
		<JMSPriority>	string	1 time	Message priority is set.
		<JMSReplyTo>	string	1 time	The address to be mentioned in "ReplyTo" is set. Do not use this information in Message Queue reception.
		<JMSCorrelationID>	string	1 time	Correlation identifier required to associate the current message with another message is set.
		<JMSType>	string	1 time	When a message is sent, the message type provided by an application is set.
		<JMSHeaderExtension>	string	More than 0 time	The following values are set: Attribute contains "name" and name of JMS header is set. Value of JMS header set in name is set.in value.
	<user_property>		-	1 time	Property contents set by the user are set.
		<property>	string	More than 0 time	The following values are set. This tag is generated for the number part in the set property. Attribute contains "name" and the property name is set. Property value set in name is set in value.

Legend:: -: Corresponding item does not exist.

(b) Format of body message

Pass on the main text stored in the body of a request message to a business process as a body message.

The types of a body message differ as per the interface of JMS message and settings of user-defined reception definition. The following table describes the message types of a body message:

Table 2-19 Message types of a body message

Interface name	Setting of user-defined reception definition (request message format is specified)
Interface name	any is specified	any is not specified
BytesMessage	Binary message	Message in any format
TextMessage	XML message	Message in any format

The method of creating a message format to be used in Message Queue reception is described here.

(a) Creating header message

For the message format of header message of Message Queue reception, edit XML schema provided by service platform and use it. Therefore, you need not create XML schema of header message.

XML schema of the message format provided by service platform is stored in "Installation directory of service platform\CSC\custom-reception\mq\schema".

The contents of XML schema provided by service platform are as follows:

 
<?xml version="1.0" encoding="UTF-8"?>
<!-- All Rights Reserved. Copyright (C) 2014, Hitachi, Ltd. -->
<xsd:schema elementFormDefault="qualified"
           targetNamespace="http://www.hitachi.co.jp/soft/xml/cosminexus/csc/reception/mq/header" 
           xmlns:mhc="http://www.hitachi.co.jp/soft/xml/cosminexus/csc/reception/mq/header" 
           xmlns:xsd="http://www.w3.org/2001/XMLSchema">
 
 <xsd:element name="mq_header">
  <xsd:complexType>
   <xsd:sequence>
     <xsd:element name="jms_header" maxOccurs="1" minOccurs="0">
      <xsd:complexType>
       <xsd:sequence>
        <xsd:element name="JMSDestination" maxOccurs="1" minOccurs="0" nillable="true" type="xsd:string"/>
        <xsd:element name="JMSDeliveryMode" maxOccurs="1" minOccurs="0" nillable="true" type="xsd:string"/>
        <xsd:element name="JMSMessageID" maxOccurs="1" minOccurs="0" nillable="true" type="xsd:string"/>
        <xsd:element name="JMSTimestamp" maxOccurs="1" minOccurs="0" nillable="true" type="xsd:string"/>
        <xsd:element name="JMSExpiration" maxOccurs="1" minOccurs="0" nillable="true" type="xsd:string"/>
        <xsd:element name="JMSRedelivered" maxOccurs="1" minOccurs="0" nillable="true" type="xsd:string"/>
        <xsd:element name="JMSPriority" maxOccurs="1" minOccurs="0" nillable="true" type="xsd:string"/>
        <xsd:element name="JMSReplyTo" maxOccurs="1" minOccurs="0" nillable="true" type="xsd:string"/>
        <xsd:element name="JMSCorrelationID" maxOccurs="1" minOccurs="0" nillable="true" type="xsd:string"/>
        <xsd:element name="JMSType" maxOccurs="1" minOccurs="0" nillable="true" type="xsd:string"/>
        <xsd:element name=" JMSHeaderExtension " minOccurs="0" maxOccurs="unbounded" >
         <xsd:complexType>
          <xsd:simpleContent>
           <xsd:extension base="xsd:string">
            <xsd:attribute name="name" type="xsd:string" use="optional"/>
           </xsd:extension>
          </xsd:simpleContent>
         </xsd:complexType>
        </xsd:element>
       </xsd:sequence>
      </xsd:complexType>
     </xsd:element>
     <xsd:element name="user_property" maxOccurs="1" minOccurs="0">
      <xsd:complexType>
       <xsd:sequence>
        <xsd:element name="property" minOccurs="0" maxOccurs="unbounded" >
         <xsd:complexType>
          <xsd:simpleContent>
           <xsd:extension base="xsd:string">
            <xsd:attribute name="name" type="xsd:string" use="optional"/>
           </xsd:extension>
          </xsd:simpleContent>
         </xsd:complexType>
        </xsd:element>
       </xsd:sequence>
      </xsd:complexType>
     </xsd:element>
   </xsd:sequence>
  </xsd:complexType>
 </xsd:element>
</xsd:schema>

(b) Creating body message

Schema format is optional for the message format of body message of Message Queue reception. You must create the schema by matching it with the message type of body message. Note thatyou need not create schema, if the message format is optional (any is specified).

2.6.2 Creating message format of Message Queue reception

(1) Message format

(a) Format of the header message

(b) Format of body message

(2) Method of creating a message format

(a) Creating header message

(b) Creating body message