Templates
Os templates de alertas de sistema permitem definir o texto, juntamente com algumas possíveis variáveis, que será enviado quando o alerta ocorrer.
Os templates podem ser previamente configurados e posteriormente aplicados às configurações de cada alerta para cada canal de notificação.
Acessando os templates de alertas
Para acessar os templates de alertas de sistema, basta seguir os passos:
Autentique-se no Admin console
Acione o menu de alertas, com um clique no ícone de alertas localizado na barra do topo à direita.
Clique no botão Configurações, na parte inferior do menu de alertas.
Na página de configurações de alertas, clique no botão Canais de notificação, e em seguida clique em Configurações de templates.
Na janela de Templates, navegue pelas abas Defaults e Customizados, para acessar o template desejado.
Criando um template de alerta
Para criar um template de alerta, basta navegar até a janela de templates, você deve:
Na janela de templates, na aba Customizados clique no botão Adicionar.
Preencher um nome do template e o tipo do template (Slack, Microsoft Teams, Syslog, Email ou SMS).
Clicar no botão Concluir.
Editando um template de alerta
Após a criação do template, ou quando for necessário, pode-se editar o conteúdo do template. Para editar um template de alerta, você deve:
Navegar até a janela de templates, ver seção Acessando os templates de alertas.
Na janela de templates, na aba Customizados, encontre o template desejado e clique no botão Editar.
Edite o conteúdo do template e clique no botão Salvar.
Removendo um template de alerta
Para remover um template de alerta, você deve:
Navegar até a janela de templates, ver seção Acessando os templates de alertas.
Na janela de templates, na aba Customizados clique no botão Remover do template que se deseja remover.
Variáveis do template
O processamento do template é realizado no momento do envio da notificação com base nas informações específicas do alerta. Assim cada template conta com 5 variáveis que podem ser usadas para adicionar informações específicas do alerta na mensagem, são elas:
alertCode
Código do alerta
${alertCode}
alertName
Nome do alerta
${alertName}
alertDescription
Descrição do alerta
${alertDescription}
alertCriticity
Criticidade do alerta
${alertCriticity}
alertCreatedAt
Data de criação do alerta
${alertCreatedAt}
Processamento do template
O processamento do template é feito com base na engine do Thymeleaf, que é um processador de template que suporta vários tipos de templates como HTML, XML, TEXT, dentre outros.
Abaixo tem-se um exemplo de aplicação das variáveis do alerta em dois templates, sendo um HTML e ou outro JSON.
Exemplo de template HTML
O exemplo abaixo demonstra o uso das variáveis do alerta aplicadas num template HTML adequado para o processador do Thymeleaf:
<!DOCTYPE html>
<html>
<head>
<meta charset="UTF-8"/>
<title></title>
</head>
<body>
<p>Email:</p>
<p>Código do alerta: <span th:text="${alertCode}"></span></p>
<p>Nome do alerta: <span th:text="${alertName}"></span></p>
<p>Descrição do alerta: <span th:text="${alertDescription}"></span></p>
<p>Criticidade do alerta: <span th:text="${alertCriticity}"></span></p>
<p>Data de criação do alerta: <span th:text="${alertCreatedAt}"></span></p>
</body>
</html>Nota
Observe a sintaxe usada para o Thymeleaf processar a variável ${alertCode} num template HTML:
<span th:text="${alertCode}"></span>
Exemplo de template JSON
O exemplo abaixo demonstra o uso das variáveis do alerta aplicadas num template TEXT, formatado como JSON, adequado para o processador do Thymeleaf:
{
"alerta": "Nome do alerta: [[${alertName}]]",
"codigo": "Código do alerta: [[${alertCode}]]",
"descricao": "Descrição do alerta: [[${alertDescription}]]",
"criticidade": "Criticidade do alerta: [[${alertCriticity}]]",
"dataCriacao": "Data de criação do alerta: [[${alertCreatedAt}]]"
}Atualizado
Isto foi útil?