Executando um trabalho dentro do Orchestrator

Pré-requisitos:

• Criar um processo no Orchestrator.
• Execute o arquivo CLI exe (para Windows) ou dll (para Linux).
• Adicione os escopos de aplicativos de acesso à API do Orchestrator necessários.

Para executar um trabalho dentro do Orchestrator, siga as seguintes etapas:

1. Execute a tarefa job , usando uipcli job. Agora, é possível ver uma lista das subtarefas disponível
2. Especifique os parâmetros necessários e execute a subtarefa run .

   A seguinte tabela descreve os parâmetros necessários.

   Parâmetro	Description
   -iou --input_path (Obrigatório apenas se o ponto de entrada do fluxo de trabalho tiver parâmetros de entrada)	O caminho completo para o arquivo de entrada JSON correspondente ao processo que você deseja executar. Exemplo de formato de arquivo JSON: { "StringArgument_In": "MyConfigurationValue", "IntArgument_In": 1, "DictionaryArgument_In": { "Key1": "Value1", "Key2": "Value2" } }
   -Pou --priority	A prioridade com a qual você deseja executar o trabalho:- Baixa.- Normal (padrão).- Alto.
   -rou --robots	Uma lista de nomes de robôs específicos, separados por vírgulas.
   -jou --jobscount	O número de vezes que você deseja executar o processo. O número padrão de vezes que o processo é executado é um.
   -Uou --user	O nome do usuário. Deve ser um usuário de máquina, não um usuário do Orchestrator. Para usuários locais, o formato é MachineName\UserName.
   -Mou --machine	O nome da máquina na qual você deseja executar o processo.
   -Rou --result_path	O caminho completo para um arquivo JSON ou para uma pasta onde você deseja armazenar os resultados do trabalho. Os resultados retornam como arquivos JSON.
   -Wou --timeout	O tempo limite para execuções de trabalho (segundos). O padrão é 1800 segundos.
   -fou --fail_when_job_fails	O comando falha quando um trabalho falha. O padrão para isso é True.
   -wou --wait	O comando aguarda a conclusão do trabalho. O padrão para isso é True.
   -bou --job_type (somente para pastas modernas)	O tipo de tempo de execução para a tarefa. Você pode escolher:- Unattended- NonProduction.
   -u ou --username(necessário se você usar a autenticação básica, por meio de um nome de usuário e uma senha)	O nome de usuário usado para autenticação no Orchestrator. Você deve emparelhá-lo com a senha correspondente.
   -p ou --password(necessário se você usar a autenticação básica, por meio de um nome de usuário e uma senha)	A senha usada para autenticação ao Orchestrator. Você deve combiná-lo com o nome de usuário correspondente.
   -tou --token (obrigatório se você usar autenticação baseada em token)	O token de atualização OAuth2 usado para autenticação no Orchestrator. Você deve emparelhá-lo com o nome da conta e o ID do cliente.
   -aou --accountName (obrigatório se você usar autenticação baseada em token)	O nome da conta do Orchestrator CloudRPA. Você deve emparelhá-lo com o token de atualização OAuth2 e o Client ID.
   -Aou --accountForApp	O nome da conta CloudRPA do Orchestrator (nome da organização). Você deve combiná-lo com a ID do aplicativo, Segredo do aplicativo e Escopo do aplicativo para um aplicativo externo.
   -I ou --applicationId (Necessário se você usar a autenticação do aplicativo externo)	A ID do aplicativo externo. Você deve combiná-lo com a Conta do aplicativo, Segredo do aplicativo e Escopo do aplicativo.
   -S ou --applicationSecret (Necessário se você usar a autenticação do aplicativo externo)	O Segredo do aplicativo externo. Você deve combiná-lo com a Conta do aplicativo, ID do aplicativo e Escopo do aplicativo.
   --applicationScope (Necessário se você usar a autenticação do aplicativo externo)	A lista de escopos do aplicativo, separada por espaços únicos. Você deve combiná-lo com a Conta do aplicativo, ID do aplicativo e Segredo do aplicativo para um aplicativo externo.
   -oou --organizationUnit	O nome da pasta do Orchestrator (unidade organizacional). Para inserir subpastas, certifique-se de inserir o nome da pasta pai e o nome da subpasta. Por exemplo, use AccountingTeam\TeamJohn.
   -l, --language	O idioma do Orchestrator.
   -y, --disableTelemetry	Desabilitar dados de telemetria.
   --traceLevel	Exibir o rastreamento dos eventos.
   --identityUrl (Necessário apenas para implantações do PaaS)	A URL do seu servidor de identidade.
   Process Name (pos.0) (necessário)	O nome do processo que você deseja executar.
   Orchestrator URL (pos.1) (necessário)	O URL da instância do Orchestrator.
   Orchestrator Tenant (pos.2) (Obrigatório) para implantações SaaP. (Opcional) para implantações de PaaS.	O tenant da Instância do Orchestrator, onde você deseja executar processos.

Uso:

uipcli job run <process_name> <orchestrator_url> <orchestrator_tenant> [-i <input_path>] [-j <jobscount>] [-R <result_path>] [-P <Low|Normal|High>] [-r <robots>] [-f <false|true>] [-W <timeout>] [-w <false|true>] [-u <orchestrator_user> -p <orchestrator_pass>] [-t <auth_token> -a <account_name>] [-A <organization_name> -I <application_id> -S <application_secret> --applicationScope <application_scope>] [-o <folder_name>] [-l <language>] [--user <machine_user> --machine <machine_host_name>] [--job_type <Unattended|NonProduction>] [--traceLevel <None|Critical|Error|Warning|Information|Verbose>] [--identityUrl <identityUrl>]

Exemplos mínimos de comandos:

• uipcli job run ProcessName "https://orch-23-10-paas.cloudapp.azure.com/" "TenantName" -u "orchestratorUsername" -p "********" -o "FolderName" --traceLevel "Information"

• uipcli job run ProcessName "https://orch-23-10-paas.cloudapp.azure.com/" "TenantName" -I "76000552-3e4f-4590-9317-cdb420001f1d" -S "********" --applicationScope "OR.Folders OR.BackgroundTasks OR.TestSets OR.TestSetExecutions OR.TestSetSchedules OR.Settings.Read OR.Robots.Read OR.Machines.Read OR.Execution OR.Assets OR.Users.Read OR.Jobs OR.Monitoring" --identityUrl "https://orch-23-10-paas.cloudapp.azure.com/identity" -o "FolderName" --traceLevel "Information"

• uipcli job run ProcessName "https://automation-suite.base.url.com/" "TenantName" -A "organizationName" -I "3f6239b9-e0e8-465e-a429-d9ffd1d9e57a" -S "********" --applicationScope "OR.Folders OR.BackgroundTasks OR.TestSets OR.TestSetExecutions OR.TestSetSchedules OR.Settings.Read OR.Robots.Read OR.Machines.Read OR.Execution OR.Assets OR.Users.Read OR.Jobs OR.Monitoring" -o "FolderName" --traceLevel "Information"

• uipcli job run ProcessName "https://cloud.uipath.com/" "TenantName" -A "organizationName" -I "becc663c-8f1e-409a-a75f-c00330d80bc8" -S "********" --applicationScope "OR.Folders OR.BackgroundTasks OR.TestSets OR.TestSetExecutions OR .TestSetSchedules OR.Settings.Read OR.Robots.Read OR.Machines.Read OR.Execution OR.Assets OR.Users.Read OR.Jobs OR.Monitoring" -o "FolderName" --traceLevel "Information"