À 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 paramètres 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 paramètres 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 paramètres d'entrée ne sont pas définis pour cette version ».

Les arguments d'entrée; de sortie ou d'entrée/de sortie d'un projet deviennent les paramètres d'entrée et de sortie lors de la publication dans Orchestrator. Notez que pour les arguments d'entrée/de sortie, deux paramètres différents sont créés et s'affichent dans Orchestrator, un d'entrée et un de sortie, avec le même nom.

Fourniture de valeurs de paramètres

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

Studio

As default values, when creating the arguments. A short example can be found here. A default value provided for an argument in Studio can be overwritten in Orchestrator, both at process or job level.

Remarque :

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

Orchestrator

• At process level - in the Parameters tab of the View Process window, as explained here.

• At job level - in the Parameters tab of the Start Job window, as explained here.

• At trigger level - in the Parameters tab of the Add trigger window, as explained here.

  Remarque :

  Une valeur fournie pour un paramètre 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.

Si vous fournissez des valeurs pour les paramètres d'entrée dans Orchestrator, notez qu'ils doivent être fournis dans un format JSON. Voici quelques exemples sur la manière de 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.

API Orchestrator

• At package level - to the /odata/Processes/UiPath.Server.Configuration.OData.SetArguments(key='key') endpoint;

• At process level - as a PATCH request to the /odata/Releases(Id) endpoint;

• At job level - as a POST request to the /odata/Jobs/UiPath.Server.Configuration.OData.StartJobs endpoint;

• At schedule level - as a POST request to the /odata/ProcessSchedules endpoint.

  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 paramètres 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 de paramètres

La valeur d'un paramètre d'entrée est marquée comme suit :

• Aucune valeur (No value) : aucune valeur n'a été fournie pour le paramètre 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 les valeurs de paramètres d'entrée ou de sortie existent, elles s'affichent dans la fenêtre Détails de la tâche (Job Details). Les valeurs d'entrée s'affichent 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.

You can also view input and output parameters at package level, in the Package Versions window. For more information, see the 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

The following permissions are required in relation to input and output parameters in 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 de la planification, Création (Create) et/ou Modification (Edit) des planifications.