wm.art.dev.notification:updatePollingNotificationNode
This service updates the values of an existing polling notification. You must perform the following:
You must disable the polling notification before updating its properties, using the
pub.art.notification:disablePollingNotification service.
You can modify the following items:
Underlying connection resource used by the notification
Metadata property values
Schedule
Signature of its publishable output document
You must perform the following steps to populate the input pipeline:
1. Use wm.art.dev.notification:fetchPollingNotificationTemplateMetadata service to identify the supported service template properties and configure the connectionAlias, notificationSettings, scheduleSettings, and publishableRecordDef input parameter.
2. Configure the connectionAlias, notificationSettings, scheduleSettings input parameters.
3. Set only those properties that you want to change in connectionAlias, notificationSettings, scheduleSettings input parameters.
This service attempts to overlay these new values on the polling notification's current property values. The resulting set of merged property values are used to reconfigure the polling notification. For instance, change the connection resource that the polling notification uses by providing a new connectionAlias input parameter. If you omit this parameter, the polling notification continues to use the current connection resource. If you are changing only the connection resource, it is not necessary to provide the notificationSettings,scheduleSettings, or publishableRecordDef input parameters.
4. If you are providing explicit property values in notificationSettings parameter, then the values must conform to the underlying data types of those properties.
5. Configuring the publishableRecordDef.
The
publishableRecordDef input parameter must be replaced in its entirety. The service does not attempt to merge the values into the current publishable record definition. .
The
fieldNames and
fieldTypes properties of
publishableRecordDef are an array of String. A one-to-one correspondence exists between the elements in these two arrays.
The values assigned to the
fieldNames and
fieldTypes properties of
publishableRecordDef must correspond to fields that the notification class and the invoked service use to communicate with each other.
Note:
This service cannot verify this assertion. If you configure either record definition incorrectly, the consequence may not manifest until runtime.
6. The value of the systemName metadata attribute is the internal name of a property. Use this internal name as the key for setting a property's value when constructing the input parameter notificationSettings.
7. Update the property depending on the data type.
If a property's data type is non-primitive (derived from
java.lang.Object), you may clear a property's current value by setting its value to
null.
If a property's data type is Java primitive, then the property value cannot be cleared; however the property can be updated.
The resource domains registered by the polling notification templates are set in the polling notification's properties according to the interdependencies between the resource domains. Knowledge of these interdependencies is adapter-specific, and beyond the scope of this service. This service does not interpret resource domains.
Input Parameters
Name | Description |
notificationName | String. Required. Namespace name of the existing polling notification in the format: folder:node. |
connectionAlias | String. Required. Namespace name of the connection in the format: folder:node. |
notificationSettings | IData. Required. Structure for passing the polling notification's property values. |
| systemName | String. Required. Internal property name. The following Java data types are supported for connections: char, short, int, long, float, double, boolean, java.lang.String, java.lang.Character, java.lang.Short, java.lang.Integer, java.lang.Long, java.lang.Float, java.lang.Double, java.lang.Boolean. Arrays of all the above data types are also supported. |
scheduleSettings | IData. Required. Specifies the scheduling properties. |
| notificationInterval | Integer. Frequency to poll in seconds. |
| notificationOverlap | Boolean. Specifies whether notifications can overlap. |
| notificationImmediate | Boolean. Specifies whether to invoke the notification immediately. |
clusterProperties[k] | IData[]. A k-dimensioned array of cluster properties. | |
| systemName | String. Required. Internal property name |
| parameterType | String. Required. Data type of the property |
publishableRecordDef | IData. Required. Specifies the definition of the runtime publishable output document. |
| fieldNames | String[]. Names of the fields used in the polling notification's output document. |
| fieldTypes | String[]. Data types of the fields used in the polling notification's output document. The following Java data types are supported for connections: char, short, int, long, float, double, boolean, java.lang.String, java.lang.Character, java.lang.Short, java.lang.Integer, java.lang.Long, java.lang.Float, java.lang.Double, java.lang.Boolean. Arrays of all the above data types are also supported. |
Output Parameters
None.