License Logging

<< Click to Display Table of Contents >>

Navigation:  Administration and Configuration > Licensing >

License Logging

License Lease

License Record Locations

Usage Reporting

 

EQuIS tracks usage history for all products that use Network Licenses. To see a list of who is currently using network licenses, click Registration in the EQuIS Professional backstage to display the Registration tab. 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. Access this information any time by opening the Registration Form from EQuIS Professional.

 

This information is also saved in the ST_LICENSE_USE table and includes the fields listed below.

APP_ID is the webkey identifier for the product.

WORKSTATION is the workstation used to consume the license. It is a concatenation of the computer name environment variable, the CPU ID, the volume serial number of the first hard drive, and the network MAC address.

USER_NAME is the database login name used when acquiring the license, and reflects the connection type used when first opening EQuIS.

oFor Windows Authentication, the user name is the Windows Login.

oFor SQL Authentication, the name is the Database Management System login name.

oFor Application Level Security, the name is the value of ST_USER.USERNAME from the database the user connected to when starting EQuIS.

oIn the case of a master license server, it could be the credentials used to connect to the license database as stored in another EQuIS database's ST_LICENSE table.

LICENSE_CHECKED_OUT is the date and time that the record was created. The time is given in Coordinated Universal Time (UTC).

LICENSE_EXPIRES

oFor Professional licenses, this field is populated after five minutes on database query with an expiration date that is approximately 15 minutes in the future. The LICENSE_EXPIRES is set to the current date and time upon successful termination of a session. Values set in the future indicate current leases, while expiration dates in the past represent historical usage data. Since expiration dates are automatically set to 15 minutes in the future, session duration is accurate to within 15 minutes, even in the event of power failure or loss of network.

oFor Enterprise licenses, this field populates with a date expiring 30 years in the future (or until user is disabled or deleted through the User Manager Widget).

CHECKSUM is used to determine if the license use record was modified while the license was checked out.

 

License Lease

 

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 User 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 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..."

 

License Record Locations

 

The useNetworkLicenses setting for different licensing modes is configured via the EQuIS Professional installation’s EQuIS.exe.config file, as documented in Change Licensing Mode. License use is recorded differently for each of the modes as detailed in the table below.

 

Licensing Mode

License Source

License Use Logging

Username Logged

Registration Pane Display

useNetwork-Licenses = "True" (no license database)

Active database

ST_LICENSE_USE table in the active database

Depending on login type, ST_LICENSE_USE.USER_NAME records:

a) Enterprise username

b) SQL account login

c) Windows domain and user name
(e.g. DOMAIN\USER_NAME)

 

These will have corresponding records in ST_USER (B and, depending on setup, C will have STATUS_FLAG=R).

Network licenses for that database, plus any existing Workstation licenses

useNetwork-Licenses = "True" (with license database)

License database (which may be a different EQuIS database)

ST_LICENSE_USE table in the license database

As above. The license database will maintain a separate record for that user in its ST_USER table.

Network licenses for that license database plus any existing Workstation licenses

useNetwork-Licenses = "False"

Local/workstation licenses

None

N/A

Only Workstation Licenses tab populates

useNetwork-Licenses = "Config"

Database specified in the configured Connection String

ST_LICENSE_USE table in the database specified in the connection string

The Windows' username, without domain (e.g. USER_NAME)

Network licenses for the database in the connection string plus any existing Workstation licenses

 

Linking to license databases works similarly to the useNetworkLicenses="Config" mode.

 

Tables for license databases used with EQuIS Online will not necessarily be visible to clients. To check license usage, use the reporting methods described in the following section, or contact EarthSoft Support for assistance.

 

Usage Reporting

 

Two reports are available to EQuIS administrators to track how and when users access a database:

1.License Use – Queries the ST_LICENSE_USE table for that database or, if it exists, the license database.

2.User Activity – Queries the ST_USAGE table for that database.

 

The Active Client Access License model used in EQuIS Enterprise, EQuIS Collect, and EQuIS REST API checks out licenses using one record per user, which expires decades later. Consequently, the License Use report may not provide all the information required for ACAL usage. Run the User Activity report for this information.