Ir para o conteúdo

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

Criar uma conta BotCity

Para você 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á no e-mail utilizado as suas credenciais de acesso ao Maestro.

Instalação

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 Orquestrador BotCity Maestro e clicar no botão azul Baixar Studio, no menu lateral, localizado na seção Configuração.

Download SDK

Dica

Você também pode acessar a página do Studio para fazer o download, através do menu superior esquerdo do Orquestrador BotCity Maestro:

Maestro Menu

Na nova página aberta, selecione a versão compatível com o seu sistema operacional e faça o download.

Neste workshop faremos o download para o sistema operacional Windows. Após a conclusão do download, extraia o arquivo baixado.

Download SDK Options

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.

Ela valida se é possível estabelecer uma conexão com o Orquestrador BotCity Maestro e se as ferramentas necessárias, como Java e Python, estão corretamente configuradas no seu ambiente.

Para obter o diagnóstico do seu ambiente, basta executar o diagnostic.jar, selecionar o servidor e pressionar o botão azul Run Tests. Você será direcionado a fazer o login na sua conta BotCity, em seguida os testes serão feitos automaticamente.

Ao finalizar, você terá um retorno parecido com a imagem abaixo:

Diagnostic report

Informação

Essa é uma ferramenta completamente opcional, você pode utilizá-la caso ache necessário, ou caso perceba algum impedimento na instalação ou utilização das ferramentas BotCity. Para mais informações, acesse a documentação.

Instalando

Haverá um arquivo chamado wizard-X.Y.Z onde X.Y.Z representa a versão do Wizard, execute o arquivo wizard-X.Y.Z.exe e siga as instruções na tela.

Iniciando o processo

Na tela inicial, clique em Start.

Start

Passo 1 - Setup

  • Selecione o local onde deseja instalar as ferramentas do BotCity Studio SDK.
  • Clique em Next.

Install

Aviso

Esteja ciente de que a instalação em locais como C:\... pode causar problemas de permissão.

Tente evitar esses locais ou certifique-se de corrigir as permissões conforme necessário.

Passo 2 - Login

  • Selecione o servidor.
  • Clique em Next.
  • Realize o login com suas credenciais BotCity.

Configuring

Atenção

Em Server use sempre a URL do seu Orquestrador BotCity Maestro.

Caso sua empresa já use BotCity é provável que sua URL seja algo como https://sua-empresa.botcity.dev.

Para a versão Community use https://developers.botcity.dev.

Passo 3 - Download

Com a autenticação realizada com sucesso, o download das ferramentas será feito automaticamente.

finishing

Passo 4 - Finalização

Download concluído. Agora podemos seguir para a etapa de configuração do Runner.

  • Clique em SDK Lounch.

Finish

Dica

Uma cópia do Wizard agora está disponível na pasta em que o SDK foi instalado. Você pode sempre iniciá-lo a partir dela e voltar a esta tela.

Configurar um Runner

Nessa etapa será configurado um Runner para essa instalação.

Passo 1 - Setup do Runner

  • Clique em Setup Runner.

Runner

Passo 2 - Novo Runner

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

  • Clique em Create a New Runner.

Runner

Passo 3 - Configuração do Runner

  • Dê um nome para o Runner.
  • Clique em Next.

Runner Name

Passo 4 - Confirmação

  • Aguarde a confirmação.

Tudo pronto! O Runner foi criado com sucesso e está pronto para ser utilizado.

Runner Confirmation

Ações do BotCity Wizard

Concluida

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 seu 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 onde o SDK foi instalado.

Dica

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

Explore 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:

.
├── .cookieCli
├── .workspaceCli
├── bin
├── bot
├── BotCLI.bat
├── BotRunner-gui.bat
├── BotRunner.bat
├── BotStudio.exe
├── conf
│   ├── conf.bcf
│   └── properties.json
├── install.log
├── logs
├── run
├── scripts
├── setup.json
├── startup
├── venvs
└── win32
    └── java

.
├── .cookieCli
├── .workspaceCli
├── bin
├── bot
├── BotCLI.sh
├── BotRunner-gui.sh
├── BotRunner.sh
├── BotStudio.sh
├── conf
│   ├── conf.bcf
│   └── properties.json
├── install.log
├── logs
├── run
├── setup.json
└── venvs

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 SDK.
  • bot: pasta de cache de bots (uso interno do BotCity Runner).
  • 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).
  • 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).
  • install.log: arquivo de log da instalação.
  • logs: pasta de armazenamento de logs do BotCity Runner.
  • run: pasta utilizada pelo BotCity Runner durante a execução.
  • scripts: pasta contendo scripts de inicialização do SDK.
  • setup.json: arquivo de configuração da instalação.
  • startup: pasta contendo scripts legados de inicialização do SDK.
  • 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.

Configuração

A configuração do BotCity Studio SDK é feita através do arquivo conf.bcf localizado na pasta conf.

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

server=https://developers.botcity.dev
workspace=<codigo_workspace>
key=NOM_1A235ASFGA6F6AHJ501H459
login=<codigo_login>
machineId=Execucao
logScreen=true
logApplication=true

Entenda 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 na documentação.