Keywords: Enterprise licenses, registration, license keys, per core, per processor, active client access license, network license
Applies To: EQuIS Enterprise v6+
EQuIS Enterprise supports two internal end use perpetual licensing models, (Per Core License and Active Client Access License (ACAL)). This article explains each of the two licensing models and provides information about configuring licenses within EQuIS Enterprise. Both of these licensing models are available to customers for internal end user licensing (EULA) as perpetual licenses or term subscription licenses. External users must be licensed via Viewer License Agreement (VLA) or Service Provider License Agreement (SPLA). Contact firstname.lastname@example.org for more information.
Both types of licenses may be viewed, added or removed using the Software Registration tool, which is typically installed at C:\Program Files\EarthSoft\Enterprise6\bin\Register.exe. Alternatively, access the Software Registration tool within EQuIS Professional (if installed on the EQuIS Enterprise server), by clicking the application menu button, and then Register.
Per Core License
Per Core licenses are based on the number of cores in the server where the EQuIS application/database is running and are licensed for the physical or virtual machine. This license model places no restrictions on the number of instances or quantity of users. Depending on hardware configuration, network infrastructure, and other considerations, each core has a practical limit of simultaneous users that can be adequately served. While the license would allow, it is not possible to adequately serve an unlimited number of internal end users, for example, a million users with a single core server.
A Per Core license is unique to the machine on which it is used, and can be used with as many instances of the EQuIS application/database as desired, as long as they are all on the same machine.
If you put instances of the EQuIS application/database on different machines (whether physical or virtual), then each machine must have a valid Per Core license.
All cores in the machine must be licensed with a minimum of 4 cores per machine (see Microsoft SQL Server 2012 Licensing Reference Guide). This license model is required to support the use of EQuIS Enterprise 6 Public Viewer Licenses.
Per Core licenses can be viewed, added, or removed using the Workstation Licenses tab of the Software Registration tool (in this case "Workstation" refers to the server machine where the Software Registration tool is running). When requesting a Per Core license key, make sure to:
- Enter the Computer ID from the Workstation Licenses tab (the Computer ID is a numeric value between 8-12 digits long that is unique to your machine, e.g. 1851063450).
- Select Register Local License as the License Type.
Per Core licenses may require additional configuration in order to ensure that the EQuIS Enterprise web application can read/write to the location where the licenses are stored. The Workstation Licenses tab shows the path to the local machine license file (e.g. C:\ProgramData\EarthSoft\EQuIS.exe.config). Ensure that the user account being used as the EQuIS Enterprise Application Pool identity has read/write permissions to the local machine license file. The user may need to use either of the following methods to configure permissions:
Method 1: Change Application Pool Identity
The simplest method of granting the permissions necessary to use Per Core licenses, is to change the IIS Application Pool to use an account that already has sufficient permissions (e.g. LocalSystem)
Method 2: Grant Permissions to ApplicationPoolIdentity
By default, application pools in IIS 7+ run under the ApplicationPoolIdentity virtual account. You cannot grant file/folder permissions directly to the ApplicationPoolIdentity account, because it is not an actual user account. Follow these instructions to grant the necessary permissions:
- Open Windows Explorer
- Browse to C:\ProgramData
- Right-click the EarthSoft folder and select Properties
- Select the Security tab
- Click the Edit button
- Click the Add button
- Click the Locations button and make sure the local machine is selected
Enter IIS AppPool\Enterprise6 in the Enter the object names to select box
(change Enterprise6 to your application pool name, if different)
- Click the Check Names button
- Click the OK button
Active Client Access License
Active Client Access Licenses are based on the number of EQuIS Enterprise 6 Servers plus a specific quantity of ACAL in the configuration (Server +"X" ACAL licensing). You may only have the total number of ACAL allowed by your license and both the number of Enterprise 6 Servers, and the total quantity of ACAL must be licensed. This is usually the most appropriate license model for confidential database operations and is typically less expensive. This license model supports use of the EQuIS Enterprise 6 Pay Per User Viewer Licenses.
The Server license permits installation of as many instances of EQuIS Enterprise 6 on the licensed OSE (operating system environment) as desired. For example, a 3 Server 100 ACAL EQuIS Enterprise 6 License supports 3 discreet OSE's (each of which may include multiple instances of Enterprise 6) for up to 100 named users (may be centrally authenticated).
Active Client Access is not the same as a "concurrent user" in EQuIS Professional. Active Client Access is any user who has an active user account (i.e. ST_USER.STATUS_FLAG = 'A') regardless of when or how often that user uses the application. An Active Client Access License does not restrict the number of users; it does not matter if all, some or none of the active users are logged in simultaneously. The active user account requires an Active Client Access License as long as that account is active (i.e. the user has permission to login and use the application). If the user account is deactivated (by an Administrator), the license is released and becomes available to activate a new/different user. The previously active user can no longer log in, and is unable to use the application.
An Active Client Access License is unique to the user; he/she may login from any device at any time and use the same license. A single Active Client Access License may be used across multiple EQuIS databases if both of the following conditions are true:
- all of the EQuIS databases point to the same license server
- the user name (ST_USER.USER_NAME) and email address (ST_USER.EMAIL_ADDRESS) are exactly the same in each EQuIS database
Active Client Access Licenses can be viewed, added, or removed using the Network Licenses tab of the Software Registration tool (in this case "Network" refers to the server/database that the Software Registration tool is connected to). When requesting an Active Client Access License key, make sure to:
- Enter the Server ID from the Network Licenses tab (the Server ID is a numeric value between 20-80 digits long that is unique to your server/database, e.g. 1101256521412324323422116918267129161928814).
- Select EQuIS Enterprise 6 on the registration page.
- Select Register Network [Number of Users] as the License Type.
- Enter the number of active users you are requesting in the Number box.
The EQuIS Enterprise 6 Systems Administrator (SA) authorizes individual named users, assigns login credentials, user roles and permissions in the EQuIS user table by setting the user status flag to "Active." That user will then consume 1 ACAL of the Enterprise 6 license, regardless of actual login activity. The SA may set up to, but no more than "X" user status flags to "Active" at any given time. The SA may turn a user to inactive simply by unchecking the "Active" status flag, and the inactivated user will not be able to login. The number of Active Client Access users may not exceed the license ACAL quantity; also, the number of inactive users may not exceed the license ACAL quantity. When the SA activates the login permission for a named user, that user may also connect to the database using EQuIS Professional and Application Level Security.
Existing Users in Upgraded Database
A database that is upgraded from EQuIS Enterprise 5 to EQuIS Enterprise 6 may have existing active users. Applying an Active Client Access License during the upgrade process will not automatically consume a license for each active user that already exists. To ensure the appropriate access for current users:
- Review ST_USER and set STATUS_FLAG=A for each user to be designated an Active Client Access License. Ensure all other (inactive) users have a STATUS_FLAG value other than 'A'.
A = Approved/Active Client Access
B = Pending account requests
C = Inactive users that only receive email notifications
D = Disabled through user interface
R = Manually disabled and may need review
- In the Enterprise 6 User Manager Widget, review/revise each user profile and save with a Status set to 'Active' or 'Inactive' as appropriate. For more information, see the article, Widget - User Manager.
If the steps above are not taken, licenses will be consumed and assigned to each user when the user logs into the application. The licenses will be assigned to users in the order they are designated and/or through their login. If you have more active users than your license key allows for, then some of those users may not be able to login when all of the licenses have been consumed by other users.