Voorbeeld voor het integreren van concepten en verzendingscomponenten met database

Voorbeeldoverzicht

Met concepten en verzendingscomponenten van AEM Forms-portaalsites kunnen gebruikers hun formulieren opslaan als concepten en later verzenden vanaf elk apparaat. Gebruikers kunnen hun ingevulde formulieren ook via een portal bekijken. Om deze functionaliteit in te schakelen, biedt AEM Forms gegevens- en metagegevensservices waarmee de gegevens die een gebruiker heeft ingevuld, worden opgeslagen in het formulier en de metagegevens van het formulier die zijn gekoppeld aan concepten en verzonden formulieren. Deze gegevens worden standaard opgeslagen in de CRX-opslagplaats. Als gebruikers echter via AEM publicatieexemplaar met formulieren werken, wat doorgaans buiten de bedrijfsfirewall valt, willen organisaties wellicht gegevensopslag aanpassen om deze beter te beveiligen en betrouwbaarder te maken.

Het voorbeeld, dat in dit document wordt besproken, is een referentie-implementatie van aangepaste gegevens en metagegevensservices om concepten en verzendingscomponenten te integreren in een database. De database die wordt gebruikt in de voorbeeldimplementatie is MySQL 5.6.24. U kunt echter de concepten en verzendingscomponent integreren met elke database van uw keuze.

OPMERKING
  • De voorbeelden en configuraties die in dit document worden uitgelegd, zijn in overeenstemming met MySQL 5.6.24 en u moet deze op de juiste wijze vervangen voor uw databasesysteem.
  • Controleer of u de nieuwste versie van het AEM Forms-invoegpakket hebt geïnstalleerd. Raadpleeg het AEM Forms-artikel voor een lijst met beschikbare pakketten.
  • Het voorbeeldpakket werkt alleen met verzendacties voor Adaptive Forms.

Het voorbeeld instellen en configureren

Voer de volgende stappen uit, op alle auteur en publiceer instanties, om de steekproef te installeren en te vormen:

  1. Download het volgende aem-fp-db-integration-sample-pkg-6.1.2.zip-pakket naar uw bestandssysteem.

    Voorbeeldpakket voor databaseintegratie

    Bestand ophalen

  2. Ga naar AEM pakketbeheer op https://[host]:[port]/crx/packmgr/.

  3. Klik op Upload Package.

  4. Blader naar het aem-fp-db-integration-sample-pkg-6.1.2.zip-pakket en klik op OK.

  5. Klik Install naast het pakket om het pakket te installeren.

  6. Ga naar AEM Web Console Configuration
    pagina op https://[host]:[port]/system/console/configMgr.

  7. Klik om Forms Portal Draft and Submission Configuration te openen in bewerkingsmodus.

  8. Geef de waarden voor de eigenschappen op zoals in de volgende tabel wordt beschreven:

    Eigenschap Beschrijving Waarde
    Forms Portal Conceptgegevensservice Id voor conceptgegevensservice formsportal.sampledataservice
    Forms Portal Draft Metadata Service Identificatiecode voor service met metagegevens van concept formsportal.samplemetadataservice
    Forms Portal verzendt Data Service Id voor verzendgegevensservice formsportal.sampledataservice
    Forms Portal verzendt metagegevensservice Id voor verzendmetagegevensservice formsportal.samplemetadataservice
    Forms Portal in afwachting van Sign Data Service Identifier voor de dataservice in afwachting van ondertekening formsportal.sampledataservice
    Forms Portal in afwachting van Sign Metadata Service Identificatiecode voor de metagegevensservice in afwachting van ondertekening formsportal.samplemetadataservice
    OPMERKING

    De services worden als volgt opgelost door hun namen die als waarde voor de aem.formsportal.impl.prop-sleutel worden vermeld:

    @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")
    

    U kunt namen van de gegevens en meta-gegevenslijsten veranderen.

    Een andere naam opgeven voor de metagegevenstabel:

    • Zoek in de webconsoleconfiguratie naar en klik op Voorbeeldimplementatie van Forms Portal Metadata Service. U kunt de waarden van gegevensbron, meta-gegevens/extra naam van de meta-gegevenslijst veranderen.

    Een andere naam voor de gegevenstabel opgeven:

    • Zoek en klik in de webconsoleconfiguratie op Voorbeeldimplementatie van Forms Portal Data Service. U kunt de waarden van gegevensbron en naam van de gegevenslijst veranderen.
    OPMERKING

    Als u de tabelnamen wijzigt, geeft u deze op in de configuratie Formulierportal.

  9. Andere configuraties ongewijzigd laten en op Save klikken.

  10. De databaseverbinding kan worden uitgevoerd via de gegevensbron van Apache Sling Connection Pooled.

  11. Voor Apache Sling-verbinding zoekt en klikt u om Apache Sling Connection Pooled DataSource te openen in de bewerkingsmodus in de webconsoleconfiguratie. Geef de waarden voor de eigenschappen op zoals in de volgende tabel wordt beschreven:

Eigenschap Waarde
Naam gegevensbron

Een gegevensbronnaam voor het filtreren bestuurders van de gegevensbronpool

Opmerking: De steekproefimplementatie gebruikt FormsPortal als naam van de gegevensbron.

JDBC-stuurprogrammaklasse com.mysql.jdbc.Driver
JDBC-verbinding URI
jdbc:mysql://[host]:[poort]/[schema_name]
Gebruikersnaam Een gebruikersnaam om handelingen voor databasetabellen te verifiëren en uit te voeren
Wachtwoord Aan de gebruikersnaam gekoppeld wachtwoord
Transactieisolatie READ_COMTED
Max. actieve verbindingen 1000
Max. aantal inactieve verbindingen 100
Min. onbelaste verbindingen 10
Oorspronkelijke grootte 10
Max. wachttijd 100000
Testen op lenen Ingeschakeld
Testen tijdens inactiviteit Ingeschakeld
Validatiezoekopdracht Voorbeelden zijn SELECT 1(mysql), select 1 vanuit dual (oracle), SELECT 1 (MS Sql Server) (validationQuery)
Time-out voor validatiezoekopdracht 10000
OPMERKING
  • Het JDBC-stuurprogramma voor MySQL wordt niet bij het voorbeeld geleverd. Zorg ervoor dat u daarvoor de provisioned hebt en verstrek de vereiste informatie om de JDBC verbindingspool te vormen.
  • Wijs de auteur aan en publiceer instanties om het zelfde gegevensbestand te gebruiken. De waarde van het veld URI van de JDBC-verbinding moet gelijk zijn voor alle auteur- en publicatie-instanties.
  1. Andere configuraties ongewijzigd laten en op Save klikken.

  2. Als u al een lijst in het gegevensbestandschema hebt, sla aan de volgende stap over.

    Anders, als u nog geen lijst in het gegevensbestandschema hebt, voer de volgende SQL verklaringen uit om afzonderlijke lijsten voor gegevens, meta-gegevens, en extra meta-gegevens in het gegevensbestandschema tot stand te brengen:

    OPMERKING

    U hebt geen verschillende databases nodig voor auteur- en publicatieinstanties. Gebruik dezelfde database voor alle auteurs en publiceer instanties.

    SQL-instructie voor gegevenstabel

    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-instructie voor tabel met metagegevens

    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-instructie voor extra metatable

    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-instructie voor tabel met opmerkingen

    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. Als u reeds de lijsten (gegevens, meta-gegevens, en extra metatable) in het gegevensbestandschema hebt, voer de volgende veranderlijke lijstvragen uit:

    SQL-instructie voor het wijzigen van de gegevenstabel

    ALTER TABLE `data` CHANGE `owner` `owner` VARCHAR(255) CHARACTER SET utf8 COLLATE utf8_general_ci NULL DEFAULT NULL;
    

    SQL-instructie voor het wijzigen van de tabel met metagegevens

    ALTER TABLE metadata add markedForDeletion varchar(45) DEFAULT NULL
    
    OPMERKING

    De metagegevens van de ALTER-TABEL kunnen niet worden toegevoegd als u deze al hebt uitgevoerd en de kolom MarkedforDeletion in de tabel staat.

    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-instructie voor het wijzigen van de extra metadatable-tabel

    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;
    

De voorbeeldimplementatie is nu geconfigureerd, waarmee u concepten en verzendingen kunt weergeven terwijl u alle gegevens en metagegevens in een database opslaat. Laten we nu zien hoe de gegevens- en metagegevensservices zijn geconfigureerd in het voorbeeld.

Het bestand mysql-connector-java-5.1.39-bin.jar installeren

Voer de volgende stappen uit op alle auteur- en publicatieinstanties om het bestand mysql-connector-java-5.1.39-bin.jar te installeren:

  1. Navigeer naar https://[server]:[port]/system/console/depfinder en zoek naar het pakket com.mysql.jdbc.

  2. Controleer in de kolom Geëxporteerd door of het pakket wordt geëxporteerd door een willekeurige bundel.

    Ga door als het pakket niet door enige bundel wordt uitgevoerd.

  3. Navigeer naar https://[server]:[port]/system/console/bundles en klik Install/Update.

  4. Klik Choose File en blader om het mysql-connector-java-5.1.39-bin.jar dossier te selecteren. Selecteer ook Start Bundle en Refresh Packages selectievakjes.

  5. Klik op Install or Update. Start de server opnieuw als de bewerking is voltooid.

  6. (Alleen Windows) Schakel de systeemfirewall voor uw besturingssysteem uit.

Voorbeeldcode voor de gegevens- en metagegevensservice van een formulierportal

De volgende ZIP bevat FormsPortalSampleDataServiceImpl en FormsPortalSampleMetadataServiceImpl (implementatieklassen) voor gegevens en meta-gegevensdienstinterfaces. Bovendien bevat deze klasse alle klassen die vereist zijn voor de compilatie van de bovengenoemde implementatieklassen.

Bestand ophalen

Lengte van bestandsnaam controleren

De implementatie van de database van Forms Portal maakt gebruik van extra metagegevenstabel. De tabel heeft een samengestelde primaire sleutel die is gebaseerd op de kolommen Key en id van de tabel. MySQL staat primaire sleutels tot de lengte van 255 karakters toe. U kunt het volgende validatiescript aan de clientzijde gebruiken om de lengte te controleren van de bestandsnaam die aan de bestandswidget is gekoppeld. De validatie wordt uitgevoerd wanneer een bestand wordt gekoppeld. Het script dat in de volgende procedure wordt weergegeven, geeft een bericht weer wanneer de bestandsnaam groter is dan 150 (inclusief de extensie). U kunt het script wijzigen om te controleren op een ander aantal tekens.

Voer de volgende stappen uit om een cliëntbibliotheek te creëren en het manuscript te gebruiken:

  1. Meld u aan bij CRXDE en navigeer naar /etc/clientlibs/

  2. Maak een knooppunt van het type cq:ClientLibraryFolder en geef de naam van het knooppunt op. Bijvoorbeeld, validation.

    Klik op Save All.

  3. Klik met de rechtermuisknop op het knooppunt, klik op create new file en maak een bestand met de extensie .txt. Voeg bijvoorbeeld js.txtde volgende code toe aan het nieuwe .txt-bestand en klik op Save All.

    #base=util
     util.js
    

    In de bovenstaande code is util de naam van de map en util.js de naam van het bestand in de map util. De map util en het bestand util.js worden in volgende stappen gemaakt.

  4. Klik met de rechtermuisknop op het knooppunt cq:ClientLibraryFolder dat in stap 2 is gemaakt, en selecteer Maken > Map maken. Maak een map met de naam util. Klik op Save All. Klik met de rechtermuisknop op de map util en selecteer Maken > Bestand maken. Maak een bestand met de naam util.js. Klik op Save All.

  5. Voeg de volgende code toe aan het bestand util.js en klik op Save All. De code valideert de lengte van de bestandsnaam.

    /*
     * 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);
            });
        }
    })();
    
    OPMERKING

    Het script is bedoeld voor een component van de box-widget voor bijlagen (OOTB). Als u de OOTB gehechtheidswidget hebt aangepast dan verander het bovengenoemde manuscript om respectieve veranderingen op te nemen.

  6. Voeg de volgende eigenschap toe aan de map die in stap 2 is gemaakt en klik op Save All.

    • Name: categorieën

    • Type: Tekenreeks

    • Value: fp.validation

    • multi option: Ingeschakeld

  7. Navigeer naar /libs/fd/af/runtime/clientlibs/guideRuntimeen voeg de fp.validation waarde aan embed bezit toe.

  8. Navigeer naar /libs/fd/af/runtime/clientlibs/guideRuntimeWithXFA en voeg de waarde fp.validation toe aan embed bezit.

    OPMERKING

    Als u aangepaste clientbibliotheken gebruikt in plaats van guideRuntime en guideRuntimeWithXfa-clientbibliotheken, gebruikt u de categorienaam om de clientbibliotheek die in deze procedure is gemaakt, in te sluiten in uw aangepaste bibliotheken die tijdens runtime worden geladen.

  9. Klik Save All. Nu, wanneer filename groter is dan 150 (met inbegrip van uitbreiding) karakters wordt een bericht getoond.

Op deze pagina