Configure client settings
- Last UpdatedJul 09, 2025
- 2 minute read
- PI System
- Adapter for OPC UA 1.6
- Adapters
The Client Settings configuration is automatically generated when a new data source is added. If you experience problems with timeouts or when OPC UA limits are exceeded in terms of browse or subscription operation, you can change the Client Settings configuration.
Generate default OPC UA client settings configuration file
If a valid data source exists, the adapter is running, and you do not want to modify the OPC UA client settings, you can use the default OPC UA client settings file generated by the adapter.
To generate the default client settings file:
-
Add an OPC UA adapter component with a unique ComponentId. For more information, see Configure system components .
-
Configure a valid OPC UA data source. For more information, see Configure data source.
After completing these steps, a default OPC UA client settings configuration file is generated in the configuration directory for the corresponding platform.
The following are example locations of the file created. In this example, the ComponentId of the OPC UA component is OpcUa1:
Windows: %programdata%\OSIsoft\Adapters\OpcUa\Configuration\OpcUa1_ClientSettings.json
Linux: /usr/share/OSIsoft/Adapters/OpcUa/Configuration/OpcUa1_ClientSettings.json
Postman
To configure client settings using Postman:
-
To initialize the configuration, use the PUT method in conjunction with the http://localhost:5590/api/v1/configuration/<componentId>/ClientSettings REST endpoint.
Note: If you installed the adapter to listen on a non-default port, update 5590 to the port number in use.
-
Copy and paste an example configuration for client settings into the Body section.
For sample JSONs, see the Examples section.
-
Update the example JSON parameters for your environment.
-
Select Send to push the configuration to the adapter.
EdgeCmd
To configure client settings using EdgeCmd:
-
Using a text editor, create an empty text file.
-
Copy and paste an example configuration for client settings into the file.
-
Update the example JSON parameters for your environment.
For sample JSONs, see the Examples section.
-
Save the file. For example, ConfigureClientSettings.json.
-
Open a command line session. Change directory to the location of your saved file.
-
Use the following edgecmd command with the name of your JSON file. For this example, we will use ConfigureClientSettings.json for the saved file.
edgecmd -port <port number> -cid <componentId> set ClientSettings -file /.ConfigureClientSettings.json
For a list of other REST operations you can perform, like updating or replacing a health endpoints configuration, see the REST URLs.