wm.art.dev.connection:createConnectionNode

This service creates a new connection node in the specified package and folder. The service initializes the connection in a disabled state. You must populate the input pipeline according to the table below prior to calling this service. To obtain a list of supported connection manager properties and connection-specific properties, call the services wm.art.dev.connection:fetchConnectionManagerMetadata and wm.art.dev.connection:fetchConnectionMetadata.

The value of a property's systemName is the internal name of the property. When constructing the input parameters connectionManagerSettingsand connectionSettings, use this internal name as the key for setting a property's value. For example, if a connection defines a property named hostPort, then its systemName (as returned by fetchConnectionMetada) would be hostPort. If the caller is a Java application, it might then use this information to set this property's value as follows:

IData pipeline = IDataFactory.create();
IDataCursor pipeCursor = pipeline.getCursor();
.
.
.
IData connSettings = IDataFactory.create();
IDataCursor connCursor = connSettings.getCursor();
connCursor.insertAfter("hostPort", new Integer(1234));
.
.
.
pipeCursor.insertAfter("connectionSettings", connSettings);
.
.
.

All connection manager properties have default values, in the defaultValuemetadata attribute for each property in the connectionManagerPropertiesstructure returned by fetchConnectionManagerMetadata. You may use these default values or override them with values that conform to the underlying data types of the properties. This service will not automatically set property values to their default values; you must explicitly set all required properties in the input parameter connectionManagerSettings.A required property is one whose metadata attribute isRequiredis set to true. (The isRequired attribute is contained in fetchConnectionManagerMetada.) 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. In particular, the connection manager property poolable is always required. The remaining connection manager properties have a special dependence on the value of poolable. Specifically, if you set poolable to true, then the remaining connection manager properties must be assigned values as well. If poolable is false however, may omit the remaining connection manager properties.

Connection-specific properties may or may not have default values, depending on the specific adapter's implementation. (In fact, depending on the underlying data type of the property, it might not be possible to assign it a default value.) You may use these default values or override them with values that conform to the underlying data types of the properties. This service will not automatically set property values to their default values; you must explicitly set all required properties in the input parameter connectionSettings. A required property is one whose metadata attribute isRequiredis set to true. (The isRequired attribute is contained in fetchConnectionMetada.) 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.

Be aware of any resource domains registered by the connection factory, and set the new connection's properties according to the interdependencies between resource domains. Knowledge of these interdependencies is notification-specific, and beyond the scope of this service. This service does not interpret resource domains.

adapterTypeName	String. Required. The name of adapter (the value returned by WmAdapter.getAdapterName()).
connectionFactoryType	String. Required. The fully qualified path of the WmManagedConnectionFactory implementation class.
packageName	String. Required. The package in which to install the connection.
connectionAlias	String. Required. The namespace (folder:node) name of the connection.
connectionManagerSettings	IData. Required. The structure for passing connection's manager property values.
.poolable	Boolean. Required. Determines 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 the 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. Required. The structure for passing a connection's property values.
.systemName	The value of the systemName property; see notes 1, 2, and 3.

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 must 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. The implementation of the adapter determines whether a particular property is required. To determine whether a property is required, call the service wm.art.dev.connection:fetchConnectionMetadata and check whether its isRequired attribute is set to true. If you do not provide a value for a required property, createConnectionNode throws an exception.