Skip to main content

License

When you purchase ConSol CM, you receive a license file valid for the purchased modules and the required number of concurrent users. The license file is a text file which contains entries for several modules. For each module, the number of concurrent users and the expiration date is indicated.

The license always refers to concurrent users. This means that only the number of users who are logged in simultaneously is considered. It is not checked which users are logged in. Therefore, you do not need one license for each user.

A license is consumed when the user logs in. The license is handed back to the server when the user session is terminated, either because the user logs out or because the session times out (see cmas-core-server, server.session.timeout). You can see the active sessions on the Sessions page of the Web Admin Suite.

Available settings for licenses​

The license file has the following sections:

  • [ADDONS]: The ConSol CM add-ons, e.g. CM/EBIA, CM/Resource Pool, which can be used.
  • [CONCURRENT_USERS]: The number of user who can log in to the Web Client at the same time.
  • [REST_USERS]: The number of users who can access the REST API. This does not include the number of CM/Track users. CM/Phone consumes one REST licenses per client where CM/Phone is installed and active.
  • [TRACK]: The number of contacts who can log in to CM/Track at the same time.
  • [TRACK_USERS]: The number of user profiles for CM/Track. This is the number of users who are created as Portal profile on the Users page of the Web Admin Suite.
Licensing in CM/Track

Since several contacts can use the same user profile in CM/Track, the license numbers of [TRACK] and [TRACK_USERS] might differ considerably. For example, there might be two CM/Track profiles, but 100 contacts should be allowed to log in to CM/Track at the same time. This would mean 2 [TRACK_USERS] licenses and 100 [TRACK] licenses.

Each license section has the following data:

  • contractParty: The name of the customer who owns the license.
  • products: The ConSol CM module to which the license refers.
  • version: The ConSol CM version for which the license is valid.
  • expirationDate: The date when the license expires.
  • licenses: The number of licenses for the respective module.
  • enabledModules: Only for the module [ADDONS]. The names of the purchased add-ons, e.g. RESOURCE_POOL if CM/Resource Pool has been purchased.
  • signature: The license code.

Basic tasks​

The license is managed on the License page of the Web Admin Suite.

Importing a new license​

You can import a new license in two ways:

  • Click the Import license button and select the license file. Click the Save license button.
  • Open the license file in a text editor and paste the license text into the license editor in the Web Admin Suite. Click the Save license button.

The new license takes effect immediately. There is no downtime required.

Advanced tasks​

Monitoring the license​

You can use the monitoring endpoint (see Monitoring) to check the license status.

  1. Open <CM URL>/health/check or <CM URL>/health/report.
  2. Locate the section cmas-core-server-licence:
  • The daysUntilNextExpiry attribute indicates the number of days until the first license expires.
  • The statistics attribute lists all license pools with the number of purchased licenses (all licences) and the number of currently used licenses (consumed licences).
Licenses in the Web Client

To determine the number of users who are logged in to the Web Client, check the pool CONCURRENT_USERS.

Alternatives for license monitoring

The following alternatives for license monitoring exist:

Log files​

The message which is written to the log files when a user logs in or out contains the name of the client. For the Web Client, it also shows the number of licenses which are currently in use.

Example 1: User logs in to the Web Client

2022-12-19 11:18:25,069 INFO [ sessionTimeoutEngineerLogger] [-authentication-] New session for engineer: webadmin and client: WEB_CLIENT has started. Session id: b0a95ce1-4172-4534-a95c-e14172e534fc. (Licenses in use: 1)

Example 2: User logs out from the Web Client

2022-12-19 11:19:05,382 INFO [ sessionTimeoutEngineerLogger] [webadmin-welcome-b0a95ce1-4172-4534-a95c-e14172e534fc] Session of engineer: webadmin and client: WEB_CLIENT has ended. Reason: logout. Session id: b0a95ce1-4172-4534-a95c-e14172e534fc. (Licenses in use: 0)

Database queries​

The sessions are saved in the database table cmas_user_session. The following statements return the number of licenses in use.

Example 1: Web Client sessions, CM version 6.10

SELECT count(auth_username) FROM cmas_user_session WHERE end_date = 0 and session_source = 'WEB_CLIENT';

Example 2: CM/Track sessions, CM version 6.10

SELECT count(*) FROM cmas_user_session WHERE end_date = 0 and session_type = 'CUSTOMER';

MBeans​

The ConSol CM licenses can also be queried using the MBean licenseDeployer. Three methods are available:

  • getRemainingDays
  • deployLicence
  • getLicenseInfo