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. El campo Nombre se rellena previamente con el nombre del proceso, seguido del tipo de desencadenador en el formato <ProcessName>_<TriggerType>. Sin embargo, el nombre del desencadenante puede editarse con un nombre diferente, si se prefiere.
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. En el menú desplegable Tipo de runtime selecciona el runtime utilizado para ejecutar los trabajos lanzados por el desencadenador.
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 la finalización de la ejecución del trabajo: detener el trabajo después de 10 minutos.

    • Programar automáticamente "Cancelar", si el trabajo no se detiene: detener 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 del trabajo ya aplicadas, las mismas que configuraste al crear el desencadenador.

    Additionally, if you schedule to stop a Pending or Running job after 2 hours and also configure to kill the same job after 3 hours, the job will be killed after 5 hours. This happens because, first, the signal is sent to Orchestrator that the job was indeed stopped after 2 hours. Once the signal has been received, the kill job action is triggered to occur in 3 hours, thus resulting a total of 5 hours.

    • Select Stop from the drop-down - attempts to gracefully end the execution after the defined time interval has passed since the job is stuck in a Pending or Running state (set the time to a minimum of 1 minute, maximum of 10 days, 23 hours and 59 minutes);
      Example: Orchestrator will attempt to stop jobs that have been stuck for at least 10 minutes in Pending or Running.

      

    • Select Kill from the drop-down - attempts to forcefully end the execution after the defined time interval has passed since the job is stuck in a Pending or Running state (set the time to a minimum of 1 minute, maximum of 10 days, 23 hours and 59 minutes);

      Example: Orchestrator will attempt to kill jobs that have been stuck for at least 10 minutes in Pending or Running.

    • Select Stop from the drop-down and enable the If the job does not stop, kill it option - attempts to gracefully end the execution after the defined time interval has passed since the job is stuck in a Pending or Running state and then attempts to forcefully end it after the defined time interval has passed since the job is stuck in a Stopping state (set the time to a minimum of 1 minute, maximum of 10 days, 23 hours and 59 minutes).

      Example: Orchestrator will attempt to stop jobs that have been stuck in Pending or Running for at least 10 minutes. If the termination does not happen, Orchestrator will attempt killing those jobs that have been Stopping for at least 20 minutes.

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 la opción Establecer deshabilitación de desencadenadores basada en la ejecución si deseas controlar cuándo se deshabilita el desencadenador una vez que falla un trabajo. Esta alternancia muestra dos opciones:

    Opción	Descripción
    Deshabilitar cuando falla la ejecución de trabajos consecutivos	El desencadenador se deshabilita después del número de ejecuciones fallidas que elija para esta configuración. Puedes elegir un valor entre 0 y 100. El valor predeterminado es 0, lo que significa que el desencadenador nunca se deshabilita. 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 de espera 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.

    Nota:

    Si eliges un tiempo de ejecución Cloud - Serverless para el proceso subyacente, se habilita automáticamente la opción Deshabilitar desencadenador basado en la ejecución, con los siguientes valores predeterminados (los campos son de solo lectura):

    • Deshabilitar cuando el recuento de fallos de ejecución de trabajos consecutivos se establece en 10.

    • El período de gracia para deshabilitar el desencadenador (días) se establece en 0.

    Esto solo se aplica si tienes el plan de licencias Community.

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 en el 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:

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://cloud.uipath.com/{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 slughw-process, tendría el aspecto que se muestra a continuación.

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 hw-processslug, tendría el aspecto que se muestra a continuación.

curl "https://cloud.uipath.com/{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 fetch: para un desencadenador de API con el hw-processslug, tendría el aspecto que se muestra a continuación.

fetch("https://cloud.uipath.com/{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 hw-processslug, tendría el aspecto que se muestra a continuación.

$headers = @{ "method"="POST" "Authorization" = "Bearer ***INSERT_YOUR_TOKEN***" } Invoke-WebRequest -UseBasicParsing -Uri "https://cloud.uipath.com/{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 Definición de API en la página Desencadenadores de API o a través de https://cloud.uipath.com/{organizationName}/{tenantName}/orchestrator_/t/swagger/index.html.

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.