Automações¶

Ir para Automações

Uma Automação é um dos elementos mais importantes do BotCity Orquestrador, ela caracteriza um processo a ser executado.

Visualizar Automações¶

Nessa tela, você visualiza o resumo das Automações nos seguintes cartões:

Total de Automações: quantidade total de Automações criadas.
Automações completas: quantidade de automações com Robô e pelo menos um Runner vinculados.
Automações incompletas: quantidade de automações sem Robô, sem Runner ou sem nenhum dos dois.

Abaixo do resumo, você pode visualizar as automações no formato de lista com as seguintes colunas:

Ícone: Ícone que representa a linguagem do robô vinculado à automação.
Nome: Identificador único da automação, como link para acessar os detalhes.
Label: Rótulo amigável da automação.
Descrição: Descrição definida para a automação.
ID do Robô: Identificador do robô vinculado à automação.
Repositório: Nome do repositório onde a automação está armazenada.
Avisos: Indica a quantidade de informações pendentes de configuração na automação.
Menu de ações: Ações disponíveis para a automação.

Anatomia de uma Automação¶

A automação é responsável por fazer o vínculo entre o Robô (script, software ou código de um processo) e os Runners (instâncias do serviço BotCity Runner). Dessa forma, ao criar uma Nova Tarefa, na automação estarão as informações de qual robô utilizar e quais Runners podem executar essa automação.

Mais informações

Entenda mais sobre:

Uma automação pode conter mais informações e configurações sobre um processo a ser executado.

Ao acessar o menu Automações e selecionar uma automação existente, as informações estão separadas em 3 abas:

Visão Geral
Desenvolvimento
Política de execução

Visão Geral¶

Nessa aba, você encontra as informações gerais sobre a Automação, separadas em blocos:

Sobre a automação
- Nome: O nome amigável da automação.
- Label: O identificador único da automação (o label é unico, mesmo se excluir a automação não poderá usá-lo novamente).
- Repositório: Seleção do repositório onde a automação será alocada.
- Descrição: Uma breve descrição sobre o processo de automação.
Gerenciamento de tarefas
- Prioridade: A prioridade padrão de execução desse processo.
- Runners vinculados: Seleção de Runners associados a esta automação. Se mais de um Runner estiver anexado, a tarefa será atribuída ao primeiro BotCity Runner livre que está online e disponível.
Notificações
- Usuários para notificar: Seleção de usuários a serem notificados quando o alerta de notificações de um determinado tipo acontecer.
- Tipo de notificação: Os tipos de notificação de alerta para notificar os usuários.

Notificações

Os usuários selecionados no campo Notificar os usuários receberão uma notificação via e-mail toda vez que a automação disparar um alerta via código.

Veja mais em:

Alertas

Desenvolvimento¶

Nessa aba, você encontra informações de desenvolvimento da automação, separadas em blocos:

Informações do Bot
- Robô vinculado: O código de um processo ou software associado a esta automação.
- Tecnologia: Tecnologia ou linguagem de programação utilizada na automação.
Parâmetros: Informações dinâmicas que podem ser usadas pelo Robô vinculado.

Parâmetros¶

As automações podem ser parametrizadas para maior flexibilidade e código mais dinâmico.

Os parâmetros são definidos na seção Parâmetros da automação ao criá-la ou editá-la.

Na aba Desenvolvimento, clique no botão Editar, isso habilita os campos de edição, em seguida clique no botão Adicionar + para adicionar um novo parâmetro.

Um parâmetro é definido pelos seguintes elementos:

Nome: O nome amigável do parâmetro.
Label: O identificador exclusivo do parâmetro.
Descrição: Uma breve descrição sobre o parâmetro.
Tipo: Seleção do tipo de dados do parâmetro, podem ser:
- Text: Tipo de entrada de texto.
- Integer: Tipo de entrada de número inteiro.
- Double: Tipo de entrada de número decimal.
- Date: Tipo de entrada de data.
Intervalo: Indica o valor mínimo e máximo para a entrada de dado numérico.
Valor padrão: Indica qual valor de entrada definido como padrão para o campo.
Obrigatório:
- Sim: É obrigatório informar um valor para o campo no momento de criar uma tarefa.
- Não: É opcional informar um valor para o campo no momento de criar uma tarefa.
Ações:
- Deletar: Deleta o parâmetro.
- Editar: Abre a edição do parâmetro.
- Cancelar: Cancela a edição do parâmetro.
- Salvar: Salva a edição do parâmetro.

Tipo de dado

O Tipo determinará como o parâmetro será exibido ao criar uma nova tarefa no BotCity Orquestrador.

Veja mais detalhes de como acessar em código os Parâmetros via SDK.

Política de Execução¶

Nessa aba você tem a opção de definir o tempo máximo esperado para que uma tarefa desta automação execute.

Quando o timeout é habilitado, você pode selecionar a opção de tempo esperado em:

Minuto
Hora
Dia

O valor de tempo deve ser definido como no mínimo 1 minuto e no máximo de 1 dia.

Atenção!

O timeout será aplicado para as novas tarefas desta automação, caso já existam tarefas em fila, elas não serão afetadas.
O tempo definido em timeout começa a contar a partir do momento que a tarefa começa sua execução pelo Runner, o tempo em fila não é considerado.

Ações¶

Você pode realizar algumas ações no menu de Automações.

Criar¶

Para criar uma automação, siga os passos:

Acesse o menu Automações no Orquestrador BotCity
Clique no botão + Nova Automação no canto superior direito
Preencha as informações de:
- Visão Geral
- Desenvolvimento
- Política de Execução
Clique no botão Salvar no canto superior direito

Campos obrigatórios

Os campos obrigatórios são: Nome, Label, Repositório e Descrição.

As demais informações podem ser preenchidas depois. Para executar tarefas dessa automação, porém, é necessário ter o Robô e pelo menos um Runner vinculados.

Outra forma de criar

As automações também podem ser criadas de maneira facilitada através do Easy Deploy.

Automações completas e incompletas¶

Você pode criar apenas a automação, com os campos obrigatórios, e vincular o Robô e o Runner depois, em outro momento da sua jornada. Enquanto esses vínculos não existem, a automação é considerada incompleta.

O status da automação considera dois vínculos:

Robô vinculado: a automação tem um Robô vinculado.
Runner vinculado: a automação tem pelo menos um Runner vinculado.

A automação é completa quando tem os dois vínculos. Quando falta um deles, ou os dois, ela é incompleta.

Automações incompletas não executam tarefas

Não é possível criar nem executar tarefas de uma automação incompleta. Vincule o Robô e pelo menos um Runner à automação antes de criar uma nova tarefa.

Na página de detalhes da automação, um quadro de avisos indica o que está faltando:

Nenhum Runner vinculado: a automação não tem nenhum Runner vinculado. Veja mais em Runners.
Nenhum Bot vinculado: a automação não tem nenhum Robô vinculado. Veja mais em Robôs.
Não reportando itens: a automação não está reportando itens processados para o BotCity Insights e, por isso, não alimenta os indicadores de eficiência. Veja como reportar em Finalizar tarefa e reportar dados.

Reporte de itens não altera o status

O aviso Não reportando itens não é considerado para definir se a automação é completa ou incompleta. Uma automação com Robô e Runner vinculados é completa mesmo que ainda não reporte itens para o BotCity Insights.

Editar¶

Após criar uma automação, você pode seguir os passos para editá-la:

Acesse o menu Automações no Orquestrador BotCity
Acesse os detalhes clicando no nome da automação
Clique no botão Editar no canto superior direito
Altere os valores de dos campos desejados
Clique em Salvar no canto superior direito

Exportar¶

Você pode exportar as informações de uma automação de um workspace para usar em outros.

Para exportar, você pode seguir os passos:

Acesse o menu Automações no Orquestrador BotCity
Acesse os detalhes clicando no nome da automação
Clique no botão Exportar no canto superior direito
O download do arquivo deve começar automaticamente

Importar¶

Você pode importar as informações de uma Automação de um workspace para usar em outros, sem a necessidade de passar pela etapa de criação.

Para importar, você pode seguir os passos:

Exporte a automação de outro workspace
Acesse o menu Automações no Orquestrador BotCity
Clique no botão + Importar no canto superior direito
Selecione o arquivo .json da automação
Selecione o repositório para essa automação
Clique no botão + Importar

Arquivo JSON

O arquivo .json contém as informações de uma automação para ser importada em outro workspace, porém é necessário fazer o vínculo de Runners e Robôs dessa automação após a importação.

Exemplo de arquivo

    {
      "label" : "demo",
      "name" : "Automation Demo",
      "description" : "Automation used as an example.",
      "parameters" : [ {
        "defaultValue" : "value",
        "description" : "Demo Param",
        "label" : "paran",
        "name" : "Param",
        "required" : true,
        "resourceLabel" : null,
        "rules" : { },
        "type" : "TEXT"
      } ],
      "notification" : {
        "monitored_types" : [ "INFO", "WARN", "ERROR" ],
        "users" : [ 9314 ]
      },
      "status" : null,
      "priority" : 0,
      "automationExists" : false
    }

Mover de Repositório¶

As automações podem ser realocadas em outro repositório, para isso, siga os passos:

Acesse o menu Automações no Orquestrador BotCity
Encontre a automação que deseja mover
Clique no menu de opções dessa automação
Selecione Mover para o repositório
Selecione o novo repositório
Clique em Confirmar

Atenção

Essa ação moverá também os robôs, agendamentos e outros recursos que estão vinculados a essa automação.

Busca e filtros¶

É possível combinar vários filtros para fazer buscas no menu Automações, conforme as suas necessidades.

Busca por:

Automação: Busca pelo nome ou label da Automação.

Filtros disponíveis:

Label: Seleciona uma ou mais labels.
Automação: Seleciona uma ou mais nomes.
Repositório: Seleciona um repositório específico.
Completas: Filtra as automações com Robô e pelo menos um Runner vinculados.
Incompletas: Filtra as automações sem Robô, sem Runner ou sem nenhum dos dois.

Ordenação:

Alfabeticamente
Mais recente primeiro
Mais antigo primeiro