Parameter Name | Parameter Name | Description |
input | Document List. Required. Represents an array of input records to the upgrade service. At least one input record is required. Each input record has the following parameters: | |
packageName | String. Required. Name of the package containing the Adapter for OPC service or notification nodes to be updated. | |
connectionName | String. Required. Name of the connection alias. All Adapter for OPC service or notification nodes matched by the namespace filter and having this connection alias will be picked for an update. The upgrade service will use the connection to communicate with OPC Server to fetch namespace table, required to generate extended node id. | |
nsFilter | Document. Optional. A namespace filter in the form of text expression(s), which can be applied to selectively filter Adapter for OPC service or notification 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 to include Adapter for OPC service or notification nodes which are to be updated. The default is to include all nodes. exclude. String List. Optional. An array of text expressions to exclude Adapter for OPC service or notification nodes from being updated. The default is to exclude none. | |
detailedStatusFilter | Document. Optional. Filter the output field detailedStatus based on the success or failure of Adapter for OPC service or notification nodes being updated . This includes any combination of success, failure or warning. Default is set to true for all the following options: success. String. Optional. Display the detailedStatus of Adapter for OPC service or notification node that successfully updated. Default is true. failed. String. Optional. Display the detailedStatus of Adapter for OPC service or notification node that failed to update. Default is true. warning. String. Optional. Display the detailedStatus of Adapter for OPC service or notification node that updated successfully but with warnings. Default is true. | |
simulate | String. Optional. Allowed values are true or false. Instructs the upgrade service to run in simulation mode during which no changes are made to Adapter for OPC service or notification nodes, and only a check is performed if a service or notification node can be updated successfully or not. Default value is true. Set simulate to false to persist the changes made to an Adapter for OPC service or notification node. | |
backup | String. Optional. Allowed values are true or false. Instructs the upgrade service to continue the backup of each package (specified via input records) before starting the update process. The backup is created under folder Integration Server_directory \instances\instance_name\replicate\outbound. The backup zip file name format is vname_yyyy-MM-dd_HHmmss_z. For example, package ExtSample1 will be backed up as ExtSample1_2020-07-08_155656_IST.zip. Default value of this parameter is false. Please note that the package backup (applicable if this parameter is true) is taken irrespective of whether the update service is running in simulate mode or persistence mode. |
Parameter Name | Parameter Name | Description |
output | Document List. Required. Represents an array of output records of the upgrade service corresponding to each input record. Each record has the following parameters: | |
packageName | String. Required. Name of the package containing Adapter for OPC service or notification nodes provided as an input to the upgrade service. | |
status | String. Required. The overall status of the upgrade service. Allowed values are success, error or warning. | |
message | String. Required. A summary message in case the Adapter for OPC service or notification nodes are updated successfully, else an error message displaying the reasons for failure to update. | |
summary | Document. Optional. Status summary of the Adapter for OPC service or notification nodes available in the given package after upgrade. Each record has the following parameters: total. String Array. Optional. An array of fully qualified NSNames representing the individual Adapter for OPC service or notification node available in the given package. selected. String Array. Optional. An array of fully qualified NSNames representing the individual Adapter for OPC service or notification nodes filtered based on the input fields nsFilter and connectionName selected for the upgrade. success. String Array. Optional. An array of fully qualified NSNames representing the Adapter for OPC service or notification nodes successfully updated by the upgrade service. failed. String Array. Optional. An array of fully qualified NSNames representing the Adapter for OPC service or notification nodes failed to update by the upgrade service. warning. String Array. Optional. An array of fully qualified NSNames representing the Adapter for OPC service or notification nodes successfully updated by the upgrade service with a warning. | |
detailedStatus | String Array. Optional. An array of the Adapter for OPC service or notification node records with detailed information of success, error or warning for each individual Adapter for OPC service or notification node, which was acted upon by the upgrade service. Each record has the following parameters: name. String. Required. The fully qualified NSName of the Adapter for OPC service or notification node. status. String. Required. Status of the updated Adapter for OPC service or notification node. Allowed values are success, error or warning. message. String. Required. A message if the Adapter for OPC service or notification node was updated successfully, else an error message explaining why the node could not be updated. data. Document List. Optional. List of records where each record represents the updated field information of the Adapter for OPC service or notification node. |