Ir para o conteúdo

Configurar um Runner

O BotCity Runner é o responsável por solicitar tarefas ao BotCity Orquestrador e executá-las em um ambiente de execução.

Basicamente, a configuração de um novo Runner pode ser dividida em duas etapas:

  • Criação do Runner no BotCity Orquestrador
  • Configuração do Runner no ambiente de execução

Nas seções a seguir, vamos ver mais detalhes sobre como instalar e configurar um Runner no ambiente de execução.

Orquestrador BotCity

A alocação e configuração do Runner deve ser feita diretamente nos ambientes de execução.

Veja mais em:

Ambiente de execução

Após realizar a instalação do BotCity Studio SDK, você terá a opção de fazer o Setup de um Runner.

Instalação

Veja a etapa de instalação em:

Nessa etapa você pode alocar o Runner criado no Orquestrador BotCity no seu ambiente de execução, seguindo os passos:

  • Acesse o ambiente de execução
  • Busque pela pasta onde o BotCity Studio SDK foi instalado
  • Execute o arquivo wizard-X.Y.Z
  • Clique no botão Setup Runner Wizard Setup Runner
  • Siga as etapas guiadas pelo Wizard:
    • Selecione o servidor, por exemplo: https://suaempresa.botcity.dev Wizard Setup Runner Auth
    • Clique no botão I already have a Runner Wizard Runner options
    • Selecione na lista de Runners disponiveis no Orquestrador Wizard Select Runner

Após concluido, seu Runner está configurado no ambiente de execução e pronto para iniciar.

Criar Runner no Wizard

Você também pode criar um Runner diretamente na etapa de Setup Runner ao clicar no botão Create a New Runner.

Ao criar o Runner no Wizard, automaticamente ele será criado no Orquestrador BotCity.

Personalizar a configuração do Runner

Arquivo de configuração

A configuração do Runner é definida pelas informações do arquivo conf.bcf, localizado na pasta conf onde o SDK foi instalado.

Você pode ver mais detalhes sobre o arquivo de configuração através deste link.

O arquivo de configuração do BotCity Studio SDK possui algumas configurações específicas do BotCity Runner.

Algumas dessas configurações já são incluídas por padrão, no momento de instalação do BotCity Studio SDK.

server=https://developers.botcity.dev
workspace=
key=
login=
machineId=<Identificador do Runner>
logScreen=true
logApplication=true

Além das configurações definidas por padrão, você pode incluir configurações personalizadas conforme a necessidade.

Veja na tabela abaixo mais detalhes sobre as configurações adicionais disponíveis que podem ser utilizadas no arquivo de configuração do Runner.

Configuração Obrigatório Padrão Descrição
machineId Sim O identificador exclusivo da instância do BotCity Runner.
javaParams Não Parâmetros da JVM a serem passados para a execução da automação.
pythonBinary Não python O binário Python a ser usado, como python3, py ou o caminho completo para o binário
logScreen Não true Se definido como 'true', permite o compartilhamento de tela com o BotCity Orquestrador para automações baseadas em GUI.
logApplication Não true Se definido como 'true', permite o compartilhamento de log com o BotCity Maestro.
logTelemetry (a partir da versão 2.7.0) Não false Se definido como 'true', permite o compartilhamento de telemetria do sistema com o BotCity Orquestrador, como % de CPU, uso de memória e etc.
startup Não O caminho para um script de inicialização a ser executado assim que o BotCity Runner iniciar sua execução.
beforeTask (a partir da versão 2.7.0) Não O caminho para um script a ser executado antes de cada tarefa.
debugEnabled (a partir da versão 2.7.0) Não false Se deve ou não produzir uma saída de log mais detalhada.
ignoreSSL (a partir da versão 2.7.0) Não false Ignorar ou não os problemas de SSL ao se comunicar com o BotCity Maestro. Isso é útil quando sua rede intercepta conexões HTTPS.

Info

No arquivo conf.bcf você deverá incluir o nome da configuração desejada e o valor que ela receberá, exemplo:

server=https://developers.botcity.dev
workspace=
key=
login=
machineId=<Identificador do Runner>
logScreen=true
logApplication=true
debugEnabled=true

Iniciar o Runner

O BotCity Runner pode ser iniciado de diversas formas, veja a seguir.

Execução com GUI

Simplesmente execute o script BotRunner-gui disponível em seu BotCity Studio SDK ou use o parâmetro -gui se invocar o arquivo botrunner.jar manualmente.

Nesse caso, é necessário clicar no botão START para que o Runner estabeleça conexão com o Orquestrador e comece o processamento das tarefas.

Runner-GUI

Execução Headless (sem GUI)

Simplesmente execute o script BotRunner disponível em seu BotCity Studio SDK. Nesse caso, somente um terminal referente ao processo do Runner será iniciado.

Execução utilizando container

É possível executar o Runner em contêineres usando nossas imagens, veja mais detalhes na seção containers.