Anpassen von Vorlagen für Forms Portal-Komponenten

Letzte Aktualisierung: 2023-11-01
  • Erstellt für:
  • User

Voraussetzungen

Formularmetadaten verwalten

Kenntnisse im Bereich HTML und CSS

Übersicht

In der Benutzeroberfläche von AEM Forms können Sie jedem beliebigen Formular Metadaten hinzufügen. Benutzerdefinierte Metadaten können das Benutzererlebnis beim Auflisten und Suchen von Formularen in Ihrer Organisation verbessern.

Mit Forms Portal können Sie benutzerdefinierte Metadaten in Formularlisten verwenden. Beim Erstellen benutzerdefinierter Vorlagen für Assets können Sie das Layout ändern und benutzerdefinierte Metadaten mit Ihrem CSS-Stilsatz verwenden.

Führen Sie die folgenden Schritte aus, damit Sie eine benutzerdefinierte Vorlage für verschiedene Forms Portal-Komponenten erstellen können.

Benutzerdefinierte Vorlage erstellen

  1. Erstellen eines sling:Folder-Knotens unter /apps

    Fügen Sie eine fpContentType-Eigenschaft hinzu. Geben Sie die entsprechenden Werte für die Eigenschaft an, abhängig von der Komponente, für die Sie die benutzerdefinierte Vorlage definieren.

    • Komponente „Search & Lister“: „/libs/fd/fp/formTemplate“

    • Komponente „Drafts & Submissions“:

      • Bereich "Drafts": /libs/fd/fp/draftsTemplate
      • Bereich "Submissions": /libs/fd/fp/submissionsTemplate

    • Link-Komponente: /libs/fd/fp/linkTemplate

    Fügen Sie einen Titel hinzu, der bei der Auswahl der Layoutvorlagen angezeigt werden soll.

    HINWEIS

    Der Titel kann sich von dem Knotennamen des erstellten sling:Folder unterscheiden.

    Die folgende Abbildung zeigt die Konfiguration der Komponente „Search & Lister“.
    Erstellen eines sling:Folder

  2. Erstellen Sie eine Datei template.html in diesem Ordner, damit sie als benutzerdefinierte Vorlage dienen kann.

  3. Schreiben Sie die benutzerdefinierte Vorlage und verwenden Sie benutzerdefinierte Metadaten wie unten beschrieben.

Arbeitsbeispiel

Im Folgenden finden Sie eine Beispielimplementierung einer benutzerdefinierten Vorlage, bei der Forms Portal ein benutzerdefiniertes Geometrixx Gov Card-Layout für die Komponente "Search & Lister"abruft.

<div class="__FP_boxes-container __FP_single-color">
    <div class="boxes __FP_boxes __FP_single-color" data-repeatable="true">
 <div class="__FP_boxes-thumbnail">
     <img src ="${path}/jcr:content/renditions/cq5dam.thumbnail.319.319.png"/>
        </div>
        <h3 class="__FP_single-color" title="${name}" tabindex="0">${name}</h3>
        <p>${description}</p>
        <div class="boxes-icon-cont __FP_boxes-icon-cont">
            <div class="op-dow">
                <a href="${formUrl}" target="_blank" class="__FP_button ${htmlStyle}" title="${config-htmlLinkText}">${localize-Apply}</a>
                <a href="${pdfUrl}" class="__FP_button ${pdfStyle}" title="${config-pdfLinkText}">${localize-Download}</a>
            </div>
        </div>
    </div>
</div>

Technische Spezifikationen für benutzerdefinierte Vorlagen

Eine benutzerdefinierte Vorlage für eine beliebige Formularportal-Komponente enthält wiederholbare und nicht wiederholbare Einträge. Wiederholbare Einträge sind grundlegende Entitäten für die Auflistung. Beispiele für wiederholbare Einträge sind die Komponenten "Search & Lister", "Drafts & Submissions"und "Link".

Forms Portal bietet eine Syntax für Platzhalter zur Anzeige von benutzerdefinierten bzw. OOTB-Metadaten. Die Platzhalter werden nach der Anzeige der Ergebnisse von Formularen, Entwürfen oder Übermittlungen ausgefüllt.

Um einen wiederholbaren Eintrag einzuschließen, konfigurieren Sie den Wert des Attributs data-repeatable als true.

Im gezeigten Beispiel sind oben in der benutzerdefinierten Vorlage zwei Div-Elemente vorhanden. Das erste mit der CSS-Klasse „__FP_boxes-container“ fungiert als Containerelement für die aufgelisteten Formulare. Das zweite mit der CSS-Klasse „__FP_boxes“ ist eine Vorlage für die Basiseinheiten, in diesem Fall ein Formular. Das Attribut data-repeatable​im Div-Element weist den Wert true​auf.

Jeder Platzhalter verfügt über einen exklusiven OOTB-Metadatensatz. Um die benutzerdefinierten Metadaten an einer bestimmten Position im Formular anzuzeigen, fügen Sie die ${metadata_prop}-Eigenschaft an der entsprechenden Position hinzu.

In diesem Beispiel wird die Metadateneigenschaft in mehreren Instanzen verwendet. Sie wird z. B. bei description,name,formUrl,htmlStyle,pdfUrl,pdfStyle​und path​in der genannten Weise verwendet.

Vordefinierte Metadaten

Verschiedene Forms Portal-Komponenten bieten exklusive OOTB-Metadatensätze, die Sie für die Auflistung verwenden können.

Komponente „Suche und Auflister“

  • Title: Titel des Formulars

  • name: Name des Formulars (meist identisch mit dem Titel)

  • description: Beschreibung des Formulars

  • formUrl: URL zur Ausgabe des Formulars als HTML

  • pdfUrl: URL zur Ausgabe des Formulars als PDF

  • assetType: Typ des Assets. Gültige Werte sind unter anderem Form,PDF Form,Print Form und Adaptive Form

  • htmlStyle& pdfStyle: Anzeigestil für HTML- bzw. PDF-Symbole für die Ausgabe. Gültige Werte sind „__FP_display_none“ oder leer.

HINWEIS

Denken Sie daran, im benutzerdefinierten Stylesheet die Klasse „__FP_display_none“ zu verwenden.

  • downloadUrl: URL für das Herunterladen eines Assets.

Unterstützung für Lokalisierung, Sortierung und Verwendung von Konfigurationseigenschaften in der Benutzeroberfläche (nur Search & Lister):

  1. Lokalisierungsunterstützung: Zur Lokalisierung von beliebigem statischem Text verwenden Sie das Attribut ${localize-YOUR_TEXT} und stellen Sie den lokalisierten Wert bereit, sofern er nicht bereits vorhanden ist.
    Im genannten Beispiel werden die Attribute ${localize-Apply} und ${localize-Download} verwendet, um den Text „Apply“ und „Download“ zu lokalisieren.

  2. Unterstützung für die Sortierung: Klicken Sie auf das HTML-Element, um die Suchergebnisse zu sortieren. Um die Sortierung in ein Tabellenlayout zu implementieren, fügen Sie das Attribut "data-sortKey" in die jeweilige Tabellenüberschrift ein. Fügen Sie außerdem seinen Wert als die Metadaten hinzu, nach denen Sie sortieren möchten.
    So ist z. B. im Header „Title“ in der Rasteransicht der Wert für den Header „data-sortKey“ „title“. Klicken Sie auf die Überschrift, damit Sie die Werte in einer bestimmten Spalte sortieren können.

  3. Verwenden von Konfigurationseigenschaften: Die Komponente „Search & Lister“ verfügt über mehrere Konfigurationen, die Sie in der Benutzeroberfläche verwenden können. Verwenden Sie z. B. das Attribut ${config-htmlLinkText}, um im Bearbeitungsdialogfeld gespeicherten HTML-QuickInfo-Text anzuzeigen.  Verwenden Sie analog dazu für PDF-QuickInfo-Text das Attribut ${config-pdfLinkText}.

  • Title: Titel des Formulars
  • formUrl: URL zur Ausgabe des Formulars als HTML
  • target: Zielattribut des Links. Gültige Werte sind „_blank“ und „_self“.
  • linkText: Linkbeschriftung

Komponente "Drafts & Submissions"

  • Path: Pfad des Entwurfs-/Übermittlungs-Metadatenknotens. Verwenden Sie ihn mit der Erweiterung .HTML als URL, damit Sie einen Entwurf oder eine Übermittlung öffnen können.
  • contextPath: Kontextpfad der AEM Instanz
  • firstLetter: Erster Buchstabe (in Großbuchstaben) des Titels des adaptiven Formulars, der als Entwurf gespeichert oder übermittelt wurde.
  • formName: Der Titel des adaptiven Formulars, das als Entwurf gespeichert oder übermittelt wurde.
  • draftID: ID für den aufgelisteten Entwurf (Nur in der Vorlage für den Bereich Entwurf verwenden).
  • submitID: ID für die aufgelistete Übermittlung (Nur in der Vorlage für den Abschnitt Übermittlung verwenden).
  • status: Status des gesendeten Formulars. (Nur in der Vorlage für den Abschnitt Übermittlung verwenden).
  • description: Beschreibung des adaptiven Formulars, das mit dem Entwurf oder der Übermittlung verknüpft ist.
  • diffTime: Differenz zwischen der aktuellen Zeit und der letzten Speicheraktion für den Entwurf. Alternativ dazu die Differenz zwischen der aktuellen und der zuletzt gesendeten Aktion für die Übermittlung.
  • iconClass: CSS-Klasse zur Anzeige des ersten Buchstabens des Entwurfs/der Übermittlung. Forms Portal umfasst die folgenden Klassen, die verschiedene farbige Hintergründe bieten.
  • owner: Benutzer, der den Entwurf/die Übermittlung erstellt hat.
  • Today: Erstellungsdatum des Entwurfs/der Übermittlung im Format TT:MM:JJJJ.
  • TimeNow: Erstellungszeitpunkt des Entwurfs/der Übermittlung im 24-Stunden-Format HH:MM:SS.

Hinweis:

  1. Geben Sie der CSS-Klasse für die Löschoption im Bereich „Drafts“ in der Komponente „Drafts & Submissions“ den Namen „__FP_deleteDraft“. Schließen Sie außerdem das Attribut „draftID“ mit dem Wert ${draftID} ein, bei dem es sich um die Entwurfs-ID des entsprechenden Entwurfs handelt.

  2. Beim Erstellen von Links zu geöffneten Entwürfen und Übermittlungen können Sie ${path}.html als Wert des href-Attributs für das Anker-Tag angeben.

Knoten „Drafts and Submission“

A. Container-Element

B. „path“-Metadaten mit einer festen Hierarchie zum Abruf der für jedes Formular gespeicherten Miniatur.

C. Datenwiederholbares Attribut für den Vorlagenbereich jedes Formulars

D. Zeichenfolge "Anwenden"lokalisieren

E. Verwenden der Konfigurationseigenschaft „pdfLinkText“

F. Verwenden der Metadaten „pdfUrl“

Tipps, Tricks und bekannte Probleme

  1. Verwenden Sie in keiner benutzerdefinierten Vorlage einfache Anführungszeichen (').
  2. Bei benutzerdefinierten Metadaten speichern Sie diese Eigenschaft nur im Knoten jcr:content/metadata. Wenn Sie sie an einem anderen Ort speichern, kann das Formularportal die Metadaten nicht anzeigen.
  3. Stellen Sie sicher, dass der Name von benutzerdefinierten bzw. bereits vorhandenen Metadaten keinen Doppelpunkt (:) enthält. Wenn dies der Fall ist, können Sie ihn nicht auf der Benutzeroberfläche anzeigen.
  4. data-repeatable hat keinerlei Bedeutung für eine Komponente des Typs Link. Adobe empfiehlt, diese Eigenschaften in einer Vorlage für eine Komponente des Typs „Link“ zu vermeiden.

Ähnliche Artikel

Vorherige Seite
Next page

Auf dieser Seite