Sobre argumentos de entrada e saída

Visão geral dos argumentos de entrada e saída para passar dados de e para processos de automação por meio do Orchestrator.

We have exposed the In and Out arguments, you are already used to in Studio, as a way to seamlessly integrate the tools you use, such as various DCMs or BPMs. This means that any process you create can now receive input arguments through the Orchestrator API or interface, as well as return output to all of the aforementioned.

Last but not least, this is a stepping stone in linking processes together. This extensibility helps you better integrate UiPath® in your company’s ecosystem.

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.

At design time, in Studio, the way you configure your project to accept In or Out arguments, with or without default values, enables you to use them in other third-party apps or Orchestrator. You can only make use of input and output arguments in Orchestrator and other third-party apps if you had added the corresponding arguments in your Studio project beforehand.

If no arguments have been added in Studio, the following message is displayed: "Input arguments are not defined for this version.".

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 nos argumentos In no Studio não serão exibidos no Orchestrator, em nenhum nível.

Orchestrator

• No nível do processo - na aba Argumentos da janela Exibir Processo, conforme explicado aqui.
• No nível de trabalho - na aba 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 um argumento de 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 endpoint; /odata/Processes/UiPath.Server.Configuration.OData.SetArguments(key='key');
• No nível do processo - como uma solicitação PATCH para o ponto de extremidade /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 do agendamento - como uma solicitação POST para o ponto de extremidade /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.

Figura 1. Valores do argumento

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:

Os fluxos de trabalho que foram criados e publicados no Orchestrator antes da v2018.3 devem ser carregados novamente com um robô v2018.3 (ou posterior), para que os argumentos In e Out do arquivo Main.xaml possam ser exibidos.

Permissões de argumentos

Os seguintes itens são necessários em relação aos argumentos de entrada e saída no Orchestrator:

• no nível do pacote - Exibir em Pacotes;
• no nível do processo - Exibir e Editar em Processos;
• no nível do trabalho - Criar em Trabalhos;
• no nível de gatilho – Criar e/ou Editar em Agendamentos.

Tratamento de grandes argumentos de entrada (>10.000 caracteres)

Quando o tamanho dos argumentos de entrada do trabalho excede 10.000 caracteres, o chamador que inicia o trabalho converte a carga em uma entrada baseada em anexo.

Nesse caso, o Orchestrator armazena os Argumentos de entrada como um anexo de arquivo e os passa para o robô como uma carga disponível para download, em vez de incluí-los diretamente no corpo da solicitação de trabalho.

Compatibilidade com a versão do robô

Esta funcionalidade é compatível com a versão 2025.10 do robô e posteriores.

Importante:

Os trabalhos que usam argumentos de entrada baseados em anexos falham quando os robôs que executam versões anteriores que não suportam este formato os executam.

Como lidar com entradas grandes

Se você encontrar esse comportamento, você pode:

• Atualize o robô para uma versão compatível (2025.10 ou posterior).
• Reduza o tamanho dos argumentos de entrada para que você possa enviá-los em linha.
• Descarregue a carga (recomendado) armazenando dados grandes externamente (por exemplo, em buckets de armazenamento ou armazenamento externo) e passando apenas uma referência (como um nome do arquivo, ID ou URL).

Exemplo

1. Carregue a grande carga (por exemplo, um arquivo JSON) para um bucket de armazenamento.
2. Passe uma referência para o arquivo como um argumento de entrada:

{
  "inputFileName": "large-payload.json"
}

3. No fluxo de trabalho, recupere e processe o arquivo usando a atividade apropriada (por exemplo, Download Storage File).