Configuring a Synchronous Listener Notification
Perform the following procedure to configure a synchronous listener notification.
To configure a WebSphere MQ synchronous listener notification
2. Start Designer.
3. Using Designer, perform the following:
a. Right-click the package in which the notification should be contained and select New > Adapter Notification.
b. Select the parent namespace and type a name for the adapter notification.
c. Click Next.
4. Select WebSphere MQ Adapter as the adapter type and click Next.
5. Select WebSphere MQ Synchronous Listener Notification as the template and click Next.
6. Select the appropriate Notification Listener Name and click Next.
7. Select the appropriate Service Node and click Next.
8. Select a package and folder to contain the notification, type a unique name for the notification, and click Next.
9. Click Finish.
The Adapter Notification template creates the following items:
A Synchronous Listener Notification
Two Synchronous Document Types:
A Synchronous Reply Document Type
A Synchronous Request Document Type
Note:
You cannot edit any fields or properties on the Publications Properties tab for the Synchronous Request and Reply Document Types. Integration Server does not publish these document types.
10. Select the MQMD Header tab to specify which optional msgHeader property fields the synchronous notification will use.
Use the following icons to manage the rows on the MQMD Header tab:
To define new
Request Field Names or
Reply Field Names, select the Insert Row icon
(or the Fill in all rows to the table icon
).
To change the order of the input or output fields to ensure the parameters are parsed in the correct order, use the Shift Up
or Shift Down
icons.
To delete any input field names or output field names, use the Remove row icon
.
You can add the following optional msgHeader Elements to the Request Field Name column (input) and the Reply Field Name column (output).
The selected
Request Field Names appear within the signature of the Synchronous Request Document on the
Document Type tab.
The selected
Reply Field Names appear within the signature of the Synchronous Reply Document on the
Document Type tab.
Maximum field lengths apply only to the Request Field Names in the Constant Value column:
msgHeader Property | Data Type | Maximum Field Length for Constant Value |
AccountingToken* | String | 32 alphanumeric single-byte characters |
AccountingTokenByteArray* | Byte Array | 32 bytes |
ApplIdentityData | String | 32 alphanumeric single-byte characters |
ApplOriginData | String | 4 alphanumeric single-byte characters |
BackoutCount | String | 4 digits |
CodedCharSetId | String | 4 digits Note: If this field is left blank, then WebSphere MQ Adapter enters a default value of MQCCSI_Q_MGR. |
CorrelId | String | 24 alphanumeric single-byte characters |
CorrelationIdByteArray | Byte Array | 24 bytes |
Encoding | String | 4 digits Note: If this field is left blank, then WebSphere MQ Adapter enters a default value of 273 Native. |
Expiry | String | 4 digits |
Feedback | String | 4 digits Note: If this field is left blank, then WebSphere MQ Adapter enters a default value of MQFB_NONE. |
Format | String | 8 alphanumeric single-byte characters Note: If this field is left blank, then the WebSphere MQ Adapter enters a default value of (NONE). |
GroupId* | String | 24 alphanumeric single-byte characters |
GroupIdByteArray* | Byte Array | 24 bytes |
MsgFlags | String | 4 digits Note: If this field is left blank, then WebSphere MQ Adapter enters a default value of None. |
MsgId | String | 24 alphanumeric single-byte characters |
MsgIdByteArray | Byte Array | 24 bytes |
MsgType | String | 4 digits Note: If this field is left blank, then the WebSphere MQ Adapter enters a default value of Datagram. |
MsgSeqNumber | String | 4 digits |
Offset | String | 4 digits |
OriginalLength | String | 4 digits |
Persistence | String | 4 digits Note: If this field is left blank, then the WebSphere MQ Adapter enters a default value of Not Persistent. |
Priority | String | 4 digits Note: If this field is left blank, then the WebSphere MQ Adapter enters a default value based on the default priority of the queue. |
PutApplName | String | 24 alphanumeric single-byte characters |
PutApplType | String | 4 digits |
PutDate | String | 8 digits |
PutTime | String | 8 digits |
ReplytoQueueMgr | String | 48 alphanumeric single-byte characters |
ReplyToQ | String | 48 alphanumeric single-byte characters |
Report | String | 4 digits |
UserIdentifier | String | 12 alphanumeric single-byte characters |
Note:
An asterisk * indicates that you can enter these properties either as a string or as a byte array. For example, AccountingToken and AccountingTokenByteArray refer to the same msgHeader property. If you specify values for both properties, then the byte array value will be used.
11. Select the JMS Properties tab to identify the optional JMS property fields that the synchronous notification will use. The selected JMS property fields display within the signature of the Synchronous Request document on the Document Type tab.
Use the following icons to manage the rows on the JMS Properties tab:
To define new JMS property fields, select the Insert Row icon
(or the Fill in all rows to the table icon
).
To change the order of JMS properties to ensure the parameters are parsed in the correct order, use the Shift Up
or Shift Down
icons.
To delete any JMS properties, use the Remove row icon
.
Select the following optional JMS property fields:
JMS Property | Data Type |
JMSDestination | String |
JMSExpiration | String |
JMSPriority | String |
JMSDeliveryMode | String |
JMSCorrelationID | String |
JMSCorrelationIDByteArray | Byte Array |
JMSReplyTo | String |
JMSType | String |
JMSMessageID | String |
JMSTimestamp | String |
JMSRedelivered | String |
JMSXGroupID | String |
JMSXGroupIdByteArray | Byte Array |
JMSXGroupSeq | String |
JMSXUserID | String |
JMSXAppID | String |
JMSXDeliveryCount | String |
MCDMessageDomain | String |
MCDMessageSet | String |
MCDMessageFormat | String |
Note:
An "X" in the JMS property name indicates that the property is provider specific. The remaining JMS properties are generic, delivered by any JMS provider.
You can also add your own folders and properties to the JMS Properties.
Use the following icons to manage the rows for User-Defined Properties on the JMS Properties tab:
To define new folders and properties, select the Insert Row icon
.
Enter the new folder and property. For example, enter "jms.usr.usr1". The "jms" and "usr" are the names of the folders and "usr1" is the name of the property.
All the folders and properties you add will be under JMSProperties as part of the RequestDocument of the adapter service.
Note:
The property name has to be prefixed with a folder name. You cannot use "JMSProperties" and "mcd" as the first folder name.
To change the order of User-Defined property fields to ensure the parameters are parsed in the correct order, use the
or
icons.
To delete any User-Defined property fields, use the Remove row icon
.
12. Select the Msg Properties tab, to choose the format in which you want to view the contents of the payload in the notification's publishable document.
Message Body as Object displays the msgBody property in the notification's publishable document.
Message Body as Byte[] displays the msgBodyByteArray property in the notification's publishable document.
13. Select the Adapter Settings tab, to view the adapter properties and to select the appropriate service name for the synchronous notification.
a. The following fields in the Adapter Properties section are read-only:
Adapter Properties | Description |
Adapter Name | The name of the adapter. |
Adapter Listener Name | The name of the adapter listener that you selected when you configured the synchronous notification. |
Adapter Notification Template | The name of the adapter notification template that you selected when you configured the synchronous notification. |
b. Specify one of the following modes in the Execution Mode section:
To invoke a flow service directly, select
Service Invoke and specify the
Service Name field as the name of the service that you selected when you initially configured the adapter listener notification. You can select a different service by clicking the browse icon
to the right of the
Service Name field.
Important:
Before you select a different service, make sure that you have disabled the notification. When the notification is enabled, then the new service is utilized. For more information on enabling and disabling listeners, see
Enabling Listeners and
Disabling Listeners.
To publish documents locally or to a
Broker and wait for a reply, select
Publish and Wait and specify the following fields:
Local--Select
true to publish documents locally (to
Integration Server only) or
false to publish to the
Broker connected to
Integration Server. If no
Broker is configured for
Integration Server, documents will be published locally.
Wait Time--Specify the number of milliseconds to wait for a reply. The default is -1, which means to wait indefinitely.
14. From the File menu, select Save.