Mise à jour automatique des composants clients

À propos

Cette fonctionnalité permet aux administrateurs de mettre à jour les clients Robot, Studio et UiPath Assistant vers des versions plus récentes à partir d'Orchestrator. Cela offre un moyen simple de permettre la mise à jour de version d'un nombre important de machines à partir d'un emplacement centralisé, aidant à éliminer les frictions des utilisateurs et à simplifier le processus de mise à jour.

Remarque :

The Auto Updating Client Components feature only works for updating already installed Robot, Studio, and Assistant products to a newer version. If a version downgrade is needed, the downgrade process must be done manually or using tools independent of UiPath.

Prérequis

1. Orchestrator, Studio et Robot 2021.10 ou version ultérieure.
2. Studio et/ou Robot 2021.10 ou version ultérieure installés sur la machine cliente et connectés à Orchestrator.

Composants qui participent au processus de mise à jour

Côté client

• Applications clientes :
  • Robot
  • Assistant
  • Studio
• Service de robots
• Agent de mise à jour : un processus Windows responsable de la communication entre l'utilisateur et le service de mise à jour. (présent uniquement dans le mode utilisateur et l'installation du robot assisté)
• Update Service - a Windows service or process (when quick install is used) responsible for the communication between the client machine and the update server.

Côté serveur

• Orchestrator : fournit l'interface utilisateur permettant aux administrateurs de définir des politiques de mise à jour automatique et d'afficher l'état de la version des applications clientes.
• Serveur de mise à jour : un service centralisé chargé de gérer les politiques de mise à jour automatique et de maintenir la communication avec les machines clientes via le service de mise à jour.

Mode de fonctionnement

Lorsque Studio et le Robot sont installés, deux exécutables sont également ajoutés à la machine : UiPath.UpdateService.Worker.exe et UiPath.UpdateService.Agent.exe.

Selon le type d'installation de Studio/du Robot, ils sont exécutés de manière différente :

• Unattended Robot : UiPath.UpdateService.Worker.exe est installé en tant que service Windows et UiPath.UpdateService.Agent.exe n'est pas installé.

• Attended Robot : UiPath.UpdateService.Worker.exe est installé en tant que service Windows ; UiPath.UpdateService.Agent.exe est installé en tant que tâche de connexion dans le planificateur de tâches.

• Installation rapide (mode utilisateur) : UiPath.UpdateService.Worker.exe et UiPath.UpdateService.Agent.exe sont installés en tant que tâches de connexion dans le planificateur de tâches.

  Important :

  When installing Studio and Robot per-machine in attended user-mode, for the update service to connect to the update server, make sure to add the Orchestrator URL during setup. If the Orchestrator URL is not added during installation, a user with administrator rights on the machine has to log on to the machine and connect the robot to Orchestrator.

Le service de mise à jour sur la machine communique avec le serveur de mise à jour lors des interrogations régulières, et lorsqu'il trouve un changement dans la politique, vérifie auprès des applications clientes si elles sont prêtes à démarrer le processus de mise à jour.

Pour qu'un produit reçoive une mise à jour, il doit être dans un état neutre :

• Studio - pas de processus en cours ni de sessions actives.

• Robot - pas de tâches ou de processus en cours d'exécution.

• Assistant - pas de processus en cours d'exécution ni d'activités en attente (processus d'installation ou de téléchargement).

  Remarque :

  Pendant le processus de mise à jour, le Robot ne démarre aucune tâche tant que la mise à jour n'est pas terminée.

Dans le scénario Attended, une invite de mise à jour s'affiche, proposant à l'utilisateur deux options :

• Update Now : arrête toutes les tâches en cours d'exécution et ferme toutes les instances Studio sur cette machine, puis procède à la mise à jour.
• Later - coupe le son de la notification et le processus de mise à jour peut être repris en rouvrant la notification à partir de l'icône de l'interface utilisateur dans la barre d'état système et en cliquant sur Vérifier les mises à jour .

Lorsque l'utilisateur accepte l'invite, la confirmation est envoyée au service de mise à jour et le processus de mise à jour démarre.

Si aucune réponse n'est fournie dans les 24 heures suivant la première notification, la mise à jour s'installe automatiquement.

Dans le scénario Unattended, le service de mise à jour confirme que l'application cliente est dans un état neutre (comme décrit ci-dessus) avant de renvoyer la confirmation au serveur de mise à jour.

Remarque :

Si des processus sont en cours d'exécution sur la machine, l'utilisateur est invité à choisir d'arrêter le processus ou d'attendre qu'il se termine afin de continuer avec la mise à jour. Si une session Studio est ouverte, l'utilisateur est invité à enregistrer la progression.

Si l'utilisateur ne réagit pas, Studio se ferme et le processus est enregistré tel quel à ce moment-là. Il peut être récupéré une fois la mise à jour terminée, tandis que le Robot attend la fin d'un processus et démarre le processus de mise à jour par la suite.

Étapes du processus de mise à jour

Le processus de mise à jour est divisé en sept étapes :

1. Téléchargement

   Le service de mise à jour vérifie le serveur de mise à jour toutes les trois heures pour une demande de mise à jour. Si la demande de mise à jour est reçue, le processus de mise à jour démarre le processus de téléchargement. Si le processus de téléchargement a démarré avec succès, la demande de mise à jour est ajoutée à la base de données du serveur de mise à jour avec le statut Downloading .

2. téléchargé

   L'état Downloaded agit comme un marqueur, afin que le service de mise à jour puisse démarrer la phase de post-traitement. Cet état marque le fait que le fichier de mise à jour a été téléchargé avec succès.

3. Traitement

   Cette étape gère le traitement du fichier téléchargé. Dans cette étape, le fichier est vérifié et si aucune erreur n'apparaît, le processus d'installation démarre.

4. Prêt à installer

   L'agent de mise à jour informe l'utilisateur qu'une mise à jour est en attente d'installation et demande son approbation, ou vérifie si les composants clients sont prêts à recevoir la mise à jour.

5. Installation approuvée

   Une fois l'approbation reçue par le service de mise à jour, l'installation proprement dite démarre.

6. Installation en cours

   La nouvelle version est installée sur la machine en conservant les mêmes paramètres que la version précédente.

7. Succès / Erreur

   En fonction du résultat de l'installation, l'état de la mise à jour est renvoyé au serveur de mise à jour.

   Remarque :

   Si l’ extension Chrome était déjà installée sur la machine robot, la fonctionnalité de mise à jour automatique la met également à jour. Sinon, l’extension doit être installée manuellement.

Mécanisme de nouvelle tentative

Pendant le processus de mise à jour, si le fichier ne peut pas être récupéré lors du premier téléchargement, le service de mise à jour réessaye trois fois. Les intervalles entre les tentatives sont les suivants : une heure après la tentative d'origine, puis deux heures après la première nouvelle tentative, et quatre heures après la dernière tentative. Avant chaque nouvelle tentative, l'utilisateur est informé via le système de notification.

Pour chaque tentative de téléchargement, les journaux sont ajoutés aux journaux de mise à jour d'Orchestrator, et localement sur la machine dans le fichier %localappdata%/Uipath/UpdateService/logs.

Le processus est similaire pour l'installation, ce qui signifie que si la première installation échoue, le service de mise à jour réessaye trois fois avec la même fréquence (une heure après la tentative initiale, puis deux heures après la première nouvelle tentative et quatre heures après la dernière tentative).

Le serveur de mise à jour attend 72 heures que la mise à jour se termine depuis son démarrage. Si la nouvelle version n'est pas installée après l'expiration de cet intervalle, une erreur détaillée est ajoutée aux journaux. La mise à jour est retentée la prochaine fois qu'une demande est reçue.

Déploiements de robots en mode service ou en mode utilisateur

Les aspects techniques côté serveur sont identiques pour les déploiements en mode service et en mode utilisateur, car ils utilisent le même type de connexion entre le serveur de mise à jour et le service de mise à jour. La différence réside dans la façon dont le service de Robot communique avec le service de mise à jour sur la machine client, comme expliqué ci-dessous.

Mode de service

Dans les déploiements en mode service, le service de robot et le service de mise à jour s'exécutent tous deux dans la session de compte du système local.

Mode utilisateur

Dans les déploiements en mode utilisateur, le service de robot s'exécute dans la session utilisateur et le service de mise à jour s'exécute dans la session du compte du système local.

Important :

Lorsque Robot et Studio sont déployés en mode utilisateur, l'envoi de la commande de mise à jour à un Robot sur la machine affecte tous les utilisateurs sur cette machine spécifique.

Avertissement :

Une fois le processus de mise à jour terminé, Studio et Robot doivent être démarrés manuellement.

Configuration des politiques

Des politiques peuvent être définies pour des utilisateurs, des groupes d'utilisateurs (recommandé pour les cas d'utilisation Attended) ou des machines (recommandé pour les cas d'utilisation Unattended).

Configuration des politiques pour les utilisateurs/groupes d'utilisateurs

La configuration des politiques de mise à jour pour les utilisateurs ou les groupes d'utilisateurs permet aux administrateurs de contrôler la version Studio, Robot et Assistant pour un utilisateur ou un groupe d'utilisateurs spécifique.

• Utilisateur spécifique - pour mettre à jour de manière précise les composants liés à un utilisateur spécifique.
• Groupe d'utilisateurs - pour mettre à jour l'accès à tous les membres du groupe sans avoir besoin de définir le niveau d'accès pour chaque utilisateur individuellement.

Les politiques sont configurées en modifiant un utilisateur ou un groupe spécifique à partir de l'onglet Gérer l'accès (Manage Access) dans Orchestrator.

1. Accédez à Locataire (Tenant) > Gérer l'accès (Manage Access). La fenêtre Utilisateurs (Users) s'affiche.
2. Pour l'utilisateur/groupe d'utilisateurs souhaité, cliquez sur Modifier (Edit). La fenêtre Modifier un utilisateur (Edit User) s'affiche.
3. Dans la section Paramètres de politique de mise à jour (Update policy settings), remplacez la politique de mise à jour automatique par l'une des valeurs suivantes :

Par utilisateur

Par groupe

Remarque :

Si la politique appliquée à l'utilisateur est définie sur None, mais qu'elle fait également partie d'un groupe doté d'un ensemble de politiques spécifique (par exemple Dernier correctif), la politique de groupe s'applique. Si vous souhaitez que les composants de cet utilisateur spécifique ne soient pas mis à jour, vous devez soit les supprimer du groupe qui possède la politique, soit définir la politique de mise à jour pour qu'elle corresponde à la version actuelle installée.

Si l'utilisateur a une politique définie pour transmettre une version spécifique et qu'il fait également partie d'un groupe qui a une politique différente, la politique au niveau de l'utilisateur est prioritaire.

Configuration des politiques pour les objets machine

La configuration d'une politique de mise à jour pour les objets machine permet aux administrateurs de mettre à jour les versions du robot sur toutes les machines connectées à Orchestrator à l'aide de cette clé de machine. La configuration se fait au niveau de l'objet de machine :

1. Accédez à Locataire (Tenant) > Machines. La fenêtre Machines s'affiche

2. Pour l'objet machine souhaité, cliquez sur Modifier (Edit). La fenêtre Modifier la machine (Edit Machine) s'affiche.

3. Dans la section Paramètres de politique de mise à jour (Update policy settings), remplacez la politique de mise à jour par l'une des valeurs suivantes :

   

Priorité de la politique

Dans le cas où une politique au niveau de l'utilisateur, une politique au niveau du groupe et une politique au niveau de la machine s'appliquent au même Robot, la politique au niveau de l'utilisateur prévaut.

Exemple

• Machine_1 a une version 2021.10 de Robot et Studio installée.
• Sur machine_1, le robot est connecté à Orchestrator via la connexion interactive avec l'utilisateur [e-mail] .
• Une politique de mise à jour s'applique à [e-mail] , qui est configurée afin de transmettre la version 2021.10.2.
• [e-mail] fait également partie de group_1.
• Une politique de mise à jour s'applique au group_1, qui est configuré pour transmettre la version 2021.10.3.
• Une politique de mise à jour s'applique à machine_1 qui est configurée pour transmettre la version 2022.4 .

Result: when the update policies trigger, the components on that machine are updated to 2021.10.2 version.

Disponibilité des versions dans les politiques

Lors de la création d'une politique de mise à jour, vous pouvez choisir l'une des options suivantes :

Dernière version majeure	Dernier correctif	Patch spécifique
Installe la dernière version disponible trouvée sur le serveur de mise à jour.	Installe le dernier correctif disponible pour chacune des versions prises en charge. (par exemple, Dernier correctif 2021.10, Dernier correctif 2022.4).	Installe un correctif spécifique dans la liste de ceux disponibles sur le serveur de mise à jour.

Journaux de mise à jour

In the Orchestrator user interface, the update logs are available for failed and successful updates and can be copied directly using the button next to each log. Complete logs for the update are found on the machine in the %localappdata%/Uipath/UpdateService/logs file.

Avertissement :

Lorsque les robots sont déployés sur des environnements virtuels où les machines sont clonées, le nom de la machine, le guid, l'ID de lecteur et l'adresse mac sont les mêmes. Cela peut provoquer des conflits car Orchestrator reçoit des statuts de mise à jour différents de plusieurs machines avec les mêmes identifiants.

Dans ce scénario, le statut de mise à jour dans Orchestrator est affiché en fonction de la dernière machine qui s'est connectée.

Cela peut également avoir un impact sur les journaux d'Orchestrator, car si plusieurs machines ont les mêmes identifiants, des journaux peuvent apparaître en double.

Statuts des versions

La colonne Statut de version (Version status) vous permet de vérifier l'état de la version du Robot pour vos machines par rapport à la politique associée.

Les valeurs suivantes sont disponibles :

• Aucune politique - aucune politique n'est définie
• Mise à jour en cours (Update in progress) - ce statut est présenté lorsque le processus de mise à jour est en cours sur la machine.
• Conforme : la version du robot sur la machine correspond à la politique de mise à jour.
• Non conforme (Non compliant) - la version du robot sur la machine est différente de celle qui a été configurée dans la stratégie. (par exemple, la version du robot est 2021.10.3, la politique est configurée comme 2021.10.1)
• Échec de la mise à jour (Update failed) - ce statut s'affiche lorsque le processus de mise à jour a échoué. Vous trouverez plus de détails dans les journaux de mise à jour.
• N/A : ce statut s'affiche lorsque le paramètre permettant d'exclure les machines inactives est activé et que le robot n'a pas été connecté depuis un certain temps, ou lorsque le type de machine n'est pas compatible avec le processus de mise à jour automatique.

Statut de la version pour les machines

La colonne Statut de version (Version status) de l'onglet Machines d'Orchestrator (Orchestrator Machines) vous permet de vérifier le statut de la version du Robot pour vos machines par rapport à la politique associée.

Important :

Les robots Linux ne sont pas compatibles avec la fonctionnalité de mise à jour automatique. Pour ces dernières, le statut de la version s’affiche sous la forme N/A avec l’info-bulle « La mise à jour automatique n’est pas applicable pour ce type de machine ».

Exclusion des machines inactives

Si plusieurs machines sont connectées à Orchestrator à l'aide de la même clé et que l'une d'entre elles est inactive, le statut de la version du modèle de machine devient Non compliant. Cela se produit lorsque le modèle de machine communique avec le serveur de mise à jour à l'aide de la même clé de machine, et si l'une des machines connectées ne peut pas recevoir de mise à jour, le statut général du modèle de machine est affecté.

Pour éviter cela, accédez à la section Général (General) du menu Paramètres (Settings) dans le contexte du locataire, cochez la case Binaires client (Client Binaries) et définissez l'intervalle d'inactivité de votre choix. Cela exclut les machines inactives du processus de mise à jour et ne les prend plus en compte lorsque le statut de mise à jour est signalé.

Statut de la version pour les utilisateurs

La colonne Statuts de versions (Version Statuses) de l'onglet Robots dans Orchestrator vous permet de vérifier le statut de la version du composant client pour vos utilisateurs par rapport à la politique associée.

Gestion des versions de mise à jour

Si votre instance Orchestrator dispose d’un accès Internet, par défaut, la gestion des versions est effectuée par UiPath et la liste des versions disponibles dans les stratégies est automatiquement renseignée. Si vous souhaitez gérer manuellement les versions, accédez à Paramètres (Settings) au niveau de l’hôte, sélectionnez Général (General) et décochez la case Remplissage automatique des versions de produit disponibles (Auto-fill available product versions).

Si vous choisissez de ne pas confier la gestion des versions à UiPath, ou si votre instance d’Orchestrator n’a pas accès à Internet, vous devez télécharger manuellement les programmes d’installation des composants clients depuis la page Téléchargements de produits via le UiPath Customer Portal, et les charger sur le serveur de mise à jour à l’aide de l’outil étapes ci-dessous :

1. Acquire the -InstallationToken from the Identity Server using the steps described in Installation Access Token.

2. Pour définir les valeurs de ClientId et ClientSecret, exécutez le script ci-dessous :

   Remarque :

   Les scripts nécessaires pour les commandes ci-dessous se trouvent dans le dossier d'installation (le chemin par défaut est C:\Program Files (x86)\UiPath\Orchestrator\Tools\UpdateServerScripts) sur la machine Orchestrator.

   Les versions du produit prises en charge à utiliser dans les scripts se trouvent dans la page Documentation du cycle de vie du produit. Pour les scripts de mise à jour, le format court de la version est utilisé (par ex. 22.4.3 au lieu de 2022.4.3).

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

   Les valeurs définies pour ClientId et ClientSecret seront utilisées ultérieurement lors de l’appel du script Product-Versions.ps1

Obtenir les versions disponibles

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

Publier une nouvelle version sur le serveur de mise à jour

.\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"

Supprimer une version spécifique du serveur de mise à jour

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

Publier une nouvelle version sur la machine cliente

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

En fonction des exigences, les ID de produit suivants peuvent être utilisés dans les scripts :

IDProduit	Produit
FD97813F-44F7-45A0-BB55-0DAF0088F568	Assistant UiPath pour Mac (x64)
46C978F2-A5FE-4F71-AD88-D6A07118F790	Assistant UiPath pour Mac (arm64)
B69FDACF-6DD0-46FB-88C7-AF2D87CAF5AA	Bundle d'automatisation UiPath (UiPathStudio.msi)

Configuration du proxy

Pour les scénarios dans lesquels les Robots se trouvent derrière un proxy, pour que la fonctionnalité de mise à jour automatique fonctionne, une configuration supplémentaire peut être nécessaire. En fonction du type d’installation, les configurations de proxy peuvent être héritées des paramètres de proxy au niveau de l’utilisateur, ou définies manuellement en modifiant le fichier de configuration.

Important :

Both the Update Service on the client machine and the Update Server in Orchestrator must have access to https://download.uipath.com on port 443. The Update Service needs it to download the update files, while the Update Server in Orchestrator needs it to fetch the versions for the update policies.

Type d'installation	Déploiement du Robot	Service de mise à jour	Agent de mise à jour	Paramètres du proxy
Unattended Robot	Service Windows	Service Windows	S/O 1	À partir du fichier uipath.config .
Robot assisté (Attended Robot)	Exécutable au niveau utilisateur	Service Windows	Exécutable au niveau utilisateur	À partir du fichier uipath.config .
Installation rapide	Exécutable au niveau utilisateur	Exécutable au niveau utilisateur	Exécutable au niveau utilisateur	À partir des paramètres de proxy au niveau de l'utilisateur.

1 lorsque le Robot est installé en mode Unattended, l'agent de mise à jour n'est pas ajouté à la machine.

Collecte des journaux d'erreurs

When an update fails, you can use the Diagnostic Tool to collect logs which can be sent to our Support Team which are used for further investigation on the specific error.

Message d'erreur

Configuration de l'outil de diagnostic