BotCity Studio SDK¶

O BotCity Studio SDK é um pacote completo, que contém todas as ferramentas necessárias para construir, implantar e executar suas automações BotCity.

Inclui as ferramentas BotCity Studio, BotCity Runner e BotCity CLI (interface de linha de comando).

O procedimento de instalação do BotCity Studio SDK é muito simples e consiste em apenas duas etapas:

1. Baixe e descompacte o BotCity Wizard
2. Siga as instruções na tela

Download¶

Para baixar o Wizard, basta acessar seu workspace no Maestro e clicar em Download Studio, na seção Setup.

Na nova página aberta, basta fazer o download da versão compatível com o seu sistema operacional.

Ferramenta de Diagnóstico¶

A ferramenta BotCity - Diagnostic acompanha o pacote do Wizard e tem como objetivo principal validar se o seu ambiente atende os pré-requisitos para a utilização do BotCity Studio SDK.

Desta forma, a ferramenta irá validar se é possível realizar a instalação no seu ambiente e também se as ferramentas BotCity irão conseguir estabelecer uma conexão bem-sucedida com o Orquestrador.

Para obter o diagnóstico do seu ambiente, basta executar o diagnostic.jar, fornecer as credencias solicitadas e apertar Run. Com isso, você terá um retorno parecido com o abaixo:

Além das informações de conexão, o BotCity - Diagnostic também verifica as versões de Python e Java do seu ambiente.

Caso observar alguma falha em um desses testes, verifique se o seu ambiente atende os pré-requisitos para utilizar as ferramentas BotCity.

Você também pode exportar os resultados dos testes para um arquivo CSV, através do botão Export.

Instalando¶

Após a conclusão do download, extraia o arquivo baixado. Haverá um arquivo chamado wizard-X.Y.Z onde X.Y.Z representa a versão do Wizard.

Para seguir com a instalação, podemos escolher entre duas opções:

• Instalar via GUI (interface gráfica)
• Instalar via linha de comando (instalação silenciosa)

Instalando via GUI (interface gráfica)¶

Através da interface gráfica, o Wizard irá guiá-lo por cada etapa do processo de instalação.

Escolha onde instalar¶

Autenticando com o BotCity Maestro¶

Quase pronto¶

Aguarde enquanto o download termina e o SDK está sendo configurado.

Finalizado 🚀¶

Configurando um BotCity Runner¶

Após finalizar a instalação do SDK, você poderá configurar um Runner no seu ambiente de execução através da opção Setup Runner.

É possível escolher um Runner que já existe no seu workspace do Orquestrador ou criar um novo.

Se esta é a primeira vez que você está instalando, recomendamos criar um novo Runner para que você possa executar suas automações.

Ações do BotCity Wizard¶

Aqui estão algumas ações que você pode executar a partir da tela inicial do Wizard:

• Alterar a versão para uma versão mais recente ou anterior, bem como para uma versão de desenvolvimento
• Configurar um BotCity Runner
• Iniciar o BotCity Studio
• Iniciar o BotCity Runner como um processo em segundo plano ou como um aplicativo visual (GUI)
• Abrir a pasta em que o SDK foi instalado

Instalando via linha de comando (instalação silenciosa)¶

Outra forma de instalar o SDK é por linha de comando, informando os parâmetros necessários para a instalação.

Comandos de instalação¶

Podemos fazer a instalação, usando o comando wizard install e informando alguns parâmetros.

O comando mais simples possível é aquele que informamos apenas os parâmetros obrigatórios email e password, os quais são utilizados para autenticação no Orquestrador BotCity Maestro.

wizard install 
  --email "user@server.com"
  --password "bot32r$3usr74"

Para fazer a instalação completa, com todos os parâmetros, podemos usar o seguinte comando:

wizard install 
  --dir "C:\BotCity"
  --server "https://developers.botcity.dev"
  --email "user@server.com"
  --password "bot32r$3usr74"
  --organization "superbots"
  --runner "vm-01"

Tabela de parâmetros para o comando de instalação:

Comandos de atualização¶

Para atualizar as configurações do SDK, podemos usar o comando wizard update informando sempre o parâmetro password, os demais parâmetros são opcionais. Além dos parâmetros de instalação, podemos informar o parâmetro version para atualizar a versão do SDK.

Podemos informar apenas um parâmetro opcional como no exemplo abaixo (inclui a atualização de versão):

wizard update
  --password "bot32r$3usr74"
  --runner "vm-01"

Ou fazer uma atualização completa, com todos os parâmetros como no seguinte exemplo:

wizard update 
  --server "https://developers.botcity.dev"
  --email "user@server.com"
  --password "bot32r$3usr74"
  --organization "superbots"
  --runner "vm-01"
  --version "v2.16.5"

Com esse comando não podemos alterar o local de instalação do SDK, para isso é necessário refazer a instalação.

Tabela de parâmetros para o comando de atualização:

Explorando o Conteúdo¶

Depois de finalizar a instalação do SDK utilizando uma das formas acima, você encontrará a seguinte estrutura de pastas:

.
├── bin
├── bots
├── conf
│   ├── conf.bcf
│   └── properties.json
├── logs
├── probes
├── run
├── scripts
├── startup
├── venvs
├── win32
│   └── java
├── .cookieCli
├── .workspaceCli
├── BotCLI.bat
├── BotRunner.bat
├── BotRunnerBackgroundWrapper.bat
├── BotRunner-gui.bat
├── BotStudio.exe
├── diagnostic.jar
├── install.log
├── setup.json
└── wizard-X.Y.Z.exe

.
├── .cookieCli
├── .workspaceCli
├── bin
├── BotCLI.sh
├── BotRunner-gui.sh
├── BotRunner.sh
├── bots
├── BotStudio.sh
├── conf
│   ├── conf.bcf
│   └── properties.json
├── diagnostic.jar
├── install.log
├── logs
├── probes
├── run
├── scripts
├── setup.json
├── startup
├── venvs
└── wizard-X.Y.Z.jar

Na pasta raiz do SDK, você encontrará os seguintes arquivos:

• .cookieCli: arquivo de cookie de sessão do BotCity CLI.
• .workspaceCli: arquivo de workspace utilizado pelo CLI.
• bin: pasta contendo os arquivos binários .jar referentes ao BotCity SDK.
• BotCLI.bat/BotCLI.sh: atalho para utilizar o BotCity CLI (ferramenta de interface de linha de comando).
• BotRunner-gui.bat/BotRunner-gui.sh: atalho para iniciar o BotCity Runner no modo gráfico.
• BotRunner.bat/BotRunner.sh: atalho para iniciar o BotCity Runner no modo headless (background).
• bots: pasta de cache de bots (uso interno do BotCity Runner).
• BotStudio.exe/BotStudio.sh: atalho para iniciar o BotCity Studio.
• conf: pasta contendo os arquivos de configuração.
  • conf.bcf: arquivo de configuração do BotCity Studio.
  • properties.json: arquivo de propriedades do BotCity Studio (use o menu de 'Preferências' para editar os valores ao invés de alterar diretamente este arquivo).
• diagnostic.jar: ferramenta para validar os pré-requisitos do ambiente para utilizar as ferramentas BotCity.
• install.log: arquivo de log da instalação produzido pelo Wizard.
• logs: pasta de armazenamento de logs do BotCity Runner.
• probes: pasta com informações de horário de comunicação do Runner com o Orquestrador.
• run: pasta utilizada pelo BotCity Runner durante a execução.
• scripts: pasta para armazenar scripts que podem ser executados pelo BotCity Runner.
• setup.json: arquivo contendo as informações da instalação, como a versão do SDK instalada e as credenciais de acesso utilizadas.
• startup: pasta contendo um script que pode ser executado pelo BotCity Runner ao ser inicializado.
• venvs: pasta utilizada pelo BotCity Runner para gerenciar os ambientes virtuais das automações Python.
• win32: pasta contendo a versão do Java utilizada pelo SDK.
• wizard-X.Y.Z.exe/wizard-X.Y.Z.jar: cópia do BotCity Wizard criada dentro da pasta de instalação.

Configuração¶

A configuração do BotCity Studio SDK é feita através do arquivo conf.bcf localizado no diretório "conf".

Usando o Wizard, esse arquivo é gerado automaticamente para você, mas você ainda pode personalizá-lo de acordo com suas próprias necessidades.

Vamos dar uma olhada no conteúdo do arquivo conf.bcf:

server=https://developers.botcity.dev
workspace=<Your Workspace Here>
key=<Your Key Here>
login=<Your Login Here>
machineId=<Your Machine ID Here>
logScreen=true
logApplication=true

• server: URL do servidor do BotCity Maestro.
• workspace: Espaço de trabalho do BotCity Maestro.
• key: Chave da API do BotCity Maestro localizada na página Amb. Desenvolvedor.
• login: Usuário da API do BotCity Maestro localizado na página Amb. Desenvolvedor.
• machineId: ID do Runner atual. Veja a página Runners.
• logScreen: Opção booleana que define se as capturas de tela são ou não enviadas periodicamente ao BotCity Maestro.
• logApplication: Opção booleana que define se os logs do BotCity Runner são ou não enviados periodicamente ao BotCity Maestro.

Testando seu SDK do BotCity Studio¶

A maneira mais fácil de testar seu SDK do BotCity Studio é usar a ferramenta BotCity CLI.

Para isso, abra um terminal na pasta que contém o BotCity Studio SDK e execute o seguinte comando:

./BotCLI.bat bot list

./BotCLI.sh bot list

Se o seu SDK do BotCity Studio estiver configurado corretamente, você deverá ver a seguinte saída:

SUCCESS:
...

Próximos Passos¶

Agora você está pronto para começar a desenvolver suas automações BotCity.

Vamos para o próximo passo e começar a desenvolver seu primeiro robô.