Invoquer une API de tâche dans un formulaire

Créez un formulaire pour invoquer le API de tâche et associez les variables du API de tâche aux champs obligatoires du formulaire.

Prérequis

  • Vous devez disposer d'une licence Bot Creator.
  • Vous devez en premier lieu créer une API de tâche pour l'invoquer dans le formulaire.
Cette rubrique décrit comment invoquer une API de tâche dans un formulaire. Dans cet exemple, vous allez créer un formulaire de code postal qui invoque une API de tâche pour récupérer les détails du lieu et de l'État en fonction du code postal fourni. Le formulaire créé peut être exécuté par le biais d'un processus. Vous pouvez créer un formulaire avec les champs propres à votre cas d'utilisation.

Procédure

  1. Accédez à un formulaire existant ou créez-en un nouveau à l'emplacement où vous souhaitez invoquer un API de tâche. Pour plus d'informations, voir Créer un formulaire.
    Nommez ce formulaire Formulaire Code postal.
  2. Concevoir un formulaire : Utilisez les éléments de formulaire pour construire un formulaire interactif basé sur votre cas d'utilisation. Dans cet exemple, le formulaire est conçu pour mapper les variables de code postal à partir de la API de tâche.
    1. Dans la colonne Éléments, faites glisser l'élément Zone de texte et déposez-le dans votre concepteur de formulaires.
      L'onglet Propriétés apparaît avec les champs pertinents sur le côté droit de l'écran.
    2. Saisissez un Libellé de l'élément. Par exemple : Code postal.
    3. Si vous le souhaitez, renseignez les champs Min et Max du paramètre Limite de caractères. Par exemple, saisissez 1 dans le champ Min et 5 dans le champ Max.
    4. En outre, faites glisser deux autres éléments Zone de texte et nommez-les Lieu et État.
    5. Dans la colonne Éléments, faites glisser un élément Bouton et déposez-le dans votre concepteur de formulaires. Donnez un nom à ce bouton dans le champ Texte du bouton (obligatoire) (Par exemple : Réinitialiser). L'image suivante montre un formulaire rempli :
      Exemple de tâche API Code postal
  3. Ajoutez les règles de formulaire. Les règles de formulaire fournissent les conditions requises pour chaque élément du formulaire. Vous pouvez définir des règles de formulaire à l'aide des conditionssietalorset indiquer les actions qui seront exécutées lorsque les conditions sont remplies. Dans cet exemple, les règles de formulaire sont configurées de manière à ce que la valeur de l'élément Code postal soit supérieure ou égale à cinq. Si cette condition est remplie, la zone Lieu et État récupère les valeurs des variables API de tâche. Lors de l'exécution, la API de tâche ne fonctionnera pas comme prévu si les conditions de la règle de formulaire ne sont pas remplies.
    1. Cliquez sur l'onglet Règles de formulaire.
    2. Si vous le souhaitez, saisissez un nom pour la règle. (Par exemple, Appel du API de tâche).
    3. Saisissez une condition Si pour valider le code postal saisi. Par exemple, vous pouvez vérifier si le code postal saisi comporte au minimum 5 caractères.
      Exemple de tâche API Code postal - Vérification des 5 caractères minimum
    4. Pour définir la clause Alors, sélectionnez Actions de formulaire, puis sélectionnez Obtenir la valeur de l'appel d'API dans le menu déroulant.
      Formulaire de tâche API Code postal - Condition Alors
    5. Vous pouvez mapper les variables associées au API de tâche sur un formulaire en utilisant l'option Ajouter un mappage de variables.
      Remarque : Si vous modifiez un API de tâche publié et que vous ajoutez des variables supplémentaires après avoir archivé la tâche, les variables ne s'affichent pas dans le formulaire. Vous devez enregistrer le API de tâche après avoir ajouté les variables.
    6. Cliquez sur Parcourir pour sélectionner une API de tâche spécifique afin d'effectuer une opération spécifiée. Dans cet exemple, un API de tâche (Tâche Code postal) est sélectionné pour récupérer le lieu et l'état de n'importe quel code postal.
  4. Ajoutez une règle au bouton Réinitialiser. Dans cet exemple, les règles de formulaire pour le bouton de réinitialisation sont définies de façon à effacer les valeurs de tous les champs lorsque vous cliquez sur le bouton Réinitialiser.
    1. Cliquez sur le bouton Ajouter une règle.
    2. Saisissez une condition Si pour capturer l'état Est cliqué du bouton. Cette condition est vraie chaque fois qu'une personne clique sur le bouton.
      Exemple de tâche API Code postal - Vérification des 5 caractères minimum
    3. Pour définir la clause Alors, cliquez sur Ajouter une action, puis cliquez sur la liste déroulante Sélectionner un élément pour sélectionner tous les éléments Zone de texte qui doivent être effacés lorsque vous cliquez sur le bouton Réinitialiser.
      Formulaire de tâche API Code postal - Réinitialiser
    4. Cliquez sur la liste déroulante située sous la liste déroulante Sélectionner un élément et sélectionnez Effacer la valeur.
      Remarque : Lorsque vous invoquez un API de tâche dans un formulaire à plusieurs reprises au cours d'une même session, vous pouvez rencontrer une erreur. Pour résoudre cette erreur, ajoutez un bouton de réinitialisation au formulaire pour effacer les valeurs existantes.