Show Menu
THEMEN×

Beispiel zur Integrierung der Komponente für Entwurf und Übermittlung in die Datenbank

Überblick zum Beispiel

Mit der Komponente für Entwurf und Übermittlung des AEM Forms Portals können Benutzer ihre Formulare als Entwürfe speichern und zu einem späteren Zeitpunkt von jedem beliebigen Gerät senden. Zudem können die Benutzer ihre übermittelten Formulare im Portal anzeigen. Um diese Funktion zu aktivieren, bietet AEM Forms Daten- und Metadatendienste an, um die vom Benutzer im Formular eingegebenen Daten sowie die mit Entwürfen und gesendeten Formularen verknüpften Metadaten zu speichern. Diese Daten werden standardmäßig im CRX-Repository gespeichert. Da die Benutzer mit den Formularen jedoch über eine AEM-Veröffentlichunginstanz interagieren, die in der Regel außerhalb der Unternehmens-Firewall liegt, sollten Sie die Datenspeicherung so anpassen, dass sie sicherer und zuverlässiger ist.
Das in diesem Dokument gezeigte Beispiel ist eine Referenzimplementierung benutzerdefinierter Daten- und Metadatendienste zur Integration der Komponente für Entwurf und Übermittlung in eine Datenbank. In der Beispielimplementierung wird die Datenbank MySQL 5.6.24 verwendet. Sie können die Komponente für Entwurf und Übermittlung jedoch in eine Datenbank Ihrer Wahl integrieren.
  • Die Beispiele und Konfigurationen in diesem Dokument entsprechen MySQL 5.6.24 und Sie müssen sie für Ihr Datenbanksystem anpassen.
  • Stellen Sie sicher, dass Sie die neueste Version des AEM Forms Add-On-Pakets installiert haben. Eine Liste der verfügbaren Pakete finden Sie im Artikel AEM Forms Freigabe .
  • Das Musterpaket funktioniert nur mit Übermittlungsaktionen für adaptive Formulare.

Beispiel installieren und konfigurieren

Führen Sie die folgenden Schritte für alle Autoren- und Veröffentlichungsinstanzen durch, um das Beispiel zu installieren und zu konfigurieren :
  1. Laden Sie das folgende aem-fp-db-integration-sample-pkg-6.1.2.zip -Paket auf Ihr Dateisystem herunter.
    Beispielpaket für Datenbankintegration
  2. Go to AEM package manager at https:// #: #/crx/packmgr/.
  3. Klicken Sie auf Paket hochladen .
  4. Navigieren Sie zum Paket aem-fp-db-integration-sample-pkg-6.1.2.zip , wählen Sie es aus und klicken Sie auf OK .
  5. Klicken Sie neben dem Paket auf Installieren , um das Paket zu installieren.
  6. Go to AEM Web Console Configuration page at https:// #: #/system/console/configMgr.
  7. Klicken Sie, um die Konfiguration des Forms Portals für Entwurf und Übermittlung im Bearbeitungsmodus zu öffnen.
  8. Geben Sie die Werte für die Eigenschaften an, wie in der folgenden Tabelle beschrieben:
    Eigenschaft
    Beschreibung
    Wert
    Forms Portal-Datendienst für Entwurf
    Bezeichner für den Datendienst für Entwurf
    formsportal.sampledataservice
    Forms Portal-Metadatendienst für Entwurf
    Bezeichner für den Dienst für Entwurfs-Metadaten
    formsportal.samplemetadataservice
    Forms Portal-Datendienst für Übermittlung
    Bezeichner für den Dienst zur Datenübermittlung
    formsportal.sampledataservice
    Forms Portal-Metadatendienst für Übermittlung
    Bezeichner für den Dienst Metadatenübermittlung
    formsportal.samplemetadataservice
    Forms Portal ausstehender Sign Datendienst
    Bezeichner für den Dienst für Daten zu ausstehende Signaturen
    formsportal.sampledataservice
    Forms Portal ausstehender Sign Metadatendienst
    Bezeichner für den Dienst für Metadaten zu ausstehende Signaturen
    formsportal.samplemetadataservice
    Die Dienste werden nach ihren Namen aufgelöst, die als Wert für den aem.formsportal.impl.prop -Schlüssel wie folgt erwähnt werden:
    @Service(value = {SubmitDataService.class, DraftDataService.class})
    @Property(name = "aem.formsportal.impl.prop", value = "formsportal.sampledataservice")
    @Service(value = { SubmitMetadataService.class, DraftMetadataService.class })
    @Property(name = "aem.formsportal.impl.prop", value = "formsportal.samplemetadataservice")
    
    
    Sie können die Namen der Daten- und Metadatentabellen ändern.
    Angeben eines anderen Namens für die Metadatentabelle:
    • Auf der Seite zur Web-Konsolenkonfiguration klicken Sie auf die Beispielimplementierung des Forms Portal-Metadatenservice. Sie können die Werte der Datenquelle, Metadaten/zusätzlichen Metadatentabellennamen ändern.
    Angeben eines anderen Namens für die Datentabelle:
    • Auf der Seite zur Web-Konsolenkonfiguration klicken Sie auf die Beispielimplementierung des Forms Portal-Datenservice. Sie können die Werte der Datenquelle und Datentabellennamen ändern.
    Wenn Sie die Tabellennamen ändern, geben Sie sie in der Form Portal-Konfiguration an.
  9. Belassen Sie die anderen Konfigurationen und klicken Sie auf Speichern .
  10. Die Datenbankverbindung kann über die Datenquelle Apache Sling Connection Pooled erfolgen.
  11. Klicken Sie für die Apache Sling-Verbindung auf Apache Sling-Verbindung Datenquellpool im Bearbeitungsmodus in der Web Console-Konfiguration. Geben Sie die Werte für die Eigenschaften an, wie in der folgenden Tabelle beschrieben:
Eigenschaft Wert
Datenquellenname
Ein Datenquellenname für das Filtern der Treiber aus dem Datenquellenpool
Hinweis : In der Beispielimplementierung wird FormsPortal als Datenquellenname verwendet .
JDBC-Treiberklasse com.mysql.jdbc.Driver
JDBC-Verbindungs-URI jdbc:mysql://[ Host ]:[ Anschluss ]/[ Schemaname ]
Benutzername Ein Benutzername zur Authentifizierung und zum Durchführen von Aktionen auf Datenbanktabellen
Kennwort Kennwort für den Benutzernamen
Transaktions-Isolierung READ_COMMITTED
Max. aktive Verbindungen 1000
Max. inaktive Verbindungen 100
Min. inaktive Verbindungen 10
Anfangsgröße 10
Max. Wartezeit 100000
Test zu Leihung Aktiviert
Test bei inaktiv Aktiviert
Validierungsanfrage Beispielwerte sind SELECT 1 (mysql), select 1 von Dual (oracle), SELECT 1 (MS Sql Server) (validationQuery)
Timeout für Validierungsanfrage 10000
  • Der JDBC-Treiber für MySQL wird nicht mit dem Beispiel geliefert. Stellen Sie sicher, dass Sie ihn bereitgestellt haben, und geben Sie die erforderlichen Informationen ein, um den JDBC-Verbindungspool zu konfigurieren.
  • Zeigen Sie mit Ihren Autor- und Veröffentlichungsinstanzen, um dieselbe Datenbank zu verwenden. Der Wert des URI-Feldes für die JDBC-Verbindung muss für alle Autoren- und Veröffentlichungsinstanzen gleich sein.
  1. Belassen Sie die anderen Konfigurationen und klicken Sie auf Speichern .
  2. Wenn Sie bereits eine Tabelle im Datenbankschema haben, fahren Sie mit dem nächsten Schritt fort.
    Wenn Sie noch keine Tabelle im Datenbankschema haben, führen Sie die folgenden SQL-Anweisungen aus, um separate Tabellen für Daten, Metadaten und weitere Metadaten im Datenbankschema zu erstellen:
    Sie benötigen nicht verschiedene Datenbanken für Autoren- und Veröffentlichungsinstanzen. Verwenden Sie dieselbe Datenbank für alle Autor- und Veröffentlichungsinstanzen.
    SQL-Anweisung für Datentabelle
    CREATE TABLE `data` (
    `owner` varchar(255) DEFAULT NULL,
    `data` longblob,
    `metadataId` varchar(45) DEFAULT NULL,
    `id` varchar(45) NOT NULL,
    PRIMARY KEY (`id`)
    ) ENGINE=InnoDB DEFAULT CHARSET=utf8;
    
    
    SQL-Anweisung für Metadatentabelle
    CREATE TABLE `metadata` (
    `formPath` varchar(1000) DEFAULT NULL,
    `formType` varchar(100) DEFAULT NULL,
    `description` text,
    `formName` varchar(255) DEFAULT NULL,
    `owner` varchar(255) DEFAULT NULL,
    `enableAnonymousSave` varchar(45) DEFAULT NULL,
    `renderPath` varchar(1000) DEFAULT NULL,
    `nodeType` varchar(45) DEFAULT NULL,
    `charset` varchar(45) DEFAULT NULL,
    `userdataID` varchar(45) DEFAULT NULL,
    `status` varchar(45) DEFAULT NULL,
    `formmodel` varchar(45) DEFAULT NULL,
    `markedForDeletion` varchar(45) DEFAULT NULL,
    `showDorClass` varchar(255) DEFAULT NULL,
    `sling:resourceType` varchar(1000) DEFAULT NULL,
    `attachmentList` longtext,
    `draftID` varchar(45) DEFAULT NULL,
    `submitID` varchar(45) DEFAULT NULL,
    `id` varchar(60) NOT NULL,
    `profile` varchar(255) DEFAULT NULL,
    `submitUrl` varchar(1000) DEFAULT NULL,
    `xdpRef` varchar(1000) DEFAULT NULL,
    `agreementId` varchar(255) DEFAULT NULL,
    `nextSigners` varchar(255) DEFAULT NULL,
    `eSignStatus` varchar(45) DEFAULT NULL,
    `pendingSignID` varchar(45) DEFAULT NULL,
    `agreementDataId` varchar(255) DEFAULT NULL,
    `enablePortalSubmit` varchar(45) DEFAULT NULL,
    `submitType` varchar(45) DEFAULT NULL,
    `dataType` varchar(45) DEFAULT NULL,
    `jcr:lastModified` varchar(45) DEFAULT NULL,
    PRIMARY KEY (`id`),
    UNIQUE KEY `ID_UNIQUE` (`id`)
    ) ENGINE=InnoDB DEFAULT CHARSET=utf8;
    
    
    SQL-Anweisung für additionalmetadatatable
    CREATE TABLE `additionalmetadatatable` (
    `value` text,
    `key` varchar(255) NOT NULL,
    `id` varchar(60) NOT NULL,
    PRIMARY KEY (`id`,`key`),
    CONSTRAINT ‘additionalmetadatatable_fk’ FOREIGN KEY (`id`) REFERENCES `metadata` (`id`) ON DELETE CASCADE
    ) ENGINE=InnoDB DEFAULT CHARSET=utf8;
    
    
    SQL-Anweisung für Kommentartabelle
    CREATE TABLE `commenttable` (
    `commentId` varchar(255) DEFAULT NULL,
    `comment` text DEFAULT NULL,
    `ID` varchar(255) DEFAULT NULL,
    `commentowner` varchar(255) DEFAULT NULL,
    `time` varchar(255) DEFAULT NULL);
    
    
  3. Wenn Sie bereits die Tabellen (Daten, Metadaten und additionalmetadatatable) im Datenbankschema haben, führen Sie folgende Tabellenfragen durch:
    SQL-Anweisung für die Änderung der Datentabelle
    ALTER TABLE `data` CHANGE `owner` `owner` VARCHAR(255) CHARACTER SET utf8 COLLATE utf8_general_ci NULL DEFAULT NULL;
    
    
    SQL-Anweisung für die Änderung der Metadatentabelle
    ALTER TABLE metadata add markedForDeletion varchar(45) DEFAULT NULL
    
    
    Die Metadatenanfrage „Tabelle ändern“ schlägt fehl, wenn Sie diese bereits ausführen und die Spalte „markedfordeletion“ ist in der Tabelle vorhanden.
    ALTER TABLE metadata add agreementId varchar(255) DEFAULT NULL,
    add nextSigners varchar(255) DEFAULT NULL,
    add eSignStatus varchar(45) DEFAULT NULL,
    add pendingSignID varchar(45) DEFAULT NULL,
    add agreementDataId varchar(255) DEFAULT NULL,
    add enablePortalSubmit varchar(45) DEFAULT NULL,
    add submitType varchar(45) DEFAULT NULL,
    add dataType varchar(45) DEFAULT NULL;
    
    
    ALTER TABLE `metadata` CHANGE `formPath` `formPath` VARCHAR(1000) CHARACTER SET utf8 COLLATE utf8_general_ci NULL DEFAULT NULL,
    CHANGE `formType` `formType` VARCHAR(100) CHARACTER SET utf8 COLLATE utf8_general_ci NULL DEFAULT NULL,
    CHANGE `description` `description` TEXT CHARACTER SET utf8 COLLATE utf8_general_ci NULL DEFAULT NULL,
    CHANGE `formName` `formName` VARCHAR(255) CHARACTER SET utf8 COLLATE utf8_general_ci NULL DEFAULT NULL,
    CHANGE `owner` `owner` VARCHAR(255) CHARACTER SET utf8 COLLATE utf8_general_ci NULL DEFAULT NULL,
    CHANGE `renderPath` `renderPath` VARCHAR(1000) CHARACTER SET utf8 COLLATE utf8_general_ci NULL DEFAULT NULL,
    CHANGE `showDorClass` `showDorClass` VARCHAR(255) CHARACTER SET utf8 COLLATE utf8_general_ci NULL DEFAULT NULL,
    CHANGE `sling:resourceType` `sling:resourceType` VARCHAR(1000) CHARACTER SET utf8 COLLATE utf8_general_ci NULL DEFAULT NULL,
    CHANGE `profile` `profile` VARCHAR(255) CHARACTER SET utf8 COLLATE utf8_general_ci NULL DEFAULT NULL,
    CHANGE `submitUrl` `submitUrl` VARCHAR(1000) CHARACTER SET utf8 COLLATE utf8_general_ci NULL DEFAULT NULL,
    CHANGE `xdpRef` `xdpRef` VARCHAR(1000) CHARACTER SET utf8 COLLATE utf8_general_ci NULL DEFAULT NULL;
    
    
    SQL-Anweisung für die Änderung der Tabelle „additionalmetadatatable“
    ALTER TABLE `additionalmetadatatable` CHANGE `value` `value` TEXT CHARACTER SET utf8 COLLATE utf8_general_ci NULL DEFAULT NULL, CHANGE `key` `key` VARCHAR(255) CHARACTER SET utf8 COLLATE utf8_general_ci NOT NULL;
    
    
Die Beispielimplementierung ist jetzt konfiguriert. Sie können sie verwenden, um Ihre Entwürfe und Übermittlungen aufzulisten, während Sie alle Daten und Metadaten in einer Datenbank speichern. Als Nächstes geht es darum, wie im Beispiel die Daten- und Metadatendienste konfiguriert werden.

Installieren der Datei mysql-connector-java-5.1.39-bin.jar

Führen Sie die folgenden Schritte auf allen Autoren- und Veröffentlichungsinstanzen aus, um die Datei mysql-connector-java-5.1.39-bin.jar zu installieren:
  1. Navigieren Sie zu https://'[server]:[port]'/system/console/depfinder und suchen Sie nach dem com.mysql.jdbc-Paket.
  2. Überprüfen Sie in der Spalte „Exportiert von“, ob das Paket von einem Paket exportiert wird.
    Fahren Sie fort, wenn das Paket nicht von einem Paket exportiert wird.
  3. Navigieren Sie zu https://'[server]:[port]'/system/console/bundles und klicken Sie auf  Installieren/Aktualisieren .
  4. Klicken Sie auf Datei auswählen und wählen Sie die Datei mysql-connector-java-5.1.39-bin.jar. Aktivieren Sie außerdem die Kontrollkästchen Paket starten  und Paket aktualisieren .
  5. Klicken Sie auf Installieren oder Aktualisieren . Wenn dies abgeschlossen ist, starten Sie den Server neu.
  6. ( Windows only ) Turn off the system firewall for your operating system.

Beispielcode für Formularportaldaten und Metadatendienst

Die folgende Zip enthält FormsPortalSampleDataServiceImpl und FormsPortalSampleMetadataServiceImpl ( (Implementierungsklassen) für Benutzeroberflächen für Daten- und Metadatendienste. Zusätzlich enthält es alle Klassen, die für die Kompilierung der oben genannten Implementierungsklassen benötigt werden.

Überprüfen Sie die Länge des Dateinamens

Die Datenbankimplementierung von Forms Portal verwendet eine zusätzliche Metadatentabelle. Die Tabelle hat einen zusammengesetzten Primärschlüssel, der auf Schlüssel- und ID-Spalten der Tabelle basiert. MySQL ermöglicht Primärschlüssel bis zur Länge von 255 Zeichen. Sie können das folgende clientseitige Validierungsskript verwenden, um die Länge des Dateinamens zu überprüfen, der an das Datei-Widget angehängt ist. Die Überprüfung wird ausgeführt, wenn eine Datei angehängt ist. Das Skript, das im folgenden Verfahren bereitgestellt wird, zeigt eine Meldung an, wenn der Dateiname größer als 150 (einschließlich Erweiterung) ist. Sie können das Skript modifizieren, um es auf eine andere Anzahl von Zeichen zu überprüfen.
Führen Sie die folgenden Schritte aus, um eine Client-Bibliothek zu erstellen und das Skript zu verwenden:
  1. Melden Sie sich bei CRXDE an und navigieren Sie zu /etc/clientlibs/
  2. Erstellen Sie einen Knoten vom Typ cq:ClientLibraryFolder und geben Sie den Namen des Knotens an. Beispiel: validation .
    Klicken Sie auf Alle speichern .
  3. Klicken Sie mit der rechten Maustaste auf den Knoten Neue Datei erstellen und legen Sie eine Datei mit der Erweiterung .txt an. Beispiel: js.txt Fügen Sie den folgenden Code zur neu erstellten .txt-Datei hinzu und klicken Sie auf Alle speichern .
    #base=util
     util.js
    
    
    Im vorstehenden Code ist util der Name des Ordners und util.js der Name der Datei im util -Ordner. The util folder and util.js file are created in suceeeding steps.
  4. Klicken Sie mit der rechten Maustaste auf den Knoten cq:ClientLibraryFolder , der in Schritt 2 erstellt wurde, wählen Sie „Erstellen“ > „Ordner erstellen“. Create a folder named util . Klicken Sie auf Alle speichern . Klicken Sie mit der rechten Maustaste auf den Ordner util und wählen Sie „Erstelle“ > „Ordner erstellen“. Create a file named util.js . Klicken Sie auf Alle speichern .
  5. Fügen Sie der Datei „POST.jsp“ folgenden Code hinzu und klicken Sie auf Alle speichern . Der Code validiert die Länge des Dateinamens.
    /*
     * ADOBE CONFIDENTIAL
     * ___________________
     *
     * Copyright 2016 Adobe Systems Incorporated
     * All Rights Reserved.
     *
     * NOTICE:  All information contained herein is, and remains
     * the property of Adobe Systems Incorporated and its suppliers,
     * if any.  The intellectual and technical concepts contained
     * herein are proprietary to Adobe Systems Incorporated and its
     * suppliers and may be covered by U.S. and Foreign Patents,
     * patents in process, and are protected by trade secret or copyright law.
     * Dissemination of this information or reproduction of this material
     * is strictly forbidden unless prior written permission is obtained
     * from Adobe Systems Incorporated.
     *
     */
    (function () {
        var connectWithGuideBridge = function (gb) {
            gb.connect(function () {
                //For first time load
                window.guideBridge.on("elementValueChanged" , function(event, payload) {
            var component = payload.target; // Field whose value has changed
                    if(component.name == 'fileAttachment' && component.parent) {
                        var fileItems = $('#'+payload.target.parent.id).find(".guide-fu-fileItem");
                        for (i = 0;i<fileItems.length;i++) {
                            var filename = $(fileItems[i]).find(".guide-fu-fileName").text();
                            //check whether it is previously attached file or a newly  attached one
                            if(filename.length > 150 && filename.indexOf("fp.attach.jsp") < 0) {
                                window.alert("filename is larger than 150 : "+filename);
                                 $(fileItems[i]).find(".guide-fu-fileClose.close").click();
                            }
                        }
                    }
    
       });
            });
        };
    
        if (window.guideBridge) {
            connectWithGuideBridge(window.guideBridge);
        } else {
            window.addEventListener("bridgeInitializeStart", function (event) {
                connectWithGuideBridge(event.detail.guideBridge);
            });
        }
    })();
    
    
    Das Skript ist für eine sofort einsetzbare (OOTB) Anlagen-Widgetkomponente. Wenn Sie das OOTB-Anlage-Widget angepasst haben, ändern Sie das obige Skript, um entsprechende Änderungen zu implementieren.
  6. Fügen Sie dem in Schritt 2 erstellten Ordner die folgende Eigenschaft hinzu und klicken Sie auf Alle speichern .
    • Name: Kategorien
    • Typ: String
    • Wert: fp.validation
    • Multi-Option: Aktiviert
  7. Navigate to /libs/fd/af/runtime/clientlibs/guideRuntime and append the fp.validation value to the embed property.
  8. Navigate to /libs/fd/af/runtime/clientlibs/guideRuntimeWithXFA and append the fp.validation value to embed property.
    Wenn Sie benutzerdefinierte Clientbibliotheken anstelle der Clientbibliotheken guideRuntime und guideWithXfa verwenden, verwenden Sie den Namen der Kategorie, um die in diesem Verfahren erstellte Client-Bibliothek in Ihre zur Laufzeit geladenen benutzerdefinierten Bibliotheken einzubetten.
  9. Klicken Sie auf Alle speichern. Wenn der Dateiname nun größer als 150 Zeichen (einschließlich Erweiterung) ist, wird eine Meldung angezeigt.