Gestionnaires d’erreurs dans Forms adaptatif (composants principaux)

AEM Forms fournit des gestionnaires de succès et d’erreurs prêts à l’emploi pour les soumissions de formulaires. Il fournit également une fonctionnalité pour personnaliser les fonctions du gestionnaire d’erreurs. Par exemple, vous pouvez appeler un workflow personnalisé dans le serveur principal pour des codes d’erreur spécifiques ou informer le client ou la cliente que le service est indisponible. Les gestionnaires sont des fonctions côté client qui s’exécutent en fonction de la réponse du serveur. Lorsqu’un service externe est appelé à l’aide des API, les données sont transmises au serveur pour validation, qui renvoie une réponse au client ou à la cliente avec des informations sur le succès ou l’erreur de la soumission. Les informations sont transmises en tant que paramètres au gestionnaire approprié pour exécuter la fonction. Un gestionnaire d’erreurs permet de gérer et d’afficher les erreurs ou les problèmes de validation rencontrés.

Le formulaire adaptatif valide les entrées que vous fournissez dans les champs en fonction de critères de validation prédéfinis et vérifie diverses erreurs renvoyées par le point de terminaison REST configuré pour appeler un service externe. Vous pouvez définir les critères de validation en fonction de la source de données que vous utilisez avec le formulaire adaptatif. Par exemple, si vous utilisez des services web RESTful comme source de données, vous pouvez définir les critères de validation dans un fichier de définition Swagger.

Si les valeurs d’entrée répondent aux critères de validation, les valeurs sont envoyées à la source de données, sinon le formulaire adaptatif affiche un message d’erreur à l’aide d’un gestionnaire d’erreurs. De la même manière que cette approche, Adaptive Forms s’intègre aux gestionnaires d’erreurs personnalisés pour effectuer des validations de données. Si les valeurs d’entrée ne répondent pas aux critères de validation, les messages d’erreur s’affichent au niveau du champ dans le formulaire adaptatif. Cela se produit lorsque le message d’erreur de validation renvoyé par le serveur est au format standard du message.

Utilisation des gestionnaires d’erreurs

Les gestionnaires d’erreurs sont utilisés à diverses fins. Certaines des utilisations des fonctions de gestionnaire d’erreurs sont répertoriées ci-dessous :

• Effectuer une validation : la gestion des erreurs commence par la validation des entrées utilisateur par rapport à des règles ou critères prédéfinis. Lorsque les utilisateurs ou les utilisatrices remplissent un formulaire adaptatif, le gestionnaire d’erreurs valide l’entrée afin de s’assurer qu’elle respecte le format, la longueur ou toute autre contrainte.

• Fournir des commentaires en temps réel : lorsqu’une erreur est détectée, le gestionnaire d’erreurs affiche des commentaires immédiats à l’utilisateur ou à l’utilisatrice, tels que des messages d’erreur intégrés sous les champs de formulaire correspondants. Ces commentaires permettent aux utilisateurs et aux utilisatrices d’identifier et de corriger les erreurs sans avoir à envoyer le formulaire et attendre une réponse.

• Affichage des messages d’erreur : lorsqu’un envoi de formulaire adaptatif rencontre une erreur de validation, le gestionnaire d’erreurs affiche un message d’erreur approprié. Les messages d’erreur doivent être clairs, concis et mettre en évidence les champs spécifiques qui nécessitent une attention particulière.

• Mise en surbrillance du champ erroné : pour attirer l’attention de l’utilisateur ou de l’utilisatrice sur les champs spécifiques incorrects, le gestionnaire d’erreurs surligne ou distingue visuellement les champs correspondants. Il est effectué en modifiant la couleur d’arrière-plan, en ajoutant une icône ou une bordure, ou tout autre indice visuel qui aide les utilisateurs et les utilisatrices à localiser et à corriger rapidement les erreurs.

Format de réponse échec/erreur

Un formulaire adaptatif affiche les erreurs au niveau du champ si les messages d’erreur de validation du serveur sont au format standard suivant.
Le code ci-dessous illustre la structure de réponse d’échec existante :

   {
    errorCausedBy : "SERVER_SIDE_VALIDATION/SERVICE_INVOCATION_FAILURE"
    errors : [
        {
             errorMessage / errorMessages : <validationMsg> / [<validationMsg>, <validationMsg>]
        }
    ]
    originCode : <target error Code>
    originMessage : <unstructured error message returned by service>
    }

Où :

• errorCausedBy décrit la raison de l’échec.
• errors mentionnez le nom de champ qualifié des champs qui ont échoué aux critères de validation avec le message d’erreur de validation.
• originCode est un champ ajouté par AEM, qui contient le code d’état http renvoyé par le service externe.
• originMessage est un champ ajouté par AEM, qui contient les données d’erreur brutes renvoyées par le service externe.

Avec les améliorations des fonctionnalités et les mises à jour ultérieures dans les versions d’AEM Forms, la structure de réponse aux échecs existante a été changée en nouveau format basé sur RFC7807, qui est rétrocompatible avec la structure de réponse aux échecs existante :

    {
        "type": "SERVER_SIDE_VALIDATION/FORM_SUBMISSION/SERVICE_INVOCATION/FAILURE/VALIDATION_ERROR", (required)
        "title": "Server side validation failed/Third party service invocation failed", (optional)
        "detail": "", (optional)
        "instance": "", (optional)
        "validationErrors" : [ (required)
            {
                "fieldName":"<qualified fieldname of the field whose data sent is invalid>",
                "dataRef":<JSONPath (or XPath) of the data element which is invalid>
                "details": ["Error Message(s) for the field"] (required)

            }
        ],
        "originCode": <Origin http status code>, (optional - if there is SERVER_SIDE_VALIDATION)
        "originMessage" : "<unstructured error message returned by service>" (optional - if there is SERVER_SIDE_VALIDATION)
    }

Où :

• type (required) spécifie le type d’échec. Les valeurs peuvent être les suivantes :

  • SERVER_SIDE_VALIDATION indique un échec en raison de la validation côté serveur.
  • FORM_SUBMISSION indique un échec lors de l’envoi du formulaire
  • SERVICE_INVOCATION indique un échec lors d’un appel de service tiers.
  • FAILURE indique un échec général.
  • VALIDATION_ERROR indique un échec en raison d’une erreur de validation.

• title (optional) fournit un titre ou une brève description de l’échec.

• detail (optional) fournit des détails supplémentaires sur l’échec, si nécessaire.

• instance (optional) représente une instance ou un identifiant associé à l’échec et permet de suivre ou d’identifier l’occurrence spécifique de l’échec.

• validationErrors (required) contient des informations sur les erreurs de validation. Les champs suivants sont inclus :

  • fieldname mentionne le nom de champ qualifié des champs qui n’ont pas rempli les critères de validation.
  • dataRef représente le chemin JSON ou XPath des champs qui ont échoué à la validation.
  • details contiennent le message d’erreur de validation avec le champ en erreur.

• originCode (optional) est un champ ajouté par AEM, qui contient le code d’état http renvoyé par le service externe

• originMessage (optional) est un champ ajouté par AEM, qui contient les données d’erreur brutes renvoyées par le service externe.

Exemple de format de réponse d’erreur

Voici quelques options pour afficher les réponses d’erreur :

Conditions préalables requises

Avant d’utiliser un gestionnaire d’erreur dans une Forms adaptative :

• Activation des composants principaux de Forms adaptatif pour votre environnement.
• Connaissances de base en créer une fonction personnalisée.
• Installez la dernière version d’Apache Maven.

Ajouter un gestionnaire d’erreurs à l’aide de l’éditeur de règles

En utilisant l’action Service d’appel de l’éditeur de règles, vous définissez les critères de validation en fonction de la source de données que vous utilisez avec le formulaire adaptatif. Si vous utilisez des services web RESTful comme source de données, vous pouvez définir les critères de validation dans un fichier de définition Swagger. En utilisant les fonctions de gestionnaire d’erreurs et l’éditeur de règles dans Adaptive Forms, vous pouvez gérer et personnaliser efficacement la gestion des erreurs. Vous définissez les conditions à l’aide de l’éditeur de règles et configurez les actions à effectuer lorsque la règle est déclenchée. Un formulaire adaptatif valide les entrées que vous fournissez dans les champs en fonction de critères de validation prédéfinis. Si les valeurs d’entrée ne répondent pas aux critères de validation, les messages d’erreur s’affichent au niveau du champ dans un formulaire adaptatif.

L’éditeur de règles vous permet d’effectuer les opérations suivantes :

• Ajouter la fonction de gestionnaire d’erreurs par défaut
• Ajouter une fonction de gestionnaire d’erreurs personnalisé

Ajouter la fonction de gestionnaire d’erreurs par défaut

Un gestionnaire d’erreurs par défaut est pris en charge pour afficher les messages d’erreur sur les champs si la réponse d’erreur se trouve dans le schéma standard ou dans un échec de validation côté serveur.
Pour comprendre comment utiliser un gestionnaire d’erreurs par défaut à l’aide de la méthode Service d’appel de l’éditeur de règles , prenez un exemple de formulaire adaptatif simple avec deux champs, Identifiant de paramètre prédéfini et Nom du paramètre prédéfini et utilisez un gestionnaire d’erreurs par défaut au niveau de l’événement Identifiant de paramètre prédéfini pour vérifier les différentes erreurs renvoyées par le point de terminaison REST configuré pour appeler un service externe, par exemple : 200 - OK,404 - Not Found, 400 - Bad Request. Pour ajouter un gestionnaire d’erreurs par défaut à l’aide de l’action Invoke Service de l’éditeur de règles, procédez comme suit :

1. Ouvrez un formulaire adaptatif en mode création, sélectionnez un composant de formulaire, puis sélectionnez Éditeur de règles pour ouvrir l’éditeur de règles.
2. Sélectionnez Créer.
3. Définissez une condition dans la section Lorsque de la règle. Par exemple : When[Nom du champ Identifiant de l’animal domestique] est modifiée. L’option Sélectionner est modifiée à partir du Sélectionner un état liste déroulante.
4. Dans la section Then (Alors), sélectionnez Invoke Service (Appeler un service) dans la liste déroulante Select Action (Sélectionner une action).
5. Sélectionnez un service Post et ses liaisons de données correspondantes dans la section Entrée. Par exemple, pour valider Identifiant d’animal domestique, sélectionnez un service Post comme GET /pet/{petId}, puis sélectionnez Identifiant d’animal domestique dans la section Entrée.
6. Sélectionnez les liaisons de données dans la section Sortie. Sélectionner Nom du paramètre prédéfini dans le Sortie .
7. Sélectionner Gestionnaire d’erreurs par défaut de la Gestionnaire d’erreurs .
8. Cliquez sur Terminé.

À la suite de cette règle, les valeurs que vous saisissez pour Identifiant d’animal domestique vérifie la validation du Nom de l’animal domestique à l’aide du service externe appelé par le point d’entrée REST. Si les critères de validation basés sur la source de données échouent, les messages d’erreur s’affichent au niveau du champ.

Ajouter une fonction de gestionnaire d’erreurs personnalisé

Vous pouvez ajouter une fonction de gestionnaire d’erreurs personnalisé pour effectuer certaines des actions suivantes :

• gérer les réponses d’erreur qui utilisent des réponses d’erreur non standard ou standard. Il est important de noter que ces réponses d’erreur non standard ne sont pas conformes au schéma standard des réponses d’erreur.
• envoyer des événements d’analyse à n’importe quelle plate-forme analytics. Par exemple, Adobe Analytics.
• afficher la boîte de dialogue modale avec les messages d’erreur.

Outre les actions mentionnées, les gestionnaires d’erreurs personnalisés peuvent être utilisés pour exécuter des fonctions personnalisées répondant à des besoins spécifiques de l’utilisateur ou l’utilisatrice.

Le gestionnaire d’erreurs personnalisé est une fonction (bibliothèque cliente) conçue pour répondre aux erreurs renvoyées par un service externe et fournir une réponse personnalisée aux utilisateurs et utilisatrices finaux. Toute bibliothèque cliente avec l’annotation @errorHandler est considérée comme une fonction de gestionnaire d’erreurs personnalisé. Cette annotation permet d’identifier la fonction de gestionnaire d’erreurs spécifiée dans la variable .js fichier .

Pour comprendre comment créer et utiliser un gestionnaire d’erreurs personnalisé à l’aide de l’action Service Invoke de l’éditeur de règles, prenons un exemple de formulaire adaptatif avec deux champs, Identifiant d’animal domestique et Nom de l’animal domestique et utilisez un gestionnaire d’erreurs personnalisé sur le champ Identifiant d’animal domestique pour vérifier les différentes erreurs renvoyées par le point d’entrée REST configuré pour appeler un service externe, par exemple : 200 - OK,404 - Not Found, 400 - Bad Request.

Pour ajouter et utiliser un gestionnaire d’erreurs personnalisé dans un formulaire adaptatif, procédez comme suit :

1. Créez un gestionnaire d’erreurs personnalisé
2. Utilisez l’éditeur de règles pour configurer le gestionnaire d’erreurs personnalisé

1. Créer un gestionnaire d’erreurs personnalisé

Pour créer une fonction de gestionnaire d’erreur personnalisée, procédez comme suit :

1. Se connecter http://server:port/crx/de/index.jsp#.

2. Créez un dossier sous le /apps dossier. Par exemple, créez un dossier nommé comme experience-league.

3. Enregistrez vos modifications.

4. Accédez au dossier créé et créez un noeud de type cq:ClientLibraryFolder as clientlibs.

5. Accédez au clientlibs et ajoutez le dossier allowProxy et categories properties:

   

   REMARQUE

   Vous pouvez indiquer n’importe quel nom à la place de customfunctionsdemo.

6. Enregistrez vos modifications.

7. Créez un dossier appelé js sous le clientlibs dossier.

8. Créez un fichier JavaScript appelé functions.js sous le js folder

9. Créez un fichier appelé js.txt sous le clientlibs dossier.

10. Enregistrez vos modifications.
    La structure de dossiers créée ressemble à ce qui suit :

    

11. Double-cliquez sur le functions.js pour ouvrir l’éditeur. Le fichier comprend le code du gestionnaire d’erreurs personnalisé.
    Ajoutons le code suivant au fichier JavaScript pour afficher la réponse et les en-têtes reçus du point d’entrée du service REST dans la console du navigateur.

        /**
        Custom Error handler
        * @name customErrorHandler Custom Error Handler Function
        * @errorHandler
        */
        function customErrorHandler(response, headers, globals)
        {
            console.log("Custom Error Handler processing start...");
            console.log("response:"+JSON.stringify(response));
            console.log("headers:"+JSON.stringify(headers));
            alert("CustomErrorHandler - Please enter valid PetId.")
            globals.invoke('defaultErrorHandler',response, headers)
            console.log("Custom Error Handler processing end...");
        }
    

    Pour appeler le gestionnaire d’erreurs par défaut à partir de votre gestionnaire d’erreurs personnalisé, la ligne suivante de l’exemple de code est utilisée :
    globals.invoke('defaultErrorHandler',response, headers)

12. Enregistrer function.js.

13. Accédez à js.txt et ajoutez le code suivant :

        #base=js
        functions.js
    

14. Enregistrez le fichier js.txt.

Maintenant, apprenons comment configurer et utiliser un gestionnaire d’erreurs personnalisé à l’aide du service Invoke de l’éditeur de règles dans AEM Forms.

2. Utiliser l’éditeur de règles pour configurer le gestionnaire d’erreurs personnalisé

Avant d’implémenter le gestionnaire d’erreurs personnalisé dans un formulaire adaptatif, assurez-vous que le nom de la bibliothèque cliente dans la variable Catégorie de bibliothèque cliente s’aligne sur le nom spécifié dans l’option categories de la variable .content.xml fichier .

Dans ce cas, le nom de la bibliothèque cliente est fourni comme suit : customfunctionsdemo dans le .content.xml fichier .

Pour utiliser un gestionnaire d’erreurs personnalisé à l’aide de l’action Service Invoke de l’éditeur de règles :

1. Ouvrez un formulaire adaptatif en mode création, sélectionnez un composant de formulaire, puis sélectionnez Éditeur de règles pour ouvrir l’éditeur de règles.
2. Sélectionnez Créer.
3. Définissez une condition dans la section Lorsque de la règle. Par exemple, lorsque [Nom du champ Identifiant de l’animal domestique] est modifié, sélectionnez est modifié dans la liste déroulante Sélectionner un état.
4. Dans la section Then (Alors), sélectionnez Invoke Service (Appeler un service) dans la liste déroulante Select Action (Sélectionner une action).
5. Sélectionnez un service Post et ses liaisons de données correspondantes dans la section Entrée. Par exemple, pour valider Identifiant d’animal domestique, sélectionnez un service Post comme GET /pet/{petId}, puis sélectionnez Identifiant d’animal domestique dans la section Entrée.
6. Sélectionnez les liaisons de données dans la section Sortie. Par exemple, sélectionnez Nom de l’animal domestique dans la section Sortie.
7. Sélectionnez Gestionnaire d’erreurs personnalisé dans la section Gestionnaire d’erreurs.
8. Cliquez sur Terminé.

À la suite de cette règle, les valeurs que vous saisissez pour Identifiant d’animal domestique vérifie la validation du Nom de l’animal domestique à l’aide du service externe appelé par le point d’entrée REST. Si les critères de validation basés sur la source de données échouent, les messages d’erreur s’affichent au niveau du champ.

Ouvrez la console du navigateur et vérifiez le message d’erreur de validation de la réponse et de l’en-tête reçus du point d’entrée du service REST.

La fonction de gestionnaire d’erreurs personnalisé est chargée de l’exécution d’actions supplémentaires telles que l’affichage d’une boîte de dialogue modale ou l’envoi d’un événement d’analyse, en fonction de la réponse à l’erreur. Une fonction de gestionnaire d’erreurs personnalisé offre la possibilité de personnaliser la gestion des erreurs en fonction des besoins spécifiques de l’utilisateur ou utilisatrice.

Voir également

• Création d’un formulaire adaptatif basé sur des composants principaux autonomes
• Créer un style ou des thèmes pour vos formulaires
• Créer ou ajouter un formulaire adaptatif à une page AEM Sites