El modo de mantenimiento se puede establecer en las aplicaciones generadas para evitar que los usuarios accedan a sus páginas. Cuando los usuarios intentan acceder a las páginas de la aplicación mientras ésta se encuentra en modo de mantenimiento, en su lugar obtienen una página o mensaje que les informa la situación.

Es posible configurar una lista de roles funcionales que deben tener acceso irrestricto y una lista de páginas que deben estar disponibles para todos los usuarios aún en este modo.

Establecer modo de mantenimiento

Existen dos formas de poner una aplicación en modo de mantenimiento:

  • Crear en la raíz de la aplicación un archivo con nombre maintenance.html. Cuando este archivo existe y es legible, se retorna su contenido en vez de la página solicitada. Los parámetros de configuración que afectan al modo de mantenimiento no se tienen en cuenta si se usa este archivo.

  • Establecer el parámetro de configuración en_mantenimiento con valor true. En este caso, en vez de la página solicitada, se retorna la indicada por el parámetro de configuración pagina_mantenimiento.

La primera forma tiene prioridad sobre la segunda.

Más específicamente, cuando la aplicación está en modo de mantenimiento, la respuesta sigue las siguientes reglas:

  • Si la página solicitada o el rol funcional actual tienen acceso libre, de acuerdo a los parámetros de configuración (paginas_accesibles_en_mantenimiento o rolfs_acceso_en_mantenimiento, respectivamente), se agrega un mensaje de aviso y se continúa el procesamiento normal sin más interferencia.

  • Si no, se responde con la primera de las siguientes opciones que cumpla las condiciones indicadas:

    1. Redirección a maintenance.html, si existe y la página solicitada produciría respuesta HTML.

    2. Redirección a la página de mantenimiento configurada (parámetro de configuración pagina_mantenimiento), si existe y la página solicitada produciría respuesta HTML.

    3. Estado HTTP 503 (Service Unavailable), con el valor del parámetro de configuración mensaje_mantenimiento en el cuerpo de la respuesta, en cualquier otro caso.

Configuración

Los siguientes parámetros de configuración afectan al modo de mantenimiento:

en_mantenimiento

Indica si la aplicación está o no en modo de mantenimiento.

pagina_mantenimiento

Nombre de la página que se debe retornar al usuario cuando la aplicación está en modo de mantenimiento.

mensaje_mantenimiento

Mensaje a mostrar cuando la aplicación está en modo mantenimiento. Se usa en la página de mantenimiento por defecto provista por XGAP o cuando se retorna con código HTTP 503.

paginas_accesibles_en_mantenimiento

Lista de páginas accesibles por cualquier usuario cuando la aplicación está en modo de mantenimiento.

rolfs_acceso_en_mantenimiento

Lista de roles funcionales que deben poder acceder a todas las páginas de la aplicación cuando está en modo de mantenimiento.