Caché System Administration Guide - InterSystems Documentation

Managing Caché Licensing
You modify how you specify the license user ID using the $SYSTEM.License.UserNameLicensing()
method of the %SYSTEM.License class. By default, Caché uses the client IP address to identify a user
to the license tracking subsystem. If you installed Caché with higher than Minimal initial security
settings, each process has a user ID ($USERNAME). You can call the
$SYSTEM.License.UserNameLicensing() system method to make the Caché license subsystem use
$USERNAME as the license user identifier.
The $SYSTEM.License.UserNameLicensing() method modifies the system state. You can also call
it from SYSTEM^%ZSTART to enable username licensing at instance startup. The method has the
following functions:
• $SYSTEM.License.UserNameLicensing(1) — enables $USERNAME based licensing and returns
the previous state.
• $SYSTEM.License.UserNameLicensing(0) — disables $USERNAME based licensing and returns
the previous state.
• $SYSTEM.License.UserNameLicensing() — returns the current state. May return an error if
called with an argument for license types that use special login rules.
For example, the following displays whether username licensing is currently enabled or disabled:
Write " Username Licensing",!
Write " 1-enabled, 0-disabled",!
Write $SYSTEM.License.UserNameLicensing(),!
The following example enables, then disables username licensing:
Set RC=$SYSTEM.License.UserNameLicensing(1)
Write RC,!
Set RC=$SYSTEM.License.UserNameLicensing(0)
Write RC
See the $USERNAME special variable entry in the Caché ObjectScript Reference for more information.
4.4.3 CSP Connections and Other Special Cases
CSP connections are a special case for logins. InterSystems strongly recommends that CSP applications
use the %CSP.Session equivalent method, %CSP.Session.Login, to identify a user for licensing purposes.
If they do not, the CSP session ID is used as the license user ID. Each session consumes a license
unit, which in many cases is unsuitable. For example, a user can have several browser windows open
concurrently. Alternatively, a user can connect via several pathways (CSP, a terminal window, and a
Caché Direct connection from a Visual Basic client). In this case, you can use the %CSP.Session
method, %CSP.Session.Login(username, password) to perform an explicit license login for the
session.
Any SOAP request in which the user is not identified does not use a license unit because it is considered
a “machine request”; however, any SOAP request that identifies the user requires a license because it
62 Caché System Administration Guide