Notificaciones de plataforma y workflows

El siguiente paso en la configuración del modelo operativo de gobierno en Anjana Data consiste en definir las notificaciones que permiten informar a los usuarios sobre eventos, flujos de validación (workflows) o incidencias en la plataforma.

Las notificaciones son un mecanismo clave para garantizar la trazabilidad y la comunicación dentro del gobierno de datos, ya que avisan a los usuarios o a roles completos de acciones como la expiración de un objeto, la creación de un workflow, el fallo en una adherencia, la modificación de políticas o la caducidad de una licencia.

En Anjana Data, las notificaciones se configuran en la tabla Notifications del panel de configuración y estarán disponibles posteriormente en el portal de datos para los usuarios afectados.

Tabla Notifications del Panel de Configuración (Visión administrador)

Las notificaciones se configuran en la tabla Notifications del panel de configuración. La definición de los notificaciones es un paso indispensable para poder configurar los workflows en el BPM y para que los usuarios clave reciban notificaciones de su interés.

Estructura de la tabla Notifications

Cada notificación registrada en la tabla se caracteriza por los siguientes campos:

• id: identificador único de la notificación (PK).

• moduleType: módulo al que aplica la notificación. Actualmente es un campo informativo (legacy) heredado de versiones antiguas. Valores posibles:

  • "BG" → Business Glossary

  • "DC" → Data Catalog

  • "ALL" → aplica a toda la plataforma (opción recomendada).

• notificationCode: código alfanumérico que identifica la notificación y permite invocarla desde las funcionalidades de la plataforma.

• notificationReceiverType: define el tipo de destinatario. Valores posibles:

  • "USER" → la notificación se envía a un usuario específico.

  • "ROLE" → la notificación se envía a todos los usuarios que tengan asignado el rol indicado.

• translationKey: clave de traducción que enlaza con el texto del mensaje en la tabla InternalTranslation. El texto puede contener variables que serán sustituidas en el momento de emisión de la notificación.

• notificationType: tipo de notificación. Valores posibles:

  • "ALERT" → alerta

  • "NOTICE" → aviso

  • "ADMIN_ALERT" → alerta dirigida a administradores

• receiverRole: rol destinatario de la notificación (si el notification_receiver_type es ROLE). Debe coincidir con el name de la tabla Roles.

• severity: nivel de criticidad de la notificación.

• subject: clave de traducción que enlaza con el texto del mensaje en la tabla InternalTranslation que contiene el asunto de la notificación.

• externalSending: permite habilitar el envío de notificaciones por canales externos. Para activarlo, incluya las claves de los proveedores externos separadas por comas. Por ejemplo, para enviar a los proveedores disponibles: EMAIL, SLACK, MICROSOFT_TEAMS, GOOGLE_CHAT. Si está vacío, no se enviará a ningún proveedor externo. Consulte la lista de proveedores disponibles.

Códigos de notificación (notificationCode)

Para el correcto funcionamiento de la aplicación, la tabla Notifications debe contener registros que correspondan con una serie de notificationCode predefinidos.

Variables para las Key de InternalTranslation como parte del cuerpo de la notificación

Adicionalmente, los cuerpos de los mensajes de notificación definidos mediante las claves de traducción (campo Key de la tabla de Translations ) pueden contener variables dinámicas delimitadas por ##. Estas variables serán sustituidas automáticamente por los valores correspondientes en el momento de generar y enviar la notificación.

Por ejemplo:

“Ocurrió un error en el borrado del workflow con id #OBJECT_ID#”.

En caso de que una variable se incluya en un mensaje en el que no tenga valor aplicable, será sustituida por N/A.

A continuación se detallan las distintas variables que soporta Anjana Data para su uso en las notificaciones:

Notificaciones nativas

Anjana Data incorpora de forma nativa una gran cantidad de notificaciones basadas en ROLE para cubrir los principales eventos de gobierno de datos (creación, borrado, expiración, workflows, errores, etc.).

Es responsabilidad del administrador funcional configurar correctamente el campo receiver_role en cada notificación, de modo que los mensajes lleguen a los stakeholders adecuados según el modelo operativo de gobierno definido por la organización.

Una asignación incorrecta o incompleta puede provocar que los usuarios no reciban alertas críticas o, por el contrario, que se sobrecarguen con notificaciones que no les corresponden.

Alta de una nueva Notificación en la tabla Notifications

El alta de una nueva notificación (por ejemplo, una alerta para validar un paso de workflow) implica:

1. Añadir un registro en la tabla Notifications con los datos básicos de la notificación.

2. Configurar las claves de traducción asociadas a la notificación (translationKey y subject) en la tabla InternalTranslation, para todos los idiomas que utilice la organización en Anjana Data (tabla Languages).

Para añadir el registro en la tabla Notifications y dar de alta una nueva notificación:

1. Pulsar el botón New en la esquina superior derecha. Esto abrirá un asistente (wizard) con los campos definidos en el apartado Estructura de la tabla Notifications.

2. Completar los campos de la notificación conforme a la estructura descrita en el apartado anterior.

3. Pulsar en Save para guardar la notificación o en Cancel para descartar.

Configuración de traducciones para notificaciones

Una vez creada la notificación en la tabla Notifications, deben definirse los textos que recibirá el usuario: el cuerpo del mensaje (clave translationKey) y el asunto (clave subject), en cada uno de los idiomas configurados en la plataforma.

Esta configuración se realiza desde el Portal de Administración, en la sección Internacionalización, accesible desde el menú de navegación del Portal de Datos.

Para cada notificación se crea una traducción, tanto para el cuerpo como para el asunto, cumplimentando los siguientes campos:

• Clave: debe coincidir con el valor definido en la notificación (translationKey para el cuerpo y subject para el asunto).

• Uso: texto descriptivo que ayude a identificar que la traducción corresponde a una notificación. Se recomienda definir un estándar de nomenclatura para mantener un vocabulario común de referencia.

• Idioma (English y resto de idiomas configurados): texto que recibirá el usuario según el idioma establecido en su perfil.

El cuerpo del mensaje admite variables dinámicas delimitadas por # (por ejemplo, #OBJECT_ID#), tal como se describe en apartados anteriores.

Modificación de una Notificación

La modificación del asunto o del cuerpo de una notificación no tiene impacto en la configuración, siempre que no se alteren las claves de traducción (translationKey o subject). En ese caso basta con actualizar el texto del idioma correspondiente, desde la sección Internacionalización del Portal de Administración, mediante una de estas dos opciones:

• Edición directa del texto en el campo editable.

• Edición mediante asistente: al pulsar el icono del lápiz se abre un wizard que permite editar los textos en los distintos idiomas.

Si, por el contrario, es necesario modificar las claves de traducción (translationKey o subject), deberán aplicarse los cambios tanto en la notificación (tabla Notifications) como en sus traducciones.

Consulta y explotación de las notificaciones en base de datos (Visión desarrollador)

Además de configurarse desde el Panel de configuración, la información de las notificaciones queda almacenada en la base de datos y puede consultarse en modo lectura para explotarla con fines analíticos. Por ejemplo, permite que el cliente construya su propio data mart, cuadros de mando o informes sobre la configuración de notificaciones de su plataforma (qué eventos se notifican, a qué roles, con qué criticidad, por qué canales, etc.).

Tabla hermes.notification

La configuración de cada notificación se almacena en la tabla hermes.notification. Sus columnas, disponibles para su consulta, son:

Tablas relacionadas para enriquecer las consultas

Para obtener una vista más completa, la tabla de notificaciones puede cruzarse con otras tablas del modelo:

• InternalTranslation: contiene el texto del cuerpo y del asunto de cada notificación por idioma. Se cruza enlazando translation_key y subject con el campo key de la tabla, filtrando por el idioma deseado (campo language). Permite recuperar el mensaje final que ve el usuario.

• Roles: permite resolver el receiver_role con el detalle del rol destinatario (enlazando con su campo name).

• Languages: lista de idiomas configurados en la plataforma, útil para acotar las consultas de textos por idioma.

Ejemplos de consulta

Listado completo de las notificaciones configuradas, con su tipo, destinatario y criticidad:

SELECT id_notification,
       module_type,
       notification_code,
       notification_receiver_type,
       receiver_role,
       notification_type,
       severity,
       external_sending
FROM hermes.notification
ORDER BY id_notification;

Notificaciones dirigidas a un rol concreto:

SELECT notification_code, notification_type, severity
FROM hermes.notification
WHERE notification_receiver_type = 'ROLE'
  AND receiver_role = 'DataOwner';

Recuento de notificaciones por módulo y tipo (útil como métrica para un data mart):

SELECT module_type,
       notification_type,
       COUNT(*) AS total
FROM hermes.notification
GROUP BY module_type, notification_type
ORDER BY module_type, notification_type;

Notificaciones con envío por canales externos configurado:

SELECT notification_code, notification_type, external_sending
FROM hermes.notification
WHERE external_sending IS NOT NULL
  AND external_sending <> '';