Best Practices für die Arbeit mit adaptiven Formularen best-practices-for-working-with-adaptive-forms

Verwenden Sie Apache Maven aem-project-archetype, um eine Struktur für AEM-Projekte zu erstellen und zu verwalten. Es werden empfohlene Strukturen und Vorlagen für Ihr AEM-Projekt erstellt. Darüber hinaus bietet es Versionsautomatisierungs- und Änderungskontrollsysteme, um das Projekt zu verwalten.

• Verwenden Sie den Maven-Befehl archetype:generate, um die anfängliche Struktur zu generieren.
• Verwenden Sie den Maven-Befehl eclipse:eclipse, um die Eclipse-Projektdateien zu generieren und das Projekt in Eclipse zu importieren.

Mit dem FileVault-Tool oder VLT können Sie den Inhalt einer CRX- oder AEM-Instanz Ihrem Dateisystem zuordnen. Es bietet Änderungskontrollverwaltungsvorgänge, wie das Ein- und Auschecken des AEM Projektinhalts. Siehe Vewenden des VLT-Tools.

Wenn Sie die Eclipse-integrierte Entwicklungsumgebung verwenden, können Sie AEM Entwickler-Tools für die nahtlose Integration der Eclipse IDE mit AEM-Instanzen verwenden, um AEM Anwendungen zu erstellen. Weitere Informationen finden Sie unter AEM Entwicklertools für Eclipse.

Eine adaptive Formularvorlage ist eine spezielle AEM, die die Struktur und die Kopf- und Fußzeileninformationen eines adaptiven Formulars definiert. Eine Vorlage verfügt über vorkonfigurierte Layouts, Stile und eine grundlegende Struktur für ein adaptives Formular. AEM Forms bietet Standardvorlagen und -Komponenten, die Sie verwenden können, um adaptive Formulare zu erstellen. Sie können jedoch benutzerdefinierte Vorlagen und Komponenten entsprechend Ihren Anforderungen erstellen. Es wird empfohlen, Anforderungen für zusätzliche Vorlagen und Komponenten zu erfassen, die Sie in Ihren adaptiven Formularen benötigen. Weitere Informationen finden Sie unter Anpassen adaptiver Formulare und Komponenten.

Mit AEM Forms können Sie adaptive Formulare erstellen, die auf den folgenden Formularmodellen basieren. Die Formularmodelle fungieren als Schnittstelle für den Datenaustausch zwischen einem Formular und AEM System und stellen eine XML-basierte Struktur für Datenfluss innerhalb und außerhalb eines adaptiven Formulars bereit. Darüber hinaus legen die Formularmodelle Regeln und Einschränkungen für adaptive Formulare in Form von Schema- und XFA-Beschränkungen fest.

• Keines: Adaptive Formulare, die mit dieser Option erstellt wurden, verwenden kein Formularmodell. Die XML-Datendatei, die aus diesen Formularen generiert wird, hat eine flache Struktur mit Feldern und entsprechenden Werten.
• XML- oder JSON-Schema: XML- und JSON-Schemata stellen die Struktur dar, in der Daten vom Back-End-System in Ihrer Organisation produziert oder genutzt werden. Sie können ein Schema mit einem adaptiven Formular verknüpfen und dem adaptiven Formular mithilfe der Elemente aus dem Schema dynamische Inhalte hinzufügen. Die Elemente des Schemas stehen auf der Registerkarte „Datenmodellobjekt“ des Inhalts-Browsers für das Erstellen von adaptiven Formularen zur Verfügung. Sie können die Schemaelemente zum Erstellen des Formulars ziehen und ablegen.
• XFA-Formularvorlage: Es ist ein ideales Formularmodell, wenn Sie in XFA-basierte HTML5-Formulare investieren. Es bietet eine direkte Möglichkeit, Ihre XFA-basierten Formulare in adaptive Formulare zu konvertieren. Alle vorhandenen XFA-Regeln werden in den zugehörigen adaptiven Formularen beibehalten. Die resultierenden adaptiven Formulare unterstützen XFA-Konstrukte wie Überprüfungen, Ereignisse, Eigenschaften und Muster.
• Formulardatenmodell: Dies ist das bevorzugte Formularmodell, wenn Sie Ihre Backend-Systeme wie Datenbanken, Web-Services und AEM-Benutzerprofile integrieren möchten, um adaptive Formulare vorauszufüllen und übermittelte Formulardaten zurück in die Backend-Systeme zu schreiben. Mit einem Formulardatenmodell-Editor können Sie Entitäten und Dienste in einem Formulardatenmodell definieren und konfigurieren, das Sie zum Erstellen adaptiver Formulare verwenden können. Weitere Informationen finden Sie unter AEM Forms-Datenintegration.

AEM Forms bietet vordefinierte adaptive Formularvorlagen, mit denen Sie adaptive Formulare erstellen können. Sie können auch eigene Vorlagen erstellen. AEM stellt statische und bearbeitbare Vorlagen bereit.

• Statische Vorlagen werden von den Entwicklern definiert und konfiguriert.
• Bearbeitbare Vorlagen werden von Autoren mithilfe des Vorlageneditors erstellt. Mit dem Vorlagen-Editor können Sie eine grundlegende Struktur und anfänglichen Inhalt in einer Vorlage definieren. Jede Änderung in der Strukturebene wird in allen Formularen, die diese Vorlage verwenden, übernommen. Der anfängliche Inhalt kann ein vorkonfiguriertes Design, einen Vorbefüllungs-Dienst, eine Sendeaktion usw. umfassen. Diese Einstellungen können jedoch mit dem Formular-Editor für ein Formular geändert werden. Weitere Informationen finden Sie unter Adaptive Formularvorlagen.

Verwenden Sie Inline-Formatierung für die Formatierung einer bestimmten Feld- oder Bedienfeldinstanz. Alternativ können Sie eine Klasse in einer CSS-Datei definieren und den Klassennamen in der CSS-Klasseneigenschaft der Komponente angeben.

Schließen Sie eine Client-Bibliothek in eine Komponente ein, um Stile konsistent auf alle adaptiven Formulare oder Fragmente anzuwenden, die diese Komponente verwenden. Weitere Informationen finden Sie unter Erstellen einer Seitenkomponente für adaptive Formulare.

Wenden Sie in einer Client-Bibliothek definierte Stile an, um adaptive Formulare auszuwählen, indem Sie den Pfad zur Client-Bibliothek im Feld CSS-Dateipfad in den Eigenschaften des adaptiven Formularcontainers angeben.

Um eine Client-Bibliothek Ihrer Stile zu erstellen, können Sie die benutzerdefinierte CSS-Datei in der Client-Bibliothek des Design-Editors oder in den Eigenschaften des Formular-Containers konfigurieren.

Adaptive Formulare bieten Bedienfeldlayouts, z. B. responsive Layouts, Registerkarten, Akkordeons und Assistenten, um zu steuern, wie Formularkomponenten in einem Bedienfeld angeordnet werden. Sie können benutzerdefinierte Bedienfeldlayouts erstellen und sie für Formularautoren zur Verfügung stellen. Weitere Informationen finden Sie unter Erstellen benutzerdefinierter Layout-Komponenten für adaptive Formulare.

Sie können auch bestimmte adaptive Formularkomponenten wie Felder und Bedienfeldlayout anpassen.

• Verwenden Sie die Überlagerung Funktionalität von AEM , um eine Kopie einer Komponente zu ändern. Es wird nicht empfohlen, Standardkomponenten zu ändern.
• Um das Layout von vordefinierten adaptiven Formularkomponenten in /libs anzupassen, Erstellen benutzerdefinierter Layoutkomponenten zusätzlich zu Standardlayouts.
• Stellen Sie benutzerdefinierte Interaktivitäten ein, indem Sie benutzerdefinierte Widgets oder Erscheinungsbilder erstellen. Es wird nicht empfohlen, Standardkomponenten zu ändern. Weitere Informationen finden Sie unter Erscheinungsbild-Framework.

Weitere Informationen finden Sie unter Bearbeiten von persönlichen identifizierbaren Informationen für Vorschläge zum Umgang mit PII-Daten.

Verwenden Sie den Objekt-Browser in der Seitenleiste, um schnell auf Felder in der Formularhierarchie zuzugreifen. Sie können im Suchfeld nach Objekten in der Formular- oder Objektstruktur, um von einem Objekt zu einem anderen zu navigieren.

Um die Eigenschaften einer Komponente im Komponenten-Browser in der Seitenleiste anzuzeigen, wählen Sie die Komponente aus und klicken Sie auf . Sie können auch auf eine Komponente doppelklicken, um deren Eigenschaften im Eigenschaftenbrowser anzuzeigen.

Verwenden Sie die Tastaturkürzel, um schnelle Aktionen in Ihren Formularen durchzuführen. Siehe Tastaturbefehle für AEM Forms.

Adaptive Formularkomponenten werden nur zur Verwendung auf Seiten mit adaptiven Formularen empfohlen. Die Komponenten hängen von ihrer übergeordneten Hierarchie ab. Daher dürfen Sie diese nicht auf der AEM-Seite verwenden.

Verwenden Sie aussagekräftige und eindeutige Namen für Formularfelder und Komponenten, um mögliche Konflikte beim Schreiben von Regeln zu vermeiden.

Verwenden Sie den this-Operator für eine Komponente, damit diese auf sich selbst in einem Regelausdruck verweist. Es wird sichergestellt, dass die Regel gültig bleibt, selbst wenn sich der Komponentenname ändert. Beispiel: field1.valueCommit script: this.value > 10.

Verwenden Sie Komponentennamen, wenn Sie auf verschiedene Formularkomponenten verweisen. Verwenden Sie die value-Eigenschaft, um den Wert eines Feldes oder einer Komponente abzurufen. Beispiel: field1.value.

Verweisen Sie auf Komponenten durch die relative eindeutige Hierarchie, um Konflikte zu vermeiden. Beispiel: parentName.fieldName.

Beim Bearbeiten von komplexen oder häufig verwendeten Regeln, sollten Sie die Geschäftslogik als Funktionen in eine separaten Client-Bibliothek schreiben, die Sie in adaptiven Formularen festlegen und wieder verwenden können. Die Client-Bibliothek sollte eine eigenständige Bibliothek sein und darf keine externen Abhängigkeiten, außer von jQuery und Underscore.js haben. Sie können die Client-Bibliothek auch benutzen, um serverseitige erneute Überprüfung der übermittelten Formulardaten zu erzwingen.

Adaptive Formulare bieten eine Reihe von APIs, mit denen Sie kommunizieren und Aktionen für adaptive Formulare ausführen können. Einige der wichtigsten APIs sind wie folgt: Weitere Informationen finden Sie unter JavaScript-Bibliotheks-API-Referenz für adaptive Forms.

• guideBridge.reset(): Setzt ein Formular zurück.

• guideBridge.submit(): Versendet ein Formular.

• guideBridge.setFocus(somExp, focusOption, runCompletionExp): Setzt den Fokus auf ein Feld.

• guideBridge.validate(errorList, somExpression, focus): Validiert ein Formular.

• guideBridge.getDataXML(options): Ruft Formulardaten als XML ab.

• guideBridge.resolveNode(somExpression): Ruft ein Formularobjekt ab.

• guideBridge.setProperty(somList, propertyName, valueList): Setzt die Eigenschaft eines Formularobjekts.

• Darüber hinaus können Sie die folgenden Feldeigenschaften verwenden:

  • field.value, um den Wert eines Felds zu ändern.
  • field.enabled, um ein Feld zu aktivieren.
  • field.visible, um die Sichtbarkeit eines Felds zu ändern.

Autoren adaptiver Formulare müssen möglicherweise JavaScript-Code schreiben, um Geschäftslogik in einem Formular zu erstellen. JavaScript ist zwar leistungsstark und effektiv, aber kann die Sicherheit beeinflussen. Daher müssen Sie sicherstellen, dass der Formularautor eine vertrauenswürdige Person ist und dass Prozesse zum Überprüfen und Genehmigen des JavaScript-Codes vorhanden sind, bevor ein Formular in Produktion genommen wird. Der Administrator kann den Zugriff auf den Regeleditor auf Benutzergruppen je nach Rolle oder Funktion beschränken. Siehe Zugriff des Regeleditors auf ausgewählte Benutzergruppen gewähren.

Sie können Ausdrücke in Regeln verwenden, um adaptive Formulare dynamisch zu gestalten. Alle Ausdrücke sind gültige JavaScript-Ausdrücke und verwenden Skriptmodell-APIs für adaptive Formulare. Diese Ausdrücke geben Werte bestimmter Typen zurück. Weitere Informationen zu Ausdrücken und optimalen Verfahren finden Sie unter Adaptive Formularausdrücke.

Es wird empfohlen, adaptive Formulare mithilfe von XSD-Formulardatenmodellen zu erstellen, selbst bei Konvertierung einer XFA in ein adaptives Formular.

Schließen Sie nur die Felder und Bereiche in adaptiven Formularen, die Informationen vom Benutzer erfassen. Erwägen Sie, statische Inhalte zu minimieren oder URLs zu verwenden, um sie in einem separaten Fenster zu öffnen.

Während jedes Formular für einen bestimmten Zweck entwickelt wurde, gibt es in den meisten Formularen einige gängige Segmente. Zum Beispiel persönliche Details, Adresse, Beschäftigungsdetails usw. Erstellen Sie adaptive Formularfragmente für allgemeine Formularelemente und -abschnitte und verwenden Sie diese in allen Formularen. Sie können auch einen Bereich in einem vorhandenen Formular als Fragment speichern. Jede Änderung in einem Fragment wird in allen zugehörigen adaptiven Formularen übernommen. Es unterstützt gemeinsames Authoring, da mehrere Verfasser an verschiedenen Fragmenten, die ein Formular bilden, gleichzeitig arbeiten können.

• Ähnlich wie bei adaptiven Formularen wird empfohlen, dass alle fragmentspezifischen Stile und benutzerdefinierten Skripte in der Client-Bibliothek mithilfe des Dialogfelds "Fragmentcontainer"definiert werden. Versuchen Sie außerdem, selbstständige Fragmente zu erstellen, die nicht von Objekten außerhalb des Fragments abhängig sind.
• Außerdem sollten Sie Cross-Fragments-Skripterstellung vermeiden. Wenn es ein Objekt außerhalb des Fragments gibt, auf das Sie verweisen möchten, müssen Sie das Objekt als Teil des übergeordneten Formulars einarbeiten. Wenn sich das Objekt noch in einem anderen Fragment befinden muss, verweisen Sie im Skript anhand seines Namens darauf.

Verwenden Sie Speichern und Fortsetzen mit automatischem Speichern, um das adaptive Formular regelmäßig zu speichern und Benutzern zu ermöglichen, das Formular zu einem späteren Zeitpunkt erneut aufzurufen, um es auszufüllen.

Konfigurieren Sie Fragmente, um sie verzögert zu laden. Fragmente, die zur Laufzeit als „Verzögert laden“ markiert sind, werden nur gerendert, wenn sie erforderlich sind. Die Ladezeit für große Formulare wird dadurch erheblich reduziert. Sie wird auch in Fragmenten mit wiederholbaren Bereichen unterstützt. Weitere Informationen finden Sie unter Konfigurieren von verzögertem Laden.

• Konfigurieren Sie kein verzögertes Laden für Fragmente in einem responsiven Rasterlayout oder im ersten Bereich.
• In verzögert geladenen Fragmenten werden keine Komponenten für Dateianhänge und Geschäftsbedingungen unterstützt.
• Markieren Sie einen Wert in einem verzögert geladenen Bereich als "Wert global verwenden", wenn dieser Wert in einem anderen Teil des Formulars verwendet wird, sodass der Wert verfügbar ist, wenn der übergeordnete Bereich entladen wird.
• Erwägen Sie, Sichtbarkeitsregeln für Fragmente zu erstellen, die basierend auf einer Bedingung ein- bzw. ausgeblendet werden sollen.

AEM Forms bietet einen Vorbefüllungs-Dienst zum Lesen von Daten aus einer vordefinierten XML-Datendatei und zum Vorbefüllen der Felder eines adaptiven Formulars mit dem Inhalt in der XML-Datei zum Vorausfüllen.

Die XML zum Vorausfüllen der Daten muss mit dem Schema des Formularmodells konform sein, das mit dem adaptiven Formular verknüpft ist.

Schließen Sie die AbschnitteafBoundedData undafUnBoundedData in die Prefill-XML zum Vorbefüllen von gebundenen und ungebundenen Feldern in einem adaptiven Formular ein.

Für adaptive Formulare, die auf dem Formulardatenmodell basieren, bietet AEM Forms einen sofort einsatzbereiten Vorbefüllungs-Service für Formulardatenmodelle an. Der Vorbefüllungs-Dienst fragt Datenquellen für Datenmodellobjekte im adaptiven Formular ab und füllt Feldwerte bei der Wiedergabe des Formulars vorab aus.

Sie können auch die Protokolle Datei, crx, service oder http verwenden, um adaptive Formulare vorab auszufüllen.

AEM Forms unterstützt benutzerdefinierte Vorbefüllungs-Dienste, die Sie als OSGi-Dienst einbinden können, um adaptive Formulare vorab auszufüllen.

Je nach Formulardatenmodell, auf dem ein adaptives Formular basiert, können Sie eine Vorlage für das DoR wie folgt konfigurieren:

• XFA-Formularvorlage: Verwenden Sie die zugehörige XDP-Datei als DoR-Vorlage.
• XSD-Schema: Verwenden Sie die zugeordnete XFA-Vorlage, die dasselbe XML-Schema wie das adaptive Formular verwendet.
• Keines: Verwenden Sie automatisch generierte DoR.

Konfigurieren Sie Kopf- und Fußzeile, Bilder, Farbe, Schriftart usw. direkt auf der Registerkarte "Datensatzdokument"des adaptiven Formulareditors.

Verwenden Sie DoRService, um das DoR programmatisch zu generieren.

Ausgeblendete Felder aus DoR ausschließen.

Verwenden Sie den Aufforderungsparameter afAcceptLang; um DoR in einem anderen Gebietsschema anzuzeigen.

Verwenden Sie adaptive Formularfragmente für gängige Elemente in Formularen und lokalisieren Sie Fragmente. Dadurch wird sichergestellt, dass Sie ein Fragment einmal lokalisieren und es in allen Formularen wiedergeben, in denen das lokalisierte Fragment verwendet wird.

Änderungen wie das Hinzufügen einer neuen Komponente oder das Anwenden eines Skripts in einem lokalisierten Formular werden nicht automatisch lokalisiert. Daher müssen Sie ein Formular vor der Lokalisierung fertigstellen, um mehrere Lokalisierungszyklen zu vermeiden.

Verwenden Sie den Anforderungsparameter afAcceptLang, um das Browsergebietsschemazu überschreiben und das Formular in einem spezifischen Gebietsschema zu lokalisieren. Die folgende URL erzwingt beispielsweise die Darstellung des Formulars im japanischen Gebietsschema, unabhängig vom Gebietsschema, das in den Browser-Einstellungen angegeben ist:

https://[*server*]:[*port*]/<*contextPath*>/<*formFolder*>/<*formName*>.html?wcmmode=disabled&afAcceptLang=ja

AEM Forms unterstützt derzeit die Lokalisierung von Inhalten für adaptive Formulare in den Gebietsschemata Englisch (en), Spanisch (es), Französisch (fr), Italienisch (it), Deutsch (de), Japanisch (ja), Portugiesisch-Brasilianisch (pt-BR), Chinesisch-Taiwan (zh-TW) und Koreanisch (ko-KR). Sie können jedoch zur Laufzeit Unterstützung für neue Gebietsschemata für adaptive Formulare hinzufügen. Weitere Informationen finden Sie unter Unterstützung neuer Gebietsschemata für die Lokalisierung adaptiver Formulare.

Aktivieren Sie HTML-Client-Bibliothekskomprimierung für JavaScript und CSS-Code aus der Felix-Konsole.

Speichern Sie alle Client-Bibliotheken unter /etc.clientlibs/fd und alle zusätzlichen benutzerdefinierten Client-Bibliotheken auf dem AEM-Dispatcher zwischen, um die Interaktivität und Sicherheit Ihrer veröffentlichen Formulare zu erhöhen. Weitere Informationen finden Sie unter Dispatcher

Speichern Sie keine /content/forms/af/- und /content/dam/formsanddocuments/*-Pfade im Cache. Detaillierte Informationen zum Konfigurieren der Zwischenspeicherung adaptiver Formulare finden Sie unter Zwischenspeichern adaptiver Formulare.

Aktivieren Sie HTML über das Webserver-Komprimierungsmodul. Weitere Informationen finden Sie im Abschnitt Leistungsoptimierung des AEM Forms-Servers.

Erhöhen Sie Aufrufe pro Anforderungskonfiguration für große Formulare. Siehe Optimieren der Leistung von großen und komplexen Formularen.

Erstellen Benutzerdefinierte Fehlerseiten, die vom Fehler-Handler angezeigt werden.

Sichere AEM Forms-Server.

• Verwenden Sie nosamplecontent-Laufzeitmodus unter, um sicherzustellen, dass die Anwendung keine Beispielinhalte und Beispielbenutzer enthält, die auf dem Produktionsserver bereitgestellt werden. Siehe Ausführen von AEM im produktionsfertigen Modus.

Halten Sie die Heap-Größe auf mindestens 8 GB fest. Für andere Einstellungen finden Sie weitere Informationen im Abschnitt Leistungsoptimierung des AEM Forms-Servers.

Verwenden Sie Dienstbenutzersitzungen anstelle von Admin-Sitzungen zum Ausführen von Aufgaben auf Dienstebene. Weitere Informationen finden Sie unter Dienstauthentifizierung.

Speichern von Entwurfsdaten: Wenn Sie die Funktion „Entwurf“ in ein adaptiven Formularen verwenden, müssen Sie eine benutzerdefinierte Service Provide Interface (Dienstanbieterbenutzeroberfläche, SPI) verwenden, um Entwurfsdaten in einem sichereren Speicher wie in einer Datenbank zu speichern. Weitere Informationen finden Sie unter Beispiel zur Integrierung der Komponente für Entwurf und Übermittlung in die Datenbank.

Speichern von Übermittlungsdaten: Wenn Sie den Formularportalübermittlungs-Store verwenden, sollten Sie eine benutzerdefinierte SPI implementieren, um Übermittlungsdaten in einer Datenbank zu speichern. Siehe Beispiel für die Integration der Komponente für Entwürfe und Übermittlungen mit der Datenbank für ein Integrationsbeispiel.

Sie können auch eine benutzerdefinierte Übermittlungsaktion schreiben, die Formulardaten und Anhänge in einem sicheren Speicher speichert. Weitere Informationen finden Sie unter Schreiben einer benutzerdefinierten Sendeaktion für adaptive Formulare.