Metadata

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 set by the customer.

• AdapterType: This specifies the type of adapter and corresponds to the componentType in the adapter configuration. The componentType for this adapter is RDBMS.

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:

• ScheduleId: Specifies the schedule used to collect data for the stream. For RDBMS, this value correlates to the ScheduleId property of the selection item. For example, schedule1.

• SourceId: Specifies the information used to uniquely identify the stream on the source system. For RDBMS it is {QueryId}.{SelectValue}.{ValueColumn}. For example, TankQuery.Tank1.Temperature. If there is no SelectValue specified for a given selection item, SelectValue is omitted from the SourceId. For example, Query1.Temperature.

  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	None
  Low	Includes only framework related information	AdapterType and datasource
  Medium	Includes adapter specific information that is considered not sensitive	AdapterType, datasource, ScheduleId
  High	All metadata (including potentially sensitive information and control addresses)	AdapterType, datasource, ScheduleId, and SourceId

Each stream created for the selected measurement has a unique identifier (stream Id). If you specify a custom stream Id for the measurement in the data selection configuration, the adapter uses that stream Id to create the stream. Otherwise, the adapter constructs the stream Id using the following format:

<AdapterComponentId>.<QueryId>.<ValueColumn>

Note: Naming convention is affected by StreamIdPrefix and DefaultStreamIdPattern settings in the data source configuration. For more information, see Configure data source.

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.