Formularsatz in AEM Forms form-set-in-aem-forms
Übersicht overview
Ihre Kunden müssen oft mehrere Formulare senden, um sich bei einem Dienst oder anzumelden. Dazu gehört die Suche aller relevanter Formular sowie das Ausfüllen und Nachverfolgen. Außerdem müssen sie allgemeine Details oft mehrmals in Formularen ausfüllen. Der gesamte Prozess ist mühsam und fehleranfällig, wenn eine große Anzahl von Formularen verwendet wird. Die Formularsatzfunktion von AEM Forms kann in solchen Fällen dazu beitragen, das Benutzererlebnis zu vereinfachen.
Ein Formularsatz ist eine Sammlung von HTML5-Formularen, die zusammen gruppiert sind und den Benutzenden als einzelner Formularsatz präsentiert wird. Wenn der Benutzer ein Formularsatz ausfüllt, werden diese Informationen von einem Formular zu einem anderen übertragen. Am Ende können sie alle Formulare mit nur einem Klick absenden.
AEM Forms bietet eine intuitive Benutzeroberfläche zum Erstellen, Konfigurieren und Verwalten von Formularsätzen. Als Autor können Sie Formulare in einer bestimmten Reihenfolge anfordern, in der Endanwender sie ausfüllen sollen. Sie können auch Bedingungen oder Berechtigungsausdrücke in einzelnen Formularen verwenden, um ihre Sichtbarkeit aufgrund Benutzereingaben zu steuern. Beispielsweise können Sie das Formular zum Ehepartner so konfigurieren, dass es nur dann angezeigt wird, wenn der Familienstand als „Verheiratet“ angegeben wurde.
Darüber hinaus können Sie allgemeine Felder in unterschiedlichen Formularen konfigurieren, um allgemeine Datenbindungen zu teilen. Mit den richtigen Datenbindungen müssen Benutzende allgemeine Informationen nur einmal ausfüllen. Diese werden dann in den nachfolgenden Formularen automatisch ausgefüllt.
Formularsätze werden auch in der AEM Forms-App unterstützt, sodass etwa Ihr Außendienstpersonal einen Formularsatz offline bearbeiten, Kundinnen und Kunden besuchen, Daten eingeben und später mit dem AEM Forms-Server synchronisieren kann, um Formulardaten an Geschäftsprozesse zu senden.
Erstellen und Verwalten eines Formularsatzes creating-and-managing-form-set
Sie können mehrere XDPs oder Formularvorlagen, die unter Verwendung von Designer erstellt wurden, in einen Formularsatz zuordnen. Formularsätze können dann selektiv verwendet werden, um die XDPs zu rendern, basierend auf den Werten, die von den Benutzern in den anfänglichen Formularen und deren Profilen eingegeben wurden.
Verwenden Sie die AEM Forms-Benutzeroberfläche, um alle Formulare, Formularsätze und zugehörigen Assets zu verwalten.
Erstellen eines Formularsatzes create-a-form-set
Gehen Sie wie folgt vor, um einen Formularsatz zu erstellen:
-
Wählen Sie „Formulare“ > „Formulare und Dokumente“ aus.
-
Klicken Sie auf „Erstellen“ > „Formularsatz“.
-
Fügen Sie auf der Seite „Eigenschaften hinzufügen“ die folgenden Angaben hinzu und klicken Sie auf „Weiter“.
- Titel: Geben Sie den Titel des Dokuments an. Der Titel erleichtert Ihnen die Identifizierung von Formularsätze in der Benutzeroberfläche von AEM Forms.
- Beschreibung: Geben Sie detaillierte Informationen zum Dokument an.
- Tags: Gibt Tags an, die eine eindeutige Identifizierung des Formularsatzes ermöglichen. Tags erleichtern die Suche im Formularsatz. Um die Tags zu erstellen, geben Sie neue Tag-Namen in das Feld Tags ein.
- Übermittlungs-URL: URL, unter der die übermittelten Daten bei eigenständiger Ausgabedarstellung eines Formularsatzes veröffentlicht werden (Anwendungsfall ohne AEM Forms -App). Die Daten werden als multipart/formdata mit dem folgenden Anfrageparameter an diesen Endpunkt übermittelt:
- dataXML: Dieser Parameter enthält eine XML-Darstellung der gesendeten Formularsatzdaten. Wenn alle Formulare im Formularsatz ein gemeinsames Schema verwenden, wird das XML gemäß diesem Schema generiert. Andernfalls enthält der XML-Stamm-Tag einen untergeordneten Tag für jedes ausgefüllte Formular im Formularsatz, das Daten für die Formularanlagen enthält.
- formsetPath: Der Pfad des Formularsatzes in CRXDE, der gesendet wurde.
- HTML-Ausgabeprofil: Sie können bestimmte Optionen wie schwebende Felder, Anhänge und Entwurfsunterstützung konfigurieren (für eine eigenständige Ausgabedarstellung des Formularsatzes), um das Erscheinungsbild, das Verhalten und die Interaktionen des Formularsatzes anzupassen. Sie können das vorhandene Profil anpassen oder erweitern, um alle Profileinstellungen des HTML-Formulars zu ändern.
-
Der Bildschirm „Formular(e) auswählen“ zeigt die verfügbaren XDP-Formulare oder XDP-Dateien an. Suchen Sie nach den Formularen, die Sie den Formularsatz aufnehmen möchten, wählen Sie sie aus und klicken Sie auf „Zum Formularsatz hinzufügen“. Suchen Sie nötigenfalls nach weiteren hinzuzufügenden Formularen. Nachdem Sie die Formulare zum Formularsatz hinzugefügt haben, klicken Sie auf „Weiter“.
note note NOTE Stellen Sie sicher, dass die Feldnamen in den XDP-Formularen keinen Punkt enthalten. Andernfalls können die Skripte, die versuchen, die Felder zu beheben, in denen Punkte enthalten sind, diese nicht beheben. -
Auf der Seite „Formular(e) konfigurieren“ haben Sie folgende Möglichkeiten:
- Reihenfolge der Formulare: Ziehen Sie die Formulare per Drag&Drop, um die Anordnung zu ändern. Dieses Formular definiert die Reihenfolge, in der die Formulare dem Endbenutzer in der AEM Forms-App und in der eigenständigen Ausgabedarstellung angezeigt werden.
- Formular-ID: Gibt eine eindeutige ID an, damit die Formulare in den Berechtigungsausdrücken verwendet werden können.
- Datenstamm: Die Autorin oder der Autor kann für jedes Formular im Formularsatz den XPATH konfigurieren, unter dem die Daten des betreffenden Formulars im übermittelten XML-Code positioniert werden. Standardmäßig ist der Wert „/“. Wenn alle Formulare in Formularsätzen schemagebunden sind und das gleiche XML-Schema haben, können Sie diesen Wert ändern. Es wird empfohlen, für jedes Feld im Formular in der XDP-Datei die korrekte Datenbindung anzugeben. Wenn zwei Felder in zwei verschiedenen Formularen die allgemeine Datenbindung gemeinsam nutzen, dann zeigt das Feld im zweiten Formular vorausgefüllte Werte aus dem ersten Formular an. Binden Sie zwei Teilformulare mit dem gleichen internen Inhalt nicht an denselben XML-Knoten. Weitere Informationen zur XML-Struktur von Formularsätzen finden Sie unter Vorausfüllen von XML für Formularsätze.
- Berechtigungsausdruck: Gibt einen JavaScript-Ausdruck an, der einen booleschen Wert auswertet und anzeigt, ob ein Formular im Formularsatz zum Ausfüllen zulässig ist. Wenn dies „false“ ist, wird der Benutzer nicht gefragt und es wird ihm auch nicht das Formular zum Ausfüllen angezeigt. Der Ausdruck basiert normalerweise auf den Werten der Felder, die in den diesem Formular vorangehenden Formularen erfasst werden. Darüber hinaus enthalten Ausdrücke auch Aufrufe von „fs.valueOf“ in der Formularsatz-API, um die von der Benutzerin oder dem Benutzer im entsprechenden Feld eines Formulars im Formularsatz eingegebenen Werte abzurufen:
fs.valueOf(<Formularkennung>, <fieldSom-Ausdruck>) > <Wert>
Beispielsweise können Sie bei zwei Formularen im Formularsatz – Geschäftsausgaben und Reisekosten – ein JavaScript-Snippet im Feld „Berechtigungsausdruck“ für beide Formulare hinzufügen, sodass bei beiden Formularen auf die Benutzereingabe für die Kostenart geprüft wird. Wenn der Benutzer Geschäftsausgaben wählt, wird das Formular „Geschäftsausgaben“ für den Endbenutzer gerendert. Wenn der Benutzer „Reisekosten“ wählt, wird ein anderes Formular gerendert und angezeigt. Weitere Informationen finden Sie unter „Berechtigungsausdruck“.
Darüber hinaus hat die Autorin oder der Autor die Möglichkeit, ein Formular mithilfe des Löschsymbols am rechten Ende jeder Zeile aus dem Formularsatz zu entfernen oder mithilfe des Symbols „+“ in der Symbolleiste einen weiteren Formularsatz hinzuzufügen. Über das Symbol „+“ gelangt die Benutzerin oder der Benutzer zurück zum vorherigen Schritt des Assistenten, d. h. zur Formularauswahl. Die bestehende Auswahl bleibt erhalten. Zusätzlich ausgewählte Formulare müssen dem Formularsatz über das Symbol „Zum Formularsatz hinzufügen“ auf dieser Seite hinzugefügt werden.
note note NOTE Alle Formulare in Formularsätzen werden in der Benutzeroberfläche von AEM Forms verwaltet.
Verwalten eines Formularsatzes managing-a-form-set
Nachdem ein Formular erstellt wurde, können Sie die folgenden Aktionen für den Formularsatz durchführen:
- Einfachklick: Wenn der Formularsatz erstellt wurde und in der Liste auf der Haupt-Asset-Seite angezeigt wird, kann die Benutzerin oder der Benutzer den Formularsatz per Einfachklick anzeigen. Der Formularsatz wird geöffnet und alle darin enthaltenen Formularvorlagen (XDPs) werden angezeigt.
- Bearbeiten: Wenn Sie einen Formularsatz auswählen und anschließend auf „Bearbeiten“ klicken, wird der oben unter „Schritte zum Erstellen eines Formularsatzes“ gezeigte Bildschirm „Formular(e) konfigurieren“ geöffnet. Sie können alle hier beschriebenen Funktionen durchführen.
- Kopieren und Einfügen: Mithilfe dieser Funktion können Sie den gesamten Formularsatz von einem Speicherort kopieren und am gewünschten Speicherort bzw. im gewünschten Ordner einfügen.
- Herunterladen: Sie können den Formularsatz mit sämtlichen Abhängigkeiten herunterladen.
- Prüfung starten/verwalten: Nachdem der Formularsatz erstellt wurde, können Sie dessen Überprüfung durch Klicken auf das Symbol zum Starten einer Überprüfung einrichten. Sobald die Überprüfung für einen Formularsatz gestartet wurde, wird die Option zum Verwalten der Überprüfung angezeigt. Im Bildschirm zum Verwalten einer Überprüfung können Sie diese aktualisieren oder beenden. Überprüfungen, die Sie hinzugefügt haben, können Sie kontrollieren und ggf. mit Kommentaren versehen.
- Löschen: Sie können den vollständigen Formularsatz löschen. Die Formulare im gelöschten Formularsatz bleiben im Repository.
- Veröffentlichen/Veröffentlichung rückgängig machen: Mithilfe dieser Funktion können Sie den Formularsatz, einschließlich aller darin enthaltenen Formulare und der zu diesen gehörigen Assets, veröffentlichen oder seine Veröffentlichung rückgängig machen.
- Vorschau: es stehen zwei Optionen zur Verfügung – die HTML-Vorschau (ohne Daten) und die benutzerdefinierte Vorschau mit Beispieldaten.
- Eigenschaften anzeigen/bearbeiten: Sie können die Metadateneigenschaften des ausgewählten Formularsatzes anzeigen/bearbeiten.
Bearbeiten eines Formularsatzes edit-a-form-set
Gehen Sie wie folgt vor, um Formularsätze zu bearbeiten:
-
Wählen Sie „Formulare“ > „Formulare und Dokumente“ aus.
-
Suchen Sie nach dem Formularsatz, den Sie bearbeiten möchten. Bewegen Sie den Cursor darüber und wählen Sie „Bearbeiten“ (
-
Auf der Seite „Formular(e) konfigurieren“ können Sie Folgendes bearbeiten:
- Formular-Reihenfolge
- Formularkennung
- Datenstamm
- Berechtigungsausdruck
Sie können auch auf das entsprechende Lösch-Symbol klicken, um das Formular aus dem Formularsatz zu löschen.
Formularsätze in der Prozessverwaltung form-set-in-process-management
Nachdem Sie einen Formularsatz in der AEM Forms Management-Benutzeroberfläche erstellt haben, können Sie ihn in Workbench für die Aktivität „Startpunkt“ oder „Aufgabe zuweisen“ verwenden.
Verwenden des Formularsatzes unter „Aufgabe“ oder „Startpunkt“ using-form-set-in-task-or-start-point
-
Wählen Sie beim Entwickeln eines Prozesses im Bereich „Präsentation und Daten“ von „Ausgangspunkt“ bzw. „Aufgabe zuweisen“ die Option zum Verwenden eines CRX-Assets. Der Browser für CRX-Assets wird angezeigt.
-
Wählen Sie den Formularsatz, um den Formularsatz im AEM-Repository (CRX) zu filtern.
-
Wählen Sie einen Formularsatz aus und klicken Sie auf „OK“.
Berechtigungsausdrücke eligibility-expressions
Mithilfe von Berechtigungsausdrücken können Sie die Formulare, die für bestimmte Benutzer angezeigt werden sollen, definieren und dynamisch steuern. So können Sie beispielsweise festlegen, dass ein bestimmtes Formular nur für Benutzer angezeigt werden soll, die zu einer bestimmten Altersgruppe gehören. Geben Sie mithilfe von Forms Manager einen Berechtigungsausdruck an und bearbeiten Sie ihn.
Ein Berechtigungsausdruck kann jede gültige JavaScript-Anweisung sein, die einen booleschen Wert zurückgibt. Die letzte Anweisung im JavaScript-Codesnippet wird als boolescher Wert behandelt, der die Berechtigung des Formulars anhand der Verarbeitung im Rest (vorherige Zeilen) des JavaScript-Codesnippets bestimmt. Wenn der Wert des Ausdrucks „wahr“ ist, bedeutet dies, dass das Formular für den Benutzer angezeigt werden soll. Solche Formulare werden als berechtigte Formulare bezeichnet.
Neben der normalen JavaScript-Funktion wird im Formularsatz die fs.valueOf-API genutzt, die Zugriff auf den Wert eines Formularfelds in einem Formularsatz bietet. Verwenden Sie diese API, um auf den Wert eines Formularfelds in einem Formularsatz zuzugreifen. Die API-Syntax lautet fs.valueOf (formUid, fieldSOM), wobei:
- formUid (String): Eine eindeutiger ID eines Formulars im Formularsatz. Sie können dies beim Erstellen des Formularsatzes in der Forms Manager-Benutzeroberfläche angeben. Standardmäßig ist dies der Name des Formulars.
- fieldSOM (string): Ein SOM-Ausdruck des Felds im durch formUid angegebenen Formular. SOM-Ausdruck- oder Skriptobjekt-Modellausdruck wird verwendet, um die Werte, Eigenschaften und Methoden innerhalb eines bestimmten Dokumentobjektmodells (DOM) zu referenzieren. Sie können ihn in Form Designer auf der Registerkarte „Skripte“ anzeigen, während das Feld ausgewählt ist.
Beispiele examples
Gültige Verwendung der API:
fs.valueOf("form1", "xfa.form.form1.subform1.field1")
Ungültige Verwendung der API:
var formUid = "form1";
var fieldSOM = "xfa.form.form1.subform1.field1"; fs.valueOf(formUid, fieldSOM);
XML zum Vorausfüllen in Formularsätzen prefill-xml-for-form-set
Ein Formularsatz ist eine Sammlung mehrerer HTML5-Formulare mit einem gemeinsamen oder mehreren unterschiedlichen Schemata. Der Formularsatz unterstützt das Vorausfüllen von Formularfeldern mithilfe einer XML-Datei. Sie können eine XML-Datei mit einem Formularsatz verknüpfen, sodass, wenn Sie ein Formular in einem Formularsatz öffnen, einige der Felder im Formular voraufgefüllt werden.
Das Vorauffüllen einer XML-Datei wird mithilfe des dataRef-Parameters der URL des Formularsatzes angegeben. Der dataRef-Parameter gibt den absoluten Pfad der XML-Datendatei an, die mit dem Formularsatz zusammengeführt wird.
Sie haben beispielsweise drei Formulare (form1, form2 und form3) im Formularsatz mit der folgenden Struktur:
form1
Field form1field
form2
Field form2field
form3
Field form3field
Jedes Formular verfügt über ein Feld mit einem gängigen Namen wie „Feld“ und einem einzigartig benannten Feld namens „Formularfeld<i>“.
Sie können diesen Formularsatz mithilfe einer XML-Datei mit der folgenden Struktur vorausfüllen lassen:
<?xml version="1.0" encoding="UTF-8" ?>
<formSetRootTag>
<field>common field value</field>
<form1field>value1</form1field>
<form2field>value2</form2field>
<form3field>value3</form3field>
</formSetRootTag>
Das obige XML-Codefragment zeigt an, dass die XML zum Vorausfüllen des Formularsatzes eine Vereinigung der XML-Codefragmente zum Vorausfüllen der einzelnen Formulare darstellt. Wenn bestimmte Felder in unterschiedlichen Formularen eine ähnliche Datenhierarchie/Schema haben, werden die Felder mit den gleichen Werten vorausgefüllt. In diesem Beispiel werden alle drei Formulare mit dem gleichen Wert für das gemeinsame Datenfeld „Feld“ vorausgefüllt. Dies ist eine einfache Möglichkeit, Daten von einem Formular zum nächsten weiterzugeben. Dasselbe kann auch erreicht werden, indem die Felder an dasselbe Schema oder dieselbe Datenreferenz gebunden werden. Wenn Sie die Formularsatzdaten basierend auf dem Formularschema trennen möchten. Dies kann durch Angabe des Attributs „Datenstamm“ des Formulars während der Formularsatzerstellung erreicht werden (der Standardwert ist „/“, was dem Stamm-Tag des Formularsatzes zugeordnet ist).
Wenn Sie im vorherigen Beispiel die Datenstämme für die drei Formulare wie folgt angeben: „/form1“, „/form2“ und „/form3“, müssen Sie zum Vorausfüllen eine XML mit der folgenden Struktur verwenden:
<?xml version="1.0" encoding="UTF-8" ?>
<formSetRootTag>
<form1>
<field>field value1</field>
<form1field>value1</form1field>
</form1>
<form2>
<field>field value2</field>
<form2field>value2</form2field>
</form2>
<form3>
<field>field value3</field>
<form3field>value3</form3field>
</form3>
</formSetRootTag>
In einem Formularsatz definierte die XML ein XML-Schema mit der folgenden Syntax:
<formset>
<fs_data>
<xdp:xdp xmlns:xdp="https://ns.adobe.com/xdp/">
<xfa:datasets xmlns:xfa="https://www.xfa.org/schema/xfa-data/1.0/">
<xfa:data>
<rootElement>
... data ....
</rootElement>
</xfa:data>
</xfa:datasets>
</xdp:xdp>
</fs_data>
<fs_draft>
... private data...
</fs_draft>
</formset>
Beschreibung der XML-Elemente zum Vorausfüllen prefill-xml-elements-description
Syntaxregeln zum Erstellen einer XML-Datei zum Vorausfüllen:
- Übergeordnete Elemente: Elemente, die dem betreffenden Element übergeordnet sein können, wobei „null“ bedeutet, dass das Element im Stammverzeichnis der XML-Datei liegen kann.
- Kardinalität: Gibt an, wie oft das Element innerhalb des ihm übergeordneten Elements verwendet werden kann.
- submitXML: Gibt an, ob das Element in der Sende-XML immer vorhanden (P) oder optional (O) ist.
- prefillXML: Gibt an, ob das Element in der XML zum Vorbefüllen erforderlich ® oder optional (O) ist.
- Untergeordnete Elemente: Gibt an, welche Elemente untergeordnet sein können.
FORMSET formset
parent elements:
null
cardinality: [0,1]
submitXML: P
prefillXML: O
children: fs_data
Das Stammelement der XML für den Formularsatz. Es wird empfohlen, dieses Wort nicht als Namen des rootSubform eines Formulars im Formularsatz zu verwenden.
FS_DATA fs-data
parent elements:
formset
Kardinalität: [1]
submitXML: P
prefillXML: O
children: xdp:xdp/rootElement
Die Unterstruktur gibt die Daten der Formulare im Formularsatz an. Das Element ist in der XML zum Vorausfüllen nur dann optional, wenn das Formularsatzelement nicht vorhanden ist
XDP:XDP xdp-xdp
parent elements: fs_data/null
cardinality: [0,1]
submitXML: O
prefillXML: O
children: xfa:datasets
Dieses Tag gibt den Anfang der XML für das HTML5-Formular an. Dies wird in der Sende-XML hinzugefügt, sofern es in der der XML zum Vorausfüllen angegeben wurde oder diese nicht vorhanden ist. Dieses Tag kann aus der XML zum Vorausfüllen entfernt werden.
XFA:DATASETS xfa-datasets
parent elements: xdp:xdp
cardinality: [1]
submitXML: O
prefillXML: O
children: xfa:data
XFA:DATA xfa-data
parent elements: xfa:datasets
cardinality: [1]
submitXML: O
prefillXML: O
children: rootElement
ROOTELEMENT rootelement
parent elements: xfa:datasets/fs_data/null
cardinality: [0,1]
submitXML: P
prefillXML: O
children: controlled by the Forms in Form set
Der Name „rootElement“ dient hier lediglich als Platzhalter. Der tatsächliche Name wird aus den im Formularsatz verwendeten Formularen übernommen. Die mit dem rootElement beginnende Unterstruktur enthält die Daten aus den Feldern und Unterformularen innerhalb der im Formularsatz enthaltenen Formulare. Es gibt mehrere Faktoren, die die Struktur des rootElement und seiner untergeordneten Elemente bestimmen.
In der XML zum Vorausfüllen ist dieses Tag optional, fehlt es jedoch, wird die gesamte XML ignoriert.
NAME DES STAMMELEMENT-TAGS
Ist in der XML zum Vorausfüllen ein Stammelement vorhanden, wird der Name dieses Elements auch für die Senden-XML übernommen. Falls keine XML zum Vorausfüllen vorhanden ist, wird der Name des Unterformulars auf der Stammebene des ersten Formulars im Formularsatz, dessen dataRoot-Eigenschaft auf „/“ eingestellt wurde, als Name für das rootElement übernommen. Wenn kein solches Formular vorhanden ist, lautet der Name des rootElement fs_dummy_root, was ein reserviertes Keyword ist.
Formularsatz in der AEM Forms-App formset-in-workspace-app
Die AEM Forms-App ermöglicht es Außendienstmitarbeitern, ihre Mobilgeräte mit einem AEM Forms-Server zu synchronisieren und Aufgaben zu bearbeiten. Die Anwendung funktioniert auch dann, wenn das Gerät offline ist, indem Daten lokal auf dem Gerät gespeichert werden. Mithilfe von Anmerkungsfunktionen wie etwa Fotos können Mitarbeitende im Außendienst genaue Informationen bereitstellen, die in die Geschäftsprozesse integriert werden können.
Bekannte Einschränkungen – Muster, die in Formularsätzen nicht vollständig unterstützt werden known-limitations-patterns-not-fully-supported-in-form-set
Die folgenden Datenmuster werden im Formularsatz nicht vollständig unterstützt: