Benutzerdefinierte Funktionen in adaptiven Formularen

Einführung

AEM Forms 6.5 bietet nun die Möglichkeit, JavaScript-Funktionen zu definieren, mit denen komplexe Geschäftsregeln mithilfe des Regeleditors definiert werden können. AEM Forms bietet eine Reihe solcher benutzerdefinierten Funktionen standardmäßig, aber Sie müssen Ihre eigenen benutzerdefinierten Funktionen definieren und sie in mehreren Formularen verwenden.

Die benutzerdefinierten Funktionen erweitern die Funktionen von Formularen, indem sie die Bearbeitung und Verarbeitung der eingegebenen Daten erleichtern, um bestimmten Anforderungen gerecht zu werden. Sie ermöglichen auch eine dynamische Änderung des Formularverhaltens basierend auf vordefinierten Kriterien.
In adaptiven Formularen können Sie benutzerdefinierte Funktionen im Regeleditor eines adaptiven Formulars verwenden, um spezifische Validierungsregeln für Formularfelder zu erstellen.
Nehmen wir an, Sie verwenden eine benutzerdefinierte Funktion, bei der Benutzende eine E-Mail-Adresse eingeben. Sie möchten sicherstellen, dass die eingegebene E-Mail-Adresse einem bestimmten Format entspricht (sie muss ein „@“-Symbol und einen Domain-Namen enthalten). Erstellen Sie eine benutzerdefinierte Funktion als „ValidateEmail“, die die E-Mail-Adresse als Eingabe verwendet und „true“ zurückgibt, wenn sie gültig ist, und andernfalls „false“.

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;
    }
}

Im obigen Beispiel wird die benutzerdefinierte Funktion „ValidateEmail“ aufgerufen, wenn die Benutzenden versuchen, das Formular zu senden, um zu überprüfen, ob die eingegebene E-Mail-Adresse gültig ist.

Vorteile benutzerdefinierter Funktionen uses-of-custom-function

Die Verwendung benutzerdefinierter Funktionen in adaptiven Formularen bietet folgende Vorteile:

Unterstützte JS-Anmerkungen

Stellen Sie sicher, dass die benutzerdefinierte Funktion, die Sie schreiben, mit einem darüber stehenden jsdoc versehen ist, falls Sie eine benutzerdefinierte Konfiguration und Beschreibung benötigen. Es gibt in JavaScript, mehrere Möglichkeiten, eine Funktion zu deklarieren, und Kommentare helfen Ihnen, den Überblick über die Funktionen zu behalten. Weitere Informationen finden Sie unter usejsdoc.org.

Unterstützte jsdoc-Tags:

Unterstützte Typen von Funktionsdeklarationen function-declaration-supported-types

Funktionsanweisung

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

Diese Funktion wird ohne jsdoc-Kommentare eingefügt.

Funktionsausdruck

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

Funktionsausdruck und -anweisung

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

Funktionsdeklaration als Variable

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

Einschränkung: Über die benutzerdefinierte Funktion wird nur die erste Funktionsdeklaration aus der Variablenliste ausgewählt, falls zusammen vorhanden. Der Funktionsausdruck kann für jede deklarierte Funktion verwendet werden.

Funktionsdeklaration als Objekt

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

Erstellen einer benutzerdefinierten Funktion create-custom-function

Gehen Sie wie folgt vor, um eine benutzerdefinierte Funktion zu erstellen:

Sie können auf den folgenden Ordner benutzerdefinierte Funktion verweisen. Laden Sie diesen Ordner herunter und installieren Sie ihn in Ihrer AEM-Instanz.

Jetzt können Sie die benutzerdefinierte Funktion in Ihrem adaptiven Formular verwenden, indem Sie die Client-Bibliothek hinzufügen.

Hinzufügen einer Client-Bibliothek in einem adaptiven Formular use-custom-function

Nachdem Sie Ihre Client-Bibliothek in Ihrer Forms CS-Umgebung bereitgestellt haben, verwenden Sie die zugehörigen Funktionen in Ihrem adaptiven Formular. Hinzufügen der Client-Bibliothek zu einem adaptiven Formular

Jetzt können Sie eine Regel erstellen, um benutzerdefinierte Funktionen im Regeleditor zu verwenden:

Im Folgenden erfahren Sie, wie Sie einen benutzerdefinierten Fehler-Handler mit dem Aufrufdienst des Regeleditors in AEM Forms konfigurieren und verwenden.