Administer the site (on-premises)

Here are instructions for managing the overall site, such as ALM Octane database servers, mail servers, and logs. This context is also for adding spaces and reviewing the history of modifications to spaces. On-premises site admins can manage the site from the Site area in Settings.

About the site

Site administration includes tasks such as managing ALM Octane database servers, mail servers, and logs.

The site context is also for adding spaces and reviewing the history of modifications to spaces.

On-premises site admins can manage the site from the Site area in Settings.

Manage servers (on-premises)

You can perform the following server management actions in Settings > Site > Servers.

Task How to
View cluster health

In the Cluster Status area, click the cluster.

The Cluster Status dialog box:

  • Indicates whether the cluster is healthy.

  • Provides additional details about the nodes in the cluster, such as their addresses and names.

If the cluster is unhealthy, ALM Octane displays the Hazelcast nodes that are stably connected to ALM Octane. This enables you to troubleshoot the situation and make corrections to the Hazelcast node information in the octane.yml file as necessary. For details, see the information about installing clusters: Linux / Windows

Refresh the status of the servers to test connectivity in the Application Servers area, click .
Change the database admin password In the Database Servers area, click the server name, change the Admin password, and click Save.
Change log details

In the Application Logs area, click the log file name, change the Level and Max Size, and click Save.

  • Path

    The path of the log file. (Read only)

    The log is written to the relevant log file in the specified path, according to the context in which you are working.

    Example: When you are working in the context of the main ALM Octane application, the log is written to the app.log file located in Path.

  • Level

    Determines the severity of the events to include in the log.

    Valid values are: Fatal, Error, Warn, Info, Debug, Trace.

    Note: If you change the log level to Debug, make sure to change it back when you are finished debugging.

  • Max Size

    When the log size reaches this maximum size in MB, a new log file opens.

Change the mail server host name and port In the Mail Servers area, click the server name, change the Host name and Port, and click Save.

Back to top

Manage users at the site level

Site admins can delete, activate, and deactivate users from Settings > Site. They can also assign other users the site admin role.

Space admins, and admins for workspaces, can also activate and deactivate users For details, see Activate or deactivate a user.

Assign the site admin role to existing users

  1. In Settings > SiteUsers grid view, select the user who should also be a site admin.

  2. Click to display the Roles column.

  3. Select Site Admin in the Roles column for that user.

Delete a user

The operation of deleting a user may take a few minutes.

Note: Before deleting in ALM Octane, SaaS operators should delete the user from the system before deleting the user in ALM Octane.

  1. In Settings > SiteUsers grid view, select a user.

  2. In the toolbar, click and answer Yes to confirm.

  3. On-premises: If your site is configured to erase all traces of the deleted user, the following appears.

    Click Delete.

    We strongly recommend that you manage an external file that maps deleted ALM Octane users to reference codes.

    Enter a reference code for the user from this external file.

    Internally, references to the user are replaced by this reference code in ALM Octane.

    If you do not enter a reference code, the user is not deleted.

    For details on how to configure the site to erase deleted users' details, see FORGET_USER_ON_DELETE under Configuration parameters.

    Setting the value for this parameter only affects how users are deleted from this point forward, not retroactively.

Tip: You can also delete multiple users using the REST API. For details, see Delete multiple users.

Back to top

Manage spaces at the site level

Site admins can view, add, rename, and upgrade spaces (including monitoring background jobs) from Settings > Site.

For details about what the space admin can do to manage spaces, see Manage spaces.

Tip: For strategies for setting up your spaces and workspaces, see Best practices for setting up spaces and workspaces.

View spaces for a site

In Settings > Site > Spaces, you can see a list of spaces at the site, and select one to see its details. 

Icons indicate if the space is shared or isolated .

While looking at the details, you can also see the history of changes made to the space.

Create spaces for a site

  1. In Settings > Site:

    To create a shared space, click .

    To create an isolated space, click .

  2. Name the space.

    You can rename the space at any time.

  3. If the database at your site is managed by database administrators, and ALM Octane is not authorized to create its own schemas or databases, check Use existing schema. Enter the name of the existing space schema to use, and its password.

  4. Create workspaces and associate them with the space. For details, see Manage workspaces.

Delete a space

Deleting a space removes all data from all of the space's workspaces.

Caution: You cannot undo this operation. Make sure you want to delete the space before proceeding.

Before deleting a space, note the following: 

  • You cannot delete the default space.

  • You cannot delete multiple spaces at one time.

  • For security and GDPR compliance, you can view the history of deleted spaces using the REST API. For details, see Viewing the history of deleted spaces.

  • The history of session information is deleted. However, files are created that contain this information for security and GDPR compliance.

    Each file can contain information for up to 500 sessions. Files are located here: 


    The naming convention for the files is: 

    SessionsOfDeletedSpace_<space_id>_<spaceName> [_<pageNum>]

To delete a space: 

  1. In Settings > Site > Spaces, select the space you want to delete.

  2. In the toolbar, click More and then Delete.

Edit space admins

Add or remove space admins.

  1. In Settings > Site > Spaces, click in the Administrators column's cell of the space you want to edit.

  2. From the list, select or remove admins for this space.

Upgrade spaces

After upgrading from a previous ALM Octane version, check if any spaces must be upgraded. Upgrade these spaces using the instructions below.

For details on the upgrade procedure to use before upgrading spaces, see:

  1. In Settings > Site > Spaces, select all spaces and click Upgrade.

    Upgrade is available only if a space needs to be upgraded.

    Click Refresh to see the updated status for the spaces.

  2. The workspace name is a unique identifier within a space. ALM Octane adds a numeric suffix (_1, _2, and so on) to any upgraded workspaces with the same name. If necessary, ALM Octane truncates the last characters from workspace names longer than 255 characters before adding the suffix.

    After upgrading, review the names of the workspaces. You can rename them if you want.

Note: Until all of the background jobs have completed, some data may be unavailable in trend graphs, and some ALM Octane features might be temporarily unavailable.

See a space's background jobs

Background jobs include processes that run after upgrading a space, among other activities. A space is only fully upgraded after all background jobs have completed successfully. Check periodically to see when an upgraded space is ready.

  1. In Settings > Site > Spaces, select the space, and click Background Jobs.

  2. Review the statuses of the spaces.

    Active, Inactive

    The space retained its state from before the upgrade.

    No action necessary.


    The space is waiting to be sent for upgrade but the upgrade has not yet started. When the upgrade is actually in progress, the current step being processed is displayed. See the status Step # of #.

    The number of spaces that can be upgraded concurrently is limited.

    No action necessary.

    Step # of #

    As the upgrade progresses, the current step and operation are displayed.

    No action necessary.


    A recoverable error occurred.

    Review the error and the logs. Display the Recovery guidelines field, and follow the instructions. Restart the upgrade.


    An unrecoverable error occurred.

    Restore schemas from the previous version. For details, see:

  3. Some jobs can be rerun. If a job failed, try rerunning it.

  4. When all jobs have completed, if you are in the middle of an ALM Octane upgrade, continue by restarting all Jetty servers: Linux / Windows

Note: Until all of the background jobs have completed, some data may be unavailable in trend graphs, and some ALM Octane features might be temporarily unavailable.

Back to top

Set configuration parameters

Site admins and space admins can set configuration parameters, such as parameters for setting the language, determining from where the Help Center opens, activating basic authentication, and so on: 

Back to top

View sessions

You can see information about each session that logged into ALM Octane. This includes:

  • The user ID that logged in

  • The type of client for the session (UI, API user, or API key)

  • The IP address used for the session

  • The duration of the session

  • The session's license edition

To view sessions, click Site and then click the Sessions tab.

You can group sessions.

Back to top

See also: