wm.art.dev.service:updateAdapterServiceNode
This service updates an existing adapter service node.
You must perform the following steps to populate the input pipeline:
1. Use wm.art.dev.service:fetchAdapterServiceTemplateMetadata service to identify the supported service template properties and configure the adapterServiceSettings input parameter.
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
adapterServiceSettings input parameter.
2. Set only those properties that you want to change.
This service attempts to overlay these new values on the adapter service's current property values. The resulting set of merged property values are used to reconfigure the adapter service.
3. Update the properties 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.
4. If you are providing explicit property values in the adapterServiceSettings parameter, then the values must conform to the underlying data types of those properties.
5. Change the connection resource that the adapter service uses by providing a new connectionAlias input parameter.
If you omit the
connectionAlias parameter, the adapter service will continue to use its current connection resource.
If you are changing only the connection resource, it is not necessary to provide the
adapterServiceSettings input parameter.
The resource domains registered by the adapter service template are set in the adapter service's properties according to the interdependencies between the resource domains. This includes input and output signatures since they are supported through resource domains. This service provides the properties inputFieldNames, inputFieldTypes, outputFieldNames, and outputFieldTypes for this purpose. Knowledge of these interdependencies is adapter-specific, and beyond the scope of this service. This service does not interpret resource domains.
For an example of setting an adapter service property, see the Java code example in
wm.art.dev.service:createAdapterServiceNode.
Input Parameters
Name | Description |
serviceName | String. Required. Name of the existing adapter service in the format: folder:node. |
connectionAlias | String. Required. Name of the connection in the format: folder:node. |
adapterServiceSettings | IData. Required. Structure for passing the adapter's property values. |
| systemName | String. Required. Adapter service specific internal property name. |
| inputFieldNames | String[]. Names of the fields used in the adapter's input signature. |
| inputFieldTypes | String[]. Data types of the fields used in the adapter's input signature. 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 are supported. |
| outputFieldNames | String[]. Names of the fields used in the adapter's output signature. |
| outputFieldTypes | String[]. Data types of the fields used in the adapter's output signature. 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 are supported. |
Output Parameters
None.