À propos des arguments d'entrée et de sortie

Nous avons exposé les arguments d’entrée et de sortie que vous avez déjà utilisés dans Studio comme moyen d’intégrer facilement les outils que vous utilisez, tels que les différents DCM ou BPM. Cela implique que tout processus que vous créez peut à présent recevoir des arguments d’entrée via l’API ou l’interface d’Orchestrator, ainsi que renvoyer une sortie à tous les éléments susmentionnés. Enfin, cela est la première étape de liaison des processus. Cette extensibilité permet de mieux intégrer UiPath® dans l’écosystème de votre société.

Remarque :

Seuls les arguments d'entrée, de sortie et d'entrée/sortie du fichier .xaml marqué comme Principal (Main) dans Studio sont exposés à d'autres applications.

Les arguments sont enregistrés dans le fichier project.json d’un projet.

Au moment de la conception dans Studio, la manière dont vous configurez votre projet pour qu'il accepte les arguments d'entrée ou de sortie, avec ou sans valeurs par défaut, permet de les utiliser dans d'autres applications tierces ou dans Orchestrator. Vous ne pouvez utiliser les arguments d'entrée et de sortie dans Orchestrator et dans d'autres applications tierces que si vous aviez ajouté au préalable les arguments correspondants dans votre projet Studio. Si aucun argument n'a été ajouté dans Studio, le message suivant s'affiche : « Les arguments d'entrée ne sont pas définis pour cette version » (Input arguments are not defined for this version).

Les arguments In, Out ou In/Out d'un projet deviennent des arguments d'entrée et de sortie lorsqu'ils sont publiés dans Orchestrator. Veuillez noter que pour les arguments In/Out, deux arguments différents sont créés et affichés dans Orchestrator, un d'entrée et un de sortie, avec le même nom.

Fournir des valeurs d'argument

Des valeurs peuvent être uniquement fournies aux arguments d'entrée, à l'aide de Studio, d'Orchestrator ou de l'API Orchestrator, comme suit :

Studio

En tant que valeurs par défaut lors de la création d'arguments. Un court exemple se trouve ici. Une valeur par défaut fournie pour un argument dans Studio peut être remplacée dans Orchestrator, au niveau du processus ou de la tâche.

Remarque : Les valeurs par défaut fournies pour les arguments d'entrée dans Studio ne s'affichent pas dans Orchestrator, à tout niveau.

Orchestrator

• au niveau du processus, dans l'onglet Arguments de la fenêtre Afficher le processus (View Process), comme expliqué ici.
• au niveau de la tâche, dans l'onglet Arguments de la fenêtre Démarrer la tâche (Start Job), comme expliqué ici.

• Au niveau du déclencheur, dans l’onglet Arguments de la fenêtre Ajouter un déclencheur (Add trigger), comme expliqué ici.

  Remarque : Une valeur fournie pour un argument d'entrée au niveau du processus dans Orchestrator est conservée même si vous mettez à jour le package, tant que la nouvelle version du package ne concerne pas la définition des arguments.

  La limite de stockage des arguments d'entrée/de sortie est de 1 Mo.

Si vous fournissez des valeurs pour les arguments d'entrée dans Orchestrator, veuillez noter qu'elles doivent être fournies au format JSON. Quelques exemples de la façon dont vous pouvez procéder :

• Chaîne (String) - la valeur doit être fournie sans guillemets, par exemple string ;
• Int32 (Int32) - indiquez la valeur comme vous le feriez avec un entier, 11 ;
• Booléen (Boolean) : deux cases d'option s'affichent pour vous aider à sélectionner true ou false ;
• Double (Double) - indiquez la valeur en tant que valeur de virgule flottante, par exemple 3.5 ;
• DateTime - indiquez la valeur au format JSON valide, par exemple "2012-04-23T18:25:43.511Z" ;
• Tableau (Array) - indiquez les valeurs au format JSON valide, par exemple [1, 1, 2, 3, 5, 8] ou ["firstString", "secondString"].
  Remarque : Tout type d'argument d'entrée peut être utilisé. Gardez à l'esprit que seules les primitives sont validées par Orchestrator.

  Lorsque les types énumérés (enums) sont convertis en JSON, chaque membre de l’énumération est représenté par une valeur entière plutôt que par son nom. Cela signifie que la représentation JSON d’une énumération correspond à la valeur numérique de chaque membre inclus dans l’énumération d’origine.

API Orchestrator

• Au niveau du package : au point de terminaison /odata/Processes/UiPath.Server.Configuration.OData.SetArguments(key='key') ;
• Au niveau du processus : en tant que requête PATCH au point de terminaison /odata/Releases(Id) ;
• Au niveau de la tâche : en tant que requête POST au point de terminaison /odata/Jobs/UiPath.Server.Configuration.OData.StartJobs ;

• Au niveau de la planification : en tant que requête POST vers le point de terminaison /odata/ProcessSchedules.

  Remarque : Pour les appels API, un maximum de 10 000 caractères est accepté pour la longueur entière de la représentation JSON des arguments d'entrée, y compris les noms des arguments, tous les caractères avec échappement, les espaces, les crochets et les valeurs d'arguments.

Affichage des valeurs d'argument

La valeur d'un argument d'entrée est marquée comme suit :

• Aucune valeur (No value) : aucune valeur n'a été fournie pour l'argument au niveau du processus, de la tâche, de la planification ou du paquet (dans Studio).
• Hérité du paquet (Inherited from package) : si la valeur a été fournie par défaut dans Studio. Ce message s'affiche dans la fenêtre Arguments (Arguments) d'un paquet spécifique, ainsi que dans les fenêtres Afficher le processus (View Process), Démarrer la tâche (Start Job), et Ajouter une planification (Add Schedule).

• Hérité du processus (Inherited from process) : la valeur a été fournie au niveau du processus (dans la fenêtre Afficher le processus (View Process). Ce message s'affiche dans les fenêtres Démarrer la tâche (Start Job) et Ajouter une planification (Add Schedule), tandis que dans la fenêtre Afficher le processus (View Process), la valeur elle-même s'affiche.

  
  

  

  
  

Si des valeurs d'argument d'entrée ou de sortie existent, elles sont affichées dans la fenêtre Détails de la tâche (Job Details). Les valeurs saisies sont affichées dans la fenêtre susmentionnée dans les cas suivants :

• elles ont été ajoutées au niveau du processus ;
• elles ont été ajoutées au niveau de la tâche.

Vous pouvez également afficher les arguments d'entrée et de sortie au niveau du package, dans la fenêtre Versions de packages (Package Versions). Pour plus d'informations, consultez la section Gestion des packages (Managing Packages).

Remarque : Les workflows qui ont été créés et publiés dans Orchestrator avant v2018.3 doivent être retéléchargés avec un robot v2018.3 (ou version ultérieure) pour que les arguments d'entrée et de sortie du fichier Main.xaml puissent s'afficher.

Autorisations d'arguments

Les autorisations suivantes sont requises par rapport aux arguments d'entrée et de sortie dans Orchestrator :

• au niveau du paquet, Consultation (View) des paquets ;
• au niveau du processus, Consultation (View) et Modification (Edit) des processus ;
• au niveau de la tâche, Création (Create) des tâches ;
• au niveau du déclencheur, Création (Create) et/ou Modification (Edit) des planifications.