Configuring an Asynchronous Listener Notification

Perform the following procedure to configure an asynchronous listener notification.

To configure a WebSphere MQ asynchronous listener notification

1. Review the steps in Before you Configure Listener Notifications.

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 Asynchronous Listener Notification as the template and click Next.

6. Select the appropriate Notification Listener Name and click Next.

7. Select a package and folder to contain the notification, type a unique name for the notification, and click Next.

8. Click Finish.

9. Designer creates an asynchronous listener notification and an asynchronous publishable document type, and the editor for the adapter notification appears.

a. You can select the Adapter Settings tab at any time to confirm listener notification properties such as the Adapter Name, Adapter Listener Name, and Adapter Notification Template as necessary.

b. In the Publish Document section, you can specify how you want the notification document to be published:

To publish documents to Broker, select Broker/Local. This is the default option.

To publish documents to a JMS provider, select JMS Provider, and provide values for the following input fields:Connection alias name--Specify the name of the JMS connection alias configured on Integration Server.

If the connection alias is a Broker Cluster configured with Multisend Guaranteed policy, you must add the watt property watt.art.notification.jmsSend.usePublicService and set it to true.

Adapter Runtime does not support LOCAL_TRANSACTION and XA_TRANSACTION type JMS connection alias.

Destination name--Specify the name of the JMS connection alias configured on Integration Server.Destination type--Specify whether the destination is a Queue (default) or a Topic.

10. Select the MQMD Header tab to specify which optional msgHeader property fields and constant values the asynchronous notification will use. The msgHeader property fields that you select in the Output Field Names column appear within the signature of the Asynchronous Publishable Document on the Document Type tab.

Use the following icons to manage the rows on the MQMD Header tab:

To define new Output Field Names, select the Insert Row icon

(or the Fill in all rows to the table icon

To change the order of Output Field Names to ensure the parameters are parsed in the correct order, use the Shift Up

or Shift Down

icons.

To delete any Output Field Names, use the Remove row icon

You can add the following msgHeader property fields to the Input Field Name column and the Output Field Name column. In the MQMD Header, Filter Criteria refers to specific values that must be present in the header of the actual message in order for this notification to process it. You must select the Use for Input check box next to each property in order for the notification to use the filter criteria for that property.

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 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 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 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 and select the Use for Input check box 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 asynchronous notification will use.

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 property fields to ensure the parameters are parsed in the correct order, use the Shift Up

or Shift Down

icons

To delete any JMS property fields, use the Remove row icon

You can add 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 publishable document 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 Shift Up

or Shift Down

icons.

To delete any User-Defined property fields, use the Remove row icon

In an asynchronous publishable document, you can only edit parameters on the Publishable Properties tab.

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. From the File menu, select Save.

14. Select the publishable document that is associated with the asynchronous notification.

15. Select the Publication Properties tab to select a storage type and set a time-to-live value.

In an asynchronous publishable document, you can only edit parameters on the Publishable Properties tab:

Property	Description/Action
Storage type	For a publishable document type, you can set a storage type property to specify the steps Integration Server and Broker will take to ensure that a document does not get lost if a resource fails. Select the appropriate setting: Volatile Offers a faster, but less reliable type of storage than guaranteed. Volatile documents move through Integration Server faster than guaranteed documents because volatile documents are not acknowledged. Volatile documents will be lost if the resource on which the volatile document resides (Integration Server or Broker) fails or shuts down. Specify volatile storage for documents that have a short life or are not critical. Guaranteed Guaranteed storage offers a safer, but slower type of document storage. Integration Server saves guaranteed documents in a disk-backed document store using a process that ensures that guaranteed documents are never lost. Guaranteed documents move through Integration Server more slowly than volatile documents. Use guaranteed storage for documents that you cannot afford to lose. If the resource (Integration Server or Broker) that contains the guaranteed document fails or shuts down, the resource recovers the guaranteed documents when the resource restarts. For more discussion on volatile and guaranteed storage types, see the Publish-Subscribe Developer’s Guide for your release.
Time to live	The length of time the document type is allowed to stay on Integration Server, before it is thrown away. Select the appropriate setting that indicates how Integration Server processes the document type: Never discard Specifies that the Broker should never discard instances of the publishable document type. Discard after Specifies that the Broker should discard instances of the publishable document type after the specified time elapses. Specify the time interval in seconds, minutes, hours, days, weeks, months, or years.

16. From the File menu, select Save.