Actions

Il existe plusieurs actions dans le service API Web Interact, qui sont appelées à l'aide de l'objet Blue Prism (Utilitaire – API Interact). En parcourant chacune des actions à tour de rôle, les sections en dessous expliquent comment les utiliser dans vos automatisations.

Toutes les actions du service API Web doivent être appelées à partir du VBO Utilitaire - API Interact dans Blue Prism, et non directement à partir du service Web.

Obtenir la soumission

L'action Obtenir la soumission effectue une action très similaire à l'action Obtenir l'élément suivant lorsqu'elle récupère les informations d'une file d'attente.

Pour l'utiliser, une action définie sur Obtenir la soumission est ajoutée à votre processus et à l'objet métier sélectionné. Il n'y a qu'un seul paramètre d'entrée : l'ID de soumission, comme illustré ci-dessous.

Les paramètres de sortie récupèrent le contenu du formulaire Interact, en utilisant l'ID de soumission dans une collection.

Lorsque la soumission est récupérée en utilisant cette méthodologie plutôt que l'action standard Obtenir l'élément suivant, le formatage des éléments de date est différent. À l'aide de la technique Obtenir l'élément suivant, la date est renvoyée au format Texte, tandis qu'avec Obtenir la soumission, elle est renvoyée au format Date et heure comme ci-dessous.

Pour obtenir une liste complète des restrictions, veuillez consulter la section Restrictions de l'objet Service API Web Interact.

Vous ne pouvez pas utiliser l'action Obtenir la soumission à moins que vous ne connaissiez l'ID de soumission, car il est propre à chaque soumission. Il ne peut pas être codé en dur dans votre automatisation. Cela doit être récupéré à l'aide de l'action Obtenir l'élément suivant.

Obtenir le schéma du formulaire

L'action Obtenir le schéma du formulaire permet d'obtenir la structure d'un formulaire Interact dans une collection, ce qui vous permet de manipuler puis d'utiliser l'action Créer une soumission pour créer un formulaire Interact vide ou partiellement créé pour qu'un utilisateur le remplisse et le soumette.

Il n'existe qu'un seul paramètre d'entrée qui est le nom du formulaire dans Interact pour lequel vous récupérez la structure, comme illustré ci-dessous.

Les paramètres de sortie sont similaires à l'action « Obtenir la soumission » où le statut de la requête est renvoyé avec une collection contenant les champs.

La collection récupérée est une collection vierge contenant la structure du formulaire.

Le format de la structure des champs présentés est similaire au format de l'action Obtenir l'élément suivant et, par conséquent, l'élément Date demande la soumission d'un type de données de texte. Le type Texte est utilisé afin de prendre en charge les types d'éléments de date à formats multiples dans Interact, où la date peut être fournie au format Royaume-Uni, États-Unis ou international.

La différence entre les formats des actions Obtenir l'élément suivant et Obtenir le schéma du formulaire est le champ de l'élément de chargement. L'action Obtenir l'élément suivant renvoie un lien vers l'emplacement de stockage du fichier tandis que l'action Obtenir le schéma du formulaire renvoie une collection qui inclut non seulement un lien, mais également les détails du fichier chargé. Cela est également requis lors de l'utilisation de l'action Charger un fichier.

Le format de la collection contenant les détails du fichier de chargement doit être défini correctement, comme illustré ci-dessus :

• Nom : le nom du fichier, y compris l'extension.
• Taille : la taille du fichier en octets.
• Extension : l'extension de fichier, sans le point de début ou point final.
• Lien : le lien vers le fichier chargé.
• Type : le type de fichier, par exemple « application/pdf » ou « image/png ».

Créer une soumission

Quatre paramètres doivent être définis dans l'action Créer une soumission.

Ces quatre paramètres sont les suivants :

• Nom d'utilisateur : il s'agit du nom d'utilisateur de l'utilisateur Interact pour lequel la soumission sera créée.
• Mot de passe : le mot de passe pour cet utilisateur Interact.
• Nom du formulaire : le formulaire qui sera créé dans Interact.
• Champs : les valeurs qui seront définies dans la soumission créée.

Pour faciliter la création d'une soumission, l'action Obtenir le schéma du formulaire peut être utilisée pour récupérer la structure de base du formulaire. Elle pourrait ensuite être remplie avec de nouveaux éléments de données, puis créée en tant que nouvelle soumission pour un utilisateur.

Pour créer une soumission, les champs et le schéma du formulaire doivent correspondre à ceux du formulaire dans Interact. Des champs manquants ou une structure incorrecte aboutiront à la création d'une soumission corrompue.

Une fois lancée, la soumission créée apparaîtra dans l'Historique des soumissions des utilisateurs spécifiés en tant que formulaire soumis et sera ajoutée à la file d'attente Blue Prism spécifiée détaillée dans la construction du formulaire.

L'utilisateur dont les identifiants sont utilisés pour créer la soumission doit être autorisé à accéder au formulaire. Par conséquent, l'utilisateur spécifié doit apparaître dans la liste des utilisateurs du rôle Interact qui contient le formulaire.

Il n'y a aucun paramètre de sortie pour l'action Créer une soumission.

Formuler une soumission

Modifier la valeur du champ de soumission

L'action Modifier la valeur du champ de soumission, comme toutes les autres actions, est appelée à partir de l'objet. Il existe plusieurs actions dans l'objet qui vous permettent de mettre à jour des éléments de champ spécifiques. Ces actions sont directement liées au type d'élément utilisé dans le formulaire Interact.

Le nom de champ dans les sections ci-dessous est l'ID d'automatisation qui a été créé dans le concepteur de formulaires.

Les détails des différents types d'éléments sont décrits dans les sections suivantes.

Élément Case à cocher (unique)

La valeur d'édition de case à cocher correspond à deux actions différentes prenant en charge l'utilisation de cases à cocher simples et multiples. Pour mettre à jour les valeurs d'une case à cocher unique, il s'agit d'une chaîne de texte simple qui est soumise.

Élément Case à cocher (multiple)

Pour la valeur d'édition de case à cocher (multiple) à nouveau, il s'agit d'une chaîne de texte simple qui est soumise, mais qui utilise une chaîne séparée par des virgules pour les différentes valeurs.

Élément Date

L'élément Date utilise le format Texte pour modifier les valeurs dans un formulaire Interact, afin de prendre en charge les trois formats différents dans le formulaire Interact. Le formulaire vous permettra d'utiliser ces formats pour les dates :

• JJ/MM/AAAA : format Royaume-Uni ;
• MM/JJ/AAAA : format États-Unis ;
• AAAA/MM/JJ : format International.

Si vous avez configuré le formulaire Interact pour accepter le format International pour les dates et que vous renvoyez la date au format Royaume-Uni ou États-Unis, le formulaire Interact affichera un message de données non valides.

Élément Menu déroulant (unique)

L'élément Menu déroulant, comme l'élément Case à cocher, prend en charge deux actions pour les entrées uniques et multiples. Pour mettre à jour les valeurs d'un menu déroulant unique, il s'agit d'une chaîne de texte simple qui est soumise.

Élément Menu déroulant (multiple)

Pour la valeur d'édition de menu déroulant (multiple) à nouveau, il s'agit d'une chaîne de texte simple qui est soumise, mais qui utilise une chaîne séparée par des virgules pour les différentes valeurs.

Élément Nombre

L'élément Nombre accepte soit un nombre, soit un texte qui lui est transmis. Bien que le type de champ soit un type Texte, vous devez fournir un nombre en utilisant uniquement les délimiteurs acceptables tels que les virgules et les points décimaux. Si le texte est renvoyé, le formulaire Interact affichera un message concernant les données non valides.

Élément Groupe de boutons radio

L'élément Groupe de boutons radio est comme un élément Menu déroulant ou Case à cocher unique. La valeur modifiée est un champ de texte unique qui inclut la valeur mise à jour requise.

Élément Tableau

L'élément Tableau utilise une collection pour vous permettre de mettre à jour les valeurs. La collection doit contenir le même nombre de colonnes que le champ du formulaire dans le formulaire ciblé. Les ID d'automatisation doivent être utilisés pour les noms de champ de la collection. Le nombre de lignes peut être augmenté ou diminué pour s'adapter aux données mises à jour.

L'action Modifier le tableau remplace l'ensemble du tableau par l'ajout de lignes à un tableau existant.

Élément Texte

L'élément Texte nécessite qu'un champ Texte simple lui soit transmis.

Élément Heure

L'élément Heure utilise le format Texte pour modifier les valeurs dans un formulaire Interact. Vous pouvez fournir l'heure dans l'un des deux formats suivants :

• 03:00:00 PM ; ou
• 15:00:00.

Les deux renverront 3 heures dans l'après-midi dans Interact.