Ir para o conteúdo

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.

Download SDK

Dica

Você também pode acessar a página de download do BotCity Studio através do menu superior esquerdo do Maestro, representado pelo ícone: Maestro Menu

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

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.

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:

Dignostic report

Aviso

Caso receba o resultado FAIL em algum teste de conexão, possivelmente você deve estar tentando fazer a instalação em um ambiente de bloqueio.

Neste caso, é necessário solicitar ao time responsável as liberações descritas nesta seção.

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.

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.

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

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.

Autenticando com o BotCity Maestro

Configuring

Aviso

Para Server, certifique-se de sempre usar a sua URL do BotCity Maestro.

Se você tiver um subdomínio personalizado, é muito provável que sua URL seja algo como https://suaempresa.botcity.dev.

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

Quase pronto

finishing

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

Finalizado 🚀

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 daí e voltar a esta tela.

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.

Runner Setup

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

Runner

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

Dica

Veja mais detalhes na seção Configurando um Runner.

Ações do BotCity Wizard

Wizard Home

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"

Dica

  • Pode ser necessário informar a versão do wizard no comando, caso ele não seja encontrado. wizard-X.Y.Z install ...
  • Para sistemas Linux e macOS adicionar o comando java -jar antes do comando wizard. java -jar wizard-X.Y.Z.jar install ...

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:

Opção Obrigatório Definição Valor Padrão
dir Não Pasta onde o SDK será instalado Depende do sistema operacional
server Não URL do Orquestrador BotCity Maestro https://developers.botcity.dev
email Sim Email da conta de usuário
password Sim Senha da conta de usuário
organization Não Organization a ser usada (label) Primeira organization da lista
runner Não Runner a ser configurado (machineId) Vazio

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.

Aviso

Quando o parâmetro version não for informado, sempre será atualizado para a versão mais recente 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"

Dica

A versão do SDK pode ser verificada no arquivo setup.json na pasta onde o SDK foi instalado.

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:

Opção Obrigatório Definição Valor Padrão
server Não URL do Orquestrador BotCity Maestro Mantém o instalado
email Não Email da conta de usuário Mantém o instalado
password Sim Senha da conta de usuário
organization Não Organization a ser usada (label) Mantém o instalado
runner Não Runner a ser configurado (machineId) Mantém o instalado
version Não Versão a ser instalada Versão mais recente

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
├── conf
│   ├── conf.bcf
│   └── properties.json
├── lib
│   └── tesseract
├── run
├── scripts
│   └── console_session.bat
├── startup
│   └── startup.bat
├── venvs
├── win32
│  └── java
├── BotCLI.bat
├── BotRunner.bat
├── BotRunner-gui.bat
├── BotStudio.exe
├── diagnostic-X.Y.Z.jar
├── install.log
├── setup.json
└── wizard-X.Y.Z.exe
.
├── bin
├── conf
│   ├── conf.bcf
│   └── properties.json
├── lib
│   └── tesseract
├── run
├── scripts
├── startup
├── venvs
├── wizard-X.Y.Z.jar
├── diagnostic-X.Y.Z.jar
├── setup.json
├── install.log
├── BotCLI.sh
├── BotRunner-gui.sh
├── BotRunner.sh
└── BotStudio.sh

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

  • BotCLI.bat/BotCLI.sh: Wrapper para a ferramenta BotCity CLI (interface de linha de comando).
  • BotRunner-gui.bat/BotRunner-gui.sh: Inicia a ferramenta BotCity Runner no modo gráfico.
  • BotRunner.bat/BotRunner.sh: Inicia a ferramenta BotCity Runner no modo headless.
  • BotStudio.exe/BotStudio.sh: Inicia a ferramenta BotCity Studio.
  • bin: Pasta contendo os arquivos jar binários do BotCity SDK.
  • conf: Pasta que contém 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 Preferências para editar valores, não altere diretamente no arquivo).
  • lib: Bibliotecas de suporte para o BotCity Studio.
  • run: Pasta de tempo de execução para o BotCity Runner.
  • venvs: Pasta de tempo de execução para os ambientes virtuais Python do BotCity Runner.
  • scripts: Pasta para armazenar scripts que podem ser executados pelo BotCity Runner. Mais detalhes aqui.
  • startup: Pasta contendo um script que pode ser executado pelo BotCity Runner ao ser inicializado. Mais detalhes aqui.
  • setup.json: Arquivo contendo as informações da instalação, como a versão do SDK instalada e as credenciais de acesso utilizadas.
  • install.log: Arquivo produzido pelo Wizard contendo as informações de log da instalação.
  • diagnostic-X.Y.Z.jar: Cópia do BotCity Diagnostic criada dentro da pasta de instalação.
  • 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=
key=
login=
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:
...

Observação

Se você ver uma mensagem de SUCCESSO seguida de uma mensagem de ERRO, significa que seu BotCity Studio SDK está configurado corretamente, mas você provavelmente ainda não possui robôs implantados.

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ô.