Glossary

The following table explains key terms in connection with the Storage Provider.

Name

Function

Unique identifier
(automatically generated)

Descriptive parameters
(configurable by the user)

Storage Provider Configurator

Software tool for configuring the local Storage Provider.

 

 

Storage Provider Manager

Software tool for working with the Storage Provider. This can be used to start, stop, and manage data collections. The Storage Provider Manager can be used for both the local and the remote Storage Provider.

 

 

Storage Provider CLI Client

Command-line tool for interactions with the Storage Provider.

 

 

Storage Provider PLC library

PLC library for interactions with the Storage Provider.

 

 

Storage Provider

Software application for historizing data, e.g., from the Analytics Logger. Both the acquisition of the data to be stored and the provision of stored data are carried out via MQTT. The Storage Provider can be operated under Windows and FreeBSD®.

ProviderGuid

ProviderAlias

Storage

Data sink of a Storage Provider (e.g. MS SQL or CSV).

StorageGuid

StorageAlias

Message Broker

MQTT message broker via which data can be transmitted using the MQTT protocol.

 

 

HostBroker

Central message broker on which the Storage Provider provides information and receives commands.

BrokerGuid

BrokerAlias

DataBroker

Additional message broker from which the Storage Provider can obtain data to be recorded.

BrokerGuid

BrokerAlias

Pipeline

Description of a data flow. Components are data sources (Input Sources), processing steps (Rules), and data stores (Recordings).

PipelineGuid

PipelineAlias (can be set before starting the pipeline)

RuleEngine

Processing unit within the Storage Provider.

 

 

Rule

Processing rule within a pipeline that is used to filter, aggregate, and sample data.

RuleID

RuleAlias

Recording

Recording configuration for data. This includes which data should be recorded in which storage.

RecordingID

RecordingAlias (can be set before starting the pipeline)

Record

Data collection based on a defined recording configuration (Recording).

RecordID, additionally RecordDataKey if recording is running

RecordAlias (can be set before starting the pipeline)

Input Source

Data source for a pipeline. This can be an MQTT LiveStream or a HistoricalStream.

 

 

LiveStream

Data from the Analytics Logger, IoT Data Agent, or EK9160.

 

 

HistoricalStream

MQTT data stream from the Storage Provider, which contains all information about a recording and the associated records. One HistoricalStream is generated per recording.

HistStreamID

HistStreamAlias – this corresponds to the RecordingAlias

Recorder

Identifier of the client that communicates with the provider. It is provided when the pipeline is started in order to be able to trace who started the pipeline.

RecorderGuid

RecorderAlias

Ring buffer

Ring buffer function for a running record. Depending on the configuration (time-based or data-based), the oldest data in the record is overwritten.

 

 

Cleanup

Cross-record ring buffer function for an entire recording. This process takes into account all records associated with the recording. This includes both ongoing and completed records.

CleanupKey

CleanupAlias