准备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客户端对象以使用Backup and Restore Service 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对象。 (请参阅设置连接属性。)
    • 使用BackupService对象的构造函数并传递ServiceClientFactory对象,创建对象。
  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. 包括项目文件

    • 创建一个使用备份和还原服务API WSDL的Microsoft .NET客户端程序集。
    • 引用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客户端对象以使用Backup and Restore Service 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对象。 (请参阅设置连接属性。)
    • 使用BackupService对象的构造函数并将ServiceClientFactory对象作为参数进行传递,从而创建对象。
  3. 进入备份模式

    通过调用leaveBackupMode方法退出备份模式。

  4. 检索有关服务器上备份模式会话的信息

    使用返回的BackupModeResult对象检索有关操作的信息。 进入备份模式后可以检索到的信息对于与备份过程集成可能很有用。 例如,标签、备份ID和开始时间可能用作备份过程文件名的输入。

使用Web服务API退出备份模式

使用备份和还原服务API(Web服务)退出备份模式:

  1. 包括项目文件

    要使用Web服务,必须确保包含代理文件。 请按照以下步骤配置您的项目以将备份和还原服务API用作Web服务。

    • 创建一个使用备份和还原服务API WSDL的Microsoft .NET客户端程序集。
    • 引用Microsoft .NET客户端程序集。
  2. 创建BackupService客户端API对象

    使用Microsoft .NET客户端程序集,通过调用其默认构造函数创建BackupServiceService对象。

  3. 进入备份模式

    通过调用leaveBackupMode Web服务操作退出备份模式。

  4. 检索有关服务器上备份模式会话的信息

    在操作后检索备份模式标识符,以验证其是否成功。 在离开备份模式后可以检索到的信息对于与备份过程集成可能很有用。

在此页面上

Adobe Summit Banner

A virtual event April 27-28.

Expand your skills and get inspired.

Register for free
Adobe Summit Banner

A virtual event April 27-28.

Expand your skills and get inspired.

Register for free