Schedules

AVEVA Events to CONNECT schedules are configured to specify at what time interval data can be polled from the on-premises REST API.

Configure AVEVA Events to CONNECT Schedules using Curl commands

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

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

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

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

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

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

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 Schedules configuration, see Schedules REST URLs.

Configure AVEVA Events to CONNECT Schedules using the Configurator plugin

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

Create a new schedule period

To add a schedule period:

1. Select Add.

2. Enter values for the input fields.

   The Period field specifies at what time interval data can be polled from the on-premises REST API. For more information, see Schedules parameters.

Modify a schedule period

To edit a schedule period:

3. Select an existing item in the Schedules list.

4. Update the editable input fields.

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

Delete a schedule period

To delete a schedule period:

5. Select an existing item in the Schedules list.

6. Select Delete.

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