7.1 Eventos

Eventos

 
Los eventos son todas las acciones o procesos que realiza un actor en el negocio y que nos proporcionan información sobre él. También incluyen las acciones o procesos que generamos sobre el actor. En resumen, todas las actividades diarias en un negocio pueden considerarse eventos.
Sepiia captura estos eventos para automatizar otras acciones, que se pueden configurar mediante reglas y condiciones. Técnicamente, los eventos son modificaciones a las tablas de la base de datos de cada actor.
Para cada evento, debemos crear un archivo en formato JSON que debe seguir la siguiente estructura:
 
{
  "elementType": "PREDIO",
  "operationId": "15",
  "event": "CIERRE",
  "eventLabel": "Cierre gasto",
  "eventBase64Image": "",
  "category": "TRANSAC",
  "checkBigdataStructure": true,
  "checkNewAttributes": true,
  "categoryLabel": "Acciones transaccionales",
  "categoryBusinessTrx": true,
  "user": "[email protected]",
  "channels": [
    {
      "code": "MAIL",
      "label": "Correo periodico",
      "active": true
    },
    {
      "code": "_APP_",
      "label": "App móvil",
      "active": true,
      "base64Image": ""
    }
  ],
  "ruleLevels": [
    {
      "name": "Estrategias de negocios",
      "category": "COMMERCIAL"
    },
    {
      "name": "Procesos internos",
      "category": "TECHNICAL"
    }
  ],
  "clearRuleLevels": true,
  "attributes": [
    {
      "code": "ITEM_CC"
    },
    {
      "code": "ITEM_NAM"
    },
    {
      "code": "ITEM_COD",
      "elementCategory": "a"
    },
    {
      "code": "PRED_COD",
      "elementCategory": "p",
      "value": "cheq-01"
    }
  ],
  "loadAttributes": [
    {
      "key": "PRED_COD_ITEM",
      "elementCategory": "a",
      "value": "cheq-01"
    }
  ]
}
Parámetro
Descripción
“elementType”: "CLIENTES"
Código del actor al cual estará asociado el evento.
“operationId”: "12"
Código de la organización.
“event”: "VENTAS"
Código del evento, debe tener como máximo 17 caracteres.
“eventLabel”: "Venta de productos"
Nombre del evento.
“eventBase64Image”:
Ícono que represente el Evento, estará disponible a futuro, por ahora dejarlo en blanco.
category: "VENTAS"
Código de la agrupación de Eventos, lo cual puede perfilarse para los usuarios, ver Ejemplo Agrupación de Eventos en la Plataforma.
categoryLabel: "Venta de productos"
Nombre de la agrupación de Eventos, lo cual puede perfilarse para los usuarios, si el valor va vacío lo crea.
checkBigdataStructure:true
true = valida consistencia de bases de datos, false = no hace la validación, éste último se usa cuando son millones de repeticiones de evento.
checkNewAttributes:true
true = valida la existencia de un atributo que almacena resultados de fórmulas hechas por el usuario, false = no hace la validación, éste último se usa cuando son millones de repeticiones de eventos.
categoryBusinessTrx : true
true = cuando el evento es una transacción comercial o transacción de otro tipo y deja un registro en la tabla de transacciones por Actor, false = si no corresponde a una transacción.
user: "[email protected]"
Usuario de la Organización.
traceLevel: 4
ANALYSIS  Solo guarda el registro del análisis en BD Bigdata = 1,PROVISION Solo guarda el registro de las acciones ejecutadas  en BD Bigdata = 2, ANA_PROV  Guarda el registro del análisis y de las acciones en BD Bigdata = 3, STRUCTURED  Guarda registro de todos los pasos ejecutados en BD Bigdata = 4
channels:
Son los canales donde se activa el evento o recibe la información.
code: "MAIL"
Código del canal donde se activa o triggerea el Evento. Ejemplos: _MAIL_, _APP_, _WEB_. Si este ya se creo para la organización solo se debe colocar el code.
label: "Correo periódico"
Nombre del Canal.
active: true
Valores: true, false. True si está activo, false si está inactivo.
ruleLevels:
Niveles de reglas: una forma de agrupación de las Reglas y Estrategias, lo cual puede perfilarse para los usuarios, ver imagen de ejemplo. Pueden existir varias agrupaciones en función de la naturaleza de las Reglas y Estrategias a configurar para cada Grupo de Eventos..
name: "Campañas y promociones"
Corresponden al nombre de los Niveles de Reglas.
category: "COMMERCIAL"
Hay dos tipos de categorías COMMERCIAL y TECHNICAL.
clearRuleLevels: true
true = te permite modificar la cantidad de Niveles de reglas configurados, dejando la última publicación, false = no va permitir modificar la cantidad de Niveles después de la última publicación.
attributes:
Corresponde  a lista de campos configurados en la Tabla del actor relacionado al Evento.
code: "FECHA_VTA"
Código del atributo, debe ser único para toda la organización independiente del tipo de actor, se recomienda que sea corto, usar letras, números y guión, y no usar carácteres especiales como espacio, ñ, tildes, símbolos.
elementCategory: "p"
Un evento debe estar relacionado a uno o más actores, pero uno de ellos será el principal (p) y los otros secundarios (a). Valores: n = ninguno, p = principal, a = adicional. Se usa acompañando el código del atributo para indicar si este es el atributo principal (p), key del actor al cual está relacionado el Evento. O para indicar si hay algún atributo key de un actor relacionado pero de forma secundaria, en este caso se coloca a.
loadAttributes:
Se ocupa cuando requiero llamar a otros atributos tanto del actor principal como de otros actores y rescato el valor de la base de datos, y estos atributos no vienen dentro los campos que nos proporcionará el Evento que estamos configurando.
key:"USR_COD_ASIG"
Código del atributo.
value: "@@USR_COD_ASIG@@"
Si hay algún valor pre-establecido que queremos que ese atributo adquiera.
 
Ejemplo de agrupación de eventos en la plataforma.
Ejemplo de agrupación de eventos en la plataforma.
 
En este ejemplo las Agrupaciones de Eventos corresponden a:
  • Procesos automáticos.
  • Actividades de usuario.
  • Acciones del cliente.
  • Colección de APIs de flujos.
  • Venta de productos.
Dentro de cada agrupación existen uno o más Eventos.
Ejemplo de Agrupación de Niveles de Reglas y Estrategias en la Plataforma.
Ejemplo de Agrupación de Niveles de Reglas y Estrategias en la Plataforma.

Tipos de eventos

Existen dos tipo de eventos:
  • Eventos de configuración
      • Son eventos que crean nuevos registros de los actores en la base de datos o actualizan los existentes. En los eventos de actualización, pueden incluirse datos de otros actores, marcándolos con "elementCategory": "a", lo que significa que esos atributos no se actualizarán.
  • Eventos transaccionales
      • Estos eventos registran acciones que ocurren y afectan a uno o más actores en la empresa. Pueden incluir nuevos datos no previamente relacionados. Es importante usar "elementCategory": "p" o "elementCategory": "a" para indicar que son actores. El "p" se usa para el atributo del actor que está directamente relacionado y que crea el evento transaccional.
 
Tabla de contenido