Configure data selection
- Last UpdatedFeb 20, 2025
- 2 minute read
- PI System
- Adapter for DNP3 1.2
- Adapters
In addition to the data source configuration, you need to provide a data selection configuration to specify the data you want the DNP3 adapter to collect from your outstations.
Depending on your data source configuration, your data selection configuration can be pre-populated by discovery. For additional information, see Configure discovery.
To configure a DNP3 data source:
-
Use the PUT method in conjunction with the api/v1/configuration/<ComponentId>/DataSelection REST endpoint to initialize the configuration.
-
Using a text editor, create an empty text file that includes an example configuration for a DNP3 data selection. See Data selection example for an example of a valid DNP3 data selection configuration.
-
Update the example with JSON parameters for your environment. For a list of all available parameters, see Data selection parameters.
-
Save the file in JSON format. For example, ConfigureDataSelection.json.
-
Open a command line session and change directory to the location of ConfigureDataSelection.json.
-
Enter the following cURL command (which uses the PUT method) to initialize the data selection configuration.
curl -d "@ConfigureDataSelection.json" -H "Content-Type: application/json" -X PUT "http://localhost:5590/api/v1/configuration/DNP3-1/DataSelection"
Note: If you installed the adapter to listen on a non-default port, update 5590 to the port number in use. If you use a component ID other than DNP3-1, update the endpoint with your chosen component ID and stream ID.
For a list of other REST operations you can perform, like updating or deleting a data selection configuration, refer to the REST URLs table.
REST URLs
|
Relative URL |
HTTP verb |
Action |
|---|---|---|
|
api/v1/configuration/<ComponentId>/DataSelection |
GET |
Retrieves the data selection configuration, including all data selection items. |
|
api/v1/configuration/<ComponentId>/DataSelection |
PUT |
Configures or updates the data selection configuration. The adapter starts collecting data for each data selection item when the following conditions are met:
|
|
api/v1/configuration/<ComponentId>/DataSelection |
POST |
Allows new items to be appended to the data selection without having to pass the entire data selection. |
|
api/v1/configuration/<ComponentId>/DataSelection |
PATCH |
Allows partial updating of configured data selection items. Note: The request must be an array containing one or more data selection items. Each item in the array must include its StreamId. |
|
api/v1/configuration/<ComponentId>/DataSelection |
DELETE |
Deletes the active data selection configuration. The adapter stops collecting data. |
|
api/v1/configuration/<ComponentId>/DataSelection/<StreamId> |
PUT |
Updates or creates a new data selection item by StreamId. For new items, the adapter starts collecting data after the request is received. |
|
api/v1/configuration/<ComponentId>/DataSelection/<StreamId> |
DELETE |
Deletes a data selection item from the configuration by StreamId. The adapter stops collecting data for the deleted item. |
Note: Replace <ComponentId> with the Id of your DNP3 component. For example, DNP3-1.