Create External Task

UiPath.Persistence.Activities.ExternalTask.CreateExternalTask

Description

Crée une action externe avec les données, le titre de la tâche, la priorité de la tâche et le catalogue de tâches donnés.

Compatibilité du projet

Windows - Héritage | Windows | Multiplate-forme

Windows, Windows - Configuration héritée

Module Designer

• TitreTâche : le titre de l'action que vous souhaitez créer. Ce champ prend en charge les chaînes et les variables String uniquement.
• TaskPriority : permet de sélectionner le niveau de priorité de l'action. Par défaut, cette propriété est définie sur TaskPriority.Medium. Les options suivantes sont disponibles : TaskPriority.Low, TaskPriority.Medium, TaskPriority.High, TaskPriority.Critical.
• TaskCatalog : une classification métier facultative des éléments de tâche. Ce champ prend en charge les chaînes et les variables String uniquement.
• DonnéesTâches : une collection de données métier, au format Dictionary<String,Argument>, que vous souhaitez stocker dans une action donnée. La modification des arguments Out et In/Out les renvoie au workflow une fois l'action terminée. Ce champ prend en charge les objets Dictionary<String,Argument> uniquement.
• ObjetTâche(Sortie) : l'objet de tâche renvoyé par Orchestrator en tant qu'objet ExternalTaskData après la création des Actions . Cet objet peut être transmis à l'activité Attendre la tâche externe et reprendre (Wait for External Task and Resume ) afin de suspendre l'exécution du workflow jusqu'à ce que les Actions soient terminées.

Panneau propriétés

Commun

• Poursuite sur erreur (ContinueOnError) - Spécifie si l'automatisation doit continuer même si l'activité génère un message d'erreur. Ce champ prend uniquement en charge les valeurs booléennes (True, False). La valeur par défaut est False. Par conséquent, si le champ est vide et si une erreur est renvoyée, l'exécution du projet s'interrompt. Si la valeur est configurée sur True, l'exécution du projet continue indépendamment de toute erreur.

Remarque : si cette activité est incluse dans l'activité Try Catch et que la valeur de la propriété ContinuerSurErreur est « True », aucune erreur ne sera détectée lors de l'exécution du projet.

• NomAffichage (DisplayName) - Nom affiché de l'activité.
• TimeoutMS - Spécifie la durée (en millisecondes) d'attente d'exécution de l'activité avant la génération d'un message d'erreur. La valeur par défaut est 30 000 millisecondes (30 secondes).

Entrée

• Balise externe : une balise qui peut être utilisée pour identifier le système externe qui est la source des données dans l'action donnée. Ce champ prend en charge les chaînes et les variables String uniquement.
• Libellés : le robot ajoute les libellés saisis à l'action, ce qui permet un filtrage ultérieur. Ce champ prend en charge les valeurs de chaîne uniquement et comporte des restrictions de nommage.

Remarque : pour autoriser le labellisation automatique des actions via les activités de persistance, le compte Robot exécutant le workflow doit disposer des autorisations Consultation ( View), Création ( Create) et Suppression ( Delete ) sur les balises.

• Chemin d'accès au dossier Orchestrator (Orchestrator Folder Path) - Chemin d'accès à un dossier Orchestrator différent de celui dans lequel le processus actuel fonctionne, dans lequel vous souhaitez créer la tâche. Pour en savoir plus sur les dossiers Orchestrator, rendez-vous ici. Pour les dossiers classiques , cette propriété ne peut être utilisée qu'avec des robots flottants et uniquement si l'utilisateur actuel dispose des privilèges de tâche appropriés dans le dossier cible. Pour les dossiers modernes , le remplacement du chemin d'accès au dossier n'est pas pris en charge. Ce champ prend en charge les chaînes et les variables String uniquement.

Remarque : la propriété CheminDossier (FolderPath) ne doit être utilisée que si la tâche doit être créée ou interrogée à partir d'un dossier différent du dossier actuel. Si l'utilisateur effectuant cette action ne dispose pas des autorisations requises pour le dossier cible, la création de la tâche échoue et génère une erreur critique. Vous pouvez afficher plus d'informations sur les autorisations de dossier ici.

• TaskCatalog : une classification métier facultative des éléments de tâche. Ce champ prend en charge les chaînes et les variables String uniquement.

Remarque : assurez-vous que le catalogue d'actions existe avant la création de l'action. Sinon, la création de l'action échoue avec le message d'erreur suivant : « Aucun catalogue de tâches n'existe avec le nom [action_catalog_name] Code d'erreur : 2451 ».

• DonnéesTâches : une collection de données métier, au format Dictionary<String,Argument>, que vous souhaitez stocker dans une action donnée. La modification des arguments Out et In/Out les renvoie au workflow une fois l'action terminée. Ce champ prend en charge les objets Dictionary<String,Argument> uniquement.
• TaskPriority : permet de sélectionner le niveau de priorité de l'action. Par défaut, cette propriété est définie sur TaskPriority.Medium. Les options suivantes sont disponibles : TaskPriority.Low, TaskPriority.Medium, TaskPriority.High, TaskPriority.Critical.
• TitreTâche : le titre de l'action que vous souhaitez créer. Ce champ prend en charge les chaînes et les variables String uniquement.

Divers

• Privé (Private) - Si cette option est sélectionnée, les valeurs des variables et des arguments ne sont plus enregistrées au niveau Détaillé (Verbose).

Sortie

• ObjetTâche(Sortie) : l'objet de tâche renvoyé par Orchestrator en tant qu'objet ExternalTaskData après la création des Actions . Cet objet peut être transmis à l'activité Attendre la tâche externe et reprendre (Wait for External Task and Resume ) afin de suspendre l'exécution du workflow jusqu'à ce que les Actions soient terminées.

Configuration multiplateforme

• TitreTâche : le titre de l'action que vous souhaitez créer. Ce champ prend en charge les chaînes et les variables String uniquement.
• TaskPriority : permet de sélectionner le niveau de priorité de l'action. Par défaut, cette propriété est définie sur TaskPriority.Medium. Les options suivantes sont disponibles : TaskPriority.Low, TaskPriority.Medium, TaskPriority.High, TaskPriority.Critical.
• TaskCatalog : une classification métier facultative des éléments de tâche. Ce champ prend en charge les chaînes et les variables String uniquement.

Remarque : assurez-vous que le catalogue d'actions existe avant la création de l'action. Sinon, la création de l'action échoue avec le message d'erreur suivant : « Aucun catalogue de tâches n'existe avec le nom [action_catalog_name] Code d'erreur : 2451 ».

• DonnéesTâches : une collection de données métier, au format Dictionary<String,Argument>, que vous souhaitez stocker dans une action donnée. La modification des arguments Out et In/Out les renvoie au workflow une fois l'action terminée. Ce champ prend en charge les objets Dictionary<String,Argument> uniquement.
• ObjetTâche(Sortie) : l'objet de tâche renvoyé par Orchestrator en tant qu'objet ExternalTaskData après la création des Actions . Cet objet peut être transmis à l'activité Attendre la tâche externe et reprendre (Wait for External Task and Resume ) afin de suspendre l'exécution du workflow jusqu'à ce que les Actions soient terminées.

Options avancées

Commun

• Poursuite sur erreur (ContinueOnError) - Spécifie si l'automatisation doit continuer même si l'activité génère un message d'erreur. Ce champ prend uniquement en charge les valeurs booléennes (True, False). La valeur par défaut est False. Par conséquent, si le champ est vide et si une erreur est renvoyée, l'exécution du projet s'interrompt. Si la valeur est configurée sur True, l'exécution du projet continue indépendamment de toute erreur.

Remarque : si cette activité est incluse dans l'activité Try Catch et que la valeur de la propriété ContinuerSurErreur est « True », aucune erreur ne sera détectée lors de l'exécution du projet.

• TimeoutMS - Spécifie la durée (en millisecondes) d'attente d'exécution de l'activité avant la génération d'un message d'erreur. La valeur par défaut est 30 000 millisecondes (30 secondes).

Entrée

• Libellés : le robot ajoute les libellés saisis à l'action, ce qui permet un filtrage ultérieur. Ce champ prend en charge les valeurs de chaîne uniquement et comporte des restrictions de nommage.

Remarque : pour autoriser le labellisation automatique des actions via les activités de persistance, le compte Robot exécutant le workflow doit disposer des autorisations Consultation ( View), Création ( Create) et Suppression ( Delete ) sur les balises.

• Chemin d'accès au dossier Orchestrator (Orchestrator Folder Path) - Chemin d'accès à un dossier Orchestrator différent de celui dans lequel le processus actuel fonctionne, dans lequel vous souhaitez créer la tâche. Pour en savoir plus sur les dossiers Orchestrator, rendez-vous ici. Pour les dossiers classiques , cette propriété ne peut être utilisée qu'avec des robots flottants et uniquement si l'utilisateur actuel dispose des privilèges de tâche appropriés dans le dossier cible. Pour les dossiers modernes , le remplacement du chemin d'accès au dossier n'est pas pris en charge. Ce champ prend en charge les chaînes et les variables String uniquement.

Remarque : la propriété CheminDossier (FolderPath) ne doit être utilisée que si la tâche doit être créée ou interrogée à partir d'un dossier différent du dossier actuel. Si l'utilisateur effectuant cette action ne dispose pas des autorisations requises pour le dossier cible, la création de la tâche échoue et génère une erreur critique. Vous pouvez afficher plus d'informations sur les autorisations de dossier ici.

• Référence (Reference) - Balise que vous pouvez utiliser pour identifier le système externe qui est la source des données dans l'action donnée. Ce champ prend en charge les chaînes et les variables String uniquement.

Création d'actions externes

Pour créer une action externe, choisissez l'une des procédures suivantes :

1. Ajoutez une activité Créer une tâche externe (Create External Task) à votre workflow et fournissez des informations pour les champs de propriétés suivants :

   • Titre de la tâche
   • Priorité de la tâche
   • Données de tâche (collection)
   • Balise externe : spécifiez une balise pour identifier de manière unique les lots de tâches externes que vous souhaitez récupérer à partir d'un système tiers. Vous pouvez utiliser cette balise pour synchroniser les tâches externes avec un système externe. Vous pouvez également utiliser cette balise pour effectuer des tâches en fonction des actions effectuées par un utilisateur dans le système tiers.
2. Créer des Actionsexternes à l'aide d'API.

Synchronisation des actions externes avec des outils tiers

Pour synchroniser les actions externes avec d'autres systèmes externes, vous devez d'abord créer un objet correspondant dans le système externe, puis récupérer la tâche, ou le lot de tâches, créé par le système tiers, à l'aide d'un appel API.

1. Créez un objet à l'intérieur d'un système externe, tel que :

   • Créez un problème dans Jira.
   • Créez un contact dans Salesforce.
2. Appelez l'API suivante dans Swagger : GET /odata/Tasks/UiPath.Server.Configuration.OData.GetTasksAcrossFolders.
   Par exemple : GET <ORCH_URL>/odata/Tasks/UiPath.Server.Configuration.OData.GetTasksAcrossFolders?$filter=(Type eq 'ExternalTask') and (IsDeleted eq false) and (ExternalTag eq 'JiraTasks') and (Status ne 'Completed')&$count=true.

Récupération des actions externes

Appelez l'API suivante pour récupérer des informations sur une tâche externe, à l'aide de l' ID de tâche et de l'ID d' unité d'organisation (l'ID du dossier Orchestrator) : GET /tasks/GenericTasks/GetTaskDataById. Vous pouvez utiliser les détails récupérés pour créer une tâche similaire dans un système tiers.

Les captures d'écran ci-dessous montrent les paramètres de l'API et les réponses dans Swagger. Pour accéder à votre locataire dans Swagger, suivez la procédure Accéder à votre fichier Swagger (Accessing your Swagger file ).

Terminer les actions externes

Appelez l'API suivante pour terminer une tâche externe, en utilisant l'ID de tâche et l'ID d' unité d'organisation (l'ID du dossier Orchestrator) : POST /tasks/GenericTasks/CompleteTask.

Consultez la procédure Terminer la tâche externe du guide de l'API Orchestrator pour plus de détails.

Exemple de workflow

Pour obtenir un exemple ou une référence future, consultez l’ exemple de projet