wm.art.dev.notification:createListenerNotificationNode

This service creates a new instance of a synchronous or asynchronous listener notification in the specified package and folder from the specified notification template and connection alias. You must populate the input pipeline according to the table below before calling this service. To obtain a list of supported listener notification template and schedule properties, call the service wm.art.dev.notification:fetchListenerNotificationTemplateMetadata.

The value of a property's systemName attribute is the internal name of the property. When constructing the input parameter notificationSettings, use this internal name as the key for setting a property's value. For example, if a notification template defines a property named foo, then its systemName (as returned by fetchListenerNotificationTemplateMetadata) would be foo. If a Java application calls the service, it might use this information to set this property's value as follows:

Listener notification properties may or may not have default values, depending on the specific notification's implementation. You may use these default values or override them with values that conform to the underlying data types of the properties. You must explicitly set all required properties in the input parameter notificationSettings . A required property is one whose metadata attribute isRequiredis set to true. (The isRequired attribute is contained in fetchListenerNotificationTemplateMetadata.)The absence of the isRequiredattribute implies that the property is not required. If you fail to set a required property, the service throws an exception. In addition, be aware of any properties that may become required based on the current value of some other property. This service will not try to locate and assign defaults for properties that you have omitted.

You configure asynchronous listener notifications in a manner similar to how you configure polling notifications. In fact, a polling notification is actually a kind of asynchronous notification. Each time an asynchronous listener notification is triggered, it attempts to generate a run-time publishable output document. The format of this document (the names and types of the data fields it holds) is predefined. This service provides the input parameter publishableRecordDef for this purpose. You construct this parameter in the same manner that you construct notificationSettings(as described above). The difference is that the fieldNamesand fieldTypesproperties of publishableRecordDef each view an array of String. There is a one-to-one correspondence between the elements in these two arrays.The values you assign to these properties should correspond to fields that the notification class outputs in its runNotification()method. (If you specify an empty publishableRecordDef it will probably not execute properly.) This service does not validate that the fields in the publishable document are actually generated by the notification. By default, this service creates a publishable document node in a folder named notificationNamePublishDocument (where notificationName is the value you specify for the input parameter notificationName). This name is not configurable.

notificationName	String. Required. The namespace folder:node name of the new notification.
packageName	String. Required. The package in which to install the notification.
listenerNode	String. Required. The namespace folder:node name of the notification's listener.
notificationTemplate	String. Required. The fully qualified pathname of the listener notification template class; see note 1.
notificationSettings	IData. Required. The structure for passing the listener's property values.
.systemName	The value of the systemName property; see notes 2, 3, and 4.
serviceName	String. For synchronous notifications only; required. The node name of the service to invoke. This parameter must not be null.
publishableRecordDef	IData. For asynchronous notifications only; required. The definition of the run-time publishable output document.
.fieldNames	String[]. The names of the fields used in the notification's output document.
.fieldTypes	String[]. The data types of the fields used in the notification's output document; see note 2.
requestRecordDef	IData. For synchronous notifications only; required. The definition of the request document sent to serviceName. This parameter must not be null, but may be empty.
.fieldNames	String[]. The names of fields used in notification's request document
.fieldTypes	String[]. The data types of fields used in notification's request document; see note 2.
replyRecordDef	IData. For synchronous notifications only; required. The definition of the reply document received from serviceName. This parameter must not be null, but may be empty.
.fieldNames	String[]. The names of fields used in notification's reply document
.fieldTypes	String[]. The data types of fields used in notification's reply document; see note 2.

3. The implementation of the notification determines whether a particular property is required. To determine whether a property is required, call the service wm.art.dev.notification:fetchListenerNotificationTemplateMetadata and check whether its isRequired attribute is set to true. If you do not provide a value for a required property, createListenerNotificationNode throws an exception.