Put Runtime in maintenance mode

Learn how to execute maintenance tasks by activating and deactivating Bonita Runtime maintenance mode.

For certain maintenance tasks that require a change to database tables or to information used by several processes (for example to update the Business Data Model), it is necessary to enable Bonita Runtime maintenance mode temporarily while it is updated.

When the maintenance mode is activated, this has the following consequences:

  • BPM and BDM APIs are not accessible (except BDM installation)

  • Users who are currently logged in, including Administrator users, are automatically redirected to a maintenance page.

  • Users who are filling in forms when the services are paused will lose any information that has not been submitted.

  • All processes are automatically paused.

Those are the reasons why such maintenance procedures must be planned at a time of low usage and must be communicated carefully to the users.

The following sections explain how to notify users about incoming maintenance operations and also how to activate/deactivate the maintenance mode using the Bonita Super Administrator application.
You can also use the Engine API or the Web REST API.

Notify users about incoming maintenance

As a technical user, you can set a maintenance message to be displayed to logged-in users before the scheduled maintenance window. This message should inform users about when and what the maintenance is about. It is also displayed on the maintenance page (503 error page) when the maintenance mode is activated.

To perform that you need to:

  1. Log into Bonita Super Administrator application.

  2. Go to Platform maintenance.

  3. Set the Scheduled maintenance message, and enable Display message to users toggle.

  4. click the update button to submit your changes.

  5. Your maintenance message is now visible to all logged-in users.

  • If you made some changes to the bonita layout page or applicationDirectoryBonita page, you need consider adapting it with the latest versions.

  • You still can use the Maintenance API, if you want to get maintenance sate over external applications.

Enable maintenance mode

  1. Log into Bonita Super Administrator application.

  2. Go to Platform maintenance.

  3. Click the Activate maintenance mode button.

  4. In the popup, click Activate maintenance mode to confirm that maintenance mode is to be activated.

  5. The maintenance mode is immediately activated.

Disable maintenance mode

  1. Log into Bonita Super Administrator application.

  2. Go to Platform maintenance.

  3. Click the Deactivate maintenance mode button.

  4. In the popup, click Deactivate maintenance mode to confirm that maintenance mode is to be disabled.

  5. The maintenance mode is deactivated.

After the services are resumed, it is important to inform users that they can now log into all applications.