Attribute und Zeitreihen

Attribute

Mithilfe von Attributen können Zeitreihen nicht nur kategorisiert werden, aber auch einfach aggregiert werden. So ist es möglich alle Zeitreihen eines Gebietes oder eines Lieferanten mit dem jeweiligen Attribut zu versehen und entsprechende Aggregate für Fahrplanmanagement oder Abrechnung zu berechnen.

In HAKOM TSM sind grundsätzlich 3 Gruppen von Attributstypen verfügbar:

• Einfache Attribute und

• Baumhierarchien

Einfache Attribute

Kategorien vs. Attribut Wert-Paare

Eine Kategorie ist ein Attribut ohne Wert, welche einer Zeitreihe zur Kategorisierung (wie ein "Tag") zugewiesen wird.

Ein Attribut-Wert Paar ist hingegen ein Attribut mit Wert. Durch Attribut-Wert Paar kann eine Zeitreihe zweierlei kategorisiert werden:

• Ist das Attribut zugewiesen oder nicht

• Mit welchem Wert wurde das Attribut zugewiesen

Aggregation von einfachen Attributen

Kategorieaggregate können in TSM App Hauptfenster via "Zeitreiheneigenschaftsaggregat" Funktion direkt aus dem Plugin ausgeführt werden.

Aggregation von weiterern Attribute inklusive wert-abhängige Aggregationen können sowohl aus der TSM App als auch aus der REST API mittels Formelfunktionen durchgeführt werden. Siehe Funktionen TSCA und TSAA in Formelzeitreihen)

Typen von einfachen Attributen

Für die TSM App stehen eine Reihe von unterschiedlichen Attribut-Typen (wie Text, Numeric, Date etc.) zur Verfügung (siehe auch Zeitreihen Erstellen, Bearbeiten und Löschen). Diese werden in TSM App entsprechend gegen Benutzereingaben validiert.

Dieselben Attribut-Typen können auch via WebTSM Services API verwaltet, zugewiesen werden, eine Validierung der Eingaben erfolgt in der API jedoch nicht.

Einfache Attribute in der Zeitreihensuche

In TSM App Zeitreihensuche ist es möglich gleichzeitig zwei Attribute in der Zeitreihensuche einzubeziehen. Wird ein Attribut-Wert Paar ausgewählt, so kann zusätzlich dessen Wert auch in die Suche einfließen.

In der WebTSM Services API ist die Anzahl der Attribute, bzw. Attribut|Wert Paare in der Zeitreihensuche unlimitiert. Es kann im Pfad /repositories/:repository/timeseries pro Attribut ein "attribute=Attributname" bzw. "attribute=Attributname|Attributwert" Parameter übergeben werden.

Anmerkung

In der WebTSM Services API kann mit derselben Logik auch ein Attribut der Typ Baumhierarchie in der Suche berücksichtigt werden.

Hierarchien mittels Attribute

Sogenannte Knotenattribute erlauben die Zuweisung von Zeitreihen zu komplexen Hierarchien. Dabei kann eine Zeitreihe in derselben Hierarchie nur in einem Knotenpunkt enthalten sein. 

Aggregation von Knotenattribute

TSM App:

1. Klicke auf Öffnen im TSM Ribbon

2. Wähle Raster, Einheit und gegebenenfalls weitere Parameter (absteigend und / oder Fehlende leer) aus

3. Wähle im Bereich Knotenaggregat einen Hauptknoten oder einer dessen Unterknoten aus

4. Betätige die Öffnen Schaltfläche

Anmerkung

Ein Knotenaggregat in TSM App wird immer alle dem ausgewählten Knoten untergeordnete Knoten (Kinder) enthalten.

WebTSM Services API:

• Aggregat auf Hauptknoten Ebene: /repositories/:repository/trees/:id|name/sum 

• Aggregat auf Unterknoten Ebene: /repositories/:repository/trees/:id|name/nodes/:nodeId/sum

Tipp

Anders als in TSM App ist es in WebTSM Services API steuerbar, ob Unterknoten in die Berechnung miteinbezogen werden sollen oder nicht (siehe Parameter sumType). 

Knoten in der Zeitreihensuche

TSM App:

1. Klicke auf Öffnen im TSM Ribbon

2. Betätige die Suchen... Schaltfläche im Bereich Zeitreihe des TSM Fensters

3. Es werden alle Knotenstrukturen im rechten Knotenpanel angezeigt, sofern mindestens ein Knotenattribut definiert wurde:

Anmerkung

Wird ein Knoten ausgewählt werden in der Suche alle Zeitreihen berücksichtigt die exakt dem ausgewählten Knoten zugewiesen sind. Zeitreihen aus Unterknoten werden derzeit in TSM App - Zeitreihensuche nicht berücksichtigt.

WebTSM Services API: 

• unter dem /repositories/:repository/timeseries Pfad können Hierarchien via Parameter "attribute=Knotenattributname|KnotenID" exakt gesucht werden.

• Ferner ist es möglich alle Zeitreihendefinitionen auszugeben, die einem Knoten bzw. Unterknoten zugewiesen sind:

  • Hauptknoten: /repositories/:repository/trees/:id|name/sum – siehe includeTimeSeries und includeSubNodes Parameter

  • Unterknoten: /repositories/:repository/trees/:id|name/nodes/:nodeId/sum – siehe includeTimeSeries und includeSubNodes Parameter

Sonderfall: Attribute mit Gültigkeitsbereich

In bestimmten Konstellationen ist es notwendig, dass zugewiesene Attributswerte sich über die Zeit ändern. Das kann der Fall sein, wenn zum Beispiel ein Attribut "Lieferant" ab einem Stichtag einen anderen Liefernaten widerspiegeln soll. Hierzu können in HAKOM TSM Attributswerte Stichtage ab denen sie gelten sollen vergeben werden. D.h. ein Attributswert ist immer bis zum nächsthöchsten Stichtag mit einem neuen Wert gültig. Solche Stichtage werden dann auch bei der Aggregation nach gewählten Attributswerten berücksichtigt.

Attribute verwalten

Attribute anlegen und anpassen

Um neue Attribute anzulegen müssen die folgenden Schritte durchgeführt werden:

TSM App

Mehr zum Thema Attribute in TSM App verwalten finden Sie hier: (3.11.2.2) Attribute

WebTSM Services API

In der WebTSM Services API sind Attribut Management Funktionalitäten unter folgenden Pfaden erreichbar:

• /attributetypes

  • > GET: Liste der Attributstypen

• /repositories/:repository/attributes

  • > GET: Liste aller Attributen im System

  • > POST: ein neues Attribut anlegen

• /repositories/:repository/attributes/:id|name

  • > GET: ein bestimmtes Attribut abrufen

  • > PUT: ein bestehendes Attribut anpassen

  • > DELETE: löscht das gewählte Attribut

Body eines Attributes in REST API:

{
  "ID": -1,
  "Name": "SensorName",
  "Description": "string",
  "Type": 2
}

Anmerkung

ID: -1 wird für neue Objekte verwendet.

Attribute Zeitreihen zuweisen

TSM App:

1. Klicke auf Öffnen im TSM Ribbon

2. Betätige die Suchen... Schaltfläche im Bereich Zeitreihe des TSM Fensters

3. Wähle die gewünschte Zeitreihe durch Eingabe der Suchparameter, Betätigen der Suche und Anklicken des Zeitreihennamens

4. Wähle den Reiter Bearbeiten im Fenster Zeitreihen Suche > die Definition der gewählten Zeitreihe wird geladen

5. Klicke auf Reiter Attribute

6. Klicke auf das grüne Plus Ikon  um die Attributsuche zu öffnen

7. Wähle die gewünschte Attribute aus und bestätige mit OK

Tipp

Es ist auch möglich eine vordefinierte Liste von Attributen auf einmal mithilfe von Attribut-Templates zuzuweisen.

Mehr zur Zuweisung von Attributen zu Zeitreihen finden Sie hier: Zeitreihen Erstellen, Bearbeiten und Löschen

In der WebTSM Services API können Attribute über folgende Pfade Zeitreihen zugewiesen werden:

• /repositories/:repository/timeseries/:id|name/attributes

  • > GET: liest alle Attribute einer Zeitreihe aus

  • > POST: wenn in Body ein Einzelattribut > weist ein neues Attribut zu oder wenn in Body ein Listenobjekt > überschreibt alle zugewiesenen Attribute der Zeitreihe

    

    Anmerkung

    Wird via POST eine leere Liste übermittelt, so werden alle Attributszuweisungen der jeweiligen Zeitreihe gelöscht

• /repositories/:repository/timeseries/:id|name/attributes/:id

  • > GET: liest ein bestimmtes Attribute einer Zeitreihe aus

  • > DELETE: löscht ein bestimmtes Attribut

• /repositories/:repository/timeseries/:id|name/attributes/:id/values

  • > GET: liest alle Werte aus (Response enthält nur eine "Dictionary" der Werte mit deren jeweiligen Gültigkeiten – siehe unten)

  • > PUT: überschreibt alle zugewiesenen Werte des Attributs

  • > DELETE: löscht alle zugewiesenen Werte für das jeweilige Attribut

• /repositories/:repository/timeseries/:id|name/attributes/:id/values/:key

  • > GET: ruft den zugewiesenen Wert eines Attributs zum gewählten Stichtag (Schlüssel) aus

  • > PUT: überschreibt den zugewiesenen Wert eines Attributs zum gewählten Stichtag

  • > DELETE: löscht den zugewiesenen Wert zum gewählten Stichtag inklusive Stichtag.

• /repositories/:repository/trees

  • > GET: liest die Hauptknoten aller definierten Hierarchien aus

  • > POST: legt einen neuen Haupknoten für einen neuen Baumstruktur an

• /repositories/:repository/trees/:id|name

  • > GET: liest den Hauptknoten der gewählten Hierarchie aus

  • > PUT: überschreibt den Haupknoten der gewählten Hierarchie 

  • > DELETE: löscht den gewählten Hauptknoten

• /repositories/:repository/trees/:id|name/nodes

  • > GET: liest den kompletten Baumstruktur der gewählten Hierarchie aus

  • > POST: überschreibt den kompletten Baumstruktur der gewählten Hierarchie

Mehr über Attribute erfahren Sie hier: Zeitreihen Erstellen, Bearbeiten und Löschen

Wir empfehlen folgendes Video unter Video Tutorials:

• Attributes

Erweiterte Zeitreihen-Attributsuche

Die erweiterte Zeitreihen-Attributsuche ermöglicht eine granularere und präzisere Suche nach Zeitreihen mithilfe von Attributen, deren Werten und Zeitstempeln als Filter. Im Gegensatz zur regulären Zeitreihen-Attributsuche, bei der nur 2 Attribute als Filter verwendet werden können, erlaubt die erweiterte Zeitreihen-Attributsuche die Definition einer unbegrenzten Anzahl von Attributen. Zusätzlich ist es möglich, Wildcards (_, %, ?, *) in Attributnamen und -werten zu verwenden. Bei der Suche mit angegebenen Attributwerten kann auch ein Zeitstempel hinzugefügt werden, der angibt, zu welchem Zeitpunkt der Wert für eine Zeitreihe übereinstimmen muss.

Hinweis

Die erweiterte Zeitreihen-Attributsuche ist nur in der TSM App bei Verwendung einer HTTP-API-Verbindung der Version 4.10+ verfügbar.

Die erweiterte Zeitreihen-Attributsuche ist im Reiter Suche des Fensters Zeitreihensuche über die Schaltfläche Zusätzliche Attribute… erreichbar.

Attribute können in mehrere Mengen gruppiert werden:

• Innerhalb dieser Mengen werden die Attribute mit einem logischen ODER-Operator verknüpft, was bedeutet, dass mindestens eine der innerhalb der Menge definierten Bedingungen erfüllt sein muss, damit eine Zeitreihe in den Suchergebnissen erscheint.

• Mengen von Attributen hingegen werden mit einem logischen UND-Operator verknüpft. Folglich erscheint eine Zeitreihe nur dann in den Suchergebnissen, wenn jede definierte Menge zu wahr ausgewertet wird.

In der regulären Zeitreihen-Attributsuche definierte Attribute tragen ebenfalls zum Zeitreihen-Suchfilter bei. Sie werden mit der erweiterten Zeitreihen-Attributsuche über einen logischen UND-Operator verknüpft.