Bots¶
En el menú Bots, puede visualizar, implementar nuevos bots y versiones, gestionar la versión que se utilizará en la ejecución, actualizar el código del bot, descargarlo y también eliminarlo de la plataforma.
Visualización de Bots¶
Al acceder al menú Bots, puede visualizar todos los bots implementados en el Orquestador BotCity en una lista, con la siguiente información en columnas:
- BotID: Identificación del bot
- Versión: Versión definida durante el deploy del bot
- Último Deploy: Fecha y hora del deploy o actualización del bot
- Versión de Release: Identifica qué versión será ejecutada por la tarea; otras versiones del mismo bot tienen la columna vacía.
- Tecnología: Identifica en qué tecnología fue desarrollado el bot
- Repositorio: Selección del repositorio donde se asignará el bot
- Acciones: Selección de acción
Crear un Bot¶
Para cada tipo de tecnología es necesaria una estructura específica para ser reconocida y ejecutada en el contexto del Orquestador BotCity.
Puede desarrollar un nuevo proyecto o adaptar uno existente. Vea los tutoriales a continuación utilizando el template de proyecto BotCity:
-
Python
-
Java
-
Javascript
Construir su proyecto de Bot¶
Tras el desarrollo completo, para enviar el bot al Orquestador BotCity necesita realizar el proceso de build del proyecto.
Hay archivos de build disponibles en los templates de proyecto de BotCity; puede ejecutar el archivo adecuado para el sistema operativo que está utilizando, ya sea Windows, Linux o macOS.
Bots Java
Para bots desarrollados en Java, utilice el archivo .jar generado en la carpeta dist/. Si se generan dos archivos .jar, utilice el archivo con jar-with-dependencies en su nombre.
Bots Python
Para bots desarrollados en Python, utilice el archivo .zip o .tar.gz generado en la carpeta dist/.
Bots Javascript
Para bots desarrollados en Javascript, utilice un archivo .zip que contenga los archivos del proyecto, como bot.js, la carpeta resources y package.json.
Operaciones con Bots¶
Tras crear el proyecto y realizar el proceso de build del bot, puede implementarlo en el Orquestador BotCity y realizar diversas operaciones descritas a continuación.
Interfaz de Línea de Comandos
Puede seguir los pasos descritos a continuación en la plataforma o realizar las operaciones de Deploy, Update y Release en la interfaz de línea de comandos de BotCity.
Vea más detalles en:
Deploy/Implementar¶
Deploy es el proceso utilizado para agregar nuevos bots o nuevas versiones de bots existentes a la plataforma BotCity.
Para implementar un bot, debe acceder al menú Bots y hacer clic en + Desplegar, luego completar los campos:
- BotID: Nombre de identificación del bot
- Versión: Versión definida por caracteres alfanuméricos y especiales
- Tecnología: Lenguaje de desarrollo del proyecto
- Repositorio: Selección del repositorio donde se asignará el bot
- Archivo: Archivo del proyecto ya construido
Update/Actualizar¶
Update es el proceso utilizado para sobrescribir una versión existente de un bot.
Sobrescritura
Observe que el proceso de actualización es irreversible y reemplazará una versión existente, incluso si está marcada como "release", por lo tanto, tenga cuidado.
Para actualizar un bot existente, debe acceder al menú Bots, hacer clic en editar en el menú de acciones de la versión del bot a actualizar, luego completar los campos:
- Tecnología: Lenguaje del proyecto desarrollado
- Archivo: Archivo del proyecto ya construido
Release/Liberar¶
Release es el proceso utilizado para marcar cuál de las versiones disponibles de un bot se utilizará al ejecutar las tareas.
La versión marcada es descargada y ejecutada por el BotCity Runner.
Para definir la versión liberada de un bot existente, debe acceder al menú Bots, hacer clic en Release en el menú de acciones de la versión del bot a marcar.
Columna Release
Cuando hay más de una versión de un bot, vea en la columna Release cuál de las versiones está marcada.
Download¶
Puede descargar el archivo de cualquier bot implementado en el Orquestador BotCity. Para ello, acceda al menú Bots y haga clic en Descargar robot en el menú de acciones de la versión del bot elegida.
Eliminar¶
Puede eliminar la versión de cualquier bot implementado en el Orquestador BotCity. Para ello, acceda al menú Bots y haga clic en Eliminar.
Eliminación
Observe que el proceso de eliminación es irreversible y eliminará permanentemente una versión existente, tenga cuidado.
Tecnologías¶
Toda automatización implementada en el Orquestador BotCity debe tener obligatoriamente definida su tecnología.
Vea a continuación qué tecnologías son aceptadas, cómo definirlas y utilizarlas.
Python¶
Al definir la tecnología Python, el Orquestador BotCity espera que cargue una automatización que utiliza el lenguaje Python en su desarrollo.
Tipo de archivo esperado
Para proyectos Python, cargue el archivo .zip o .tar.gz generado por el comando de build.
Template heredado
Recuerde que el archivo .tar.gz es generado por el comando de build del template de proyecto heredado.
Java¶
Al definir la tecnología Java, el Orquestador BotCity espera que cargue una automatización utilizando el lenguaje Java en su desarrollo.
Tipo de archivo esperado
Para proyectos Java, cargue el .jar de la carpeta /dist, generado por el comando de build. Si se generan dos archivos .jar, cargue el archivo que tiene jar-with-dependencies en su nombre.
JavaScript¶
Al definir la tecnología JavaScript, el Orquestador BotCity espera que cargue una automatización utilizando el lenguaje JavaScript en su desarrollo.
Tipo de archivo esperado
Para proyectos JavaScript, cargue un archivo .zip que contenga los archivos del proyecto, como bot.js, la carpeta resources y package.json.
Comando¶
Al definir la opción Comando como tecnología, el Orquestador BotCity acepta que ejecute cualquier tipo de comando como shell, batch o bash, permitiendo también la orquestación de automatizaciones en lenguajes como C#, Ruby, Go, VBA, así como cualquier otro.
Tipo de archivo esperado
Para proyectos del tipo Comando, el Orquestador BotCity no espera que se cargue un tipo de archivo específico, debido a la variedad de opciones de comandos aceptados. Es decir, puede cargar cualquier archivo que contenga los comandos que desea ejecutar.
Para este tipo de tecnología, al realizar la implementación o editar un bot, es necesario completar un nuevo campo llamado Comando.
En este campo puede pasar comandos, argumentos y parámetros externos para que el Runner pueda ejecutarlos.
Flags especiales para conectarse al Orquestador BotCity¶
| Flag | Descripción |
|---|---|
| {maestro_server} | URL del Orquestador BotCity |
| {maestro_taskid} | ID de la tarea en ejecución |
| {maestro_token} | Token del Orquestador BotCity preautenticado para uso en integración |
Ejemplo de comando
Pasar parámetros de la tarea¶
Es común el uso de parámetros en las automatizaciones para definir valores dinámicos en el momento de crear tareas.
En este contexto, los parámetros se pueden pasar utilizando el label del parámetro entre llaves, en el momento de crear el comando.
Ejemplo de comando con el parámetro name
- Parámetro creado en la automatización
- Parámetro recibido en el comando
Integraciones¶
Incluso utilizando la tecnología Comando, puede realizar integraciones con las funcionalidades del Orquestador BotCity, como alertas, archivos de resultado, errores, etc.
Para ello, puede utilizar la API e integrar con cualquier lenguaje utilizado en el desarrollo.
Finalizar tarea
La integración más importante es la finalización de tarea, donde puede hacer seguimiento del estado de cada tarea, y el reporte de datos, informando la cantidad de elementos ejecutados con éxito o con falla en una ejecución.
Vea más detalles en: