API REST del Scheduler 2.0

<< Clic para mostrar Tabla de Contenidos >>

Navegación:  Automation Server > Automation Server - configuración y administración > Mantenimiento y monitoreo del sistema > Configuración y administración del ambiente > Managment Console > Administración de los trabajos programados > Scheduler 2.0 >

API REST del Scheduler 2.0

Introducción

Scheduler 2.0 ofrece una API REST donde puede administrar las tareas de mantenimiento. Por ejemplo, si necesita cambiar la hora de una tarea de mantenimiento o deshabilitarla. Esta sección explica las operaciones que puede ejecutar a través de REST de la API del Scheduler.

 

Antes de Empezar

Asegúrese de haber actualizado su Scheduler a la versión 2.0. Consulte el Scheduler 2.0.

Esta API REST utiliza la autenticación OAuth de Bizagi. Por lo tanto, debe definir las credenciales de OAuth y obtener un token de autenticación. Consulte la autenticación API de Bizagi.

Esta API está destinada a tareas de mantenimiento. Otras tareas ejecutadas por el programador, como temporizadores o trabajos personalizados, se pueden administrar en la Consola de Administración.

 

Asegúrese de configurar lo siguiente:

Alcance permitido (Allowe Scope): API

Tipo de permiso (Grant Type): si va a utilizar Postman como su cliente para invocar la API del Scheduler, le recomendamos que utilice las credenciales de cliente asociadas con el usuario admon.

 

Propiedades de la API de Scheduler 2.0

Bizagi ejecuta tareas que ayudan a realizar el mantenimiento de algunas tablas de la base de datos y mantener el rendimiento, así como otras tareas de sistema como sincronización de usuarios con LDAP o replicación de entidades paramétricas. De forma predeterminada, estas tareas tienen una periodicidad y un tiempo definidos. La siguiente sección describe las tareas y cómo puede administrarlas usando los métodos API.

 

Tipo de tareas de mantenimiento

Las siguientes tareas se pueden administrar con este API:

 

Nombre de la Tarea

Número de Tipo de Tarea

Descripción

Frecuencia (Recurrencia) por defecto

Hora de inicio por defecto

LDAPSynch

1

Sincronización de usuarios mediante LDAP. Consulte Importación de usuarios LDAP.

Diario

Como lo definió en la configuración de sincronización.

Replication

2

Replicación de entidades paramétricas. Consulte Replicación de datos.

Como está configurado en el esquema de replicación.

Como está configurado en el esquema de replicación.

Clean WFE Data

3

Esta tarea limpia los casos marcados como cerrados y las actividades de la tabla que almacena la información de los casos.

Diario

22:00

DataStore

5

Para proyectos locales, puede configurar un almacén de datos operacionales (ODS), donde Bizagi puede usar una réplica de su base de datos para sus informes. Consulte Configuración de un ODS de Bizagi.

 

* Esta opción no aplica a los proyectos de Automation Service.

Diario

22:00

Delete Case Resources

6

Cuando los usuarios dejan comentarios o cargan archivos en la carpeta de caso, pueden eliminar estos archivos o comentarios en cualquier momento. Cuando se eliminan, Bizagi los marca para ser eliminados, y esta tarea de mantenimiento elimina el comentario o archivo más tarde.

Diario

22:00

StartCases

7

Trabajos asociados a eventos de Timer Start en procesos, para iniciar casos automáticamente.

Cómo defina en el evento de inicio.

Cómo defina en el evento de inicio.

Email Browser

8

Esta tarea se ejecuta cuando el Scheduler busca nuevos correos electrónicos recibidos en la bandeja de entrada configurada para completar tareas por correo electrónico.

Cada minuto

N/A

Move Closed Cases

16

Esta tarea limpia los casos cerrados de la tabla que almacena la información de los casos. Debe ejecutarse solo si la tarea de Clean WFE data no fue suficiente para limpiar todos los casos.

No está activa por defecto

No está activa por defecto

CleanOperationalTables

17

Borra las tablas temporales que no estan en uso.

Hora

00:00

CleanCatalogTables

18

Todos los objetos de un proyecto de Bizagi, como tareas, entidades, atributos, alarmas, se describen en el catálogo. El catálogo contiene los metadatos y las propiedades de esos objetos. Si se elimina un objeto, el catálogo debe actualizarse. Esta tarea limpia el catálogo cuando se elimina un objeto.

Diario

22:00

 

Los siguientes métodos están asociados con las tareas de mantenimiento

 

Obtener el estado de tareas de mantenimiento

Este método se puede utilizar para cambiar las propiedades de una tarea de mantenimiento, como el tiempo de ejecución, la recurrencia y otros.

URL: [URL del proyecto]/api/GetAllMaintenanceTask

Método de invocación: GET

Autorización: Bearer [TOKEN]

Tipo de contenido: application / json

Cuerpo: N/A

 

El método devuelve un JSON con la información de todas las tareas de mantenimiento. Para cada tarea, Bizagi muestra la siguiente información:

 

jobGuid: identificador de la tarea del scheduler

Name: nombre del trabajo o tarea del programador

Description: se aplica a trabajos de replicación. Muestra la descripción registrada en la configuración de replicación.

Enabled: Verdadero o Falso, dependiendo de si el trabajo está habilitado o no.

Type: Número del tipo de tarea. Consulte los tipos de tareas.

Scheduling: este es el formato JSON que contiene la información de programación para cada tarea. El formato puede ser diferente según la tarea de mantenimiento. Puede utilizar la misma estructura JSON si necesita actualizar la información de la tarea en el siguiente método.

 

Ejemplo

En el siguiente ejemplo, se usa Postman para ejecutar el método.

 

Scheduler2_7

 

Actualizar una tarea de mantenimiento

Este método se puede utilizar para cambiar las propiedades de una tarea de mantenimiento, como el tiempo de ejecución, la recurrencia y otros.

URL: [URL del proyecto]/api/BackgroundJob/UpdateMaintenanceTask

Método de invocación: POST

Autorización: Bearer [TOKEN]

Tipo de contenido: application / json

Cuerpo: JSON

 

El método le permite realizar las siguientes acciones:

 

Activar / desactivar una tarea de mantenimiento

Reprogramar una tarea de mantenimiento

Cambiar el modo de operación (solo se aplica a la tarea Limpiar datos WDE)

 

JSON para cada acción

Para ejecutar cualquiera de las acciones, necesita la siguiente estructura JSON en el cuerpo de la invocación del método:

 

Para habilitar / deshabilitar la tarea

{ "type": 3, "enabled": false }

 

Dónde:

Type: es el número de tipo de la tarea descrita en la tabla anterior.

enabled: true o false.

 

Para reprogramar o cambiar la frecuencia de la tarea

{ "type": 3, "scheduling": "{\"recurring\":true,\"enabled\":true,\"startHour\":\"22:00\",\"endHour\":\"23:00\",\"frequency\":{\"type\":\"Daily\",\"recurrence\":1}}" }

 

Dónde

Type: es el número de tipo de la tarea descrita en la tabla anterior.

Recurring: Verdadero o falso, dependiendo de si desea configurar la tarea como un trabajo repetitivo (recurrente).

Enabled: Verdadero o falso dependiendo de si desea activar o desactivar la tarea.

startHour: hora de inicio del trabajo (formato 24H). Si la tarea es recurrente, por ejemplo, diariamente, es la hora a la que se ejecuta el trabajo todos los días.

endHour; Hora en la que debe forzarse la finalización de la tarea (formato 24H).

Frequency - Type: puede ser Daily, Hours, or Minutes.Dependiendo si quiere ejecutarla diariamente, cada hora o cada minuto, respectivamente.

Frequency -Recurrence: Dependiendo del tipo de frecuencia, es la frecuencia con la que se repite la tarea.

 

Cambiar el modo de funcionamiento (solo para Clean WFE Data)

{ "type": 3, "OperationMode" 2 }

 

Dónde:

Type; debe ser siempre 3 para esta acción.

OperationMode: 0 = Ninguno, 1 = Tiempo de inactividad, 2 = En línea.

 

La tarea Limpiar datos WFE se puede ejecutar en tres modos:

 

Sin modo

Tiempo de inactividad: Cuando se activa la ventana de mantenimiento para que Bizagi pueda limpiar las tablas en picos de bajo uso, por defecto se configura en este modo, a las 22 horas todos los días.

En línea: Este modo le permite a Bizagi limpiar la mesa inmediatamente después de cerrar una tarea o un caso. Este modo debe usarse con extrema precaución porque puede afectar el rendimiento del Scheduler y la base de datos. Es recomendable analizar el mejor escenario antes de cambiar el modo de ejecución de la tarea Clean WFE data.

 

Cambiar la hora de sincronización con LDAP

{ "type": 1, "enabled": true, "scheduling": "{\"syncHour\":14}" }

 

Type: Es el número de tipo de la tarea descrita en la tabla anterior. Para la sincronización LDAP, este valor debe ser siempre 1.

Enabled: True (verdadero) o False (falso).

Scheduling - SyncHour: esta es la hora del día en que la sincronización se activa a diario. Este valor usa un formato militar. Por ejemplo, 14 son las 2 pm.

 

Ejemplo

En el siguiente ejemplo, usamos Postman para ejecutar el método y reprogramamos la tarea "Limpiar datos WFE" que se iniciará a las 23:00 y se repetirá dos veces al día:

 

Scheduler2_6