Creación de una Entidad de tipo KPI

Creación de una Entidad de tipo KPI

Desde la versión 3.1.0-KickOff, en el Control Panel se ha pasado a denominar a las Ontologías como «Entidades». Esto no altera ninguna funcionalidad; simplemente se ha cambiado la nomenclatura para un mejor entendimiento del concepto.

Interfaz de usuario: 5.3.2-Ultimate

Introducción

Un KPI (Key Performance Indicator) consiste básicamente en una métrica que nos ayuda a medir y a cuantificar un progreso en función de unas metas y objetivos planteados, es decir, un KPI se diseña para mostrar cómo es el progreso en un proceso o producto en concreto.

Los KPIs son ampliamente usados en el mundo del márquetin; los KPI son métricas específicas (cuantitativas y cualitativas) que permiten analizar cada uno de los canales de difusión, rendimiento, fidelización, posicionamiento y branding de nuestras campañas.

En general, buscamos que los objetivos de nuestra solución sean mediables y alcanzables, o dicho de otra forma, que sean «SMART»:

  • S de Specific (específicos).

  • M de Measurable (medibles).

  • A de Attainable (alcanzables).

  • R de Realist (realistas).

  • T de Timely (oportunos).

Pasos

Crear la Entidad

Desde el Control Panel, navegaremos al menú de Desarrollo > Mis Entidades.

image-20240315-092532.png

 

Esto nos llevará al listado de Entidades disponibles. Para crear la Entidad, pulsaremos en el botón de «+» situado en la parte superior derecha de la pantalla.

image-20240227-121951.png

De las distintas Entidades que vamos a poder crear, seleccionaremos la de «Creación de Entidad Tipo KPI»:

image-20240315-104623.png

Rellenar la información general

Esto nos abrirá el asistente de creación de Entidades, en donde en primer lugar tendremos que indicar si vamos a generar una nueva Entidad, o si queremos reutilizar alguna ya existente.

En caso de que vayamos a reutilizar una Entidad nueva, desmarcaremos el toggle switch de «Nueva Entidad», lo que habilitará un selector en donde podremos buscar la Entidad que queremos utilizar.

image-20240315-111127.png

En caso de que se vaya a crear una Entidad nueva, al igual que el resto de Entidades tendremos que introducir cierta información básica.

image-20240315-111101.png
  • Identificación: el nombre único con el que identificar a la Entidad.

  • Meta-Información: etiquetas con las que caracterizar la Entidad, que servirán para su filtrado a la hora de hacer búsquedas.

  • Descripción: texto descriptivo extendido de la Entidad, como su uso, propiedades, características, etc.

  • Instancia de base de datos: aquí se podrá indicar el tipo de base de datos a utilizar para esta Entidad.

Además, contamos con las opciones de caracterización de las Entidades:

  • Entidad activa: para que la Entidad funcione o se encuentre bloqueada.

  • Entidad pública: si queremos que la Entidad sea pública, o si la queremos privada.

  • Permitir campos cifrados: permite el uso de campos encriptados (más información).

  • Habilitar ContextData: si queremos que la Entidad registre internamente los cambios de escritura y gestión (más información).

Una vez definida la información general y las opciones de la Entidad, pulsaremos en el botón de «Continuar» para acceder a la configuración del KPI.

image-20240315-111225.png

Configuración del KPI

En esta pantalla, en primer lugar tendremos que definir el Cron Job del KPI; es decir, asignar una periodicidad de ejecución.

image-20240315-111706.png

Para esta guía, indicaremos una periodicidad diaria, a las 00:00:

image-20240315-111635.png

También vamos a poder seleccionar si la generación de este KPI se llevará a cabo entre un periodo de fechas concreto (por ejemplo, si estamos haciendo una campaña y nos interesa generar el KPI sólo durante unos días concretos):

image-20240315-111910.png

Seguidamente, debajo de estas opciones temporales, se encuentra una ventana de código en donde vamos a poder introducir una consulta, la cual se usará para indicar qué datos se van a extraer, su agrupación, transformación y agregación de otras Entidades que sirvan como base para la creación del KPI.

El resultado de esta consulta será lo que se almacene en la Entidad de tipo KPI que estamos generando.

Como ejemplo, digamos que interesa conocer de la Entidad de «Restaurants», la valoración que tienen los restaurantes por tipo de comida y barrio. Así, generaremos la siguiente consulta:

SELECT c.Restaurant.cuisine as cuisine, c.Restaurant.borough as borough, sum(c.Restaurant.grades[0].score) as score FROM Restaurants as c GROUP BY c.Restaurant.cuisine,c.Restaurant.borough

Si lanzamos la consulta, el resultado que obtendremos será el siguiente:

image-20240315-113237.png

Si necesitamos procesar la información de la consulta para adaptarla de algún modo, podemos activar el toggle switch de «Activar procesado» para habilitar una ventana de edición de código de JavaScript, en donde podremos modificar el resultado de la consulta:

image-20240315-113350.png

Una vez que la consulta esté al gusto de lo que necesitemos, pulsaremos el botón de «Crear» para terminar con la creación de la Entidad.

image-20240315-095454.png

Además, como con el resto de las Entidades, se mostrará una ventana con las opciones disponibles a realizar con la Entidad creada.

image-20240315-100324.png

Gestión del KPI

Tras crear la Entidad, volveremos al listado de Entidades en donde aparecerá listada, con sus propiedades. Ahí veremos que es de tipo KPI:

image-20240315-113935.png

La Entidad de KPI se estará ejecutando en función a la temporalidad asignada, almacenando los datos obtenidos por la consulta que hemos definido.

En las opciones de la entidad, vamos a poder detener la ejecución de la tarea pulsando en la opción de «Parar»:

image-20240315-114428.png

Para volver a activar la tarea, desde el mismo menú podremos hacerlo pulsando en «Empezar»:

image-20240315-115016.png

Además, en todo momento, vamos a poder ejecutar el KPI (para comprobar que funciona, por ejemplo), pulsando en «Ejecutar generación de KPI»:

image-20240315-115145.png