Erstellen von Formularfragmenten im universellen Editor

Formularfragmente sind wiederverwendbare Komponenten, mit denen sich wiederholende Entwicklungsaufgaben erübrigen und die Konsistenz der Formulare in Ihrem Unternehmen sicherstellen lässt. Anstatt für jedes Formular gemeinsame Abschnitte wie Kontaktdaten, Adressdetails oder Einverständniserklärungen neu zu erstellen, können Sie diese Elemente einmal als Fragmente erstellen und sie dann in verschiedenen Formularen wiederverwenden.

Was Sie in diesem Artikel erreichen werden:

  • Vertrautmachen mit dem geschäftlichen Nutzen und den technischen Funktionen von Formularfragmenten
  • Erstellen wiederverwendbarer Formularfragmente mit dem universellen Editor
  • Integrieren von Fragmenten in vorhandene Formulare mit ordnungsgemäßer Konfiguration
  • Verwalten des Lebenszyklus von Fragmenten und Beibehalten der Konsistenz über Formulare hinweg

Geschäftliche Vorteile:

  • Verkürzte Entwicklungszeit: Einmalige Erstellung von allgemeinen Formularabschnitten und Wiederverwendung überall
  • Höhere Konsistenz: Standardisierte Layouts und Inhalte für alle Formulare
  • Vereinfachte Wartung: Einmaliges Aktualisieren eines Fragments, um Änderungen in allen Formularen widerzuspiegeln, die es verwenden
  • Verbesserte Compliance: Sicherstellen, dass regulatorische Abschnitte konsistent und aktuell bleiben

Formularfragmente in Edge Delivery Services unterstützen erweiterte Funktionen wie verschachtelte Fragmente, mehrere Instanzen innerhalb eines Formulars und nahtlose Integration mit Datenquellen.

Grundlegendes zu Formularfragmenten

Formularfragmente in Edge Delivery Services bieten leistungsstarke Funktionen für die Entwicklung modularer Formulare:

Kernfunktionen:

  • Konsistenz-Management: Fragmente verwalten identische Layouts und Inhalte in verschiedenen Formularen. Mit dem Ansatz „Einmal ändern, überall widerspiegeln“ wird jede Aktualisierung eines Fragments automatisch auf alle Formulare im Vorschaumodus angewendet.
  • Mehrfache Verwendung: Fügen Sie dasselbe Fragment mehrmals in einem einzelnen Formular hinzu, wobei jedes Fragment eine unabhängige Datenbindung an verschiedene Datenquellen oder Schemaelemente aufweist.
  • Verschachtelte Strukturen: Erstellen Sie komplexe Hierarchien, indem Sie Fragmente in andere Fragmente einbetten, um komplexe Formulararchitekturen zu erstellen.

Technische Anforderungen:

  • Konsistenz der GitHub-URL: Sowohl das Fragment als auch jedes Formular, das es nutzt, müssen dieselbe GitHub-Repository-URL aufweisen.
  • Eigenständige Bearbeitung: Fragmente können nur in ihrer eigenständigen Form geändert werden. Änderungen innerhalb des Host-Formulars sind nicht möglich.

Veröffentlichungsverhalten:

IMPORTANT
Im Vorschaumodus werden Fragmentänderungen sofort in allen Formularen übernommen. Im Veröffentlichungsmodus müssen Sie sowohl das Fragment als auch alle Formulare, die es verwenden, erneut veröffentlichen, um Aktualisierungen widerzuspiegeln.
CAUTION
Vermeiden Sie rekursive Fragmentverweise (Verschachteln eines Fragments in sich selbst), da dies zu Rendering-Fehlern und unerwartetem Verhalten führt.

Voraussetzungen

Technische Setup-Anforderungen:

  • GitHub-Repository konfiguriert mit hergestellter Verbindung zwischen Ihrer AEM-Umgebung und dem GitHub-Repository
  • Neuester adaptiver Formularblock zum GitHub-Repository hinzugefügt (für bestehende Edge Delivery Services-Projekte)
  • AEM Forms-Autoreninstanz mit Edge Delivery Services-Vorlage verfügbar
  • Zugriff auf die URL Ihrer AEM Forms as a Cloud Service-Autoreninstanz und die GitHub-Repository-URL

Erforderliche Kenntnisse und Berechtigungen:

  • Grundlegendes Verständnis der Konzepte des Formularentwurfs und der Komponentenhierarchie
  • Vertrautheit mit der Benutzeroberfläche des universellen Editors und den Workflows zur Formularerstellung
  • Berechtigungen auf Autorenebene in AEM Forms zum Erstellen und Verwalten von Formular-Assets
  • Verständnis der Formularstandards Ihres Unternehmens und Anforderungen für wiederverwendbare Komponenten

Arbeiten mit Edge Delivery Services-Formularfragmenten

Sie können Edge Delivery Services-Formularfragmente im universellen Editor erstellen und die erstellten Fragmente zu Edge Delivery Services-Formularen hinzufügen. Sie können mit Edge Delivery Services-Formularfragmenten die folgenden Aktionen durchführen:

Erstellen von adaptiven Formularfragmenten

Gehen Sie zum Erstellen eines Formularfragments im universellen Editor wie folgt vor:

  1. Melden Sie sich bei Ihrer AEM Forms as a Cloud Service-Autoreninstanz an.

  2. Wählen Sie  Adobe Experience Manager > Formulare  > Formulare und Dokumente aus.

  3. Klicken Sie auf Erstellen > Adaptives Formularfragment.

    Erstellen eines Fragments

    Der Assistent zum Erstellen von adaptiven Formularfragmenten wird angezeigt.

  4. Wählen Sie auf der Registerkarte Vorlage auswählen die auf Edge Delivery Services basierende Vorlage aus und klicken Sie auf Weiter.
    Auswählen einer Edge Delivery Services-Vorlage

  5. Geben Sie Titel, Namen, Beschreibung und Tags für das Fragment an. Stellen Sie sicher, dass Sie einen eindeutigen Namen für das Fragment angeben. Wenn bereits ein anderes Fragment mit demselben Namen vorhanden ist, kann das Fragment nicht erstellt werden.

  6. Geben Sie die GitHub-URL an. Wenn Ihr GitHub-Repository beispielsweise edsforms heißt und sich unter dem Konto wkndforms befindet, lautet die URL https://github.com/wkndforms/edsforms.

    Allgemeine Eigenschaften

  7. (Optional) Klicken Sie auf die Registerkarte Formularmodell, um sie zu öffnen. Wählen Sie dann aus dem Dropdown-Menü Auswählen eines der folgenden Fragmentmodelle:

    Zeigt den Modelltyp auf der Registerkarte „Formularmodell“ an

    • Formulardatenmodell (FDM): Zum Integrieren von Datenmodellobjekten und Diensten aus Datenquellen in Ihr Fragment. Wählen Sie „Formulardatenmodell (FDM)“, wenn Ihr Formular das Lesen und Schreiben von Daten aus mehreren Quellen erfordert.

    • JSON-Schema: Zum Integrieren Ihres Formulars in ein Backend-System, indem Sie ein JSON-Schema verknüpfen, das die Datenstruktur definiert. Damit können Sie dynamische Inhalte mithilfe der Schemaelemente hinzufügen.

    • Keine: Gibt an, dass das Fragment von Grund auf ohne Formularmodell erstellt werden soll.

    note note
    NOTE
    Um mehr über die Integration von Formularen oder Fragmenten mit einem Formulardatenmodell (FDM) im universellen Editor zur Verwendung verschiedener Backend-Datenquellen zu erfahren, konsultieren Sie Formulare mit Formulardatenmodell im universellen Editor integrieren.
  8. (Optional) Geben Sie auf der Registerkarte Erweitert das Veröffentlichungsdatum oder das Datum der Aufhebung der Veröffentlichung für das Fragment an.

    Registerkarte „Erweitert“

  9. Klicken Sie auf Erstellen, um das Fragment zu generieren. Es wird ein Erfolgsdialogfeld mit Bearbeitungsoptionen angezeigt.

    Bearbeiten eines Fragments

  10. Klicken Sie auf Bearbeiten, um das Fragment im universellen Editor mit angewendeter Standardvorlage zu öffnen.

    Fragment im universellen Editor zum Authoring

  11. Gestalten Ihres Fragmentinhalts: Fügen Sie Formularkomponenten (Textfelder, Dropdown-Listen, Kontrollkästchen) hinzu, um den wiederverwendbaren Abschnitt zu erstellen. Detaillierte Komponentenanleitungen finden Sie unter Erste Schritte mit Edge Delivery Services für AEM Forms unter Einsatz des universellen Editors.

  12. Konfigurieren der Komponenteneigenschaften: Legen Sie für Ihren Anwendungsfall je nach Bedarf Feldnamen, Validierungsregeln und Standardwerte fest.

  13. Speichern und Vorschau: Speichern Sie das Fragment und verwenden Sie den Vorschaumodus, um das Layout und die Funktionalität zu überprüfen.

    Screenshot eines ausgefüllten Formularfragments für Kontaktdetails im universellen Editor, mit Feldern für Name, Telefon, E-Mail und Adresse, die in mehreren Formularen wiederverwendet werden können

Validierungs-Checkpoint:

  • Fragment wird im universellen Editor fehlerfrei geladen
  • Alle Formularkomponenten werden korrekt gerendert
  • Feldeigenschaften und Validierungsregeln funktionieren ordnungsgemäß
  • Fragment wird gespeichert und ist in der Forms- und Dokumentenkonsole verfügbar

Sobald Ihr Fragment vollständig ist, können Sie es in ein beliebiges Edge Delivery Services-Formular integrieren.

Hinzufügen von Formularfragmenten zu einem Formular

Dieses Beispiel veranschaulicht das Erstellen eines Employee Details-Formulars, das das Contact Details-Fragment für die Abschnitte „Mitarbeiterinnen und Mitarbeiter“ und „Vorgesetzte“ verwendet. Dieser Ansatz gewährleistet eine konsistente Datenerfassung und reduziert gleichzeitig den Entwicklungsaufwand.

So integrieren Sie ein Formularfragment in Ihr Formular:

  1. Öffnen Sie das Formular im Bearbeitungsmodus.

  2. Fügen Sie die Komponente „Formularfragment“ dem Formular hinzu.

  3. Öffnen Sie den Inhalts-Browser und navigieren Sie in der Inhaltsstruktur zur Komponente Adaptives Formular.

  4. Navigieren Sie zum Abschnitt, in dem ein Fragment hinzugefügt werden soll. Navigieren Sie beispielsweise zum Panel mit den Mitarbeiterdetails.

    Navigieren zum Abschnitt

  5. Klicken Sie auf das Symbol Hinzufügen und fügen Sie die Komponente Formularfragment  aus der Liste der adaptiven Formularkomponenten hinzu.
    Hinzufügen eines Formularfragments

    Wenn Sie die Komponente Formularfragment auswählen, wird das Fragment zu Ihrem Formular hinzugefügt. Sie können die Eigenschaften des hinzugefügten Fragments konfigurieren, indem Sie dessen Eigenschaften öffnen. Blenden Sie beispielsweise den Titel des Fragments in seinen Eigenschaften aus.

    Konfigurieren der Fragmenteigenschaften

  6. Wählen Sie den Fragmentverweis auf der Registerkarte Allgemein aus. Je nach Formularmodell werden alle für Ihr Formular verfügbaren Fragmente angezeigt.

    Navigieren Sie beispielsweise zu /content/forms/af und wählen Sie das Fragment Contact Details aus:

    Auswählen eines Fragments

  7. Klicken Sie auf Auswählen.

    Das Formularfragment wird als Verweis in das Formular eingefügt und bleibt mit dem eigenständigen Formularfragment synchronisiert.

    Screenshot, der zeigt, wie das Fragment „Kontaktdetails“ im universellen Editor erfolgreich in ein Mitarbeiterformular integriert wurde und wie Fragmente ihre Struktur beibehalten, wenn sie wiederverwendet werden

    note note
    NOTE
    Mit der Schaltfläche Fragment bearbeiten können Benutzende zum Bearbeiten direkt zum Formularfragment navigieren.

    Sie können das Formular in einer Vorschau anzeigen, um zu sehen, wie das Formular im Modus Vorschau aussieht.

    Vorschau

    Auf ähnliche Weise können Sie die Schritte 3 bis 7 wiederholen, um das Fragment Contact Details für das Panel Supervisor Details einzufügen.

    Formular „Mitarbeiterdetails“

Verwalten von Formularfragmenten

Auf der Benutzeroberfläche von AEM Forms können Sie mehrere Aktionen für Formularfragmente ausführen.

  1. Melden Sie sich bei Ihrer AEM Forms as a Cloud Service-Autoreninstanz an.

  2. Wählen Sie  Adobe Experience Manager > Formulare  > Formulare und Dokumente aus.

  3. Wenn Sie ein Formularfragment auswählen, werden in der Symbolleiste die folgenden Vorgänge angezeigt, die Sie mit dem ausgewählten Fragment durchführen können.

    Verwalten von Fragmenten

    table 0-row-2 1-row-2 2-row-2 3-row-2 4-row-2 5-row-2 6-row-2 7-row-2 8-row-2 9-row-2 html-authored no-header
    Vorgang Beschreibung
    Bearbeiten Öffnet das Formularfragment im Bearbeitungsmodus.
    Eigenschaften Bietet Optionen zum Ändern der Eigenschaften des Formularfragments.
    Kopieren Bietet Optionen zum Kopieren des Formularfragments und zum Einfügen des Fragments an der gewünschten Position.
    Vorschau Bietet Optionen zum Anzeigen einer HTML-Vorschau des Fragments oder für eine benutzerdefinierte Vorschau des Fragments durch Zusammenführen von Daten aus einer XML-Datei mit dem Fragment.
    Herunterladen Lädt das ausgewählte Fragment herunter.
    Überprüfung starten/Überprüfung verwalten Ermöglicht es, eine Überprüfung des ausgewählten Fragments zu initiieren und zu verwalten.
    Veröffentlichen/Veröffentlichung rückgängig machen Veröffentlicht das ausgewählte Fragment bzw. macht die Veröffentlichung rückgängig.
    Löschen Löscht das ausgewählte Fragment.
    Vergleichen Vergleicht zwei verschiedene Formularfragmente zu Vorschauzwecken.

Best Practices

Design und Benennung von Fragmenten:

  • Beschreibende, eindeutige Namen verwenden Wählen Sie Namen, die den Zweck des Fragments klar machen (z. B. „kontaktdetails-mit-validierung“ anstelle von „fragment1“).
  • Wiederverwendbarkeit planen: Entwerfen Sie Fragmente kontextunabhängig, sodass sie über verschiedene Formulartypen hinweg funktionieren.
  • Fragmente fokussiert halten: Erstellen Sie Fragmente für einen einzigen Zweck anstelle von komplexen, multifunktionalen Komponenten.

Entwicklungs-Workflow:

  • Fragmente unabhängig testen: Überprüfen Sie die Funktionalität von Fragmenten vor der Integration in Formulare.
  • Konsistente GitHub-URLs beibehalten: Stellen Sie sicher, dass in allen zugehörigen Fragmenten und Formularen dieselbe Repository-URL verwendet wird.
  • Zweck von Dokumentfragmenten: Geben Sie klare Beschreibungen und Tags an, damit Team-Mitglieder verstehen können, wann einzelne Fragmente verwendet werden sollen.

Veröffentlichung und Wartung:

  • Veröffentlichung koordinieren: Planen Sie beim Aktualisieren von Fragmenten, alle abhängigen Formulare gleichzeitig erneut zu veröffentlichen.
  • Versionskontrolle: Verwenden Sie beim Aktualisieren von Fragmenten aussagekräftige Commit-Meldungen, um Änderungen im Laufe der Zeit verfolgen zu können.
  • Abhängigkeiten überwachen: Verfolgen Sie zur Einschätzung der Auswirkungen von Aktualisierungen, welche Formulare die einzelnen Fragmente verwenden.
TIP
Fragmentstile, Skripte und Ausdrücke werden beim Einbetten beibehalten. Daher ist diese Vererbung bei der Gestaltung zu berücksichtigen.

Zusammenfassung

Sie haben erfahren, wie Sie Formularfragmente in Edge Delivery Services nutzen können, um die Entwicklungseffizienz zu erhöhen und die Konsistenz zwischen Formularen Ihres Unternehmens zu wahren.

Schlüsselergebnisse:

  • Verständnis: Ermittlung des geschäftlichen Nutzens und der technischen Möglichkeiten von Formularfragmenten
  • Erstellung: Entwicklung von wiederverwendbaren Formularfragmenten mit ordnungsgemäßer Konfiguration unter Einsatz des universellen Editors
  • Integration: Hinzufügen von Fragmenten zu Formularen mit korrekter Referenzeinrichtung und Konfiguration von Eigenschaften
  • Management: Verständnis der Vorgänge im Fragmentlebenszyklus und der Wartungs-Workflows

Nächste Schritte:

  • Erstellen Sie eine Bibliothek häufig verwendeter Fragmente für Ihre Organisation.
  • Legen Sie Benennungskonventionen und Governance-Richtlinien für die Fragmentverwendung fest.
  • Erkunden Sie die erweiterte Integration mit Formulardatenmodellen für dynamische datengestützte Fragmente
  • Implementieren Sie fragmentbasierte Formularvorlagen für konsistente Benutzererlebnisse.

Ihre Formulare profitieren nun von einer modularen, verwaltbaren Architektur, die effizient über Projekte skaliert werden kann. Gleichzeitig werden konsistente Benutzererlebnisse sichergestellt.

recommendation-more-help
fbcff2a9-b6fe-4574-b04a-21e75df764ab