Normes de contenu

Identifying the use case

Le cas d’utilisation idéal pour une automatisation prête à l’emploi est le processus d’automatisation Attended qui permet à chaque employé d’une organisation ou d’un service de bénéficier de cette automatisation.

Avant de se concentrer sur un cas d'utilisation particulier, le développeur doit poser les questions suivantes :

• si cela permettrait aux employés de déléguer à leur robot des tâches qu’ils effectuent chaque jour, comme planifier des réunions, effectuer des recherches et générer des rapports, ou analyser, gérer et mettre à jour des données.
• si cela permettrait aux employés d'accéder facilement à l'automatisation.

Un exemple typique d'un tel processus est celui des cas d'utilisation liés à la productivité dans lesquels un employé peut déclencher un Attended Robot à l'aide de l'Assistant, qui lui proposera rapidement un formulaire concernant les participants à la réunion, la description et les contraintes de temps. Le robot prend ces informations et compare automatiquement les options entre les invités et les calendriers de salle de réunion. Le jour, l'heure et les options de salle de réunion sont ensuite présentés pour validation finale par l'utilisateur. Une fois confirmés, le robot envoie des invitations à la réunion.

Recommendations for high business value

• Un cas d’utilisation pouvant fonctionner avec des logiciels à usage général tels que MS Office, Adobe Acrobat Reader, Google Chrome, etc. est fortement recommandé, car s’il fonctionne avec des logiciels rarement utilisés, seuls un nombre limité d’utilisateurs finaux pourraient en profiter .
• Si l'automatisation nécessite un besoin de formation inhabituellement élevé pour la configurer ou l'utiliser, le développeur citoyen ne peut pas l'exécuter ne serait-ce qu'une seule fois. Il y a de fortes chances qu'une autre catégorie telle que Activité personnalisée (Custom Activity), Solution (Solution) ou Outils (Tools) soit potentiellement mieux adaptée pour développer un tel cas d'utilisation.
• Le cas d'utilisation doit être universel et évolutif. Par exemple, imaginez une automatisation prête à l'emploi qui effectue une connexion automatique pour les applications utilisées quotidiennement. Il y aura un avantage limité si l’étendue est limitée à une ou deux applications. Par conséquent, soit il devrait fournir une connexion automatique pour plus d’applications, soit il devrait y avoir de la place pour ajouter d’autres applications.

Developing the automation

En règle générale, les processus d'automatisation assistée peuvent être exécutés à l'aide d'Assistant. Ces processus doivent être conçus de manière à être petits, fragmentés et pouvant être exécutés sous supervision humaine.

The naming of the ready-to-go automation

• Lors de l’élaboration du processus d’automatisation prête à l’emploi via UiPath Studio, le « nom » et la « description » du projet sont de la plus haute importance. Chaque automatisation prête à l'emploi :

  1. « Name » (Nom) devrait commencer par un mot d'action ou un verbe. Il doit être descriptif afin que les utilisateurs puissent facilement comprendre immédiatement la valeur.

  2. Doit contenir une « Description » pertinente et concise de la fonctionnalité.

  3. Lors du développement de l’automatisation, le « Nom » et la « Description » peuvent être saisis via l’assistant « Paramètres du projet » dans UiPath Studio, comme indiqué ci-dessous.

     

     Important :

     Pour qu’une liste soit publiée sur UiPath Marketplace, vous devez inclure dans la Description (Description) de la liste tous les détails sur les produits UiPath utilisés dans l’automatisation ou qui sont compatibles avec votre automatisation, et le rôle qu’ils jouent.

     Les partenaires ne peuvent pas inclure les noms de tiers ou d'applications de tiers ou d'autres produits tiers dans le texte de leur liste ou description de produit sur la place de marché UiPath sans l'autorisation expresse du tiers.

Configuration and startup

Lors de la première exécution, l’automatisation prête à l’emploi doit afficher un écran « Informations de démarrage » (Startup Info) qui suggère aux utilisateurs ce à quoi ils peuvent s’attendre, mentionne les prérequis avant d’exécuter l’automatisation et fournit des instructions d’utilisation.

• Certains processus d'automatisation assistés s'exécutent de la même manière pour tout le monde, c'est-à-dire que lorsque l'utilisateur clique sur Démarrer (Start) dans l'Assistant, les étapes prédéfinies sont exécutées sans aucune variation. Mais dans d'autres cas, l'exécution d'un processus dépend de paramètres uniques pour l'utilisateur ou le contexte, tels que l'adresse e-mail, l'emplacement du dossier ou une chaîne de message. Dans de tels cas, le processus doit être créé par le développeur dans UiPath Studio avec des arguments ou des champs d'entrée personnalisables.
• Les détails de configuration qui ne changent généralement pas pour les utilisateurs sur une machine où l'automatisation prête à l'emploi s'exécute, par exemple Le serveur de messagerie, le port, le chemin d'accès au fichier, etc. doivent être disponibles comme arguments pour l'assistant sur l'écran Afficher les détails du processus (Show Process Details).
• L’Assistant UiPath ne peut afficher que les types d’arguments suivants sur l’écran « Afficher les détails du processus » (Show Process Details). Par conséquent, s’il est nécessaire de transmettre tout autre type comme argument, un formulaire peut être utilisé à cette fin :
  • Int32 : saisissez un nombre.
  • Chaîne (String) : saisissez le texte.
  • Booléen (Boolean) - cochez ou décochez une case.
  • DateTime : choisissez une date ou une heure.
• Les mots de passe ou les informations sensibles ne doivent pas être exposés ou enregistrés par le workflow.

Providing the status of the execution

L’état intermédiaire d’exécution de l’automatisation prête à l’emploi doit être transmis à l’écran par le biais de légendes, de boîte de message à fermeture automatique ou de panneaux dans le coin de l’écran. Cette fenêtre doit rester en haut de l’écran pendant que l’automatisation est en cours. Il doit fournir de courts messages de mise à jour ou une barre de progression à l'utilisateur interagissant avec l'Assistant.

• Implémentez la gestion des exceptions afin que les utilisateurs reçoivent des messages significatifs lorsque des erreurs se produisent.

• Si le résultat de l'exécution est un texte de sortie, il doit être affiché dans une boîte de message ou un formulaire à l'attention de l'utilisateur final sous la forme d'une chaîne copiable.

  • For instance, the following listing [Shorten my URL link

    • RPA Component | UiPath Marketplace](https://marketplace.uipath.com/listings/2853) generates the output that can be copied for further use.

      

• Consider another listing Get a full path to my file - RPA Component | UiPath Marketplace. All output file paths are readable and copiable.

  

Publishing the process

Toutes les automatisations prêtes à l'emploi pour l'Assistant doivent être publiées sous forme de package NuGet dans UiPath Studio, car UiPath Assistant ne peut utiliser que des packages NuGet.

Meilleures pratiques

Le paquet NuGet doit contenir les métadonnées suivantes :

• Balises : il s'agit des libellés pertinents indiquant la catégorie/fonctionnalité de l'automatisation.
• URL de la licence (License URL) : spécifiez l'URL de la licence en fonction du type de licence que vous avez sélectionné pour votre automatisation.
• La coche Acceptation de la licence (License Acceptance) doit être cochée.
• The name of the NuGet package should use the following convention: CompanyName.. If you are not affiliated with any company, you should use the following convention: .
• La version NuGet commence à 0.0. Chaque modification effectuée avant la publication augmente son index « décimal ». Par exemple, lorsque nous publions la première ou une nouvelle version de NuGet, nous la considérons comme une mise à jour MAJEURE, elle passe donc à la version 1.0.
• Le nom de balise UiPath ne doit pas être présent dans les ID/dll.
• Si le contenu est localisé, « Langues » (Languages) doit être spécifié, même si le champ est marqué comme Facultatif (Optional).
• In case there is a need to edit the metadata after publishing the automation to a NuGet, then it can be done using NuGet Package Explorer.
• A user guide document containing the necessary information to run the automation should be provided. Here is a sample user guide template that can be downloaded and updated with the relevant information.
• A video demo showing the execution of the automation with UiPath Studio or UiPath Assistant should be provided. The guidelines for creating the video can be found on this page.

Testing the NuGet with Assistant

Pour tester si un processus développé à l'aide d'UiPath Studio est compatible avec UiPath Assistant, la première étape consiste à installer le package NuGet de ce processus dans UiPath Assistant.

• Pour installer ou mettre à jour le package NuGet à partir du flux Orchestrator, le Robot doit être connecté à Orchestrator.

• Une fois le package NuGet installé avec succès, l'étape suivante consiste à configurer tous les champs d'entrée personnalisables.

• Si le processus est développé dans UiPath Studio avec des arguments, les paramètres doivent être fournis dans les champs de saisie personnalisables de l'Assistant UiPath. Ces champs sont accessibles dans l'Assistant en cliquant sur « Afficher les détails du processus » dans le menu à trois points du processus correspondant.

• Les valeurs fournies à ces champs peuvent être enregistrées afin que ces valeurs soient utilisées lors de la prochaine exécution de l'automatisation.