Como Iniciar um Trabalho

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

Pontos de extremidade e entradas

Iniciar um trabalho requer o uso de solicitações GET e POST para vários endpoints da API do Orchestrator. As solicitações GET são usadas para recuperar os valores dos parâmetros de entrada necessários para a solicitação POST para o endpoint StartJobs .

O que são os parâmetros de entrada de StartJob?

Para enviar solicitações POST com êxito para o endpoint StartJob , você deve fornecer, no mínimo, uma ReleaseKey (identificador do processo) e uma estratégia (como executar o processo) como parâmetros de entrada. Dependendo da estratégia, pode haver parâmetros de entrada adicionais, incluindo JobsCount ou RobotIds.

Como posso obter os valores dos parâmetros de entrada StartJob?

Para recuperar os parâmetros de entrada necessários observados acima (ou seja, ReleaseKey e Estratégia), você coleta as seguintes informações:

Nome do Processo

O nome do processo que será executado após uma solicitação StartJob bem-sucedida (para obter mais informações, consulte Sobre processos no Guia do Orchestrator).

O nome do processo é usado para recuperar o valor de ReleaseKey .

Pode haver várias instâncias do mesmo processo que são diferenciados pelo ambiente em que foram publicados. Por isso, um único Nome do Processo pode resultar em várias ChavesDeVersão. Caso haja várias ReleaseKeys associadas a um processo, o EnvironmentName pode ser usado para identificar a ReleaseKey do processo que o usuário deseja executar (o EnvironmentName também é usado para identificar os robôs disponíveis, veja mais sobre isso no próximo item) .

Para recuperar a 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}}).

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

Quando Específico estiver selecionado, o endpoint de StartJob exigirá o RobotId do robô que você deseja usar para executar o processo.

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

Vários RobotIds podem ser incluídos na resposta GetEnvironments . Para identificar o RobotId correto, você pode usar o Nome do Robô. Por isso, é recomendável coletar essas informações quando Especificidade estiver selecionado.

2. Contagem de Trabalhos

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

Quando JobsCount está selecionado, o endpoint StartJob exige que o parâmetro de entrada JobsCount inclua um valor. Por isso, é recomendável que você forneça meios para que um usuário insira um número.

3. Todos

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

Argumentos de Entrada (Opcional)

O processo, especificado pelo Nome do processo, pode exigir argumentos de entrada. Esses argumentos de entrada geralmente mapeiam para campos de dados associados a um objeto de aplicativo.

Por exemplo, um sistema de gerenciamento de problemas pode ter um objeto Incident . Esse objeto Incident inclui vários campos de dados que contêm informações relevantes para o processo (por exemplo, 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 (consulte o exemplo de resposta abaixo).

Para incluir esses valores de campo de dados na solicitação POST de StartJob , é recomendável que você forneça os meios para selecionar o objeto do aplicativo e seus campos de dados relevantes necessários para o processo. Quando o trabalho é invocado, o conector recupera os valores do campo de dados e os adiciona na solicitação POST como o valor do parâmetro ArgumentoDeEntrada .

Observação:

Você também pode enviar uma solicitação GET para o endpoint Processes_GetArgumentsByKey para identificar se um processo tem 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 desse ponto de extremidade, e a razão pela qual ele não é usado em nossos exemplos, é que ele exigiria que o conector tivesse que fazer solicitações GET adicionais para recuperar informações que já foram fornecidas na resposta anterior de Versões GET (que é necessária para se 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
    }{
  "@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.

Nesses exemplos, introduzimos o conceito de um Modelo. Um modelo representa a associação de um objeto e/ou evento do aplicativo com um processo ou fila da UiPath. Conceitualmente, um modelo oferece a capacidade de invocar diferentes recursos do Orchestrator (por exemplo, iniciar um trabalho, adicionar um item da fila) quando diferentes eventos ocorrem em seu aplicativo (por exemplo, novo objeto criado, mudança de status do objeto) enquanto mantém uma única conexão autenticada.