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 se producen dentro de tu plataforma (fuera de UiPath Platform).

Puntos finales y entradas

Iniciar un trabajo requiere el uso de solicitudes GET y POST a varios puntos finales 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 al punto final StartJobs .

What are the StartJob input parameters?

To successfully send POST requests to the StartJob endpoint, you must provide at a minimum, a ReleaseKey (process identifier) and Strategy (how to run the process) as input parameters. Depending on the Strategy, there may be additional input parameters including JobsCount or RobotIds.

How do I get the StartJob input parameter values?

To retrieve the required input parameters noted above (i.e., ReleaseKey and Strategy), you collect the following information:

Nombre del proceso

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

The process name is used to retrieve the ReleaseKey value.

There may be multiple instances of the same process that are differentiated by the environment they're published in. Because of this, a single Process Name can result in multiple ReleaseKeys. In the event that there are multiple ReleaseKeys associated with a process, the EnvironmentName can be used to identify the ReleaseKey of the process the user wants to run (the EnvironmentName is also used to identify the available robots, more on that in the next bullet).

Para recuperar tanto ReleaseKey como EnvironmentName para un proceso determinado, envía una solicitud GET al punto final de Versiones utilizando el Nombre del proceso como tu 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 Liberaciones también incluye los requisitos del argumento 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.

When Specific is selected, the StartJob endpoint requires the RobotId of the robot that you want to use to run the process.

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

• API
• Swagger
• Postman

Multiple RobotIds may be included in the GetEnvironments response. To identify the correct RobotId, you can use the Robot Name. Because of this, it's recommended that you collect this information when Specific is selected.

2. JobsCount

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

When JobsCount is selected, the StartJob endpoint requires the JobsCount input parameter to include a value. Because of this, it's recommended that you provide means for a user to enter a number.

3. Todos

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

Argumentos de entrada (opcional)

The process, specified by the Process Name, may require input arguments. These input arguments typically map to data fields associated with an application object.

For example, an issue management system may have an Incident object. This Incident object includes several data fields that contain information relevant to the process (e.g., IncidentId, DateCreated, Owner, etc.).

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

To include these data field values in the StartJob POST request, it's recommended that you provide the means to select the application object and its relevant data fields required for the process. When the job is invoked, the connector retrieves the data field values and adds them in the POST request as the InputArgument parameter value.

Nota:

También puedes enviar una solicitud GET al punto final Processes_GetArgumentsByKey para identificar si un proceso tiene argumentos necesarios. La ventaja de este punto final es que la respuesta solo incluye los detalles del argumento (es decir, Input y Output).

La desventaja de este punto final, y por qué no se utiliza en nuestros ejemplos, es que requeriría que el conector realizara solicitudes GET adicionales para recuperar información que ya se proporcionó en la respuesta GET Releases anterior (que es necesaria para obtener el valor 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.

In these examples, we introduce the concept of a Template. A template represents an association of an application object and/or event with a UiPath process or queue. Conceptually, a template gives you the ability to invoke different Orchestrator resources (e.g., start a job, add a Queue item) when different events occur within your application (e.g., new object created, object status change) while maintaining a single authenticated connection.

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