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 StructuredDataFiles.

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::

• InputDirectory: Location of the source files to process.

  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
  High	All metadata (including potentially sensitive information and control addresses)	AdapterType, datasource, and InputDirectory

Each stream created for a given item has a unique identifier (stream ID). If you specify a custom stream ID for the item in data selection configuration, the adapter uses that stream ID to create the stream. Otherwise, the adapter constructs the stream ID with the following format constructed from the data source's FriendlyName and the item's ValueField:

<Adapter Component ID>.<FriendlyName>.<ValueField>

Note: The naming convention is affected by StreamIdPrefix and DefaultStreamIdPattern settings in the Data source configuration.

ComponentId corresponds to the adapter components' data source configured in the System components. ComponentType corresponds to the adapter type.

Metadata for health and diagnostics streams

If you configure a health endpoint and enable metadata, they are included in the health streams (Device status and Next health message expected) together with ComponentId and ComponentType.

If you enable diagnostics in Diagnostics and metadata, metadata are included in the diagnostics streams (Stream count, IO rate, Error rate) together with ComponentId and ComponentType.

The adapter may also send its own stream metadata not including health and diagnostics streams. For more information about what custom metadata is included in each stream, see the user guide for your adapter.

Note: Metadata is only sent for streams created by the ingress components. Currently, the only endpoint that persists sent metadata is CONNECT data services.