Lab 4.3: Integrações com o Orquestrador

O Orquestrador BotCity Maestro oferece uma solução integrada para o gerenciamento de suas automações.

O código possui integração com Alerta, Credenciais e entrada de Log de Execução, permitindo que você tenha uma visão completa do que está acontecendo em suas automações.

Mais informações sobre o Orquestrador BotCity Maestro podem ser encontradas aqui.

Log de Execução

Para que as entradas de Log fiquem registradas no Orquestrador, você pode criar um novo log no menu Log de Execução com as seguintes informações:

Label: controle_cadastro
Repositório: DEFAULT
Colunas:
- Label: nome
- Nome: Nome
- Label: status
- Nome: Status

Atenção

Para que as entradas de log sejam registradas corretamente, é necessário que no código o método new_log_entry() seja chamado com o mesmo activity_label="controle_cadastro" definido no Orquestrador.

Credenciais

Outra integração importante é a utilização de Credenciais para armazenar informações sensíveis, como login e senha de acesso ao sistema.

Para criar uma nova credencial, acesse o menu Credenciais no Orquestrador, clique em Nova Credencial e preencha os campos:

Label: login_orangehrm
Repositório: DEFAULT
Secrets:
- Chave: username
- Valor: Admin
- Chave: password
- Valor: admin123

Atenção

Para que as credenciais sejam utilizadas corretamente, é necessário que o label e as key do código estejam iguais ao Orquestrador:

username = maestro.get_credential(label="login_orangehrm", key="username")
password = maestro.get_credential(label="login_orangehrm", key="password")

Reportando itens processados para alimentar BotCity Insights

O BotCity Insights utiliza como base para os cálculos a quantidade de itens que uma tarefa executou. Essa será uma unidade essencial para o cálculo de desempenho e dados financeiros.

Você pode entender item como sendo algo que foi produzido pela automação, e que de certa forma gerou uma saída (output). Por exemplo, um fornecedor que foi homologado, um produto cadastrado em um determinado sistema, etc.

Durante a execução de um processo, pode ser que apenas um item de saída seja gerado ao final, ou sejam gerados múltiplos itens em uma mesma execução. Tudo isso fica a cargo das regras de negócio e do processo realizado pelo robô.

Desta forma, basta contabilizar o número total de itens processados, itens processados com sucesso e falha. Para passar essas informações ao finalizar a tarefa, como o exemplo de código abaixo:

...
# Finalizando a tarefa e reportando os itens processados
maestro.finish_task(
    task_id=execution.task_id,
    status=status,
    message=message,
    total_items=total_itens,
    processed_items=itens_sucesso,
    failed_items=itens_falhos
)

Warning

Lembrando que a configuração e entrada de dados financeiros é essencial para serem geradas informações e indicativos relevantes referentes aos processos.

Certifique-se de que os valores de entrada utilizados estão corretos para cada automação.