Cómo iniciar un trabajo

Un trabajo es la ejecución de un proceso utilizando uno o más robots. La implementación del proceso Iniciar trabajo permite la creación de un nuevo trabajo en respuesta a los eventos que ocurren dentro de tu plataforma (fuera de la plataforma UiPath).

Puntos finales y entradas

Iniciar un trabajo requiere el uso de solicitudes GET y POST a varios puntos de conexión de la API de Orchestrator. Las solicitudes GET se utilizan para recuperar los valores de los parámetros de entrada necesarios para la solicitud POST en el punto final de StartJobs .

¿Qué son los parámetros de entrada de StartJob?

Para enviar con éxito solicitudes POST al punto final StartJob , debes proporcionar como mínimo una ReleaseKey (identificador de proceso) y una estrategia (cómo ejecutar el proceso) como parámetros de entrada. Dependiendo de la estrategia, puede haber parámetros de entrada adicionales, incluidos JobsCount o RobotIds.

¿Cómo obtengo los valores de los parámetros de entrada de StartJob?

Para recuperar los parámetros de entrada necesarios indicados anteriormente (es decir, ReleaseKey y Estrategia), se recopila la siguiente información:

Nombre del proceso

El nombre del proceso que se ejecutará tras una solicitud StartJob correcta (para obtener más información sobre procesos, consulta Acerca de los procesos en la guía de Orchestrator).

El nombre del proceso se utiliza para recuperar el valor ReleaseKey .

Puede haber varias instancias del mismo proceso que se diferencian por el entorno en el que se publican. Por ello, un solo nombre de proceso puede generar varias ReleaseKeys. En el caso de que haya varias ReleaseKeys asociadas con un proceso, EnvironmentName se puede utilizar para identificar la ReleaseKey del proceso que el usuario desea ejecutar ( EnvironmentName también se utiliza para identificar los robots disponibles, hablaremos de ello en la siguiente viñeta). .

Para recuperar tanto la ReleaseKey como el EnvironmentName para un proceso determinado, envía una solicitud GET al punto final de las versiones utilizando el Nombre del proceso como parámetro de entrada (por ejemplo, {{base url}}/odata/Releases?$filter=ProcessKey eq {{ProcessName}}).

• API
• Swagger

• Postman

Nota: La respuesta de la solicitud GET de versiones también incluye los requisitos de argumentos de entrada para el proceso específico. Para obtener más información, consulta la viñeta Argumentos de entrada a continuación.

Estrategia

Especifica cómo el trabajo ejecuta el proceso; hay tres opciones:

1. Específico

El proceso se ejecuta en robots específicos.

Cuando se selecciona Específico , el punto final StartJob requiere el RobotId del robot que quieres usar para ejecutar el proceso.

Para recuperar el RobotId, envía una solicitud GET al punto final GetEnvironments utilizando el EnvironmentName como parámetro de entrada (por ejemplo, {{base url}}/odata/Environments?$expand=Robots&$filter=Name eq {{_EnvironmentName_}}).

• API
• Swagger
• Postman

Es posible que se incluyan varios RobotIds en la respuesta ObtenerEntornos . Para identificar el RobotId correcto, puede utilizar el Nombre del robot. Por ello, se recomienda recopilar esta información cuando se selecciona Específico .

2. JobsCount

El proceso se ejecuta un número específico de veces utilizando el siguiente robot disponible.

Cuando se selecciona CuentaTrabajo , el punto final StartJob requiere que el parámetro de entrada CuentaTrabajo incluya un valor. Por ello, se recomienda proporcionar medios para que el usuario introduzca un número.

3. Todos

El proceso se ejecutará una vez en todos los robots.

Argumentos de entrada (opcional)

El proceso, especificado por el Nombre del proceso, puede requerir argumentos de entrada. Estos argumentos de entrada normalmente se asignan a campos de datos asociados con un objeto de aplicación.

Por ejemplo, un sistema de gestión de incidencias puede tener un objeto Incidente . Este objeto de incidente incluye varios campos de datos que contienen información relevante para el proceso (por ejemplo, IncidentId, Fecha de creación, Propietario, etc.).

Como se indicó anteriormente, puedes determinar si un proceso requiere argumentos de entrada analizando el bloque Arguments en la respuesta GET Versiones (consulta la respuesta de ejemplo a continuación).

Para incluir estos valores de campo de datos en la solicitud POST de StartJob , se recomienda que proporciones los medios para seleccionar el objeto de la aplicación y sus campos de datos relevantes necesarios para el proceso. Cuando se invoca el trabajo, el conector recupera los valores del campo de datos y los agrega en la solicitud POST como valor del parámetro InputArgument .

Nota:

También puedes enviar una solicitud GET al punto final Processes_GetArgumentsByKey para identificar si un proceso tiene argumentos requeridos. El beneficio de este punto final es que la respuesta solo incluye los detalles del argumento (es decir, entrada y salida).

La desventaja de este punto final, y la razón por la que no se usa en nuestros ejemplos, es que requeriría que el conector realice solicitudes GET adicionales para recuperar información que ya se proporcionó en la respuesta de versiones GET anterior (que se requiere para obtener el valor de ReleaseKey ) .

{
  "@odata.context": "https://platform.uipath.com/twTenantTest/twTenantTest/odata/$metadata#Releases",
  "@odata.count": 1,
  "value": [
    {
      "Key": "99587436-4ce5-480d-988c-6d7f43787a2c",
      "ProcessKey": "SupportTriage",
      "ProcessVersion": "1.0.1",
      "IsLatestVersion": false,
      "IsProcessDeleted": false,
      "Description": "",
      "Name": "SupportTriage_QuickstartDemo",
      "EnvironmentId": 128912,
      "EnvironmentName": "QuickstartDemo",
      "InputArguments": null,
      "ProcessType": "Process",
      "SupportsMultipleEntryPoints": false,
      "RequiresUserInteraction": true,
      "AutoUpdate": false,
      "JobPriority": "Normal",
      "Id": 312722,
      "Arguments": {
        "Input": "[{\)\)"name\)\)":\)\)"IncidentId\)\)",\)\)"type\)\)":\)\)"System.String, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089\)\)",\)\)"required\)\)":true,\)\)"hasDefault\)\)":false}]",
        "Output": null
      },
      "ProcessSettings": null
    }

Ejemplos

Esta sección proporciona enlaces a interfaces de usuario de conector de ejemplo y las solicitudes de la API de Orchestrator correspondientes para cada campo de entrada.

En estos ejemplos presentamos el concepto de Plantilla. Una plantilla representa una asociación de un objeto de aplicación y / o evento con un proceso o cola de UiPath. Conceptos

• Iniciar un trabajo (específico)
• Iniciar un trabajo - JobsCount
• Iniciar un trabajo - Todos