Guia do usuário do Orchestrator

ENTREGA:

Automation Cloud Automation Cloud Public Sector Automation Suite Standalone

Última atualização 4 de dez de 2024

Sobre argumentos de entrada e saída

Apresentamos os argumentos In e Out, aos quais você já está acostumado no Studio, como uma maneira de integrar perfeitamente as ferramentas que você usa, tais como várias DCMs ou BPMs. Isso significa que qualquer processo que você criar pode receber argumentos de entrada por meio da API ou da interface do Orchestrator, além de retornar a saída para todos os itens mencionados anteriormente. Por último, mas não menos importante, este é um ponto de partida para a vinculação de processos. Essa extensibilidade ajuda você a integrar melhor o UiPath® ao ecossistema da sua empresa.

Observação:

Apenas os argumentos In, Out e In/Out do .xaml marcado como Principal no Studio serão expostos a outros aplicativos.

Os argumentos são salvos em project.json de um projeto.

No tempo de design, no Studio, a maneira como você configura seu projeto para aceitar argumentos In ou Out, com ou sem valores padrão, permite que você os use em outros aplicativos de terceiros ou no Orchestrator. Você só pode usar os argumentos de entrada e saída no Orchestrator e outros aplicativos de terceiros, se tiver adicionado os argumentos correspondentes previamente no seu projeto do Studio. Se nenhum argumento foi adicionado no Studio, a seguinte mensagem é exibida: “Os argumentos de entrada não serão definidos para esta versão.”

Os argumentos In, Out ou In/Out de um projeto tornam-se argumentos de entrada e saída quando publicados no Orchestrator. Observe que para os argumentos In/Out, dois argumentos diferentes são criados e exibidos no Orchestrator, um de entrada e um de saída, com o mesmo nome.

Fornecer valores de argumentos

Os valores podem ser fornecidos apenas para os argumentos de entrada, seja usando Studio, Orchestrator ou a API do Orchestrator, da seguinte maneira:

Studio

Como valores padrão, ao criar os argumentos. Um breve exemplo pode ser encontrado aqui. Um valor padrão fornecido para um argumento no Studio pode ser substituído no Orchestrator, tanto no nível do processo quanto no nível do trabalho.

Observação: os valores-padrão fornecidos para argumentos In Studio não são exibidos no Orchestrator em qualquer nível.

Orchestrator

No nível do processo - na guia Argumentos da janela Visualizar processo, conforme explicado aqui.
No nível do trabalho - na guia Argumentos da janela Iniciar trabalho, conforme explicado aqui.
No nível de gatilho - na guia Argumentos da janela Adicionar gatilho, como explicado aqui.

Observação: um valor fornecido para os argumentos de uma entrada no nível de processo no Orchestrator é mantido quando você atualiza o pacote, desde que a nova versão do pacote não esteja relacionada à definição dos argumentos.
O limite de armazenamento para argumentos de entrada/saída é de 1 MB.

Se você fornecer valores para os argumentos de entrada no Orchestrator, observe que eles devem ser fornecidos em formato JSON. Alguns exemplos de como você pode fazer isso:

String - O valor deve ser fornecido sem aspas, como string;
Int32 - Forneça o valor como faria para qualquer inteiro, 11;
Boolean – Dois botões de opção serão exibidos para ajudar você a selecionar true ou false;
Double – Forneça o valor como um valor de ponto flutuante, como 3.5;
DateTime - Forneça o valor como um JSON válido, como "2012-04-23T18:25:43.511Z";
Array – Forneça valores como JSON válido, como [1, 1, 2, 3, 5, 8] ou ["firstString", "secondString"].

Observação: todos os tipos de argumentos In podem ser usados, mas lembre-se de que apenas os primitivos serão validados pelo Orchestrator.
Quando tipos enumerados (enums) são convertidos para JSON, cada membro de enumeração é representado por um valor inteiro, em vez de pelo seu nome. Isso significa que a representação JSON de um enum é o valor numérico de cada membro incluído na enumeração original.

API do Orchestrator

No nível do pacote - para o terminal /odata/Processes/UiPath.Server.Configuration.OData.SetArguments(key='key');
No nível do processo - como uma solicitação PATCH para o terminal /odata/Releases(Id);
No nível do trabalho - como uma solicitação POST para o ponto de extremidade /odata/Jobs/UiPath.Server.Configuration.OData.StartJobs;
No nível de planejamento - como uma solicitação POST para o terminal /odata/ProcessSchedules.

Observação: para as chamadas de API, um máximo de 10.000 caracteres é aceito para toda a extensão da representação JSON de argumentos de entrada, incluindo nomes de argumentos, todos os caracteres escapados, espaços, parênteses e os valores de argumentos.

Exibir valores de argumentos

O valor de um argumento de entrada é marcado da seguinte maneira:

Sem valor - nenhum valor foi fornecido para o argumento no nível de processo, trabalho, agendamento ou de pacote (no Studio).
Herdado do pacote – Se o valor tiver sido fornecido por padrão no Studio. Esta mensagem será exibida na janela Argumentos de um pacote específico, além das janelas Visualizar Processo, Iniciar Trabalho e Adicionar Agendamento.
Herdado do processo - Se o valor tiver sido fornecido no nível de processo (na janela Exibir processo). Essa mensagem é exibida na janela Iniciar trabalho e Adicionar agendamento. Na janela Exibir processo, o valor será exibido.

Se os valores de argumento de entrada ou saída existirem, eles serão exibidos na janela Detalhes do Trabalho. Os valores de entrada são exibidos na janela mencionada acima nos seguintes casos:

eles foram adicionados no nível de processo;
eles foram adicionados no nível de trabalho.

Você também pode ver os argumentos de entrada e saída no nível do pacote, na janela Versões de Pacote. Para obter mais informações, consulte o Gerenciamento de pacotes.

Observação: fluxos de trabalho criados e publicados para o Orchestrator antes de v2018.3 devem ser recarregados com um robô v2018.3 v2018.3 (ou posterior), para que os argumentos In e Out do arquivo Main.xaml possam ser exibidos.