Configurando um Runner¶

Como vimos anteriormente, o BotCity Runner é o responsável por solicitar tarefas ao BotCity Maestro 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 Maestro (mais detalhes aqui).
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.

Configurando um Runner no ambiente de execução¶

O BotCity Runner faz parte do BotCity Studio SDK. Para conseguir utilizar corretamente as ferramentas, consulte a documentação referente a instalação do BotCity Studio SDK.

Na pasta onde o SDK foi instalado, basta iniciar o wizard-X.Y.Z onde X.Y.Z é a versão do Wizard.

A partir dessa tela, podemos selecionar a opção Setup Runner.

Nessa etapa vamos informar nossas credenciais de acesso, para que seja feita a autenticação no Maestro.

Dica

Caso você esteja utilizando um workspace exclusivo, como por exemplo: https://suaempresa.botcity.dev você poderá utilizar essa URL personalizada ao informar o Server.

Para a versão da comunidade, use https://developers.botcity.dev.

Ao avançar, você conseguirá selecionar um Runner já existente no seu workspace do Orquestrador ou criar um novo a partir do Wizard.

Selecionando um Runner existente¶

Basta selecionar o identificador que você deseja vincular ao Runner deste ambiente de execução.

Criando um novo Runner¶

Basta informar um identificador para o novo Runner que está sendo criado.

Dica

Ao utilizar a opção para criar um novo Runner, a criação na plataforma e a associação com o Runner do ambiente de execução será feita automaticamente.

Dessa forma, quando iniciar o Runner no ambiente de execução através dos scripts BotRunner ou BotRunner-gui do SDK, esse Runner estará associado ao Runner que foi criado no BotCity Orchestrator.

Personalizando a configuração do Runner¶

Info

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.

conf.bcf

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, também podemos incluir configurações personalizadas conforme a necessidade.

Na tabela abaixo podemos ver 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 Maestro 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 Maestro, 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á.

Iniciando o Runner¶

O BotCity Runner agora suporta a execução com ou sem uma interface gráfica do usuário (GUI).

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 Maestro e comece o processamento das tarefas.

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.