Maintenance Periods

Overview

The ReadiNow platform allows administrators to place a tenant into a 'maintenance' mode.   

The purpose of this feature is to allow tenant administrators to define their own maintenance periods and place the tenant in 'maintenance' mode. 

When a tenant is in maintenance mode non-admin users are prevented from interacting with the tenant - this may be necessary during large data migrations or schema changes, for example. 

Users who are members of the administrators role will be able to use the console as normal.  

Reminders and notifications are used to inform all users about the current status of the tenant, including start and end times for the maintenance period.

Note: 'Maintenance Periods' performed by tenant administrators are different to Scheduled Maintenance & Updates performed by ReadiNow.

Setting a Maintenance Period

Tenant administrators can create, edit, delete their own Maintenance Periods via:

Administration > Settings > Maintenance Periods 

A scheduled maintenance period settings Form  has the following fields :

• Name : An optional name for the maintenance period
• Description: An optional description of the maintenance period - displayed in messages & reminders relating to the maintenance period.
• Enabled: Must be checked to activate the maintenance period.
• Start date: The date and time of the start of the maintenance period (required)
• End date: The date and time of the end of the maintenance period (required)  
• Reminder date: An optional reminder notification sent to all users currently logged into the tenant. 

Creating a custom Scheduled Maintenance Period via:
Administration > Settings > Maintenance Periods

What users experience

Once a maintenance period has been set and enabled by an administrator the following events will take place:

• if configured a reminder will be sent at the specified time to all users currently logged into the tenant
• prior to the scheduled maintenance, a reminder will be sent* to all users currently logged into the tenant with:
  • 10 minutes notice
  • 5 minutes notice
• the tenant will enter maintenance mode at the scheduled time
  • all logged-in users will see a notification stating the tenant is in maintenance 
    • users will NOT be logged out
    • admin-users will be able to dismiss the notification
    • the maintenance start & end times will be specified
  • non-admin users will be unable to interact with the platform 
  • users with tenant administrator roles will be able to use the platform normally (after dismissing the notification)
• when the maintenance period ends all logged-in users will receive a notification that the scheduled maintenance period has finished

*NOTE:  if maintenance period is created with less than 10 (5) minutes notice the 10 (5) minute reminder will not be sent.