Lab 1.2: Setup e configuração - BotCity Studio SDK

Criando uma conta BotCity

Para conseguir fazer o download do SDK do BotCity Studio, o pré-requisito principal é ter uma conta BotCity devidamente criada e ativa.

Você pode criar uma nova conta acessando a página de SIGN UP.

Após criar uma nova conta, você receberá o e-mail de ativação da conta, após ativar a conta, você poderá fazer o login no Orquestrador BotCity Maestro.

Instalação

O procedimento de instalação do BotCity Studio SDK simples, siga os passos abaixo para instalar o SDK em seu ambiente.

Download

Para baixar o Wizard, acesse o Orquestrador BotCity Maestro e clique em Baixar Studio, na seção Configuração.

Dica

Você também pode acessar a página de download do BotCity Studio através do menu superior esquerdo do Orquestrador BotCity Maestro (representado na imagem abaixo) e clicar em Studio.

Na nova página aberta, faça o download da versão compatível com o seu sistema operacional. Para esse laboratório, faremos o download da versão Windows.

Instalação com o BotCity Wizard

Após baixar o arquivo do Wizard compactado, extraia e execute o arquivo wizard-X.Y.Z.exe onde X.Y.Z corresponde a versão do Wizard.

Bem-vindo ao BotCity Wizard

Ao abrir o Wizard, você será recebido com a tela de boas-vindas. Clique em Start para começar.

Selecione onde instalar

Nessa etapa você pode selecionar a pasta onde deseja instalar o SDK. Mantenha o caminho padrão sugerido C:\...\Documentos\BotCity, em seguida clique em Next.

Autenticando com Orquestrador BotCity Maestro

Selecionando o servidor

Nessa etapa, selecione o servidor do Orquestrador BotCity Maestro através da URL e clique em Next.

• Community: https://developers.botcity.dev
• Enterprise: https://<sua empresa>.botcity.dev

Autenticando

Faça a autenticação com o Orquestrador BotCity Maestro, insira o seu login e senha no navegador que abrirá automaticamente. Após a confirmação, volte ao Wizard.

Selecionando o Workspace

Selecione o workspace que deseja usar e clique em Next.

Download do SDK

Aguarde enquanto o SDK é baixado.

Finalizando a instalação

Após o download, clique em SDK Launch para abrir as opções SDK.

Configurando um Runner

Para configurar um Runner, clique no botão Setup Runner do SDK.

Confirme o servidor

Confirme o servidor que deseja usar e clique em Next.

Autenticação e criação de Runner

Faça a autenticação com o Orquestrador BotCity Maestro e siga clicando em Create a New Runner.

Nessa etapa, crie um identificador para o Runner, para esse laboratório use ambiente-01 e clicar em Next.

Uma janela de confirmação será exibida, clique em Back para finalizar a instalação.

Instalação Concluída

A instalação e configuração foram finalizadas com sucesso!

Através menu do SDK você pode clicar em:

• Change version: para alteração da versão instalada para a mais recente, a anterior ou até mesmo a versão de desenvolvimento.
• Launch Studio: executa o BotCity Studio.
• Setup Runner para refazer as configurações do Runner.
• Runner-GUI executa o Runner em modo gráfico.
• Launch Runner executa o Runner em modo headless.
• Open Folder: abre a pasta onde o SDK foi instalado.
• Go to Orchestrator: abre o Orquestrador BotCity Maestro no navegador.
• Talk to a Specialist: abre o canal de suporte da BotCity.

Dica

Uma cópia do instalador existe na pasta onde o SDK foi instalado para facilitar o processo de atualização e configuração.

Explorando o conteúdo do SDK

Este SDK contém todas as ferramentas necessárias para construir, gerenciar e executar as suas automações.

Após o processo de instalação, a estrutura da pasta será semelhante a essa:

WindowsLinux e MacOS

.
├── 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 na pasta conf.

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

O conteúdo do arquivo conf.bcf será semelhante a este aqui:

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

Entendendo melhor as configurações:

• server: URL do servidor do BotCity Maestro.
• workspace: Seu workspace no BotCity Maestro.
• key: Chave da API do BotCity Maestro, localizada na página Amb. de Desenvolvedor.
• login: Usuário da API do BotCity Maestro, localizado na página Amb. de Desenvolvedor.
• machineId: ID referente ao Runner atual usado para execução, veja a página Runners.
• logScreen: Parâmetro para definir se as screenshots da máquina serão enviadas periodicamente para o BotCity Maestro (true ou false).
• logApplication: Parâmetro para definir se os logs da máquina vão ser enviados periodicamente para o BotCity Maestro (true ou false).

Você pode conferir mais a respeito das opções disponíveis para o arquivo conf.bcf em nossa documentação.

Instalando Extensão BotCity Studio no VSCode:

Com a extensão BotCity Studio, você terá acesso às ferramentas:

• Computer Vision
• Web Inspector
• Windows API Inspector

As ferramentas estão disponíveis como uma extensão do Visual Studio Code e podem ser instalada através da aba de extensões ou através do Marketplace do VSCode.

Vamos instalar a extensão da BotCity diretamente no VSCode seguindo os passos abaixo:

• Abra o VSCode
• Clique na opção Extensões
• Digite na barra de pesquisa BotCity
• Clique em Instalar

Após instalar a extensão, o atalho do BotCity Studio fica visível no menu lateral esquerdo do editor de código, como mostrado na imagem abaixo:

Com a extensão Instalada, vamos para a etapa de login na ferramenta.

• Clique no atalho da BotCity Studio
• Clique em Account para abrir o menu
• Clique em Login

Veja no Output do VSCode indicará que a extensão foi inicializada, imprimindo a mensagem semelhante a da imagem abaixo:

Em seguida, você será redirecionado para a página de login da BotCity. Basta clicar no Botão login, e em seguida, digitar o e-mail e senha nos campos requisitados para autenticar na ferramenta.

Após efetivar o login, a tela de confirmação é mostrada no navegador:

Pronto! Coma extensão devidamente instalada, vamos utilizar cada uma delas nos próximos laboratórios.