Maintenance mode
In Codebeamer 21.09 a new administrator feature is introduced: Maintenance mode. The feature serves as a limitation of access for users without System Administrator permissions, by default (accessibility can be reconfigured by granting normal users Access in Maintenance mode permission).
When Maintenance mode is turned on, only System Administrators (or users with Access in Maintenance mode permission) can log in to Codebeamer, this way providing separated time and limited user access for executing maintenance tasks.
Configuration
Users can access maintenance mode in > :
The following configuration parameters are available:
• Set system mode — Determines the mode Codebeamer runs in. Default value: Normal. Possible values:
◦ Normal — Anyone with a user account can log in to Codebeamer.
◦ Maintenance — Only users with appropriate permissions can log in to Codebeamer (users in the System Administrator group, or with Access in Maintenance mode permission).
• Configure maintenance information — Users can configure different texts to be displayed while Maintenance mode is turned on:
◦ Notification text — Sets the text that is sent to currently logged in users, to send the notification click the Send notification now button.
◦ Login text — Sets the text displayed on the login screen. If left empty, the default Login text is displayed.
◦ Welcome text — Sets the text displayed on the My Start page. If left empty, the default Welcome text is displayed.
◦ Slogan text — Sets the text displayed in the application header. If left empty, the default Slogan text is displayed.
◦ Login error text — Sets the text displayed when an unauthorized user tries to log in while Maintenance mode is turned on.
 |
Default configuration for Login text, Welcome text, and Slogan text can be found in > and > menus.
|
Click the Save button to save the configuration and turn on Maintenance mode (Set system mode parameter's value: Maintenance).
|
|
For developers, the following endpoint was introduced: /v3/system/maintenance. For more information, see: Swagger API.
|
|
|
The information that follows applies to Codebeamer 2.2.1.1 and later 2.2.1.x versions only.
|
If Codebeamer is in Maintenance mode at startup, the background services are not started except for the SWS migration service. This service is needed for the migration. The service requires that no integration services are running and adding or modifying items at the finalization phase of Working-Set migration.
Services are not started or stopped when Codebeamer is already running. This implies the following:
• If Codebeamer is started in Maintenance mode, the background services are not started except for the SWS migration service.
• When Codebeamer is switched back to normal mode, the services are not started. A server restart is required in normal mode to start the background services.
• When Codebeamer is put into Maintenance mode, the services are not stopped. A server restart is required in Maintenance mode to ensure that the background services are not running.
Based on this behavior, note the following:
• If Codebeamer is put into Maintenance mode for a while, and then put back to normal mode without a server restart, the services will be still running during the entire maintenance period. So a server restart is not required.
• If Codebeamer was restarted after enabling Maintenance mode, another server restart is required after putting it back to normal mode to ensure the services are started.