User Guide

Al entrar en el menú de cálculo personalizado, el gráfico de enfoque se sustituye completamente por el panel de desarrollo de scripts, que consta de 2 pestañas:

Su script de python personalizado puede copiarse o crearse desde cero en el editor en la pestaña de código. El resaltado de sintaxis de Python está habilitado de base para aumentar la legibilidad. Consulte la siguiente sección para saber cómo debe configurarse un script para obtener un tag de TrendMiner utilizable. El botón de ejecución de la parte derecha puede utilizarse para ejecutar el script actual y abrirá automáticamente la pestaña de vista previa. Aunque puede ejecutarse cualquier script sin salida gráfica, el objetivo principal de esta función es crear un nuevo tag, por lo que debe proporcionarse el conjunto de marcas de tiempo y valores . Si se proporcionan, la pestaña de vista previa mostrará un gráfico del comportamiento del script del tag basado en la hora de inicio y fin aplicada en los ajustes de vista previa.

Puede alternar entre el código y la pestaña de vista previa. El script sólo se ejecutará al hacer clic en ejecutar. En la pestaña de vista previa se muestra una marca de tiempo para indicar cuándo se ejecutó el script por última vez.

Por defecto, la configuración de la vista previa abarca las últimas 8 horas. Las fechas de inicio y fin pueden modificarse para comprobar un periodo de interés personalizado. Sin embargo, el lapso de tiempo total del modo de vista previa está limitado a 1 mes.

Se pueden añadir declaraciones de impresión al script para ayudar durante el desarrollo. Estas declaraciones de impresión, así como los errores se mostrarán debajo del gráfico en caso de que sean aplicables. Si no hay errores y no se utilizan declaraciones de impresión, estos cuadros de texto se omitirán.

Aunque el comportamiento principal del cálculo personalizado estará influido por el propio script, hay 2 configuraciones que deben especificarse en el menú de la izquierda.

Tipo de tag

El tipo de tag determina cómo se interpolarán los datos proporcionados por el tag. Los datos se interpolarán linealmente (Tag analógico), o de forma escalonada (Tag discreto). Actualmente no es posible guardar el tag como String o Digital.

Dependencias de los tags

En la sección de dependencias de tags, debe seleccionar todos los tags a los que se accede en su script. Esto es diferente en comparación con todos los demás tipos de Generador de Tags, donde las dependencias de variables mapeadas se detectan automáticamente como parte del flujo de creación de un tag. Con los cálculos personalizados, TrendMiner no puede deducir qué tags se están utilizando. Esta información es crucial en caso de que se utilice un cálculo personalizado dentro de un Monitor. En ese caso, TrendMiner necesita asegurarse de que el índice del cálculo personalizado, así como todas las dependencias, están actualizados. El número máximo de dependencias para el cálculo personalizado está fijado en 50.

Al crear un nuevo cálculo personalizado, se proporcionará un script marcador de posición en el editor. Se trata de un ejemplo ficticio que contiene todos los elementos necesarios para crear y guardar correctamente un tag de cálculo personalizado. Siéntase libre de experimentar con este script para comprender cómo funciona la creación de series temporales.

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) 

Basándonos en este ejemplo ficticio, los siguientes elementos son obligatorios:

Además de estos elementos, la salida generada también debe cumplir los siguientes requisitos. Si no es así, tanto la previsualización como la indexación del tag fallarán.

Aparecerán mensajes de error claros al ejecutar el script si no se cumplen los requisitos.

Para llevar a cabo su caso de uso, puede ampliar el script mínimo viable en función de sus necesidades. Dispone de un conjunto predeterminado de paquetes de Python. No se pueden instalar paquetes adicionales.

Paquetes disponibles

Además, SDK de TrendMiner está disponible, lo que le permite extraer fácilmente datos de TrendMiner, como datos de índice de etiquetas.

Para obtener una descripción general actualizada de los paquetes disponibles y su versión, puede incluir el siguiente fragmento de código en su script:

import importlib.metadata

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

Para configurar correctamente un script de cálculo personalizado, es importante comprender cómo se indexarán estos tags. Para saber más sobre la indexación en sí, consulte este artículo.

En cuanto se guarde el tag de cálculo personalizado, el tag comenzará la indexación. Inicialmente, el proceso de indexación hará un backfill histórico (es decir, indexación hacia atrás). Esto se hace ejecutando el script por mes. Los parámetros START_TIMESTAMP y END_TIMESTAMP de su script serán siempre la hora de inicio y fin de un mes durante este proceso. Los tags indexados se mantendrán actualizados automáticamente (es decir, indexación hacia adelante). Por defecto, se realiza una comprobación de nuevos datos cada hora. En caso de que su Tag esté siendo utilizado en un Monitor, esto se hará cada 2 minutos. En este caso, START_TIMESTAMP y END_TIMESTAMP serán la marca de tiempo del último punto de índice almacenado y el momento actual, respectivamente. Aunque TrendMiner comprobará si hay datos nuevos cada hora (o cada 2 minutos), el periodo real en el que se ejecutan los scripts puede ser más largo, dependiendo de dónde se almacenó el último punto de datos.