Egress endpoints

AVEVA Events to CONNECT collects event data and can send to a permanent data store (endpoint). This operation is called data egress. The following endpoint is available for data egress for AVEVA Events to CONNECT:

• CONNECT data services

For long term storage and analysis, you can configure the agent to send event data to one or several of these endpoints in any combination. An egress endpoint is comprised of the properties specified under Egress endpoint parameters.

Configure egress endpoints using Curl commands

Complete the following steps to configure egress endpoints. Use the PUT method in conjunction with the http://localhost:5590/api/v1/configuration/OmfEgress/dataendpoints REST endpoint to initialize the configuration.

1. Using a text editor, create an empty text file.

2. Copy and paste an example configuration for egress endpoints into the file. For sample JSON, see Egress endpoint examples.

3. Update the example JSON parameters for your environment. For a table of all available parameters, see Egress endpoint parameters.

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

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

6. Enter the following cURL command (which uses the PUT method) to initialize the egress endpoints configuration.

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

   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 replacing an egress endpoints configuration, see Egress endpoint REST URLs.

Configure egress endpoints using the Configurator plugin

Egress endpoints can be added, edited, or deleted in the Data Egress tab.

Create a new egress endpoint

To add an egress endpoint:

7. Select Add.

8. Enter values for the input fields.

   For more information on the input fields, see the Egress endpoint parameters.

9. Select Validate to verify the CONNECT data services endpoint is valid and can be authenticated using the client credentials provided.

Modify an egress endpoint

To edit an egress endpoint:

10. Select the item in the Egress Endpoint list.

11. Update the input fields.

    Id will be read-only once it has been created.

    Note: Client secret is not saved in the Configurator and must be entered again when editing the egress endpoint.

Delete an egress endpoint

To delete an egress endpoint:

12. Select the item in the Egress Endpoint list.

13. Select Delete.