Esempio per integrare il componente Bozze e invii con il database

Ultimo aggiornamento: 2023-12-07

Panoramica di esempio

Il componente Bozze e invii del portale AEM Forms consente agli utenti di salvare i moduli come bozze e inviarli successivamente da qualsiasi dispositivo. Gli utenti possono inoltre visualizzare i moduli inviati nel portale. Per abilitare questa funzionalità, AEM Forms fornisce servizi di dati e metadati per memorizzare i dati compilati da un utente nel modulo e i metadati del modulo associati alle bozze e ai moduli inviati. Per impostazione predefinita, questi dati vengono memorizzati nell’archivio CRX. Tuttavia, poiché gli utenti interagiscono con i moduli tramite l’istanza di pubblicazione dell’AEM, che in genere si trova al di fuori del firewall aziendale, le organizzazioni potrebbero voler personalizzare l’archiviazione dei dati per renderla più sicura e affidabile.

L’esempio, discusso in questo documento, è un’implementazione di riferimento di servizi di dati e metadati personalizzati per integrare bozze e componenti di invio con un database. Il database utilizzato nell’implementazione di esempio è MySQL 5.6.24. Tuttavia, è possibile integrare il componente Bozze e invii con qualsiasi database desiderato.

NOTA
  • Gli esempi e le configurazioni illustrate in questo documento sono conformi a MySQL 5.6.24 e devono essere sostituiti in modo appropriato per il sistema di database.
  • Verifica di aver installato la versione più recente del pacchetto del componente aggiuntivo AEM Forms. Per un elenco dei pacchetti disponibili, vedere Versioni di AEM Forms articolo.
  • Il pacchetto di esempio funziona solo con azioni di invio Adaptive Forms.

Impostare e configurare l’esempio

Per installare e configurare l’esempio in tutte le istanze di authoring e pubblicazione, effettua le seguenti operazioni:

  1. Scarica quanto segue aem-fp-db-integration-sample-pkg-6.1.2.zip nel file system.

    Pacchetto di esempio per l’integrazione del database

Ottieni file

  1. Vai a Gestione pacchetti AEM all’indirizzo https://[host]:[porta]/crx/packmgr/.

  2. Clic Carica pacchetto.

  3. Sfoglia per selezionare aem-fp-db-integration-sample-pkg-6.1.2.zip pacchetto e fai clic su OK.

  4. Clic Installa accanto al pacchetto per installarlo.

  5. Vai a Configurazione console web AEM
    pagina in https://[host]:[porta]/system/console/configMgr.

  6. Fai clic per aprire Configurazione bozza e invio portale Forms in modalità di modifica.

  7. Specificare i valori per le proprietà come descritto nella tabella seguente:

    Proprietà Descrizione Valore
    Servizio dati bozza portale Forms Identificatore per bozza di servizio dati formsportal.sampledataservice
    Servizio metadati bozza portale Forms Identificatore per bozza servizio metadati formsportal.samplemetadataservice
    Servizio di invio dati per Forms Portal Identificatore per il servizio dati di invio formsportal.sampledataservice
    Servizio metadati invio portale Forms Identificatore per il servizio di invio metadati formsportal.samplemetadataservice
    Servizio dati di firma in sospeso di Forms Portal Identificatore per il servizio dati di firma in sospeso formsportal.sampledataservice
    Servizio metadati firma in sospeso di Forms Portal Identificatore per il servizio metadati di firma in sospeso formsportal.samplemetadataservice
    NOTA

    I servizi vengono risolti dai nomi indicati come valore per aem.formsportal.impl.prop come segue:

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

    È possibile modificare i nomi delle tabelle di dati e metadati.

    Per specificare un nome diverso per la tabella dei metadati:

    • Nella configurazione della console Web, trovare e fare clic su Implementazione di esempio del servizio metadati di Forms Portal. È possibile modificare i valori dell'origine dati, dei metadati o del nome di tabelle di metadati aggiuntive.

    Per specificare un nome diverso per la tabella dati:

    • Nella configurazione della console Web, trovare e fare clic su Implementazione di esempio del servizio dati di Forms Portal. È possibile modificare i valori dell'origine dati e del nome della tabella dati.
    NOTA

    Se si modificano i nomi delle tabelle, specificarli nella configurazione del portale moduli.

  8. Lascia invariate le altre configurazioni e fai clic su Salva.

  9. La connessione al database può essere eseguita tramite Apache Sling Connection Pooled Data Source.

  10. Per la connessione Apache Sling, individua e fai clic per aprire Origine dati in pool di connessione Apache Sling in modalità di modifica nella configurazione della console web. Specificare i valori per le proprietà come descritto nella tabella seguente:

Proprietà Valore
Nome origine dati

Nome di origine dati per filtrare i driver dal pool di origini dati

Nota: L’implementazione di esempio utilizza FormsPortal come nome dell’origine dati.

Classe driver JDBC com.mysql.jdbc.Driver
URI connessione JDBC
jdbc:mysql://[host]:[porta]/[nome_schema]
Nome utente Un nome utente per autenticare ed eseguire azioni sulle tabelle del database
Password Password associata al nome utente
Isolamento transazione READ_COMMIT
Numero massimo connessioni attive 1000
Numero massimo di connessioni inattive 100
Connessioni inattive minime 10
Dimensione iniziale 10
Attesa massima 100000
Test su prestito Selezionato
Test durante inattività Selezionato
Query di convalida I valori di esempio sono SELECT 1(mysql), select 1 from dual(oracle), SELECT 1(MS Sql Server) (validationQuery)
Timeout query di convalida 10000
NOTA
  • Il driver JDBC per MySQL non viene fornito con l'esempio. Verificare di aver eseguito il provisioning e fornire le informazioni necessarie per configurare il connection pool JDBC.
  • Indirizza le istanze di authoring e pubblicazione per utilizzare lo stesso database. Il valore del campo URI connessione JDBC deve essere lo stesso per tutte le istanze di authoring e pubblicazione.
  1. Lascia invariate le altre configurazioni e fai clic su Salva.

  2. Se nello schema del database è già presente una tabella, andare al passaggio successivo.

    In caso contrario, se nello schema del database non è già presente una tabella, eseguire le istruzioni SQL seguenti per creare tabelle separate per dati, metadati e metadati aggiuntivi nello schema del database:

    NOTA

    Non sono necessari database diversi per le istanze di authoring e pubblicazione. Utilizza lo stesso database su tutte le istanze di authoring e pubblicazione.

    Istruzione SQL per la tabella dati

    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;
    

    Istruzione SQL per la tabella metadati

    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;
    

    Istruzione SQL per ulteriori metadati

    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;
    

    Istruzione SQL per tabella commenti

    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. Se nello schema del database sono già presenti le tabelle (dati, metadati e metadati aggiuntivi), eseguire le query di modifica seguenti:

    Istruzione SQL per la modifica della tabella dati

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

    Istruzione SQL per la modifica della tabella dei metadati

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

    La query di aggiunta dei metadati ALTER TABLE ha esito negativo se è già stata eseguita e la colonna markedforDeletion è presente nella tabella.

    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;
    

    Istruzione SQL per la modifica della tabella aggiuntiva metadatatable

    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;
    

L’implementazione di esempio è ora configurata e può essere utilizzata per elencare le bozze e gli invii durante la memorizzazione di tutti i dati e i metadati in un database. Vediamo ora come sono configurati i servizi dati e metadati nell’esempio.

Installare il file mysql-connector-java-5.1.39-bin.jar

Per installare il file mysql-connector-java-5.1.39-bin.jar, effettua le seguenti operazioni su tutte le istanze di authoring e pubblicazione:

  1. Accedi a https://'[server]:[port]'/system/console/depfinder e cercare il pacchetto com.mysql.jdbc.

  2. Nella colonna Esportato da, controlla se il pacchetto viene esportato da un bundle.

    Procedi se il pacchetto non viene esportato da alcun bundle.

  3. Accedi a https://'[server]:[port]'/system/console/bundles e fai clic su Installa/Aggiorna.

  4. Clic Scegli file e seleziona il file mysql-connector-java-5.1.39-bin.jar. Inoltre, seleziona Bundle iniziale e Aggiorna pacchetti caselle di controllo.

  5. Clic Installare o aggiornare. Al termine, riavviare il server.

  6. (Solo Windows a) Disattivare il firewall del sistema operativo.

Codice di esempio per il servizio metadati e i dati del portale Forms

Il seguente file zip contiene FormsPortalSampleDataServiceImpl e FormsPortalSampleMetadataServiceImpl (classi di implementazione) per le interfacce del servizio dati e metadati. Inoltre, contiene tutte le classi richieste per la compilazione delle classi di implementazione sopra menzionate.

Ottieni file

Verifica la lunghezza del nome del file

L’implementazione del database di Forms Portal utilizza una tabella di metadati aggiuntiva. La tabella dispone di una chiave primaria composita basata sulle colonne Chiave e ID della tabella. MySQL consente chiavi primarie fino a una lunghezza di 255 caratteri. Puoi utilizzare il seguente script di convalida lato client per verificare la lunghezza del nome file associato al widget file. La convalida viene eseguita quando un file viene allegato. Lo script fornito nella procedura seguente visualizza un messaggio quando il nome del file è maggiore di 150 (inclusa l’estensione). È possibile modificare lo script per verificare la presenza di un numero diverso di caratteri.

Per creare, effettua le seguenti operazioni una libreria client e utilizza lo script:

  1. Accedi a CRXDE e passa a /etc/clientlibs/

  2. Creare un nodo di tipo cq:ClientLibraryFolder e fornisci il nome del nodo. Esempio: validation.

    Clic Salva tutto.

  3. Fare clic con il pulsante destro del mouse sul nodo e scegliere crea nuovo file e creare un file con estensione .txt. Ad esempio: js.txtAggiungi il codice seguente al file .txt appena creato e fai clic su Salva tutto.

    #base=util
     util.js
    

    Nel codice di cui sopra, util è il nome della cartella e util.js nome del file nel util cartella. Il util cartella e util.js vengono creati nei passaggi successivi.

  4. Fare clic con il pulsante destro del mouse cq:ClientLibraryFolder nodo creato al passaggio 2, seleziona Crea > Crea cartella. Crea una cartella denominata util. Clic Salva tutto. Fare clic con il pulsante destro del mouse util , selezionare Crea > Crea file. Crea un file denominato util.js. Clic Salva tutto.

  5. Aggiungi il codice seguente al file util.js e fai clic su Salva tutto. Lunghezza di convalida del codice del nome file.

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

    Lo script è per il componente widget di allegati preconfigurato (OOTB). Se avete personalizzato il widget dell'allegato OOTB, modificate lo script precedente in modo da incorporare le rispettive modifiche.

  6. Aggiungi la seguente proprietà alla cartella creata nel passaggio 2 e fai clic su Salva tutto.

    • Nome: categorie

    • Tipo: Stringa

    • Valore: fp.validation

    • opzione multipla: Abilitato

  7. Accedi a /libs/fd/af/runtime/clientlibs/guideRuntimee aggiungi fp.validation alla proprietà embed.

  8. Passa a /libs/fd/af/runtime/clientlibs/guideRuntimeWithXFA e aggiungi fp.validation valore da incorporare.

    NOTA

    Se utilizzi librerie client personalizzate invece delle librerie client guideRuntime e guideRuntimeWithXfa, utilizza il nome della categoria per incorporare la libreria client creata in questa procedura nelle librerie personalizzate caricate in fase di esecuzione.

  9. Clic Salva tutto. Ora, quando il nome del file supera i 150 caratteri (inclusa l’estensione) viene visualizzato un messaggio.

In questa pagina