Using the Services for Managing Namespace Nodes

This service creates a new connection node in the specified package and folder, and initializes the connection in a disabled state.

You must perform the following steps to populate the input pipeline:

1. Use wm.art.dev.connection:fetchConnectionManagerMetadata service to identify the supported connection manager properties and configure the connectionManagerSettings input parameter.
   • All connection manager properties have default values.
     • The default value is set in the defaultValue metadata attribute.
     • You can use the default values or override them with values that conform to the underlying data types of the properties.
     • The property values are not automatically set to their default values; you must explicitly set all the required properties.
     • If you omit a property, then no attempt is made to locate and assign default values to the property.
   • The connection manager properties may be optional or a required property.
     • A required property is identified when the isRequired metadata attribute is set to true.
     • The absence of the isRequired attribute implies that the property is not required.
     • If you fail to set a required property, the wm.art.dev.connection:createConnectionNode service throws an exception.
     • You may have properties that might be required, based on the current value of some other property.
   • The poolable connection manager property is always required.
   • The remaining connection manager properties depend on the value of poolable property.
     • If poolable is set to true, then the remaining connection manager properties must be assigned values as well.
     • If poolable is set to false, you may omit the remaining connection manager properties.
2. Use wm.art.dev.connection:fetchConnectionMetada service to identify the connection-specific properties and configure the connectionSettings input parameter.
   • Connection-specific properties may or may not have default values, depending on the specific adapter's implementation.
     • Depending on the underlying data type of the property, it might not be possible to assign a default value to a connection specific property.
     • You may use the default values or override them with values that conform to the underlying data types of the properties.
     • The property values are not automatically set to their default values; you must explicitly set all the required properties.
     • If you omit a property, then no attempt is made to locate and assign default values to the property.
   • Connection-specific properties may be optional or a required property.
     • A required property is identified when the isRequired metadata attribute is set to true.
     • The absence of the isRequired attribute implies that the property is not required.
     • If you fail to set a required property, the wm.art.dev.connection:createConnectionNode service throws an exception.
     • You may have properties that might be required, based on the current value of some other property.
     • The number of properties to be configured is adapter-dependent. At a minimum, set those properties whose isRequired attribute is set to true.
3. Enable the connection using the pub.art.connection:enableConnection service.

   For more information, see the IBM webMethods Integration Server Built-In Services Reference for your release.

The resource domains registered by the connection factories are set in the connection'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.

This service deletes the specified connection node.

• You must disable the connection node before you delete it, using the pub.art.connection:disableConnection service.

  For more information, see the IBM webMethods Integration Server Built-In Services Reference for your release.

• The delete action is immediate and non-reversible, and returns no output data.
• You may assume that the service completed successfully if it does not throw a checked exception.

This service fetches the connection manager properties that are predefined for all the connections, such as poolable, minimumPoolSize, maximumPoolSize, and others.

This service receives no inputs and returns an array of connectionManagerProperties structure. The connectionManagerProperties structure contains all metadata associated with each of the connection manager properties such as systemName, parameterType, defaultValue, and isRequired attributes, which you can use to configure a connection node.

This service fetches the adapter-specific properties.

This service receives an adapter type name and a fully qualified connection factory class path, queries the connection factory and returns the metadata for all properties supported by the connections of that type.

This service updates the values of an existing connection.

• You must disable the connection node before you update it, using the pub.art.connection:disableConnection service.

  For more information, see the IBM webMethods Integration Server Built-In Services Reference for your release.

You must perform the following steps to populate the input pipeline:

1. Use wm.art.dev.connection:fetchConnectionManagerMetadata service to identify the supported connection manager properties and configure the connectionManagerSettings input parameter.
2. Use wm.art.dev.connection:fetchConnectionMetadata service to identify the connection-specific properties and configure the connectionSettings input parameter.
3. Provide 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 example, if you are not changing any connection manager properties, you must not build and pass in the connectionManagerSettings parameter.

4. If you are providing explicit property values in connectionManagerSettings and connectionSettings parameter, then the values must conform to the underlying data types of those properties.

For an example of setting a connection property, see the Java code example in wm.art.dev.connection:createConnectionNode.

This service creates a new adapter service node in the specified package and folder from the specified service template and connection alias.

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 service's inputFieldNames, inputFieldTypes, outputFieldNames, and outputFieldTypes parameters in the adapterServiceSettings structure define the properties that comprise the adapter service's input and output signatures.
   • The data types of properties in the adapterServiceSettings structure are arrays of java.lang.String type.
   • A one-to-one correspondence exists between the elements in the *FieldNames and *FieldTypes arrays. For example, if the property names abc, xyz, and foo are inserted into the outputFieldNames parameter, then the service expects that exactly three data types will be inserted into outputFieldTypes, and that those data types correspond to the same element in outputFieldNames.
   • Adapter service properties may or may not have default values, depending on the specific adapter's implementation.
     • Depending on the underlying data type of the property, it might not be possible to assign a default value to a property.
     • You may use the default values or override them with values that conform to the underlying data types of the properties.
     • The property values are not automatically set to their default values; you must explicitly set all the required properties.
     • If you omit a property, then no attempt is made to locate and assign default values to the property.
   • Adapter service properties may be optional or a required property.
     • A required property is identified when the isRequired metadata attribute is set to true.
     • The absence of the isRequired attribute implies that the property is not required.
     • If you fail to set a required property, the wm.art.dev.service:createAdapterServiceNode service throws an exception.
     • You may have properties that might be required, based on the current value of some other property.
     • The number of properties to be configured is adapter-dependent. At a minimum, set those properties whose isRequired attribute is set to true.

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.

This service deletes the specified adapter service node.

• The delete action is immediate and non-reversible, and returns no output data.
• You may assume that the service completed successfully if it does not throw a checked exception.

This service fetches all metadata for an adapter service template for a specified connection alias and adapter service template class path.

This service receives a connection and a fully qualified adapter service template class path, and returns the metadata for all properties supported by the adapter service template.

This service returns an array of templateProperties structure each containing attributes such as systemName, parameterType, defaultValue, and isRequired.

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.

This service logs the data for listeners in the server log file. The data includes the names of associated listener notifications, the class name of listener notifications, their status (active or disabled), and whether the associated listener notification is linked with the same listener or not.

This service creates a new listener node in the specified package and folder from the specified listener template and connection alias, and initializes the new listener in a disabled state.

You must perform the following steps to populate the input pipeline:

1. Use wm.art.dev.service:fetchListenerTemplateMetadata service to identify the supported listener template properties and configure the listenerSettings input parameter.
   • Listener properties may or may not have default values, depending on the specific adapter's implementation.
     • Depending on the underlying data type of the property, it might not be possible to assign a default value to a property.
     • You may use the default values or override them with values that conform to the underlying data types of the properties.
     • The property values are not automatically set to their default values; you must explicitly set all the required properties.
     • If you omit a property, then no attempt is made to locate and assign default values to the property.
   • Listener properties may be optional or a required property.
     • A required property is identified when the isRequired metadata attribute is set to true.
     • The absence of the isRequired attribute implies that the property is not required.
     • If you fail to set a required property, the wm.art.dev.listener:createListenerNode service throws an exception.
     • You may have properties that might be required, based on the current value of some other property.
     • The number of properties to be configured is adapter-dependent. At a minimum, set those properties whose isRequired attribute is set to true.
2. Activate the listener using the pub.art.listener:enableListener service.

   For more information, see the IBM webMethods Integration Server Built-In Services Reference for your release.

The resource domains registered by the listener service template are set in the listener'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.

This service deletes a specified listener node.

• You must disable the listener node before you delete it, using the pub.art.listener:disableListener service.

  For more information, see the IBM webMethods Integration Server Built-In Services Reference for your release.

• The delete action is immediate and non-reversible, and returns no output data.
• You may assume that the service completed successfully if it does not throw a checked exception.

This service fetches all metadata supported by the listener template for a specified connection alias and listener template class path.

This service takes a valid connection alias and listener template class path, and returns an array of templateProperties structure each containing attributes such as systemName, parameterType, defaultValue, and isRequired.

This service updates an existing listener node.

• You must disable the listener before updating its properties, using the pub.art.listener:disableListener service.

  For more information, see the IBM webMethods Integration Server Built-In Services Reference for your release.

You must perform the following steps to populate the input pipeline:

1. Use wm.art.dev.listener:fetchListenerTemplateMetadata service to identify the supported service template properties and configure the listenerSettings 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 input parameter listenerSettings.
2. Set only those properties that you want to change.
   Note: This service attempts to overlay these new values on the listener's current property values. The resulting set of merged property values are used to reconfigure the listener.
3. 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.
4. If you are providing explicit property values in listenerSettings parameter, then the values must conform to the underlying data types of those properties.
5. Change the connection resource that the listener uses by providing a new connectionAlias input parameter.
   • If you omit the connectionAlias parameter, the listener continues to use its current connection resource.
   • If you are changing only the connection resource, it is not necessary to provide the listenerSettings input parameter.

The resource domains registered by the listener templates are set in the listener'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.

For an example of setting an listener property, see the Java code example in wm.art.dev.listener:createListenerNode.

This service checks listener notifications, finds the linked listener, and then checks whether the listener notification is also registered for the same listener or not. If not, then the service registers the listener notification with the linked listener.

This service logs the data for listener notifications. The data includes the name of a listener to which a listener notification is linked, and the class name of the listener. The service also checks whether the listener notification is registered with the listener or not.

This service creates a new synchronous or asynchronous listener notification node in the specified package and folder from the specified notification template and connection alias, and initializes the listener notification node in a disabled state.

You must perform the following steps to populate the input pipeline:

1. Use wm.art.dev.notification:fetchListenerNotificationTemplateMetadata service to identify the supported listener notification template properties and configure the notificationSettings input parameter.
   • Listener notification properties may or may not have default values, depending on the specific adapter's implementation.
     • Depending on the underlying data type of the property, it might not be possible to assign a default value to a property.
     • You may use the default values or override them with values that conform to the underlying data types of the properties.
     • The property values are not automatically set to their default values; you must explicitly set all the required properties.
     • If you omit a property, then no attempt is made to locate and assign default values to the property.
   • Listener notification properties may be optional or a required property.
     • A required property is identified when the isRequired metadata attribute is set to true.
     • The absence of the isRequired attribute implies that the property is not required.
     • If you fail to set a required property, the wm.art.dev.notification:createListenerNotificationNode service throws an exception.
     • You may have properties that might be required, based on the current value of some other property.
     • The number of properties to be configured is adapter-dependent. At a minimum, set those properties whose isRequired attribute is set to true.
2. The particular combination of input parameters you specify determines whether you create a synchronous or an asynchronous listener notification as described in the section for input parameters. This service throws an exception if you specify invalid or ambiguous combinations of input parameters.
3. When an asynchronous listener notification is triggered, Integration Server generates a runtime publishable output document.
   • The names and types of the data fields in the publishable output document is predefined.
   • Specify the names and types of the data fields in the publishable output document in the service's publishableRecordDef input parameter.
   • The publishableRecordDef input parameter consists of fieldNames and fieldTypes properties.
   • The data types of properties in the publishableRecordDef structure are arrays of java.lang.String type.
   • The fieldNames and fieldTypes properties are an array of String.
   • A one-to-one correspondence exists between the elements in these fieldNames and fieldTypes arrays.
   • The values assigned to the fieldNames and fieldTypes properties must correspond to fields that the listener notification class outputs in its runNotification method.
   • The service execution may fail if an empty publishableRecordDef is specified.
4. Activate the listener notification node using the pub.art.notification:enableListenerNotification service.

   For more information, see the IBM webMethods Integration Server Built-In Services Reference for your release.

The resource domains registered by the listener notification templates are set in the listener 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.

This service deletes the specified listener notification node.

• You must disable the listener notification node before you delete it, using the pub.art.notification:disableListenerNotification service.

  For more information, see the IBM webMethods Integration Server Built-In Services Reference for your release.

• The delete action is immediate and non-reversible, and returns no output data.
• Set the cascadeDelete flag to propagate the deletion across the Broker.
• You may assume that the service completed successfully if it does not throw a checked exception.

This service fetches all metadata supported by the listener notification template for a specified connection alias and listener notification template class path.

This service takes a valid listener node and listener notification template class path, and returns an array of templateProperties structure, each containing attributes such as systemName, parameterType, defaultValue, and isRequired.

This service updates the existing synchronous or asynchronous listener notification node.

• You must disable the listener notification node before updating its properties, using the pub.art.notification:disableListenerNotification service.

  For more information, see the IBM webMethods Integration Server Built-In Services Reference for your release.

You must perform the following steps to populate the input pipeline:

1. Use fetchListenerNotificationTemplateMetadata service to identify the supported service template properties and configure the listenerNode and notificationSettings 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 input parameter notificationSettings.
2. Set only those properties that you want to change.

   This service attempts to overlay these new values on the listener notification's current property values. The resulting set of merged property values are used to reconfigure the listener.

3. If you are providing explicit property values in notificationSettings parameter, then the values must conform to the underlying data types of those properties.
4. Change the listener resource that the listener notification uses by providing a new listenerNode input parameter.
   • If you omit the listenerNode parameter, the listener notification continues to use its current listener resource.
   • If you are changing only the listener resource, it is not necessary to provide the notificationSettings or any other input parameter.
5. A synchronous listener notification contains three additional input parameters:
   1. serviceName. Specifies the node name of a separate service that is invoked by the notification at runtime. If you omit this parameter, the notifications still retains the current value of the parameter.
   2. requestRecordDef and replyRecordDef. Document record definitions that the notification uses to format messages when communicating with this service. You can modify either or both of these definitions.
   • The requestRecordDef and replyRecordDef input parameters consists of fieldNames and fieldTypes properties.
   • The fieldNames and fieldTypes properties are an array of java.lang.String.
   • A one-to-one correspondence exists between the elements in these fieldNames and fieldTypes arrays.
   Note: This service cannot verify this assertion. If you configure either record definition incorrectly, the consequence may not manifest until runtime.
6. An asynchronous listener notification use the following input parameters:
   1. publishableRecordDef. Redefine the structure of an asynchronous notification's output document.
   • The publishableRecordDef input parameter consists of fieldNames and fieldTypes properties.
   • The fieldNames and fieldTypes properties are an array of java.lang.String.
   • A one-to-one correspondence exists between the elements in these fieldNames and fieldTypes arrays.
   • The values assigned to the fieldNames and fieldTypes properties must correspond to fields that the listener notification class outputs in its runNotification method.
   Note: This service cannot verify this assertion. If you configure either record definition incorrectly, the consequence may not manifest until runtime.
7. The requestRecordDef, replyRecordDef, and publishableRecordDef input parameters can be replaced in their entirety. The service does not attempt to merge the values in these parameters with the notification's current values. For instance, if you want to redefine a synchronous notification's reply record definition, you must define the entire record in the replyRecordDef input parameter.
8. The two listenerNode and notificationSettings input parameters apply to both synchronous and asynchronous listener notifications.

The resource domains registered by the listener notification templates are set in the listener 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.

This service creates a new instance of a polling notification in the specified package and folder from the specified notification template and connection alias, and initializes the new polling notification in a disabled state.

You must perform the following steps to populate the input pipeline:

1. Use fetchPollingNotificationTemplateMetadata service to identify the supported polling notification template properties and configure the input parameter notificationSettings structure.
   • Polling notification properties may or may not have default values, depending on the specific adapter's implementation.
     • Depending on the underlying data type of the property, it might not be possible to assign a default value to a property.
     • You may use the default values or override them with values that conform to the underlying data types of the properties.
     • The property values are not automatically set to their default values; you must explicitly set all the required properties.
     • If you omit a property, then no attempt is made to locate and assign default values to the property.
   • Polling notification properties may be optional or a required property.
     • A required property is identified when the isRequired metadata attribute is set to true.
     • The absence of the isRequired attribute implies that the property is not required.
     • If you fail to set a required property, the wm.art.dev.notification:createPollingNotificationNode service throws an exception.
     • You may have properties that might be required, based on the current value of some other property.
     • The number of properties to be configured is adapter-dependent. At a minimum, set those properties whose isRequired attribute is set to true.
2. This service creates a publishable document node in a notificationNamePublishDocument folder where notificationName is the value you specify for the notificationName input parameter. The name of publishable document is not configurable.
3. When a polling notification is triggered, Integration Server generates a runtime publishable output document.
   • The names and types of the data fields in the publishable output document is predefined.
   • Specify the names and types of the data fields in the publishable output document in the service's publishableRecordDef input parameter in notificationSettings parameter.
   • The fieldNamesand 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 outputs in its runNotification method.
   • The service execution may fail if an empty publishableRecordDef is specified.
5. A newly created polling notification is not assigned a delivery schedule. You must configure the polling notification's delivery schedule before enabling it. Provide a valid scheduleSettings input parameter in the call to createPollingNotificationNode or updatePollingNotificationNode service.
6. You can activate the polling notification using the pub.art.notification:enablePollingNotification service.

   For more information, see the IBM webMethods Integration Server Built-In Services Reference for your release.

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.

This service deletes the specified polling notification node. You must disable the notification before deleting it, using the disablePollingNotificationNode service. For more information, see the IBM webMethods Integration Server Built-In Services Reference for your release.

• You must disable the polling notification node before you delete it, using the pub.art.notification:disablePollingNotificationNode service.

  For more information, see the IBM webMethods Integration Server Built-In Services Reference for your release.

• The delete action is immediate and non-reversible, and returns no output data.
• Set the cascadeDelete flag to propagate the deletion across Broker.
• You may assume that the service completed successfully if it does not throw a checked exception.

This action is immediate and non-reversible, and returns no output data. You may assume that the service completed successfully if it does not throw a checked exception.

This service fetches all metadata supported by the polling notification template, and the scheduling properties for a specified connection alias and the polling notification template class path.

This service takes a valid connection alias and polling notification template class path, and returns an array of templateProperties and an array of scheduleProperties structure. Each polling notification template properties (templateProperties structure) includes systemName, parameterType, defaultValue, and isRequired attributes, which you can use to configure a new polling notification instance.

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.