準備AEM Forms以備份

本檔案中的範例和範例僅適用於JEE環境上的AEM Forms。

關於備份和還原服務

「備份和還原」服務可讓您將AEM Forms置於​備份模式​中,以便執行熱備份。 備份和還原服務實際上不會執行AEM Forms備份或還原系統。 相反,它使您的伺服器處於一個狀態,以便進行一致且可靠的備份,同時允許您的伺服器繼續運行。 您負責備份全局文檔儲存(GDS)和連接到表單伺服器的資料庫的操作。 GDS是一個目錄,用於儲存在長期進程中使用的檔案。

備份模式是伺服器進入的狀態,這樣在備份過程進行時,GDS中的檔案就不會被清除。 而是在GDS目錄下建立子目錄,以維護儲存備份模式結束後要清除的檔案記錄。 檔案旨在使系統重新啟動並可跨越數天,甚至數年。 這些檔案是表單伺服器整體狀態的關鍵部分,可能包含PDF檔案、策略或表單模板。 如果這些檔案中的任何一個丟失或損壞,則表單伺服器上的進程可能變得不穩定,資料可能丟失。

您可以選擇執行快照備份,在備份過程中通常會在一段時間內進入備份模式,然後在完成備份活動後離開備份模式。 需要保留備份模式,以便從GDS中清除檔案,以確保檔案不會不必要地增大。 您可以明確地離開備份模式,或等待備份模式會話的時間過期。

您還可以將伺服器保留在永久備份模式,這是滾動備份或連續系統覆蓋的備份策略的典型模式。 滾動備份模式表示系統始終處於備份模式,在釋放前一個會話時立即啟動新備份模式會話。 在連續備份模式下,檔案將在兩個備份模式會話後清除,不再被引用。

您可以使用備份和還原服務將現有應用程式或新應用程式添加到您建立的應用程式中,以執行連接到表單伺服器的GDS或資料庫的備份。

注意

與AEM Forms實施的任何其他方面一樣,您的備份和恢復策略應在開發或測試環境中開發和測試,然後才用於生產環境,以確保整個解決方案能夠正常工作,不會丟失資料。

您可以使用備份和還原服務執行以下任務:

  • 進入備份模式。
  • 離開備份模式。
注意

有關執行AEM Forms備份時應考慮的詳細資訊,請參閱管理幫助

注意

有關備份和還原服務的詳細資訊,請參閱AEM Forms的服務參考

在表單伺服器上進入備份模式

您進入備份模式以允許對表單伺服器進行熱備份。 進入備份模式時,根據貴組織的備份過程指定以下資訊:

  • 標識備份模式會話的唯一標籤,該會話可能對您的備份過程有用。
  • 完成備份過程的時間。
  • 指示是否處於連續備份模式的標誌,只有在執行滾動備份時才有用。

在將應用程式寫入備份模式之前,建議您了解將表單伺服器置於備份模式後將使用的備份過程。 有關執行AEM Forms備份時應考慮的詳細資訊,請參閱管理幫助

注意

有關備份和還原服務的詳細資訊,請參閱AEM Forms的服務參考

步驟的摘要

要建立進入備份模式的應用程式,請執行以下步驟:

  1. 包含專案檔案。
  2. 建立BackupService客戶端對象。
  3. 確定唯一的標籤、執行備份的時間,以及是否處於連續備份模式。
  4. 進入備份模式。
  5. (可選)檢索伺服器上備份模式會話的相關資訊。
  6. 執行GDS(全局資料儲存)和資料庫的備份。

包含項目檔案

在您的開發專案中加入必要的檔案。 這些檔案對於在您的項目中包括以正確編譯代碼和使用備份和還原服務API非常重要。

有關這些檔案的位置資訊,請參閱包含AEM Forms Java庫檔案

建立BackupService客戶端API對象

要以寫程式方式離開備份模式,請建立一個BackupService客戶端對象以使用備份和還原服務API。

確定唯一的標籤,確定執行備份的時間,並決定是否處於連續備份模式

在進入備份模式之前,您應決定一個唯一標籤,確定要分配多少時間執行備份,並決定是否希望表單伺服器保持備份模式。 這些注意事項對於與貴組織建立的備份過程整合非常重要。 (請參閱管理幫助。)

進入備份模式

使用與貴組織的備份過程一致的參數進入備份模式。

檢索伺服器上備份模式會話的相關資訊

進入備份模式後,可以檢索有關會話的資訊。 此資訊可用於與備份過程整合

執行GDS和資料庫的備份

成功進入備份模式後,可以執行全局文檔儲存(GDS)和表單伺服器所連接的資料庫的備份。 此步驟特定於您的組織,因為您可以手動執行此步驟,或者可以運行其他工具來執行備份過程。

使用Java API進入備份模式

使用「備份和還原服務API」進入備份模式:

  1. 包含項目檔案

    在您Java專案的類別路徑中,加入必要的用戶端JAR檔案,例如adobe-backup-restore-client-sdk.jar。 要建立Java客戶端應用程式,必須將以下JAR檔案添加到項目的類路徑中:

    • adobe-backup-restore-client-sdk.jar
    • adobe-livecycle-client.jar
    • adobe-usermanager-client.jar
    • adobe-utilities.jar(若AEM Forms部署在JBoss Application Server上則為必要)
    • jbossall-client.jar(若AEM Forms部署在JBoss Application Server上則為必要)
  2. 建立BackupService客戶端API對象

    您將ServiceClientFactory對象和BackupService客戶端API對象一起使用。

    • 建立包含連接屬性的ServiceClientFactory對象。 (請參閱設定連接屬性。)
    • 使用其建構子並傳遞ServiceClientFactory物件,以建立BackupService物件。
  3. 確定唯一的標籤,確定執行備份的時間,並決定是否處於連續備份模式

    決定唯一的標籤,決定要分配多少時間執行備份,並決定是否希望表單伺服器保持連續備份模式。

  4. 進入備份模式

    通過調用enterBackupMode方法並使用以下參數進入備份模式:

    • String值,它指定標識備份模式會話的唯一人類可讀標籤。 建議您不要使用無法編碼為XML格式的空格或字元。

    • 一個int值,它指定要保持在備份模式下的分鐘數。 您可以指定從110080的值(一週內的分鐘數)。 使用連續備份模式時,會忽略此值。

    • 一個Boolean值,指定是否處於連續備份模式。 值True指定為連續備份模式。 在連續備份模式下,您為要保持在備份模式下的分鐘數指定的值將被忽略。

      連續備份模式表示在完成當前備份模式會話後將啟動新的備份模式會話。 值False表示不使用連續備份模式,在離開備份模式後,將恢復從GDS中清除檔案。

  5. 檢索伺服器上備份模式會話的相關資訊

    使用調用enterBackupMode方法後返回的BackupModeEntryResult對象檢索資訊。 進入備份模式後可檢索的資訊對於與備份過程整合可能非常有用。 例如,標籤、備份ID和開始時間可能作為備份過程檔案名的輸入而非常有用。

  6. 執行GDS和資料庫的備份

    備份全局文檔儲存(GDS)和您的表單伺服器所連接的資料庫。 執行備份的動作不屬於AEM Forms SDK,甚至可能包括貴組織中備份程式專用的手動步驟。

使用Web服務API進入備份模式

使用Backup and Restore Service API提供的Web服務進入備份模式:

  1. 包含項目檔案

    • 建立一個Microsoft .NET客戶端程式集,該程式集佔用備份和還原服務API WSDL。
    • 參考Microsoft .NET客戶端程式集。
  2. 建立BackupService客戶端API對象

    使用Microsoft .NET客戶端程式集,通過調用其預設建構子來建立BackupServiceService對象,並使用Credentials方法指定憑據。

  3. 確定唯一的標籤,確定執行備份的時間,並決定是否處於連續備份模式

    決定唯一的標籤,決定要分配多少時間執行備份,並決定是否希望表單伺服器保持連續備份模式。

  4. 進入備份模式

    要進入備份模式,請調用enterBackupMode方法並傳遞以下值:

    • String值,它指定標識備份模式會話的唯一人類可讀標籤。 建議您不要使用無法編碼為XML格式的空格或字元。

    • 一個Uint32值,它指定在備份模式下保持的分鐘數。 您可以指定從110080的值(一週內的分鐘數)。 使用連續備份模式時,會忽略此值。

    • 一個Boolean值,指定是否處於連續備份模式。 值True指定為連續備份模式。 在連續備份模式下,您為要保持在備份模式下的分鐘數指定的值將被忽略。 連續備份模式表示在完成當前備份模式會話後將啟動新的備份模式會話。

      False表示不使用連續備份模式,在離開備份模式後,將恢復從GDS中清除檔案。

  5. 檢索伺服器上備份模式會話的相關資訊

    從返回以驗證其是否成功的BackupModeEntryResult中調用enterBackupMode方法之後,檢索有關備份模式會話的資訊。 進入備份模式後可檢索的資訊對於與備份過程整合可能非常有用。 例如,標籤、備份ID和開始時間可能作為備份過程檔案名的輸入而非常有用。

  6. 執行GDS和資料庫的備份

    備份全局文檔儲存(GDS)和您的表單伺服器所連接的資料庫。 執行備份的動作不屬於AEM Forms SDK,甚至可能包括貴組織中備份程式專用的手動步驟。

在表單伺服器上保留備份模式

您可以保留備份模式,以便表單伺服器恢復從表單伺服器上的GDS(全局文檔儲存)清除檔案。

在將應用程式寫入到離開模式之前,建議您了解與AEM Forms一起使用的備份過程。 有關執行AEM Forms備份時應考慮的詳細資訊,請參閱管理幫助

注意

有關備份和還原服務的詳細資訊,請參閱AEM Forms的服務參考

步驟的摘要

要退出備份模式,請執行以下步驟:

  1. 包含專案檔案。
  2. 建立BackupService客戶端對象。
  3. 離開備份模式。
  4. (可選)檢索有關表單伺服器上運行的備份模式會話的資訊。

包含項目檔案

在您的開發專案中包含所有必要的檔案。 這些檔案對於正確編譯代碼以及使用備份和還原服務API非常重要。

有關這些檔案的位置資訊,請參閱包含AEM Forms Java庫檔案

建立BackupService客戶端API對象

要以寫程式方式離開備份模式,請建立一個BackupService客戶端對象以使用備份和還原服務API。

離開備份模式

保留備份模式以繼續正常清除全局文檔儲存(GDS)中的檔案。 在離開備份模式之前,應驗證備份過程是否已完成。

檢索有關已結束的備份模式會話的資訊

離開備份模式後,可以檢索有關會話的資訊。 此資訊可用於與備份過程整合。

使用Java API保留備份模式

使用備份和還原服務API(Java)保留備份模式:

  1. 包含項目檔案

    在您Java專案的類別路徑中,加入必要的用戶端JAR檔案,例如adobe-backup-restore-client-sdk.jar。 要建立Java客戶端應用程式,必須將以下JAR檔案添加到項目的類路徑中:

    • adobe-backup-restore-client-sdk.jar
    • adobe-livecycle-client.jar
    • adobe-usermanager-client.jar
    • adobe-utilities.jar(若AEM Forms部署在JBoss Application Server上則為必要)
    • jbossall-client.jar(若AEM Forms部署在JBoss Application Server上則為必要)
  2. 建立BackupService客戶端API對象

    您將ServiceClientFactory對象和BackupService客戶端API對象一起使用。

    • 建立包含連接屬性的ServiceClientFactory對象。 (請參閱設定連接屬性。)
    • 使用其建構子並傳遞ServiceClientFactory物件作為參數,以建立BackupService物件。
  3. 進入備份模式

    調用leaveBackupMode方法以保留備份模式。

  4. 檢索伺服器上備份模式會話的相關資訊

    使用返回的BackupModeResult對象檢索有關操作的資訊。 進入備份模式後可檢索的資訊對於與備份過程整合可能非常有用。 例如,標籤、備份ID和開始時間可能作為備份過程檔案名的輸入而非常有用。

使用Web服務API保留備份模式

使用備份和還原服務API(Web服務)保留備份模式:

  1. 包含項目檔案

    若要使用Web服務,您必須確定包含Proxy檔案。 請依照下列步驟來設定您的專案,以使用備份和還原服務API作為Web服務。

    • 建立一個Microsoft .NET客戶端程式集,該程式集佔用備份和還原服務API WSDL。
    • 參考Microsoft .NET客戶端程式集。
  2. 建立BackupService客戶端API對象

    使用Microsoft .NET客戶端程式集,通過調用其預設建構子來建立BackupServiceService對象。

  3. 進入備份模式

    調用leaveBackupMode Web服務操作,使備份模式保持不變。

  4. 檢索伺服器上備份模式會話的相關資訊

    在操作之後檢索備份模式標識符,以驗證其是否成功。 離開備份模式後可以檢索的資訊對於與備份過程整合可能非常有用。

本頁內容