License Server Features
Copyright © 2019 EarthSoft, Inc • Modified: 04 Mar 2019
Network Licenses for EQuIS Professional products are saved in the database table ST_LICENSE. This table stores the product code, encrypted key string, product name, and also supports links to External License Database. The keys stored in this table are in many instances identical to keys issued by EarthSoft. EarthSoft recommends that you do not save keys to the ST_LICENSE table manually, unless instructed to do so by EarthSoft. Keys should always be applied through the registration form in EQuIS Professional.
Please note that the Network ID string is much longer than the Computer ID used for Workstation licenses. Network ID strings are a hash code generated from the server name and database name as reported by the database server. As such, keys are tied to a particular database. If that database is moved to another server, then the Network ID will change, invalidating all existing keys. Plan accordingly when moving or renaming database servers.
When a network license is checked out, the user is said to acquire a license lease. Leases are issued when the number of held leases is less than the maximum number of concurrent use licenses available. Those values are displayed on the registration form. Each lease is issued for a 15 minute period. EQuIS Professional products will automatically renew their lease before that expiration period is reached. If for any reason the lease is not renewed, the license becomes available for other users.
When EQuIS renews its product leases, it verifies their authenticity. If the authentication fails, EQuIS releases the lease and attempts to acquire a new lease. If no licenses are available at that time, the Evaluation Form is displayed with the message "Failed to acquire license". If EQuIS cannot renew the lease because of trouble connecting to the database server, a warning message is displayed. The message informs the user that EQuIS will automatically exit if it cannot renew the lease within the subsequent 15 minutes.
If a user cannot acquire a lease for a Network License, the Evaluation Form is displayed with the name of the product for which the lease failed and the message "All concurrent licenses are in use..." To see a list of who is currently using network licenses, click Register to display the Registration Form. Select Network License and expand the appropriate product detail record by clicking on the [+] character to the left of the product name. The expanded records display the NetBIOS computer name and database login username for each held lease. This information is also available at any time by opening the Registration Form from EQuIS Professional.
Organizations managing several EQuIS Databases may wish to designate one as the Network License Database. Optionally, the Database Administrator may set up a separate Network License Database to manage concurrent licenses for an organization. If License Server linking is enabled with an EQuIS Database, no other keys are used within that database. EQuIS will follow up to five links before it stops searching for a license server. EarthSoft recommends minimizing the number of links to a license server.
To create a link from one EQuIS Database to another database acting as a license server, create a record in ST_LICENSE with the following information.
In the LICENSE_SERVER field, enter a plain text connection string for the server and database acting as a license server.
Open EQuIS Professional and connect to the originating database. Upon successful login, EQuIS will encrypt the connection string and save it back to ST_LICENSE. If Network Licensing is available on the target database, the Server name, Database name, and a new Network ID will be displayed on the registration form. Optionally, set the ST_LICENSE.LICENSE_TITLE to document the link. For example, "Link to database Training on server Primary, SQL Login as Student". If the connection string included a user name and password, that user name is used when checking out a lease.
EQuIS Data Processor (EDP) Standalone edition is designed to be used without the need to log in to an EQuIS Database. Customers wishing to take advantage of Network Licensing may do so by creating an external license database and configuring EDP to use that for licensing. See Creating an External Database here for additional information on setting up the licensing database.
To configure EDP to use the external license database, edit the EDP.exe.config file and change connectionString as appropriate. Change the value of UseNetworkLIcenses to True.
Note: The default value of UseNetworkLicenses is False in EDP.exe.config.
Open EDP and verify that the Server name, Database name, and Network ID are displayed on the Network Licenses tab of the registration form. Register licenses as necessary and exit EDP. Verify that the connecting string in EDP.exe.config is now encrypted. Distribute this copy of EDP.exe.config to all workstations using Network Licensing.
Demo Licenses are issued by EarthSoft to organizations evaluating EQuIS products. Network Demo licenses are typically not issued to evaluators to install. Persons taking part in a pilot study hosted through EQuISOnline.com will likely use Network Demo licenses installed by EarthSoft at the start of the pilot study. Demo licenses differ from regular network licenses in two ways. First, demo licenses have a built in expiration date. At the end of the expiration date, the evaluation form is displayed stating that the evaluation period has expired. Second, Demo licenses do not require maintenance keys. Maintenance is implied for the duration of the evaluation period.
When using concurrent network licenses, EQuIS Professional will consume a license from whichever database it connects to. In certain situations, clients may want to configure EQuIS to use a license from a database other than the database they are connecting to.
Modifying the EQuIS.exe.config (typically at C:\Program Files\<User>\EQuIS) can point EQuIS to a specific license database. The required additions are shown below, using a SQL Server Database and authentication example.
<add name="databaseConnection" connectionString="Data Source=dbserver.User ID=someusername;
<add key="useNetworkLicenses" value="config"/>
Note: Make sure the connection string is in the appropriate format for the database and authentication type, that it points to the database that contains the licenses, and that the provider Name shows the database type.