License Features

<< Click to Display Table of Contents >>

Navigation:  Professional > Licensing >

License Features

License Keys

Network IDs and Server Moves

License Connection String

Change Licensing Mode (useNetworkLicenses Setting)

Trial Licenses



This page describes aspects of EQuIS licensing. Further information on licensing topics is covered on other pages, as well:

License linking and using license databases – License Database

Requesting and applying license keys – Applying Licenses in EQuIS Professional

License usage tracking – License Usage

The Active Client Access License (ACAL) model used in EQuIS Enterprise, EQuIS Collect, and the REST API – Active Client Access Licenses

Deploying ACAL licenses in Enterprise as roles – Applying Licenses in EQuIS Enterprise


Users can access their organization’s EQuIS licenses in several ways, depending on how administrators have set up their database(s), licensing, and EQuIS programs.

1.Network license keys in the logged-in database

2.Network license keys in a separate license database that is linked to the logged-in database. The separate database will either be:

a.Another EQuIS database

b.A standalone license database, only containing a few of the EQuIS tables

3.Network license keys in a database specified within a program configuration file, such as EQuIS.exe.config, via the useNetworkLicenses setting [link to section in this page, “Change Licensing Mode […]”).

4.Local workstation license keys (typically limited to EDGE use or upgrades; may also use the useNetworkLicenses setting)


License Keys


Network Licenses for EQuIS Professional products are saved in the database table ST_LICENSE. This table stores the product code, encrypted key string, and product name. It also supports links to External License Databases.


All Network Keys should be managed through the Registration tab in the EQuIS Professional backstage. See Applying Licenses for instructions. Attempts to manually modify the contents of ST_LICENSE may result in invalid or corrupt keys.


A valid key consists of an APP_ID, KEY_TYPE, and KEY_STRING within ST_LICENSE. The field KEY_TITLE is filled in by the licensed product's proper name upon first use. If the field is null, then this key has never been used, and the Software Registration window will display "Unused License" for this key.


There is no relational constraint between the ST_LICENSE and ST_LICENSE_USE tables. This allows keys to be deleted without losing usage history.


Network IDs and Server Moves


A Network ID string is a hash code generated from the server name and database name as reported by the database server. As such, Network Keys are bound to the Network ID for the database storing the keys. If the database server name (or database name) changes, the Network ID will also change. Any existing keys bound to the old Network ID are rendered invalid. Organizations planning to move or rename their database server should plan accordingly.


EarthSoft recommends the following:

1.Set up the new server.

2.Request that new keys be issued prior to the actual move. This will prevent any loss of productivity during the transition.


License Connection String


When linking to another database’s licenses, either via the database’s ST_LICENSE table (see License Database)  or the user’s EQuIS.exe.config file, a connection string to that database is needed. For complete documentation on creating a connection string, read here. Example connection strings include the following and are case sensitive:


SQL Server with Windows Authentication*

Data Source=dbserver;Integrated Security=SSPI;Database=licensedb;


SQL Server with SQL Authentication

Data Source=dbserver;User ID= LicenseUser;Password=LicensePassword;Database=licensedb;


* only use for EQuIS Enterprise licenses if Windows Authentication is used for the site



Connection strings are case sensitive with SQL Database connections.

Depending on network security, the connection string may need further modification, e.g. a VPN may require that the Fully Qualified Domain Name (FQDN) be used, instead of the server name in the connection string.


Change Licensing Mode (useNetworkLicenses Setting)


The EQuIS.exe.config file is part of the EQuIS installation, typically located in C:\Program Files\EarthSoft\EQuIS or, for per-user installations, %localappdata%\Programs\EarthSoft\EQuIS. Adding the useNetworkLicenses setting to the EQuIS.exe.config file can change the licensing mode to one of the following:

•        True – use network licenses

•        False – use local workstation licenses

•        Config – use network licenses specified in a connection string


The useNetworkLicenses setting is added to the EQuIS.exe.config file as follows. The Config mode also requires an additional section added for a connection string.



    <add key="useNetworkLicense" value="true"/>



If EQuIS Professional is installed to the Program Files, Windows administrator permissions may be required to modify EQuIS.exe.config.


The licensing modes are described below.


useNetworkLicenses = "True"

The network licenses are retrieved directly from the active database (or, if present, their license database). EQuIS uses existing local licenses if the network license is not available.


useNetworkLicenses = "False"

The licenses will be retrieved directly from the local/workstation licenses, saved in the C:\ProgramData\EarthSoft\EQuIS.exe.config file (a separate file with different contents than the EQuIS.exe.config file in the installation folder). Most non-EDGE EQuIS users will not have local licenses.


useNetworkLicenses = "Config"

A connection string to the database (as documented in the previous section) containing the licenses must also be added, such as in the bolded text of the following example. Underlined text indicates information that must be replaced. A connection string that has been previously encrypted by EQuIS Professional may also be used.





 <add name="databaseConnection" connectionString="Data Source=myServer;User ID=LicenseUser;Password=LicensePassword;Database=LicenseDatabase;pooling=true;Connection Timeout=600;" providerName="EarthSoft.Common.Data.SqlConnection" />




The network licenses are retrieved directly from the database specified in the Connection String section of EQuIS.exe.config in the EQuIS installation folder. EQuIS uses existing local licenses if the network license is not available.


If the user has permission to modify the EQuIS Professional EQuIS.exe.config file at run time (may require per-user installation or to Run as Administrator), then a connection string read from there will be encrypted. An example of an encrypted connection string in the EQuIS.exe.config file follows.



 <add name="databaseConnection" connectionString="RWN3ZSVZdn17bXBJcm+BhHlNaId6iDdhXVeAfY+Sh1txg5aXnJWZjGaPjJ" providerName="EarthSoft.Common.Data.SqlConnection" />



This encrypted value represents the current license server connection information. An encrypted connection string may be copied to end user workstations, allowing them to consume EQuIS network licenses from the specified database without compromising any SQL credentials.


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.


Trial Licenses


Trial Licenses are issued by EarthSoft to organizations evaluating EQuIS products. Users taking part in a pilot study or beta may initially use Network Demo licenses installed by EarthSoft. Demo licenses differ from regular network licenses in two ways:

1.Trial 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.

2.Trial licenses do not require maintenance keys. Maintenance is implied for the duration of the evaluation period.


Expired trial licenses may cause issues with database licensing and need removal keys issued by EarthSoft.




Error acquiring license for appID=101 from server (local)\SQLEXPRESS. Exception Message: Warning: Fatal error 9001 occurred at [Date] [time]. Note the error and time, and contact your system administrator.


This is followed by a Registration pop-up window showing that all licenses are available before the program terminates. The error may be caused by a corruption in the *.LDF file or, in some cases, by a virus checker locking the database. To resolve the issue, close all connections to the database, take the database offline, and then restart it.


Error acquiring license for appID=40 from server apc-sql. Exception Message: Object referenced not set to an instance of an object.


This error is typically a result of old licenses left in ST_LICENSE or non-applicable licenses for a different server ID. To resolve this error, delete all rows in the license database ST_LICENSE, except rows pertaining to Custom EDP or EDGE formats, restart Professional and reapply all current, valid keys.


System.Data.SqlClient.SqlException (0x80131904): Invalid object name 'sq_euid'.

 at EarthSoft.Common.Data.Connection.ExecuteScalar(String CommandText)

 at EarthSoft.Common.Data.SqlConnection.NextValue(String sequenceName)

 at EarthSoft.Common.Data.Connection.NewId()

 at EarthSoft.Common.Data.User.CreateUser(Connection Connection)

 at EarthSoft.Common.Data.User.GetUser(Connection Connection)

 at EarthSoft.Common.Data.Facility.Initialize()


Error Number:208,State:1,Class:16


The above error occurs due to an out-of-date license database and may also occur alongside an EQuIS Professional message, "Please register - EQuIS licensing is required but missing or not accessible. Review the EarthSoft Software Registration information and use the links provided to request additional keys as needed." To resolve, follow the Update instructions on the License Database page.