TABLE OF CONTENTS
Introduction
In this section an overview is given of the KPI Manager of the platform. The tasks of the KPI Manager within the platform are the following:
- Create, edit and delete KPI templates
- Setting permissions editing KPI templates for users
- View and filter all KPI templates
- Setting details for virtual data points
- Query and computation of nodes
- Implementation of predefined basic computation
- Implementation of self-written computations as data scientist
- Provides an API to implement new computation
- Notifications when job-evaluations are crashing
- Migrate Job Queue from Rabbit MQ to Redis Streams
You can access the Alarm Manager within the platform as follows:
Important terms
KPI
A KPI (Key Performance Indicator) is computed from time series (e. g. measured values) and other KPIs based on a KPI template.
KPI Template
KPIs are computed based on a KPI template. A KPI template has exactly one KPI graph. It also has one or more filters to select resources. The first filter of the KPI template is supposed to have a group-by expression that yields the resources (e. g. ventilation plants) for which the KPI template should be computable. In order to create a KPI template for a pre-determined fixed set of resources, the result set of this filter can optionally be saved, so that the filter is not re-evaluated at runtime (compare to Dashboard Template).
KPI Context
KPI context is a term that helps to think about the computation of a KPI template within the context of a resource, typically a container (e. g. a ventilation plant). Here, such a resource is one of the grouping resources obtained via the group-by expression of the main filter of the KPI template.
KPI Graph
A KPI graph is composed of one or more source elements, zero or more function elements, and one or more sink elements.
Source Element
A source of time series in a KPI graph. Its outlet is typically connected to an inlet of a function element. Each source element has a filter to select a data source. That filter is evaluated against the union of the result sets of the filters of the KPI template (compare to Widget).
Function Element
A pre-configured function in a KPI graph that transforms data coming in at its inlets and yields result data at its outlet(s).
Sink Element
A sink in a KPI graph. Represents a virtual time series computed by the KPI graph. It has one inlet. The sink will not transform the data, it will just be written to a storage.