Adaptive Formularausdrücke adaptive-form-expressions

Adobe empfiehlt, die modernen und erweiterbaren Kernkomponentenzur Datenerfassung zu verwenden, um neue adaptive Formulare zu erstellenoder adaptive Formulare zu AEM Sites-Seiten hinzuzufügen. Diese Komponenten stellen einen bedeutenden Fortschritt bei der Erstellung adaptiver Formulare dar und sorgen für beeindruckende Anwendererlebnisse. In diesem Artikel wird der ältere Ansatz zum Erstellen adaptiver Formulare mithilfe von Foundation-Komponenten beschrieben.

Adaptive Formulare ermöglichen Endbenutzenden, die sich mit dynamischem Scripting auskennen, ein optimiertes und vereinfachtes Ausfüllen von Formularen. Sie können so Ausdrücke zum Hinzufügen verschiedener Verhaltensweisen schreiben, wie etwa für dynamisch ein-/ausgeblendete Felder und Panels. Außerdem können Sie auch berechnete Felder oder Überprüfungslogik hinzufügen, Felder als schreibgeschützt festlegen und vieles mehr. Das dynamische Verhalten basiert auf den vom Benutzer eingegebenen oder vorab eingetragenen Daten.

JavaScript ist die Ausdruckssprache, die sogenannte Expression Language von adaptiven Formularen. Alle Ausdrücke sind gültige JavaScript-Ausdrücke und nutzen Scripting-Modell-APIs für adaptive Formulare. Diese Ausdrücke geben Werte bestimmter Typen zurück. Eine vollständige Liste der Klassen, Ereignisse, Objekte und öffentlichen APIs für adaptive Formulare finden Sie unter API-Referenz der JavaScript-Bibliothek für adaptive Formulare.

Best Practices für das Schreiben von Ausdrücken best-practices-for-writing-expressions

Empfohlene Vorgehensweisen für Ausdrücke in Verbindung mit Wiederholungsbereichen best-practices-for-expressions-involving-repeating-panel

Wiederholungsbereiche sind Instanzen eines Bereichs, die mithilfe einer Skripterstellungs-API oder vorausgefüllter Daten dynamisch hinzugefügt oder entfernt werden. Ausführliche Informationen zum Verwenden von sich wiederholenden Panels finden Sie unter Erstellen von Formularen mit wiederholbaren Panels.

Ausdruckstypen expression-types

In adaptiven Formularen können Sie Ausdrücke zum Hinzufügen von Verhaltensweisen schreiben, wie etwa dynamisches Einblenden/Ausblenden von Feldern und Fenstern. Sie können auch Ausdrücke schreiben, um berechnete Felder hinzuzufügen, Felder als schreibgeschützt festzulegen, Überprüfungslogik hinzuzufügen und vieles mehr. Adaptive Formulare unterstützen folgende Ausdrücke:

Ausdruck für den Zugriff (Ausdruck für die Aktivierung) access-expression-enablement-expression

Mit dem Ausdruck für den Zugriff können Sie ein Feld aktivieren oder deaktivieren. Wenn der Ausdruck den Wert eines Felds verwendet, wird der Ausdruck erneut ausgelöst, sobald der Wert des Felds sich ändert.

Gilt für: Felder.

Rückgabetyp: Der Ausdruck gibt einen booleschen Wert zurück, der den Aktivierungsstatus des Felds wiedergibt. true bedeutet, dass das Feld aktiviert ist, und false, dass das Feld deaktiviert ist.

Beispiel: Wenn ein Feld nur dann aktiviert sein soll, wenn der Wert von field1 auf X eingestellt ist, lautet der Ausdruck für den Zugriff wie folgt: field1.value == "X"

Ausdruck für Berechnungen calculate-expression

Der Ausdruck für Berechnungen wird verwendet, um den Wert eines Felds unter Verwendung eines Ausdrucks automatisch zu berechnen. Normalerweise verwendet ein solcher Ausdruck die Werteigenschaft anderer Felder. Beispiel: field2.value + field3.value. Sobald sich der Wert von field2 oder field3 ändert, wird der Ausdruck erneut ausgelöst und der Wert neu berechnet.

Gilt für: Felder.

Rückgabetyp: Der Ausdruck gibt einen Wert zurück, der mit dem Feld kompatibel ist, in dem das Ausdrucksergebnis angezeigt wird (z. B. eine Dezimalzahl).

Beispiel: Zum Anzeigen der Summe zweier Felder in field1 lautet der Berechnungsausdruck wie folgt:
field2.value + field3.value

Ausdruck für ein Klickereignis click-expression

Der Ausdruck für ein Klickereignis verarbeitet die Aktionen, die beim Klicken auf eine Schaltfläche durchgeführt werden. GuideBridge bietet standardmäßig APIs zum Ausführen verschiedener Funktionen wie Senden und Validieren, die zusammen mit dem Ausdruck für ein Klickereignis verwendet werden. Eine vollständige Liste der APIs finden Sie unter GuideBridge-APIs.

Gilt für: Felder mit Schaltfläche

Rückgabetyp: Der Ausdruck für ein Klickereignis gibt keinen Wert zurück. Wenn ein Ausdruck einen Wert zurückgibt, wird dieser Wert ignoriert.

Beispiel: Zum Ausfüllen eines Textfelds textbox1 beim Klicken auf eine Schaltfläche mit dem Wert AEM Forms lautet der Ausdruck für ein Klickereignis wie folgt: textbox1.value="AEM Forms"

Initialisierungsskript initialization-script

Das Initialisierungsskript wird ausgelöst, wenn ein adaptives Formular initialisiert wird. Je nach Szenario verhält sich das Initialisierungsskript wie folgt:

Gilt für: Felder und Panels.

Rückgabetyp: Der Ausdruck für das Initialisierungsskript gibt keinen Wert zurück. Wenn ein Ausdruck einen Wert zurückgibt, wird dieser Wert ignoriert.

Beispiel: Damit in einem Szenario mit vorausgefüllten Daten Felder, deren Wert als null gespeichert ist, mit dem Standardwert 'Adaptive Forms' aufgefüllt werden, lautet der Ausdruck für das Initialisierungsskript wie folgt:
if(this.value==null) this.value='Adaptive Forms';

Ausdruck für Optionen options-expression

Der Ausdruck für Optionen wird zum dynamischen Ausfüllen von Optionen in einem Dropdown-Listenfeld verwendet.

Gilt für: Dropdown-Listenfelder

Rückgabetyp: Der Optionsausdruck gibt ein Array von Zeichenfolgenwerten zurück. Jeder Wert kann eine einfache Zeichenfolge sein, z. B. Male, oder in einer Zeichenfolge als Schlüsselwertpaar vorliegen, z. B. 1=Male

Beispiel: Wenn Sie den Wert eines Felds basierend auf dem Wert eines anderen Felds ausfüllen möchten, geben Sie einen einfachen Optionsausdruck an. Beispiel: Um ein Feld Anzahl der Kinder basierend auf dem Wert Familienstand eines anderen Felds auszufüllen, lautet der Ausdruck wie folgt:

marital_status.value == "married" ? ["1=One", "2=two"] : ["0=Zero"].

Sobald sich der Wert des Felds marital_status ändert, wird der Ausdruck erneut ausgelöst. Sie können die Dropdown-Liste auch über einen REST-Dienst auffüllen. Ausführliche Informationen finden Sie unter Dynamisches Auffüllen von Dropdown-Listen.

Zusammenfassungsausdruck summary

Der Zusammenfassungsausdruck berechnet dynamisch den Titel eines untergeordneten Panels eines Panels mit Akkordeon-Layout. Sie können den Zusammenfassungsausdruck in einer Regel angeben, die ein Formularfeld oder eine benutzerdefinierte Logik zum Auswerten des Titels verwendet. Der Ausdruck wird ausgeführt, wenn das Formular initialisiert wird. Wenn Sie ein Formular vorausfüllen, wird der Ausdruck ausgeführt, nachdem die Daten vorab ausgefüllt wurden oder wenn sich der Wert von abhängigen Feldern ändert, die in dem Ausdruck verwendet werden.

Der Zusammenfassungsausdruck wird in der Regel für das Wiederholen von untergeordneten Elementen eines Akkordeon-Layout-Bedienfelds verwendet, um einen aussagekräftigen Titel für jedes untergeordnete Bedienfeld zur Verfügung zu stellen.

Gilt für: Bedienfelder, die direkt untergeordnete Elemente eines Bedienfelds sind, deren Layout als Akkordeon konfiguriert ist.

Rückgabetyp: Der Ausdruck gibt eine Zeichenfolge zurück, die zum Titel des Akkordeons wird.

Beispiel: „Kontonummer: “ + textbox1.value

Ausdruck für die Überprüfung validate-expression

Der Ausdruck für die Überprüfung wird zur Überprüfung der Felder unter Verwendung des entsprechenden Ausdrucks verwendet. Normalerweise verwenden solche Ausdrücke reguläre Ausdrücke zusammen mit dem Feldwert, um ein Feld zu überprüfen. Bei jeder Änderung am Wert des Felds wird der Ausdruck erneut ausgelöst und der Überprüfungsstatus des Felds erneut berechnet.

Gilt für: Felder.

Rückgabetyp: Der Ausdruck gibt einen booleschen Wert zurück, der den Überprüfungsstatus des Felds wiedergibt. Der Wert false bedeutet, dass das Feld ungültig ist, und true bedeutet, dass das Feld gültig ist.
Beispiel: Für ein Feld, das eine britische Postleitzahl enthalten soll, lautet der Ausdruck für die Überprüfung wie folgt:

(this.value && this.value.match(/^(GIR 0AA|[A-Z]{1,2}\d[A-Z0-9]? ?[0-9][A-Z]{2}\s*)$/i) == null) ? false : true

Wenn im vorstehenden Beispiel der nicht leere Wert mit dem Muster nicht übereinstimmt, gibt der Ausdruck false zurück und zeigt damit an, dass das Feld nicht gültig ist.

Skript zum Bestätigen von Werten value-commit-script

Das Skript zum Bestätigen von Werten wird in folgenden Fällen ausgelöst:

Gilt für: Felder.

Rückgabetyp: Der Ausdruck für das Skript zum Bestätigen von Werten gibt keinen Wert zurück. Wenn ein Ausdruck einen Wert zurückgibt, wird dieser Wert ignoriert.

Beispiel: Um kleingeschriebene Buchstaben nach Eingabe in das Feld zu Großbuchstaben zu ändern, sieht der Ausdruck für das Bestätigen von Werten wie folgt aus:
this.value=this.value.toUpperCase()

Ausdruck für die Sichtbarkeit visibility-expression

Der Ausdruck für die Sichtbarkeit wird verwendet, um die Sichtbarkeit des Felds/Panels zu steuern. Normalerweise verwendet der Ausdruck für die Sichtbarkeit die Werteigenschaft eines Felds und wird erneut ausgelöst, sobald sich dieser Wert ändert.

Gilt für: Felder und Fenster

Rückgabetyp: Der Ausdruck gibt einen booleschen Wert zurück, der den Sichtbarkeitsstatus des Felds/Fensters wiedergibt. false bedeutet, dass das Feld oder das Fenster nicht sichtbar ist, und „true“ bedeutet, dass das Feld oder das Fenster sichtbar ist.

Beispiel: Für einen Bereich, der nur sichtbar sein soll, wenn der Wert von field1 auf Male festgelegt ist, lautet der Ausdruck für die Sichtbarkeit wie folgt: field1.value == "Male"

Ausdruck zum Abschluss von Schritten step-completion-expression

Der Ausdruck zum Abschluss von Schritten wird verwendet, um zu verhindern, dass Benutzende zum nächsten Schritt in einem Assistenten-Layout gehen. Diese Ausdrücke werden verwendet, wenn Bedienfelder über ein Assistenten-Layout verfügen (Formulare mit mehreren Schritten, die jeweils einen Schritt zeigen). Der Benutzer kann nur dann in den nächsten Schritt, Bereich oder Unterabschnitt wechseln, wenn im aktuellen Abschnitt alle erforderlichen Werte eingetragen wurden und gültig sind.

Gilt für: Panels mit Layout der Elemente im Stil eines Assistenten.

Rückgabetyp: Der Ausdruck gibt einen booleschen Wert zurück, der den Gültigkeitsstatus des aktuellen Panels wiedergibt. True bedeutet, dass der aktuelle Bereich gültig ist und der Benutzer zum nächsten Fenster navigieren kann.

Beispiel: In einem Formular mit verschiedenen Panels wird das aktuelle Panel vor der Navigation zum nächsten Panel validiert. In solchen Fällen werden die Ausdrücke zum Abschluss von Schritten verwendet. Im Allgemeinen verwenden diese Ausdrücke die GuideBridge-Validierungs-API. Beispiel für einen Ausdruck zum Abschluss von Schritten:
window.guideBridge.validate([],this.panel.navigationContext.currentItem.somExpression)

Überprüfungen in adaptiven Formularen validations-in-adaptive-form

Es gibt mehrere Methoden zum Hinzufügen einer Feldvalidierung zu einem adaptiven Formular. Wenn einem Feld eine Überprüfung hinzugefügt wird, bedeutet True, dass der in das Feld eingegebene Wert gültig ist. False bedeutet, dass der Wert ungültig ist. Wenn Sie durch Drücken der Tabulatortaste in ein Feld springen oder ein Feld verlassen, wird die Fehlermeldung nicht generiert.

Es gibt folgende Methoden zum Hinzufügen von Validierungen zu Feldern:

Erforderlich required

Um eine Komponente als obligatorisch festzulegen, können Sie im Dialogfeld Bearbeiten der Komponente die Option Titel und Text > Erforderlich auswählen. Sie können auch die entsprechende erforderliche Meldung (optional) hinzufügen.

Überprüfungsmuster validation-patterns

Für ein Feld stehen mehrere Überprüfungsmuster für den sofortigen Einsatz zur Verfügung. Suchen Sie zum Auswählen eines Überprüfungsmusters im Dialogfeld Bearbeiten der Komponente den Abschnitt Muster und wählen Sie Muster aus. Sie können im Textfeld Muster ein eigenes benutzerspezifisches Überprüfungsmuster erstellen. Als Überprüfungsstatus wird nur dann True zurückgegeben, wenn die eingegebenen Daten mit dem Überprüfungsmuster übereinstimmen. Andernfalls wird False zurückgegeben. Informationen zum Schreiben eines eigenen benutzerdefinierten Validierungsmusters finden Sie unter Picture-Klausel-Unterstützung für HTML5-Formulare.

Ausdrücke für die Überprüfung validation-expressions

Die Validierung eines Felds kann auch mithilfe von Ausdrücken für verschiedene Felder berechnet werden. Diese Ausdrücke werden in das Feld Überprüfungsskript der Registerkarte Skript des Dialogfelds Bearbeiten der Komponente geschrieben. Der Überprüfungsstatus eines Felds hängt davon ab, welchen Wert der Ausdruck zurückgibt. Informationen darüber, wie solche Ausdrücke geschrieben werden, finden Sie unter Ausdruck für die Überprüfung.

Zusätzliche Informationen additional-information

Verwendung des Anzeigeformats für Felder using-field-display-format

Das Anzeigeformat kann verwendet werden, um die Daten in verschiedenen Formaten anzuzeigen. Beispielsweise können Sie das Anzeigeformat verwenden, um eine Telefonnummer mit Bindestrichen darzustellen, eine Postleitzahl zu formatieren oder eine Datumsauswahl anzuzeigen. Diese Anzeigemuster können im Abschnitt Muster des Dialogfelds „Bearbeiten“ einer Komponente ausgewählt werden. Ähnlich wie bei den oben erwähnten Überprüfungsmustern können Sie benutzerspezifische Darstellungsmuster schreiben.

GuideBridge – APIs und Ereignisse guidebridge-apis-and-events

GuideBridge ist eine Sammlung von APIs, die für die Interaktion mit adaptiven Formularen im Speichermodell in einem Browser verwendet werden können. Eine ausführliche Einführung in die API, die Klassenmethoden und die bereitgestellten Ereignisse in GuideBridge finden Sie in der API-Referenz der JavaScript-Bibliothek für adaptive Formulare.

GuideBridge-Verwendung in verschiedenen Ausdrücken guidebridge-usage-in-various-expressions

Verwendung von GuideBridge außerhalb von Ausdrücken using-guidebridge-outside-expressions-nbsp

Sie können die GuideBridge-APIs auch außerhalb von Ausdrücken verwenden. Sie können die GuideBridge-API beispielsweise dazu verwenden, die Kommunikation zwischen Seiten-HTML, in der das adaptive Formular integriert ist, und dem Formularmodell festzulegen. Darüber hinaus können Sie den Wert festlegen, der aus einem übergeordneten Element des iFrame kommt, in dem das Formular integriert ist.

Zum Verwenden der GuideBridge-API im oben erwähnten Beispiel erfassen Sie eine Instanz von GuideBridge. Zum Erfassen einer Instanz überwachen Sie das bridgeInitializeStart-Ereignis eines window-Objekts:

window.addEventListener("bridgeInitializeStart", function(evnt) {

     // get hold of the guideBridge object

     var gb = evnt.detail.guideBridge;

     //wait for the completion of AF

     gb.connect(function (){

        //this function will be called after Adaptive Form is initialized

     })

})

Um GuideBridge nach Initialisierung des Formulars zu verwenden (das bridgeInitializeComplete-Ereignis wird gesendet), rufen Sie die GuideBridge-Instanz mit window.guideBridge auf. Sie können den GuideBridge-Initialisierungsstatus mithilfe der guideBride.isConnected-API überprüfen.

GuideBridge-Ereignisse guidebridge-events

GuideBridge stellt auch bestimmte Ereignisse für externe Skripte auf der Hosting-Seite bereit. Externe Skripte können diese Ereignisse überwachen und verschiedene Vorgänge ausführen. Wenn sich beispielsweise der Benutzername in einem Formular ändert, ändert sich auch der in der Kopfzeile der Seite angezeigte Name. Ausführliche Informationen zu solchen Ereignissen finden Sie in der API-Referenz der JavaScript-Bibliothek für adaptive Formulare.

Verwenden Sie folgenden Code zur Handler-Registrierung:

guideBridge.on("elementValueChanged", function (event, data)  {

      // execute some logic when value of a field is changed

});

Erstellen benutzerdefinierter Muster für ein Feld creating-custom-patterns-for-a-field

Wie oben erwähnt, ermöglichen es adaptive Formulare Autorinnen und Autoren, Überprüfungsmuster oder Anzeigeformate anzugeben. Über die Verwendung von Mustern für den sofortigen Einsatz können Sie wiederverwendbare benutzerdefinierte Muster für eine Komponente eines adaptiven Formulars verwenden. Beispiel: Sie können ein Textfeld oder ein numerisches Feld definieren. Einmal definiert, können Sie diese Muster in allen Formularen für einen bestimmten Typ von Komponente verwenden. Sie können zum Beispiel ein benutzerdefiniertes Muster für ein Textfeld erstellen und es in den Textfeldern in ihren adaptiven Formularen verwenden. Sie können das benutzerspezifische Muster auswählen, indem Sie im Dialogfeld „Bearbeiten“ einer Komponente auf den Abschnitt „Muster“ zugreifen. Ausführliche Informationen zu Musterdefinitionen oder Formaten finden Sie unter Picture-Klausel-Unterstützung für HTML5-Formulare.

Führen Sie die folgenden Schritte durch, um ein benutzerspezifisches Muster für einen bestimmten Feldtyp zu erstellen und es dann für alle Felder desselben Typs wiederzuverwenden: