System components

AVEVA Events to CONNECT uses JSON configuration files in a protected directory on Windows to store configuration that is read on startup. While the files are accessible to view, AVEVA recommends that you use REST tools for any changes you make to the files.

As part of making agents as secure as possible, any passwords or secrets that you configure are stored in encrypted form where cryptographic key material is stored separately in a secure location. If you edit the files directly, the agent may not work as expected.

Note: You can edit any single component or facet of the system individually using REST, but you can also configure the system as a whole with a single REST call.

Configure system components using Curl commands

Complete the following steps to configure AVEVA Events to CONNECT system components. Use the PUT method in conjunction with the http://localhost:5590/api/v1/configuration/system/components REST endpoint to initialize the configuration.

1. Use a text editor to create an empty text file.

2. Copy and paste an example configuration for system components into the file. For sample configurations, see System component examples.

3. Update the example JSON parameters for your environment.

   For a table of all available parameters, see System component parameters.

4. Save the file. For example, as ConfigureComponents.json.

5. Open a command line session. Change directory to the location of ConfigureComponents.json.

6. Enter the following curl command (which uses the PUT method) to initialize the system components configuration.

   curl.exe --ntlm --negotiate -u <UserName> -d "@ConfigureComponents.json" -H "Content-Type: application/json" -X PUT "http://localhost:5590/api/v1/configuration/system/components"

   Notes:
   If you installed the agent to listen on a non-default port, update 5590 to the port number in use.
   For a list of other REST operations you can perform, like updating or deleting a system components configuration, see System component REST URLs.

Configure system components using Configurator plugin

Add or import system components using the Configurator plugin.

Add system components

To add a system component:

7. Select Add in System Components section of the General tab.

   Default entries are automatically populated in the Data Ingress tab.

   Note: The read-only unique Component Id is automatically generated. In addition, Component Type can only be EventsToCONNECT. For details on the fields, see System component parameters.

Import system components using a JSON file

To import system components using a JSON file:

8. Select Import in the System Components section of the General tab.

   The Open File dialog appears.

9. Navigate to and select a pre-configured JSON configuration file.

   Note: A sample JSON configuration file is installed under the ConfigatorPlugin folder where the agent is installed.

10. Select Open to automatically validate and import the JSON file.

    The imported entries are populated in the Data Ingress tab.