wm.art.dev.connection:updateConnectionNode
This service alters the values of an existing connection. You must disable the connection before attempting this operation, using the disableConnection service. For more information, see the webMethods Integration Server Built-In Services Reference for your release.
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 services
wm.art.dev.connection:fetchConnectionMetadata and
wm.art.dev.connection:fetchConnectionManagerMetadata.
The value of the
systemName metadata attribute is the internal name of a property. When constructing the input parameters
connectionManagerSettingsand
connectionSettings, use this internal name as the key for setting a property's value. For an example of setting a connection property, see the Java code example in
wm.art.dev.connection:createConnectionNode.
The system names of connection manager properties are predefined. See the output specification of
wm.art.dev.connection:fetchConnectionManagerMetadata for their definitions.
You only need to supply values for the properties you want to change. This service attempts to overlay these new values on the connection's current property values. The resulting set of merged property values are used to reconfigure the connection. If you are not changing any connection manager or connection-specific properties, it is not necessary to pass in that container parameter. For instance, if you are not changing any connection manager properties, you do not need to build and pass in the connectionManagerSettingsparameter.
When providing explicit property values in connectionManagerSettingsand connectionSettings, you must provide values that conform to the underlying data types of those properties.
Input Parameters
connectionAlias | String. Required. The namespace (folder:node) name of the connection. |
connectionManagerSettings | IData. The structure for passing the connection's manager property values. |
.poolable | Boolean. Specifies whether to pool the connection. |
.minimumPoolSize | Integer. The minimum number of connections retained in the pool; not used if .poolable is false. |
.maximumPoolSize | Integer. The maximum number of connections retained in pool; not used if .poolable is false. |
.poolIncrementSize | Integer. The number of connections to add to the pool when additional connections are needed (not to exceed maximumPoolSize). Not used if .poolable is false. |
.blockingTimeout | Integer. The number of milliseconds to wait for a connection; not used if .poolable is false. |
.expireTimeout | Integer. The number of milliseconds of inactivity that may elapse prior to destroying the connection; not used if .poolable is false. |
connectionSettings | IData. The structure for passing the connection's property values. |
.systemName | The value of the systemName property; see notes 1 and 2. |
Note:
1. Unlike connection manager properties, which are predefined for all connections, actual connection properties (and their underlying data types) vary from adapter to adapter. You should set a connection property's value in accordance with its data type. To determine the value, call the service
wm.art.dev.connection:fetchConnectionMetadata and note the
parameterType attribute for that property.
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 "undefined" its 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.