Interface de Linha de Comando do Robô

A interface de linha de comando do UiPath Robô é uma ferramenta que permite interagir com o Robô a partir de um terminal de linha de comando. Ele usa o arquivo UiRobot.exe para iniciar, interromper ou monitorar automações attended e unattended diretamente da linha de comando. Você também pode obter detalhes sobre pacotes instalados, criar logs ou atualizar configurações.

Como funciona

Para usar a CLI, certifique-se dos seguintes aspectos:

• O Serviço de Robôs da UiPath está em execução
• Você está no diretório no qual o Robô está instalado.

Em seguida, digite instruções ou comandos que se referem ao programa UiRobot.exe junto com os parâmetros necessários, dependendo do que você deseja que sua automação realize.

Por exemplo, para iniciar um processo da linha de comando, você usaria o seguinte comando:

UiRobot.exe -file "C:\UiPath\Projects\YourProject\Main.xaml".

Comandos comuns do UiRobot.exe

Executar

Use esse comando para iniciar a execução de um arquivo de projeto dos seguintes tipos:

• JSON
• XAML
• NUPKG
  Observação:

  Com a versão 2023.4 do Robô, a UiPath atualiza a lista de processos ao mesmo tempo em que um processo é executado. Se uma atualização de processo estiver disponível no início do trabalho, o trabalho usará a versão mais antiga do processo. As execuções subsequentes aplicam o processo atualizado.

O comando execute usa os seguintes argumentos:

UiRobot.exe execute [--process <Package_ID> | --file <File_Path>] [--folder <Orchestrator_Folder_ID>] [--input <Input_Parameters>]

• -p--process <Package_ID> (obrigatório) - Inicia a execução de um processo local ou do Orchestrator. Exemplos:

  UiRobot.exe execute --process UiPathDemoProcess
  

  UiRobot.exe execute -p UiPathDemoProcess
  

• -f--file <File_Path> (obrigatório) - Inicia a execução de um arquivo de projeto local. O arquivo de destino pode ser JSON, XAML ou NUPKG. Exemplos:

  UiRobot.exe execute --file "C:\UiPath\Automation\Project.json"
  

  UiRobot.exe execute --file "C:\UiPath\Automation\Project.json"
  

  UiRobot.exe execute --file "C:\UiPath\Automation\Project.json"
  

• --folder <Orchestrator_Folder_ID> (opcional) - Permite que você especifique a pasta do Orchestrator a partir da qual instalar e executar o processo de destino. Pode ser usado apenas junto com o argumento --process. Exemplo:

  UiRobot.exe -Execute --process UiPathDemoProcess --folder OrchFolder1
  

• --input <Input_Parameters> (opcional) - Para especificar argumentos de entrada para execução. Pode ser usado com os argumentos --process ou --file . Exemplos:

  UiRobot.exe execute --process UiPathDemoProcess --input "{'inArg' : 'value' , 'Integer' : 3}"
  

  UiRobot.exe execute --process UiPathDemoProcess --folder OrchFolder1 --input "{'inArg' : 'value' , 'Integer' : 3}"
  

  UiRobot.exe execute --file "C:\UiPath\Automation\Main.xaml" --input "{'inArg' : 'value' , 'Integer' : 3}"
  

• --entry <entrypoint> (opcional) - Permite selecionar o entry point de um processo ao iniciá-lo por meio da linha de comando. Exemplo:

  UiRobot execute --file "C:\UiPath\Project\project.1.0.3.nupkg" --input "{'inArg':'value','integer':3}" --entry "OtherEntryPoint.xaml"
  

Importante:

• Os seguintes comandos não são compatíveis com projetos do Windows ou multiplataforma:

UiRobot.exe execute --file "C:\UiPath\Automation\Main.xaml"

UiRobot.exe execute --file "C:\UiPath\Automation\Project.json"

• Você não pode usar os argumentos --process (-p) e --file (-f) simultaneamente no comando execute.

Processo de instalação

Use esse comando para instalar um processo. Se o Robô estiver conectado ao Orchestrator, ele pesquisará o processo no feed do Orchestrator. Sem uma conexão com o Orchestrator, o Robô usa o feed local.

O comando do processo de instalação usa os seguintes argumentos:

UiRobot.exe installprocess [--process-name <process_name>] [--folder <orchestrator_folder>]

• --process-name <process_name> (obrigatório) — o nome do processo que você deseja instalar. Exemplo:

  UiRobot installprocess --process-name MyProcess
  

• --folder <orchestrator_folder> (opcional) — o nome da pasta do Orchestrator que contém o processo que você deseja instalar. Esse argumento aplica-se apenas quando a conexão com o Orchestrator está ativa. Se apenas uma pasta contiver o processo para instalação, pule esse parâmetro. Exemplo:

  UiRobot installprocess -p MyProcess --folder MyOrchestratorFolder
  

Conectar

Use esse comando para conectar seu Robô a uma instância do Orchestrator. Se seu Robô já estiver conectado ao Orchestrator e você executar esse comando, ele retornará a mensagem "Orchestrator já conectado".

O comando usa os seguintes argumentos:

UiRobot.exe connect [--url <Orchestrator_Server_URL> --key <Machine_Key>] | [--connectionString <Connection_String>]

• connect - Estabelece a conexão com o Orchestrator. Os argumentos, --url, --key ou --clientID --clientSecret devem ser usados juntos. Se você não especificar esses argumentos, o comando usará a definição de Configurações do Orchestrator . Exemplos:

  // no arguments
  
  UiRobot.exe connect
  

  //using the machine key
  
  UiRobot.exe connect --url https://demo.uipath.com/ --key 1122AAB3C-DD44-ABCD-1234-7788GG99HH00
  

  //using the client ID and secret
  
  UiRobot.exe connect --url https://demo.uipath.com/ --clientID 696CCA0C-1234-ABCD-1234-F65BBC2F15DE --clientSecret QJX!jv12345A4q4N
  

Desconectar

Use esse comando para desconectar o Robô da instância atual do Orchestrator.

O comando disconnect usa os seguintes argumentos:

UiRobot.exe disconnect --force | --wait

• disconnect - Desconecta o Robô do Orchestrator apenas quando não houver trabalhos em execução na máquina do Robô. Exemplo:

  UiRobot.exe disconnect
  

• --force - Encerra todos os trabalhos em execução na máquina e, em seguida, desconecta o Robô do Orchestrator. Exemplo:

  UiRobot.exe disconnect --force
  

• --wait - Aguarda a conclusão de trabalhos em execução antes de desconectar o Robô do Orchestrator. Exemplo:

  UiRobot.exe disconnect --wait
  

Trace

Use esse comando para habilitar ou desabilitar o rastreamento de baixo nível para o Robô.

O comando trace usa os seguintes argumentos:

UiRobot.exe trace --enableLowLevel | --disableLowLevel

• --enableLowLevel - Habilita o rastreamento Verbose para o Executor e o Serviço do Robô no Visualizador de Eventos. Ele gera um arquivo ETL que você pode abrir com o Visualizador de Eventos para obter assistência na solução de problemas de falhas e erros. Exemplo:

  UiRobot.exe trace --enableLowLevel
  

• --disableLowLevel - Desativa o rastreamento Verbose para o Executor e o Serviço do Robô. Ele gera um arquivo ETL que você pode abrir com o Visualizador de Eventos para obter assistência na solução de problemas de falhas e erros. Exemplo:

  UiRobot.exe trace --disableLowLevel
  

PiP

Use esse comando para habilitar ou desabilitar a sessão do Robô ou o recurso Picture in Picture na máquina. Essa configuração modifica as instalações existentes e se aplica a todos os usuários na máquina local. Requer privilégios de administrator.

O comando PiP usa os seguintes argumentos:

UiRobot.exe pip --enable | --disable

• --enable - Habilita a sessão do Robô (funcionalidade do PiP ) da máquina. Exemplo:

  UiRobot.exe pip --enable
  

• --disable - Desabilita a sessão do Robô (funcionalidade PiP) da máquina. Exemplo:

  UiRobot.exe pip --disable
  

Outros argumentos

Os seguintes argumentos são puramente informativos e não têm impacto em seus projetos de automação:

• --version - Exibe informações sobre a versão do Robô.
• --help - Exibe a lista de comandos compatíveis, bem como as informações e exemplos correspondentes.
• flushlogs [--timeout <timeout_in_seconds>] - Envia todos os logs pendentes para o Orchestrator.