Manage adapter-wide settings
- Last UpdatedFeb 04, 2025
- 1 minute read
- PI System
- Adapter for DNP3 1.2
- Adapters
You can configure AVEVA adapters to produce and store diagnostics data at a designated health endpoint, and to send metadata for created streams.
For more information about available diagnostics data, see Diagnostics. For more information about available metadata and what metadata are sent per metadata level, see Metadata in the Overview section.
Configure general
-
Start any of the Configuration tools capable of making HTTP requests.
-
Run a PUT command to the following endpoint and configure the enableDiagnostics, metadataLevel, and healthPrefix parameters:
http://localhost:5590/api/v1/configuration/system/general
Note: 5590 is the default port number. If you selected a different port number, replace it with that value.
Example
Example using Postman:
PUT http://localhost:5590/api/v1/configuration/system/general
{
"enableDiagnostics": true,
"metadataLevel": "Medium",
"healthPrefix": "Machine1"
}
General Parameters
The following parameters are available for configuring general:
|
Parameter |
Required |
Type |
Description |
|---|---|---|---|
|
enableDiagnostics |
Optional |
boolean |
Determines if diagnostics are enabled. Allowed values: true or false |
|
metadataLevel |
Optional |
reference |
Defines amount of metadata sent to OMF endpoints. Allowed values: None, Low, Medium, and High |
|
healthPrefix |
Optional |
reference |
Prefix to use for health and diagnostics stream and asset IDs. Default value: null |
REST URLs
|
Relative URL |
HTTP verb |
Action |
|---|---|---|
|
api/v1/configuration/system/General |
GET |
Gets the general configuration |
|
api/v1/configuration/system/General |
PUT |
Replaces the existing general configuration |
|
api/v1/configuration/system/General |
PATCH |
Allows partial updating of general configuration |