Utilisation du service d’appel dans l’éditeur visuel de règles pour les formulaires basés sur les composants principaux

L’éditeur visuel de règles d’un formulaire adaptatif prend en charge la fonctionnalité Invoquer le service, qui vous permet de sélectionner un service dans la liste des modèles de données de formulaire (FDM) configurés pour votre instance. Vous pouvez mapper des champs de formulaire directement aux paramètres d’entrée du service. Pour mapper des champs de formulaire aux paramètres de sortie, utilisez l’option de payload d’événement pour le service de modèle de données de formulaire spécifié. En outre, l’éditeur visuel de règles vous permet de créer des règles pour les gestionnaires de succès et d’échec des opérations Invoke Service en fonction de ses réponses de sortie. Les gestionnaires de succès gèrent la réussite de l’exécution de l’opération Invoke Service, tandis que les gestionnaires d’échec traitent les erreurs qui se produisent.

Avantages de l’utilisation du service d’appel dans l’éditeur de règles du formulaire

L’utilisation de l’opération Invoke Service dans l’éditeur de règles d’un formulaire adaptatif présente les avantages suivants :

Appeler des gestionnaires de services pour les réponses de succès et d’échec

L’éditeur visuel de règles vous permet de créer des règles pour les gestionnaires de succès et d’échec des opérations Invoke Service en fonction de ses réponses de sortie. L’image ci-dessous illustre le service Invoke dans l’éditeur visuel de règles pour un formulaire adaptatif :

Pour ajouter un gestionnaire de succès ou d’échec, cliquez respectivement sur Ajouter un gestionnaire de succès ou Ajouter un gestionnaire d’échec.

Lorsque vous cliquez sur Ajouter un gestionnaire de succès, l’éditeur de règles Invoquer le gestionnaire de succès du service s’affiche et vous permet de spécifier des règles ou une logique pour gérer la réponse de sortie Invoquer le service lorsque l’opération réussit. Vous pouvez spécifier des règles même sans définir de conditions ; toutefois, vous pouvez ajouter des conditions pour le gestionnaire de succès en cliquant sur l’option Ajouter une condition.

Vous pouvez ajouter plusieurs règles pour gérer les réponses réussies de l’opération Invoke Service :

{width="50%,"}

De même, vous pouvez ajouter des règles pour gérer la réponse de sortie Invoke Service en cas d’échec de l’opération. L’image ci-dessous affiche l’éditeur de règles Invoke Service Failure Handler :

Vous pouvez également ajouter plusieurs règles pour gérer les réponses infructueuses de l’opération Invoke Service.

La fonction Activer la validation d’erreur sur le serveur permet les validations ajoutées par l’auteur lors de la conception d’un formulaire adaptatif à exécuter également sur le serveur.

Conditions préalables à l’utilisation du service Invoke dans l’éditeur de règles

Vous trouverez ci-dessous les conditions préalables à remplir avant d’utiliser Invoke Service dans l’éditeur de règles :

Explorer le service Invoke à travers différents cas d’utilisation

Le service d’appel de l’éditeur visuel de règles vous permet d’effectuer plusieurs opérations utiles. Vous pouvez l’utiliser pour renseigner les options de liste déroulante, définir des panneaux répétables ou simples et valider les champs de formulaire, le tout en fonction de la réponse de sortie du Appeler le service. Cela permet d’améliorer la flexibilité et l’interactivité de vos formulaires.

Le tableau ci-dessous décrit quelques scénarios dans lesquels le service Invoke peut être utilisé :

Créez un formulaire Get Information qui récupère des valeurs en fonction de l’entrée saisie dans la zone de texte Pet ID. La capture d’écran ci-dessous montre le formulaire utilisé dans ces cas d’utilisation :

Champs de formulaire

Ajoutez les champs suivants au formulaire :

NOTE

Dans le champ Référence de liaison de la boîte de dialogue Propriétés des champs de formulaire, sélectionnez et accédez à la propriété binaire que vous avez ajoutée dans le modèle de données de formulaire (FDM).

Configuration des panneaux

Définissez les panneaux de manière répétitive avec les contraintes suivantes :

Vous pouvez ajuster les valeurs des panneaux répétitifs en fonction de vos besoins.

Source de données

Dans cet exemple, l’API Swagger Petstore est utilisée pour configurer une source de données. Le Modèle de données de formulaire est configuré pour le service getPetById qui récupère les détails des animaux de compagnie en fonction de l’identifiant saisi.

Publions le fichier JSON suivant à l’aide du service addPet dans l’API Swagger Petstore :

{
        "id": 101,
        "category": {
            "id": 1,
            "name": "Labrador"
        },
        "name": "Lisa",
        "photoUrls": [
            "https://example.com/photos/lisa1.jpg",
            "https://example.com/photos/lisa2.jpg"
        ],
        "tags": [
            {
                "id": 1,
                "name": "vaccinated"
            },
            {
                "id": 2,
                "name": "friendly"
            },
            {
                "id": 3,
                "name": "house-trained"
            }
        ],
        "status": "available"
    }

Les règles et la logique sont mises en œuvre à l’aide de l’action Invoquer le service dans l’éditeur de règles de la zone de texte Pet ID pour démontrer les cas d’utilisation mentionnés.

Examinons maintenant en détail la mise en œuvre de chaque cas d’utilisation.

Cas d’utilisation 1 : remplissage des valeurs de liste déroulante à l’aide de la sortie du service d’appel

Ce cas d’utilisation montre comment remplir les options de liste déroulante de manière dynamique en fonction de la sortie d’un Invoke Service.

Implémentation

Pour ce faire, créez une règle dans la zone de texte Pet ID pour appeler le service getPetById. Dans la règle, définissez la propriété enum de la liste déroulante photo-url sur photoUrls dans Ajouter un gestionnaire de réussite.

Sortie

Saisissez 101 dans la zone de texte Pet ID pour renseigner dynamiquement les options de liste déroulante en fonction de la valeur saisie.

Cas d’utilisation 2 : définition du panneau répétable à l’aide de la sortie du service d’appel

Ce cas d’utilisation montre comment remplir dynamiquement les panneaux répétables en fonction de la sortie d’un Invoke Service.

Considérations

Implémentation

Créez une règle dans la zone de texte Pet ID pour appeler le service getPetById. Dans Ajouter un gestionnaire de succès, ajoutez une autre réponse de gestionnaire de succès. Définissez la valeur du panneau tags à tags dans la règle.

Sortie

Saisissez 101 dans la zone de texte Pet ID pour remplir dynamiquement le panneau répétable en fonction de la valeur d’entrée.

Cas d’utilisation 3 : définition du panneau à l’aide de la sortie du service d’appel

Ce cas d’utilisation montre comment définir dynamiquement la valeur d’un panneau en fonction de la sortie d’un Invoke Service.

Considérations

Implémentation

Créez une règle dans la zone de texte Pet ID pour appeler le service getPetById. Dans Ajouter un gestionnaire de succès, ajoutez une autre réponse de gestionnaire de succès. Définissez la valeur de la zone de texte categoryname à category.name dans la règle.

Sortie

Saisissez 101 dans la zone de texte Pet ID pour remplir le panneau de manière dynamique en fonction de la valeur d’entrée.

Cas d’utilisation 4 : utilisation du paramètre de sortie du service d’appel pour valider d’autres champs

Ce cas d’utilisation montre comment utiliser la sortie d’un Invoke Service pour valider dynamiquement d’autres champs de formulaire.

Implémentation

Créez une règle dans la zone de texte Pet ID pour appeler le service getPetById. Dans Ajouter un gestionnaire d’échec, ajoutez une réponse de gestionnaire d’échec. Masquez le bouton Envoyer si un Pet ID incorrect est saisi.

Sortie

Saisissez 102 dans la zone de texte Pet ID et le bouton Envoyer est masqué.

Questions fréquentes

Q : Que se passe-t-il si j’ai créé une règle à l’aide du service d’appel, puis que j’effectue une mise à niveau vers la dernière version des composants principaux ?

A : lorsque vous effectuez une mise à niveau vers la dernière version des composants principaux, la règle Invoke Service est automatiquement mise à jour vers la dernière interface utilisateur, car elle est rétrocompatible.

Q : Puis-je ajouter plusieurs règles pour gérer les réponses réussies ou en échec pour l’opération du service d’appel ?

A : Oui, vous pouvez ajouter plusieurs règles pour gérer les réponses réussies ou en échec pour l’opération Invoke Service.

Articles connexes

Ressources supplémentaires