Cómo programar API Tasks

Programar una API Task le permite iniciar automatizaciones que son independientes de la infraestructura de Bot Runner (usuarios y dispositivos). Debido a que las API Tasks se ejecutan en Cloud, se elimina la necesidad de licencias de usuario individuales, lo que permite ahorrar costos y simplificar la gestión de la automatización.

Puede programar API Tasks disponibles para que se ejecuten en un momento específico. Por ejemplo, procesar un lote de facturas en un archivo .csv para ejecutarlo todos los miércoles a las 5:00 p. m.
Nota: Programar API Tasks en Control Room requiere una licencia de Enterprise Platform. Consulte Enterprise Platform.

Antes de empezar

Asegúrese de que inició sesión en Control Room como administrador o como usuario con los siguientes permisos:
  • Programar mis bots para ejecutarse
  • Permiso Administrar TODA la actividad programada desde mis carpetas a nivel de carpeta para fines API Task específicas y cualquier dependencia
  • API Tasks Ejecutar como usuario.

    Para obtener más información, consulte Usuario de ejecución para la tarea de API (apitaskrunner).

Procedimiento

  1. Inicie sesión en Control Room.
  2. Seleccione uno de los siguientes métodos en el panel izquierdo para crear un programa:
    • Haga clic en Automatización.

      Haga clic en el menú de acciones (elipsis vertical) a la derecha de la API Task para la que desea crear una programación y haga clic en Programar tarea API.

    • Haga clic en Administrar > Programado > Crear programa.
    Se muestra la pantalla Automatización y dependencias. También puede hacer clic en la opción Elegir para encontrar la API Task específica.
  3. Seleccione la API Task que desea programar y haga clic en Elegir.
    Se muestra la pantalla Crear programa con varias pestañas.
  4. Utilice la pestaña Automatización y dependencias para revisar y actualizar los siguientes campos:
    • Archivo de automatización: Muestra la API Task seleccionada.

      Si desea seleccionar otra API Task, haga clic en Elegir.

    • Ejecutar la automatización y las dependencias usando: Seleccione una de las siguientes versiones de la API Task para ejecutar:
      • Versión más reciente: Programa la API Task seleccionada y las dependencias con la versión más reciente.
      • Etiqueta de producción: Programa la API Task seleccionada y las dependencias con la versión de producción.

      De forma predeterminada, se selecciona la versión más reciente del API Task.

    • Dependencias: Lista de dependencias para las API Task seleccionadas.
  5. Haga clic en Siguiente.
  6. Agregue los detalles de programación a la API Task.
    En el campo Programar, seleccione una de las siguientes opciones:
    • Ejecutar una vez: Se ejecuta la API Task una vez en el día y la hora especificados.

      Utilice las siguientes opciones para configurar la opción Ejecutar una vez:

      • Fecha de inicio: El valor predeterminado es el día actual.
      • Hora de inicio: El valor predeterminado se redondea al número que marca la próxima media hora.
      • Zona horaria: Zona horaria del sistema en su dispositivo local.
        Nota: Las zonas horarias EST, HST o MST están obsoletas. Consulte Upcoming feature deprecations.
    • Ejecutar repetidamente: Use esta opción para programar que su API Task se ejecute todas las veces a la hora especificada en un día determinado.

      Utilice las siguientes opciones para configurar la opción Ejecutar repetidamente:

      • Fecha de inicio: Ingrese la fecha en la que desea que el programa comience a ejecutar el API Task.

        Ingrese la fecha de inicio manualmente en el formato DD-MM-AAAA o mediante el calendario emergente. El valor predeterminado del campo Fecha de inicio se establece en el día actual que está configurado en su dispositivo local.

      • Fecha de finalización: Ingrese la fecha en la que desea que finalice el programa.

        La fecha de finalización no se establecerá de forma predeterminada.

      • Hora de inicio: Ingrese la Hora de inicio usando la lista desplegable para establecer el valor de la hora en la que desea que comience su programa.

        La lista contiene valores de tiempo predefinidos en el formato de 12 horas a intervalos de 15 minutos. También puede ajustar manualmente el valor de la hora en el formato de 12 horas.

      • Zona horaria: Seleccione la zona horaria tanto con la hora de inicio como con la hora de finalización.

        El valor predeterminado se establece en la ubicación actual de su sistema. Se ejecuta un programa según la zona horaria seleccionada al crear o editar un programa.

      • Repetir cada vez: Seleccione esta opción para repetir el programa.
    • Frecuencia: Seleccione una de las siguientes opciones como frecuencia de ejecución del programa:
      • Diario: Seleccione la cantidad de días que desea que se ejecute el programa.
      • Semanal: Seleccione las semanas y los días particulares de la semana en los que desea que se ejecute el programa.

        Por ejemplo, si desea que el programa se ejecute cada dos semanas los lunes y jueves, aumente el recuento a 2 en la opción Cada y seleccione las casillas de verificación Lunes y Jueves.

      • Mensual: Seleccione una de las siguientes opciones:
        • Día: Seleccione el día de los meses en los que desea que se ejecute el programa.
        • El: Seleccione una ocurrencia particular del día de los meses en los que desea que se ejecute el programa.

          Por ejemplo, si desea que el programa se ejecute el segundo jueves de enero, mayo y septiembre, seleccione segundo, jueves, y enero, mayo y septiembre de las opciones provistas.

        Nota: Cuando el horario de verano está activado y, si la Fecha de inicio está programada, la fecha se muestra en la zona horaria a la que pertenece (no según la zona horaria actual del usuario). Sin embargo, la Siguiente instancia se muestra en la zona horaria (zona horaria del sistema del usuario) según el horario de verano.

        Por ejemplo, para un programa creado el 15 de marzo en la zona horaria GMT, la Fecha de inicio se muestra como 15 de marzo, que pertenece a la zona horaria GMT. Más tarde, cuando el ahorro de luz diurna está activado y si edita o ve este horario en el mes de agosto en la zona horaria BST, la siguiente instancia se muestra como agosto que pertenece a la zona horaria BST.

        Por ejemplo, si programa una tarea para ejecutarse del 23/11/2023 a las 9:00 a. m. al 30/11/2023 a las 9:00 a. m., con la frecuencia establecida en "diario", la tarea se ejecuta diariamente desde el 23/11/2023 a las 9:00 a. m. y la última tarea se ejecuta el 30/11/2023 a las 9:00 a. m.

    • En la sección Configuración de programa perdido, seleccione la casilla de verificación Reimplementar programa de nuevo para volver a implementar un programa que se perdió debido a un cierre de Control Room.

      Cuando se selecciona la opción Reimplementar la programación de nuevo, las programaciones perdidas por el cierre de Control Room se vuelven a implementar automáticamente después de que se reinicie Control Room. También se agrega una entrada de registro de auditoría que muestra el Tipo de evento como Schedule misfired.

      Nota: Para garantizar un despliegue correcto al utilizar la opción Reinstalar la programación de nuevo , debe iniciar el servicio de compilador antes de reiniciar los servicios Control Room .
  7. Haga clic en Siguiente.
  8. Utilice la pestaña Usuarios de ejecución para lo siguiente:
    • Seleccione los usuarios de la lista de la tabla Ejecutados como usuarios disponibles y haga clic en la flecha hacia abajo para agregar su selección.

      Los usuarios que ha seleccionado aparecen en la tabla Seleccionados. Puede utilizar la flecha hacia arriba para eliminar cualquiera de los usuarios seleccionados.

      Nota: El sistema genera un usuario llamado apitaskrunner, asociado con el rol Task Runner AAE_API para establecer el contexto de usuario de ejecución para la API Tasks.
    • En el campo Definir el número de ejecutados como usuarios que se utilizará, elija una de las siguientes opciones:
      • Todos los usuarios de ejecución: Seleccione esta opción para especificar todos los usuarios disponibles en la tabla Seleccionados como usuarios Run-as mientras se ejecuta la API Task.
      • Número personalizado de usuarios de ejecución: Seleccione esta opción para facilitar una cierta cantidad de usuarios de la tabla Seleccionados que desea utilizar como usuarios Run-as.

        Por ejemplo, si tiene 5 usuarios en la tabla Seleccionados y solo desea utilizar 3 como usuarios Run-as, ingrese 3. Los 3 usuarios enumerados en la parte superior de la tabla se utilizan como usuarios Run-as al ejecutar la API Task.

  9. Haga clic en Siguiente.
  10. Opcional: Utilice la pestaña General para cambiar la configuración predeterminada para las siguientes opciones:
    • Nombre de la actividad: Editar o cambiar el nombre del API Task.
    • Prioridad de automatización: Haga clic en el menú desplegable para establecer la prioridad de automatización.

      Media es la prioridad de automatización predeterminada, pero puede cambiarla para que las automatizaciones se procesen para su implementación según corresponda.

  11. Haga clic en Crear programa.
    La API Task está programada. Puede ver el estado de la API Tasks programada en la página Administrar > Programado.