Skip to content

Ejemplos

Cómo crear la plantilla HTML de un informe

El código de la plantilla debe estar en formato HTML e incluir etiquetas de plantilla Jinja2. A continuación se muestra un ejemplo de plantilla HTML que se puede usar para generar el informe de un activo:

<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="UTF-8">
    <meta name="viewport" content="width=device-width, initial-scale=1.0">
    <title>Asset Report</title>
    <style>
        body {
            font-family: Arial, sans-serif;
            margin: 20px;
        }
    </style>
</head>
<body>
<h1>Report for Asset: {{ asset_name }}</h1>
<p>Date: {{ report_date }}</p>
<p>Generated by: {{ user_name }}</p>

<h2>Asset Details</h2>
<table>
    <tr>
        <th>Attribute</th>
        <th>Value</th>
    </tr>
    <tr>
        <td>Asset ID</td>
        <td>{{ asset_id }}</td>
    </tr>
</table>

<h2>Performance Metrics</h2>
<table>
    <thead>
    <tr>
        <th>Metric</th>
        <th>Value</th>
    </tr>
    </thead>
    <tbody>
    {% for metric, value in performance_metrics.items() %}
    <tr>
        <td>{{ metric }}</td>
        <td>{{ value }}</td>
    </tr>
    {% endfor %}
    </tbody>
</table>
</body>
</html>

Cómo crear la plantilla en un notebook de Python

Para crear el notebook, es necesaria la siguiente configuración en la primera celda:

#Environment
asset_id = "$ASSET_ID"  # ID del activo para el que se genera el informe
start_ts = "$FROM_DAY"  # Fecha de inicio del informe
end_ts = "$TO_DAY"  # Fecha de fin del informe
base_url = "$BASEURL"  # URL base de la API
token = "$TOKEN"  # Token API Key para la autenticación

Explicación:

  • Las variables anteriores son marcadores de posición que deben sustituirse por valores reales al ejecutar en local.
  • Para pruebas en local, puedes asignar estos valores manualmente para probar el código.

Así puedes asignar valores locales para ejecutar el notebook:

#NoExecute
token = "fake_token"
asset_id = 'fake_asset_id'
start_ts = "2024-09-12"
end_ts = "2024-09-16"
base_url = 'https://mycircutor.com'

Esta celda está marcada con #NoExecute para que no se ejecute en producción, pero se pueda usar en pruebas locales.

Generar las variables de salida para el HTML

Para generar un archivo que contenga las variables necesarias para el HTML, puedes usar el siguiente código:

output = {
    'report_date': "value",
    'asset_name' : "value",
}
with open("output.json", "w") as f:
    f.write(json.dumps(output))

Renderizar la plantilla HTML en local

Para generar un archivo HTML en local y comprobar que las plantillas son correctas, añade la siguiente celda. Se recomienda solo para pruebas locales:

#NoExecute
from jinja2 import Environment, PackageLoader, select_autoescape, FileSystemLoader

jinja2_env = Environment(loader=FileSystemLoader("."), autoescape=select_autoescape())
template = jinja2_env.get_template("template.html")
html = template.render(output)
with open("sample.html", "w") as f:
    f.write(html)

Llamadas a la API para obtener datos

Este es un ejemplo de cómo hacer una llamada a la API para obtener los datos necesarios para el informe:

def request_metric_v3(variables, aggregation, bucket):
    url_request = "{base_url}/api/v2/assets/{id}/metricsv3/aggregate/{aggregation}/{bucket}?vars={variables}&from={start_ts}T00:00:00&to={end_ts}T00:00:00".format(
        base_url=base_url, id=asset_id, aggregation=aggregation, bucket=bucket,
        variables=variables, start_ts=start_ts, end_ts=end_ts)
    response_metrics = requests.get(url_request, headers={'X-API-KEY': token})

df_flicker_severity = request_metric_v3("PLT_AN,PLT_BN,PLT_CN", "avg", "hour")

def metric_metric_raw_v3(variables):
    url_request = "{base_url}/api/v2/assets/{id}/metricsv3/raw?vars={variables}&from={start_ts}T00:00:00&to={end_ts}T00:00:00".format(
        base_url=base_url, id=asset_id, variables=variables, start_ts=start_ts, end_ts=end_ts)
    response_metrics = requests.get(url_request, headers={'X-API-KEY': token})

df_frequency, is_data_accepted = metric_metric_raw_v3("FREQ")

Aclaraciones:

  • request_metric_v3: esta función obtiene datos agregados (por ejemplo, valores medios).
  • metric_metric_raw_v3: esta función obtiene datos en bruto (por ejemplo, puntos de datos individuales).
  • Ambas funciones usan la API key (token) y la URL base para autenticar las peticiones.

Cómo subir la plantilla a un proyecto

Para crear un informe, sube a la plataforma un archivo ZIP que contenga tanto el HTML como el notebook. Ve al proyecto concreto, entra en la sección "Templates" y selecciona "Upload New Version" para enviarlo. En esta misma sección también puedes actualizar plantillas existentes: elige la plantilla que quieres actualizar y sigue el proceso para subir una nueva versión.

Cómo generar un informe para un activo

Para generar un informe, ve a la sección "Reports" de una edición. A continuación, selecciona el tipo de informe que quieres generar, elige el activo correspondiente y establece el rango de fechas.