Optional: Configure Data filters

AVEVA Adapters can be configured to perform data filtering to save network bandwidth. Every data item in the data selection configuration can be assigned the Id of a data filter. The adapter will then filter data for those data items based on the data filter configuration.

Configure data filters

Complete the following steps to configure data filters. Use the PUT method in conjunction with the http://localhost:5590/api/v1/configuration/<ComponentId>/DataFilters REST endpoint to initialize the configuration.

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

2. Copy and paste an example configuration for data filters into the file.

   For sample JSON, see Optional: Configure Data filters.

3. Update the example JSON parameters for your environment.

   For a table of all available parameters, see Optional: Configure Data filters.

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

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

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

   curl -d "@ConfigureDataFilters.json" -H "Content-Type: application/json" -X PUT "http://localhost:5590/api/v1/configuration/<ComponentId>/DataFilters"

   Notes: If you installed the adapter 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 data filters configuration, see Optional: Configure Data filters.

   On successful execution, the change that you have made to data filters takes effect immediately during runtime.

Data filters schema

The full schema definition for the data filters configuration is in the AdapterName_DataFilters_schema.json file located in one of the following folders:

Windows: %ProgramFiles%\OSIsoft\Adapters\\Schemas

Linux: /opt/OSIsoft/Adapters//Schemas

Data filters parameters

The following parameters are available for configuring data filters:

* Note: For example, "ExpirationPeriod": 5:00 and "ExpirationPeriod": 300 both specify an expiration period of 5 minutes and 0 seconds.

Data filters example

[

{

"Id": "DuplicateData",

"AbsoluteDeadband": 0,

"PercentChange": null,

"ExpirationPeriod": "01:00:00"

}

]

REST URLs

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