Atualização automática de componentes de cliente

Sobre

Essa funcionalidade permite que os administradores atualizem os clientes do UiPath Robot, Studio e UiPath® Assistant para versões mais recentes do Orchestrator. Isso oferece uma maneira fácil de entregar uma atualização de versão a uma ampla base de máquinas de um local centralizado, ajudando a remover o atrito do usuário e simplificando o processo de atualização.

Observação: o recurso de atualização automática de componentes do cliente funciona apenas para atualizar para uma versão mais recente os produtos Robot, Studio e UiPath Assistant já instalados. Se for necessário um downgrade de versão, o processo deve ser feito manualmente ou usando ferramentas independentes da UiPath.

Pré-requisitos

1. Orchestrator, Studio e Robot 2021.10 ou posterior.
2. Studio e/ou Robot 2021.10 ou posterior instalado na máquina cliente e conectado ao Orchestrator.

Componentes que participam do processo de atualização

Lado do cliente

• Aplicativos clientes:

  • Robô
  • Assistente
  • Studio
• Serviço de robôs
• Agente de atualização - um processo do Windows responsável pela comunicação entre o usuário e o serviço de atualização. (presente apenas no modo de usuário e instalação do robô assistido)
• Serviço de atualização - um serviço do Windows responsável pela comunicação entre a máquina cliente e o servidor de atualização.

Lado do servidor

• Orchestrator: fornece a interface do usuário para que os administradores definam políticas de atualização automática e vejam o status da versão para aplicativos cliente.
• Servidor de atualização: serviço centralizado responsável por gerenciar as políticas de atualização automática e manter a comunicação com as máquinas clientes através do serviço de atualização.

Como isso funciona

Como administrador, você pode escolher a versão específica a ser implantada em uma máquina específica.

Para que isso aconteça, quando o Studio e o Robot estiverem instalados, dois executáveis também são adicionados à máquina: UiPath.UpdateService.Worker.exe e UiPath.UpdateService.Agent.exe.

Dependendo do tipo de instalação do Studio/UiPath Robot, elas são instaladas de uma maneira diferente:

• Unattended Robot: UiPath.UpdateService.Worker.exe é instalado como Serviço do Windows, enquanto UiPath.UpdateService.Agent.exe não está instalado.
• Attended Robot: UiPath.UpdateService.Worker.exe é instalado como Serviço do Windows, enquanto UiPath.UpdateService.Agent.exe é instalado como uma Tarefa de LogOn no Agendador de tarefas.
• Instalação rápida (modo de usuário): UiPath.UpdateService.Worker.exe e UiPath.UpdateService.Agent.exe são instalados como Tarefas de logon no Agendador de tarefas.
  Importante: ao instalar o UiPath Studio e o UiPath Robot na máquina no modo de usuário Attended, para que o serviço de atualização se conecte ao servidor de atualização, certifique-se de adicionar a URL do Orchestrator durante a configuração. Se o URL do Orchestrator não for adicionado durante a instalação, um usuário com direitos de administrador na máquina precisa fazer login na máquina e conectar o robô ao Orchestrator.

Quando uma nova política é definida ou alterada, o servidor de atualização envia um comando para o serviço de atualização na máquina cliente, que pergunta aos aplicativos cliente se eles estão prontos para iniciar o processo de atualização.

Para estar pronto para receber uma atualização, um produto deve estar em um estado neutro:

• Studio - sem processos em execução ou sessões ativas.
• UiPath Robot — sem trabalhos ou processos em execução.
• Assistant - sem processos em execução ou atividades pendentes (instalar ou baixar processos).
  Observação: durante o processo de atualização, o UiPath Robot não inicia nenhum trabalho até a atualização ser concluída.

No cenário assistido, uma solicitação de atualização é exibida dando ao usuário duas opções:

• Update Now - interrompe todos os trabalhos em execução e fecha todas as instâncias do Studio nessa máquina, em seguida, prossegue com a atualização.
• Later - silencia a notificação e o processo de atualização pode ser retomado acessando o ícone da interface gráfica na bandeja do sistema e clicando em verificar atualizações.

  Quando o usuário aceita a solicitação, a confirmação é enviada ao serviço de atualização e o processo de atualização é iniciado. Se nenhuma resposta for fornecida dentro de 24 horas após a primeira notificação, a atualização será instalada automaticamente.

No cenário não assistido, o serviço de atualização confirma que o aplicativo cliente está em um estado neutro (conforme descrito acima) antes de enviar a resposta de confirmação ao servidor de atualização.

Observação:

• Se quaisquer processos estiverem em execução na máquina, o usuário do UiPath Robot será solicitado a interromper o processo ou aguardar que ele seja concluído antes que a atualização possa prosseguir. Se uma sessão do Studio for aberta, o usuário do UiPath Robot será solicitado a salvar seu progresso.
• Se o usuário do UiPath Robot não reagir, o Studio fechará e salvará o processo como está nesse momento. O processo pode ser recuperado após a atualização ser concluída.
• Se um certo limite de tempo for atingido, o UiPath Robot no modo de serviço forçará uma atualização mesmo que um trabalho ainda esteja em execução. Devido a esse comportamento, o trabalho pode falhar. O tempo de espera padrão é:
  • 10 minutos para UiPath Robots de modo de serviço.
  • 1440 minutos para UiPath Robots de modo de usuário.

Passos do processo de atualização

O processo de atualização é dividido em sete etapas:

1. Fazendo o download
   • O serviço de atualização verifica o servidor de atualização a cada três horas para uma solicitação de atualização. Se a solicitação de atualização for recebida, o processo de atualização inicia o processo de download. Se o processo de download for iniciado com sucesso, a solicitação de atualização é adicionada ao banco de dados do servidor de atualização com o status Downloading.
2. baixou
   • O estado Downloaded atua como um marcador para que o serviço de atualização possa iniciar a fase de pós-processamento. Este estado marca o fato de que o arquivo de atualização foi baixado com sucesso.
3. Processando
   • Esta etapa trata do pós-processamento do arquivo baixado. Nesta etapa, o arquivo é verificado e, se nenhum erro aparecer, o processo de instalação é iniciado.
4. Pronto para instalar
   • O agente de atualização informa ao usuário que uma atualização está aguardando instalação e pede aprovação, ou verifica se os aplicativos cliente estão prontos para receber a atualização.
5. Instalação Aprovada
   • Assim que a aprovação for recebida pelo serviço de atualização, a instalação em si será iniciada.
6. Instalando
   • A nova versão é instalada na máquina mantendo as mesmas configurações da versão anterior.
7. Sucesso / Erro
   Com base no resultado da instalação, o status da atualização é relatado ao servidor de atualização.

   Observação: se a extensão do Chrome já estiver instalada na máquina do robô, a funcionalidade de atualização automática também a atualizará. Caso contrário, a extensão deve ser instalada manualmente.

Mecanismo de retentativa

Durante o processo de atualização, se o arquivo não puder ser recuperado no primeiro download, o serviço de atualização tentará novamente mais três vezes. Os intervalos de tentativa são: uma hora após a tentativa inicial, duas horas após a tentativa inicial e quatro horas após a última tentativa. Antes de cada nova tentativa, o usuário é informado pelo sistema de notificação.

Para cada tentativa de download, os registros são adicionados aos logs de atualização do Orchestrator e localmente na máquina, no arquivo %localappdata%/Uipath/UpdateService/logs.

O processo é semelhante para a instalação, o que significa que se a primeira instalação falhar, o serviço de atualização tentará novamente três vezes com a mesma frequência (uma hora após a tentativa inicial, duas horas após a tentativa inicial e quatro horas após a última tentativa).

O servidor de atualização espera 72 horas para que a atualização seja concluída desde que foi iniciada. Se a nova versão não for instalada após a expiração desse intervalo, um erro detalhado será adicionado aos logs. A atualização é repetida na próxima vez que uma solicitação for recebida.

Você também pode tentar novamente manualmente a atualização usando o botão se a atualização automática falhar.

Implantações de robôs em modo de serviço versus modo de usuário

Os aspectos técnicos no lado do servidor são idênticos para implementações no modo de serviço e no modo de usuário, pois usam o mesmo tipo de conexão entre o servidor de atualização e o serviço de atualização. A diferença consiste na forma como o Serviço de Robôs da UiPath se comunica com o serviço de atualização na máquina cliente, conforme explicado a seguir.

Modo de Serviço

Nas implantações no modo de serviço, o Serviço de Robôs da UiPath e o serviço de atualização são executados na sessão da conta do sistema local.

Modo de Usuário

Em implantações no modo de usuário, o Serviço de Robôs da UiPath é executado na sessão do usuário, e o serviço de atualização é executado na sessão da conta do sistema local.

Importante: quando o UiPath Robot e o Studio são implantados no modo de usuário, o envio do comando de atualização para um robô na máquina afeta todos os usuários naquela máquina específica.

Aviso: após a conclusão do processo de atualização, o Studio e o Robot devem ser iniciados manualmente.

Configuração de políticas

As políticas podem ser definidas para usuários, grupos de usuários (recomendado para casos de uso assistidos) ou máquinas (recomendado para casos de uso não assistidos).

Configuração de políticas para usuários/grupos de usuário

A configuração de políticas de atualização para usuários ou grupos de usuários permite que os administradores controlem a versão do Studio, Robot e Assistant para um usuário ou grupo de usuários específico.

• Usuário específico - para atualizar de forma granular os componentes vinculados a um usuário específico.

• Grupo de usuários - para atualizar o acesso a todos os membros do grupo sem a necessidade de definir o nível de acesso para cada usuário individualmente.

  Importante: para Usuários que tenham a licença do Automation Express atribuída, a política de atualização não pode ser editada e está pronta para entregar a versão corporativa mais recente.

As políticas são configuradas editando um usuário ou grupo específico na guia Gerenciar Acesso no Orchestrator.

1. Navegue até Tenant > Gerenciar acesso. A janela Usuários é exibida.
2. Para o usuário/grupo de usuário desejado, clique em Editar. A janela Editar Usuário é exibida.
3. Na seção Configurações da política de atualização, altere a política de atualização automática para um dos seguintes valores:

Por usuário

Por grupo

Observação:

Se a política aplicada ao usuário for definida como None, mas ele também fizer parte de um grupo que possui um conjunto de políticas específico (por exemplo, atualização mais recente), a política de grupo se aplica. Se quiser que os componentes desse usuário específico não sejam atualizados, você deve removê-los do grupo que possui a política ou definir a política de atualização para a versão atual instalada.

Se o usuário tiver uma política definida para enviar uma versão específica e também fizer parte de um grupo com uma política diferente, a política de nível de usuário terá precedência.

Objetos por máquina

Configurar uma política de atualização para objetos de máquina permite que os administradores atualizem as versões do robô em todas as máquinas conectadas ao Orchestrator usando uma chave de máquina específica.

Para configurar as políticas de atualização para objetos de máquina, siga as etapas abaixo:

1. Navegue até Tenant > Máquinas. A janela Máquinas é exibida
2. Para o objeto de máquina desejado, clique em Editar. A janela Editar Máquina é exibida.
3. Acesse a aba Manutenção. O menu Atualização automática será exibido.
4. Configure a política de atualização.
   

Observação: Errata - 28 de abril de 2023

Para habilitar essa funcionalidade, você precisa adicionar o parâmetro Features.MachineMaintenanceSchedule.Enabled ao arquivo UiPath.Orchestrator.dll.config e defini-lo como true.

Agendamento de atualização automática

Na aba Manutenção, também é possível agendar a atualização para iniciar em uma determinada hora e data para corresponder a outras janelas de manutenção na sua empresa. Também é possível definir a duração da janela de manutenção. Se a hora definida para a janela de manutenção passar e a atualização não tiver sido iniciada, ela será agendada durante o próximo intervalo disponível.

Prioridade de política

Caso uma política em nível de usuário, uma política em nível de grupo e uma política em nível de máquina se apliquem ao mesmo robô, a política em nível de usuário tem precedência.

Exemplo:

• Máquina_1 tem uma versão 2021.10 do Robot e Studio instalada.
• Na máquina_1, o robô é conectado ao Orchestrator por meio do logon interativo com o usuário fulano@domínio.com.
• Uma política de atualização se aplica a fulano@domínio.com, que está configurada para enviar a versão 2021.10.2.
• john.doe@domínio.com também faz parte do grupo_1.
• Uma política de atualização se aplica ao grupo_1, que está definido para enviar a versão 2021.10.3.

• Uma política de atualização se aplica a máquina_1, que está configurada para enviar a versão 2022.4.

  Resultado: quando as políticas de atualização são disparadas, os componentes dessa máquina são atualizados para a versão 2021.10.2.

  Observação: ao usar contas de robô , observe que a política no nível da máquina é usada para lidar com a atualização.

Disponibilidade de versão nas políticas

Ao criar uma política de atualização, você pode escolher uma das seguintes opções:

Versão principal mais recente	Patch mais recente	Patch específico
Instala a versão mais recente disponível encontrada no servidor de atualização.	Instala o patch mais recente disponível para cada uma das versões compatíveis. (por exemplo, patch 2021.10 mais recente, patch 2022.4 mais recente).	Instala um patch específico da lista dos disponíveis no servidor de atualização.

Atualizar logs

Na interface de usuário do Orchestrator, os logs de atualização estão disponíveis para atualizações com falha e bem-sucedidas. Logs completos para a atualização são encontrados na máquina, no arquivo %localappdata%/Uipath/UpdateService/logs.

AVISO:

Quando os robôs são implantados em ambientes virtuais onde as máquinas são clonadas, o nome da máquina, guid, id da unidade e endereço mac são os mesmos. Isso pode causar conflitos, pois o Orchestrator recebe diferentes status de atualização de várias máquinas com os mesmos identificadores.

Nesse cenário, o status de atualização no Orchestrator é mostrado com base na última máquina que conectou-se.

Isso também pode impactar os logs do Orchestrator, pois várias máquinas têm os mesmos identificadores, logs duplicados podem aparecer.

Status de versão

A coluna de Status da versão permite que você verifique o status da versão do UiPath Robot para suas máquinas em relação à política associada.

Os seguintes valores estão disponíveis:

• Nenhuma política - nenhuma política é definida
• Atualização em andamento — esse status é apresentado quando o processo de atualização está em andamento na máquina
• Em conformidade - a versão do robô na máquina está de acordo com a política de atualização.
• Não compatível - a versão do robô na máquina é diferente da que foi configurada na política. (por exemplo, a versão do robô é 2021.10.3, a política está definida como 2021.10.1)
• Falha na atualização - este status mostra quando o processo de atualização falhou. Mais detalhes podem ser encontrados nos logs de atualização.
• N/A - este status aparece quando a configuração para excluir máquinas inativas está habilitada e o robô não está conectada há algum tempo, ou quando o tipo de máquina não é compatível com o processo de atualização automática.

Status da versão para máquinas

A coluna Status da versão na guia Máquinas do Orchestrator permite que você verifique o status da versão do UiPath Robot para suas máquinas em relação à política associada.

Importante: Robôs Linux não são compatíveis com a funcionalidade de Atualização automática. Para eles, o status da versão é exibido como N/A, com a dica de contexto "A atualização automática não se aplica a este tipo de máquina".

Removendo máquinas inativas

Se várias máquinas estiverem conectadas ao Orchestrator usando a mesma chave e uma delas estiver inativa, o status da versão do modelo de máquina se torna Non compliant. Isso acontece conforme o modelo da máquina se comunica com o servidor de atualização usando a mesma chave da máquina e, se uma das máquinas conectadas não puder receber uma atualização, o status geral do modelo da máquina será afetado.

Para evitar isso, acesse a seção Geral do menu Configurações no contexto do tenant, marque a caixa de seleção Binários do cliente e defina o intervalo de inatividade preferido. Isso exclui máquinas inativas do processo de atualização e não as leva mais em consideração quando o status da atualização é relatado.

Status da versão para usuários

A coluna Status da versão na guia Sessões do usuário da janela Monitoramento permite que você verifique o status da versão do componente do cliente para seus usuários em relação à política associada.

Gerenciamento das versões de atualização

If your Orchestrator instance has Internet access, by default, version management is done by UiPath, and the list of available versions in the policies is automatically populated. If you want to manually manage the versions, go to Settings at the host level, then select General, and then clear the Auto-fill available product versions checkbox.

Se você optar por não ter o gerenciamento de versão feito pela UiPath ou se sua instância do Orchestrator não tiver acesso à Internet, você deve baixar manualmente os instaladores dos componentes do cliente do Customer Portal Download Center e carregá-los no servidor de atualização usando a página etapas abaixo:

1. Obtenha o -InstallationToken a partir do Identity Server usando as etapas descritas em Token de Acesso de Instalação.
2. Para definir os valores para ClientId e ClientSecret, execute o script abaixo:
   Observação:

   Os scripts necessários para os comandos abaixo estão localizados na pasta de instalação (o caminho padrão é C:\Program Files (x86)\UiPath\Orchestrator\Tools\UpdateServerScripts) na máquina do orquestrador.

   As versões do produto compatíveis a serem usadas nos scripts são encontradas na página de documentação de Ciclo de vida do produto . Para os scripts de atualização, o formato curto da versão é usado (por exemplo, 22.4.3 em vez da 2022.4.3).

   .\Provision-IdentityClient.ps1 -IdentityUri "<IDENTITY_URL>" -InstallationToken "<INSTALLATION_TOKEN>" -ClientId "<CLIENT_ID>" -ClientSecret "<CLIENT_SECRET>"

   Os valores definidos para ClientId e ClientSecret devem ser usados mais tarde ao chamar o script Product-Versions.ps1

Obter versões disponíveis

.\Product-Versions.ps1 get -ApiBaseUri "<ORCHESTRATOR_URL>" -IdentityUri "<IDENTITY_URL>" -ClientId "<CLIENT_ID>" -ClientSecret "<CLIENT_SECRET>"

Publicar uma nova versão no servidor de atualização

.\Product-Versions.ps1 register -ApiBaseUri "<ORCHESTRATOR_URL>" -IdentityUri "<IDENTITY_URL>" -ClientId "<CLIENT_ID>" -ClientSecret "<CLIENT_SECRET>" -ProductId "b69fdacf-6dd0-46fb-88c7-af2d87caf5aa" -Version "<NEW_VERSION>" -DownloadUri "<DOWNLOAD_URL>".\Product-Versions.ps1 register -ApiBaseUri "https://intranet/orchestrator_" -IdentityUri "https://intranet/identity_" -ClientId "<CLIENT_ID>" -ClientSecret "<CLIENT_SECRET>" -ProductId "b69fdacf-6dd0-46fb-88c7-af2d87caf5aa" -Version "22.4.3" -DownloadUri "https://download.uipath.com/versions/22.10.3/UiPathStudio.msi"

Excluir uma versão específica do servidor de atualização

DELETE
.\Product-Versions.ps1 delete -ApiBaseUri "<ORCHESTRATOR_URL>" -IdentityUri "<IDENTITY_URL>" -ClientId "<CLIENT_ID>" -ClientSecret "<CLIENT_SECRET>" -ProductId "b69fdacf-6dd0-46fb-88c7-af2d87caf5aa" -Version "<NEW_VERSION>"

Publicar uma nova versão na máquina do cliente

.\Provision-IdentityClient.ps1 -IdentityUri "<IDENTITY_URL>" -InstallationToken "<INSTALLATION_TOKEN>" -ClientId "<CLIENT_ID>" -ClientSecret "<CLIENT_SECRET>"

Com base nos requisitos, as seguintes IDs de produto podem ser usadas nos scripts:

IdDoProduto	Produto
FD97813F-44F7-45A0-BB55-0DAF0088F568	UiPath Assistant para Mac (x64)
46C978F2-A5FE-4F71-AD88-D6A07118F790	UiPath Assistant para Mac (arm64)
B69FDACF-6DD0-46FB-88C7-AF2D87CAF5AA	Pacote de automação UiPath (UiPathStudio.msi)

Proxy Configuration

Para cenários em que os robôs estão atrás de um proxy, para que o recurso de atualização automática funcione, pode ser necessária uma configuração adicional. De acordo com o tipo de instalação, as configurações de proxy podem ser herdadas das configurações de proxy de nível de usuário ou definidas manualmente editando o arquivo de configuração.

Tipo de Instalação	Implantação de robôs	Atualizar Serviço	Agente de atualização	Configurações de Proxy
Robô unattended	Serviço do Windows	Serviço do Windows	N/A 1	Do arquivo uipath.config.
Robô Attended	Executável de nível de usuário	Serviço do Windows	Executável de nível de usuário	Do arquivo uipath.config.
Instalação rápida	Executável de nível de usuário	Executável de nível de usuário	Executável de nível de usuário	Das configurações de proxy do nível do usuário.

1 quando o robô é instalado no modo não assistido, o agente de atualização não é adicionado à máquina.

Coletando Logs de Erros

Quando uma atualização falha, você pode usar a Ferramenta de Diagnóstico para coletar logs que podem ser enviados para nossa equipe de suporte, usados então para uma investigação mais aprofundada sobre o erro específico.

Mensagem de Erro

Configuração de Ferramenta de Diagnóstico