wm.art.dev.service:updateAdapterServiceNode
This service alters the values of an existing adapter service. You must populate the input pipeline according to the table below before calling this service. To obtain a list of supported template and schedule properties, call the service
wm.art.dev.service:fetchAdapterServiceTemplateMetadata.
The value of the
systemName metadata attribute is the internal name of a property. When constructing the input parameter
adapterServiceSettings, use this internal name as the key for setting a property's value. For an example of setting an adapter service property, see the Java code example in
wm.art.dev.service:createAdapterServiceNode.
You only need to supply values for the properties 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.
You can change the connection resource that the adapter service uses by providing a new connectionAliasinput parameter. If you omit this 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 adapterServiceSettingsinput parameter.
When providing explicit property values in adapterServiceSettings, you must provide values that conform to the underlying data types of those properties.
Be aware of any resource domains registered by the adapter service, and set the service's properties according to the interdependencies between resource domains. This includes input and output signatures since they are supported via resource domains. The properties inputFieldNames, inputFieldTypes, outputFieldNames, and outputFieldTypesare provided for this purpose. Knowledge of these interdependencies is adapter-specific, and beyond the scope of this service. This service does not interpret resource domains.
Input Parameters
serviceName | String. Required. The namespace folder:node name of an existing adapter service. |
connectionAlias | String. The namespace folder:node name of the connection to use. |
adapterServiceSettings | IData. The structure for passing the adapter's property values. |
.systemName | The value of the systemName property; see notes 1 and 2. |
.inputFieldNames | String[]. The names of the fields used in the adapter's input signature. |
.inputFieldTypes | String[]. The data types of the fields used in the adapter's input signature; see note 1. |
.outputFieldNames | String[]. The names of the fields used in the adapter's output signature. |
.outputFieldTypes | String[]. The data types of the fields used in the adapter's output signature; see note 1. |
Note:
1. The following Java data types are supported for adapter services: 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.
2. Set only those properties that you want to change. If a property's data type is non-primitive (that is, derived from java.lang.Object), you may clear a property's current value by setting it to null. There is no way to do this for Java primitives; they may only be redefined.
Output Parameters
None.