Configure an adapter using a module

Edge modules are configured using a single JSON configuration file. For examples of configuration, see the Configuration examples in the Appendix.

CONNECT data services has a configuration editor that allows creating, modifying, and exporting adapter configuration as a single JSON file. Default configuration is provided to make it easy to get started, and the configuration file is validated as you make changes to ensure the configuration is valid. For more information, see Edge Data Store & Adapters.

Prior to using a module to configure the adapter, use the secret store to complete the secure transfer of secret values to the device. The configuration file should contain secret variables that act as placeholders for the actual secrets and passwords.

Complete the secret store configuration in AVEVA Edge Management to define values for the secret variables. AVEVA Edge Management encrypts the values and provides the Setup module secret command. After you deploy the module configuration, run the Setup module secret command in a Linux terminal on the device to replace the secret variables with the encrypted values.

To configure a new module using either Linux x64 or Linux ARM64:

1. Select the specific version of the module you want to configure from the Versions drop-down.

2. Specify the Deployment Name. This identifies the module deployment on the device.

3. Select the Configuration File field to upload a configuration for the module. A file Open dialog displays. Locate and select the JSON file containing the configuration, then click Open. If you do not specify a configuration file, the module uses the default configuration.

4. Specify the Connection Port. This port is used for local configurations.

5. In the Secret Store section, select Setup.

6. In the Credentials dialog, provide your Client ID and Secret. Select Save.

   This step is only required if your configuration file references a token endpoint.

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.

   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.

   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.

9. When you are finished, select Create.

   A module command script is generated containing the 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 prevent the device from functioning correctly.

11. Select to save your changes.

    • If this is a new device, you can now pair your edge device with the device twin and deploy the device twin. See Pair a Device Twin with an Edge Device for more information.

    • If this is an existing device and you are updating the secret information, you must publish your device changes. See Deploy a Device Twin for more information.