Saltar a contenido

Tareas

El recurso de Tareas en el menú lateral del Orquestador BotCity es el lugar donde puedes gestionar todas las tareas creadas para los procesos de automatización de tu workspace.

Visualización de la cola de tareas

Puedes organizar la visualización de la cola de tareas en dos formatos diferentes:

Tarjetas

En este formato, cada tarea se muestra en una tarjeta individual con información esencial como:

  • Nombre de la automatización
  • ID de la tarea
  • Estado actual
  • Botón de acciones disponibles

Captura de pantalla del Orquestador de BotCity, en el menú Tareas, presentando el menú de filtros y la visualización en Tarjetas de la cola de tareas. Cada tarjeta muestra el nombre de la automatización, ID de la tarea, estado actual y un botón de acciones disponibles.

Lista

En este formato, las tareas se muestran en una tabla, permitiendo una vista más detallada y organizada de las tareas.

Puedes ver las siguientes columnas:

  • ID: Identificador único de la tarea.
  • Prioridad: Nivel de prioridad asignado a la tarea (0 a 10).
  • Estado: Estado actual de la tarea.
  • Última actualización: Fecha y hora de la última actualización de la tarea.
  • Nombre de la Automatización: Nombre del proceso de automatización asociado a la tarea.
  • Runner | Status: Nombre del Runner responsable de la ejecución de la tarea y su estado actual.
  • Nombre de Usuario: Nombre del usuario que creó la tarea.
  • Fecha de creación: Fecha y hora en que se creó la tarea.
  • Ítems procesados: Cantidad de ítems procesados con éxito por la tarea.
  • Ítems fallidos: Cantidad de ítems que fallaron durante el procesamiento por la tarea.
  • Mensaje de finalización: Mensaje asociado a la finalización de la tarea.
  • Elementos informados: Alerta de reporte de ítems incompleto.
  • Repositorio: Nombre del repositorio donde está almacenada la automatización.
  • Botón de Acciones: Acciones disponibles para la tarea.

Captura de pantalla del Orquestador de BotCity, en el menú Tareas, presentando la visualización en Lista de la cola de tareas. La tabla muestra las columnas: ID de la tarea, Prioridad, Estado, Última actualización, Nombre de la Automatización, Runner | Estado, Nombre de Usuario, Fecha de creación, Ítems procesados. La tabla contiene varias tareas listadas con la información completada en cada columna, y un menú de acciones disponible para cada tarea.

Personalizar la visualización de las tareas

Cuando se selecciona el formato de lista, también puedes personalizar la tabla de visualización de las tareas según tus preferencias.

Para personalizar la visualización:

  • Selecciona el menú de opciones de la columna deseada.
  • Elige el pin (📌) para fijar la columna en la tabla.

De esta forma, todas las columnas seleccionadas se guardarán como configuración predeterminada para la visualización de la cola de tareas.

GIF que demuestra cómo personalizar la visualización de la cola de tareas, seleccionando el menú de opciones de algunas columnas y eligiendo el pin para fijar la columna en la tabla para visualización futura. También presenta el menú de opciones para ocultar columnas no deseadas en la visualización de la cola de tareas.

Consejo

A través del botón Personaliza la visualización de la lista de tareas puedes encontrar un resumen de cómo configurar la visualización.

GIF que demuestra cómo acceder a la guía de personalización de la visualización de la cola de tareas, haciendo clic en el botón "Personaliza la visualización de la lista de tareas" ubicado cerca del menú de opciones de las columnas. La guía presenta un resumen de cómo configurar la visualización de la cola de tareas, incluyendo cómo fijar columnas para visualización futura y ocultar columnas no deseadas.

Búsqueda y filtros

Es posible combinar varios filtros en la parte superior de la cola de tareas para realizar búsquedas según tus necesidades.

Búsqueda por:

  • ID de la Tarea: Búsqueda por el ID único de la tarea.

Filtros disponibles:

  • Automatización: Selecciona una o más automatizaciones.
  • Repositorio: Selecciona un repositorio específico.
  • Estado: Selecciona el estado actual de la tarea (Iniciado, Ejecutando, Finalizado, Fallido, Parcialmente completado, Cancelado o Tiempo agotado).
  • Runner: Selecciona un Runner específico.
  • Período: Selecciona una fecha o período para filtrar.

Ordenación:

  • Más reciente primero
  • Más antiguo primero

GIF del Orquestador de BotCity, en el menú Tareas, presentando los filtros para la visualización de las tareas. Muestra los tres campos principales disponibles para filtro: Búsqueda por ID, Filtro, Ordenación.

Avisos

Algunos avisos pueden aparecer en la cola de tareas. Estos avisos pueden ayudar a gestionar mejor las ejecuciones.

  • Runners sin conexión

    Si hay tareas en la cola asociadas a Runners que están desconectados, se mostrará un aviso para que revises tus Runners asignados. Este aviso incluye un enlace directo al menú de Runners de la plataforma, donde podrás gestionar los Runners de tu workspace. Captura de pantalla del Orquestador de BotCity, en el menú Tareas, presentando un aviso de Runners sin conexión para tareas asociadas a Runners que están desconectados. El aviso incluye un enlace directo a la pestaña Runners de la plataforma, donde es posible gestionar los Runners del workspace.

  • Ítems no reportados

    En caso de que una tarea haya finalizado sin reportar el número total de ítems procesados, se mostrará un aviso en la columna Ítems del informe. Este aviso sirve para informar que la tarea no reportó los datos esperados. Es importante que los datos sean reportados en la finalización de la tarea. Captura de pantalla del Orquestador de BotCity, en el menú Tareas, presentando un aviso de ítems no reportados para tareas que finalizaron sin reportar el número total de ítems procesados. La alerta se muestra en la columna "Ítems del informe" e incluye un ícono de aviso.

Información de la tarea

Cada tarea tiene información detallada a la que se puede acceder para comprender mejor su estado, los parámetros utilizados, los mensajes de finalización y otros datos relevantes.

Estado

El estado de una tarea indica en qué fase del ciclo de vida se encuentra. Esta tarea puede tener varios estados a medida que avanza el proceso de automatización.

Los estados posibles son:

Iniciado: Indica que la tarea está en la cola de ejecución, esperando ser procesada por alguno de los Runners vinculados al proceso de automatización.

Ejecutando: La tarea fue dirigida a un Runner disponible y está en ejecución.

Finalizado: El procesamiento de la tarea finalizó con éxito.

Fallido: El procesamiento de la tarea finalizó con fallo.

Parcialmente completado: El procesamiento de la tarea finalizó de forma parcial. Por ejemplo, considera un proceso donde algunos ítems se procesaron con éxito y otros con fallo en una única tarea.

Cancelado: La ejecución de la tarea fue cancelada antes de que fuera tomada para ejecución.

Tiempo Agotado: La tarea tardó más de lo previsto en completarse.

Maestro SDK

Para más información sobre cómo implementar la funcionalidad de finalización de tarea en código, consulta la sección Tareas del Maestro SDK.

Captura de pantalla del Orquestador de BotCity, en el menú Tareas, presentando los diferentes estados posibles de una tarea: En espera, Ejecutando, Finalizado, Falló, Parcialmente finalizado y Cancelado. Cada estado está representado por un ícono de color correspondiente.

Información detallada

Para acceder a la información detallada de una tarea específica, tienes dos opciones según el formato de visualización elegido.

  • Tarjetas: Haz clic en el nombre de la automatización dentro de la tarjeta de la tarea. Captura de pantalla del Orquestador de BotCity, en el menú Tareas, presentando la visualización en Tarjetas de la cola de tareas. Cada tarjeta muestra el nombre de la automatización, ID de la tarea, estado actual y un botón de acciones disponibles. El nombre de la automatización está destacado para indicar que es clickable y lleva a la información detallada de la tarea.
  • Lista: Haz clic en el ID de la tarea en la tabla o en el menú de acciones de la tarea y haz clic en Info. Captura de pantalla del Orquestador de BotCity, en el menú Tareas, presentando la visualización en Lista de la cola de tareas. La tabla muestra las columnas: ID de la tarea, Prioridad, Estado, Última actualización, Nombre de la Automatización, Runner | Estado. El ID de la tarea está destacado para indicar que es clickable y lleva a la información detallada de la tarea.

Al acceder a los detalles de una tarea, encontrarás varias secciones con información importante sobre la ejecución de la tarea.

En la parte superior de la página se encuentra:

  • ID de la tarea: Identificador único de la tarea.
  • Botón de Acciones: Acciones disponibles para la tarea.
  • Pestañas de navegación: Permite navegar entre las secciones de Información, Errores, Alertas y Archivos de resultado.

Pestaña Información

En la pestaña de Información, encontrarás varias secciones con detalles sobre la tarea.

Tarjetas de resumen:

  • Estado: Muestra la información del estado de la tarea.
  • Ítems procesados: Cantidad de ítems procesados con éxito por la tarea.
  • Ítems fallidos: Cantidad de ítems procesados con fallo por la tarea.
  • Ejecución: El tiempo empleado en la ejecución de la tarea, desde el inicio hasta la finalización.
  • Runner: El Runner responsable de la ejecución de la tarea.
  • Mensaje de finalización: El mensaje asociado a la finalización de la tarea.
  • Parámetros: Los parámetros de entrada y sus valores utilizados en la ejecución de la tarea.

Datos reportados

Los datos reportados en las tarjetas Ítems procesados e Ítems fallidos también se utilizan para componer los informes de datos de BotCity Insights. Por lo tanto, es importante que el código de la automatización reporte correctamente todos los datos procesados. Consulta la sección Tareas del Maestro SDK para saber cómo reportar los datos.

Captura de pantalla del Orquestador de BotCity, en la página de información de una tarea específica, presentando el ID de la tarea, el botón de acciones disponibles para la tarea y las pestañas de navegación para acceder a las secciones de Información (seleccionada), Errores, Alertas y Archivos de resultado. Se muestran las tarjetas de resumen con los detalles del estado, ítems procesados, ítems con fallo, tiempo de ejecución, Runner responsable, mensaje de finalización y parámetros utilizados en la ejecución de la tarea.

Información de control:

  • Cola de control: Información de control de la cola de tareas:
    • Prioridad: Nivel de prioridad asignado a esta tarea (0 a 10).
    • Fecha de ejecución mínima: Fecha y hora mínima definida para esta ejecución de la tarea.
    • ¿Interrupción solicitada?: Indica si se solicitó la detención durante la ejecución de la tarea ( o No).
    • ¿Tarea terminada?: Indica si la tarea fue forzadamente terminada ( o No).
  • Resumen de la tarea: Información de la tarea:
    • ID: Identificador único de la tarea.
    • Automatización: Nombre de la automatización asociada a la tarea.
    • Nombre de Usuario: Nombre del usuario que creó la tarea.
    • Tarea de Prueba: Indica si es una tarea de prueba ( o No).
    • ID del Bot: Identificador único del robot asociado a la tarea.
    • Versión: Versión del robot utilizado en la tarea.
  • Runtime: Información de la ejecución:
    • Runner asignado: Nombre del Runner responsable de la ejecución de la tarea.
    • Fecha de creación: Fecha y hora en que se creó la tarea.
    • Fecha de Inicio de Ejecución: Fecha y hora en que la tarea comenzó su ejecución.
    • Fecha de Última Actualización: Fecha y hora en que la tarea fue actualizada por última vez.
    • Ciclo de Vida: Tiempo total desde la creación hasta la finalización de la tarea.
    • Tiempo en la cola: Tiempo total que la tarea permaneció en la cola de ejecución, desde el momento de creación hasta el inicio del procesamiento.

Captura de pantalla del Orquestador de BotCity, en la página de información de una tarea específica, presentando la información de control de la cola de tareas, el resumen de la tarea y el runtime.

Pestaña Errores

En la pestaña de Errores, puedes visualizar todos los errores que ocurrieron durante la ejecución de la tarea.

Los errores se muestran en una tabla con las siguientes columnas:

  • ID de error: Identificador único del error con un enlace para ver más detalles sobre el error.
  • Fecha: Fecha y hora en que ocurrió el error.
  • Tipo de error: Tipo del error ocurrido.
  • Mensaje: Descripción del error ocurrido.

Captura de pantalla del Orquestador de BotCity, en la página de información de una tarea específica, presentando el ID de la tarea, el botón de acciones disponibles para la tarea y las pestañas de navegación para acceder a las secciones de Información, Errores (seleccionada), Alertas y Archivos de resultado. La pestaña contiene un número que indica la cantidad de errores ocurridos durante la ejecución de la tarea. La tabla muestra la lista de errores ocurridos durante la ejecución de la tarea para acceso detallado.

Pestaña Alertas

En la pestaña de Alertas, puedes visualizar todas las alertas emitidas durante la ejecución de la tarea.

Las alertas se muestran en una tabla con las siguientes columnas:

  • Tipo de alerta: Tipo de alerta emitida (Información, Aviso o Error).
  • Alerta: Título de la alerta emitida con enlace para ver más detalles sobre la alerta y descripción personalizada.
  • Fecha: Fecha y hora en que se emitió la alerta.

Captura de pantalla del Orquestador de BotCity, en la página de información de una tarea específica, presentando el ID de la tarea, el botón de acciones disponibles para la tarea y las pestañas de navegación para acceder a las secciones de Información, Errores, Alertas (seleccionada) y Archivos de resultado. La pestaña contiene un número que indica la cantidad de alertas emitidas durante la ejecución de la tarea. La tabla muestra la lista de alertas emitidas durante la ejecución de la tarea para acceso detallado.

Pestaña Archivos de Resultado

En la pestaña de Archivos de Resultado, puedes visualizar todos los archivos enviados durante la ejecución de la tarea.

Los archivos se muestran en una tabla con las siguientes columnas:

  • Nombre: Nombre del archivo enviado.
  • Automatización: Nombre de la automatización que generó el archivo.
  • Fecha: Fecha y hora en que se envió el archivo.
  • Repositorio: Nombre del repositorio donde está almacenada la automatización.
  • Botón de descarga: Botón para descargar el archivo.

Captura de pantalla del Orquestador de BotCity, en la página de información de una tarea específica, presentando el ID de la tarea, el botón de acciones disponibles para la tarea y las pestañas de navegación para acceder a las secciones de Información, Errores, Alertas (seleccionada) y Archivos de resultado. La pestaña contiene un número que indica la cantidad de archivos generados durante la ejecución de la tarea. La tabla muestra la lista de archivos generados durante la ejecución de la tarea para su descarga.

Atención

Los errores, alertas y archivos de resultado se envían en tiempo de ejecución de la tarea, por lo tanto, esta información puede ser accedida antes de que la tarea finalice.

Mensaje de finalización de la tarea

El mensaje de finalización mostrado en la tarea debe definirse en el código de la automatización y puede personalizarse según las necesidades del proceso.

Sin embargo, existen mensajes predeterminados que se muestran en algunos contextos.

  1. Cuando la finalización de la tarea no fue definida en el código:

    Check your automation code for status indicators and messages to report the finished task status.

  2. Cuando el entorno de ejecución no está preparado correctamente:

    The execution environment was not prepared correctly. Check the logs for more details.

Definir el mensaje de finalización

Consulta cómo definir un mensaje de finalización en el código utilizando el Maestro SDK o a través de la BotCity Orquestrador API.

Captura de pantalla del Orquestador de BotCity, en la página de información de una tarea específica, presentando el mensaje de finalización de la tarea.

Parámetros de la tarea

Los parámetros mostrados en una tarea se pasan durante la creación de la tarea y se utilizan durante la ejecución. Los parámetros permiten personalizar el comportamiento de la automatización en función de los valores proporcionados, aportando flexibilidad para diferentes escenarios de uso.

Por defecto, una automatización no tiene parámetros definidos, pero es posible configurar parámetros personalizados para cada proceso de automatización.

Definir parámetros para la automatización

Consulta cómo crear parámetros personalizados para la automatización en la sección Automatizaciones, de la Documentación.

Captura de pantalla del Orquestador de BotCity, en la página de información de una tarea específica, presentando los parámetros definidos para la automatización y sus respectivos valores utilizados en la ejecución de la tarea.

Crear tareas con parámetros

Una vez que los parámetros estén definidos en la automatización, puedes crear tareas con esos parámetros utilizando diferentes métodos:

Acciones de la tarea

Cada tarea tiene un conjunto de acciones que pueden realizarse dependiendo del estado actual de la tarea.

Las acciones disponibles pueden accederse a través del botón de acciones en la pantalla de información de la tarea, así como en la visualización de tarjetas o lista de la cola de tareas.

Las acciones disponibles son:

  • Eliminar: Elimina una tarea que está en la cola en espera.
  • Solicitar detener tarea: Solicita la interrupción de una tarea en ejecución.
  • Forzar detener tarea: Finaliza la tarea forzando el término de la ejecución.
  • Reiniciar: Reinicia una tarea de prueba.
  • Cancelar: Cancela la ejecución de una tarea que está en espera.
  • Duplicar: Vuelve a encolar con las mismas asignaciones una tarea cancelada o que ya fue ejecutada anteriormente.

Solicitar detener tarea vs. Forzar detener tarea

  • Para solicitar la detención de una tarea, el código de la automatización debe implementar la verificación periódica del estado de detención utilizando el Maestro SDK.
  • La acción de forzar la detención interrumpe inmediatamente la tarea, finalizando el proceso en curso de forma forzada. En este caso, no se requiere ninguna implementación en el código de la automatización.

Atención

  • Las tareas en ejecución solo tienen las acciones de Solicitar detener tarea y Forzar detener tarea.
  • Las tareas en espera en la cola solo tienen las acciones de Eliminar y Cancelar.
  • Solo las tareas definidas como prueba pueden ejecutar la acción Reiniciar.
  • Las tareas finalizadas o canceladas solo tienen la acción de Duplicar.

Captura de pantalla del Orquestador de BotCity, en la página Tareas, presentando el botón de acciones disponibles en una tarjeta de tarea que falló, con la opción de duplicar la tarea.