Configurar plantillas de notificación

Qué son las plantillas

Es una herramienta que permite definir el formato y estructura en que se dará aviso de una alerta a un contacto.

Las plantillas permiten definir el cómo se informará el mensaje, textos adiciones para dar más contexto, definir qué variables se incluyen en el aviso y cuáles se omiten.

Todo esto, además, con la flexibilidad de poder definir, para cada sistema de comunicación o servicio, un formato diferenciado y/o particular.

Crear una plantilla

  1. En el menú superior, seleccionar la opción Personalización

  2. En la subsección "Administrar plantillas".

  3. En el apartado "Nuevo diseño"

  4. Rellenar los campos nombre y formato

  5. Presionar el botón Guardar.

Qué es el "formato"

Un formato de planilla se compone de texto plano y etiquetas para extraer información y definir la estructura de esta.

Ejemplo:

 Usted tiene una nueva alarma: <sni:mensaje> 

Qué es una etiqueta

Dentro del formato, es posible usar dos tipos de etiquetas, las etiquetas simples y las complejas.

Ambas, permiten extraer información del sistema e incluirlas de manera dinámica a un mensaje.

Etiquetas simples

Una etiqueta simple empieza con el símbolo “<” y termina con “>”. Son utilizadas para extraer información.

Etiqueta

Descripción

<sni:criticidad>

o

<24c:criticity>

Extrae la criticidad de la alarma.

  • Para las alarmas nuevas: critical, major, minor.

  • Para las alarmas existentes: notificada, solucionada.

<sni:CRITICIDAD>

o

<24c:CRITICITY>

Extrae la criticidad en mayúsculas.

<sni:servicio>

o

<24c:service>

Extrae el servicio afectado de la alarma.

<sni:SERVICIO>

o

<24c:SERVICE>

Extrae el servicio afectado de la alarma en mayúsculas.

<sni:turno>

o

<24c:shift>

Extrae el turno responsable o informativo de la alarma. En el caso de las Integraciones, es el turno del contacto que ha realizado la acción correspondiente.

<sni:contacto>

o

<24c:contact>

Extrae el contacto responsable o informativo de la alarma. En el caso de las Integraciones, es el contacto que ha realizado la acción correspondiente.

<sni:mensaje>

o

<24c:message>

Extrae el mensaje de la alarma.

<sni:alarmid>

o

<24c:alarmid>

Extrae el ID de alarma.

<sni:externalid>

o

<24c:externalid>

Extrae el external_id de la alarma.

<sni:fecha>

o

<24c:date>

Extrae la fecha de la alarma.

<sni:custom:unavariable>

o

<24c:custom:unavariable>

Extrae los datos de “unavariable” del conjunto “custom”. Más adelante se especifica cómo utilizar esta etiqueta.

<sni:allcustomtable>

o

<24c:allcustomtable>

Extrae y estructura automáticamente todas las variables del conjunto “custom”. Más adelante se especifica cómo utilizar esta etiqueta.

<sni:spell:custom:unavariable>

o

<24c:spell:custom:unavariable>

Solo para audio.

 

Extrae y estructura automáticamente todas las variables del conjunto “custom” y al pronunciarla, la deletrea. Más adelante se especifica cómo utilizar esta etiqueta.

Etiquetas Complejas

Una etiqueta compleja comienza y termina con etiquetas simples reservadas. Estas etiquetas se utilizan para estructurar la información.

Algunas etiquetas complejas requieren de más de un argumento para su correcto uso. Para ello, se utiliza la etiqueta reservada <next> para separarlas.

Etiqueta de Inicio

Etiqueta de Término

Descripción

<header>

</header>

  • Indica una nueva subsección.

  • Puede utilizar esta etiqueta para separar la notificación en grupos, para que sea más agradable a la vista del usuario.

<row>

</row>

  • Representa una fila de una tabla con dos columnas, para visualizar datos de una forma más organizada.

  • La primera columna es el nombre de una propiedad. La segunda es su valor.

  • Esta etiqueta espera dos argumentos.

<meta:title>

</meta>

  • Define un título para la notificación.

  • En este momento, solo es soportado por las notificaciones por Correo (define el asunto).

  • El resto de notificaciones lo ignoran.

<meta:attachment>

</meta>

  • Adjunta información adicional, entregadas por variables especiales del conjunto “custom”.

  • En este momento, solo es soportado por las notificaciones por Correo (se adjuntan como archivos) y Telegram.

  • El resto de notificaciones lo ignoran.

  • Se esperan dos argumentos: un nombre y los datos.

<meta:direct-json>TEAMS WORKFLOWS</meta>

  • Le indica a la plantilla que el contenido es un JSON para cards de TEAMS.

  • Valida tu JSON para teams dentro de la herramienta de microsoft

Ejemplos

  • Header

<header>Comentarios</header>
 <header> Alarma <24c:CRITICITY> </header>
  • Row

<row>País<next>Chile</row>
<row> Comentario <next> <24c:custom:comentario> </row>
  • Meta:title

<meta:title> 24Cevent: Nueva notificación </meta>
<meta:title> 24Cevent: <24c:SERVICE> </meta>
  • Meta:attachment

<meta:attachment> Mi Foto <next> <24c:custom:mifoto> </meta>

Donde “mifoto” es una variable especial del conjunto “custom”.

  • Meta:direct-json

<meta:direct-json>TEAMS WORKFLOWS</meta>
{
   "$schema":"https://adaptivecards.io/schemas/adaptive-card.json",
   "type":"AdaptiveCard",
   "version":"1.5",
   "body":[
      {
         "type":"Container",
         "style":"good",
         "bleed":true,
         "items":[
            {
               "type":"ColumnSet",
               "columns":[
                  {
                     "type":"Column",
                     "width":"auto",
                     "verticalContentAlignment":"Center",
                     "items":[
                        {
                           "type":"Image",
                           "url":"https://www.dparadig.com/wp-content/uploads/2024/03/Recurso-1@3x-889x1024.png",
                           "height":"40px"
                        }
                     ]
                  },
                  {
                     "type":"Column",
                     "width":"stretch",
                     "verticalContentAlignment":"Center",
                     "items":[
                        {
                           "type":"TextBlock",
                           "text":"🚨 **Alerta de Monitoreo**",
                           "size":"Medium",
                           "weight":"Bolder",
                           "horizontalAlignment":"Center",
                           "wrap":true
                        },
                        {
                           "type":"TextBlock",
                           "text":"<sni:externalid>",
                           "size":"Small",
                           "isSubtle":true,
                           "horizontalAlignment":"Center",
                           "spacing":"None"
                        }
                     ]
                  },
                  {
                     "type":"Column",
                     "width":"auto",
                     "verticalContentAlignment":"Center",
                     "items":[
                        {
                           "type":"TextBlock",
                           "text":"✅",
                           "size":"ExtraLarge",
                           "weight":"Bolder",
                           "horizontalAlignment":"Right"
                        }
                     ]
                  }
               ]
            }
         ]
      },
      {
         "type":"TextBlock",
         "text":"⚙️ **Problema:** <sni:custom:service>",
         "wrap":true,
         "spacing":"Medium",
         "size":"Medium"
      },
      {
         "type":"TextBlock",
         "text":"📝 **Descripción del problema:** <sni:custom:service_output> <sni:custom:extra_output>",
         "wrap":true,
         "spacing":"Small"
      }
   ],
   "actions":[
      {
         "type":"Action.OpenUrl",
         "title":"🚀 Ir al Problema",
         "url":"<sni:custom:problem_url>"
      }
   ]
}

Importante

La etiqueta "meta:direct-json" es especial debido a que solo funciona para envio de notificaciones a "TEAMS WORKFLOWS". Dedicado a los canales dentro de Teams.

 

Luego de la etiqueta, solo se debe agregar JSON validado para teams. Y dentro del contenido se pueden agregar etiquetas simples.

Importante

No se pueden anidar etiquetas complejas. Solo se permiten etiquetas simples dentro de estas.

Variables Personalizadas

Utilice la etiqueta simple “<24c:custom:mivariable>” para extraer el valor de “mivariable” del conjunto “custom”.

Si la variable personalizada es especial, debe utilizar la etiqueta simple dentro de una etiqueta compleja correspondiente (en este momento, la única disponible es “<meta:attachment>”).

Utilice “<24c:allcustomtable>” para extraer todas las variables del conjunto “custom” de la alarma. Esta etiqueta insertará automáticamente un “<header>”, “<row>” por cada variable, y “<meta:attachment>” por cada variable especial.

Plantillas por defecto

El sistema, no requiere tener definidas las plantillas para cada mensaje, ya que para cada medio de comunicación existen plantillas por defecto que serán usadas en caso de que no se haya definido una por el usuario.

Estas plantillas por defecto son las siguientes:

Llamada

Alarma <24c:criticity> del servicio <24c:service> con el siguiente mensaje: <24c:message> 

Telegram

<header>Alarma <24c:CRITICITY></header>
<24c:message>

<header>Detalles</header>
<row>Servicio<next><24c:service></row>
<row>Turno<next><24c:shift></row>

<24c:allcustomtable> 

Teams

<header>Alarma <24c:CRITICITY></header>
<24c:message>

<header>Detalles</header>
<row>Servicio<next><24c:service></row>
<row>Turno<next><24c:shift></row>
<row>Fecha<next><24c:date></row>
<row>External-ID<next><24c:externalid></row>

<24c:allcustomtable> 

Correo

<header>Alarma <24c:CRITICITY></header>
<24c:message>

<header>Detalles</header>
<row>Servicio<next><24c:service></row>
<row>Turno<next><24c:shift></row>
<row>Fecha<next><24c:date></row>
<row>ID de Alarma<next><24c:alarmid></row>
<row>External-ID<next><24c:externalid></row>

<24c:allcustomtable> 

SMS

<header>SNI</header>
Alarma <24c:CRITICITY> del servicio <24c:service>.

<24c:message>