cicd-integrations
2023.10
false
- Visão geral
- UiPath CLI
- Sobre o UiPath CLI
- Baixando o UiPath CLI
- Matriz de compatibilidade
- Executando o UiPath CLI
- Gerenciando feeds do NuGet
- Sobre tarefas do UiPath CLI
- Exclusão de ativos do Orchestrator
- Implantação de ativos no Orchestrator
- Executando um trabalho dentro do Orchestrator
- Análise de um projeto
- Implantação de um pacote no Orchestrator
- Empacotando projetos em um pacote
- Teste de um pacote ou execução de um conjunto de testes
- Testando um pacote ou executando um conjunto de testes no Test Manager
- Formato JSON dos parâmetros de entrada
- Extensão do Azure DevOps
- Plug-in do Jenkins
Importante :
A tradução automática foi aplicada parcialmente neste conteúdo.
A localização de um conteúdo recém-publicado pode levar de 1 a 2 semanas para ficar disponível.
Guia do usuário de integrações de CI/CD
Pré-requisitos
- 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.
Para executar um trabalho dentro do Orchestrator, siga as seguintes etapas:
- Execute a tarefa
job, usandouipcli job. Agora você pode ver uma lista das subtarefas disponível - Especifique os parâmetros necessários e execute a subtarefa
run. Consulte a lista de parâmetros abaixo.
| Parâmetro | Description |
|---|---|
-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. Consulte Formato JSON dos Parâmetros de Entrada para obter detalhes sobre a estrutura do arquivo. |
-P , or --priority | A prioridade com a qual você deseja executar o trabalho:- Baixa.- Normal (padrão).- Alto. |
-r , or --robots | Uma lista de nomes de robôs específicos, separados por vírgulas. |
-j , or --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 , or --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 , or --machine | O nome da máquina na qual você deseja executar o processo. |
-R , or --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 , or --timeout | O tempo limite para execuções de trabalho (segundos). O padrão é 1800 segundos. |
-f , or --fail_when_job_fails | O comando falha quando um trabalho falha. O padrão para isso é True . |
-w , or --wait | O comando aguarda a conclusão do trabalho. O padrão para isso é True . |
-b ou --job_type (apenas para pastas modernas) | O tipo de runtime do trabalho. O valor padrão é Valores suportados para esse comando: |
-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 ( obrigatório se você usar autenticação baseada em token ) | O token de atualização do OAuth2 usado para autenticação ao Orchestrator. Você deve combiná-lo com o Nome da conta e ID do cliente . |
-a ou --accountName ( obrigatório se você usar autenticação baseada em token ) | O nome da conta CloudRPA do Orchestrator. Você deve combiná-lo com o token de atualização do OAuth2 e o ID do cliente . |
-A , or --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. |
-I ou --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. |
-S ou --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 autenticação de 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 , or --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. |
|
| Exibir o rastreamento dos eventos. |
--identityUrl ( Necessário para implantações PaaS ou MSI ) | A URL do seu servidor de identidade. |
|
| Exibe os parâmetros e exemplos para este comando. |
|
| Exibe informações da versão. |
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)
| O tenant da Instância do Orchestrator, onde você deseja executar processos. |
Uso
job run <process_name> <orchestrator_url> <orchestrator_tenant> [-i <input_path>] [-j <jobscount>] [-R <result_path>] [-P <priority>] [-r <robots>] [-f <do_not_fail_when_job_fails>] [-W <timeout>] [-w <do_not_wait>] [-u <orchestrator_user> -p <orchestrator_pass>] [-t <auth_token> -a <account_name>] [-A <account_for_app> -I <application_id> -S <application_secret> --applicationScope] [-o <folder_organization_unit>] [-l <language>] [-b <RuntimeType>]
job run <process_name> <orchestrator_url> <orchestrator_tenant> [-i <input_path>] [-j <jobscount>] [-R <result_path>] [-P <priority>] [-r <robots>] [-f <do_not_fail_when_job_fails>] [-W <timeout>] [-w <do_not_wait>] [-u <orchestrator_user> -p <orchestrator_pass>] [-t <auth_token> -a <account_name>] [-A <account_for_app> -I <application_id> -S <application_secret> --applicationScope] [-o <folder_organization_unit>] [-l <language>] [-b <RuntimeType>]
Exemplos
job run ProcessName "https://uipath-orchestrator.myorg.com" default -u admin -p 123456job run ProcessName "https://uipath-orchestrator.myorg.com" default -u admin -p 123456 -P Lowjob run ProcessName "https://uipath-orchestrator.myorg.com" default -u admin -p 123456 -P Normal -o MyFolderjob run ProcessName "https://uipath-orchestrator.myorg.com" default -u admin -p 123456 -P High -o MyFolderjob run ProcessName "https://uipath-orchestrator.myorg.com" default -t a7da29a2c93a717110a82 -a myAccount -f false -W 0job run ProcessName "https://uipath-orchestrator.myorg.com" default -t a7da29a2c93a717110a82 -a myAccount -P High -j 3 -w falsejob run ProcessName "https://uipath-orchestrator.myorg.com" default -t a7da29a2c93a717110a82 -a myAccount -P Low -r robotName -R C:\Tempjob run ProcessName "https://uipath-orchestrator.myorg.com" default -t a7da29a2c93a717110a82 -a myAccount -r robotName -R C:\Temp\status.jsonjob run ProcessName "https://uipath-orchestrator.myorg.com" default -A accountForExternalApp -I myExternalAppId -S myExternalAppSecret --applicationScope "OR.Folders.Read OR.Settings.Read" -r robotName -R C:\Temp\status.json