Gestionar desencadenadores de API

Crear un desencadenador de API

1. En una carpeta, ve a Automatizaciones > Desencadenadores > Desencadenadores de API.

2. Haz clic en Añadir un nuevo desencadenador. Se mostrará la ventana Crear un nuevo desencadenador de API.

3. En el menú desplegable Nombre del proceso, selecciona un proceso subyacente para tu desencadenador.

4. En el campo Nombre, introduce un nombre que te permita identificar el desencadenador fácilmente.

5. En el menú desplegable Prioridad del trabajo, selecciona la prioridad del trabajo. El valor predeterminado será Heredado, lo que significa que la prioridad de la tarea es la misma que la definida para el proceso seleccionado.

6. From the Runtime type drop-down menu, select the runtime used to execute the jobs that are launched by the trigger.

7. En la pestaña Argumentos, proporciona los valores para los argumentos de entrada si tu proceso tiene alguno. Más información sobre los argumentos de entrada y salida.

8. En el menú desplegable Verbo, selecciona la opción que representa la acción que quieres que realice tu trabajo: ELIMINAR, OBTENER, PUBLICAR y PONER.

9. En el campo Slug, introduce un slug que se añadirá a la URL base, generando así la URL final para el punto final resultante que utilizarás en tu aplicación. Puedes ver una vista previa de la URL completa en este campo.

   El slug predeterminado es ${Process_Name}, pero puedes personalizarlo para garantizar su unicidad en el ámbito de tenant.

   Ten en cuenta que no admite barras inclinadas.

10. En el menú desplegable Modo de llamada predeterminado, selecciona el modo de llamada deseado. Las opciones disponibles son:

    • Sondeo asíncrono (este es el valor predeterminado, pero se puede cambiar)

    • Enviar y olvidar asíncrono

    • Sincronización (sondeo largo)

      Obtén más información sobre estas opciones en Iniciar un trabajo a través de un desencadenador de API.

11. Activa la alternancia Programar finalización de la ejecución del trabajo para seleccionar una estrategia de finalización del trabajo.

    Nota:

    • El tiempo especificado aquí transcurre según las especificaciones incluso si la tarea está en cola. Por ejemplo, si programas una tarea para que se ejecute a las 13:00 y que se detenga después de 20 minutos, la tarea se detendrá a las 13:20 aunque haya permanecido en cola hasta las 13:15 y después se haya iniciado.
    • Las opciones de Programar la finalización de la ejecución del trabajo de un desencadenador se conservan para los trabajos iniciados manualmente. Por ejemplo, digamos que has creado el desencadenador T1 y has activado las siguientes programaciones de finalización de trabajo:
    • Programar el final de la ejecución del trabajo: detener el trabajo después de 10 minutos
    • Programa "Eliminar" automático si el trabajo no se detiene: elimina el trabajo después de 2 minutos En la página Automatizaciones > Desencadenadores, al hacer clic en Iniciar un trabajo ahora para el desencadenador T1, se abre la página Iniciar trabajo con las programaciones de finalización de trabajos ya aplicadas, los mismos que configuraste cuando creaste el desencadenador.

    Además, si programa detener un trabajo en ejecución o en curso después de 2 horas y también configura para eliminar el mismo trabajo después de 3 horas, el trabajo se eliminará después de 5 horas. Esto sucede porque, en primer lugar, se envía la señal a Orchestrator de que el trabajo se detuvo después de 2 horas. Una vez que se ha recibido la señal, la acción de cancelar trabajo se desencadena para que se produzca en 3 horas, lo que da como resultado un total de 5 horas.

• Seleccione Detener en el menú desplegable: intenta finalizar la ejecución correctamente después de que haya pasado el intervalo de tiempo definido, ya que el trabajo está atascado en estado Pendiente o En ejecución (establezca el tiempo en un mínimo de 1 minuto, un máximo de 10 días, 23 horas y 59 minutos);

  Ejemplo: Orchestrator intentará detener los trabajos que hayan estado atascados durante al menos 10 minutos en Pendiente o En ejecución.

  

• Seleccione Cancelar en el menú desplegable: intenta finalizar la ejecución de forma forzada después de que haya transcurrido el intervalo de tiempo definido, ya que el trabajo está atascado en estado Pendiente o En ejecución (establezca el tiempo en un mínimo de 1 minuto, un máximo de 10 días, 23 horas y 59 minutos);

  Ejemplo: Orchestrator intentará eliminar los trabajos que hayan estado atascados durante al menos 10 minutos en Pendiente o En ejecución.

  • Seleccione Detener en el menú desplegable y habilite la opción Si el trabajo no se detiene, eliminar: intenta finalizar la ejecución correctamente después de que haya transcurrido el intervalo de tiempo definido, ya que el trabajo está atascado en un estado Pendiente o En ejecución y luego intenta finalizarla forzosamente después de que haya transcurrido el intervalo de tiempo definido, ya que el trabajo está atascado en un estado Deteniendo (establezca el tiempo en un mínimo de 1 minuto, un máximo de 10 días, 23 horas y 59 minutos).

    Ejemplo: Orchestrator intentará detener los trabajos que hayan estado atascados en Pendiente o En ejecución durante al menos 10 minutos. Si la terminación no se produce, Orchestrator intentará eliminar los trabajos que hayan estado detenidos durante al menos 20 minutos.

12. Activa la alternancia Programar la desactivación automática del desencadenador e introduce la fecha y hora en la que se debe desactivar el desencadenador. La zona horaria seleccionada influye en la desactivación del desencadenador de tiempo.

13. Activa la alternancia Generar una alerta si el trabajo se atasca (en estado pendiente o reanudado), y establece la duración aceptable de la permanencia del trabajo en el estado pendiente o reanudado.La duración mínima configurable es de un minuto. La duración máxima configurable es de once días. Si el trabajo excede la duración configurada, una ventana emergente de alerta de gravedad de «Error» informa sobre ello con el siguiente texto: «N trabajos para el #proceso {número_de_proceso} han estado pendientes o se han reanudado durante más de X horas y Y minutos.», Donde:

    • N: es el número de trabajos que desencadenó la alerta;
    • {process_number}: el identificador de proceso;
    • X: el número de horas configurado que superó el trabajo con el estado pendiente o reanudado; Los días se convierten en horas.
    • Y: el número de minutos configurado que superó el trabajo con el estado pendiente o reanudado.

14. Activa la alternancia Generar una alerta si el trabajo se inicio y no se ha completado, y establece la duración aceptable para que se complete el trabajo. La duración configurable es como mínimo de un minuto y como máximo de once días. Si el trabajo excede la duración configurada, una ventana emergente de alerta de gravedad de «Error» informa sobre ello con el siguiente texto: «El trabajo para el #proceso {número_de_proceso} lleva pendiente de ejecuciónj más de X horas y Y minutos.», donde:

    • {process_number}: el identificador de proceso;
    • X: el número establecido de horas que el trabajo superó al intentar completarse; los días se convierten en horas.
    • Y: el número de minutos configurado que superó el trabajo al intentar completarse.

15. Activa el interruptor Establecer deshabilitación de desencadenadores basados en la ejecución si quieres controlar cuándo se deshabilita el desencadenador una vez que falla un trabajo. Esta alternancia revela dos opciones:

    Opción	Descripción
    Deshabilitar cuando falla la ejecución de trabajos consecutivos	El desencadenador se deshabilita después de la cantidad de ejecuciones fallidas que eliges para esta configuración. Puedes elegir un valor entre 0 y 100. El valor predeterminado es 0, lo que significa que el desencadenador nunca está deshabilitado. Los trabajos detenidos no se cuentan para este valor.
    Período de gracia al deshabilitar el desencadenador (días)	El número de días que se debe esperar antes de que se deshabilite el desencadenador después del primer error de un trabajo. Puedes elegir un valor entre 0 y 30. El valor predeterminado es 0, lo que significa que el desencadenador se deshabilita en cuanto se alcanza el número de ejecuciones de trabajos establecido en el campo anterior para el día actual.

16. Para mantener el mismo contexto cuenta-máquina configurado para iniciar el trabajo, marca la casilla Mantener la asignación de cuenta/máquina en la reanudación del trabajo. Esto optimiza el uso de licencias y recursos.

Importante:

• La configuración de ejecución a nivel de tenant se aplica a los desencadenadores de API.
• Puedes crear un máximo de 1000 desencadenadores de API por tenant.

Acciones en desencadenadores de API

La página Desencadenadores de API te permite realizar varias acciones desde el menú contextual de cada desencadenador:

Nota:

En los ejemplos proporcionados en esta sección, el identificador alfanumérico 6ea73196-ca89-446c-81e1-5279bdd36dc2 es la clave de la carpeta donde se encuentra el desencadenador de API. La API de Orchestrator utiliza el identificador como valor del parámetro Key en los puntos finales /Folders .

Copiar la URL completa de Slug

Copia la URL que se utilizará en la aplicación de terceros.

Para un desencadenador de API con el hw-processslug, tendría el siguiente aspecto: https://{yourDomain}/{organizationName}/{tenantName}/orchestrator_/t/6ea73196-ca89-446c-81e1-5279bdd36dc2/hw-process

Editar

Cambia las propiedades del desencadenador de API seleccionado.

Copiar Slug

Copia el slug en el formato adecuado para su uso en la línea de comandos o en el código existente. Las opciones disponibles son:

Copiar como curl (bash) : para un desencadenador de API con el slug hw-process , se vería así:

curl '{baseURL_orchestrator}/t/6ea73196-ca89-446c-81e1-5279bdd36dc2/hw-process'  -X 'POST'  -H 'Content-Type: application/json'  -H 'Authorization: Bearer ***INSERT_YOUR_TOKEN***'

Copiar como curl (cmd) : para un desencadenador de API con el slug hw-process , se vería así:

curl "https://{yourDomain}/{organizationName}/{tenantName}/orchestrator_/t/6ea73196-ca89-446c-81e1-5279bdd36dc2/hw-process" ^ -X "POST" ^ -H "Content-Type: application/json" ^ -H "Authorization: Bearer ***INSERT_YOUR_TOKEN***"

Copiar como obtención : para un desencadenador de API con el slug hw-process , se vería así:

fetch("https://{yourDomain}/{organizationName}/{tenantName}/orchestrator_/t/6ea73196-ca89-446c-81e1-5279bdd36dc2/hw-process", { headers: { Authorization: "Bearer ***INSERT_YOUR_TOKEN***", "Content-Type": "application/json" }, "method": "POST" })

Copiar como PowerShell : para un desencadenador de API con el slug hw-process , se vería así:

$headers = @{ "method"="POST" "Authorization" = "Bearer ***INSERT_YOUR_TOKEN***" } Invoke-WebRequest -UseBasicParsing -Uri "https://{yourDomain}/{organizationName}/{tenantName}/orchestrator_/t/6ea73196-ca89-446c-81e1-5279bdd36dc2/hw-process" ` -Headers $headers ` -ContentType "application/json"

Habilitar

Habilita un activador de API previamente deshabilitado.

Deshabilitar

Deshabilita un desencadenador de API ya habilitado.

Quitar

Elimina el desencadenador de API seleccionado. Eliminar un desencadenador de API es equivalente a eliminar el punto final resultante. Estos son los comportamientos que puedes esperar en función de tu escenario particular:

Trabajos ya iniciados

Si un trabajo basado en un proceso asociado a un desencadenador de API eliminado ya está iniciado en el momento de la eliminación, se llevará a cabo hasta su finalización.

Iniciar nuevos trabajos

Dado que la URL ya no está disponible, al intentar iniciar un trabajo basado en un proceso asociado a un desencadenador de API eliminado se genera un error 404.

Editar procesos

Si editas un proceso que utiliza al menos un desencadenador de API, el desencadenador se actualiza y se aplica el nuevo conjunto de propiedades del proceso.

Uso compartido de recursos entre orígenes

Puedes añadir dominios a la lista de permisos para el tráfico entrante utilizando la opción Lista de permisos CORS para desencadenadores de API en la pestaña General de la configuración de tu tenant.

Esto es necesario para las aplicaciones del explorador que realizarán solicitudes HTTP a Orchestrator desde tu explorador (es decir, no desde un servidor). Si no se permiten los dominios de la lista, se podría provocar un error en la política CORS, que puedes ver en tu consola de desarrollador.

Si quieres añadir más dominios a la lista de permisos, utiliza una coma o pulsa Intro para separarlos.

Definición de API

En esta página se muestra una definición Swagger de los desencadenadores de API que has creado, agrupados por carpeta, junto con su resultado. Además, permite ejecutar los trabajos correspondientes a esos desencadenadores.

Se puede acceder a ella haciendo clic en el botón de definición de API en la página Desencadenadores de API o a través de https://{yourDomain}/{organizationName}/{tenantName}/orchestrator_/t/swagger/index.html.

Figura 1. Página Desencadenadores de API

La definición de API para un tenant con desencadenadores de API en un espacio de trabajo personal y la carpeta Compartido tendría el aspecto que se muestra a continuación.

Figura 2. Definición de API para un tenant