Introduction

Coded automations allow you to create automations using code instead of drag-and-drop activities, allowing collaborative work on complex projects. In coded workflows and test cases, you can use UiPath^® services (equal to activity packages), APIs (similar to activities), external .NET NuGet packages, and your custom C# classes in UiPath Studio. This makes it easy to integrate with external systems, databases, APIs, and other services.

Les workflows codés se comportent comme des workflows standard, ce qui signifie qu'ils peuvent également être appelés à partir de workflows UiPath standard, et vice versa, à l'aide de l'activité Appeler le fichier de flux de travail (Invoke Workflow File).

En outre, les types définis dans le code, tels que les énumérations, peuvent être utilisés comme entrées dans les workflows UiPath standard.

Les automatisations codées peuvent être de trois types :

• Workflows codés : utilisés pour concevoir des workflows codés.
• Cas de test codés : utilisés pour concevoir des cas de test.
• Fichiers source du code : utilisés pour créer du code que vous pouvez appeler ultérieurement dans d'autres types de fichiers codés.

Utilisation d'automatisations codées

Pour créer des automatisations codées dans votre projet, le package UiPath.CodedWorkflows est généralement préinstallé. Le package est livré avec la base CodedWorkflowBase et la classe partielle CodedWorkflow .

Le package est préinstallé lorsque :

• Vous créez un nouveau projet avec a minima la version 23.10 de System.Activities, Testing.Activities ou UIAutomation.Activities, ou tout autre package d’activités prenant en charge le workflow codé.
• Vous créez un nouveau workflow codé, un cas de test codé ou un fichier source du code dans votre projet.

Si vous ne pouvez pas utiliser d'automatisations codées dans les scénarios indiqués, téléchargez le package à partir du menu Gérer les packages (Manage Packages).

Bénéfices

Voici quelques-uns des avantages de l’utilisation d'automatisations codées :

1. Productivité améliorée : si vous maîtrisez le codage ou les scripts, vous pouvez tirer parti de vos compétences et augmenter votre productivité. Travailler dans un environnement de codage familier vous permet de développer des automatisations plus efficaces.
2. Gestion de la complexité : les automatisations codées offrent une solution flexible pour gérer des scénarios d'automatisation complexes. En utilisant du code, vous pouvez implémenter une logique personnalisée, gérer des exceptions et créer des fonctions réutilisables.
3. Automatisation hybride  : vous pouvez utiliser des automatisations codées de manière interchangeable avec des automatisations low-code. Cela permet une intégration transparente entre les deux approches et vous permet de créer des solutions d'automatisation flexibles.
4. Performances améliorées : les automatisations codées vous permettent d'optimiser vos workflows d'automatisation pour améliorer les performances. En utilisant du code, vous pouvez implémenter des algorithmes spécifiques pour accélérer les exécutions d'automatisation.
5. Lisibilité : les automatisations codées vous permettent de créer du code structuré, ce qui améliore sa lisibilité. Si vous organisez votre code et le documentez, vous pouvez facilement le gérer et le partager avec d’autres collaborateurs.

Structure

Les automatisations codées présentent une conception structurée avec des espaces de noms, des classes d'aide et des méthodes de point d'entrée. La structure des automatisations codées vous permet d’écrire les automatisations à l’aide du langage de programmation C#.

Suivez la structure détaillée d'une automatisation codée tel que décrit dans les sections suivantes.

Espaces de noms

Lorsque vous créez une automatisation codée, un espace de noms est automatiquement généré à l'aide du nom du projet Studio. Par exemple, si votre projet Studio se nomme « Mon projet » (My project), l'espace de noms de toutes les automatisations codées sera « Monprojet » (Myproject).

De plus, si vous créez une automatisation codée dans un dossier de votre projet Studio, l'espace de noms correspondra au nom du projet et du dossier. Par exemple, si votre projet Studio s'appelle « Mon projet » (My project) et que le dossier se nomme « place », l'espace de noms sera « Monprojet.place » (Myproject.place).

Classe de base

Les automatisations de workflow codé et de cas de test codé utilisent la classe partielle CodedWorkflow du package UiPath.CodedWorkflows. Cette classe permet à l’automatisation d’accéder aux interfaces nécessaires pour les services (équivalent aux packages d’activités), en fonction des packages d’activités installés dans votre projet.

Remarque : le package UiPath.CodedWorkflows est automatiquement inclus lorsque vous importez un package d'activités qui prend en charge les automatisations codées, telle que UiPath.System.Activities 23.10 ou version ultérieure.

CodedWorkflow

Les automatisations codées héritent de la classe partielle CodedWorkflow, créant ainsi une relation de type CodedAutomationExample : CodedWorkflow. Cela signifie que la classe CodedAutomationExample hérite des attributs, des méthodes et des fonctionnalités de la classe CodedWorkflow. Elle peut principalement accéder et utiliser les fonctionnalités définies dans la classe CodedWorkflow, qui fournit une base de l'automatisation codée, ce qui facilite l'élaboration et la personnalisation du comportement de l'automatisation.

La classe CodedWorkflow est déclarée comme classe partielle, ce qui vous permet d'étendre ses fonctionnalités en définissant la même classe partielle CodedWorkflow dans un fichier source du code. De cette façon, vous pouvez ajouter de nouveaux champs et de nouvelles méthodes pour personnaliser davantage le comportement de vos automatisations codées. Vous pouvez utiliser cette approche pour implémenter une interface Avant

De plus, la classe partielle CodedWorkflow hérite de la classe CodedWorkflowBase.

CodedWorkflowBase

La classe CodedWorkflowBase contient les fonctionnalités intégrées héritées par une automatisation codée. Cette classe contient des méthodes et des propriétés spécifiques pour la gestion des instances de workflow, l'accès au runtime, la gestion des conteneurs de services et la configuration des contextes d'environnement. La classe CodedWorkflowBase offre également une autre méthode distincte de journalisation que vous pouvez personnaliser vous-même.

Remarque : Dans les Paramètres de l’éditeur de code, sélectionnez Activer la décompilation source (Enable Source Decompilation) pour afficher la classe CodedWorkflowBase.

Consultez les méthodes CodedWorkflowBase dans le tableau ci-dessous :

Method	Description
serviceContainer(ICodedWorkflowServiceContainer)	Permet d'accéder au conteneur d'injection de dépendance spécifique au workflow codé actuel. Ce conteneur, appelé conteneur de service, vous permet de récupérer les instances de services qui y ont été enregistrées.
GetRunningJobInformation()	Récupère des informations sur la tâche en cours d'exécution dans le contexte du workflow codé. La méthode accède à la propriété RunningJobInformation de l'objet executorRuntime , qui contient des informations sur le statut, la progression, les paramètres et les horodatages de la tâche.
Log(string message, LogLevel level = LogLevel.Info, IDictionary<string, object>additionalLogFields = null)	Ajoute des champs de journal supplémentaires pour consigner les messages avec les attributs spécifiés.
RunWorkflow(string workflowFilePath,IDictionary<string, object> inputArguments = null,TimeSpan? timeout = null, bool isolated = false, InvokeTargetSession targetSession = InvokeTargetSession.Current)	Fournit une structure pour exécuter un workflow dans le contexte d'un runtime de workflow donné. Elle peut définir les paramètres, gérer l'isolement potentiel et lancer l'exécution du workflow. La tâche renvoyée fournit les résultats du workflow exécuté, y compris ses arguments de sortie et d'entrée/de sortie.
RunWorkflowAsync(string workflowFilePath,IDictionary<string, object> inputArguments = null, TimeSpan?timeout = null, bool isolated = false, InvokeTargetSession targetSession = InvokeTargetSession.Current)	Fournit une structure pour exécuter un workflow de manière asynchrone dans le contexte d'un runtime de workflow donné. Elle peut définir les paramètres, gérer l'isolement potentiel et lancer l'exécution du workflow. La tâche renvoyée fournit les résultats du workflow exécuté, y compris ses arguments de sortie et d'entrée/de sortie.
DelayAsync(TimeSpan time) et DelayAsync(int delayMs)	Suspend l'exécution de manière asynchrone pendant une période spécifiée.
Delay(TimeSpan time) et Delay(int delayMs)	Suspend l'exécution pendant une période spécifiée.
HttpClient BuildClient(string scope = "Orchestrator", bool force = true)	Génère un client HTTP avec une étendue et un jeton d'accès spécifiés.
RegisterServices(ICodedWorkflowsServiceLocator serviceLocator)	Enregistre les services (packages d'activités) dans le localisateur de services du workflow codé. Vous pouvez contourner cette opération lorsque vous souhaitez injecter des services personnalisés dans le conteneur d'injection de dépendance. Pour savoir comment créer et utiliser des services personnalisés (packages d'activités codées); cliquez ici.

Articles associés

• Enregistrement de services personnalisés
• Implémentation des exécutions Avant (Before) et Après (After)

Points d’entrée

La méthode de point d'entrée pour les workflows codés et les cas de test codés est nommée Execute() et est attribuée sous la forme Workflow ou TestCase. Vous pouvez modifier le nom de la méthode, tant que vous l'attribuez à Workflow ou TestCase.

Vous ne pouvez utiliser qu'une seule méthode Execute() ([TestCase] ou [Workflow]) dans un fichier, qui hérite de la classe Coded Workflow.

Dans cette méthode, vous pouvez ajouter des arguments d'entrée et/ou de sortie, qui sont équivalents aux arguments In, Out ou In/Out dans les automatisations low-code. Suivez le didacticiel Utilisation d'arguments d'entrée et de sortie pour apprendre à utiliser des arguments dans des automatisations codées.

Cette méthode de point d'entrée sert de point de départ à l'exécution des automatisations. Cela rend les workflows et les cas de test codés faciles à identifier comme points d'entrée en raison de leur méthode Execute().

Compatibilité du projet

Vous pouvez utiliser les automatisations codées uniquement dans les projets Windows et multiplate-forme.

Services

Pour concevoir des automatisations codées, vous pouvez utiliser des services, qui correspondent à des packages d'activités. Par exemple, System.Activities n'est pas seulement un package d'activités dans les automatisations low-code, mais également un service dans les automatisations codées. Comme pour les activités contenues dans un package d'activités, un service possède des API que vous pouvez utiliser pour créer des automatisations codées.

Les services disponibles pouvant être utilisés dans les automatisations codées sont les suivants :

Service	Version
System.Activities	23.10 et versions ultérieures
UiAutomation.Activities	23.10.7 et versions ultérieures
Testing.Activities	23.10 et versions ultérieures

Pour utiliser des packages d'activités dans des automatisations codées, procédez comme suit :

1. Téléchargez le package d'activité (équivaut à un service), comme vous le feriez pour des automatisations low-code. Vous obtenez une collection d'API à utiliser dans votre code.
2. Appelez les API dans les services en utilisant le format : service.API. Par exemple, si vous souhaitez utiliser l'API ObtenirRessource (GetAsset), vous l'appelleriez system.GetAsset.
3. Les API ont des paramètres au lieu de propriétés. Après avoir appelé une API, vous pouvez configurer ses paramètres en fournissant des valeurs entre parenthèses. Par exemple, si vous avez une ressource dans l'instance Orchestrator à laquelle vous êtes connecté appelée Email Address, vous pouvez transmettre le nom de cette ressource en tant que String à l'API : system.GetAsset("Email Address").

Conseil : dans les automatisations codées, vous pouvez également utiliser les bibliothèques de classes .NET disponibles en téléchargement dans le flux nuget.org.