Manage licenses (on-premises)

This section describes how to manage your ALM Octane licenses.

License modes: Standalone or shared

You can work with licenses in the following ways:

You define your license mode during installation. By default, ALM Octane is set to work in standalone mode.

Back to top

License types: Named or concurrent

There are two types of licenses in ALM Octane:

  • Named. This defines how many users you can register in ALM Octane.

  • Concurrent. This defines how many users can access the system at the same time.

ALM Octane does not allow you to work with mixed licenses. You can either use named licenses, or concurrent licenses. Note that license sharing with ALM or Quality Center is for concurrent licenses only.

An active license is released when a user logs out of a session, or after the session timeout (by default, 3 hours). If there are no available licenses, a user trying to log in receives an error message.

Working with named licenses:

  • To view details on your license capacity, access Settings > Site > Users. On the top right you will see how many licenses are in use, and how many are still available.

  • If you need to deactivate a user to release a license, the site admin should deactivate the user at the site level. If you deactivate a user at the shared space or workspace level, their license is not released.

Working with concurrent licenses:

  • In the concurrent model, license consumption is per user, and per machine. When a user opens multiple sessions on a single machine, one license is consumed. When a user opens sessions on different machines, multiple licenses are consumed.

  • For details on how to view information regarding usage, see Calculate license usage.

Switching between license types:

  • You can switch from a named license to a concurrent license without limitation.

  • If you need to switch from a concurrent license to a named license, the number of active users must be within the named license capacity limits.

You switch modes when the site admin installs a new license of the other type (for example named instead of concurrent).

Back to top

Install a standalone license

To install a standalone license:

  1. Access Settings > Site > Licenses.

  2. Click Install License, browse to the license file that you received from Micro Focus, and click Install.

To switch from sharing to standalone mode:

If you were previously sharing licenses with ALM or Quality Center and you now want to work in standalone mode, you need to edit the octane.yml file.

  1. Open the /opt/octane/conf/octane.yml configuration file (in Windows: C:\octane\conf\octane.yml) and locate the license section.

  2. Change the value of mode to standalone.

For details on how to work with the octane.yml file, refer to the ALM Octane Installation Guide.

Back to top

View license and session details

  • To view details on your active license edition, access Settings > Site > Licenses.

  • To view details on active sessions, access Settings > Site > Sessions.

    Details include the user ID that logged in, the type of access (UI, API user, or API key), the IP address used for the session, the start and end time of the session, and the license edition.

Back to top

Calculate license usage

You can export data on sessions to Excel, and then generate graphs tracking license usage based on sessions.

  1. Access Settings > Site > Sessions.

  2. Make sure all the columns are visible, and in their default order:

  3. Filter Access Type by USER_UI_ACCESS.

  4. Sort by Start Time to show the least recent start time on top.

  5. Click the Export to Excel button .

  6. Open the Excel file, and add a column to the right of the License Edition column named Active Sessions. Your header row should now look like this:

  7. In cell I2, directly under the heading Active Sessions, paste the following formula:

    =COUNTIFS(G$2:G2, ">="&A2)+COUNTBLANK( G$2:G2)

    The Active Sessions column now shows the number of sessions that are active at every given session start time.

    Note: In this formula, column A represents Start time and column G represents End time. The formula assumes that you have followed the previous steps, and now have all the columns as displayed above. If you change the order of the columns or remove columns, you need an understanding of Excel to modify the formula accordingly. For example, if you move Start time to column F, you would change the formula to
    =COUNTIFS(G$2:G2, ">="&F2)+COUNTBLANK( G$2:G2)

  8. Select the Start time and Active Sessions columns, using Ctrl-click for multiple selection.

  9. In the Excel toolbar, select Insert > Recommended Charts. Generate one of the following graphs: Scatter with smooth lines for ongoing data, or Clustered Bar Chart to see maximum usage per day. Here's an example of a scatter chart:

Back to top

Share licenses with ALM or Quality Center

You can allocate licenses from ALM Edition or Quality Center Enterprise Edition to ALM Octane.

After allocating licenses you can change the allocation dynamically. If you need more licenses in ALM Octane, you can allocate more from ALM or Quality Center. If you need fewer in ALM Octane, you can reduce the number of licenses allocated.

License sharing is supported for concurrent licenses only.

Supported ALM, QC, and ALM Octane editions

For details on supported ALM and QC versions, see Installation, setup, and synchronization.

You can allocate licenses as follows:

  • ALM (ALM.Net) Edition to ALM Octane Enterprise Edition

  • Quality Center (QC) Enterprise Edition to ALM Octane Pro Edition

For details about Enterprise and Pro capabilities, see ALM Octane editions.

Step 1: Perform the following in ALM or QC site administration:

  1. Define an integration user and password to be used for the license integration. You can either create a new user, or use an existing integration user. The user must have Viewer permissions.

  2. Create a dedicated project which will be used for the integration only.

  3. Assign the above user to this project.

  4. Define a new site parameter: OCTANE_INTEGRATION_PROJECT_NAME. Assign the value: <domain name>/<project name>.

  5. Allocate a number of ALM or QC full licenses to the project:

    1. In the Licenses > License Assignments tab, locate the integration project.

      At the bottom of the tab you can see how many licenses are available, which means the number of licenses that are not yet assigned to a project.

    2. In the Full License column, type the number of licenses you want to allocate from ALM or QC to ALM Octane, and click Save.

      The license allocation is done out of the available quota in the licenses pool.

Note: To enable license sharing, you need to set up a connection between the ALM Octane server and the ALM or QC server. If there is a Forward proxy server between the systems that requires authentication, license sharing cannot be configured.

Step 2: Define the following in the ALM Octane octane.yml file:

  1. Open the /opt/octane/conf/octane.yml configuration file (in Windows: C:\octane\conf\octane.yml) and locate the license section. Change the value of mode to almSharing.

    For details on how to work with the octane.yml file, refer to the ALM Octane Installation Guide.

  2. In the almSharing section, define the following:

    • url. Enter the full path that you use to access ALM or QC .

    • almIntegrationUser. Enter the user that you defined in ALM or QC for the integration.

    • almIntegrationPassword. Enter the password for the above user. This password is automatically encrypted after you restart the ALM Octane server.

      Note: If you are using an LDAP user in ALM or QC whose password changes periodically, you will need to regularly update the password here to maintain license sharing.

  3. Restart ALM Octane. ALM Octane is now updated with the allocated licenses.

If there is a connectivity problem such as network issues or changes to user or password, an email is sent to the ALM Octane administrator describing the problem. Details are written to site.log. Users will be able to log in to ALM Octane for a limited time, enabling you to fix the problem before access is blocked.

If you add licenses to the designated project in ALM or QC , ALM Octane can take up to 3 hours to update the license allocation.

Back to top

See also: