Workflow codé

Les workflows codés sont les mêmes que les workflows low-code, la seule différence étant qu'ils sont créés à l'aide d'interfaces distinctes :

• Les workflows ont une interface de conception visuelle.
• Les workflows codés ont une interface basée sur du code.

En outre, vous pouvez intégrer des workflows codés avec des activités et des workflows low-code, et utiliser une approche d'automatisation hybride. Cela vous permet de combiner les avantages de l'automatisation basée sur le code avec la conception visuelle de composants low-code.

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.

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).

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 module d’activités qui prend en charge les automatisations codées, tel que UiPath.System.Activities 23.10 ou une 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 CodedWorkflow classe est déclarée comme une classe partielle, ce qui vous permet d'étendre ses fonctionnalités en définissant la même classe partielle CodedWorkflowdans un fichier de code source. Vous pouvez ainsi ajouter de nouveaux champs et méthodes pour personnaliser davantage le comportement de vos automatisations codées. Vous pouvez utiliser cette approche pour implémenter une interface Avant et Après (Before and After), spécifiquement pour les cas de test codés.

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 de la source pour afficher la classe CodedWorkflowBase.

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

Method	Description
ICodedWorkflowServices services We recommend you to use the Log , BuildClient , and RunWorkflow methods through the services class and their corresponding services, instead of using them as standalone, readily available methods.	Permet d’accéder aux services disponibles pour les workflows codés, tels que : OutputLoggerService : vous permet de générer des journaux à l’aide de la méthode Log. OrchestratorClientService (méthode BuildClient) : permet d’activer l’interaction avec Orchestrator via la méthode BuildClient. WorkflowInvocationService : vous permet d’invoquer d’autres workflows en utilisant la méthode RunWorkflow. Container : le conteneur dans lequel tous les services sont stockés. Il vous permet de gérer les ressources pour les workflows codés en prenant en charge l’importation automatique d’espaces de noms et de types, à l’aide des méthodes AutoImportedNamespaces et AutoImportedTypes. De plus, il fournit une instance d’un service spécifique à l’aide de la méthode Resolve.
serviceContainer(ICodedWorkflowServiceContainer) Cela a été remplacé par ICodedWorkflowServices services. Si vous continuez à utiliser cette syntaxe, vous recevez un Warning vous invitant à utiliser la nouvelle syntaxe services.Container.	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.

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.

You can only use one Execute() method ([TestCase] or [Workflow]) inside a file, that inherits the Coded Workflow class.

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.