When users log in the platform can display a notification of a planned maintenance window to all users. Users can acknowledge the popup and request that the platform does not display it again, and this preference is stored in cookies.
To display the additional maintenance information, the user can click on the Help "?" button in the top left-hand corner of the popup. This will go to a link that the administrator can configure.
The platform also displays a maintenance notice link at the bottom of the screen.
By default, the maintenance window in the UI will have a status of scheduled, in progress, or finished. The platform determines this status automatically from the dates set by the administrator.
To customize the maintenance states, change the UI labels for "maintenance.status". For example, to change the "scheduled" label to "planned", modify the label text as follows: "maintenance.status.not_started" : "planned". For details of how to create custom UI labels, see Abiquo UI client language configuration.
To configure and activate maintenance notices for a maintenance window:
Go to Configuration → Dashboard
Set the properties as described in the following table.
Name | Type | Required | Description | Example |
|---|---|---|---|---|
Enable maintenance mode | Boolean | yes | This attribute is used to enable this feature | true |
Maintenance start time | String | yes | This attribute is used to specify the start of the maintenance period in Javascript date-time format: yyyy-mm-ddTHH:MM:ss.lo | 2018-10-19T11:00:00.000+0200 |
Maintenance end time | String | yes | This attribute is used to specify the end of the maintenance period in Javascript date-time format: yyyy-mm-ddTHH:MM:ss.lo | 2018-12-03T12:00:00.000+0200 |
Additional maintenance info URL | String | no | This attribute is used to add a link in the maintenance popup to add additional information about the maintenance. The link is reached by clicking the "?" symbol in the top left-hand corner of the popup. | https://wiki.abiquo.com/display/doc/Configuration+View |