將草稿和提交元件與資料庫整合的範例

範例概述

AEM Forms portal草稿和提交元件可讓使用者將表單儲存為草稿,並稍後從任何裝置提交。 此外,使用者也可以在入口網站上檢視其提交的表單。 為了啟用此功能,AEM Forms提供資料和中繼資料服務,將使用者填入的資料儲存在表單中,以及與草稿和已提交表單相關聯的表單中繼資料。 預設情況下,此資料會儲存在CRX存放庫中。 不過,當使用者透過AEM發佈例項與表單互動時(通常不在企業防火牆之外),組織可能會想要自訂資料儲存,以提高安全性和可靠性。

本檔案中討論的範例是自訂資料和中繼資料服務的參考實作,以將草稿和提交元件與資料庫整合。 範例實作中使用的資料庫為​MySQL 5.6.24。 不過,您可以將草稿和提交元件與您選擇的任何資料庫整合。

注意
  • 本文檔中解釋的示例和配置是根據MySQL 5.6.24進行的,您必須將它們適當替換為資料庫系統。
  • 請確定您已安裝最新版的AEM Forms附加元件套件。 如需可用套件的清單,請參閱AEM Forms發行版本文章。
  • 範例套件僅適用於適用性Forms提交動作。

設定範例

在所有製作和發佈執行個體上執行下列步驟,以安裝和設定範例:

  1. 將下列​aem-fp-db-integration-sample-pkg-6.1.2.zip​套件下載至您的檔案系統。

    資料庫整合的示例包

取得檔案

  1. 前往AEM套件管理器,網址為https://[host]:[port]/crx/packmgr/。

  2. 按一下「上傳套件」。

  3. 瀏覽以選取​aem-fp-db-integration-sample-pkg-6.1.2.zip​套件,然後按一下​OK

  4. 按一下​安裝 ,安裝該軟體包。

  5. 前往​AEM Web控制台配置
    https://[host]:[port]/system/console/configMgr的頁面。

  6. 按一下以在編輯模式中開啟​Forms入口網站草稿和提交設定

  7. 指定屬性的值,如下表所述:

    屬性 說明
    Forms入口網站草稿資料服務 草稿資料服務的識別碼 formsportal.sampledataservice
    Forms入口網站草稿中繼資料服務 草稿元資料服務的識別碼 formsportal.samplemetadataservice
    Forms Portal提交資料服務 提交資料服務的標識符 formsportal.sampledataservice
    Forms Portal提交中繼資料服務 提交元資料服務的標識符 formsportal.samplemetadataservice
    Forms Portal待簽署資料服務 掛起簽名資料服務的標識符 formsportal.sampledataservice
    Forms Portal擱置中的簽署中繼資料服務 待定簽名元資料服務的標識符 formsportal.samplemetadataservice
    注意

    服務的解析方式為其名稱(作為aem.formsportal.impl.prop鍵的值),如下所示:

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

    您可以變更資料和中繼資料表格的名稱。

    要為元資料表提供不同的名稱:

    • 在「Web主控台設定」中,尋找並按一下「Forms入口網站中繼資料服務實作範例」。 您可以變更資料來源、中繼資料/其他中繼資料表格名稱的值。

    要為資料表提供不同的名稱:

    • 在Web主控台設定中,尋找並按一下Forms Portal資料服務實作範例。 您可以變更資料來源和資料表格名稱的值。
    注意

    如果您變更表格名稱,請在「表單入口網站」設定中提供這些名稱。

  8. 保留其他配置原樣,然後按一下「保存」。

  9. 資料庫連線可透過Apache Sling Connection Pooled Data Source完成。

  10. 若為Apache Sling連線,請尋找並按一下,以Web主控台設定中的編輯模式開啟​Apache Sling連線Pooled DataSource。 指定屬性的值,如下表所述:

屬性
資料源名稱

用於從資料源池中篩選驅動程式的資料源名稱

注意: 實作範例使用FormsPortal做為資料來源名稱。

JDBC驅動程式類 com.mysql.jdbc.Driver
JDBC連接URI
jdbc[host]:[port]/[schemaname]
使用者名稱 對資料庫表進行身份驗證和執行操作的用戶名
密碼 與用戶名關聯的密碼
事務隔離 READ_COMMITTED
最大活動連接數 1000
最大空閒連接數 100
最小空閒連接 10
初始大小 10
等待次數上限 100000
借閱時測試 已核取
空閒時測試 已核取
驗證查詢 示例值為SELECT 1(mysql)、從dual(oracle)中選擇1、SELECT 1(MS Sql Server)(validationQuery)
驗證查詢超時 10000
注意
  • 示例中未提供MySQL的JDBC驅動程式。 請確保已為其進行了配置,並提供配置JDBC連接池所需的資訊。
  • 指向您的製作和發佈執行個體以使用相同的資料庫。 所有製作和發佈實例的JDBC連接URI欄位值必須相同。
  1. 保留其他配置原樣,然後按一下「保存」。

  2. 如果資料庫架構中已有表,請跳到下一步。

    否則,如果資料庫架構中沒有表,請執行以下SQL陳述式,為資料、元資料和資料庫架構中的其他元資料建立單獨的表:

    注意

    製作和發佈例項不需要不同的資料庫。 在所有製作和發佈執行個體上使用相同的資料庫。

    資料表的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;
    

    元資料表的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;
    

    其他元資料表的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;
    

    注釋表的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. 如果資料庫架構中已有表(資料、元資料和其他元資料表),請執行以下更改表查詢:

    用於更改資料表的SQL陳述式

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

    用於更改元資料表的SQL陳述式

    ALTER TABLE metadata add markedForDeletion varchar(45) DEFAULT NULL
    
    注意

    如果您已執行ALTER TABLE中繼資料新增查詢,且表格中存在marketdforDeletion欄,則該查詢會失敗。

    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;
    

    用於更改additionalmetadatatable表的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;
    

現在已設定範例實作,您可以用來列出草稿和提交,同時將所有資料和中繼資料儲存在資料庫中。 現在來查看範例中資料和中繼資料服務的設定方式。

安裝mysql-connector-java-5.1.39-bin.jar檔案

在所有製作執行個體和發佈執行個體上執行下列步驟,以安裝mysql-connector-java-5.1.39-bin.jar檔案:

  1. 導航到https://[server]:[port]/system/console/depfinder並搜索com.mysql.jdbc包。

  2. 在「匯出依據」欄中,檢查套件是否由任何套件匯出。

    如果包未由任何包導出,請繼續。

  3. 導覽至https://[server]:[port]/system/console/bundles,然後按一下​安裝/更新

  4. 按一下「選擇檔案」,然後瀏覽以選擇mysql-connector-java-5.1.39-bin.jar檔案。 此外,選擇​Start Bundle​和​Refresh Packages​複選框。

  5. 按一下​安裝或更新。 完成後,重新啟動伺服器。

  6. 僅Windows)關閉作業系統的系統防火牆。

表單入口網站資料和中繼資料服務的范常式式碼

以下zip包含資料和中繼資料服務介面的FormsPortalSampleDataServiceImplFormsPortalSampleMetadataServiceImpl(實作類別)。 此外,它包含編譯上述實施類所需的所有類。

取得檔案

驗證檔案名的長度

Forms Portal的資料庫實作使用其他中繼資料表格。 該表具有基於表的「鍵」和「id」列的複合主鍵。 MySQL允許主鍵長達255個字元。 您可以使用下列用戶端驗證指令碼來驗證附加至檔案介面工具集的檔案名稱長度。 附加檔案時會執行驗證。 下列程式中提供的指令碼會在檔案名稱大於150(包括副檔名)時顯示訊息。 您可以修改指令碼,以檢查其是否有不同數量的字元。

執行下列步驟以建立用戶端程式庫並使用指令碼:

  1. 登入CRXDE並導覽至/etc/clientlibs/

  2. 建立​cq:ClientLibraryFolder​類型的節點,並提供該節點的名稱。 例如, validation

    按一下「全部保存」。

  3. 按一下右鍵節點,按一下​建立新檔案,然後建立副檔名為.txt的檔案。 例如,將以下代碼添加到新建立的.txt檔案中,然後按一下「保存全部」。js.txt

    #base=util 
     util.js
    

    在上述程式碼中,util是資料夾的名稱,util.jsutil資料夾中檔案的名稱。 在以下步驟中建立util資料夾和util.js檔案。

  4. 按一下右鍵在步驟2中建立的cq:ClientLibraryFolder節點,選擇「建立」>「建立資料夾」。 建立名為util的資料夾。 按一下「全部保存」。 按一下右鍵util資料夾,選擇「建立」>「建立檔案」。 建立名為util.js的檔案。 按一下「全部保存」。

  5. 將下列程式碼新增至util.js檔案,然後按一下「儲存全部」。 程式碼會驗證檔案名稱的長度。

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

    指令碼適用於現成(OOTB)附件Widget元件。 如果您已自訂OOTB附件Widget,請變更上述指令碼以併入個別變更。

  6. 將下列屬性新增至步驟2中建立的資料夾,然後按一下「儲存全部」。

    • 名稱: 類別

    • 類型: 字串

    • 值: fp.validation

    • 多選項: 啟用

  7. 導覽至/libs/fd/af/runtime/clientlibs/guideRuntime,並將fp.validation值附加至​embed​屬性。

  8. 導覽至/libs/fd/af/runtime/clientlibs/guideRuntimeWithXFA,並將fp.validation值附加至​embed​屬性。

    注意

    如果您使用自訂用戶端程式庫,而非guideRuntime和guideRuntimeWithXfa用戶端程式庫,請使用類別名稱,將此程式中建立的用戶端程式庫內嵌至執行階段載入的自訂程式庫。

  9. 按一下「全部保存」。 現在,當檔案名稱大於150(包括副檔名)字元時,就會顯示訊息。

本頁內容