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

Présentation

AEM Forms 6.5 offre la possibilité de définir des fonctions JavaScript qui peuvent ê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 le Forms adaptatif, vous pouvez utiliser des fonctions personnalisées dans l’ é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 :

Annotations JS prises en charge

Assurez-vous que la fonction personnalisée que vous écrivez est accompagnée de la fonction jsdoc ci-dessus, au cas où vous auriez besoin d’une configuration et d’une description personnalisées. Il existe plusieurs façons de déclarer une fonction dans JavaScript, et les commentaires vous permettent de conserver une trace des fonctions. Pour plus d’informations, voir usejsdoc.org.

Balises jsdoc prises en charge :

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 :

Vous pouvez vous référer au dossier custom function suivant. 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

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

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