Benutzerhandbuch

Wenn Sie das Menü für benutzerdefinierte Berechnungen aufrufen, wird das Fokusdiagramm vollständig durch das Skriptentwicklungsfenster ersetzt, das aus 2 Registerkarten besteht:

Ihr benutzerdefiniertes Python-Skript kann im Editor auf der Registerkarte Code kopiert oder von Grund auf neu erstellt werden. Die Syntaxhervorhebung in Python ist standardmäßig aktiviert, um die Lesbarkeit zu erhöhen. Im nächsten Abschnitt erfahren Sie, wie ein Skript aufgebaut sein sollte, um einen brauchbaren TrendMiner-Tag zu erzeugen. Mit der Schaltfläche Ausführen auf der rechten Seite können Sie das aktuelle Skript ausführen und öffnen automatisch die Registerkarte Vorschau. Obwohl jedes Skript ohne grafische Ausgabe ausgeführt werden kann, besteht das Hauptziel dieser Funktion darin, einen neuen Tag zu erstellen, und daher sollten die Zeitstempel und Werte angegeben werden. Wenn Sie diese angeben, wird auf der Registerkarte Vorschau ein Diagramm des skriptgesteuerten Verhaltens des Tags auf der Grundlage der in den Vorschaueinstellungen angegebenen Start- und Endzeit angezeigt.

Sie können zwischen dem Code und der Registerkarte Vorschau wechseln. Das Skript wird nur ausgeführt, wenn Sie auf Ausführen klicken. Auf der Registerkarte Vorschau wird ein Zeitstempel angezeigt, der angibt, wann das Skript zuletzt ausgeführt wurde.

Die Standardeinstellungen für die Vorschau umfassen die letzten 8 Stunden. Die Start- und Enddaten können geändert werden, um einen benutzerdefinierten Zeitraum von Interesse zu testen. Die Gesamtzeitspanne des Vorschaumodus ist jedoch auf 1 Monat begrenzt.

Um die Entwicklung zu erleichtern, können Sie dem Skript Druckanweisungen hinzufügen. Diese Druckanweisungen sowie Fehler werden unterhalb des Diagramms angezeigt, wenn sie zutreffend sind. Liegen keine Fehler vor und werden keine Druckanweisungen verwendet, werden diese Textfelder nicht angezeigt.

Obwohl das Hauptverhalten der benutzerdefinierten Berechnung durch das Skript selbst beeinflusst wird, gibt es 2 Konfigurationen, die im linken Menü angegeben werden müssen.

Tag-Typ

Der Tag-Typ bestimmt, wie die Daten des Tags interpoliert werden. Die Daten werden linear (analoger Tag) oder schrittweise (diskreter Tag) interpoliert. Die Möglichkeit, den Tag als String oder digitalen Tag zu speichern, wird derzeit nicht unterstützt.

Tag-Abhängigkeiten

Im Bereich Tag-Abhängigkeiten sollten Sie alle Tags auswählen, auf die in Ihrem Skript zugegriffen wird. Dies ist ein Unterschied zu allen anderen Tag Builder-Typen, bei denen die Abhängigkeiten von zugeordneten Variablen automatisch als Teil des Erstellungsprozesses eines Tags erkannt werden. Bei benutzerdefinierten Berechnungen kann TrendMiner nicht ableiten, welche Tags verwendet werden. Diese Information ist wichtig, wenn eine benutzerdefinierte Berechnung in einem Monitor verwendet wird. In diesem Fall muss TrendMiner sicherstellen, dass der Index der benutzerdefinierten Berechnung sowie alle Abhängigkeiten auf dem neuesten Stand sind. Die maximale Anzahl von Abhängigkeiten für benutzerdefinierte Berechnungen ist auf 50 festgelegt.

Wenn Sie eine neue benutzerdefinierte Berechnung erstellen, wird im Editor ein Platzhalter-Skript bereitgestellt. Dabei handelt es sich um ein Dummy-Beispiel, das alle notwendigen Elemente enthält, um einen Tag für benutzerdefinierte Berechnungen korrekt zu erstellen und zu speichern. Sie können gerne mit diesem Skript experimentieren, um zu verstehen, wie die Erstellung von Zeitreihen funktioniert.

import numpy as np
import pandas as pd
import os

# Parameter configuration
output_file = os.environ["OUTPUT_FILE"] # Where to write output table
start = os.environ["START_TIMESTAMP"]   # Start datetime of range to compute values in
end = os.environ["END_TIMESTAMP"]       # End datetime of range to compute values in

# Code to compute table
num_points = 100
pd.DataFrame(
    {
        "ts": pd.date_range(start, end, num_points),
        "value": np.random.randn(num_points)
    }
).to_csv(output_file, index=False) 

Ausgehend von diesem Dummy-Beispiel sind die folgenden Elemente obligatorisch:

Neben diesen Elementen muss die generierte Ausgabe auch die folgenden Anforderungen erfüllen. Wenn dies nicht der Fall ist, schlägt sowohl die Vorschau als auch die Indexierung des Tags fehl.

Bei der Ausführung des Skripts erscheinen eindeutige Fehlermeldungen, wenn die Anforderungen nicht erfüllt sind.

Um Ihren Anwendungsfall fertigzustellen, können Sie die Mindestanforderungen an das Skript nach Ihren Bedürfnissen erweitern. Eine Reihe von Python-Paketen ist standardmäßig verfügbar. Zusätzliche Pakete können nicht installiert werden.

Verfügbare Pakete

Zusätzlich, TrendMiner SDK ist verfügbar, wodurch Sie TrendMiner-Daten, wie etwa Indexdaten von Tags, problemlos einbinden können.

Um einen aktuellen Überblick über die verfügbaren Pakete und ihre Version zu erhalten, können Sie den folgenden Codeausschnitt in Ihr Skript einfügen:

import importlib.metadata

installed_packages = importlib.metadata.distributions()
for package in installed_packages:
    print(package.metadata["Name"], package.version)

Um ein benutzerdefiniertes Berechnungsskript korrekt einzurichten, ist es wichtig zu verstehen, wie diese Tags indiziert werden. Wenn Sie mehr über die Indizierung selbst erfahren möchten, lesen Sie bitte diesen Artikel.

Sobald der benutzerdefinierte Berechnungs-Tag gespeichert ist, beginnt die Indizierung des Tags. Zunächst wird bei der Indizierung ein historischer Backfill (d.h. eine Rückwärtsindizierung) durchgeführt. Dies geschieht, indem das Skript jeden Monat ausgeführt wird. Die Parameter START_TIMESTAMP und END_TIMESTAMP in Ihrem Skript sind während dieses Prozesses immer die Start- und Endzeit eines Monats. Indizierte Tags werden automatisch auf dem neuesten Stand gehalten (d.h. Vorwärtsindizierung). Standardmäßig wird jede Stunde geprüft, ob neue Daten vorhanden sind. Falls Ihr Tag in einem Monitor verwendet wird, geschieht dies alle 2 Minuten. START_TIMESTAMP und END_TIMESTAMP sind in diesem Fall der Zeitstempel des letzten gespeicherten Indexpunkts bzw. des aktuellen Zeitpunkts. Obwohl TrendMiner jede Stunde (oder 2 Minuten) nach neuen Daten sucht, kann der tatsächliche Zeitraum, in dem die Skripte ausgeführt werden, länger sein, je nachdem, wo der letzte Datenpunkt gespeichert wurde.