Exemple d’intégration d’un composant brouillons & envois à la base de données sample-for-integrating-drafts-submissions-component-with-database

Vue d’ensemble de l’exemple sample-overview

Le composant brouillons et envois du portail AEM Forms permet aux utilisateurs et utilisatrices d’enregistrer leurs formulaires en tant que brouillons et de les envoyer ultérieurement à partir de n’importe quel appareil. En outre, les utilisateurs et utilisatrices peuvent afficher les formulaires envoyés sur le portail. Pour activer cette fonctionnalité, AEM Forms fournit des services de données et de métadonnées pour stocker les données renseignées par un utilisateur ou une utilisatrice dans le formulaire et les métadonnées de formulaire associées aux formulaires brouillons et envoyés. Ces données sont stockées dans le référentiel CRX, par défaut. Cependant, lorsque les utilisateurs et utilisatrices interagissent avec les formulaires via une instance de publication AEM qui se trouve généralement en dehors du pare-feu de l’entreprise, les entreprises peuvent personnaliser le stockage des données pour qu’il soit plus sécurisé et fiable.

L’exemple présenté dans ce document est une implémentation de référence des services de données et de métadonnées personnalisés pour intégrer un composant brouillons et envois à une base de données. La base de données utilisée dans l’exemple d’implémentation est : MySQL 5.6.24. Toutefois, vous pouvez intégrer le composant brouillons et envois à n’importe quelle base de données.

NOTE
  • Les exemples et configurations décrits dans ce document sont conformes à MySQL 5.6.24 et vous devez les remplacer de manière adaptée à votre système de base de données.
  • Vérifiez que vous avez installé la dernière version du package du module complémentaire AEM Forms. Pour obtenir la liste des packages disponibles, consulter l’article Versions d’AEM Forms.
  • L’exemple de package fonctionne uniquement avec les actions d’envoi de formulaires adaptatifs.

Installer et configurer l’exemple set-up-and-configure-the-sample

Effectuez les étapes suivantes, sur toutes les instances d’auteur et de publication, pour installer et configurer l’exemple :

  1. Téléchargez le package suivant aem-fp-db-integration-sample-pkg-6.1.2.zip vers votre système de fichiers.

    Exemple de package pour l’intégration à une base de données

Obtenir le fichier

  1. Accédez au gestionnaire de package AEM à l’adresse https://[host]:[port]/crx/packmgr/.

  2. Cliquez sur Upload Package (Télécharger le package).

  3. Parcourez l’arborescence pour sélectionner le package aem-fp-db-integration-sample-pkg-6.1.2.zip et cliquez sur OK.

  4. Cliquez sur Installer à côté du package pour l’installer.

  5. Accédez à la page de configuration de la console web AEM
    à l’adresse https://[host]:[port]/system/console/configMgr.

  6. Cliquez pour ouvrir Forms Portal Draft and Submission Configuration (Configuration des brouillons et des envois du portail Forms) en mode d’édition.

  7. Spécifiez les valeurs des propriétés comme décrit dans le tableau suivant :

    table 0-row-3 1-row-3 2-row-3 3-row-3 4-row-3 5-row-3 6-row-3
    Propriété Description Valeur
    Service de données de brouillon du portail Formulaires Identifiant du service de données de brouillon formsportal.sampledataservice
    Service de métadonnées de brouillon du portail Formulaires Identifiant du service de métadonnées de brouillon formsportal.samplemetadataservice
    Service de données d’envoi du portail Formulaires Identifiant du service de données d’envoi formsportal.sampledataservice
    Service de métadonnées d’envoi du portail Formulaires Identifiant du service de métadonnées d’envoi formsportal.samplemetadataservice
    Service de données de signature en attente du portail Formulaires Identificateur du service de données de signature en attente formsportal.sampledataservice
    Service de métadonnées de signature en attente du portail Formulaires Identificateur du service de métadonnées de signature en attente formsportal.samplemetadataservice
    note note
    NOTE
    Les services sont résolus par leurs noms indiqués comme valeur de la clé aem.formsportal.impl.prop comme suit :
    code language-java
    @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")
    

    Vous pouvez modifier les noms des tableaux de données et de métadonnées.

    Pour modifier le nom du tableau de métadonnées :

    • Dans la configuration de la console web, recherchez et cliquez sur Exemple de mise en œuvre du service de métadonnées sur le portail Forms. Vous pouvez modifier les valeurs de la source de données et le nom du tableau des métadonnées/métadonnées supplémentaires.

    Pour modifier le nom du tableau de données :

    • Dans la configuration de la console web, recherchez et cliquez sur Exemple de mise en œuvre du service de données du portail Forms. Vous pouvez modifier les valeurs de la source de données et le nom du tableau de données.
    note note
    NOTE
    Si vous modifiez les noms du tableau, renseignez-les dans la configuration du portail Formulaires.
  8. Laissez les autres configurations inchangées et cliquez sur Save (Enregistrer).

  9. La connexion à la base de données peut être effectuée via la source de données mise en pool de la connexion Apache Sling.

  10. Pour la connexion Apache Sling, recherchez Apache Sling Connection Pooled DataSource et cliquez dessus pour l’ouvrir en mode de modification dans la configuration de la console Web. Spécifiez les valeurs des propriétés comme décrit dans le tableau suivant :

Propriétés
Valeur
Nom de la source de données

Un nom de source de données pour filtrer les pilotes du pool de la source de données

Remarque : l’exemple de mise en œuvre utilise FormsPortal comme nom de la source de données.

Classe de pilote JDBC
com.mysql.jdbc.Driver
URI de connexion JDBC
jdbc//[host]:[port]/[schema_name]
Nom d’utilisateur
Nom d’utilisateur pour l’authentification et l’exécution d’actions sur les tables de base de données
Mot de passe
Mot de passe associé au nom d’utilisateur
Isolation des transactions
READ_COMMITTED
Nombre max. de connexions actives
1 000
Nombre max. de connexions inactives
100
Nombre min. de connexions inactives
10
Taille initiale
10
Attente max.
100 000
Test lors de l’emprunt
Cochée
Test en mode inactif
Cochée
Requête de validation
Exemples de valeurs : SELECT 1(mysql), select 1 from dual (oracle), SELECT 1 (MS Sql Server) (validationQuery).
Délai d’expiration des requêtes de validation
10 000
NOTE
  • Le pilote JDBC pour MySQL n’est pas fourni avec l’exemple. Assurez-vous que vous avez fourni les informations requises pour configurer le pool de connexions JDBC.
  • Pointez vos instances de création et de publication pour qu’elles utilisent la même base de données. La valeur du champ URI de connexion JDBC doit être identique pour toutes les instances de création et de publication.
  1. Laissez les autres configurations inchangées et cliquez sur Save (Enregistrer).

  2. Si vous disposez déjà d’un tableau dans le schéma de base de données, passez à l’étape suivante.

    En revanche, si vous ne disposez pas déjà d’un tableau dans le schéma de base de données, exécutez les instructions SQL suivantes pour créer des tableaux distincts pour les données, les métadonnées et les métadonnées supplémentaires dans le schéma de base de données :

    note note
    NOTE
    Vous n’avez pas besoin de bases de données différentes pour les instances de création et de publication. Utilisez la même base de données sur toutes les instances d’auteur et de publication.

    Instruction SQL pour le tableau de données

    code language-sql
    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;
    

    Instruction SQL pour le tableau de métadonnées

    code language-sql
    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;
    

    Instruction SQL pour le tableau de métadonnées supplémentaires

    code language-sql
    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;
    

    Instruction SQL pour le tableau de commentaires

    code language-sql
    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. Si vous disposez déjà des tableaux (données, métadonnées et métadonnées supplémentaires) dans le schéma de base de données, modifiez les requêtes de tableau comme suit :

    Instruction SQL pour modifier le tableau de données

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

    Instruction SQL pour modifier le tableau de métadonnées

    code language-sql
    ALTER TABLE metadata add markedForDeletion varchar(45) DEFAULT NULL
    
    note note
    NOTE
    La requête d’ajout des métadonnées ALTER TABLE échoue si vous l’avez déjà effectuée et la colonne markedforDeletion est présente dans le tableau.
    code language-sql
    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;
    
    code language-sql
    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;
    

    Instruction SQL pour modifier le tableau de métadonnées supplémentaires

    code language-sql
    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’exemple de mise en œuvre est maintenant configuré. Vous pouvez l’utiliser pour répertorier vos brouillons et envois tout en stockant l’ensemble des données et métadonnées dans une base de données. Voyons maintenant comment les services de données et de métadonnées sont configurés dans l’exemple.

Installer le fichier mysql-connector-java-5.1.39-bin.jar install-mysql-connector-java-bin-jar-file

Effectuez les étapes suivantes, sur toutes les instances d’auteur et de publication, pour installer le fichier mysql-connector-java-5.1.39-bin.jar :

  1. Accédez à https://'[server]:[port]'/system/console/depfinder et recherchez le package com.mysql.jdbc.

  2. Dans la colonne Exported by (Exporté par), vérifiez si le package est exporté par un groupe.

    Continuez si le package n’est pas exporté par un groupe.

  3. Accédez à https://'[server]:[port]'/system/console/bundles et cliquez sur Install/Update (Installer/Mettre à jour).

  4. Cliquez sur Choose File (Choisir un fichier) et accédez au chemin permettant de sélectionner le fichier mysql-connector-java-5.1.39-bin.jar. Cochez également les cases Start Bundle (Démarrer le groupe) et Refresh Packages (Actualiser les packages).

  5. Cliquez sur Install (Installer) ou Update (Mettre à jour). Une fois cette opération effectuée, redémarrez le serveur.

  6. (Windows uniquement) Désactivez le pare-feu système pour votre système d’exploitation.

NOTE
Il est recommandé d’utiliser la commande « Ctrl + C » pour redémarrer le SDK. Le redémarrage du SDK AEM à l’aide de méthodes alternatives, par exemple l’arrêt des processus Java, peut entraîner des incohérences dans l’environnement de développement AEM.

Exemple de code pour le service de données et de métadonnées de portail de formulaires sample-code-for-forms-portal-data-and-metadata-service

Le fichier zip suivant contient FormsPortalSampleDataServiceImpl et FormsPortalSampleMetadataServiceImpl (classes d’implémentation) pour les interfaces de service de données et de métadonnées. En outre, il contient toutes les classes requises pour la compilation des classes d’implémentation mentionnées ci-dessus.

Obtenir le fichier

Vérifier la longueur du nom de fichier verify-length-of-the-file-name

La mise en œuvre de la base de données du portail Forms utilise un tableau de métadonnées supplémentaire. Le tableau comporte une clé primaire composite basée sur les colonnes Clé et ID du tableau. MySQL autorise les clés primaires jusqu’à 255 caractères. Vous pouvez utiliser le script de validation côté client suivant pour vérifier la longueur du nom de fichier joint au widget de fichier. La validation est exécutée lorsqu’un fichier est joint. Le script fourni dans la procédure suivante affiche un message lorsque le nom de fichier est supérieur à 150 (extension comprise). Vous pouvez modifier le script pour vérifier un nombre différent de caractères.

Effectuez les étapes suivantes pour créer une bibliothèque cliente et utiliser le script :

  1. Connectez-vous à CRXDE et accédez à /etc/clientlibs/

  2. Créez un nœud de type cq:ClientLibraryFolder et nommez-le. Par exemple, validation.

    Cliquez sur Enregistrer tout.

  3. Cliquez avec le bouton droit sur le nœud, cliquez sur Créer un nouveau fichier et créez un fichier avec l’extension .txt. Par exemple, js.txt Ajoutez le code suivant au fichier .txt nouvellement créé et cliquez sur Enregistrer tout.

    code language-javascript
    #base=util
     util.js
    

    Dans le code ci-dessus, util est le nom du dossier etutil.js est le nom du fichier dans le dossier util. Le dossier util et le fichier util.js sont créés dans les étapes suivantes.

  4. Cliquez avec le bouton droit sur le nœud cq:ClientLibraryFolder créé à l’étape 2 et sélectionnez Créer > Créer un dossier. Créez un dossier nommé util. Cliquez sur Enregistrer tout. Cliquez avec le bouton droit sur le dossier util et sélectionnez Créer > Créer un fichier. Créez un fichier nommé util.js. Cliquez sur Enregistrer tout.

  5. Ajoutez le code suivant au fichier util.js et cliquez sur Enregistrer tout. Le code valide la longueur du nom de fichier.

    code language-javascript
    /*
     * 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);
            });
        }
    })();
    
    note note
    NOTE
    Le script concerne le composant de widget de pièce jointe prêt à l’emploi. Si vous avez personnalisé le widget de pièce jointe prêt à l’emploi, modifiez le script ci-dessus pour y incorporer les modifications.
  6. Ajoutez les propriétés suivantes au dossier créé à l’étape 2 et cliquez sur Enregistrer tout.

    • Nom : categories

    • Type : Chaîne

    • Valeur : fp.validation

    • Option multiple : Activé

  7. Accédez à /libs/fd/af/runtime/clientlibs/guideRuntime et ajoutez la valeur fp.validation à la propriété embed.

  8. Accédez à /libs/fd/af/runtime/clientlibs/guideRuntimeWithXFA et ajoutez la valeur fp.validation à la propriété embed.

    note note
    NOTE
    Si vous utilisez des bibliothèques client personnalisées au lieu des bibliothèques client guideRuntime et guideRuntimeWithXfa, utilisez le nom de catégorie pour intégrer la bibliothèque client créée dans cette procédure à vos bibliothèques personnalisées chargées lors de l’exécution.
  9. Cliquez sur Enregistrer tout.  Désormais, lorsque le nom de fichier contient plus de 150 caractères (extension comprise), un message s’affiche.

recommendation-more-help
19ffd973-7af2-44d0-84b5-d547b0dffee2