Variables personnalisées

Insights ingère toujours les données via les champs prédéfinis disponibles dans le modèle de données Insights, mais les administrateurs peuvent également configurer des variables personnalisées extraites des journaux et des files d'attente du robot à utiliser pour calculer des ICP spécifiques ou créer des tableaux de bord plus spécialisés.

Astuce :

1. Pour inclure des variables personnalisées pour les processus, vous devez d'abord vous assurer qu'elles sont ajoutées aux journaux de votre automatisation via l'activité UiPath.System.Activities.AddLogFields dans Studio, puis vous devez les sélectionner pour l'ingestion.
   • Les variables personnalisées de processus seront envoyées avec les journaux de robot par défaut (le processus a démarré/terminé) et tout message écrit avec l'activité Consigner le message (Log Message). Si aucune variable n'est renseignée, veillez à écrire une activité de message de journal.
2. Pour inclure des variables personnalisées pour les files d'attente, vous devez d'abord vous assurer qu'elles sont ajoutées aux workflows via une activité dans Studio, puis les sélectionner pour l'ingestion
   • Utilisez l'activité UiPath.System.Activities.AddQueueItem pour les données spécifiques (Specific Data) ;
   • Utilisez l'activité UiPath.System.Activities.SetTransactionStatus pour les données de sortie (Output Data) et les données analytiques (Analytics Data).
3. La désactivation des variables personnalisées peut casser les tableaux de bord existants référençant les variables.
4. Si vous avez déjà ajouté les champs personnalisés dans l'activité Ajouter un élément de file d'attente (Add Queue Item), vous devez uniquement désigner un élément de transaction comme Réussi (Successful) ou Échoué (Failed), et vous n'avez pas besoin de remplir les propriétés DonnéesSortie (OutputData) ou DonnéesAnalytics (AnalyticsData). Si vous n'avez pas spécifié les champs dans l'activité Ajouter un élément de file d'attente (Add Queue Item), ils doivent être ajoutés dans l'activité Définir l'élément de transaction (Set Transaction Item) lors de la configuration du statut.

Utilisation de variables personnalisées dans les tableaux de bord au niveau de l'organisation

Lorsque vous utilisez des variables personnalisées dans des tableaux de bord à l'échelle de l'organisation, tenez compte des points suivants :

• Seules les variables personnalisées extraites de la fenêtre Configurer la variable personnalisée (Configure Custom Variable) de la vue Locataire s'afficheront dans la section de configuration des variables personnalisées au niveau de l'organisation. Aucune variable personnalisée non extraite du locataire ne s'affichera dans les tableaux de bord au niveau de l'organisation.
• Lors de la modification des variables personnalisées au niveau du locataire, les variables personnalisées au niveau de l'organisation seront désactivées dans l'organisation. Veillez à bien les réactiver une fois que toutes les modifications auront été effectuées, afin qu'elles s'affichent sur les tableaux de bord.
• Les sections variables personnalisées et ROI sont en lecture seule.

Configuration des variables personnalisées

Pour configurer des variables personnalisées, un administrateur doit suivre les étapes suivantes :

1. Ouvrez le menu à 3 points dans le coin supérieur droit de n'importe quelle page Insights et sélectionnez Configurer les variables personnalisées (Configure Custom Variables). La page de configuration s'ouvre, répertoriant tous les champs personnalisés disponibles pour l'extraction.
2. Décidez si vous souhaitez configurer des variables personnalisées pour les processus ou les files d'attente en cliquant sur l'onglet correspondant en haut de la page de configuration.
   Remarque : vérifiez les limites des variables personnalisées mises en évidence dans le coin supérieur droit. Si vous vous rapprochez de la limite, envisagez de définir davantage de variables personnalisées comme courantes afin qu'elles puissent être utilisées dans tous les processus ou toutes les files d'attente.
   
   

   

   
   
3. Dans la colonne Extraire (Extract), choisissez les variables personnalisées que vous souhaitez utiliser lors de la création de tableaux de bord.
4. Dans la colonne Type, sélectionnez le type de variable personnalisée. Vous pouvez choisir Chaîne (String), Nombre (Number) ou DateHeure (DateTime).
   Important :

   • Les champs sont limités à 40 caractères et tous les caractères après ce nombre seront coupés. Pour ajouter plus de 40 caractères, modifiez l'indicateur Insights.Etl.Json.MaxStringLen . Vous pouvez ajouter cet indicateur dans la configuration Web d'Orchestrator et définir la valeur en fonction des besoins de votre projet. Par exemple :

   <add key="Insights.Etl.Json.MaxStringLen" value="60" />

   • Le pourcentage de renvoi indique la progression de l'extraction d'une variable personnalisée à partir de tous les processus ou files d'attente. Vous devrez actualiser la page pour voir le dernier pourcentage de renvoi. Cela peut prendre un certain temps en fonction de la taille des données. Les valeurs des variables personnalisées renverront les données des plus récentes aux plus anciennes. Le champ sera utilisable peu de temps après l'enregistrement de la configuration, vous n'aurez pas besoin d'attendre le renvoi à 100 %.
   • Vous pouvez extraire des variables d’un maximum de 235 processus ou files d’attente et un maximum de 235 variables pour chaque processus ou file d’attente.
   • Si vous configurez le Type d'une variable personnalisée sur Nombre (Number), assurez-vous qu'elle ne contient pas de , ou d'autres caractères non numériques tels que $ car ces caractères ne sont pas pris en charge. Pour les nombres avec des caractères spéciaux, veuillez sélectionner le type Chaîne (String).
   • Chaque modification de la configuration des variables personnalisées entraînera un nouveau renvoi complet pour ce processus spécifique. L'heure du renvoi dépend du nombre de journaux stockés dans la base de données Insights pour ce processus spécifique.

5. Enregistrez la configuration. Toutes les variables extraites pour un processus spécifique doivent apparaître dans une exploration nommée *Processus - NomProcessus (Process - ProcessName), et toutes les variables extraites pour une file d'attente spécifique doivent apparaître dans une exploration nommée *File d'attente - NomFileAttente (Queue - QueueName).

   Important: Vous pouvez extraire des variables d’un maximum de 235 processus ou files d’attente et un maximum de 235 variables pour chaque processus ou file d’attente.

   Nombre de variables personnalisées configurées	Échelle matérielle	Nombre de processus	Nombre de journaux de Robot par processus	Durée approximative de l'extraction
   30	Grande échelle	1	1 000 000	5 minutes
   30	Grande échelle	1	40 000 000	120 minutes

Modification d'une configuration existante

Pour modifier une configuration existante, un administrateur doit suivre les étapes suivantes :

1. Ouvrez le menu à 3 points dans le coin supérieur droit de n'importe quelle page Insights et sélectionnez Configurer les variables personnalisées (Configure Custom Variables). La page de configuration s'ouvre, répertoriant tous les champs personnalisés disponibles pour l'extraction.
2. Décidez si vous souhaitez configurer des variables personnalisées pour les processus ou les files d'attente en cliquant sur l'onglet correspondant en haut de la page de configuration.
3. Pour supprimer des variables précédemment sélectionnées, décochez la case Extraire (Extract).
4. Pour supprimer l'état Commun (Common) d'une variable, décochez la case dédiée.
5. Pour modifier le type d'une variable, sélectionnez le nouveau type souhaité dans la liste déroulante.
6. Assurez-vous d'enregistrer la configuration.
7. Effectuez les vérifications suivantes sur les tableaux de bord existants qui utilisaient une variable modifiée ou supprimée :
   1. Si vous avez supprimé la variable, assurez-vous de supprimer toutes les références à la variable des formules qui ont été créées ou modifiées, des filtres, ou à l'intérieur des visualisations ;
   2. Si vous avez modifié le type de variable, assurez-vous que le nouveau type s'applique toujours correctement ;
   3. Si la variable n'a plus le statut Commun (Common), vous devez remplacer la référence à la variable commune par la valeur par processus mise à jour.

Exemple de configuration

Cette section fournit un exemple d'utilisation d'une variable personnalisée dans un tableau de bord.

Dans l'image suivante, la variable ProcessCount est présente dans plusieurs processus tandis que la variable Argument1_Email n'apparaît que dans un seul processus.

Suivez les étapes suivantes pour configurer les variables personnalisées :

1. Sélectionnez la variable ProcessCount pour l'extraction et choisissez le type String. Marquez la variable comme commune afin que vous obteniez sa valeur dans tous les processus dans lesquels elle apparaît.

2. Activez la variable Argument1_Email et sélectionnez le type String. Étant donné que cette variable n'apparaît pas dans plusieurs processus, vous ne devez pas sélectionner Commun (Common). Cliquez sur Enregistrer (Save).

   
   

   

   
   
3. Revenez à Tableaux de bord (Dashboards), créez un nouveau tableau de bord et ajoutez une nouvelle vignette.

4. Choisissez l'explorateur Journaux du Robot (Robot Logs) pour voir les variables personnalisées déjà configurées.

   Étant donné que vous avez sélectionné Common pour ProcessCount, vous pouvez voir qu'il n'y a pas de préfixe de nom de processus car il a été ajouté au modèle de données standard. Contrairement à ProcessCount, vous n'avez pas sélectionné Common pour Argument1_Email ; le champ personnalisé a donc été ajouté en tant que Log_Email.Argument1_Email.

   
   

   

   
   

Variables personnalisées Null Cases

Les variables personnalisées peuvent avoir une valeur null dans certains cas particuliers, comme décrit dans les sections suivantes.

Scénario 1

Si vous utilisez un champ du modèle de données standard dans une visualisation associée à un champ de variable personnalisé spécifique au processus et qu'un processus ne contient pas la variable personnalisée dans les journaux du robot, la valeur de tous les champs associés au processus qui ne contient pas la variable personnalisée dans ses journaux de robot est null.

Il existe deux manières d'éliminer les valeurs null pour ce scénario :

Option 1 : ajoutez la variable personnalisée en tant que filtre et définissez la condition sur is not null

Option 2 : définissez un filtre pour le nom du processus qui inclut la variable personnalisée. Notez, cependant, que si vous adoptez cette approche, vous pouvez rencontrer le deuxième scénario ci-dessous.

Scénario 2

Si une variable personnalisée n'est pas présente dans tous les journaux générés par un processus, les journaux qui ne contiennent pas de valeur pour cette variable personnalisée afficheront la valeur de la variable comme étant une valeur null.

L'exemple suivant illustre ce cas particulier.

1. Accédez à Configurer les variables personnalisées (Configure Custom Variables). Vous pouvez voir que le champ de variable personnalisée Argument1_Email n'apparaît que dans le processus Log_Email. Étant donné que Argument1_Email est un champ de variable personnalisé spécifique au processus, laissez Common non sélectionné.

   
   

   

   
   
2. Ouvrez un tableau de bord nouveau ou existant et ajoutez une vignette.
3. Accédez à l'exploration des journaux du robot. Sélectionnez le champ Nom du processus et le champ de variable personnalisée. Dans ce cas, le champ de variable personnalisé est Log_Email.Argument1_Email.

4. Cliquez sur Exécuter (Run). Les résultats que vous voyez devraient être similaires à ceux illustrés dans la capture d'écran suivante.

   
   

   

   
   

Pour éliminer les valeurs null, ajoutez le champ de variable personnalisé en tant que filtre. Enfin, définissez la condition sur is not null, afin de pouvoir supprimer les valeurs de type null de la visualisation.

Remarque : Ces deux cas se produisent lorsque vous affichez les données brutes du champ personnalisé. Lorsque vous appliquez une fonction (Somme, Moyenne, etc.) aux variables personnalisées, vous excluez les valeurs null.

Dépannage et limitations

Consultez notre section Résolution des problèmes (Troubleshooting) pour plus d'informations sur le dépannage et les limitations.