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.

Importante:

Ao usar o UiPath CLI, você deve garantir que o projeto seja fechado no Studio. Caso contrário, causa um conflito que leva à seguinte mensagem de erro no CLI: The action could not be performed because the project is already opened in another Studio instance. Please close it and try again.

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.

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.

Adição de um aplicativo externo

Para registrar um aplicativo externo, de forma que ele possa usar o OAuth para acessar seus recursos da UiPath:

1. Acesse Admin e selecione a organização na parte superior do painel à esquerda.
2. Selecione Aplicativos externos.
3. Clique em Adicionar aplicativo na parte superior direita.
4. Preencha o campo Application Name
5. Selecione uma opção para o Tipo de aplicativo.

   Se você selecionar Aplicativo confidencial, receberá um segredo do aplicativo no final, portanto, certifique-se de que seu aplicativo pode armazená-lo com segurança. Se não for possível, selecione Aplicativo não confidencial.

6. Em Recursos, clique em Adicionar escopos.

   O painel Editar recurso será aberto à direita, no qual você pode selecionar os recursos que o aplicativo deve ter acesso.

7. Na lista suspensa Recurso, selecione a API do UiPath que o aplicativo pode usar.
   Nota: Você só pode adicionar escopo para um recurso por vez. Se você quiser permitir acesso a vários recursos, repita esse processo para adicionar escopo para cada recurso.
8. Na guia Escopo(s) do usuário, marque as caixas de seleção para as permissões de API lógica que você deseja conceder, conforme necessário.

   A concessão de permissões no escopo do usuário significa que o aplicativo externo pode acessar esses recursos dentro de um contexto de usuário e um usuário com as permissões adequadas deve estar logado.

9. Se esse for um aplicativo confidencial, você pode alternar para a guia Escopo(s) do aplicativo para também conceder permissões de nível de aplicativos para o recurso selecionado, conforme necessário.

   Com permissões sob o escopo do aplicativo, o aplicativo externo tem acesso aos dados de nível de aplicativo dos escopos selecionados sem a necessidade de interação do usuário.

   Os aplicativos não confidenciais não podem acessar o escopo do aplicativo.

10. Clique em Salvar.

    O painel será fechado e o recurso e os escopos selecionados serão adicionados à tabela Recursos no formulário.

11. Se o aplicativo externo tiver sido registrado com os escopos do usuário, você deve adicionar uma URL de redirecionamento onde o aplicativo externo deve receber a resposta de autorização.

    Se apenas os escopos de aplicativos forem selecionados, fornecer uma URL de redirecionamento é opcional.

12. Clique em Adicionar para criar o registro.

    Uma mensagem de confirmação será aberta. Para aplicativos confidenciais, a mensagem de confirmação inclui o segredo do aplicativo que o aplicativo externo registrado pode usar para solicitar autorização. Certifique-se de salvá-lo em um local seguro porque não poderá exibi-lo novamente.

Running UiPath.CLI.Windows

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.

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:

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

Executando UiPath.CLI

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.

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:

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

Exibindo a versão CLI

Execute o comando uipcli --version.

Deleting assets from Orchestrator

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 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	true
asset3_name	Número inteiro	N/A
asset4_name	Credencial	username:password

Para excluir ativos do Orchestrator, siga as seguintes etapas:

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

   Veja a lista de parâmetros abaixo.

   Parâmetro	Description
   -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.
   -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 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.
   -Iou --applicationId (obrigatório se você usar autenticação de aplicativo externo)	A ID do aplicativo externo. Você deve combiná-lo com a Conta do aplicativo, Segredo do aplicativo e Escopo do aplicativo.
   -Sou --applicationSecret (obrigatório se você usar autenticação de 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.
   -lou --language	O idioma usado na interface do usuário do Orchestrator.
   -you --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.
   --version	Exibe informações da versão.
   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.

Uso:

uipcli asset delete <assets_file> <orchestrator_url> <orchestrator_tenant> [-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>] [--traceLevel <None|Critical|Error|Warning|Information|Verbose>] [--identityUrl <identity_url>]

Exemplos mínimos de comando:

• Excluir ativo do uipcli “C:\userprofile\assets.csv” “https://orch-23-10-paas.cloudapp.azure.com/” "TenantName" -u "orchestratorUsername" -p "********" -o "FolderName" --traceLevel "Information"
• Excluir ativo do uipcli “C:\userprofile\assets.csv” “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"
• Excluir ativo do uipcli “C:\userprofile\assets.csv” "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"
• Excluir ativo do uipcli “C:\userprofile\assets.csv” "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"

Deploying assets to 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 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	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 as seguintes etapas:

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

   Veja a lista de parâmetros abaixo.

   Parâmetro	Description
   -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 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.
   -Iou --applicationId (obrigatório se você usar autenticação de aplicativo externo)	A ID do aplicativo externo. Você deve combiná-lo com a Conta do aplicativo, Segredo do aplicativo e Escopo do aplicativo.
   -Sou --applicationSecret (obrigatório se você usar autenticação de 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.
   -lou --language	O idioma usado na interface do usuário do Orchestrator.
   --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.
   --version	Exibe informações da versão.
   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.

Uso:

uipcli asset deploy <assets_file> <orchestrator_url> <orchestrator_tenant> [-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>] [--traceLevel <None|Critical|Error|Warning|Information|Verbose>] [--identityUrl <identity_url>]

Exemplos mínimos de comandos:

• Implantação de ativo do uipcli “C:\userprofile\assets.csv” “https://orch-23-10-paas.cloudapp.azure.com/” "TenantName" -u "orchestratorUsername" -p "********" -o "FolderName" --traceLevel "Information"
• Implantação de ativo do uipcli “C:\userprofile\assets.csv” “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"
• Implantação de ativo do uipcli “C:\userprofile\assets.csv” "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
• Implantação de ativo do uipcli “C:\userprofile\assets.csv” "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"

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 você pode ver uma lista das subtarefas disponível
2. Especifique os parâmetros necessários e execute a subtarefa run .
   Veja a lista de parâmetros abaixo.

   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"

Analyzing a project

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 necessários.

Para analisar um projeto, siga as seguintes etapas:

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

   Veja a lista de parâmetros abaixo.

Observação:

A validação do projeto não é executada pelas tarefas Pacote ou Analisar do UiPath CLI.

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

Parâmetro	Description
--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.
--governanceFilePath	Aprovar políticas de governança que contenham as regras do Analisador de Fluxo de Trabalho. As políticas podem ser baixadas da Governança do Automation Ops ou extraídas do arquivo zip compactado exportado do Studio. Observação: A tarefa falha se você especificar o uso de uma política, mas o arquivo da política não estiver no caminho mencionado.
--ignoredRules	Uma lista de regras que você deseja ignorar durante a análise, separadas por vírgulas.
-u, --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.
-p, --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.
-t, -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.
-a, --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.
-A, --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.
-I, --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.
-S, --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.
-l, --language	A linguagem do Orchestrator.
--traceLevel	Exibir o rastreamento dos eventos.
-identityUrl (Necessário apenas para implantações do PaaS)	A URL do seu servidor de identidade.
--disableBuiltInNugetFeeds	Desabilitar feeds integrados do NuGet.
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 .

Uso:

uipcli package analyze <project_path> [--analyzerTraceLevel <analyzer_trace_level>] [--stopOnRuleViolation] [--treatWarningsAsErrors] [--resultPath <result_path>] [--governanceFilePath <governance_file_path>] [--ignoredRules <rule_id_1,rule_id_2>] [--orchestratorUrl <orchestrator_url> --orchestratorTenant <orchestrator_tenant>] [-u <orchestrator_user> -p <orchestrator_pass>] [-t <auth_token> -a <account_name>] [-A <organization_name> -I <application_id> -S <application_secret> --orchestratorApplicationScope <application_scope>] [--orchestratorFolder <folder_name>] [-l <language>] [--traceLevel <None|Critical|Error|Warning|Information|Verbose>] [--identityUrl <identityUrl>] [--disableBuiltInNugetFeeds]

Exemplos mínimos de comandos:

• uipcli package analyze "C:\userprofile\AutomationProject\project.json" --traceLevel Information --resultPath "C:\userprofile\result.json"

• uipcli package analyze "C:\userprofile\AutomationProject\project.json" --traceLevel Information --resultPath "C:\userprofile\result.json" --orchestratorUrl "https://orch-23-10-paas.cloudapp.azure.com/" --orchestratorTenant "TenantName" -u "orchestratorUsername" -p "********" --orchestratorFolder "FolderName"

• uipcli package analyze "C:\userprofile\AutomationProject\project.json" --traceLevel Information --resultPath "C:\userprofile\result.json" --orchestratorUrl "https://orch-23-10-paas.cloudapp.azure.com/" --orchestratorTenant "TenantName" -A "organizationName" -I "76000552-3e4f-4590-9317-cdb420001f1d" -S "********" --orchestratorApplicationScope "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" --orchestratorFolder "FolderName" --identityUrl "https://orch-23-10-paas.cloudapp.azure.com/identity"

• uipcli package analyze "C:\userprofile\AutomationProject\project.json" --traceLevel Information --resultPath "C:\userprofile\result.json" --orchestratorUrl "https://automation-suite.base.url.com/" --orchestratorTenant "TenantName" -A "organizationName" -I "3f6239b9-e0e8-465e-a429-d9ffd1d9e57a" -S "********" --orchestratorApplicationScope "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" --orchestratorFolder "FolderName"

• uipcli package analyze "C:\userprofile\AutomationProject\project.json" --traceLevel Information --resultPath "C:\userprofile\result.json" --orchestratorUrl "https://cloud.uipath.com/" --orchestratorTenant "TenantName" -A "organizationName" -I "becc663c-8f1e-409a-a75f-c00330d80bc8" -S "********" --orchestratorApplicationScope "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" --orchestratorFolder "FolderName"

Deploying a package to 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 necessários.

Para implantar um pacote no Orchestrator, execute as seguintes etapas:

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

   Veja a lista de parâmetros abaixo.

   Parâmetro	Description
   -cou --createProcess	O valor padrão é true. Quando definido como true, ele cria um processo na pasta do Orchestrator que é passado no comando. Quando definido como false, ele não cria um processo na pasta do Orchestrator. Por exemplo, --createProcess false.
   --processNames	Opcionalmente, forneça um arquivo .csv com nomes personalizados para os processos a serem criados/atualizados. A seguir está um exemplo de como o arquivo .csv a estrutura deve se parecer. Os nomes das colunas/cabeçalhos: NomeDoPacote, NomeDoPontoDeEntrada e NomeDoProcesso são necessários! PackageName EntryPointName ProcessName MeuPacote Main.xaml Meu processo Ainda Outro Pacote CustomEntryPoint.xaml Ainda Outro Processo
   --processName	Opcionalmente, forneça um nome personalizado para o processo ser atualizado/criado.
   --ignoreLibraryDeployConflict	Ignore o conflito ao implantar um pacote de biblioteca com a mesma versão de um existente. Por padrão, a implantação falhará se uma biblioteca com a mesma versão já existir na instância do Orchestrator.
   -eou --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.
   -hou --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.
   -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
   -Iou --applicationId (obrigatório se você usar autenticação de aplicativo externo)	A ID do aplicativo externo. Você deve combiná-lo com a Conta do aplicativo, Segredo do aplicativo e Escopo do aplicativo.
   -Sou --applicationSecret (obrigatório se você usar autenticação de 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.
   -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.
   -lou --language	O idioma usado na interface do usuário do Orchestrator.
   -you --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.
   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 de PaaS.	O locatário da instância do Orchestrator em que você deseja excluir uma máquina.

O 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.

Uso:

uipcli package deploy <packages_path> <orchestrator_url> <orchestrator_tenant> [-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>] [-c <false|true>] [-e <environment_list>] [-l <language>] [--ignoreLibraryDeployConflict] [--entryPointsPath <entry_points_path_list>]  [--traceLevel <None|Critical|Error|Warning|Information|Verbose>] [--identityUrl <identityUrl>]

Exemplos mínimos de comando:

• uipcli package deploy "C:\userprofile\AutomationPackages" "https://orch-23-10-paas.cloudapp.azure.com/" "TenantName" -u "orchestratorUsername" -p "********" -o "FolderName" --traceLevel Information --entryPointsPath "Main.xaml"

• uipcli package deploy "C:\userprofile\AutomationPackage.1.0.171447983.nupkg" "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 --entryPointsPath "Main.xaml"n

• uipcli package deploy "C:\userprofile\AutomationPackage.1.0.171447983.nupkg" "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 --entryPointsPath "Main.xaml"

• uipcli package deploy "C:\userprofile\AutomationPackage.1.0.171447983.nupkg" "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 --processNames "C:\userprofile\processNames.csv"

• uipcli package deploy "C:\userprofile\AutomationPackage.1.0.171447983.nupkg" "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 --entryPointsPath "Main.xaml" --processName "MyProcessName"

Packing projects into a package

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 necessários.

Para empacotar um projeto em um pacote, siga as seguintes etapas:

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

   Veja a lista de parâmetros abaixo.

Observação:

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
-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.
--autoVersion	Gera automaticamente uma versão do pacote.
--outputType	Força a saída a ser de um tipo específico.
--splitOutput	Habilita a saída dividida para runtime e bibliotecas de design.
--repositoryUrl	A URL do repositório onde o projeto é versionado.
--repositoryCommit	A confirmação do repositório de onde o projeto foi criado.
--repositoryBranch	A ramificação do repositório de onde o projeto foi criado.
--repositoryType	Tipo de repositório do sistema VCS.
--projectUrl	URL da ideia do Automation Hub.
--releaseNotes	Adicione notas da versão.
-u, --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
-p, --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
-t, --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
-a, --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
-A, --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.
-I ,--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.
-S, --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.
--libraryIdentityUrl(Necessário apenas para implantações do PaaS )	A URL do seu servidor de identidade.
--traceLevel	Exibir o rastreamento dos eventos.
-lou --language	O idioma usado na interface do usuário do Orchestrator.
--disableBuiltInNugetFeeds	Desabilite os feeds de nuget integrados.
Project(s) Path (pos. 0) (Necessário)	O caminho para um arquivo project.json ou para uma pasta que contém project.json arquivos.

Uso:

uipcli package pack <project_path> -o <destination_folder> [-v <version>] [--autoVersion] [--outputType <Process|Library|Tests|Objects>] [--libraryOrchestratorUrl <orchestrator_url> --libraryOrchestratorTenant <orchestrator_tenant>] [--u <orchestrator_user> --p <orchestrator_pass>] [--t <auth_token> --a <account_name>] [-A <organization_name> -I <application_id> -S <application_secret> --libraryOrchestratorApplicationScope <application_scope>] [--libraryIdentityUrl <identity_url>] [--libraryOrchestratorFolder <folder_name>] [-l <language>] [--splitOutput] [--repositoryUrl <repository_url>] [--repositoryCommit <repository_commit>] [--repositoryBranch <repository_branch>] [--repositoryType <repository_type>] [--projectUrl <automation_hub_idea_url>] [--releaseNotes <release_notes>] [--disableBuiltInNugetFeeds]  [--traceLevel <None|Critical|Error|Warning|Information|Verbose>]

Exemplos:

• uipcli package pack "C:\userprofile\AutomationProject\project.json" --traceLevel Information -o "C:\userprofile\Packages\Output"

• uipcli package pack "C:\userprofile\AutomationProject\project.json" --traceLevel Information -o "C:\userprofile\Packages\Output" --libraryOrchestratorUrl "https://orch-23-10-paas.cloudapp.azure.com/" --libraryOrchestratorTenant "TenantName" -u "orchestratorUsername" -p "********" --orchestratorFolder "FolderName"

• uipcli package pack "C:\userprofile\AutomationProject\project.json" --traceLevel Information -o "C:\userprofile\Packages\Output" --libraryOrchestratorUrl "https://orch-23-10-paas.cloudapp.azure.com/" --libraryOrchestratorTenant "TenantName" -A "organizationName" -I "76000552-3e4f-4590-9317-cdb420001f1d" -S "********" --libraryOrchestratorApplicationScope "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" --libraryOrchestratorFolder "FolderName" --libraryIdentityUrl "https://orch-23-10-paas.cloudapp.azure.com/identity"

• uipcli package pack "C:\userprofile\AutomationProject\project.json" --traceLevel Information -o "C:\userprofile\Packages\Output" --libraryOrchestratorUrl "https://automation-suite.base.url.com/" --libraryOrchestratorTenant "TenantName" -A "organizationName" -I "3f6239b9-e0e8-465e-a429-d9ffd1d9e57a" -S "********" --libraryOrchestratorApplicationScope "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" --libraryOrchestratorFolder "FolderName"

• uipcli package pack "C:\userprofile\AutomationProject\project.json" --traceLevel Information -o "C:\userprofile\Packages\Output" --libraryOrchestratorUrl "https://cloud.uipath.com/" --libraryOrchestratorTenant "TenantName" -A "organizationName" -I "becc663c-8f1e-409a-a75f-c00330d80bc8" -S "********" --libraryOrchestratorApplicationScope "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" --libraryOrchestratorFolder "FolderName"

Restaurando dependências de automação

Pré-requisitos:

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

Para restaurar as dependências, siga as seguintes etapas:

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

   Veja a lista de parâmetros abaixo.

   Parâmetro	Description
   --restoreFolder	Obrigatório. Restaure o caminho da pasta de destino.
   --nugetConfigFilePath	Opcional. Caminho para o arquivo NuGet.Config que contém os feeds.
   -u, --libraryOrchestratorUsername	Opcional, útil apenas quando você tem dependências de uma biblioteca no Orchestrator. O nome de usuário do Orchestrator usado para autenticação. Deve ser usado com a senha.
   -p, --libraryOrchestratorPassword	Opcional, útil apenas quando você tem dependências de uma biblioteca no Orchestrator. A senha do Orchestrator usada para a autenticação. Deve ser usado com o nome de usuário.
   -t, --libraryOrchestratorAuthToken	Opcional, útil apenas quando você tem dependências de uma biblioteca no Orchestrator. O token de atualização do Orchestrator usado para a autenticação. Deve ser usado com o nome da organização e o ID do cliente.
   -a, --libraryOrchestratorAccountName	Opcional, útil apenas quando você tem dependências de uma biblioteca no Orchestrator. O nome da organização do Orchestrator. Deve ser usado com o token de atualização e o ID do cliente.
   -A, --libraryOrchestratorAccountForApp	Opcional, útil apenas quando você tem dependências de uma biblioteca no Orchestrator. O nome da organização do Orchestrator. Deve ser usado com id, segredo e escopo(s) para aplicativo externo.
   -I, --libraryOrchestratorApplicationId	Opcional, útil apenas quando você tem dependências de uma biblioteca no Orchestrator. O ID do aplicativo externo. Deve ser usado com o nome da organização, o segredo e o(s) escopo(s) para o aplicativo externo.
   -S, --libraryOrchestratorApplicationSecret	Opcional, útil apenas quando você tem dependências de uma biblioteca no Orchestrator. O segredo do aplicativo externo. Deve ser usado com o nome, id e escopo(s) da organização para o aplicativo externo.
   --libraryOrchestratorApplicationScope	Opcional, útil apenas quando você tem dependências de uma biblioteca no Orchestrator. A lista separada por espaços de escopos do aplicativo. Deve ser usado com o nome, ID e segredo da organização para um aplicativo externo.
   --libraryOrchestratorUrl	Opcional, útil apenas quando você tem dependências de uma biblioteca no Orchestrator. A URL do Orchestrator.
   --libraryOrchestratorTenant	Opcional, útil apenas quando você tem dependências de uma biblioteca no Orchestrator. O tenant do Orchestrator.
   --libraryIdentityUrl	URL do seu Identity Server. Isso é necessário apenas para implantações do PaaS.
   --traceLevel	Especifica quais tipos de mensagens de log darão origem a um dos seguintes valores: Nenhum, Crítico, Erro, Aviso, Informações, Detalhado. Valor padrão: informações.
   -l, --language	Idioma dos logs traduzidos.
   --disableBuiltInNugetFeeds	Desabilite os feeds de nuget integrados.
   Project(s) Path (pos. 0)	Obrigatório. O caminho para um arquivo project.json ou uma pasta que contém arquivos project.json .

Uso:

uipcli package restore <project_path> --restoreFolder <restore_directory> --nugetConfigFilePath <nuget_config_path> [--libraryOrchestratorUrl <orchestrator_url> --libraryOrchestratorTenant <orchestrator_tenant>] [--u <orchestrator_user> --p <orchestrator_pass>] [--t <auth_token> --a <account_name>] [-A <organization_name> -I <application_id> -S <application_secret> --libraryOrchestratorApplicationScope <application_scope>] [--libraryIdentityUrl <identity_url>] [--libraryOrchestratorFolder <folder_name>] [-l <language>] [--disableBuiltInNugetFeeds] [--traceLevel <None|Critical|Error|Warning|Information|Verbose>]

Exemplos mínimos de comando:

• uipcli package restore "C:\userprofile\AutomationProject" --traceLevel Information --restoreFolder ""C:\userprofile\DependencyPackages" --nugetConfigFilePath "C:\userprofile\Package\NuGet.Config"

• uipcli package restore "C:\userprofile\AutomationProject" --traceLevel Information --restoreFolder "C:\userprofile\DependencyPackages" --libraryOrchestratorUrl "https://orch-23-10-paas.cloudapp.azure.com/" --libraryOrchestratorTenant "TenantName" -u "orchestratorUsername" -p "********" --orchestratorFolder "FolderName"

• uipcli package restore "C:\userprofile\AutomationProject" --traceLevel Information --restoreFolder "C:\userprofile\DependencyPackages" --libraryOrchestratorUrl "https://orch-23-10-paas.cloudapp.azure.com/" --libraryOrchestratorTenant "TenantName" -A "organizationName" -I "76000552-3e4f-4590-9317-cdb420001f1d" -S "********" --libraryOrchestratorApplicationScope "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" --libraryOrchestratorFolder "FolderName" --libraryIdentityUrl "https://orch-23-10-paas.cloudapp.azure.com/identity"

• uipcli package restore "C:\userprofile\AutomationProject" --traceLevel Information --restoreFolder "C:\userprofile\DependencyPackages" --libraryOrchestratorUrl "https://automation-suite.base.url.com/" --libraryOrchestratorTenant "TenantName" -A "organizationName" -I "3f6239b9-e0e8-465e-a429-d9ffd1d9e57a" -S "********" --libraryOrchestratorApplicationScope "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" --libraryOrchestratorFolder "FolderName"

• uipcli package restore "C:\userprofile\AutomationProject" --traceLevel Information --restoreFolder "C:\userprofile\DependencyPackages" --libraryOrchestratorUrl "https://cloud.uipath.com/" --libraryOrchestratorTenant "TenantName" -A "organizationName" -I "becc663c-8f1e-409a-a75f-c00330d80bc8" -S "********" --libraryOrchestratorApplicationScope "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" --libraryOrchestratorFolder "FolderName"

Teste de um pacote ou execução de um conjunto de testes

Pré-requisitos:

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

Para testar um pacote, siga as seguintes etapas:

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

   Veja a lista de parâmetros abaixo.

   Parâmetro	Description
   -Pou --project-path	O caminho para o arquivo do pacote Testing que você deseja testar.
   -sou --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 de resultado <junit|uipath>.
   -rou --result_path	O caminho de destino do arquivo onde você deseja armazenar os resultados.
   -eou --environment (obrigatório para pastas clássicas)	O ambiente onde você deseja implantar o pacote. Você deve emparelhá-lo com o project path.
   -wou --timeout	O tempo (em segundos) que você deseja aguardar a execução do conjunto de testes. O valor padrão é 7200 segundos.
   -iou --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.
   --repositoryUrl	A URL do repositório onde o projeto é versionado.
   --repositoryCommit	A confirmação do repositório de onde o projeto foi criado.
   --repositoryBranch	A ramificação do repositório de onde o projeto foi criado.
   --repositoryType	Tipo de repositório do sistema VCS.
   --projectUrl	URL da ideia do Automation Hub.
   --releaseNotes	Adicione notas da versão.
   --disableBuiltInNugetFeeds	Desabilitar feeds integrados do NuGet.
   --retryCount	Número de novas tentativas para casos de teste com falha (por padrão, nenhuma nova tentativa é definida).
   -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.
   -A, --accountForApp	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.
   -Iou --applicationId (obrigatório se você usar autenticação de aplicativo externo)	A ID do aplicativo externo. Você deve combiná-lo com a Conta do aplicativo, Segredo do aplicativo e Escopo do aplicativo.
   -Sou --applicationSecret (obrigatório se você usar autenticação de 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	A pasta do Orchestrator onde você deseja executar os conjuntos de teste.
   -lou --language	O idioma usado na interface do usuário do Orchestrator.
   --traceLevel	Exibir o rastreamento dos eventos.
   --identityURL (exigido apenas para implantações de PaaS)	A URL do seu servidor de identidade.
   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.

Uso:

uipcli test run <orchestrator_url> <orchestrator_tenant> [-i <input_path>] [-P <project_json_path>] [-s <testset_name>] [-u <orchestrator_user> -p <orchestrator_pass>] [-t <auth_token> -a <account_name>] [-A <organization_name> -I <application_id> -S <application_secret> --applicationScope <application_scope>] [-e <environment>] [-o <folder_name>] [-l <language>] [--out <junit|uipath>] [--result_path <result_path>] [--timeout <seconds>] [--attachRobotLogs true] repositoryUrl <repository_url>] [--repositoryCommit <repository_commit>] [--repositoryBranch <repository_branch>] [--repositoryType <repository_type>] [--projectUrl <automation_hub_idea_url>] [--releaseNotes <release_notes>] [--disableBuiltInNugetFeeds] [--retryCount <number>]  [--traceLevel <None|Critical|Error|Warning|Information|Verbose>] [--identityUrl <identityUrl>]

Exemplos:

• uipcli test run "https://orch-23-10-paas.cloudapp.azure.com/" "TenantName" -u "orchestratorUsername" -p "********" -o "FolderName" --traceLevel Information -P "C:\userprofile\AutomationProjectWithTestCases\project.json" "C:\userprofile\AutomationProjectWithTestCases\project.json"

• uipcli 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"

• uipcli 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"

• uipcli 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"