BotCity Studio SDK¶

El BotCity Studio SDK es un paquete todo en uno que contiene todas las herramientas necesarias para construir, implementar y ejecutar tus automatizaciones de BotCity.

Incluye las herramientas BotCity Studio, BotCity Runner y BotCity CLI (interfaz de línea de comandos).

El procedimiento de instalación del BotCity Studio SDK es muy sencillo y consta de solo dos pasos:

1. Descargar y descomprimir el BotCity Wizard
2. Seguir las instrucciones en pantalla

Descargar¶

Para descargar el Wizard, simplemente inicia sesión en tu espacio de trabajo de Maestro y haz clic en Descargar Studio, en la sección Setup.

En la nueva página que se abre, descarga la versión compatible con tu sistema operativo.

Herramienta de Diagnostico¶

La herramienta BotCity - Diagnostic acompaña al paquete Wizard y su objetivo principal es validar si su entorno cumple con los requisitos previos para usar el SDK de BotCity Studio.

De esta manera, la herramienta validará si es posible realizar la instalación en su entorno y también si las herramientas de BotCity podrán establecer una conexión exitosa con Orchestrator.

Para diagnosticar su entorno, simplemente ejecute diagnostic.jar, proporcione las credenciales solicitadas y presione Ejecutar. Con esto tendrás una devolución similar a la siguiente:

Además de la información de conexión, BotCity - Diagnostic también verifica las versiones de Python y Java de su entorno.

Si observa una falla en una de estas pruebas, verifique si su entorno cumple con los prerrequisitos para usar las herramientas de BotCity.

También puede exportar los resultados de las pruebas a un archivo CSV utilizando el botón Export.

Instalación¶

Una vez completada la descarga, extraiga el archivo descargado. Habrá un archivo llamado wizard-X.Y.Z donde X.Y.Z es la versión del Wizard.

Para proceder con la instalación, podemos elegir entre dos opciones:

• Instalar a través de GUI (interfaz gráfica)
• Instalar mediante línea de comando (instalación silenciosa)

Instalación mediante GUI (interfaz gráfica)¶

A través de la interfaz gráfica, el Wizard lo guiará en cada paso del proceso de instalación.

Elige dónde instalar¶

Autenticación con BotCity Maestro¶

Casi listo¶

Espera mientras se completa la descarga y se configura el SDK.

¡Estás listo para empezar! 🚀¶

Configuración de un BotCity Runner¶

Después de completar la instalación del SDK, puede configurar un Runner en su entorno de ejecución usando la opción Setup Runner.

Puede elegir un Runner que ya exista en su espacio de trabajo de Orchestrator o crear uno nuevo.

Si es la primera vez que lo instalas, te recomendamos encarecidamente crear uno para poder ejecutar tus automatizaciones.

Acciones del BotCity Wizard¶

A continuación se muestran algunas acciones que puede realizar desde la pantalla de inicio del Wizard:

• Cambiar la versión a una más nueva o anterior, así como a una versión development
• Configurar un BotCity Runner
• Iniciar BotCity Studio
• Iniciar BotCity Runner como un proceso en segundo plano o como una aplicación visual (GUI)
• Abrir la carpeta en la que se instaló el SDK

Instalación mediante línea de comando (instalación silenciosa)¶

Otra forma de instalar el SDK es mediante la línea de comando, ingresando los parámetros necesarios para la instalación.

Comandos de instalación¶

Podemos instalarlo usando el comando wizard install e ingresando algunos parámetros.

El comando más simple posible es aquel en el que solo ingresamos los parámetros obligatorios email y password, que se utilizan para la autenticación en BotCity Maestro Orchestrator.

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

Para realizar la instalación completa, con todos los parámetros, podemos utilizar el siguiente comando:

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

Tabla de parámetros para el comando de instalación:

Actualizar comandos¶

Para actualizar la configuración del SDK, podemos usar el comando wizard update, informando siempre el parámetro password, los demás parámetros son opcionales. Además de los parámetros de instalación, podemos ingresar el parámetro version para actualizar la versión del SDK.

Solo podemos ingresar un parámetro opcional como en el siguiente ejemplo (incluye actualización de versión):

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

O haga una actualización completa, con todos los parámetros como en el siguiente ejemplo:

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

Con este comando no podemos cambiar la ubicación de instalación del SDK, por lo que debemos rehacer la instalación.

Tabla de parámetros para el comando de actualización:

Explorando el contenido¶

Después de extraer el archivo descargado, encontrarás la siguiente estructura de carpetas:

.
├── 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

En la carpeta raíz del SDK, encontrarás los siguientes archivos:

• .cookieCli: archivo de cookie de sesión del BotCity CLI.
• .workspaceCli: archivo de espacio de trabajo utilizado por el CLI.
• bin: carpeta que contiene los archivos binarios .jar correspondientes al BotCity SDK.
• BotCLI.bat/BotCLI.sh: acceso directo para utilizar el BotCity CLI (herramienta de línea de comandos).
• BotRunner-gui.bat/BotRunner-gui.sh: acceso directo para iniciar el BotCity Runner en modo gráfico.
• BotRunner.bat/BotRunner.sh: acceso directo para iniciar el BotCity Runner en modo headless (en segundo plano).
• bots: carpeta de caché de bots (uso interno del BotCity Runner).
• BotStudio.exe/BotStudio.sh: acceso directo para iniciar el BotCity Studio.
• conf: carpeta que contiene los archivos de configuración.
  • conf.bcf: archivo de configuración del BotCity Studio.
  • properties.json: archivo de propiedades del BotCity Studio (utilice el menú de 'Preferencias' para editar los valores en lugar de modificar directamente este archivo).
• diagnostic.jar: herramienta para validar los prerrequisitos del entorno para usar las herramientas de BotCity.
• install.log: archivo de registro de instalación generado por el asistente.
• logs: carpeta de almacenamiento de registros del BotCity Runner.
• probes: carpeta con información sobre los horarios de comunicación del Runner con el Orquestador.
• run: carpeta utilizada por el BotCity Runner durante la ejecución.
• scripts: carpeta para almacenar scripts que pueden ser ejecutados por el BotCity Runner.
• setup.json: archivo que contiene información de la instalación, como la versión del SDK instalada y las credenciales de acceso utilizadas.
• startup: carpeta que contiene un script que puede ser ejecutado por el BotCity Runner al inicializarse.
• venvs: carpeta utilizada por el BotCity Runner para gestionar los entornos virtuales de las automatizaciones en Python.
• win32: carpeta que contiene la versión de Java utilizada por el SDK.
• wizard-X.Y.Z.exe/wizard-X.Y.Z.jar: copia del BotCity Wizard creada dentro de la carpeta de instalación.

Configuración¶

La configuración del SDK de BotCity Studio se realiza a través del archivo conf.bcf ubicado en el directorio "conf".

Usando el Wizard, este archivo se genera automáticamente para ti, pero aún puedes personalizarlo según tus necesidades.

Echemos un vistazo al contenido del archivo 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 del servidor de BotCity Maestro.
• workspace: Espacio de trabajo de BotCity Maestro.
• key: Clave de API de BotCity Maestro ubicada en la página Ambiente de desarrollo.
• login: Usuario de API de BotCity Maestro ubicado en la página Ambiente de desarrollo.
• machineId: ID de máquina de la máquina actual. Consulta Máquinas.
• logScreen: Opción booleana que define si se envían capturas de pantalla periódicamente a BotCity Studio.
• logApplication: Opción booleana que define si los registros de BotCity Runner se envían periódicamente a BotCity Studio.

Prueba de tu SDK de BotCity Studio¶

La forma más sencilla de probar tu SDK de BotCity Studio es utilizar la herramienta BotCity CLI.

Para ello, abre una terminal en la carpeta que contiene el SDK de BotCity Studio y ejecuta el siguiente comando:

./BotCLI.bat bot list

./BotCLI.sh bot list

Si tu SDK de BotCity Studio está configurado correctamente, deberías ver la siguiente salida:

SUCCESS:
...

Siguientes pasos¶

Ahora estás listo para comenzar a desarrollar tus automatizaciones de BotCity.

Pasemos al siguiente paso y comencemos a desarrollar tu primer bot.