À propos des bibliothèques

Une bibliothèque est un projet qui contient un ou plusieurs workflows qui peuvent être réutilisés comme activités dans d'autres projets. Les bibliothèques sont enregistrées en tant que fichiers NUPKG lors de leur publication et peuvent être installées en tant que dépendances à partir du Gestionnaire de packages (Package Manager).

Par exemple, vous pouvez créer une bibliothèque qui collecte des données à partir d'un tableur Excel et l'ajoute à une autre, comme cela est expliqué à la page Création d'une bibliothèque de base. Ensuite, vous pouvez empaqueter et utiliser la bibliothèque dans d'autres processus en tant qu'activité.

Création d'une bibliothèque

Accédez à Mode Backstage de Studio (Studio Backstage View) > Démarrer (Start) > Bibliothèque (Library. Cela ouvre la fenêtre Nouvelle bibliothèque vierge (New Blank Library).
Renseignez le nom et choisissez un emplacement pour la bibliothèque. C:\Users\<current_user>\Documents\UiPath est l’emplacement par défaut. Ajoutez une description, sélectionnez la compatibilité et le langage du projet, puis cliquez sur Créer (Create). La nouvelle bibliothèque est créée et enregistrée sur votre machine locale.
Remarque :
- Le nom de la bibliothèque ne peut pas dépasser 128 caractères et la description ne peut pas dépasser 500 caractères.
- N'utilisez pas lib comme nom de bibliothèque, car cela entraînerait une erreur de compilation dans les projets où la bibliothèque a été installée.
Le panneau Projet (Project) affiche l'arborescence avec le dossier Projet (Project), les dépendances et le NewActivity.xaml qui contient le workflow réel.

Chaque fichier de workflow dans une bibliothèque est disponible en tant qu'activité dans les projets où la bibliothèque est installée en tant que dépendance. Si vous souhaitez rendre un certain fichier privé, faites un clic droit dessus et sélectionnez Rendre privé (Make Private). Dans ce cas, le fichier est inclus dans le package de la bibliothèque, mais il n'est pas disponible en tant que composant réutilisable dans le panneau Activités (Activities).

Remarque : par défaut, les dépendances disponibles pour les nouvelles bibliothèques sont les mêmes que pour les nouveaux projets, avec la règle de runtime Version applicable la plus ancienne (Lowest Applicable Version).

Extraction d'un projet en tant que bibliothèque

Vous pouvez extraire n'importe quel projet d'automatisation de processus ou de test en tant que bibliothèque à réutiliser dans d'autres projets. Par exemple, vous pouvez convertir un projet d'automatisation de test pour utiliser ses modèles dans d'autres projets d'automatisation.

Ouvrez un projet dans Studio.
Dans le ruban Conception (Design), sélectionnez Exporter en tant que (Export As), puis Bibliothèque (Library).
Sélectionnez les workflows que vous souhaitez exporter en tant que bibliothèque. Par défaut, l'ensemble du projet est désélectionné, ainsi que les points d'entrée (Workflow principal et Cas de test).
Configurez les options d'extraction suivantes :
- Inclure les cas de test (Include Test Cases) : par défaut, cette option est activée pour un projet de processus et désactivée pour un projet d'automatisation de test. Vous devez activer cette option si vous souhaitez inclure des cas de test dans la bibliothèque extraite.
- Publish and install the library (Include Test Cases) : cette option est automatiquement sélectionnée pour publier le package dans un flux partagé et installe la bibliothèque en tant que dépendance du projet. Vous pouvez désactiver cette option si vous souhaitez créer la bibliothèque sans la publier. Si cette option est désactivée, les options restantes ne sont pas disponibles pour la configuration.
- Modifier vos workflows après l'installation du package (Alter your workflows after the package install) : choisissez de modifier les workflows avec des activités qui ont été compilées à partir de la bibliothèque.
- Mode de remplacement (Replacing Mode) : choisissez la méthode de remplacement du workflow.
  - Sélectionnez Remplacer le contenu des workflows appelés (Replace invoked workflows content) pour modifier les workflows appelés à partir du point d'entrée, ou les cas de test avec les activités correspondantes de la bibliothèque extraite.
  - Utilisez cette option si vous utilisez les propriétés Sessions isolées (Isolated Sessions) et Sessions cible (Target Sessions) pour que les activités Appeler le workflow (Invoke Workflow) s'exécutent dans un processus Windows distinct et démarrent dans une session différente, respectivement.
  - Sélectionnez Remplacer les activités Appeler le workflow (Replace Invoke Workflow activities) pour remplacer les activités Appeler le workflow (Invoke Workflow) par des activités de la bibliothèque extraite.
    
    Avertissement : ne sélectionnez pas cette option si vous utilisez les propriétés Sessions isolées (Isolated Sessions) et Sessions cibles (Target Sessions) pour les activités Appeler le workflow (Invoke Workflow).
- Supprimer les workflows remplacés (Delete replaced workflows) : supprimez les workflows qui ont été remplacés par les activités de bibliothèque extraites.
- Définir des modèles d'exécution depuis la bibliothèque (Set Execution Templates from library) : ajoutez des modèles d'exécution à la bibliothèque.
Cliquez sur Exporter (Export) pour confirmer les options de la bibliothèque.
Cliquez sur Créer (Create) pour terminer la création de la bibliothèque.
(Facultatif) Publiez la bibliothèque si vous avez sélectionné Publier et installer la bibliothèque (Publish and install the library) à l'étape 3, puis cliquez sur Publier (Publish).

Remarque : si vous n'avez pas activé l'option Publier et installer la bibliothèque (Publish and install the library), vous serez invité à ouvrir la bibliothèque ou à poursuivre le projet en cours.

Attention : le remplacement des workflows ou des activités invoquées à partir de la bibliothèque extraite n'aura pas lieu pour les workflows où des simulations sont utilisées.

Configuration de la mise en page d'une activité

Les arguments que vous définissez dans la bibliothèque deviennent des propriétés d'activité dans les projets où la bibliothèque est installée en tant que dépendance.

Pour configurer l'apparence et le comportement d'une activité lorsqu'elle est utilisée dans un projet, cliquez avec le bouton droit sur le fichier de workflow dans le panneau Projet de la bibliothèque, puis sélectionnez Mise en page de l'activité (Activity Layout). La fenêtre des propriétés de l'activité s'affiche avec différentes options en fonction de la compatibilité de la bibliothèque (Windows - Héritage (Windows - Legacy), Windows ou multiplate-forme).

Options pour les bibliothèques Windows et multiplate-forme

Sélectionnez Propriétés de l'activité (Activity Properties) dans le menu de gauche et saisissez les informations suivantes :

Nom affiché (Display name) : le nom de l'activité affiché dans le panneau Activités (Activities).
Info-bulle (Tooltip) : info-bulle visible lorsque vous survolez l'activité dans les panneaux Activités (Activities) et Concepteur (Designer) des projets dans lesquels la bibliothèque est installée.
Lien d'aide (Help Link) : le lien d'aide qui s'ouvre lorsque vous sélectionnez l'activité dans le panneau Concepteur (Designer) et appuyez sur la touche F1 de votre clavier.
Icône SVG (SVG Icon) : icône SVG à afficher à côté du nom de l’activité.
Couleur (Color) : la couleur de surbrillance affichée pour l'activité dans le panneau Concepteur (Designer).

Les arguments définis dans le fichier de workflow s'affichent sous Propriétés de l'activité (Activity Properties) dans le menu de gauche.

Pour personnaliser la propriété générée, sélectionnez-la et configurez les éléments suivants :
- Nom complet (Display name) : libellé qui apparaît dans l'activité pour la propriété.
- Info-bulle (Tooltip) : info-bulle visible lorsque vous survolez la propriété de l'activité.
- Type d'entrée (Input Type) : type d'entrée pour la propriété. Vous pouvez utiliser l'entrée par défaut pour le type de propriété ou sélectionner une option d'entrée en fonction du type :
  - Booléen (Boolean) : utilisez Par défaut, Activer/désactiver (par défaut), Générateur de conditions, Bouton radio.
  - Numérique (Numeric) (int, double, décimal, long, short, sbyte, byte, ulong, ushort, unit, float) : utilisez Par défaut, Éditeur de nombres, Liste déroulante. Pour Liste déroulante, dans le champ Valeurs (Values), saisissez chaque valeur séparément en appuyant sur la touche Entrée de votre clavier.
  - Chaîne (String) : utilisez Par défaut, Éditeur de texte (par défaut), Éditeur de texte enrichi, Liste déroulante, Remplissage automatique, Bouton radio. Pour Liste déroulante, Remplissage automatique et Bouton radio, dans le champ Valeurs (Values), saisissez chaque valeur séparément en appuyant sur la touche Entrée de votre clavier.
  - String[] : utilisez Par défaut, Tableau de chaînes.
  - Date et heure (Date Time) : utilisez Par défaut, Date et heure.
  - Période (Time Span) : utilisez Par défaut, Période.
  - Dictionnaire : utilisez Par défaut, Dictionnaire.
  - Tous les autres types : utilisez Par défaut, Entrée.
- Espace réservé (Placeholder) : texte de l'espace réservé à afficher pour l'entrée lorsqu'aucune valeur n'est sélectionnée.
- Obligatoire (Required) : indique si la propriété est requise.
- Avancé uniquement (Advanced Only) : indique si la propriété doit uniquement être affichée dans la section des options avancées de l'activité. Les propriétés de la section des options avancées peuvent également être organisées en catégories.
Pour ajouter une catégorie sous laquelle regrouper plusieurs propriétés associées, sélectionnez Nouvelle catégorie (New Category) dans le coin inférieur gauche de la fenêtre. Les catégories ne sont disponibles que dans la section des options avancées de l'activité générée et peuvent être développées ou réduites. Si une catégorie est vide, elle est supprimée lorsque vous cliquez sur Enregistrer (Save) pour fermer la fenêtre.
Pour modifier l'ordre des propriétés et des catégories, ou ajouter des propriétés aux catégories, faites glisser les éléments pour les déplacer dans la liste.

Options pour les bibliothèques Windows héritées

Sélectionnez Propriétés de l'activité (Activity Properties) dans le menu de gauche et saisissez les informations suivantes :

Info-bulle (Tooltip) : info-bulle visible lorsque vous survolez l'activité dans les panneaux Activités (Activities) et Concepteur (Designer) des projets dans lesquels la bibliothèque est installée.
Lien d'aide (Help Link) : le lien d'aide qui s'ouvre lorsque vous sélectionnez l'activité dans le panneau Concepteur (Designer) et appuyez sur la touche F1 de votre clavier.

Les arguments définis dans le fichier de workflow s'affichent sous Propriétés de l'activité (Activity Properties) dans le menu de gauche.

Pour personnaliser la propriété générée, sélectionnez-la et configurez les éléments suivants :
- Nom complet (Display name) : libellé qui apparaît dans l'activité pour la propriété.
- Info-bulle (Tooltip) : info-bulle visible lorsque vous survolez la propriété de l'activité.
- Obligatoire (Required) : indique si la propriété est requise.
- Avancé uniquement (Advanced Only) : indique si la propriété doit être affichée uniquement dans le panneau Propriétés (Properties). Si elle est sélectionnée, la propriété ne s'affiche pas dans le panneau Concepteur (Designer) de l'activité générée.
Pour modifier l'ordre dans lequel les propriétés sont affichées dans l'activité, faites-les glisser pour les déplacer dans la liste.
Remarque :
- Dans le cas de bibliothèques, il est recommandé d'utiliser Nothing pour attribuer une valeur nulle à une variable, plutôt que "". Cela sert à éviter les incohérences lors de l'utilisation de la bibliothèque empaquetée en tant que dépendance dans un projet.
- La propriété ImplementationVersion de l'objet System.Activities.ActivityBuilder n'est pas prise en charge. La définition d'une valeur pour cette propriété entraîne le non-enregistrement des arguments. Cet objet s'affiche dans le panneau Propriétés lorsque vous sélectionnez la zone vide du panneau Concepteur .

Ajuster les paramètres de la bibliothèque

Pour configurer les paramètres d'un projet de bibliothèque, ouvrez la fenêtre Paramètres du projet en cliquant sur Paramètres dans le panneau Projet.

Les options suivantes sont disponibles dans l'onglet Général :

Nom : modifiez le nom du projet.
Description : modifiez la description du projet.
URL Automation Hub : URL d'une idée Automation Hub liée au projet. Pour plus d'informations, consultez Lier un projet à une idée dans Automation Hub.
Icône de projet (Project Icon) : En option, définissez une icône personnalisée pour le projet. Vous pouvez parcourir et sélectionner un fichier, ou entrer un chemin ou une URL publique vers un fichier ico, jpeg, jpg, ou png d'une taille pouvant aller jusqu’à 1 Mo.

Une fois le projet publié, l’icône est affichée à côté du paquet dans la fenêtre Gérer les paquets (Manage Packages) dans Studio.
Compiler les expressions des activités (Compile activities expressions) : sélectionnez Oui (Yes) pour compiler et empaqueter toutes les expressions d'activités avec la bibliothèque. Vous réduisez ainsi le temps d'exécution. Disponible pour Windows - bibliothèques héritées uniquement.
Prêt à fonctionner (Ready to Run) - définissez sur Oui (Yes) pour optimiser les assemblys générés afin de bénéficier d'une compilation JIT plus rapide au moment de l'exécution. Disponible pour Windows - bibliothèques héritées uniquement.
Modern Design Experience : configurez sur Oui pour activer Modern Design Experience avec UI Automation, incluant des activités nouvelles et améliorées, des enregistreurs et des assistants, ainsi que le référentiel d’objets.

Publication d'une bibliothèque

La publication de bibliothèques est semblable à la publication de processus. Pour en savoir plus, consultez la section À propos de la publication de projets d'automatisation. Contrairement aux processus, la publication d'une bibliothèque crée deux fichiers NUPKG : un package de phase de conception et un package de runtime. Cela s'applique uniquement aux bibliothèques Windows et multiplate-forme si l'option Séparer les dépendances du runtime (Separate Runtime Dependencies) de Paramètres du projet (Project Settings) est activée.

Remarque :

En raison de la séparation entre les packages de phase de conception et de runtime, la compatibilité des bibliothèques personnalisées publiées dans Studio 2023.4 n’est pas garantie avec les versions antérieures de Studio.
Vous ne pouvez installer dans un projet que le package pour la phase de conception, car il est remplacé par le package de runtime lors de la publication. L’installation du package de runtime uniquement provoquera des problèmes inattendus dans Studio.

Limitations lors l'utilisation des bibliothèques

Lors de l'utilisation de bibliothèques, tenez compte des limitations suivantes :

En raison des limitations NuGet :
- Vous ne pouvez pas publier de bibliothèques à des emplacements contenant des sous-dossiers limités par l'utilisateur à l'aide de variables du chemin d'environnement Windows.
- Les notes de publication des bibliothèques publiées ne sont visibles que dans Orchestrator.
Les bibliothèques dont les noms des fichiers .xaml contiennent des caractères spéciaux peuvent ne pas être publiées avec succès.
Si une bibliothèque contient un fichier .xaml et un argument portant le même nom, la bibliothèque ne pourra pas être publiée.
Les projets de bibliothèque avec la compatibilité Windows - Legacy ne peuvent pas être publiés s'ils contiennent des activités Appeler le fichier de flux de travail (Invoke Workflow File) avec l'option Isolé (Isolated) sélectionnée. Un message d'erreur s'affiche dans le panneau Sortie (Output) lorsque vous essayez de publier. Cette limitation ne s'applique pas aux bibliothèques qui utilisent la compatibilité Windows ou multiplateforme.
Lorsque vous utilisez l'activité Invoke Workflow File, assurez-vous que le fichier invoqué se trouve dans le même dossier que le projet de bibliothèque.
L'activité Launch Workflow Interactive n'est pas prise en charge pour les bibliothèques.
L'utilisation de l'activité Invoke Workflow File dans une bibliothèque pour référencer la bibliothèque elle-même n'est pas prise en charge.
Si une bibliothèque contient une activité qui accepte un chemin de fichier comme entrée, pour vous assurer que le chemin est résolu correctement dans les projets où la bibliothèque est installée, ajoutez la constante globale UiPath.Emplacement.Projet.Constantes (UiPath.Constants.Project.Location) lors du référencement du chemin (utilisez cette casse exacte). Cette action désactive le remplacement de Environment.CurrentDirectory par le dossier de bibliothèque au début de l'exécution d'une activité de bibliothèque et utilise la constante à la place.

Par exemple, si un fichier nommé Employé.txt (Employee.txt) situé dans le sous-dossier DonnéesEntrée (InputData) du projet de bibliothèque est utilisé dans une activité Lire le fichier (Read File), indiquez le chemin d'accès comme suit :

UiPath.Constants.Project.Location+"InputData\Employee.txt"

Remarque : la constante ne doit pas être utilisée dans les activités Appeler le fichier de workflow (Invoke Workflow File) à l'intérieur des bibliothèques.
Pour référencer un emplacement dans le dossier du projet où une bibliothèque est installée, indiquez en tant qu'argument le chemin d'accès à la bibliothèque.

Ajout de composants réutilisables aux projets d'automatisation

Ouvrez et créez un projet.
Sous la catégorie Tous les paquets (All Packages), sélectionnez le flux sous lequel la bibliothèque est enregistrée et installez le paquet.
Sélectionnez OK, et le paquet est ajouté à la définition du projet.
L'activité est disponible dans la catégorie personnalisée du panneau Activités (Activities).

Considérations relatives à l'installation de bibliothèques dans les projets

Les bibliothèques avec la compatibilité multiplate-forme peuvent être installées dans des projets multiplate-forme et Windows. Les bibliothèques Windows - Héritage (Windows - Legacy) et Windows ne peuvent être installées que dans des processus ayant la même compatibilité.
Des erreurs peuvent se produire lorsque vous exécutez un projet contenant des activités personnalisées depuis une bibliothèque créée dans une version de Studio antérieure à 2019.10.1 et publiée à partir de la version 2019.10.1 de Studio ou ultérieure. Dans ce scénario, vous devez recréer et republier la bibliothèque.
Lorsque vous utilisez Importer des workflows (Import Workflows) pour ajouter un workflow qui contient une bibliothèque dans un projet de bibliothèque, les dépendances référencées dans la bibliothèque ne seront pas importées.
Lors de l’importation de deux versions d’une même bibliothèque personnalisée dans un projet, les activités personnalisées supplémentaires contenues uniquement dans la deuxième bibliothèque ne sont pas visibles dans le panneau Activités (Activities), sauf si vous supprimez la première bibliothèque importée.
L'utilisation de points (.) dans le nom de la bibliothèque permet de séparer la bibliothèque en différents groupes imbriqués lorsque vous l'afficher dans le panneau Activités.