Data selection EdgeCmd scripts
- Last UpdatedJan 29, 2026
- 2 minute read
- PI System
- Adapter for OPC UA 1.6
- Adapters
The following section explains how to add and modify data selection items for each adapter using adapter-specific identifiers such as -nodeId, -topic, -metricName, -dataType, -valueField,-valueColumn, -scheduleId, or -queryID.
Note: The identifier for selecting a data item is adapter-specific. The -id parameter in generic examples represents a placeholder and is not a valid parameter for any adapter.
The examples in this topic use the default port number 5590. If your adapter uses a different port, you will have to include that in the command. For instance: edgecmd -port 5591 <RestOfTheCommand>.
Also, the examples in the table show different componentIds, so make sure to use the right componentId for your adapter.
|
EdgeCmd command |
Description |
Examples |
|---|---|---|
|
edgecmd get DataSelection -cid <componentId> [-file <filepath>] |
Get the data selection configuration for the specified component. |
edgecmd get DataSelection -cid OpcUa1 -file C:\Users\TestUser\DataSelection\Configuration.json |
|
edgecmd set DataSelection -cid <componentId> [-file <filepath>] |
Import the data selection configuration for the specified component. |
edgecmd set DataSelection -cid MQTT1 |
|
edgecmd get DataSelection -cid <componentId> [-file <filepath>] -csv |
Display the data selection configuration for the specified component in CSV format. |
edgecmd get DataSelection -cid RDBMS1 -file C:\Users\TestUser\DataSelection\Configuration.csv -csv |
|
edgecmd set DataSelection -cid <componentId> [-file <filepath>] -csv |
Import the data selection configuration for the specified component in CSV format. |
edgecmd set DataSelection -cid OpcUa1 -csv |
|
edgecmd add DataSelection -cid <componentId> -id <itemid>][-<adapterSpecificParameter><value>] |
Add the data selection configuration for the specified component. |
edgecmd add DataSelection -cid MQTT1 -id Custom1 -Name RandomName |
|
edgecmd edit DataSelection -cid <componentId> [-streamId <streamId>][-<adapterSpecificParameter> <value>] |
Change the data selection configuration for the specified component. |
edgecmd edit DataSelection -cid RDBMS1 -Selected true |
|
edgecmd remove DataSelection -cid <componentId> [-id <itemid>] [-y] |
Remove the data selection configuration for an item in the specified component. |
edgecmd remove DataSelection -cid OpcUa1 -id Random1 |
|
edgecmd remove DataSelection -cid <componentId> [-y] |
Remove the data selection configuration for the specified component. |
edgecmd remove DataSelection -cid MQTT1 -y |
|
edgecmd help DataSelection -cid <componentId> |
Display help output for data selection facet. |
edgecmd help DataSelection -cid RDBMS1 |
Use EdgeCmd utility to add and remove adapter, and to configure facets of the components.
Note: If a command contains slashes, you must add escape characters as follows:
In Windows , add a second slash. style="box-sizing: inherit;">
Example: TestUser\OilCompany becomes TestUser\\OilCompany
In Linux , add three additional slashes. style="box-sizing: inherit;">
Example: TestUser\OilCompany becomes TestUser\\\\OilCompany