Metadata
- Last UpdatedFeb 20, 2025
- 2 minute read
Metadata for data streams
Certain metadata are sent with each stream created. Metadata is only sent for streams created by the ingress components. The endpoints that persist sent metadata are CONNECT data services and Edge Data Store.
The following metadata, created by any AVEVA adapter, is available for streams:
-
datasource: This specifies the data source and corresponds to componentId in the adapter configuration. The componentID for this adapter is Modbus1.
-
AdapterType: This specifies the type of adapter and corresponds to the componentType in the adapter configuration. The componentType for this adapter is Modbus.
To add and configure a new adapter component, see Configure system components.
Note: All supported endpoints (Edge Data Store, CONNECT data services and PI Server) use datasource. However, any other metadata is only supported on Edge Data Store and CONNECT data services. If you use PI Server as the data endpoint, the Point Source field on a PI point reflects the metadata value.
The following metadata is specific to this adapter:
-
Device: The Device Id of the Modbus device
-
SourceId: SourceId is constructed using the following pattern: {DeviceId}.{ObjectType}{ObjectId}.{PropertyIdentifier}
-
Schedule: The specific time to run a scan.
-
Unit: The Modbus TCP slave device unit ID.
The metadata level in the System/General facet controls the amount of metadata written to an adapter stream and defines the amount of metadata sent to the OMF endpoints. It can be set in Manage adapter-wide settings to one of the following values:
Metadata Level
Description
Metadata
None
No metadata
Low
Includes only framework related information
AdapterType and datasource
Medium
Includes adapter specific information that is considered not sensitive
AdapterType, datasource, Device and Schedule
High
All metadata (including potentially sensitive information and control addresses)
AdapterType, datasource, Device, Schedule, Unit, and SourceId
Note: If a scheduleId is not specified when configuring data selection items (see Configure data selection), metadata will not be sent for the associated streams until the scheduleId is specified and the adapter process is restarted.
Metadata for health and diagnostics streams
If you configure a health endpoint, the adapter sends both health and diagnostics streams by default with the following metadata:
-
datasource
-
AdapterType
For more information around Health and Diagnostics, including the list of streams, see Health and diagnostics.
To manage your diagnostics and metadata settings, see Manage adapter-wide settings.