Resources

Resources are configured to specify data you want from the different type of routes in the on-premises REST API. You can create different endpoint routes to fetch the data from the on-premises REST API. For example, there can be an endpoint route for event types definition and a different endpoint route for the events.

Configure AVEVA Events to CONNECT resources using Curl commands

Complete the following steps to configure AVEVA Events to CONNECT Data resources. Use the PUT method in conjunction with the api/v1/configuration/<ComponentId>/Resources 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 an AVEVA Events to CONNECT Data Resources into the file. For sample JSON, see Resources examples.

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

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

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

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

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

   Notes:
   If you installed the agent to listen on a non-default port, update 5590 to the port number in use.
   If you use a component ID other than EventsToCONNECTComponent1, update the endpoint with your chosen component ID.
   For a list of other REST operations you can perform, like updating or deleting a Resource configuration, see Resources REST URLs.

Configure AVEVA Events to CONNECT resources using the Configurator plugin

Resource routes can be added, edited, or deleted in the Data Ingress Resources tab for the selected component.

Add a resource path

To add a path:

7. Select Add.

   This is appended to data source endpoint for the agent to start collecting event data.

8. Enter values for the input fields. For more information, see the Resources parameters.

Modify a resource path

To modify a path:

9. Select an existing item in the Resources list.

10. Update Resource Path.

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

Delete a resource path

To delete a path:

11. Select an existing item in the Resources list.

12. Select Delete.

    If the Resource Id is being used in data selection item, a validation error will be displayed.