Preparación de AEM Forms para Backup

Acerca del Servicio de Backup y Restore

El servicio Backup and Restore permite colocar a AEM Forms en modo de backup, lo que permite realizar backups en caliente. El servicio Backup and Restore no realiza una copia de seguridad de AEM Forms ni restaura el sistema. En su lugar, pone el servidor en un estado para realizar copias de seguridad coherentes y fiables, permitiendo al mismo tiempo que el servidor continúe ejecutándose. Usted es responsable de las acciones para realizar una copia de seguridad del Almacenamiento de Documento global (GDS) y de la base de datos conectada al servidor de formularios. El GDS es un directorio que se utiliza para almacenar los archivos que se utilizan en un proceso duradero.

El modo de copia de seguridad es un estado en el que entra el servidor para que los archivos del GDS no se purguen mientras se realiza un procedimiento de copia de seguridad. En su lugar, los subdirectorios se crean en el directorio GDS para mantener un registro de los archivos que se van a purgar después de que finalice el modo de copia de seguridad guardada. Un archivo está diseñado para sobrevivir a reinicios del sistema y puede abarcar días o incluso años. Estos archivos son una parte crítica del estado general del servidor de formularios y pueden incluir archivos PDF, políticas o plantillas de formulario. Si alguno de estos archivos se pierde o se daña, los procesos del servidor de formularios pueden volverse inestables y se podrían perder datos.

Puede elegir realizar copias de seguridad instantáneas, donde normalmente entrará en el modo de copia de seguridad durante un período y, a continuación, dejará el modo de copia de seguridad después de completar las actividades de copia de seguridad. Es necesario dejar el modo de copia de seguridad para que los archivos se puedan purgar del GDS a fin de garantizar que no crezcan innecesariamente. Puede salir del modo de copia de seguridad explícitamente o esperar a que caduque en una sesión de modo de copia de seguridad.

También puede dejar el servidor en modo de copia de seguridad perpetua, que es típico para estrategias de copia de seguridad para copias de seguridad móviles o cobertura continua del sistema. El modo de copia de seguridad móvil indica que el sistema siempre está en modo de copia de seguridad, con una nueva sesión de modo de copia de seguridad iniciada en cuanto se libera la sesión anterior. Cuando se encuentra en modo de copia de seguridad continua, un archivo se purga después de dos sesiones de modo de copia de seguridad y ya no se hace referencia a él.

Puede utilizar el servicio de copia de seguridad y restauración para agregar aplicaciones existentes o nuevas que cree para realizar copias de seguridad del GDS o de la base de datos conectada al servidor de formularios.

Puede realizar estas tareas mediante el servicio de copia de seguridad y restauración:

• Introduzca el modo de copia de seguridad.
• Deje el modo de copia de seguridad.

Introducción del modo de copia de seguridad en el servidor de formularios

El modo de copia de seguridad permite realizar copias de seguridad en caliente de un servidor de formularios. Al entrar en el modo de copia de seguridad, se especifica la siguiente información en función de los procedimientos de copia de seguridad de la organización:

• Una etiqueta única para identificar la sesión del modo de copia de seguridad que puede resultar útil para los procesos de copia de seguridad.
• Hora a la que se completa el procedimiento de copia de seguridad.
• Un indicador que indica si debe estar en modo de copia de seguridad continua, lo que resulta útil sólo si realiza copias de seguridad móviles.

Antes de escribir aplicaciones para entrar en el modo de copia de seguridad, se recomienda que comprenda los procedimientos de copia de seguridad que se utilizarán después de colocar el servidor de formularios en el modo de copia de seguridad. Para obtener más información sobre qué considerar al realizar backups para AEM Forms, consulte ayuda de administración.

Resumen de los pasos

Para crear una aplicación que entre en el modo de copia de seguridad, realice los siguientes pasos:

1. Incluir archivos de proyecto.
2. Cree un objeto de cliente de BackupService.
3. Determinar una etiqueta única, la cantidad de tiempo para realizar la copia de seguridad y si debe estar en modo de copia de seguridad continua.
4. Introduzca el modo de copia de seguridad.
5. (Opcional) Recupere información sobre la sesión del modo de copia de seguridad en el servidor.
6. Realice la copia de seguridad del GDS (almacén de datos global) y la base de datos.

Incluir archivos de proyecto

Incluya los archivos necesarios en el proyecto de desarrollo. Estos archivos son importantes para incluirlos en el proyecto para compilar el código correctamente y utilizar la API de servicio de copia de seguridad y restauración.

Para obtener información sobre la ubicación de estos archivos, consulte Inclusión de archivos de biblioteca Java de AEM Forms.

Creación de un objeto de API de cliente de BackupService

Para salir del modo de copia de seguridad mediante programación, cree un objeto cliente de BackupService para utilizar la API de servicio de copia de seguridad y restauración.

Decida sobre una etiqueta única, determine la cantidad de tiempo para realizar la copia de seguridad y decida si se encuentra en modo de copia de seguridad continua

Antes de entrar en el modo de copia de seguridad, debe decidir una etiqueta única, determinar la cantidad de tiempo que desea asignar para realizar la copia de seguridad y decidir si desea que el servidor de formularios permanezca en el modo de copia de seguridad. Estas consideraciones son importantes para integrarse con los procedimientos de copia de seguridad establecidos por su organización. (Consulte ayuda de administración.)

Entrar al modo de copia de seguridad

Introduzca el modo de copia de seguridad con los parámetros que son coherentes con los procedimientos de copia de seguridad de su organización.

Recuperar información sobre la sesión de modo de copia de seguridad en el servidor

Después de entrar en el modo de copia de seguridad, puede recuperar información sobre la sesión. Esta información se puede utilizar para integrarse con los procedimientos de copia de seguridad

Realizar la copia de seguridad del GDS y la base de datos

Una vez que haya entrado correctamente en el modo de copia de seguridad, puede realizar una copia de seguridad del Almacenamiento de Documento global (GDS) y de la base de datos a la que está conectado el servidor de formularios. Este paso es específico de su organización, ya que puede realizar este paso manualmente o puede ejecutar otras herramientas para realizar el procedimiento de copia de seguridad.

Introduzca el modo de copia de seguridad mediante la API de Java

Introduzca el modo de copia de seguridad mediante la API de servicio de copia de seguridad y restauración:

1. Incluir archivos de proyecto

   Incluya los archivos JAR de cliente necesarios, como adobe-backup-restore-client-sdk.jar, en la ruta de clases del proyecto Java. Para crear la aplicación cliente Java, se deben agregar los siguientes archivos JAR a la ruta de clases del proyecto:

   • adobe-backup-restore-client-sdk.jar
   • adobe-livecycle-client.jar
   • adobe-usermanager-client.jar
   • adobe-utilities.jar (requerido si AEM Forms está implementado en el servidor de aplicaciones JBoss)
   • jbossall-client.jar (requerido si AEM Forms se implementa en el servidor de aplicaciones JBoss)

2. Creación de un objeto de API de cliente de BackupService

   Se utiliza un objeto ServiceClientFactory y el objeto API de cliente de BackupService juntos.

   • Cree un objeto ServiceClientFactory que contenga propiedades de conexión. (Consulte Configuración de propiedades de conexión.)
   • Cree un objeto BackupService utilizando su constructor y pasando el objeto ServiceClientFactory.

3. Decida sobre una etiqueta única, determine la cantidad de tiempo para realizar la copia de seguridad y decida si se encuentra en modo de copia de seguridad continua

   Decida sobre una etiqueta única, determine la cantidad de tiempo que desea asignar para realizar la copia de seguridad y decida si desea que el servidor de formularios permanezca en modo de copia de seguridad continua.

4. Entrar al modo de copia de seguridad

   Introduzca el modo de copia de seguridad invocando el método enterBackupMode con los parámetros siguientes:

   • Un valor String que especifica una etiqueta única legible en lenguaje natural que identifica la sesión del modo de copia de seguridad. Se recomienda no utilizar espacios ni caracteres que no se puedan codificar en formato XML.

   • Un valor int que especifica el número de minutos que deben permanecer en el modo de copia de seguridad. Puede especificar un valor de 1 a 10080 (el número de minutos en una semana). Este valor se ignora cuando se utiliza el modo de copia de seguridad continua.

   • Un valor Boolean que especifica si debe estar en modo de backup continuo. Un valor de True especifica que se encuentra en modo de backup continuo. Cuando se encuentra en modo de copia de seguridad continua, se ignora el valor que se especifica para el número de minutos que deben permanecer en modo de copia de seguridad.

     El modo de copia de seguridad continua significa que se inicia una nueva sesión de modo de copia de seguridad después de completar la sesión actual. Un valor de False significa que no se utiliza el modo de copia de seguridad continua y, después de salir del modo de copia de seguridad, se reanuda la depuración de archivos del GDS.

5. Recuperar información sobre la sesión de modo de copia de seguridad en el servidor

   Recupere información mediante el objeto BackupModeEntryResult que se devuelve después de invocar el método enterBackupMode. La información que puede recuperar después de entrar en el modo de copia de seguridad puede resultar útil para la integración con los procedimientos de copia de seguridad. Por ejemplo, la etiqueta, el ID de copia de seguridad y el tiempo de inicio pueden ser útiles como entrada para los nombres de archivo del procedimiento de copia de seguridad.

6. Realizar la copia de seguridad del GDS y la base de datos

   Haga una copia de seguridad del Almacenamiento de Documento global (GDS) y de la base de datos a la que está conectado el servidor de formularios. Las acciones para realizar la copia de seguridad no forman parte del SDK de AEM Forms e incluso pueden incluir pasos manuales específicos de los procedimientos de copia de seguridad de la organización.

Introduzca el modo de copia de seguridad mediante la API de servicio Web

Introduzca el modo de copia de seguridad mediante el servicio Web proporcionado por la API de servicio de copia de seguridad y restauración:

1. Incluir archivos de proyecto

   • Cree un ensamblado de cliente de Microsoft .NET que utilice el WSDL de la API de servicio de copia de seguridad y restauración.
   • Haga referencia al ensamblado de cliente de Microsoft .NET.

2. Creación de un objeto de API de cliente de BackupService

   Mediante el ensamblado de cliente de Microsoft .NET, cree un objeto BackupServiceService invocando su constructor predeterminado y especifique las credenciales mediante el método Credentials.

3. Decida sobre una etiqueta única, determine la cantidad de tiempo para realizar la copia de seguridad y decida si se encuentra en modo de copia de seguridad continua

   Decida sobre una etiqueta única, determine la cantidad de tiempo que desea asignar para realizar la copia de seguridad y decida si desea que el servidor de formularios permanezca en modo de copia de seguridad continua.

4. Entrar al modo de copia de seguridad

   Para acceder al modo de copia de seguridad, invoque el método enterBackupMode y pase los valores siguientes:

   • Un valor String que especifica una etiqueta única legible en lenguaje natural que identifica la sesión del modo de copia de seguridad. Se recomienda no utilizar espacios ni caracteres que no se puedan codificar en formato XML.

   • Un valor Uint32 que especifica el número de minutos que deben permanecer en el modo de copia de seguridad. Puede especificar un valor de 1 a 10080 (número de minutos en una semana). Este valor se ignora cuando se utiliza el modo de copia de seguridad continua.

   • Un valor Boolean que especifica si debe estar en modo de backup continuo. Un valor de True especifica que se encuentra en modo de backup continuo. Cuando se encuentra en modo de copia de seguridad continua, se ignora el valor que se especifica para el número de minutos que deben permanecer en modo de copia de seguridad. El modo de copia de seguridad continua significa que se inicia una nueva sesión de modo de copia de seguridad después de completar la sesión actual.

     Un valor de False significa que no se utiliza el modo de copia de seguridad continua y, después de salir del modo de copia de seguridad, se reanuda la depuración de archivos del GDS.

5. Recuperar información sobre la sesión de modo de copia de seguridad en el servidor

   Recupere información sobre la sesión del modo de copia de seguridad después de invocar el método enterBackupMode desde BackupModeEntryResult que se devuelve para verificar que se ha realizado correctamente. La información que puede recuperar después de entrar en el modo de copia de seguridad puede resultar útil para la integración con los procedimientos de copia de seguridad. Por ejemplo, la etiqueta, el ID de copia de seguridad y el tiempo de inicio pueden ser útiles como entrada para los nombres de archivo del procedimiento de copia de seguridad.

6. Realizar la copia de seguridad del GDS y la base de datos

   Haga una copia de seguridad del Almacenamiento de Documento global (GDS) y de la base de datos a la que está conectado el servidor de formularios. Las acciones para realizar la copia de seguridad no forman parte del SDK de AEM Forms e incluso pueden incluir pasos manuales específicos de los procedimientos de copia de seguridad de la organización.

Dejar el modo de copia de seguridad en el servidor de formularios

El modo de copia de seguridad se deja para que el servidor de formularios reanude la depuración de archivos del GDS (Almacenamiento de Documento global) en el servidor de formularios.

Antes de escribir aplicaciones para entrar en el modo de salida, se recomienda que entienda los procedimientos de copia de seguridad que se utilizan con AEM Forms. Para obtener más información sobre qué considerar al realizar backups para AEM Forms, consulte ayuda de administración.

Resumen de los pasos

Para salir del modo de copia de seguridad, lleve a cabo los siguientes pasos:

1. Incluir archivos de proyecto.
2. Cree un objeto de cliente de BackupService.
3. Deje el modo de copia de seguridad.
4. (Opcional) Recupere información sobre la sesión de modo de copia de seguridad que se estaba ejecutando en el servidor de formularios.

Incluir archivos de proyecto

Incluya todos los archivos necesarios en el proyecto de desarrollo. Estos archivos son importantes para compilar el código correctamente y utilizar la API de servicio de copia de seguridad y restauración.

Para obtener información sobre la ubicación de estos archivos, consulte Inclusión de archivos de biblioteca Java de AEM Forms.

Creación de un objeto de API de cliente de BackupService

Para salir del modo de copia de seguridad mediante programación, cree un objeto cliente de BackupService para utilizar la API de servicio de copia de seguridad y restauración.

Salir del modo de copia de seguridad

Deje el modo de copia de seguridad para reanudar la depuración normal de archivos desde el Almacenamiento de Documento global (GDS). Antes de salir del modo de copia de seguridad, debe comprobar que los procedimientos de copia de seguridad se han completado.

Recuperar información sobre la sesión de modo de copia de seguridad que finalizó

Después de salir del modo de copia de seguridad, puede recuperar información sobre la sesión. Esta información puede utilizarse para integrarse con los procedimientos de copia de seguridad.

Deje el modo de copia de seguridad usando la API de Java

Deje el modo de copia de seguridad mediante la API de servicio de copia de seguridad y restauración (Java):

1. Incluir archivos de proyecto

   Incluya los archivos JAR de cliente necesarios, como adobe-backup-restore-client-sdk.jar, en la ruta de clases del proyecto Java. Para crear una aplicación cliente Java, se deben agregar los siguientes archivos JAR a la ruta de clases del proyecto:

   • adobe-backup-restore-client-sdk.jar
   • adobe-livecycle-client.jar
   • adobe-usermanager-client.jar
   • adobe-utilities.jar (requerido si AEM Forms está implementado en el servidor de aplicaciones JBoss)
   • jbossall-client.jar (requerido si AEM Forms se implementa en el servidor de aplicaciones JBoss)

2. Creación de un objeto de API de cliente de BackupService

   Se utiliza un objeto ServiceClientFactory y el objeto API de cliente de BackupService juntos.

   • Cree un objeto ServiceClientFactory que contenga propiedades de conexión. (Consulte Configuración de propiedades de conexión.)
   • Cree un objeto BackupService utilizando su constructor y pasando el objeto ServiceClientFactory como parámetro.

3. Entrar al modo de copia de seguridad

   Deje el modo de copia de seguridad invocando el método leaveBackupMode.

4. Recuperar información sobre la sesión de modo de copia de seguridad en el servidor

   Recupere información sobre la operación mediante el objeto BackupModeResult que se devuelve. La información que puede recuperar después de entrar en el modo de copia de seguridad puede resultar útil para la integración con los procedimientos de copia de seguridad. Por ejemplo, la etiqueta, el ID de copia de seguridad y el tiempo de inicio pueden ser útiles como entrada para los nombres de archivo del procedimiento de copia de seguridad.

Deje el modo de copia de seguridad mediante la API de servicio Web

Deje el modo de copia de seguridad mediante la API de servicio de copia de seguridad y restauración (servicio Web):

1. Incluir archivos de proyecto

   Para utilizar servicios Web, debe asegurarse de incluir los archivos proxy. Siga estos pasos para configurar el proyecto y utilizar la API de servicio de copia de seguridad y restauración como un servicio Web.

   • Cree un ensamblado de cliente de Microsoft .NET que utilice el WSDL de la API de servicio de copia de seguridad y restauración.
   • Haga referencia al ensamblado de cliente de Microsoft .NET.

2. Creación de un objeto de API de cliente de BackupService

   Mediante el ensamblado de cliente de Microsoft .NET, cree un objeto BackupServiceService invocando su constructor predeterminado.

3. Entrar al modo de copia de seguridad

   Deje el modo de copia de seguridad invocando la operación de leaveBackupMode servicio Web.

4. Recuperar información sobre la sesión de modo de copia de seguridad en el servidor

   Recupere el identificador del modo de copia de seguridad después de la operación para comprobar que se ha realizado correctamente. La información que puede recuperar después de salir del modo de copia de seguridad puede resultar útil para la integración con los procedimientos de copia de seguridad.