Guide de l'utilisateur de la place de marché UiPath

Dernière mise à jour 5 sept. 2024

Contenus

Structure de votre accélérateur de solution

Votre accélérateur de solution doit se conformer à la structure de dossiers suivante pour maintenir une expérience cohérente dans tous les accélérateurs de solution. Il peut comprendre quatre dossiers :

Déploiement (si l'expérience utilisateur est Attended, comme la gestion des données de test, cela peut ne pas être inclus)
Documentation
Bibliothèques (si le processus n'inclut aucune bibliothèque, elle peut ne pas être incluse)
Processus (Processes)

Bien que certains éléments soient cohérents dans chaque accélérateur de solution (tels que la structure des dossiers), votre accélérateur de solution peut être influencé par le cas d'utilisation spécifique et les produits UiPath utilisés dans l'accélérateur de solution. Le tableau ci-dessous présente les éléments les plus cohérents de chaque accélérateur de solution :

Déploiement	Documentation	Bibliothèques	Processus (Processes)
Détails de l'actif Détails de la file d'attente Package de gestion de solutions Tous les fichiers NUPKG de la bibliothèque Toutes les activités personnalisées supplémentaires	Accélérateur de solution : Présentation de l'accélérateur Accélérateur de solution : Guide de déploiement Accélérateur de solution : documentation technique Conception de solution de haut niveau (.pdf et fichier d’édition original tel que .vsdx) Conception détaillée de solution (.pdf et fichier d’édition original tel que .vsdx)	Sous-dossiers individuels pour chaque bibliothèque	Sous-dossiers individuels pour chaque processus

2. Dossier de déploiement

a. Détails de l'actif

Les ressources représentent des variables ou des informations d’identification partagées qui peuvent être utilisées dans différents projets d'automatisation au sein d'un accélérateur de solution. Les Détails de la ressource (Asset Details) sont un fichier de classeur Microsoft Excel (.xlsx) compatible avec Orchestrator Manager, un outil qui exploite l'API d'Orchestrator pour manipuler les entités. Ce classeur permet aux utilisateurs de voir et d'ajouter facilement des ressources utilisées dans votre accélérateur de solution.

Selon l'exemple ci-dessous, ce classeur doit avoir deux feuilles : Créer (Create) pour créer des ressources Texte, Booléen (Bool) et Entier (Integer) et Créer des informations d'identification ( Create Credential ) pour créer des ressources d'identification. Les en-têtes nécessaires et l'ordre des en-têtes pour chaque feuille, ainsi que les informations à l'intérieur de chaque ligne, sont définis dans les tableaux ci-dessous.

Nom du dossier¹	Nom de la ressource¹	^Description1	Étendue¹	Nom du robot ou nom d'utilisateur de l'utilisateur¹	Type¹	Valeur¹	ID de ressource²	Résultat²
Traitement des bons de commande	`Dispatcher_PurchaseOrdersEmailsSourceAccount`	La boîte aux lettres où se trouvent les e-mails de document PurchaseOrders que nous devons traiter.	Global		Texte	À Remplacer par une valeur spécifique

¹⁾ La colonne reçoit l'entrée de l'opération : telles que les noms, les types et les valeurs des ressources à créer.

²⁾ Colonne utilisée par le gestionnaire d'Orchestrator pour écrire les données récupérées à partir d'Orchestrator, telles que les ID des ressources créées. Les valeurs ici seront écrasées lors de la prochaine opération Créer (Create)/Créer des informations d’identification (Create Credential ).

Créer (Create)

Nom du dossier¹	Nom de la ressource¹	^Description1	Étendue¹	Nom du robot¹ ou nom d’utilisateur de l’utilisateur¹	Type¹	Valeur¹	ID de ressource²	Résultat²
Lorsque vous indiquez les noms des sous-dossiers des dossiers modernes, il est nécessaire de saisir le nom complet du dossier parent, y compris ses ancêtres, séparés par la barre oblique (/). Exemple : si un dossier moderne appelé « WorkGroup1 » est un sous-dossier d'un dossier moderne appelé « DepartmentA », le nom complet de WorkGroup1 est « DepartmentA/WorkGroup1 ».	Le nom de l'actif. Le nom doit contenir 256 caractères maximum.	Description de l'actif. La description doit avoir un maximum de 250 caractères.	Le champ Étendue (Scope) a un nombre fixe de valeurs possibles, en fonction des étendues de ressource disponibles dans Orchestrator : Global Robot (uniquement disponible dans les dossiers classiques) Utilisateur (uniquement disponible dans les dossiers modernes).	Lors de la création d'actifs par robot, utilisez le champ Nom du robot (Robot Name) ou Nom d'utilisateur de l'utilisateur (User's Username) pour spécifier le nom du robot qui doit avoir accès à la valeur de l'actif en cours de définition. Le robot doit être dans le même dossier que l' actif par robot créé. Les valeurs de plusieurs Robots doivent être spécifiées dans des lignes distinctes avec le même nom de dossier, le même nom de ressource, la même étendue et le même type.	Le champ Type a un nombre fixe de valeurs possibles, en fonction des types de ressources disponibles dans Orchestrator : Texte Bool Entier	La valeur de la ressource. Si les valeurs de ressources doivent être définies par l’utilisateur, elles doivent être écrites sous la forme « À Remplacer par une valeur spécifique ». Ce champ doit avoir : un maximum de 1 000 000 caractères pour les types de texte une valeur comprise entre 2147483648 et 2147483648 pour les types entiers une valeur de VRAI ou FAUX pour les types Booléen.	L'ID de l'actif créé si l'actif est créé avec succès.	Le résultat de la création de l'actif (Asset) : réussite ou échec.

¹⁾ La colonne reçoit l'entrée de l'opération : telles que les noms, les types et les valeurs des ressources à créer.

Créer des identifiants

Nom du dossier¹	Nom de la ressource¹	^Description1	Étendue¹	Nom du robot ou nom d'utilisateur de l'utilisateur¹	Nom d'utilisateur¹	Mot de passe¹	ID de ressource²	Résultat²
Lorsque vous indiquez les noms des sous-dossiers des dossiers modernes, il est nécessaire de saisir le nom complet du dossier parent, y compris ses ancêtres, séparés par la barre oblique (/). Exemple : si un dossier moderne appelé « WorkGroup1 » est un sous-dossier d'un dossier moderne appelé « DepartmentA », le nom complet de « WorkGroup1 » est « DepartmentA/WorkGroup1 ».	Le nom de l'actif. Le nom doit contenir 256 caractères maximum.	Description de l'actif. La description doit avoir un maximum de 250 caractères.	Le champ Étendue (Scope) a un nombre fixe de valeurs possibles, en fonction des étendues de ressource disponibles dans Orchestrator : Global Robot (uniquement disponible dans les dossiers classiques) Utilisateur (uniquement disponible dans les dossiers modernes).	Lors de la création d'actifs par robot, utilisez le champ Nom du robot (Robot Name) ou Nom d'utilisateur de l'utilisateur (User's Username) pour spécifier le nom du robot qui doit avoir accès à la valeur de l'actif en cours de définition. Le robot doit être dans le même dossier que l' actif par robot créé. Les valeurs de plusieurs Robots doivent être spécifiées dans des lignes distinctes avec le même nom de dossier, le même nom de ressource, la même étendue et le même type.	Le champ Nom d'utilisateur. Comme cela est fourni par les utilisateurs finaux, ce champ doit toujours contenir "À Remplacer par une valeur spécifique" dans chaque ligne.	Le champ Mot de passe. Comme cela est fourni par les utilisateurs finaux, ce champ doit toujours contenir "À Remplacer par une valeur spécifique" dans chaque ligne.	L'ID de l'actif créé si l'actif est créé avec succès.	Le résultat de la création de l'actif (Asset) : réussite ou échec.

¹⁾ La colonne reçoit l'entrée de l'opération : telles que les noms, les types et les valeurs des ressources à créer.

b. Détails de la file d'attente

La file d'attente est un conteneur qui vous permet de contenir un nombre illimité d'éléments. Les files d'attente peuvent stocker plusieurs types de données, telles que les informations sur les factures ou les coordonnées des clients. Les files d'attente permettent de créer de gros projets d'automatisation, tels que des accélérateurs de solution, mis en évidence par la logique complexe.

Les Détails de la file d'attente (Queue Details) sont un fichier de classeur Microsoft Excel (.xlsx) compatible avec Orchestrator Manager, un outil qui exploite l'API d'Orchestrator pour manipuler les entités. Ce classeur permet aux utilisateurs de voir et d'ajouter facilement des files d'attente utilisées dans votre accélérateur de solution

Selon l'exemple ci-dessous, ce classeur doit avoir une feuille : Créer (Create) pour créer toutes les files d'attente. Les en-têtes nécessaires et l'ordre des en-têtes pour la feuille, ainsi que les informations à l'intérieur de chaque ligne, sont définis dans le tableau ci-dessous. Les colonnes d'en-tête orange reçoivent une entrée de l'opération, telle que les noms, la description et le nombre maximal de nouvelles tentatives de files d'attente à créer. Les colonnes à en-tête gris sont utilisées par le gestionnaire d'Orchestrator pour écrire les données récupérées à partir d'Orchestrator, telles que les ID des files d'attente créées. Les valeurs ici seront écrasées lors de la prochaine opération Create.

FolderName	Nom de la file d'attente	Description	Unique Reference	Nouvelle tentative automatique (Auto Retry)	Max # of Retries	ID de ressource	Résultat
Lorsque vous indiquez les noms des sous-dossiers des dossiers modernes, il est nécessaire de saisir le nom complet du dossier parent, y compris ses ancêtres, séparés par la barre oblique (/). Exemple : si un dossier moderne appelé « WorkGroup1 » est un sous-dossier d'un dossier moderne appelé « DepartmentA », le nom complet de WorkGroup1 est « DepartmentA/WorkGroup1 ».	Le nom de la file d'attente. Le nom ne peut pas comporter d'espaces. Le nom doit contenir 50 caractères maximum.	Description de la file d'attente. La description doit avoir un maximum de 250 caractères.	Oblige les transactions à avoir des références uniques. Doit être Oui (Yes) ou Non (No).	Permet de retenter automatiquement un élément de transaction de la file d'attente qui échoue avec une exception système. Doit être Oui (Yes) ou Non (No).	Le nombre maximum de tentatives pour un élément de transaction dans la file d'attente. Doit être au moins 1 si Nouvelle tentative automatique est Oui. Il peut s'agir d'un entier compris entre 1 et 50.	L'ID de la file d'attente créée si la file d'attente est créée avec succès.	Le résultat de la création de la file d'attente – réussite ou échec.

c. Package de gestion des solutions

Un accélérateur de solution est un ensemble de plusieurs composants (processus, ressources, files d'attente, etc.) développés sur la plate-forme UiPath, qui fonctionnent ensemble pour automatiser un cas d'utilisation métier. UiPath Solutions Management fournit des moyens prêts à l'emploi pour gérer le cycle de vie des composants de l'accélérateur de solution une fois qu'ils ont été créés. Cet ensemble de fonctionnalités entre en jeu une fois que le développement de votre accélérateur de solution est terminé, et que vous souhaitez facilement promouvoir ses composants dans un nouvel environnement.

Solutions Management vous permet de regrouper facilement ces composants en un seul fichier dans l'environnement Orchestrator sur lequel l'accélérateur de solution a été développé. Pour obtenir un guide sur la création d'un package de gestion de solutions, consultez la page Création d'un projet de solution.

Certaines exigences et considérations lors de la création d'un package de gestion de solutions pour votre accélérateur de solution :

Toutes les ressources qui sont des informations d’identification doivent contenir un champ Nom d'utilisateur et mot de passe qui ont des valeurs de « À Remplacer par une valeur spécifique » car celles-ci sont fournies par les utilisateurs finaux.
Toutes les ressources spécifiques à l'utilisateur final, telles que les adresses e-mail de destination ou les URL d'environnement, doivent également avoir les valeurs de « REPLACER PAR VALEUR SPÉCIFIQUE ».
La convention de nommage du fichier compressé de gestion de solution doit être « Nom de l'accélérateur de solution 1.0.0 » où Nom de l'accélérateur de solution (Solution Accelerator Name) est le nom de l'accélérateur de solution et où 1.0.0 est la version du projet de solution pour le zip de gestion des solutions.
Tous les compartiments de stockage et déclencheurs seront inclus dans le zip de gestion de solution. Les compartiments de stockage et les déclencheurs ne peuvent pas être inclus dans les déploiements manuels et doivent être indiqués comme étant créés manuellement dans la documentation du Guide de déploiement.
Les processus ne doivent PAS être inclus dans le zip de gestion de solution. Les processus ne sont pas censés fonctionner immédiatement sans modification de l’environnement et des améliorations spécifiques aux procédures apportées à un accélérateur de solution.
Si une bibliothèque personnalisée doit être modifiée, quelle que soit la raison, elle ne doit pas être incluse dans le package de gestion des solutions, car elle ne fonctionnera pas immédiatement sans modification.

ré. Fichiers NUP de la bibliothèque

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. Cela permet à votre accélérateur de solution d'utiliser un code commun tout au long de chaque processus. Pour plus d'informations sur la création d'une bibliothèque, consultez la section Création d'une bibliothèque dans la documentation de la bibliothèque. Pour plus d'informations sur les normes de développement relatives à la création d'une bibliothèque pour les accélérateurs de solution, consultez la section développement de la bibliothèque. Une bibliothèque est enregistrée en tant que fichier NUPKG lors de sa publication et peut être installée en tant que dépendance à partir du Gestionnaire de packages (Package Manager). Vous pouvez soit publier une bibliothèque dans un dossier local, soit publier et télécharger à partir du flux de packages NuGet pour récupérer le fichier NUPKG pertinent.

Important :

Si une bibliothèque réutilisable est conçue pour être prête à l'emploi sans qu'aucune modification soit nécessaire, incluez-la dans le dossier Déploiement (Deployment).

Si la bibliothèque doit être modifiée pour fonctionner correctement dans le projet, elle n'est pas censée être incluse dans le dossier de déploiement et le guide de déploiement doit indiquer clairement que la bibliothèque doit être modifiée, publiée et que les dépendances sont mises à jour dans tout projet à l'aide de cette bibliothèque.

Si une bibliothèque réutilisable est publiée séparément sur un flux, tel que UiPath Solution Accelerators Generic Reusables, vous n'avez pas besoin d'inclure le fichier NUPKG.

e. Toutes les activités personnalisées supplémentaires

Vous pouvez créer vos propres activités personnalisées qui peuvent être utilisées dans les projets UiPath Studio. Pour utiliser les activités personnalisées créées, vous devez installer le package NuGet qui le contient dans le ou les projets accélérateurs de solution en accédant au Gestionnaire de packages (Package Manager) à partir d'UiPath Studio et en installant le NUPKG. Ce package NuGet doit être créé une fois l'activité personnalisée terminée . Le NUPKG peut être inclus dans le dossier de déploiement de l' accélérateur de solution.

3. Documentation

La structure de la documentation doit suivre les directives ci-dessous :

Accélérateur de solution : Présentation de l'accélérateur
Accélérateur de solution : Guide de déploiement
Accélérateur de solution : documentation technique
Conception de solution de haut niveau (.pdf et fichier d’édition original tel que .vsdx)
Conception détaillée de solution (.pdf et fichier d’édition original tel que .vsdx)

4. Bibliothèques

Une bibliothèque UiPath 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). Une bibliothèque ne peut être développée qu'à l'aide d'un projet de type Bibliothèque (Library). Tous les composants d'IU réutilisables doivent également être implémentés dans une bibliothèque à l'aide du référentiel d'objets. Toute entité Data Service doit être importée dans une bibliothèque afin que la même référence/espace de noms puisse être utilisée dans l'ensemble de l'accélérateur de solution en important une bibliothèque. En important le dans une bibliothèque, les espaces de noms ne seront pas en conflit à travers les différents processus.

Une bibliothèque a les exigences suivantes :

Type de projet	Projets de bibliothèques
Conventions relatives à la taille du processus et à l'affectation de noms du workflow	XAML petits et bien définis Nommage : utilisez un nom "Capturer chaque mot en majuscules" (espaces entre) et pas PascalCase. Si PascalCase est préféré pour les workflows, la convention « Capturer chaque mot » (restauration des espaces du nom de l'activité) peut toujours être effectuée via le champ « Nom complet » de l'activité « Mise en page de l'activité » (option de menu Workflow dans l'explorateur de projets ).
Annotations	Ajouter des annotations épinglées sur chaque fichier de workflow en tant que clause de non-responsabilité/explication Annoter les activités avec une explication descriptive appropriée
Conventions d'affectation de noms des variables	Minuscule mixte (par exemple, firstName, lastName, myOrganizationStructure)
Conventions d'affectation de noms des arguments	Les arguments doivent être nommés en utilisant la norme PascalCase . Le nom des arguments ne doit PAS contenir le préfixe in_/out_/io_ car ces arguments apparaîtront comme des propriétés lors de la création de la bibliothèque. Les annotations doivent exister pour chaque argument, car il s'affiche lorsqu'une activité de bibliothèque est utilisée
Résultats de l’argument	Un workflow de bibliothèque doit fonctionner car le nom du workflow est décrit Un workflow doit analyser n'importe quel résultat d'API ou GUI et renvoyer le résultat de données spécifiques
Commentaires	Ajouter des commentaires pour améliorer la lisibilité des projets de bibliothèques
Entité de Data Service	Les entités Data Service peuvent être importées dans une bibliothèque. L'espace de noms doit être le nom de l'entité. Des opérations Data Service peuvent être effectuées dans une bibliothèque pour améliorer la réutilisabilité de l'entité tout au long de l' accélérateur de solution.
Gestion des exceptions	Les erreurs dans une bibliothèque doivent être générées comme des exceptions plutôt que d'être signalées via des arguments de sortie. Confirmez le résultat d'un composant de bibliothèque à la fin en vérifiant si l'action souhaitée s'est produite et générez une exception si ce n'est pas le cas.

5. Processus

Un processus est un projet UiPath développé à l'aide de l'option de conception de processus et pouvant être exécuté par un Robot UiPath. Tout nouveau projet de processus doit être un projet multiplateforme ou un projet Windows. Windows – Legacy utilise une ancienne version de .NET Framework et ne sera plus une option pour les nouveaux projets dans un futur proche. Les entités de Data Service ne doivent pas être importées dans un processus. L'importation au sein d'un processus individuel peut entraîner des espaces de noms en conflit dans tout un accélérateur de solution.

Un processus a les exigences suivantes :

Type de projet	Projets Windows Projets multiplateforme
Taille du processus	Processus petits et bien délimités
Annotations	Ajoutez des annotations épinglées sur chaque fichier de workflow en tant que clause de non-responsabilité/explication. Le format typique décrit l'objectif du workflow avec une explication de chaque argument à envoyer, à envoyer et à entrer/sortier Annoter les activités avec une explication descriptive appropriée
Conventions d'affectation de noms des variables	Maintenir une convention d'affectation de noms de variables cohérente tout au long d'un processus d'automatisation est important pour la lisibilité et la clarté Les développeurs UiPath standard typiques suivent sont la casse mixte (par exemple, Prénom (firstName), myFirstName, lastName, myOrganizationStructure)
Conventions d'affectation de noms des arguments	Minuscule mixte avec un préfixe indiquant le type d'argument comme étant in, out, ou in/out, tel que in_defaultTimeout, in_fileName, out_textResult, io_retryNumber. Les annotations doivent exister pour chaque argument, car elles sont affichées lorsqu'un workflow est invoqué
Commentaires	Ajouter des activités de commentaire aux endroits appropriés pour mettre en évidence les zones de configuration/où la logique doit être modifiée en fonction des scénarios des clients
Entité de Data Service	Les entités de Data Service ne doivent pas être importées dans un processus. Une entité de Data Service doit être importée dans une bibliothèque commune pour éviter les espaces de noms en conflit. Les opérations de Data Service peuvent se produire dans un processus avec un espace de noms importé depuis une bibliothèque.
Couches	Couche d'application (Application Layer) (il est possible d'utiliser l'API ou l'UI Automation pour une application spécifique, mais cela dépend du choix du développeur) Couche de logique métier/Couche d'implémentation