Fonctions personnalisées dans le Forms adaptatif (composants principaux)

Version
Lien de l’article
AEM as a Cloud Service
Cliquez ici
AEM 6.5
Cet article

Présentation

AEM Forms 6.5 offre la possibilité de définir des fonctions JavaScript pouvant être utilisées pour définir des règles métier complexes à l’aide de l’éditeur de règles. AEM Forms fournit un certain nombre de fonctions personnalisées prêtes à l’emploi, mais vous devrez définir vos propres fonctions personnalisées et les utiliser dans plusieurs formulaires.

Les fonctions personnalisées étendent les capacités des formulaires en facilitant la manipulation et le traitement des données saisies pour répondre aux exigences spécifiées. Ils permettent également une modification dynamique du comportement du formulaire en fonction de critères prédéfinis.
Dans les Forms adaptatives, vous pouvez utiliser des fonctions personnalisées dans les éditeur de règles d’un formulaire adaptatif pour créer des règles de validation spécifiques pour les champs de formulaire.
Comprenons l’utilisation de la fonction personnalisée dans laquelle les utilisateurs saisissent l’adresse électronique et vous souhaitez vous assurer que l’adresse électronique saisie respecte un format spécifique (elle contient un symbole "@" et un nom de domaine). Créez une fonction personnalisée "ValidateEmail" qui prend l’adresse email en entrée et renvoie true si elle est valide et false dans le cas contraire.

function ValidateEmail(inputText)
{
    var email = /^\w+([\.-]?\w+)*@\w+([\.-]?\w+)*(\.\w{2,3})+$/;
    if(inputText.value.match(email))
        {
            alert("Valid email address!");
            return true;
        }
    else
    {
        alert("Invalid email address!");
        return false;
    }
}

Dans l’exemple ci-dessus, lorsque l’utilisateur tente d’envoyer le formulaire, la fonction personnalisée "ValidateEmail" est appelée pour vérifier si l’adresse électronique saisie est valide.

Utilisation de fonctions personnalisées uses-of-custom-function

Les avantages des fonctions personnalisées dans les Forms adaptatives sont les suivants :

  • Manipulation des données: les fonctions personnalisées manipulent et traitent les données saisies dans les champs de formulaires.
  • Validation des données: les fonctions personnalisées vous permettent d’effectuer des vérifications personnalisées sur les entrées de formulaire et de fournir des messages d’erreur spécifiés.
  • Comportement dynamique: les fonctions personnalisées vous permettent de contrôler le comportement dynamique de vos formulaires en fonction de conditions spécifiques. Vous pouvez, par exemple, afficher/masquer des champs, modifier les valeurs de champ ou ajuster dynamiquement la logique du formulaire.
  • Intégration: vous pouvez utiliser des fonctions personnalisées pour l’intégration à des API ou services externes. Il permet de récupérer des données provenant de sources externes, d’envoyer des données à des points de terminaison Rest externes ou d’effectuer des actions personnalisées basées sur des événements externes.

Annotations JS prises en charge

Assurez-vous que la fonction personnalisée que vous créez est accompagnée de la fonction jsdoc au-dessus, si vous avez besoin d’une configuration et d’une description personnalisées. Il existe plusieurs façons de déclarer une fonction dans JavaScript, Les commentaires et vous permettent de conserver une trace des fonctions. Pour plus d’informations, voir usejsdoc.org.

Balises jsdoc prises en charge :

  • Syntaxe
    Privé  : @private
    Une fonction privée n’est pas incluse comme fonction personnalisée.

  • Syntaxe
    Nom  : @name funcName <Function Name>
    Autrement,, vous pouvez utiliser : @function funcName <Function Name> ou @func funcName <Function Name>.
    funcName est le nom de la fonction (les espaces ne sont pas autorisés).
    <Function Name> est le nom d’affichage de la fonction.

  • Syntaxe
    Membre  : @memberof namespace
    Associe un espace de noms à la fonction.

  • Syntaxe
    Paramètre  : @param {type} name <Parameter Description>
    Autrement, vous pouvez utiliser : @argument {type} name <Parameter Description> ou @arg {type} name <Parameter Description>.
    Affiche les paramètres utilisés par la fonction. Une fonction peut comporter plusieurs balises de paramètre, une balise pour chaque paramètre dans l’ordre d’occurrence.
    {type} représente le type de paramètre. Les types de paramètre sont les suivants :

    1. chaîne
    2. nombre
    3. booléen
    4. portée

    La portée est utilisée pour les champs référents d’un formulaire adaptatif. Lorsqu’un formulaire utilise le chargement différé, vous pouvez utiliser scope pour accéder à ses champs. Vous pouvez accéder aux champs lorsque les champs sont chargés ou si les champs sont marqués comme généraux.

    Tous les autres types de paramètre sont classés en dessous de l’un des précédents. Ils sont tous pris en charge. Assurez-vous que vous sélectionnez l’un des types ci-dessus. Les types ne respectent pas la casse. Les espaces ne sont pas autorisés dans le paramètre name. <Parameter Descrption> <parameter> can have multiple words. </parameter>

  • Syntaxe
    Type de retour  : @return {type}
    Autrement, vous pouvez utiliser @returns {type}.
    Ajoute des informations sur la fonction, comme son objectif.
    {type} représente le type de valeur renvoyée de la fonction. Les types de valeur renvoyée autorisés sont les suivants :

    1. chaîne
    2. nombre
    3. booléen

    Tous les autres types de retour sont classés en dessous de l’un des précédents. Ils sont tous pris en charge. Assurez-vous que vous sélectionnez l’un des types ci-dessus. Les types de retour ne respectent pas la casse.

  • Cette
    syntaxe : @this currentComponent

    Utilisez @this pour faire référence au composant Formulaire adaptatif à partir duquel la règle a été créée.

    L’exemple ci-dessous repose sur la valeur du champ. Dans l’exemple ci-dessous, la règle masque un champ dans le formulaire. La partie this de this.value fait référence au composant Formulaire adaptatif sous-jacent, à partir duquel la règle a été créée.

    code language-none
       /**
       * @function myTestFunction
       * @this currentComponent
       * @param {scope} scope in which code inside function will be executed.
       */
       myTestFunction = function (scope) {
          if(this.value == "O"){
                scope.age.visible = true;
          } else {
             scope.age.visible = false;
          }
       }
    
    note note
    NOTE
    Les commentaires avant la fonction personnalisée sont utilisés pour le résumé. Le résumé peut s’étendre sur plusieurs lignes jusqu’à ce qu’une balise soit rencontrée. Limitez la taille à une seule pour une description concise dans le créateur de règles.

Types pris en charge pour la déclaration de fonction function-declaration-supported-types

Instruction de fonction

function area(len) {
    return len*len;
}

Cette fonction est incluse sans commentaires jsdoc.

Expression de fonction

var area;
//Some codes later
/** */
area = function(len) {
    return len*len;
};

Expression et instruction de fonction

var b={};
/** */
b.area = function(len) {
    return len*len;
}

Déclaration de fonction en tant que variable

/** */
var x1,
    area = function(len) {
        return len*len;
    },
    x2 =5, x3 =true;

Limite : la fonction personnalisée prend uniquement la première déclaration de fonction de la liste des variables, si elles sont ensemble. Vous pouvez utiliser l'expression de fonction pour chaque fonction déclarée.

Déclaration de fonction en tant qu’objet

var c = {
    b : {
        /** */
        area : function(len) {
            return len*len;
        }
    }
};

Créer une fonction personnalisée create-custom-function

Pour créer une fonction personnalisée, procédez comme suit :

  1. Connectez-vous à http://server:port/crx/de/index.jsp#.

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

  3. Enregistrez vos modifications.

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

  5. Accédez au dossier clientlibs nouvellement créé et ajoutez les propriétés allowProxy et categories :

    Propriétés du nœud de bibliothèque personnalisée

    note note
    NOTE
    Vous pouvez utiliser le nom de votre choix à la place de customfunctionsdemo.
  6. Enregistrez vos modifications.

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

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

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

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

    Structure de dossier de bibliothèque cliente créée

  11. Double-cliquez sur le fichier functions.js pour ouvrir l’éditeur. Le fichier comprend le code de la fonction personnalisée.
    Ajoutons le code suivant au fichier JavaScript pour calculer l’âge en fonction de la date de naissance (AAAA-MM-JJ).

    code language-javascript
        /**
             * Calculates Age
             * @name calculateAge
             * @return {string}
        */
    
        function calculateAge(dateOfBirthString) {
        var dob = new Date(dateOfBirthString);
        var now = new Date();
    
        var age = now.getFullYear() - dob.getFullYear();
        var monthDiff = now.getMonth() - dob.getMonth();
    
        if (monthDiff < 0 || (monthDiff === 0 && now.getDate() < dob.getDate())) {
        age--;
        }
    
        return age;
        }
    
  12. Enregistrez function.js.

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

    code language-javascript
        #base=js
        functions.js
    
  14. Enregistrez le fichier js.txt.

Vous pouvez vous référer aux fonction personnalisée dossier. Téléchargez et installez ce dossier dans votre instance AEM.

Désormais, vous pouvez utiliser la fonction personnalisée dans votre formulaire adaptatif en ajoutant la bibliothèque cliente.

Ajout d’une bibliothèque cliente dans un formulaire adaptatif use-custom-function

Une fois que vous avez déployé votre bibliothèque cliente dans votre environnement Forms CS, utilisez ses fonctionnalités dans votre formulaire adaptatif. Pour ajouter la bibliothèque cliente dans votre formulaire adaptatif

  1. Ouvrez votre formulaire en mode d’édition. Pour ouvrir un formulaire en mode d’édition, sélectionnez-le, puis Modifier.

  2. Ouvrez l’explorateur de contenu, puis sélectionnez le composant Conteneur de guide de votre formulaire adaptatif.

  3. Cliquez sur l’icône Propriétés du conteneur de guide . La fenêtre du conteneur de formulaires adaptatifs s’ouvre.

  4. Ouvrez le De base et sélectionnez le nom du catégorie de bibliothèque cliente dans la liste déroulante (dans ce cas, sélectionnez customfunctionscategory).

    Ajout de la bibliothèque cliente de fonction personnalisée

  5. Cliquez sur Terminé .

Vous pouvez maintenant créer une règle pour utiliser des fonctions personnalisées dans l’éditeur de règles :

Ajout de la bibliothèque cliente de fonction personnalisée

Maintenant, comprenons comment configurer et utiliser une fonction personnalisée à l’aide de la fonction Service d’appel de l’éditeur de règles dans AEM Forms.

recommendation-more-help
19ffd973-7af2-44d0-84b5-d547b0dffee2