- Introdução
- Studio
- Orchestrator
- Testing Robots
- Test Manager
- Integrações CI/CD
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.
The action could not be performed because the project is already opened in another Studio instance. Please close it and try again.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. |
Além dos escopos listados na tabela, um escopo importante a ser destacado é o OR.Default. O escopo OR.Default funciona como um curinga. Ele oferece acesso refinado e específico por função, nos níveis da organização e da pasta. Isso oferece a flexibilidade de ter controle preciso sobre permissões de aplicativos, além dos escopos predefinidos para toda a organização. Para obter mais detalhes, consulte Declaração de escopos.
Pré-requisitos: Para usar o UiPath CLI for 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.
uipcli.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.exee selecione a tecla Enter .
Pré-requisitos: Para usar o UiPath CLI para plataforma cruzada e executar tarefas de trabalho, instale o .NET 6.0.7, que vem com o SDK 6.0.302.
uipcli.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.
- Digite
dotnet uipcli.dlle selecione a chave Enter.
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,typeevalue. As células de dados nas colunastypeevaluepodem permanecer vazias. - Execute o arquivo CLI
exe(para Windows) oudll(para Linux). - Adicione os escopos de aplicativos de acesso à API do Orchestrator necessários.
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 |
|
|
asset3_name |
Número inteiro | N/A |
|
asset4_name |
Credencial |
username:password |
Para excluir ativos do Orchestrator:
Exemplos:
exclusão de ativo assets_file.csv "https://uipath-orchestrator.myorg.com" padrão -u admin -p 123456 -l en-USasset delete assets_file.csv "https://uipath-orchestrator.myorg.com" default -u admin -p 123456 -o OurOrganizationexclusão de ativo assets_file.csv "https://uipath-orchestrator.myorg.com" padrão -t a7da29a2c93a717110a82 -a minha contaexclusão de ativo assets_file.csv "https://uipath-orchestrator.myorg.com" default -A accountForExternalApp -I myExternalAppId -S myExternalAppSecret --applicationScope "OR.Folders.Read OR.Settings.Read"
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,valueedescription. - Execute o arquivo CLI
exe(para Windows) oudll(para Linux). - Adicione os escopos de aplicativos de acesso à API do Orchestrator necessários.
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 |
|
asset_2_description |
|
asset_3_name |
Bool |
|
asset_3_description |
|
asset_4_name |
Credencial |
username:password |
asset_4_description |
Para implantar ativos no Orchestrator:
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".
- Criar um processo no Orchestrator.
- Execute o arquivo CLI
exe(para Windows) oudll(para Linux). - Adicione os escopos de aplicativos de acesso à API do Orchestrator necessários.
execução da tarefa ProcessName "https://uipath-orchestrator.myorg.com" padrão -u admin -p 123456 -P Alto -o MinhaPastaexecução da tarefa ProcessName "https://uipath-orchestrator.myorg.com" padrão -t a7da29a2c93a717110a82 -a minhaConta -P Alto -j 3 -w falsoexecução da tarefa ProcessName "https://uipath-orchestrator.myorg.com" default -t a7da29a2c93a717110a82 -a myAccount -r robotName -RC:\Temp\status.json
Pré-requisitos:
- Criar um projeto
- Execute o arquivo CLI
exe(para Windows) oudll(para Linux). - Adicione os escopos de aplicativos de acesso à API do Orchestrator necessários.
A validação do projeto não é executada pelas tarefas Pacote ou Analisar do UiPath CLI.
|
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 .
|
|
|
Escolha quais tipos de mensagens enviar após a análise:
|
|
|
O trabalho falha quando alguma regra é violada. |
|
|
Trate os avisos como erros. |
|
|
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. |
|
|
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 do Orchestrator CloudRPA (nome da organização). 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 do 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. |
|
|
Exibe os parâmetros e exemplos para este comando. |
Exemplos:
análise de pacote "C:\UiPath\Project\project.json" --analyzerTraceLevel "Error" --stopOnRuleViolation --treatWarningsAsErrors --resultPath "C:\UiPath\Project\output.json"análise de pacote "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"análise de pacote "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"
Pré-requisitos:
- Publique um pacote no Orchestrator.
- Execute o arquivo CLI
exe(para Windows) oudll(para Linux). - Adicione os escopos de aplicativos de acesso à API do Orchestrator necessários.
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".
Pré-requisitos:
- Crie um pacote.
- Execute o arquivo CLI
exe(para Windows) oudll(para Linux). - Adicione os escopos de aplicativos de acesso à API do Orchestrator necessários.
uipclicria um processo com um ponto de defaultentrada se você não especificar um. Se o ponto de entrada for especificado, um processo com esse ponto de entrada será criado e _{entryPoint}será anexado ao nome do processo. Além disso, todos os processos associados a ele package.Idsão atualizados para a versão mais recente, independentemente de o processo ter sido criado manualmente ou a partir de um pipeline.
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.
Pré-requisitos:
- Criar projetos.
- Execute o arquivo CLI
exe(para Windows) oudll(para Linux). - Adicione os escopos de aplicativos de acesso à API do Orchestrator necessários.
A validação do projeto não é executada pelas tarefas Pacote ou Analisar do UiPath CLI.
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 ou --output (Necessário)
|
A pasta do Orchestrator de destino, onde você deseja empacotar os projetos. |
-vou --version |
Defina a versão do pacote. |
|
|
Gera automaticamente uma versão do pacote. |
|
|
Força a saída a ser de um tipo específico. |
|
|
Adicione notas da versão. |
--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 do Orchestrator CloudRPA (nome da organização). 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 faz referência a bibliotecas do feed do Orchestrator. |
--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 faz referência a bibliotecas do feed do Orchestrator. |
--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 do aplicativo. Isso é necessário se o seu pacote faz referência a bibliotecas do feed do Orchestrator. |
--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 faz referência a bibliotecas do feed do Orchestrator. |
--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. |
-you --disableTelemetry |
Desabilitar dados de telemetria. |
|
|
Exibir o rastreamento dos eventos. |
-lou --language |
O idioma usado na interface do usuário do Orchestrator. |
|
|
Desabilite os feeds de nuget integrados. |
|
|
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.
Pré-requisitos:
- Crie um pacote ou conjunto de testes.
- Execute o arquivo CLI
exe(para Windows) oudll(para Linux). - Adicione os escopos de aplicativos de acesso à API do Orchestrator necessários.
Exemplos:
-
test run "https://orch-23-10-paas.cloudapp.azure.com/" "TenantName" -u "orchestratorUsername" -p "********" -o "FolderName" --traceLevel Information -P "C:\userprofile\AutomationProjectWithTestCases\project.json" -
test run "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 -P "C:\userprofile\AutomationProjectWithTestCases\project.json" -
test run "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 -P "C:\userprofile\AutomationProjectWithTestCases\project.json" -
test run "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 -P "C:\userprofile\AutomationProjectWithTestCases\project.json -
test run "https://orch-23-10-paas.cloudapp.azure.com/" "TenantName" -u "orchestratorUsername" -p "********" -o "FolderName" --traceLevel Information -P "C:\userprofile\AutomationProjectWithTestCases\project.json" --out junit -
test run "https://orch-23-10-paas.cloudapp.azure.com/" "TenantName" -u "orchestratorUsername" -p "********" -o "FolderName" --traceLevel Information -P "C:\userprofile\AutomationProjectWithTestCases\project.json" --out uipath
- Escopos de aplicativos de acesso à API
- Running UiPath.CLI.Windows
- Executando UiPath.CLI
- Exibindo a versão CLI
- Excluindo ativos do orquestrador
- Implantação de ativos no Orchestrator
- Executando um trabalho dentro do Orchestrator
- Analisando um Projeto
- Exclusão de um pacote
- Implantação de um pacote no Orchestrator
- Empacotando projetos em um pacote
- Testando um pacote/Executando um conjunto de teste
