Test Suite

2022.10

falso

Guia do usuário do Test Suite

Última atualização 8 de mar de 2024

Executando Tarefas

Executar tarefas dentro do UiPath CLI projetado para dispositivos Windows (UiPath.CLI.Windows) requer várias tarefas.

As principais diferenças entre os procedimentos para o UiPath.CLI.Windows e os procedimentos para o UiPath.CLI (UiPath CLI projetado para dispositivos Linux) consistem em argumentos adicionais que você pode passar com algumas tarefas específicas para o tipo de dispositivo que você está correndo.

Escopos de aplicativos de acesso à API

A tabela a seguir mostra os escopos de aplicativos de acesso à API do Orchestrator necessários para executar qualquer tarefa da CLI.

Escopo do aplicativo	Description
OU. Ativos	Acesso de leitura e gravação de ativos no Orchestrator.
OR.BackgroundTasks	Acesso de leitura e gravação de BackgroundTasks no Orchestrator.
OU. Execução	Acesso de leitura e gravação de execução no Orchestrator.
OU.Pastas	Acesso de leitura e gravação de pastas no Orchestrator.
OU.Empregos	Acesso de leitura e gravação de trabalhos no Orchestrator.
OR.Machines.Read	Acesso de leitura de máquinas no Orchestrator.
OU.Monitoramento	Acesso de leitura e gravação de monitoramento no Orchestrator.
OU.Robôs.Leitura	Acesso de leitura de robôs no Orchestrator.
OU.Configurações.Ler	Acesso de leitura de configurações no Orchestrator.
OR.TestSets	Acesso de leitura e gravação de TestSets no Orchestrator.
OR.TestSetExecutions	Acesso de leitura e gravação de TestSetExecutions no Orchestrator.
OR.TestSetSchedules	Acesso de leitura e gravação de TestSetSchedules no Orchestrator.
OU.Usuários.Leitura	Acesso de leitura de usuários no Orchestrator.

Executando UiPath.CLI.Wndows

Pré-requisitos: para usar o UiPath CLI para Windows e executar tarefas, instale o .NET 6.0.7, que deve incluir o .NET 6.0.7 Desktop Runtime, que vem com o SDK 6.0.302.

Você pode executar tarefas chamandouipcli.exe incluindo os parâmetros correspondentes. Para executar subtarefas, o comando precisa ter o seguinte formato: uipcli.exe <task name> <sub-task name>. Para executar a CLI:

Abra um prompt de comando e navegue até a pasta extraída do arquivo NUPKG.
Digite uipcli.exe e selecione a tecla Enter .

Executando UiPath.CLI

Pré-requisitos: para usar o UiPath CLI para multiplataformas e executar tarefas de trabalho, instale o .NET 6.0.7, que vem com o SDK 6.0.302.

Você pode executar tarefas chamandouipcli.exe incluindo os parâmetros correspondentes. Para executar subtarefas, o comando precisa ter o seguinte formato: dotnet uipcli.dll <task name> <sub-task name>. Para executar a CLI:

Abra um prompt de comando e navegue até a pasta extraída do arquivo NUPKG.
Digitedotnet uipcli.dll e selecione a chave Enter.

Exibindo a versão CLI

Execute o comando uipcli --version.

Excluindo ativos do orquestrador

Pré-requisitos:

Crie ativos no Orchestrator.
Crie um arquivo CSV que contenha os ativos que você deseja excluir. O arquivo CSV deve ter as três colunas a seguir: name, typee value. As células de dados nas colunas typee value podem permanecer vazias.
Execute o arquivo CLI exe (para Windows) ou dll (para Linux).

Adicione os escopos de aplicativos de acesso à API do Orchestrator abaixo:

Escopo do aplicativo	Description
OU. Ativos	Acesso de leitura e gravação de ativos no Orchestrator.
OR.BackgroundTasks	Acesso de leitura e gravação de BackgroundTasks no Orchestrator.
OU. Execução	Acesso de leitura e gravação de execução no Orchestrator.
OU.Pastas	Acesso de leitura e gravação de pastas no Orchestrator.
OU.Empregos	Acesso de leitura e gravação de trabalhos no Orchestrator.
OR.Machines.Read	Acesso de leitura de máquinas no Orchestrator.
OU.Monitoramento	Acesso de leitura e gravação de monitoramento no Orchestrator.
OU.Robôs.Leitura	Acesso de leitura de robôs no Orchestrator.
OU.Configurações.Ler	Acesso de leitura de configurações no Orchestrator.
OR.TestSets	Acesso de leitura e gravação de TestSets no Orchestrator.
OR.TestSetExecutions	Acesso de leitura e gravação de TestSetExecutions no Orchestrator.
OR.TestSetSchedules	Acesso de leitura e gravação de TestSetSchedules no Orchestrator.
OU.Usuários.Leitura	Acesso de leitura de usuários no Orchestrator.

Para mais informações sobre o arquivo CSV, confira os exemplos na tabela abaixo:

name	Tipo	Value
asset1_name	`N/A`	`N/A`
asset2_name	Bool	`true`
asset3_name	Número inteiro	`N/A`
asset4_name	Credencial	username:password

Para excluir ativos do Orchestrator:

Execute a tarefa asset , usando uipcli asset. Você pode ver uma lista das subtarefas disponíveis.

Especifique os parâmetros necessários e execute a subtarefa delete .

Veja a lista de parâmetros abaixo.

Parâmetro	Description
`Assets File (pos. 0)` (necessário)	O nome do arquivo CSV que contém os recursos que você deseja excluir.
`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 locatário da instância do Orchestrator em que você deseja gerenciar seus ativos.
`-u,` ou `--username` (Obrigatório se você usar 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.
`-t`, ou `--token`(Necessário se você usar a 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.
`-a`, ou `--accountName`(Necessário se você usar a 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.
`-A`ou `--accountForApp`	O nome da conta CloudRPA do Orchestrator. 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 por 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 por aplicativo externo)	O Segredo do aplicativo externo. Você deve combiná-lo com a Conta do aplicativo, ID do aplicativo e Escopo de 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.
`-o`ou `--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`ou `--language`	O idioma usado na interface do usuário do Orchestrator.
`-y`ou `--disableTelemetry`	Desabilitar dados de telemetria.
`--traceLevel`	Exibir o rastreamento dos eventos.
`--identityUrl` (exigido apenas para implantações de PaaS )	A URL do seu servidor de identidade.

Exemplos:

asset delete assets_file.csv "https://uipath-orchestrator.myorg.com" default -u admin -p 123456 -l en-US
asset delete assets_file.csv "https://uipath-orchestrator.myorg.com" default -u admin -p 123456 -o OurOrganization
asset delete assets_file.csv "https://uipath-orchestrator.myorg.com" default -t a7da29a2c93a717110a82 -a myAccount
asset delete assets_file.csv "https://uipath-orchestrator.myorg.com" default -A accountForExternalApp -I myExternalAppId -S myExternalAppSecret --applicationScope "OR.Folders.Read OR.Settings.Read"

Implantação de ativos no Orchestrator

Pré-requisitos:

Crie um arquivo CSV que contenha os ativos que você deseja implantar no Orchestrator.
O arquivo CSV deve ter as três colunas a seguir: name, type, valuee description.
Execute o arquivo CLI exe (para Windows) ou dll (para Linux).

Adicione os escopos de aplicativos de acesso à API do Orchestrator abaixo:

Escopo do aplicativo	Description
OU. Ativos	Acesso de leitura e gravação de ativos no Orchestrator.
OR.BackgroundTasks	Acesso de leitura e gravação de BackgroundTasks no Orchestrator.
OU. Execução	Acesso de leitura e gravação de execução no Orchestrator.
OU.Pastas	Acesso de leitura e gravação de pastas no Orchestrator.
OU.Empregos	Acesso de leitura e gravação de trabalhos no Orchestrator.
OR.Machines.Read	Acesso de leitura de máquinas no Orchestrator.
OU.Monitoramento	Acesso de leitura e gravação de monitoramento no Orchestrator.
OU.Robôs.Leitura	Acesso de leitura de robôs no Orchestrator.
OU.Configurações.Ler	Acesso de leitura de configurações no Orchestrator.
OR.TestSets	Acesso de leitura e gravação de TestSets no Orchestrator.
OR.TestSetExecutions	Acesso de leitura e gravação de TestSetExecutions no Orchestrator.
OR.TestSetSchedules	Acesso de leitura e gravação de TestSetSchedules no Orchestrator.
OU.Usuários.Leitura	Acesso de leitura de usuários no Orchestrator.

Para obter mais informações sobre o arquivo CSV, verifique o exemplo abaixo.

name	Tipo	Value	Descrição
asset_1_name	text	"tenho um comentário"	asset_1_description
asset_2_name	Número inteiro	`1`	asset_2_description
asset_3_name	Bool	`false`	asset_3_description
asset_4_name	Credencial	username:password	asset_4_description

Para implantar ativos no Orchestrator:

Execute a tarefa asset , usando uipcli asset. Você pode ver uma lista das subtarefas disponíveis.

Especifique os parâmetros necessários e execute a subtarefa deploy .

Veja a lista de parâmetros abaixo.

Parâmetro	Description
`Assets File (pos. 0)` (necessário)	O nome do arquivo CSV que contém os recursos que você deseja excluir.
`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 gerenciar seus ativos.
`-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.
`-t`, ou `--token`(Necessário se você usar a 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.
`-a`, ou `--accountName`(Necessário se você usar a 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.
`-A`ou `--accountForApp`	O nome da conta CloudRPA do Orchestrator. 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 por 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 por aplicativo externo)	O Segredo do aplicativo externo. Você deve combiná-lo com a Conta do aplicativo, ID do aplicativo e Escopo de 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.
`-o`ou `--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`ou `--language`	O idioma usado na interface do usuário do Orchestrator.
`-y`ou `--disableTelemetry`	Desabilitar dados de telemetria.
`--traceLevel`	Exibir o rastreamento dos eventos.
`--identityUrl` (exigido apenas para implantações de PaaS )	A URL do seu servidor de identidade.

Exemplos:

asset deploy assets_file.csv "https://uipath-orchestrator.myorg.com" default -u admin -p 123456 -l en-US.
asset deploy assets_file.csv "https://uipath-orchestrator.myorg.com" default -u admin -p 123456 -o OurOrganization.
asset deploy assets_file.csv "https://uipath-orchestrator.myorg.com" default -t a7da29a2c93a717110a82 -a myAccount.
asset delete assets_file.csv "https://uipath-orchestrator.myorg.com" default -A accountForExternalApp -I myExternalAppId -S myExternalAppSecret --applicationScope "OR.Folders.Read OR.Settings.Read".

Executando um trabalho dentro do Orchestrator

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 abaixo:

Escopo do aplicativo	Description
OU. Ativos	Acesso de leitura e gravação de ativos no Orchestrator.
OR.BackgroundTasks	Acesso de leitura e gravação de BackgroundTasks no Orchestrator.
OU. Execução	Acesso de leitura e gravação de execução no Orchestrator.
OU.Pastas	Acesso de leitura e gravação de pastas no Orchestrator.
OU.Empregos	Acesso de leitura e gravação de trabalhos no Orchestrator.
OR.Machines.Read	Acesso de leitura de máquinas no Orchestrator.
OU.Monitoramento	Acesso de leitura e gravação de monitoramento no Orchestrator.
OU.Robôs.Leitura	Acesso de leitura de robôs no Orchestrator.
OU.Configurações.Ler	Acesso de leitura de configurações no Orchestrator.
OR.TestSets	Acesso de leitura e gravação de TestSets no Orchestrator.
OR.TestSetExecutions	Acesso de leitura e gravação de TestSetExecutions no Orchestrator.
OR.TestSetSchedules	Acesso de leitura e gravação de TestSetSchedules no Orchestrator.
OU.Usuários.Leitura	Acesso de leitura de usuários no Orchestrator.

Execute a tarefa job, usando uipcli job. Agora você pode ver uma lista das subtarefas disponível

Especifique os parâmetros necessários e execute a subtarefa run .

Veja a lista de parâmetros abaixo.

Parâmetro	Description
`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)` - (Necessário) para implantações do SaaP. - (Opcional) para implantações do PaaS.	O tenant da Instância do Orchestrator, onde você deseja executar processos.
`-i`ou `--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.
`-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.
`-t`, ou `--token`(Necessário se você usar a 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.
`-a`, ou `--accountName`(Necessário se você usar a 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.
`-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.
`-P`ou `--priority`	A prioridade com a qual você deseja executar o trabalho:- Baixa.- Normal (padrão).- Alto.
`-r`ou `--robots`	Uma lista de nomes de robôs específicos, separados por vírgulas.
`-j`ou `--jobscount`	O número de vezes que você deseja executar o processo. O número padrão de vezes que o processo é executado é um.
`-U`ou `--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.
`-M`ou `--machine`	O nome da máquina na qual você deseja executar o processo.
`-R`ou `--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.
`-W`ou `--timeout`	O tempo limite para execuções de trabalho (segundos). O padrão é 1800 segundos.
`-f`ou `--fail_when_job_fails`	O comando falha quando um trabalho falha. O padrão para isso é True.
`-w`ou `--wait`	O comando aguarda a conclusão do trabalho. O padrão para isso é True.
`-b`ou `--job_type` (somente para pastas modernas)	O tipo de tempo de execução para a tarefa. Você pode escolher:- `Unattended`- `NonProduction`.
`-A`ou `--accountForApp`	O nome da conta CloudRPA do Orchestrator. Você deve combiná-lo com a ID do aplicativo, Segredo do aplicativo e Escopo do aplicativo para um aplicativo externo.
`-o`ou `--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`.

job run ProcessName "https://uipath-orchestrator.myorg.com" default -u admin -p 123456 -P High -o MyFolder
job run ProcessName "https://uipath-orchestrator.myorg.com" default -t a7da29a2c93a717110a82 -a myAccount -P High -j 3 -w false
job run ProcessName "https://uipath-orchestrator.myorg.com" default -t a7da29a2c93a717110a82 -a myAccount -r robotName -R C:\Temp\status.json

Analisando um Projeto

Pré-requisitos:

Criar um projeto
Execute o arquivo CLI exe (para Windows) ou dll (para Linux).

Adicione os escopos de aplicativos de acesso à API do Orchestrator abaixo:

Escopo do aplicativo	Description
OU. Ativos	Acesso de leitura e gravação de ativos no Orchestrator.
OR.BackgroundTasks	Acesso de leitura e gravação de BackgroundTasks no Orchestrator.
OU. Execução	Acesso de leitura e gravação de execução no Orchestrator.
OU.Pastas	Acesso de leitura e gravação de pastas no Orchestrator.
OU.Empregos	Acesso de leitura e gravação de trabalhos no Orchestrator.
OR.Machines.Read	Acesso de leitura de máquinas no Orchestrator.
OU.Monitoramento	Acesso de leitura e gravação de monitoramento no Orchestrator.
OU.Robôs.Leitura	Acesso de leitura de robôs no Orchestrator.
OU.Configurações.Ler	Acesso de leitura de configurações no Orchestrator.
OR.TestSets	Acesso de leitura e gravação de TestSets no Orchestrator.
OR.TestSetExecutions	Acesso de leitura e gravação de TestSetExecutions no Orchestrator.
OR.TestSetSchedules	Acesso de leitura e gravação de TestSetSchedules no Orchestrator.
OU.Usuários.Leitura	Acesso de leitura de usuários no Orchestrator.

Execute a tarefa package , usando uipcli package. Você pode ver uma lista das subtarefas disponíveis.
Especifique os parâmetros necessários e execute a subtarefa analyze .

Veja a lista de parâmetros abaixo.

Legenda: (*) - Opcional, recomendado ao usar feeds de pacote adicionais.

Parâmetro	Description
`Project(s) Path (pos.0)` (Necessário)	O caminho para o arquivo `project.json` ou o caminho para a pasta que contém vários arquivos `project.json` .
`--analyzerTraceLevel`	Escolha quais tipos de mensagens enviar após a análise: Desligado = não mostra nenhuma mensagem Erro -Warning -Informações -Verboso.
`-stopOnRuleViolation`	O trabalho falha quando alguma regra é violada.
`--treatWarningsAsErrors`	Trate os avisos como erros.
`--resultPath`	O caminho completo para um arquivo JSON no qual você deseja armazenar os resultados. Se você não adicionar isso como um argumento, os resultados serão impressos apenas no console padrão.
`--ignoredRules`	Uma lista de regras que você deseja ignorar durante a análise, separadas por vírgulas.
`--orchestratorUsername` () (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.
`--orchestratorPassword` () (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.
`-orchestratorAuthToken` () (Obrigatório* se você usar a 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.
`--orchestratorAccountName` () (Obrigatório* se você usar a 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.
`--orchestratorAccountForApp` (*)	O nome da conta CloudRPA do Orchestrator. Você deve combiná-lo com a ID do aplicativo, Segredo do aplicativo e Escopo do aplicativo para um aplicativo externo.
`--orchestratorApplicationId` () (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**.
`--orchestratorApplicationSecret` () (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 de aplicativo.
`--orchestratorApplicationScope` () (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.
`--orchestratorFolder` (*)	O nome da pasta de destino do Orchestrator. Para inserir subpastas, certifique-se de inserir o nome da pasta pai e o nome da subpasta. Por exemplo, use `AccountingTeam\TeamJohn`.
`--orchestratorUrl` (*)	O URL da instância do Orchestrator.
`--orchestratorTenant` (*)	O locatário da instância do Orchestrator em que você deseja excluir uma máquina.
`--help`	Exibe os parâmetros e exemplos para este comando.

Exemplos:

package analyze "C:\UiPath\Project\project.json" --analyzerTraceLevel "Error" --stopOnRuleViolation --treatWarningsAsErrors --resultPath "C:\UiPath\Project\output.json"
package analyze "C:\UiPath\Project\project.json" --analyzerTraceLevel "Error" --stopOnRuleViolation --treatWarningsAsErrors --resultPath "C:\UiPath\Project\output.json" --ignoredRules "ST-NMG-009,ST-DBP-020,UI-USG-011,ST-DBP-020"
package analyze "C:\UiPath\Project\project.json" --analyzerTraceLevel "Error" --stopOnRuleViolation --treatWarningsAsErrors --resultPath "C:\UiPath\Project\output.json" --ignoredRules "ST-NMG-009,ST-DBP-020,UI-USG-011,ST-DBP-020" --orchestratorUrl "https://orchestratorurl.com" --orchestratorTenant "default" --orchestratorUsername "username" --orchestratorPassword "\_ye5zG9(x" --orchestratorAuthToken "AuthToken" --orchestratorAccountName "AccountName" --orchestratorFolder "OrchestratorFolder"

Exclusão de um pacote

Pré-requisitos:

Publique um pacote no Orchestrator.
Execute o arquivo CLI exe (para Windows) ou dll (para Linux).

Adicione os escopos de aplicativos de acesso à API do Orchestrator abaixo:

Escopo do aplicativo	Description
OU. Ativos	Acesso de leitura e gravação de ativos no Orchestrator.
OR.BackgroundTasks	Acesso de leitura e gravação de BackgroundTasks no Orchestrator.
OU. Execução	Acesso de leitura e gravação de execução no Orchestrator.
OU.Pastas	Acesso de leitura e gravação de pastas no Orchestrator.
OU.Empregos	Acesso de leitura e gravação de trabalhos no Orchestrator.
OR.Machines.Read	Acesso de leitura de máquinas no Orchestrator.
OU.Monitoramento	Acesso de leitura e gravação de monitoramento no Orchestrator.
OU.Robôs.Leitura	Acesso de leitura de robôs no Orchestrator.
OU.Configurações.Ler	Acesso de leitura de configurações no Orchestrator.
OR.TestSets	Acesso de leitura e gravação de TestSets no Orchestrator.
OR.TestSetExecutions	Acesso de leitura e gravação de TestSetExecutions no Orchestrator.
OR.TestSetSchedules	Acesso de leitura e gravação de TestSetSchedules no Orchestrator.
OU.Usuários.Leitura	Acesso de leitura de usuários no Orchestrator.

Execute a tarefa package , usando uipcli package. Você pode ver uma lista das subtarefas disponíveis.

Especifique os parâmetros necessários e execute a subtarefa delete .

Veja a lista de parâmetros abaixo.

Parâmetro	Description
`Package name (pos. 0)` (necessário)	O nome do pacote que você deseja excluir.
`Orchestrator URL (pos. 1)`	O URL da instância do Orchestrator.
`Orchestrator Tenant (pos. 2)` (Obrigatório) para implantações SaaP. (Opcional) para implantações de PaaS.	O locatário da instância do Orchestrator em que você deseja excluir uma máquina.
`-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.
`-t`, ou `--token`(Necessário se você usar a 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.
`-a`, ou `--accountName`(Necessário se você usar a 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.
`-A`ou `--accountForApp`	O nome da conta CloudRPA do Orchestrator. 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 por 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 por aplicativo externo)	O Segredo do aplicativo externo. Você deve combiná-lo com a Conta do aplicativo, ID do aplicativo e Escopo de 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.
`-o`ou `--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`ou `--language`	O idioma usado na interface do usuário do Orchestrator.
`-y`ou `--disableTelemetry`	Desabilitar dados de telemetria.
`--traceLevel`	Exibir o rastreamento dos eventos.
`--identityUrl` (exigido apenas para implantações de PaaS )	A URL do seu servidor de identidade.
`--help`	Exibe os parâmetros e exemplos para este comando.

Exemplos:

package delete PackageName "https://uipath-orchestrator.myorg.com" default -u admin -p 123456 -l en-US.
package delete PackageName "https://uipath-orchestrator.myorg.com" default -t refreshToken -a accountName.
package delete PackageName "https://uipath-orchestrator.myorg.com" default -A accountForExternalApp -I myExternalAppId -S myExternalAppSecret --applicationScope "OR.Folders.Read OR.Settings.Read".

Implantação de um pacote no Orchestrator

Pré-requisitos:

Crie um pacote.
Execute o arquivo CLI exe (para Windows) ou dll (para Linux).

Adicione os escopos de aplicativos de acesso à API do Orchestrator abaixo:

Escopo do aplicativo	Description
OU. Ativos	Acesso de leitura e gravação de ativos no Orchestrator.
OR.BackgroundTasks	Acesso de leitura e gravação de BackgroundTasks no Orchestrator.
OU. Execução	Acesso de leitura e gravação de execução no Orchestrator.
OU.Pastas	Acesso de leitura e gravação de pastas no Orchestrator.
OU.Empregos	Acesso de leitura e gravação de trabalhos no Orchestrator.
OR.Machines.Read	Acesso de leitura de máquinas no Orchestrator.
OU.Monitoramento	Acesso de leitura e gravação de monitoramento no Orchestrator.
OU.Robôs.Leitura	Acesso de leitura de robôs no Orchestrator.
OU.Configurações.Ler	Acesso de leitura de configurações no Orchestrator.
OR.TestSets	Acesso de leitura e gravação de TestSets no Orchestrator.
OR.TestSetExecutions	Acesso de leitura e gravação de TestSetExecutions no Orchestrator.
OR.TestSetSchedules	Acesso de leitura e gravação de TestSetSchedules no Orchestrator.
OU.Usuários.Leitura	Acesso de leitura de usuários no Orchestrator.

Execute a tarefa package , usando uipcli package. Você pode ver uma lista das subtarefas disponíveis.

Especifique os parâmetros necessários e execute a subtarefa deploy .

Veja a lista de parâmetros abaixo.

Parâmetro	Description
`Package(s) Path (pos. 0)` (necessário)	O caminho para um arquivo de pacote ou o caminho para uma pasta contendo vários pacotes.
`Orchestrator URL (pos. 1)` (necessário)	O URL da instância do Orchestrator.
Tenant do Orchestrator (pos. 2) (Obrigatório) para implantações SaaP. (Opcional) para implantações do PaaS.`	O locatário da instância do Orchestrator em que você deseja excluir uma máquina.
`-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.
`-t`, ou `--token`(Necessário se você usar a 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.
`-a`, ou `--accountName`(Necessário se você usar a 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.
`-A`ou `--accountForApp`	O nome da conta CloudRPA do Orchestrator. 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 por 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 por aplicativo externo)	O Segredo do aplicativo externo. Você deve combiná-lo com a Conta do aplicativo, ID do aplicativo e Escopo de 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.
`-c`ou `--createProcess`	Quando definido como `true`, ele cria um processo na pasta do Orchestrator que é passado no comando. O valor padrão para essa opção é True. Quando definido como `false`, ele não cria um processo na pasta do Orchestrator. Por exemplo, `--createProcess false.`
`-e`ou `--environments` (para pastas clássicas)	Uma lista de ambientes nos quais você deseja implantar o pacote, separados por vírgulas. Se o ambiente não pertencer à pasta padrão (unidade organizacional), você deve prefixar o nome do ambiente com o nome da pasta. Por exemplo, se o ambiente for TestEnvironmente o nome da pasta for AccountingTeam, grave o ambiente como AccountingTeam\TestEnvironment.
`-h`ou `--entryPointsPath`	Define os pontos de entrada específicos para criar ou atualizar o processo. Esse é o caminho do arquivo do entry point, a partir da raiz do projeto. Para pastas clássicas, apenas um único ponto de entrada pode ser especificado para cada ambiente.
`-o`ou `--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`ou `--language`	O idioma usado na interface do usuário do Orchestrator.
`-y`ou `--disableTelemetry`	Desabilitar dados de telemetria.
`--traceLevel`	Exibir o rastreamento dos eventos.
`--identityUrl` (exigido apenas para implantações de PaaS )	A URL do seu servidor de identidade.
`--help`	Exibe os parâmetros e exemplos para este comando.

Exemplos:

package deploy "C:\UiPath\Project\TestsPackage.1.0.6820.22047.nupkg" "https://uipath-orchestrator.myorg.com" default -u admin -p 123456 -e SAPEnvironment,ExcelAutomationEnvironment -l en-US.
package deploy "C:\UiPath\Project\TestsPackage.1.0.6820.22047.nupkg" "https://uipath-orchestrator.myorg.com" default -A myAccountForExternalApp -I myExternalAppId -S myExternalAppSecret --applicationScope "OR.Folders.Read OR.Settings.Read".
package deploy "C:\UiPath\Project\TestsPackage.1.0.6820.22047.nupkg" "https://uipath-orchestrator.myorg.com" default -u admin -p 123456 -e SAPEnvironment,ExcelAutomationEnvironment -l en-US -h EntryPoint1,EntryPoint2.

Empacotando projetos em um pacote

Pré-requisitos:

Criar projetos.
Execute o arquivo CLI exe (para Windows) ou dll (para Linux).

Adicione os escopos de aplicativos de acesso à API do Orchestrator abaixo:

Escopo do aplicativo	Description
OU. Ativos	Acesso de leitura e gravação de ativos no Orchestrator.
OR.BackgroundTasks	Acesso de leitura e gravação de BackgroundTasks no Orchestrator.
OU. Execução	Acesso de leitura e gravação de execução no Orchestrator.
OU.Pastas	Acesso de leitura e gravação de pastas no Orchestrator.
OU.Empregos	Acesso de leitura e gravação de trabalhos no Orchestrator.
OR.Machines.Read	Acesso de leitura de máquinas no Orchestrator.
OU.Monitoramento	Acesso de leitura e gravação de monitoramento no Orchestrator.
OU.Robôs.Leitura	Acesso de leitura de robôs no Orchestrator.
OU.Configurações.Ler	Acesso de leitura de configurações no Orchestrator.
OR.TestSets	Acesso de leitura e gravação de TestSets no Orchestrator.
OR.TestSetExecutions	Acesso de leitura e gravação de TestSetExecutions no Orchestrator.
OR.TestSetSchedules	Acesso de leitura e gravação de TestSetSchedules no Orchestrator.
OU.Usuários.Leitura	Acesso de leitura de usuários no Orchestrator.

Execute a tarefa package , usando uipcli package. Você pode ver uma lista das subtarefas disponíveis.
Especifique os parâmetros necessários e execute a subtarefa pack .

Veja a lista de parâmetros abaixo.

Legenda: (*) - Opcional, útil apenas quando você possui dependências de uma biblioteca no Orchestrator.

Parâmetro	Description
`Project(s) Path (pos. 0)` (Necessário)	O caminho para um arquivo `project.json` ou para uma pasta que contém `project.json` arquivos.
`-o`, or `--output` (Required)	A pasta do Orchestrator de destino, onde você deseja empacotar os projetos.
`-v`, or `--version`	Defina a versão do pacote.
`--autoVersion`	Gera automaticamente uma versão do pacote.
`--outputType`	Força a saída a ser de um tipo específico.
`--libraryOrchestratorUsername` () (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. Isso é necessário se o seu pacote fizer referência a bibliotecas do feed do orquestrador
`--libraryOrchestratorPassword` () (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. Isso é necessário se o seu pacote fizer referência a bibliotecas do feed do orquestrador
`--libraryOrchestratorAuthToken` () (Obrigatório* se você usar a 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. Isso é necessário se o seu pacote fizer referência a bibliotecas do feed do orquestrador
`--libraryOrchestratorAccountName` () (Obrigatório* se você usar a 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. Isso é necessário se o seu pacote fizer referência a bibliotecas do feed do orquestrador
`--libraryOrchestratorAccountForApp` (*)	O nome da conta CloudRPA do Orchestrator. Você deve combiná-lo com a ID do aplicativo, Segredo do aplicativo e Escopo do aplicativo para um aplicativo externo Isso é necessário se o seu pacote fizer referência a bibliotecas do feed do orquestrador
`--libraryOrchestratorApplicationId` () (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. Isso é necessário se o seu pacote fizer referência a bibliotecas do feed do orquestrador
`--libraryOrchestratorApplicationSecret` () (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 de aplicativo. Isso é necessário se o seu pacote fizer referência a bibliotecas do feed do orquestrador
`--libraryOrchestratorApplicationScope` () (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. Isso é necessário se o seu pacote fizer referência a bibliotecas do feed do orquestrador
`--libraryOrchestratorFolder` (*)	O nome da pasta de destino do Orchestrator. Para inserir subpastas, certifique-se de inserir o nome da pasta pai e o nome da subpasta. Por exemplo, use `AccountingTeam\TeamJohn`.
`--libraryOrchestratorUrl` (*)	O URL da instância do Orchestrator.
`--libraryOrchestratorTenant` (*)	O locatário da instância do Orchestrator em que você deseja excluir uma máquina.
`-y`, or `--disableTelemetry`	Desabilitar dados de telemetria.
`--traceLevel`	Exibir o rastreamento dos eventos.
`-l`, or `--language`	O idioma usado na interface do usuário do Orchestrator.
`--help`	Exibe os parâmetros e exemplos para este comando.

Exemplos:

package pack "C:\UiPath\Project\project.json" -o "C:\UiPath\Package" -v 1.0.6820.22047.
package pack "C:\UiPath\Project\project.json" -o "C:\UiPath\Package" --autoVersion.
package pack "C:\UiPath\Project\project.json" -o "C:\UiPath\Package" --outputType Tests -l en-US.

Testando um pacote/Executando um conjunto de teste

Pré-requisitos:

Crie um pacote ou conjunto de testes.
Execute o arquivo CLI exe (para Windows) ou dll (para Linux).

Adicione os escopos de aplicativos de acesso à API do Orchestrator abaixo:

Escopo do aplicativo	Description
OU. Ativos	Acesso de leitura e gravação de ativos no Orchestrator.
OR.BackgroundTasks	Acesso de leitura e gravação de BackgroundTasks no Orchestrator.
OU. Execução	Acesso de leitura e gravação de execução no Orchestrator.
OU.Pastas	Acesso de leitura e gravação de pastas no Orchestrator.
OU.Empregos	Acesso de leitura e gravação de trabalhos no Orchestrator.
OR.Machines.Read	Acesso de leitura de máquinas no Orchestrator.
OU.Monitoramento	Acesso de leitura e gravação de monitoramento no Orchestrator.
OU.Robôs.Leitura	Acesso de leitura de robôs no Orchestrator.
OU.Configurações.Ler	Acesso de leitura de configurações no Orchestrator.
OR.TestSets	Acesso de leitura e gravação de TestSets no Orchestrator.
OR.TestSetExecutions	Acesso de leitura e gravação de TestSetExecutions no Orchestrator.
OR.TestSetSchedules	Acesso de leitura e gravação de TestSetSchedules no Orchestrator.
OU.Usuários.Leitura	Acesso de leitura de usuários no Orchestrator.

Execute a tarefa test , usando uipcli test. Você pode ver uma lista das subtarefas disponíveis.

Especifique os parâmetros necessários e execute a subtarefa run .

Veja a lista de parâmetros abaixo.

Parâmetro	Description
`Orchestrator URL (pos. 0)` (necessário)	O URL da instância do Orchestrator.
`Orchestrator Tenant (pos. 1)` (Obrigatório) para implantações SaaP. (Opcional) para implantações de PaaS.	O locatário dentro do qual está o pacote ou conjunto de teste.
`-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.
`-t`, ou `--token`(Necessário se você usar a 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.
`-a`, ou `--accountName`(Necessário se você usar a 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.
`-A`, `--accountForApp`	O nome da conta CloudRPA do Orchestrator. 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 por 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 por aplicativo externo)	O Segredo do aplicativo externo. Você deve combiná-lo com a Conta do aplicativo, ID do aplicativo e Escopo de 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
`-P`ou `--project-path`	O caminho para o arquivo do pacote Testing que você deseja testar.
`-s`ou `--testset`	O nome mostrado para o Conjunto de teste que você deseja executar. Certifique-se de que o Conjunto de teste inclua a versão mais recente dos Casos de teste. Se o Conjunto de teste não estiver na pasta padrão, certifique-se de incluir o nome da pasta relevante antes dele. Por exemplo, use `AccountingTeam\TestSet`.
`--out`	O tipo do arquivo que retorna os resultados.
`-r`ou `--result_path`	O caminho de destino do arquivo onde você deseja armazenar os resultados.
`-e`ou `--environment` (obrigatório para pastas clássicas)	O ambiente onde você deseja implantar o pacote. Você deve emparelhá-lo com o `project path`.
`-w`ou `--timeout`	O tempo (em segundos) que você deseja aguardar a execução do conjunto de testes. O valor padrão é 7200 segundos.
`-i`ou `--input_path` (obrigatório se o fluxo de trabalho do ponto de entrada tiver parâmetros de entrada que você deseja passar pela linha de comando)	O caminho completo para um arquivo de entrada JSON.
`--attachRobotLogs`	Anexa logs do robô para cada caso de teste executado e um relatório de teste JUnit.
`-o`ou `--organizationUnit`	A pasta do Orchestrator onde você deseja executar os conjuntos de teste.
`-l`ou `--language`	O idioma usado na interface do usuário do Orchestrator.
`-y`ou `--disableTelemetry`	Desabilitar dados de telemetria.
`--traceLevel`	Exibir o rastreamento dos eventos.
`--identityURL` (exigido apenas para implantações de PaaS)	A URL do seu servidor de identidade.
`--help`	Exibe os parâmetros e exemplos para este comando.

Exemplos:

test run "https://uipath-orchestrator.myorg.com" default -A myAccountForExternalApp -I myExternalAppId -S myExternalAppSecret --applicationScope "OR.Folders.Read OR.Settings.Read" -s "MyRobotTests".
test run "https://uipath-orchestrator.myorg.com" default -t a7da29a2c93a717110a82 -a myAccount -P "C:\UiPath\Project\project.json" -e TestingEnv -r "C:\results.json" --out uipath -l en-US.
test run "https://uipath-orchestrator.myorg.com" default -t a7da29a2c93a717110a82 -a myAccount -P "C:\UiPath\Project\project.json" -e TestingEnv -r "C:\results.json" -i "C:\UiPath\Project\input-params.json" --out uipath -l en-US --attachRobotLogs "true".

Nesta página