Licensing

Cadmatic License Server handles allocating of licenses to Cadmatic eShare. The license types vary by application. The eShare server monitors license usage and availability, and eShare system administrator can customize license configuration and distribution.

eShare license types

  • eShare Server license – License required for eShare server to operate. If server license is invalid or missing, users cannot generally access the system and a "No license" page is shown. See Server, REST API, and eMerge licenses.

  • User licenses – These licenses determine how individual users can access eShare. There are two types of user licenses:

    • Named licenses ("eShare User") – Each license is assigned to a specific user account. See Named user licenses.

    • Floating licenses ("eShare Client") – A pool of licenses is shared by a larger group of users. See Floating user licenses.

  • REST API license – A specific license required for third party integrations and to access public REST API endpoints (for example /api/public/v1/...). Standard user licensing rules also apply to the user account making the API call. See Server, REST API, and eMerge licenses.

  • eMerge license – A license required for using model importers. If more than one model is used or model importer settings are changed, this license is required. eMerge license is usually supplied together with eShare server license. See Server, REST API, and eMerge licenses.

  • eGo licenses – Device-specific licenses for eGo clients. See eGo licensing.

  • OCR license – License for using cloud-based OCR functionality in eShare.

Note that all eShare licenses (excluding eGo device licenses) are acquired by eShare server and not by the client. This differs from other Cadmatic products where the client itself acquires the licenses.

The system also supports associating licenses with specific groups of users using License groups. See License groups.

Server, REST API, and eMerge licenses

eShare monitors the server and REST API licenses periodically. If the server license is not available, users are not allowed to start eShare sessions.

eMerge license is checked when a model is published.

The address used for checking these licenses is configured in Cadmatic.LicenseServer in Internet Information Settings (IIS) Manager application settings. See Cadmatic.LicenseServer.

Named user licenses

When named licenses are used, a new eShare user automatically gets a user license and can sign in to the system. The server configuration in Cadmatic.MaxNumberOfUserLicenses in Internet Information Settings (IIS) Manager application settings sets a limit for the total number or licenses that can be assigned, i.e. the maximum number of users that can be enabled at the same time. Each enabled user uses one license.

Normally users can remain signed in and keep holding the license as long as needed. Inactivity and timeouts do not affect named licenses. However, eShare performs regular status check on active named users, and if more users have a license than the license server allows, the system starts deactivating non-administrative user accounts, in reverse alphabetical order. If deactivating all normal users does not release enough licenses the server starts deactivating system administrators.

Server options

These settings are configured in Internet Information Settings (IIS) Manager application settings. See Configuring application settings.

  • Cadmatic.LicenseServer – License server address used for checking the license.

  • Cadmatic.UserLicenseType – Set to 0 to use named licenses.

  • Cadmatic.MaxNumberOfUserLicenses – Guides the total number of named licenses that can be assigned, requires license server validation.

Floating user licenses

When floating user licenses are used, a pool of licenses is shared across all users. Creating a new eShare user does not yet allocate a license to that user. When the user logs in the eShare server requests a license from the license server for the user's session, and when the user closes the browser or application, the license is returned to the license pool, becoming available to other users. This means that, unlike with named licenses, users can be enabled and disabled independently of the total number of licenses. The maximum number of licenses is specified by Cadmatic.MaxNumberOfUserLicenses in Internet Information Settings (IIS) Manager application settings.

If all licenses are already in use when a user tries to sign in, the following happens:

  • If the user trying to sign in is a normal user, the login attempt fails and "No license" page is shown.

  • If the user trying to sign in is a system administrator, a list of active users is displayed for selecting which user's session to terminate. The list also shows when each user was last seen and last active in eShare. Last seen means that the user had eShare open and last active means that the user did something actively in eShare.

If a floating license user closes eShare, the session is marked inactive after a 3-minute timeout after which the license is returned to the license pool. If the same user returns later, the session continues if there are licenses available.

If the user is inactive for the duration specified in Cadmatic.FloatingLicenseTimeout, the license is returned to the license pool. Once the user is active again, the session continues if there are licenses available. The default value is 45 minutes.

If the number of available floating licenses is reduced while users are active, eShare starts reclaiming licenses from active sessions by non-administrative users, starting from the least recently active first, to match the new lower license limit.

Server options

These settings are configured in Internet Information Settings (IIS) Manager application settings. See Configuring application settings.

  • Cadmatic.LicenseServer – License server address used for checking the license.

  • Cadmatic.UserLicenseType – Set to 1 to use floating licenses.

  • Cadmatic.MaxNumberOfUserLicenses – Guides the total number of concurrent floating licenses that can be assigned, requires license server validation.

  • Cadmatic.FloatingLicenseTimeout (Value in minutes) – Specifies how long a floating license can be idle before it is returned to the license pool. The default value is 45 minutes, the minimum is 5 minutes. If set to 0, the floating licenses are not reclaimed due to idleness.

eGo licensing

eGo licensing consists of two parts: licensing of the eGo application and licensing of the eShare connection.

eGo device licenses

Using eGo always requires a device-specific license. The device-specific licenses are acquired by entering an activation code, which is used to contact Cadmatic servers and request a license for the device. Once a license has been activated for a device, it can be only released by the license team at Cadmatic, for example, in case the device breaks.

The same activation code may be valid for requesting licenses for multiple devices. For example, one activation code could be used to activate eGo in 20 devices, depending on the number of purchased licenses. Although the activation code is the same, each of the devices receive their own device-specific license.

The activation code can be entered in the eGo application or passed as a parameter during installation. The activation code can also be entered in eShare in System Administration > Devices, which enables activating it for multiple devices at once. See Devices.

For the eGo license to remain valid, eGo must check with the licensing servers at least every 30 days.

eGo-eShare licensing

Using eGo with eShare requires an eShare user license, the same way as using eShare in the browser or eShare App does. It does not require any configuration and if a user can access eShare (browser or eShare App), they have access to eShare from eGo as well.

When eGo is connected to eShare, it uses one named or floating eShare license depending on the configuration. It is allowed for the same user to use eGo and eShare at the same time and it does not require any additional licenses.

License groups

Assigning users to different license groups allows different user groups to use different license server configurations. For example, it can be used to limit how many user licenses a subcontractor may acquire or enable connecting to more than one license server.

When no groups are defined, all users are in the “default” group, which respects the license configuration in Internet Information Settings (IIS) Manager application settings, as described in Named user licenses and Floating user licenses. License groups can be created in eShare in System Administration > Licenses and each license group overrides the user license application settings in IIS Manager for its assigned groups. See Licenses.

From the license server's point of view, each license group acts like a separate eShare server requesting separate user licenses. Each user can only be assigned to one license group at a time, and if that license group is out of licenses, the user is denied access. Any single user is always assigned to the same license pool regardless of whether licenses are available or not.

System administrators are always assigned to the “default” license group – otherwise changing settings could lock them out of the system.

Common licensing errors

Error

Description

"No License" or "User Deactivated" on login

The user logs in but faces a "no license" or "user deactivated" page.

  • Server license is missing: The server license may be missing, disabled, or the license server is down.

  • Named license user is disabled: User account does not have a license assigned as their account has been deactivated. This results in a "user deactivated" or "no license" page.

  • There are no floating licenses available: The maximum number of floating licenses allowed by the license server has been reached. Results in a "no license" page.

"No License" after being idle (floating user license) The user's floating license has been released to the license server due to configured floating license timeout. Once the user is active again but there are no available licenses, "no license" page is shown.

"Session Terminated"

Can occur for any user (named or floating license) due to attempting to use eShare on multiple computers or browser at the same time.

Multiple tabs on the same browser are not considered multiple sessions and will not result in termination of the session.

Special cases

  • OCR License – OCR is performed using a service hosted in Cadmatic Cloud.

  • eGo sessions – eGo sessions exist in parallel to eShare sessions, and a user can have both sessions open at the same time. The same rules apply to both sessions.

  • Service sessions – Plant Modeller/Service account sessions. These can exist parallel to eShare sessions and do not take a license, but are limited to specific endpoints.

  • System administrators – System administrators are always a part of the main user license group to prevent invalid license group configurations from blocking access to the system.