Gerenciamento de alertas para automação é uma chave importante para uma comunicação mais efetiva entre as pessoas stakeholders. Além de monitorar os erros e gerenciar os logs que são essenciais para orquestrar seus robôs, os alertas podem garantir que o seu time saiba o que está acontecendo, seja antes, durante ou depois da execução de um processo, dependendo de como você precisar que esses alertas funcionem e das condições atendidas em seu código. Neste artigo, vamos entender como configurar um alerta de acordo com a sua necessidade utilizando Python e como gerenciá-lo pelo BotCity Orquestrador.
O que são alertas para automação?
Alertas são notificações que são enviadas para as pessoas envolvidas em um projeto quando determinadas condições configuradas no desenvolvimento do código da automação são atendidas durante sua execução.
As condições podem variar de acordo com os requisitos de cada processo. Em alguns casos, pode ser necessário você notificar o time de que determinado ponto da execução acabou de começar a executar ou ainda que um erro aconteceu antes do robô finalizar alguma das etapas da automação, entre muitos outros.
Tipos de alertas para automação
Os tipos de alertas para automação que temos disponíveis para serem enviados e gerenciados pelo Orquestrador são:
- INFO: alerta utilizado para levar alguma informação para stakeholders;
- WARN: alerta utilizado para avisos que merecem alguma atenção;
- ERROR: alerta utilizado para notificar erros que aconteceram.
Como adicionar o alerta na automação com Python RPA
É necessário entender em quais etapas você precisa adicionar o alerta e quais são os tipos necessários para cada uma dessas mesmas etapas.
Mas antes de adicionar o código, você precisa garantir que seu projeto já está pronto com o SDK importado e instanciado. Faça da seguinte forma, primeiro adicione a importação:
from botcity.maestro import *
E adicione a biblioteca no arquivo requirements.txt: botcity-maestro-sdk. Em seguida, faça a instalação:
pip install botcity-maestro-sdk
No seu código, lembre-se de instanciar:
# instanciando o Maestro SDK maestro = BotMaestroSDK.from_sys_args() # buscando os detalhes da tarefa atual sendo executada execution = maestro.get_execution()
No exemplo deste artigo, vamos considerar, por exemplo, que na sua automação você precise alertar o momento do início da execução, alertar quando um site demorar a abrir e um alerta quando um erro ocorrer.
Caso você queira emitir um alerta informativo (do tipo INFO), você precisará adicionar a função conforme abaixo:
maestro.alert(
task_id=execution.task_id,
title="Starting the process",
message=f"Starting the execution: Task {execution.task_id} started",
alert_type=AlertType.INFO
)
As informações adicionadas correspondem à:
- task_id: é o ID da tarefa que está em execução para identificação;
- title: é o título do seu alerta;
- message: a mensagem que você deseja adicionar sobre esse alerta;
- alert_type: trata-se do tipo de alerta que você está emitindo.
Caso você queira emitir um alerta referente a um erro (do tipo ERROR), você precisará adicionar a função conforme abaixo:
maestro.alert(
task_id=execution.task_id,
title="The process failed",
message=f"This page did not open: {site}",
alert_type=AlertType.ERROR
)
E caso você queira emitir um alerta referente a algo que está demorando para executar (do tipo WARN), você precisará adicionar a função conforme abaixo:
maestro.alert(
task_id=execution.task_id,
title="Waiting to open the website",
message=f"Waiting to open the website {site}",
alert_type=AlertType.WARN
)
Saiba mais em: documentação sobre alertas.
Como adicionar quem deve receber o alerta
Na sua automação já disponível no Orquestrador pelo processo de deploy, você também precisa adicionar as pessoas que podem ser notificadas pelos alertas configurados.
Para isso, acesse a tela “Automations” pelo menu da lateral esquerda do Orquestrador, identifique a sua automação e clique no ícone de três pontos, escolhendo por fim a opção “Edit” do menu.
Após isso, no campo “Notify Users”, selecione as pessoas que precisam receber os alertas também por e-mail. E no campo “Notification Type”, selecione os tipos de alertas que deverão ser enviados por e-mail. Por fim, clique em “Save”.
Para saber se deu tudo certo, acompanhe a notificação que receberá na tela indicando que a alteração foi salva com sucesso. E então bastará acompanhar por e-mail as notificações que serão recebidas referentes aos alertas configurados.
Como gerenciar os alertas pelo Orquestrador
É possível acompanhar os alertas pelo BotCity Orquestrador de duas maneiras: uma delas é pela tela de alertas e a outra é pela própria tarefa.
Gerenciar alertas pela tarefa executada
Dentro da própria tarefa, você identificará a aba “Alerts” e, ao clicar nela, será possível acompanhar os alertas gerados.
Para expandir ou fechar o alerta, basta clicar em cima dele para ter acesso aos detalhes mostrados no exemplo do print acima.
Gerenciar alertas pela tela de Alerts
No menu da lateral esquerda, dentro da categoria “Automation Control”, identifique o item “Alerts” e clique nele. Você terá acesso aos alertas de diferentes automações. Para facilitar, utilize o filtro com as informações necessárias.
Para expandir ou fechar o alerta, basta clicar em cima dele para ter acesso aos detalhes mostrados no exemplo do print acima.
Quer testar as funcionalidades de alertas?
Para fazer na prática tudo o que compartilhamos, você pode criar a sua conta gratuita, seguir o passo a passo e aproveitar para testar no seu caso de uso esse gerenciamento de erros. E participe da nossa comunidade para troca de experiências sobre o universo da automação RPA.
