Guia do administrador do robô

Última atualização 18 de dez de 2024

API do Robô

A API do UiPath Robot é um componente projetado para expandir a funcionalidade de seu próprio Robot. Ele vem com várias funcionalidades, cada uma abordando um aspecto específico do gerenciamento de automações. Elas incluem:

Gerenciamento de trabalhos individuais: fornece a capacidade de executar, interromper e rastrear processos de automação pessoal.
Interfaces específicas do domínio: permite o desenvolvimento de interfaces personalizadas para atender a necessidades de automação exclusivas.
Acessibilidade local: disponível apenas na máquina em que o Robô está instalado, garantindo acesso seguro e direto.
Compatibilidade da versão: mantém a consistência com a versão do Robô instalado, que permite a retrocompatibilidade.

A API do Robô usa a biblioteca UiPath.Robot.api. Use o seguinte feed para baixar a biblioteca:

https://uipath.pkgs.visualstudio.com/Public.Feeds/_packaging/UiPath-Official/nuget/v3/index.json.https://uipath.pkgs.visualstudio.com/Public.Feeds/_packaging/UiPath-Official/nuget/v3/index.json.

Matriz de compatibilidade

no mínimo 2021.8	API 2024.10.x	API 2023.10.x	API 2023.4.x	API 2022.10.x	API 2022.4.x	API 2021.10.x
Robot 2024.10.x
Robot 2023.10.x
Robot 2023.4.x
Robot 2022.10.x
Robot 2022.4.x
Robô 2021.10.x

Chamadas de API comuns do Robot

Description	Chamada de API do .NET Robot
Incluindo o cliente em seu aplicativo	`var client = new RobotClient();`var client = new RobotClient();
Obtendo a lista de processos disponíveis	`var processes = await client.GetProcesses(); var myProcess = processes.Single(process => process.Name == "MyProcess"); var job = myProcess.ToJob();`var processes = await client.GetProcesses(); var myProcess = processes.Single(process => process.Name == "MyProcess"); var job = myProcess.ToJob();
Usando a chave de processo para iniciar um trabalho	`var job = new Job("812e908a-7609-4b81-86db-73e3c1438be4");`var job = new Job("812e908a-7609-4b81-86db-73e3c1438be4");
Como iniciar uma execução de processo	`{ await client.RunJob(job); } catch (Exception ex) { Console.WriteLine(ex.ToString()); }`{ await client.RunJob(job); } catch (Exception ex) { Console.WriteLine(ex.ToString()); }
Adicionando argumentos de entrada	`job.InputArguments = {["numbers"] = new int[] { 1, 2, 3 }}; await client.RunJob(job);`job.InputArguments = {["numbers"] = new int[] { 1, 2, 3 }}; await client.RunJob(job);
Exportação de argumentos de saída	`var jobOutput = await client.RunJob(job); Console.WriteLine(jobOutput.Arguments["sumOfNumbers"]);`var jobOutput = await client.RunJob(job); Console.WriteLine(jobOutput.Arguments["sumOfNumbers"]);
Interrompendo um Processo	`await client.RunJob(job, cancellationToken);`await client.RunJob(job, cancellationToken);
Monitoramento do status do processo	`job.StatusChanged += (sender, args) => Console.WriteLine($"{((Job)sender).ProcessKey}: {args.Status}"); await client.RunJob(job);`job.StatusChanged += (sender, args) => Console.WriteLine($"{((Job)sender).ProcessKey}: {args.Status}"); await client.RunJob(job);
Usando o Agendador de eventos	`new RobotClient(new RobotClientSettings { EventScheduler = TaskScheduler.Default })`new RobotClient(new RobotClientSettings { EventScheduler = TaskScheduler.Default })