Como iniciar um trabalho

Fluxo de execução de trabalho e pontos de extremidade de API para implementar o processo Iniciar trabalho em um conector do UiPath Marketplace.

Um trabalho é a execução de um processo usando um ou mais robôs. A implementação do processo Iniciar trabalho permite a criação de um novo trabalho em resposta a eventos que ocorrem dentro da sua plataforma (fora da UiPath Platform).

Endpoints e entradas

Iniciar um trabalho requer o uso de solicitações GET e POST para vários pontos de extremidade de API do Orchestrator. As solicitações GET são usadas para recuperar os valores do parâmetro de entrada necessários para a solicitação POST para o ponto de extremidade 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:

Nome do Processo

O nome do processo que será executado após uma solicitação StartJob bem-sucedida (para obter mais informações, sobre processos, consulte Sobre processos no Guia do 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 o ReleaseKey e o EnvironmentName para um determinado processo, envie uma solicitação GET para o endpoint de Versões usando o Nome do processo como seu parâmetro de entrada (por exemplo, {{base url}}/odata/Releases?$filter=ProcessKey eq {{ProcessName}}).

• API
• arrogância
• Postman

Observação:

A resposta da solicitação GET de versões também inclui os requisitos de argumentos de entrada para o processo específico. Para obter mais informações, consulte o ponto Argumentos de entrada abaixo.

Strategy

Especifica como o trabalho executa o processo. existem três opções:

1. Específico

O processo é executado em um robô específico.

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

Para recuperar o RobotId, envie uma solicitação GET para o endpoint GetAvironments usando o NomeDoAmbiente como seu parâmetro de entrada (por exemplo, {{base url}}/odata/Environments?$expand=Robots&$filter=Name eq {{_EnvironmentName_}}).

• API
• arrogância
• 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. Contagem de Trabalhos

O processo é executado um número especificado de vezes usando o próximo robô disponível.

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

O processo será executado uma vez em todos os robôs.

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.).

Conforme observado acima, você pode determinar se um processo requer argumentos de entrada analisando o bloco Arguments na resposta GET Releases (ver exemplo de resposta abaixo).

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.

Observação:

Você também pode enviar uma solicitação GET para o ponto de extremidade Processes_GetArgumentsByKey para identificar se um processo possui os argumentos necessários. O benefício para esse ponto de extremidade é que a resposta inclui apenas os detalhes do argumento (ou seja, Entrada e Saída).

A desvantagem para esse endpoint, e por que ele não é usado em nossos exemplos, é que exigiria que o conector faça solicitações GET adicionais para recuperar informações que já foram fornecidas na resposta anterior GET Releases (que é necessária para obter o 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
    }

Exemplos

Esta seção fornece links para o exemplo de interfaces de usuário do conector e as solicitações de API do Orchestrator correspondentes 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 um trabalho - Específico
• Iniciar um trabalho - JobsCount
• Iniciar um trabalho - Todos