Mode d'emploi

Lorsque vous entrez dans le menu de calcul personnalisé, le Graphique de focus est complètement remplacé par le panneau de développement de script, composé de 2 onglets :

Votre script python personnalisé peut être copié ou créé à partir de zéro dans l'éditeur sur l'onglet code. La coloration syntaxique de Python est activée d'emblée pour améliorer la lisibilité. Veuillez vous référer à la section suivante pour apprendre comment un script doit être configuré pour produire un Tag TrendMiner utilisable. Le bouton "Run" sur le côté droit peut être utilisé pour exécuter le script actuel et ouvrira automatiquement l'onglet de prévisualisation. Bien que tout script sans sortie graphique puisse être exécuté, l'objectif principal de cette fonctionnalité est de créer un nouveau tag, et l'ensemble des horodatages et des valeurs doit donc être fourni. S'ils sont fournis, l'onglet de prévisualisation affichera un graphique du comportement du script du tag en fonction de l'heure de début et de fin appliquée dans les paramètres de prévisualisation.

Vous pouvez passer de l'onglet "code" à l'onglet "Prévisualisation". Le script ne sera exécuté que si vous cliquez sur Exécuter. Un horodatage est affiché dans l'onglet de prévisualisation pour indiquer quand le script a été exécuté pour la dernière fois.

Par défaut, les paramètres de prévisualisation couvrent les 8 dernières heures. Les dates de début et de fin peuvent être modifiées pour tester une période d'intérêt personnalisée. La durée totale du mode de prévisualisation est toutefois limitée à 1 mois.

Des instructions d'impression peuvent être ajoutées au script pour faciliter le développement. Ces instructions d'impression, ainsi que les erreurs, seront affichées sous le graphique si elles sont applicables. Si aucune erreur n'est présente et qu'aucune instruction d'impression n'est utilisée, ces zones de texte seront omises.

Bien que le comportement principal du calcul personnalisé soit influencé par le script lui-même, deux configurations doivent être spécifiées dans le menu de gauche.

Type de Tag

Le type de tag détermine la manière dont les données fournies du tag seront interpolées. Les données seront interpolées linéairement (tag analogique) ou par échelons (tag discret). La possibilité d'enregistrer le tag en tant que chaîne ou tag digital n'est pas prise en charge actuellement.

Dépendances des Tag

Dans la section dépendances des tags, vous devez sélectionner tous les tags auxquels votre script accède. Ceci est différent par rapport à tous les autres types de créateur de tags, où les dépendances sur les variables mappées sont automatiquement détectées dans le cadre du flux de création d'un tag. Avec les calculs personnalisés, TrendMiner ne peut pas déduire quels tags sont utilisées. Cette information est cruciale dans le cas où un calcul personnalisé est utilisé dans un Monitoring. Dans ce cas, TrendMiner doit s'assurer que l'index du calcul personnalisé ainsi que toutes les dépendances sont à jour. Le nombre maximum de dépendances pour un calcul personnalisé est fixé à 50.

Lors de la création d'un nouveau calcul personnalisé, un script de remplacement sera fourni dans l'éditeur. Il s'agit d'un exemple factice, contenant tous les éléments nécessaires à la création et à l'enregistrement corrects d'un Tag de calculs personnalisés. N'hésitez pas à expérimenter avec ce script pour comprendre comment fonctionne la création de séries temporelles.

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) 

Sur la base de cet exemple fictif, les éléments suivants sont obligatoires :

Outre ces éléments, la sortie générée doit également répondre aux exigences suivantes. Si ce n'est pas le cas, la prévisualisation et l'indexation du Tag échoueront.

Des messages d'erreur clairs apparaissent lors de l'exécution du script si les conditions requises ne sont pas remplies.

Pour réaliser votre cas d'utilisation, vous pouvez étendre le script minimum viable en fonction de vos besoins. Un ensemble de paquets Python est disponible par défaut. Il n'est pas possible d'installer des paquets supplémentaires.

Formules disponibles

En outre, SDK TrendMiner est disponible, ce qui vous permet d'extraire facilement des données TrendMiner, comme les données d'index des balises.

Pour obtenir une vue d'ensemble actualisée des packages disponibles et de leur version, vous pouvez inclure l'extrait de code suivant dans votre script :

import importlib.metadata

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

Afin de configurer correctement un script de calcul personnalisé, il est important de comprendre comment ces Tag seront indexés. Pour en savoir plus sur l'indexation elle-même, veuillez consulter cet article.

Dès que le Tag de calcul personnalisé est sauvegardé, il commence à être indexé. Dans un premier temps, le processus d'indexation effectuera un backfill historique (c'est-à-dire une indexation en arrière). Pour ce faire, le script est exécuté chaque mois. Les paramètres START_TIMESTAMP et END_TIMESTAMP de votre script correspondront toujours au début et à la fin d'un mois au cours de ce processus. Les tags indexés seront automatiquement mis à jour (c'est-à-dire l'indexation en avant). Par défaut, une vérification des nouvelles données est effectuée toutes les heures. Si votre Tag est utilisé dans un Monitoring, cette vérification sera effectuée toutes les 2 minutes. Dans ce cas, START_TIMESTAMP et END_TIMESTAMP correspondent respectivement à l'horodatage du dernier point d'index enregistré et à l'instant présent. Bien que TrendMiner recherche de nouvelles données toutes les heures (ou 2 minutes), la période réelle d'exécution des scripts peut être plus longue, en fonction de l'endroit où le dernier point de données a été stocké.