Configure schedules

You can configure the adapter to run scans based on a schedule. Each data item can be assigned to a schedule in the data selection configuration. The adapter samples data for those data items at the scheduled time.

If you start an ingress component without a schedule configuration, a default schedule configuration is added to use as an example.

Note: When the adapter framework scheduler misses or skips a scan for any reason, either one of the following messages is printed: Scan skipped for schedule id <Id> or Scan missed for schedule <id>.

Configure schedules

Complete the following steps to change the schedules configuration:

1. Using any text editor, create a file that contains the schedules configuration in the JSON format.

   • For content structure, see the Example schedule configuration section below.

   • For all available parameters, see the Schedules parameters table below.

2. Save the file. For example, ConfigureSchedules.json.

3. Use any of the Configuration tools capable of making HTTP requests to run a PUT command with the contents of the file to the following endpoint:

   http://localhost:5590/api/v1/configuration/<ComponentId>/Schedules.

   Note: Replace <ComponentId> with the ComponentId of the adapter.

   5590 is the default port number. If you selected a different port number, replace it with that value.

   Example using edgecmd:

   edgecmd -cid <ComponentId> set schedules -file ./ConfigureSchedules.json

On successful execution, the schedules change takes effect immediately during runtime.

Schedules parameters

The following parameters are available for configuring schedules:

Note: You can also specify time spans as numbers in seconds. For example, "Period": 25 specifies 25 seconds, or "Period": 125 specifies 2 minutes and 5 seconds.

Example schedule configuration

The following is an example of a complete schedule configuration:

[

{

"id": "schedule1",

"period": "00:00:01.500",

"offset": "00:02:03"

}

]

Default schedule configuration

If no schedule is configured, the adapter uses the following default schedule configuration:

[

{

"id": "1",

"period": "0:00:05",

"offset": "0:00:00"

}

]

REST URLs

Note: Replace ComponentId with the Id of your adapter component.