Upgrading the Edge Module

Use the following procedure (in the given order) if you are upgrading the AVEVA Adapter for OPC UA Edge Module from 1.3.1.6 to a newer version.

Note: If you need to downgrade to a previous version, please be aware of configuration differences between versions, including secret store support.

1. In Edge Management portal, select the Device Twin and select the Modules tab to select the existing AVEVA Adapter for OPC UA Module on version 1.3.1.6.

2. From the Versions drop-down, select the desired new version (for example, 1.5.0.373).

   Note: Do not change the adapter configuration file or Secret Store section.

3. Select Update to save your changes.

4. Select Publish to deploy the device. See Deploy a Device Twin for more information.

   Ensure that the Deployment state is Deployed.

5. Navigate back to the Modules tab and select the existing AVEVA Adapter for OPC UA Module (1.5.0.373).

6. If you have any changes to the adapter configuration file, select the Configuration File field to upload the new configuration for the module.

   From the Open dialog box, select the JSON file containing the configuration and select Open.

   Note: If you do not specify a configuration file, the module uses the default configuration.

7. (Optional) In the Secret Store section, select Setup.

8. (Optional) In the Setup module secret dialog, enter the secrets or passwords to replace the secret variables in the configuration file.

   By default, the text you enter is hidden, indicated by . To toggle visibility and see the text you entered, select , changing it to . The text you enter in the field is now visible.

   Important: If your module configuration file previously used secrets with any of the following identifiers, you need to modify the secret variables with this upgrade:
   
   {{EgressEndpointSecret}}
   {{AdditionalEgressEndpointSecret}}
   {{DataSourceSecret}}
   {{AdditionalDataSourceSecret}}
   
   See Module reference secrets for additional information.

   Note: This step is only required if your configuration file contains reference secrets. For example, reference secrets are used for securely transmitting protected properties to a device, such as a password for connecting to PI Web API or a data source, or a client secret for connecting to CONNECT data services.

9. After selecting the JSON file or revising the secret variables in the configuration file, select Create.

   A module command script is generated containing encrypted secret information. Use this command script to replace the variables in the configuration file on the device with the encrypted secrets.

10. Copy this command. After you deploy the module configuration, run the command on the edge device in a Linux terminal.

    Important: Every time you generate a new module command script to update secret information, you must run the script on your device and publish the device changes. Failure to perform both steps prevents the device from functioning correctly.

11. Select Update to save your changes.

12. Select Publish to deploy the device. See Deploy a Device Twin for more information.