Notificaciones ​

El servicio de envío de notificaciones nos permite enviar emails de forma individualizada o de forma masiva. Además nos permite gestionar plantillas predefinidas para el envío de notificaciones.

Modelos ​

Los modelos pretende ser la parte más técnica de una correo electrónico y por eso no es intención de este módulo que el usuario tenga que crearlo, solo tendrá que importarlo, delegando su creación a un especialista, técnico o en general a quién pueda corresponder la tarea de crear un fichero html que defina el formato y estilo del mensaje a enviar. En ningún caso estamos hablando de contenido ni de elementos dinámicos del mensaje, aquí solo se contemplan elementos estáticos que serán comunes al conjunto de mensajes que estén definidos bajo un modelo en cuestión.

La pantalla de modelos presenta un formato y funcionamiento similar al resto de Nautilus, en la que cada uno de los elementos a gestionar, en este caso modelos, se presentan mediante cards (una vez creadas).

Para la creación de un modelo hemos de pulsar al botón "+", ubicado en la parte inferior derecha. Al presiónar aparecerá la pantalla de detalle de modelo:

La pantalla de añadir un modelo y como se indicado es una interfaz para poder importar un fichero que será el modelo en cuestión.

Además de los campos de 'nombre del modelo' y 'descripción' cuya finalidad se entiende por su obviedad, tenemos dos campos más. El primero, 'Subir contenido', es el que nos pide el fichero html, el modelo. El segundo, 'Subir vista preliminar', espera una imagen que sea una previsualización del modelo (fichero html) con la idea de ayudar a la identificación de modelos una vez se tengan que seleccionar, bien para su edición o bien para su selección desde las plantillas.

Huecos (slots) ​

Un concepto que tenemos que conocer es el de los huecos, que aplica para los modelos y/o las plantillas. Bajo una sintaxis definida por el equipo de Nautilus, los modelos (ficheros html) incluirán huecos, que serán los espacios destinados a ser rellenados con el contenido a enviar. Los huecos pueden ser de dos tipos: texto e imagen. Se pueden definir tantos huecos como se desee, tanto de texto como de imagen, que serán ubicados dentro del modelo según la distribución que el desarrollador (persona con conocimientos avanzados de html) haya definido en su modelo (fichero html).

Para definirlos es necesario incluir dentro de una etiqueta html la propiedad aq-model-slot (para el modelo) y aq_slot (para la plantilla) con el correspondiente nombre del hueco, el tipo mediante la propiedad type, también se pueden indicar el nombre name y descripción description que se mostrarán al usuario a la hora de editar los huecos.

Ejemplo:

• Texto:

<span aq-model-slot="deviceName" type="text" name="Nº Serie del contador" description= "Literal para el número de serie del contador">

<span aq-model-slot="deviceName" type="text" name="Nº Serie del contador" description= "Literal para el número de serie del contador">

• Imagen:

<img aq-slot="phone" type="image" name="Imagen teléfono" description="Mida recomendada 128x128 px" class="image-icon">

<img aq-slot="phone" type="image" name="Imagen teléfono" description="Mida recomendada 128x128 px" class="image-icon">

Añadir idioma al modelo ​

Para facilitar la gestión de plantillas, un modelo puede tener diferentes idiomas para poder introducir imágenes y/o texto en un idioma en concreto. Si un modelo no tiene idioma definido, se utilizará el modelo base.

Mediante el botón en la parte derecha superior "+ IDIOMA", a medida que se seleccionan idiomas, pasan a formar parte de la lista de modelos disponibles.

Al seleccionarlo aparece una pantalla emergente solicitando el idioma para cumplimentar los huecos. Los idiomas ofrecidos en esta pantalla están precargados y no son editables por el usuario.

Selecciona el hueco a cumplimentar y aparecerá un cuadro de texto con unas opciones mínimas de formateo para los huecos de texto, o bien un selector de opciones para incluir una imagen en los huecos de imagen.

Las dos formas de incluir una imagen en un hueco son:

• Fichero: Nautilus ofrece subir un fichero a la plantilla desde un repositorio local.
• URL: Introduce la URL completa (incluido el nombre) que contiene la imagen. ¡Atención! La URL introducida debe ser accesible desde los servidores donde está desplegado Nautilus.

Para más información : Demostración modelos

Plantillas ​

Las plantillas son la parte de la notificación que el usuario personaliza. Tal y como se ha dicho en el punto anterior, el modelo define el formato del mensaje que se enviará y además unos huecos de texto y/o de imagen, los cuales ahora toca dotarlos de contenido.

La gestión de plantillas es igual que la de modelos, teniendo una pantalla donde acceder a las plantillas ya creadas, y mostradas en formato card, o donde crear nuevas plantillas. Desde de esta pantalla se puede buscar las plantillas por Nombre, segun sus etiquetas, contenidó(sms y/o email), estado(publicado o borrador) y origen de plantilla(mis plantillas o biblioteca/repositorio).

Las cards de plantillas que se muestran tienen finalidad descriptiva en lo relativo a su funcionalidad incluida, es decir, el título de la misma, titulo de repositorio(si viene de repositorio) y los medios para los que está disponible la plantilla. Al pulsar en los tres puntos, nos aparece las acciones habilitadas para estas cards (Editar, duplicar, eliminar plantilla).

Creación de plantillas ​

La creación de una plantilla empieza seleccionando la opción de menú 'Plantillas' (la que nos muestra por defecto al entrar en el servicio de notificaciones), una vez dentro de la pantalla, ubicado en la parte inferior derecha, tenemos el botón '+', haciendo clic en el mismo, accedemos al panel lateral derecho de la plantilla.

Se deberán informar los campos:

• Nombre
• Descripción
• Etiquetas Valores definidos por el usuario para su posterior filtrado.
• Medios : Email / SMS
• Modelo En el caso de que el medio sea email será obligado informar que modelo se usará en dicha plantilla
• Planificación De forma opcional se podrá informar una planficación por defecto.

Consultar plantilla ​

aparece un panel lateral con dos pestañas 'Información basica' e 'Idiomas'. En la pestaña de 'Infomación basica' se mostrará la información que hemos introducido y el modelo seleccionado, siendo estos campos editables. Destacaremos que se tiene un botón en la parte superior izquierda de esta pantalla en la que nos ofrece la opción de 'copiar el identificador de la plantilla'. Esta es una opción pensada para facilitar el trabajo a usuarios que hagan uso de la api publica.

En la pestaña idiomas se podrá realizar una gestiónde los idiomas disponibles para la plantilla igual que se ha mostrado en el apartado de "modelos"

Edición de plantillas ​

Desde el botón de acciones si pulsamos la opción "editar" nos dejara modificar los campos:

• Nombre
• Descripción
• Etiquetas Tanto eliminar las existentes como añadir de nuevas
• Medios : Email / SMS
• Modelo En el caso de que el medio sea email será obligado informar que modelo se usará en dicha plantilla
• Planificación De forma opcional se podrá informar una planficación por defecto.

Para más información : Demostración plantillas

Gestión de variables en plantillas ​

El concepto de utilización de variables no dista mucho del uso típico de las mismas, es decir, es la identificación mediante una sintáxis específica de variables que posteriormente la aplicación responsable de realizar el envío, se encargará de sustituir el identificador de dicha variable por el valor concreto para cada notificación.

La utilización de variables se dará tanto en los huecos de texto como en los de imágenes (bajo la opción de carga de imagen por variable).

El nombre de la variable deberá estar encerrado entre dobles corchetes para su correcta identificación. El nombre de la variable, como es obvio, debe ser único para la plantilla (todas las variables con el un mismo nombre dentro de una plantilla, se sustituirán por el mismo valor).

Notificaciones programadas ​

Las notificaciones planificadas son aquellas que se envían en algún momento del futuro, actualmente se permiten dos maneras distintas de indicar dicho envió.

• Indicando una fecha futura, la cual debe tener formato ISO 8601 (ejemplo: 2021-06-29T16:18:05Z)
• Mediante una plantilla de Planificación.

Plantillas de planificación ​

La plantillas de planificación sirven para indicar los días y horas en las que se tiene que enviar una notificación.

En la imagen podemos ver que se ha escogido una franja de Lunes a Viernes de 08:00 a 17:00 (horario laboral), si se envía una notificación que esta fuera de este horario, esta misma se planifica para el momento más próximo en la que se cumple la planificación.

Ejemplos de comportamiento del sistema usando la plantilla anteriormente mencionada:

1. Si se envía una notificación el Lunes a las 10:00, esta se enviara inmediatamente.
2. Si se envía el Lunes a las 19:00, la notificación será enviada el Martes a las 08:00.
3. Si se envía el Vieres a las 17:01, la notificación se enviara el Lunes a las 08:00.

Repetición de la notificación ​

Se ha habilitado la funcionalidad de reenviar una misma notificación indicando una máscara cron o tiempo de espera.

Whitelist - Lista de direcciones permitidas por aplicación ​

La configuración de la Lista de direcciones permitidas, permite indicar una dirección de correo electrónico o un dominio específicos, a los que se permiten enviar correos electrónicos, esta funcionalidad se puede activar/desactivar por cada aplicación de notificaciones. Esta acción se puede llevar a cabo desde la parametrización del modelo de la aplicación.

Por ejemplo, activando la llista e indicando el dominio "@example.com" en la configuración de direcciones permitidas, únicamente serán aceptadas aquellas peticiones en las que todos los destinatarios tengan dicho dominio.

Biblioteca de notificaciones ​

La biblioteca se puede usar cuando surge la necesidad de compartir modelos, plantillas y planificaciones entre diferentes aplicaciones (tenants). De esta manera no será necesario tener las mismas plantillas en varias aplicaciones. Una aplicación de notificaciones puede usar una o varias bibliotecas diferentes, para esto es necesario añadir lo en la parametrización de la aplicación. El uso de biblioteca de una aplicación se puede activar/desactivar desde la configuración de la misma:

Una vez configurada la biblioteca desde nuestra aplicación podremos acceder y consultar todas las plantillas, planificaciones y los modelos que están disponibles en la biblioteca, estas se muestran en la pestaña "*^biblioteca*"

Obtener estado de las notificaciones atraves de Datahub ​

Si una aplicación necestita obtener el estado de cada notificación en tiempo real atraves de Nautilus Datahub tiene que segir los siguientes pasos:

• Activar este servició atraves de la parametrización de la aplicación de Notificaciones.
• Solicitar la creación y el acceso de lectura al topic datahub.event.notification.status con el identificador de la aplicación atraves del apartado de Solicitudes.

Integración ​

• API de notificaciones