Installation

Prérequis à l'installation

1. Ensure that you meet the Hardware and Software Requirements for Insights.

2. Install Orchestrator or modify an existing installation enabling the Insights feature.

3. Ensure that you have followed the Orchestrator instructions. This certificate must have both public and private keys and must be installed in the Trusted Root of the Insights machine.

4. Assurez-vous que le certificat Insights a été placé dans la machine Racine approuvée d'Orchestrator.

5. Lorsque vous spécifiez un nom d’hôte pour Insights, assurez-vous que le nom d’hôte désiré est résolvable dans votre DNS.

6. Vérifiez que le serveur où Insights sera installé peut communiquer avec le serveur où Orchestrator est installé et vice versa,

   Important :

   Il est préférable d’utiliser un certificat SAN SSL soumis à une autorité de certificat plutôt qu’un certificat autosigné.

   Les certificats auto-signés (et ceux de votre propre autorité de certification) doivent être installés dans la banque de certificats Racine approuvée et Personnel de la machine Insights. Le certificat doit également être marqué comme Exportable.

   Notez que lorsque vous utilisez un certificat auto-signé, vous pouvez rencontrer des problèmes au moment d'accéder à Insights via Firefox, Internet Explorer ou Edge.

Modification d’une installation d’Orchestrator pour insights

1. Dans le Panneau de configuration Windows, sélectionnez Ajouter ou supprimer des programmes.

2. Sélectionnez votre Orchestrator dans la liste, puis cliquez sur Modifier.

3. Suivez le programme d'installation à l'écran et sélectionnez la fonctionnalité Intégration d'Insights :

   

   Remarque :

   After installation is complete, you must also update your Host license to ensure the Insights feature is activated.

Installation d'Insights

1. Exécutez l'installateur UiPathInsightsInstaller.exe en tant qu’administrateur. L’Assistant d'installation UiPath Insights s’affiche.

2. Activez la case à cocher Cocher ici pour accepter le contrat de licence pour accepter les termes de l’accord, puis cliquez sur Suivant. La configuration du serveur Insights s’affiche.

   

3. Modifiez la configuration du serveur comme vous le souhaitez :

   • Nom d'hôte du site Web : permet d'identifier l'appareil sur lequel Insights est installé. Par défaut, il adopte le nom d'hôte de la machine, mais peut être modifié. Ce nom doit être résolvable depuis un serveur externe.

   • Port de site Web – le port à utiliser pour la communication Insights. Par défaut, il est défini sur 443 pour permettre l'utilisation de HTTPS.

   • Ajouter des règles de pare-feu pour ce port (Add firewall rules for this port) : si cette option est sélectionnée, des règles de pare-feu sont automatiquement ajoutées pour ce port afin de garantir la sécurité de la machine.

     Important :

     Insights utilise l'adresse IP de bouclage pour la communication entre différents services. Ces ports n'utilisent pas HTTPS. Pour empêcher les ports d'être accessibles depuis d'autres machines, assurez-vous donc que seul le port 443 est ouvert à la réception de connexions de sources externes (c'est-à-dire des adresses IP autres que 127.0.0.1).

   • Répertoire de construction d'Insights – lorsqu'il est défini, détermine le répertoire dans lequel les données d'Insights seront stockées après avoir été importées et intégrées dans le système.

     Important :

     Ce champ n’est pas requis si le serveur d’installation utilise le répertoire par défaut. Le répertoire ne peut pas être la racine du lecteur - D:\ ou avoir une barre oblique.

     Vérifiez à nouveau le chemin d’installation sélectionné. Le déplacement d’une installation vers un autre emplacement après l’installation n’est pas pris en charge.

   • Sujet du certificat SSL – le nom du sujet du certificat SSL que vous souhaitez utiliser pour sécuriser les connexions avec Insights. Par défaut, il est renseigné avec le nom d'ordinateur complet mais peut être modifié.

Remarque :

The SSL certificate subject must match the Website host name provided above. If using an existing certificate, it must be marked as exportable and be installed under the Local Machine Personal Certificate Store.

• Create Self Signed Cert - if selected, automatically creates a self-signed certificate with subject name specified above. For using Edge or Internet Explorer with self-signed certificates, see here.

  Important :

  Nous ne recommandons pas d’activer l’option Créer un certificat auto-signé (Create Self-Signed Cert) car il est préférable d’utiliser un certificat SAN SSL soumis à une autorité de certificat.

  Si vous utilisez également un certificat auto-signé sur votre machine Orchestrator, les certificats Orchestrator et Insights doivent être ajoutés à la racine approuvée dans les deux machines.

• E-mail – l’adresse e-mail de l’utilisateur local de l’administrateur Insights.

Remarque :

This must not match the email address of any user defined in Orchestrator.

• Mot de passe – le mot de passe de l'utilisateur local de l'administration Insights. Il doit comporter entre 8 et 20 caractères et contenir au moins 1 lettre majuscule, 1 lettre minuscule, 1 chiffre et 1 caractère spécial (!, @, #, $, %, ^, &, *).

  1. Cliquez sur Suivant. La configuration de la base de données Insights s’affiche.

     

  2. Remplissez les détails de la base de données comme suit :

• Nom du serveur de l'hôte : nom de la machine SQL Server sur laquelle se trouve la base de données Insights. Vous pouvez également spécifier un numéro de port personnalisé ici à l'aide de deux points, par exemple sql.uipath.com:1733.
• Database Name - the name of the Insights database specified when installing Orchestrator.
• Authentification Windows – si elle est sélectionnée, la connexion à Insights est effectuée à l’aide d’un compte de domaine. Consultez les étapes de configuration supplémentaires, ci-dessous.
• Authentification SQL – si elle est sélectionnée, la connexion à Insights est effectuée à l’aide de l’authentification SQL. Si vous utilisez cette option, les champs Nom d’utilisateur et mot de passe peuvent alors être modifiés et vous devez fournir le nom d’utilisateur et le mot de passe SQL utilisés pour vous connecter à la base de données.

  1. Cliquez sur Suivant. La configuration d'Orchestrator s'affiche.

     

  2. Fournissez les détails de connexion de votre instance Orchestrator comme suit :

• Point de terminaison Orchestrator – URL de votre Orchestrator.
• Nom d’utilisateur – nom d’utilisateur du locataire hôte. Par défaut, il est configuré sur admin et ne peut pas être modifié.
• Mot de passe – le mot de passe du compte administrateur hôte.

  1. Cliquez sur Suivant (Next). La configuration de la base de données Orchestrator s'affiche.

     

  2. Remplissez les détails de la base de données Orchestrator comme suit :

• Nom du serveur de l'hôte : nom de la machine SQL Server sur laquelle se trouve la base de données Orchestrator. Vous pouvez également spécifier un numéro de port personnalisé ici à l'aide de deux points, par exemple sql.uipath.com:1733.
• Database Name - the name of the Orchestrator database specified when installing Orchestrator.
• Authentification Windows – si elle est sélectionnée, la connexion est effectuée à l’aide d’un compte de domaine.
• Authentification SQL – si elle est sélectionnée, la connexion est effectuée à l’aide de l’authentification SQL. Si vous utilisez cette option, les champs Nom d’utilisateur et Mot de passe peuvent alors être modifiés et vous devez fournir le nom d’utilisateur et le mot de passe SQL utilisés pour vous connecter à la base de données.

  1. Cliquez sur Suivant (Next). La configuration du serveur de messagerie s'affiche.

     

     Remarque :

     Si vous ne configurez pas de serveur e-mail, aucune alerte ni notification par e-mail ne sera envoyée par Insights. Vous pouvez cependant ajouter une configuration de serveur de messagerie après l'installation à l'aide de la fonction Modifier de la fonctionnalité Ajouter ou supprimer des programmes.

  2. Si vous le souhaitez, configurez les notifications Insights de votre serveur de messagerie comme suit :

• Hôte SMTP – saisissez votre hôte SMTP.
• Port SMTP – saisissez votre port SMTP. Par défaut, il est défini sur 25 mais peut être modifié.
  
• Configuration TLS – utilisée pour définir les paramètres de sécurité du serveur de messagerie. Elle comprend les options suivantes :
  • Sécurisée – si elle est vérifiée, la connexion utilisera TLS.
  • Ignorer TLS – si cette option est sélectionnée (et que Securisé ne l'est pas), TLS ne sera pas utilisé. Sélectionnez cette option lorsque vous vous connectez à un serveur SMTP non sécurisé.
  • Requiert TLS – si sélectionné (et que **Securisé ne l'est pas), la connexion doit être mise à niveau vers TLS indépendamment de l'assistance du serveur de messagerie.
• Nom d'utilisateur SMTP – l'adresse électronique à partir de laquelle envoyer des e-mails.
• Mot de passe SMTP – le mot de passe de l'adresse e-mail utilisée ci-dessus.
• Adresse de l'expéditeur – l'adresse e-mail depuis laquelle les messages sont envoyés. Elle doit correspondre à celle fournie pour le nom d'utilisateur SMTP ci-dessus.
• Nom de l'adresse de l'expéditeur affiché (From Display Name) : un nom affiché pour l'adresse e-mail.
• Configuration avancée du serveur d'e-mail – il dispose des options suivantes :
  • Débogage – s’il est sélectionné, Insight enregistre alors l'intégralité du trafic SMTP. Ne doit être utilisé que pour le dépannage.
  • Enregistreur – si cette option est sélectionnée, Insights enregistre tous les événements (par exemple, la connexion au serveur).
  • Délai d’expiration de connexion – délai, en millisecondes, d’attente avant l'établissement de la connexion.
  • Délai d’accueil – délai, en millisecondes, d'attente avant la réception du message d’accueil après l'établissement de la connexion.
  • Délai d'expiration du socket : durée, en millisecondes, d'inactivité à autoriser.

    1. Cliquez sur Installer. Le processus d’installation démarre. Une fois terminé, cliquez sur Fermer pour quitter l’installateur.

       Important :

       Une fois l’installation d’Insights terminée :

       • Ensure the .NET Trust Level) of the Sisense app is set to Full.
       • Ouvrez le fichier consts.js situé dans le répertoire C:\Program Files\Sisense\app\query-proxy-service\src\common et définissez le paramètre HEALTH_CHECK_TIMEOUT sur 100000.

Configuration de l’authentification Windows

Si vous utilisez l’authentification Windows pour vous connecter à la base de données Insights (étape 4 ci-dessus), vous devez modifier les propriétés d’ouverture de session des services Sisense.CLRConnectorsContainer et Sisense.JVMConnectorsContainer comme suit :

Remarque :

Si le compte effectuant ce processus n'est pas celui utilisé lors de l'exécution de l'installateur Insights, assurez-vous qu'il fait partie du groupe d'administrateurs locaux.

1. Ouvrez le gestionnaire de services Windows.
2. Cliquez avec le bouton droit de la souris sur Sisense.CLRConnectorsContainer et sélectionnez Propriétés.
3. Dans l'onglet Connexion, sélectionnez le bouton radio Ce compte.
4. Saisissez le nom d'utilisateur et le mot de passe du compte utilisé pour vous connecter à la base de données SQL Insights et cliquez sur OK.
5. Répétez ce processus pour le service Sisense.JVMConnectorsContainer.
6. Redémarrez les deux services.

Configuration du locataire

Une fois Insights installé, vous devez ensuite l'activer pour le(s) locataire(s) souhaité(s) à l'aide de l'utilitaire UiPath.InsightsAdminTool.exe.

Important :

Chaque locataire activé déclenche un processus de « démarrage à chaud » qui récupère des données sur le nombre configuré de jours de renvoi dans la base de données Insights.

Selon le volume de données et les capacités matérielles, plusieurs heures peuvent s'écouler avant que toutes les données des locataires ne soient traitées et consultables dans Insights.

1. Sur la machine où Insights est installé, naviguez jusqu'au répertoire \Orchestrator\Tools. Par exemple, cd C:\Program Files (x86)\UiPath\Orchestrator\Tools.

2. Exécutez l'utilitaire UiPath.InsightsAdminTool.exe :

   

3. Dans le champ Utilisateur, entrez l'utilisateur admin du locataire Orchestrator host. Il s'agit de l'utilisateur admin par défaut et ne peut être modifié.

4. Saisissez le mot de passe du locataire d'Orchestrator host et cliquez sur Connexion. La fenêtre Sélectionner une fonctionnalité s'affiche.

   Important :

   Insights 20.10.0 has a minor known issue on the ROI Dashboard. Please visit the linked release notes for instructions on how to remedy this issue using Tenant Setup.

   

5. Sélectionnez Activer la fonction Insights des locataires. Une liste de tous les locataires s'affiche.

   

6. Pour chaque locataire, sélectionnez les options suivantes :

   • Insights activé – cochez cette case pour activer Insights dans le locataire sélectionné.

   • Langue du tableau de bord – langue souhaitée pour votre tableau de bord.

   • Replace Resources - Select Cube to delete and rebuild the Insights data cube, and Dashboards if you want to replace all OOTB included dashboards with new OOTB dashboards.

   • Accès au tableau de bord - Sélectionnez les rôles/groupes d’utilisateurs qui ont accès à Insights

     Tableaux de bord par défaut des options suivantes :

Tous – les tableaux de bord par défaut sont partagés avec tous les utilisateurs Insights.

Consommateurs - les tableaux de bord par défaut ne sont partagés qu’avec les utilisateurs qui ont des autorisations d’accès à Insights.

Éditeurs - les tableaux de bord par défaut ne sont partagés qu’avec les utilisateurs qui ont des autorisations de modification dans Insights.

Insights Admin - les tableaux de bord par défaut ne sont pas automatiquement partagés avec les utilisateurs d'Insights, mais l'utilisateur admin d'Insights les partage manuellement depuis le portail Insights.

• Renvoyer – cochez pour activer un renvoi de données historiques, et entrez le nombre de jours souhaité dans le champ de saisie.

  1. Cliquez sur Suivant. Une fenêtre d’avertissement s’affiche, cliquez sur OK pour procéder.

  2. Les locataires sont activés et votre installation est terminée.

     Important :

     By default, no custom tables will be created starting with this release. You must add processes and queues to an allowlist via the Manage Custom Tables option in the Admin Tool. The Manage Custom Tables page allows you to select which processes and queue tables you would like to add to the Insights Cube.

     For deployments where the desired number of process and queue tables exceeds the maximum number of 75 per tenant, enabling table grouping will allow the combination of multiple processes or queues into a single group table.

Ingestion de journal pour les déploiements qui ne sont pas en anglais

Pour les déploiements utilisant des données qui ne sont pas en anglais (y compris l’exécution de Robot ou Studio dans une langue autre que l’anglais), quelques modifications doivent être apportées afin de s’assurer que tous les journaux sont ingérés correctement :

Pour que les journaux historiques soient renvoyés pendant le démarrage à chaud :

1. Ouvrez le fichier UiPath.InsightsAdminTool.exe.config situé dans le répertoire C:\Program Files (x86)\UiPath\Orchestrator\Tools.
2. Trouvez la clé appelée « Insights.RobotLogsWarmStartupQueryCondition », et remplacez « execution ended » dans la valeur par la traduction appropriée dans la langue utilisée par votre déploiement.

Pour l’ingestion continue de journaux :

1. Ouvrez le fichier UiPath.Orchestrator.dll.config situé à C:\Program Files (x86)\UiPath\Orchestrator.
2. Trouvez la when condition appelée level, et remplacez execution ended par la chaîne appropriée traduite dans la langue utilisée par votre déploiement :

• de > Ausführung beendet
• fr > Exécution terminée
• es-ES > Ejecución finalizada
• es-MX > Ejecución terminada
• ja > の実行が終了しました。
• ko > 실행이 종료되었습니다.
• zh-CN > 执行结束
• pt-pt > Execução terminada
• pt-BR > A execução terminou
• tr > Yürütme işlemi bitti
• ko > Выполнение завершено

Exemples

• Anglais

  <logger name="Robot.*" ruleName="insightsRobotLogsRule" enabled="false" minlevel="Info" writeTo="insightsRobotLogs"><filters defaultAction="Ignore"><when condition="level >= LogLevel.Error or ends-with('${message}',' execution ended')" action="Log" /></filters></logger>
  

• Portugais (BR)

  <logger name="Robot.*" ruleName="insightsRobotLogsRule" enabled="false" minlevel="Info" writeTo="insightsRobotLogs"><filters defaultAction="Ignore"><when condition="level >= LogLevel.Error or ends-with('${message}',' A execução terminou')" action="Log" /></filters></logger>
  

Please note that any other string changes to thiswhen condition are not supported and may require a full product reinstall if implemented.

Résolution de la vulnérabilité log4j

Pour résoudre la vulnérabilité log4j, assurez-vous d'exécuter le correctif pour mettre à jour les dépendances vers la dernière version non vulnérable d'Apache Log4j.

For more information, see the UiPath Insights Advisory (Prior to version 2021.10) section in UiPath Security Advisory CVE-2021-44228, CVE-2021-45046 & CVE-2021-45105j.