CloudStreams 10.5 | webMethods CloudStreams | Administering webMethods CloudStreams | Admin Folder | pub.cloudstreams.upgrade:batchUpgrade
 
pub.cloudstreams.upgrade:batchUpgrade
This service updates batches of CloudStreams connector service nodes and connector listener nodes from a lower version of the connector API to a higher version.
Note: 
*Make a backup copy of the existing package(s) containing the CloudStreams connector service nodes and connector listener nodes before running the batchUpgrade service.
*If the batchUpgrade service is used to update CloudStreams connector service nodes and connector listener nodes to a higher version of API and if backward compatibility is not supported by the SaaS provider, the CloudStreams connector service nodes and connector listener nodes may not function properly.
*It is recommended to use the batchUpgrade service to update CloudStreams connector service nodes and connector listener nodes from a lower version of the connector API to a higher version. Using the batchUpgrade service to update CloudStreams connector service nodes and connector listener nodes from a higher version of API to a lower version is not supported.
*Updating non-CUSTOM CloudStreams connector service nodes to CUSTOM type, that is, having an operation with either input.body.transformer or output.body.transformer property is also not supported.
If the connector service nodes and connector listener nodes were created with an earlier version of CloudStreams, you must first migrate the service nodes before using the batchUpgrade service. For information on how to migrate a connector service node and connector listener node, see the Upgrading Software AG Products document.
The batchUpgrade service may take a long time to complete if an input package contains large number of connections. This is because packages are reloaded at the end of the batchUpgrade service, and a package with many connections takes more time to reload. For better performance, disable the connections before executing the batchUpgrade service.
By default, the batchUpgrade service runs under simulation mode, that is, no actual changes are made to the corresponding CloudStreams connector service nodes and connector listener nodes, and only a check is performed if the service nodes can be updated successfully.
Input Parameters
input
Document List. Required. Represents an array of input records to the batchUpgrade service. At least one input record is required. Each input record has the following parameters:
*packageName. String. Required. Name of the package containing the CloudStreams connector service nodes and connector listener nodes to be updated.
*nsFilter. Document. Optional. A namespace filter in the form of text expression(s), which can be applied to selectively filter CloudStreams connector service nodes and connector listener nodes within the package specified by the packageName parameter. The namespace filter has the following parameters:
− patternStyle. String. Optional. Allowed values are glob or regex. The style of include or exclude text expression(s). glob allows for UNIX glob like expressions that are used by UNIX shell commands, whereas regex allows regular expressions to be used (as used by Java and Perl languages). The default style is glob.
− include. String List. Optional. An array of text expressions to include CloudStreams connector service nodes and connector listener nodes, which are to be updated. The default is to include all CloudStreams connector service nodes and connector listener nodes matched by the oldConnectionAlias parameter.
− exclude. String List. Optional. An array of text expressions to exclude CloudStreams connector service nodes and connector listener nodes from being updated. The default is to exclude none.
*oldConnectionAlias. String. Required. Name of the old connection alias. All CloudStreams connector service nodes and connector listener nodes matched by the namespace filter and having this connection alias will be picked for an update.
*newConnectionAlias. String. Required. Name of the new connection alias. The matched CloudStreams connector service nodes and connector listener nodes will get updated to use this new connection alias. The connectors associated with the old connection alias and the new connection alias must belong to the same provider package and should be of the same type, that is, REST/SOAP.
simulate
String. Optional. Allowed values are true or false. Instructs the batchUpgrade service to run in simulation mode during which no changes are made to CloudStreams connector service nodes and connector listener nodes, and only a check is performed if a service node and a listener node can be updated successfully or not. Default value is true. Set simulate to false to persist the changes made to a CloudStreams connector service node and a connector listener node.
force
String. Optional. Allowed values are true or false. Instructs the batchUpgrade service to continue updating CloudStreams connector service nodes and connector listener nodes, and ignore errors it encounters related to missing headers, parameters, and custom input/output document types that can prevent the connector service nodes and listener nodes from being updated in a normal scenario. Default value is false. Using force as true may result in an unusable CloudStreams connector service node with incorrect mappings and subsequent service execution failure or an unusable connector listener node with subsequent listener enablement or disablement failure.
Output parameters
output
Document List. Required. Represents an array of output records of the batchUpgrade service corresponding to each input record of the batchUpgrade service. Each output record has the following parameters:
*packageName. String. Required. Name of the package containing CloudStreams connector service nodes and connector listener nodes provided as an input to the batchUpgrade service.
*status. String. Required. Allowed values are true or false. The overall status of the batchUpgrade service; true if all input CloudStreams connector service nodes and connector listener nodes could be updated successfully, false otherwise.
*statusMessage. String. Required. A detailed error message in case the batchUpgrade service could not run properly, or a summary message displaying how many CloudStreams connector service nodes and connector listener nodes have updated successfully and how many service nodes and listener nodes have failed to update.
*node. Document. Optional. An array of node records for each individual CloudStreams connector service node and connector listener node, which was acted upon by the service. Each node record has the following parameters:
− nsName. String. Required. The fully qualified NS Name of the CloudStreams connector service node and connector listener node.
− success. String. Required. Allowed values are true or false. The status of the CloudStreams connector service node and connector listener node; true if updated successfully, false otherwise.
− message. String. Optional. A summary message if the CloudStreams connector service node and connector listener node was updated successfully, else an error message explaining why the service node and listener node could not be updated.