$LICENSE_OPTIONS (DLM)

Set one or more license management options for Uniface Distributed License Manager (DLM) licenses.

$LICENSE_OPTIONS {=} Option{, Option}n

where Option is one of:

Note: To configure license management options for a Sentinel license, see $LICENSE_OPTIONS.

Defaults

Assignment file: application assignment files
Section: [SETTINGS]
Default value: None

Description

Although Uniface makes use of the Sentinel Rights Management System (RMS) to manage licensing, existing Uniface Enterprise Edition users can continue use the Uniface Distributed License Manager (DLM). Contact your Uniface representative for details.

If no options are specified by $LICENSE_OPTIONS, Uniface tries to load the DLM library from the Uniface installation and check out a license.

If specified, $LICENSE_OPTIONS overrides the similar setting (except HEARTBEAT_INTERVAL) specified in the DLM. The DLM appends the setting to its license configuration file.

For more information on functionality for redundant or multiple license servers, see the DLM License Installation Guide.

License Expiry Notifications

30 days before a license expires, Uniface starts sending warning messages about the upcoming expiration:

  • License for feature FeatureName will expire in nn days.
  • License for feature FeatureName expires today.

By default, these messages are displayed in a dialog box and transcript window (in a desktop application), or in the application's log file.

You can set the length of the notification period for the notification message and the transcript window, or even suppress these messages, using the LM_NOTIFICATION and LM_TRANSCRIPT options. For example:

$LICENSE_OPTIONS=LM_LICENSE_FILE=D:\MyLicenses\myUnifaceLicense.xml, LM_NOTIFICATION=15, LM_TRANSCRIPT=15

If set to 0, no warning messages are sent.

You can customize the messages and the way they are displayed by defining this behavior in the receiveMessage trigger of the application. To instruct Uniface to redirect the notification message to this trigger, set the option LM_NOTIFICATION_POSTMESSAGE. This sends the message as an asynchronous message (postmessage) instead of displaying it in a dialog box.

Options

This option specifies the location of a license.

The license locations can include a local license file, one or more license servers, or both:

LM_LICENSE_FILE = {LicenseServers } {;LicenseFile }

  • LicenseServers —list of license servers in the format Port@Host{#4|#6}, separated by semi-colons. For example:

    7188@license1.mycomp.corp;7288@license2.mycomp.corp.

    You can optionally specify the IP version of the license server as Port@Host#4 for IPv4 or Port@Host#6 for IPv6. If the IP version is omitted, the client tries to connect with the license server over IPv4 first, and if that fails over IPv6. If the license server listens on IPv6, adding #6 ensures that a connection is made one or two seconds faster because no attempt is made to first try IPv4. The faster connection could be important for Uniface Servers.

  • LicenseFile —local license file.

This option displays a license expiration message in the transcript window (and log file), starting the NumberOfDays before the date the license expires.

LM_TRANSCRIPT=NumberOfDays

NumberOfDays—any value from 0 (license expiration message is never displayed) through to 100.

If omitted or set to a value less than 0, the default value of 30 is used. If set to a value greater than 100, the maximum value of 100 is used. Any other value generates an error message and informs the user that the value will be set to the default.

This option determines the notification period before a Uniface license expires. During this period, Uniface displays a notification message in a dialog box every time the application is started (unless this option is set to 0 or LM_NOTIFY_EXPIRATION=postmessage).

LM_NOTIFICATION=NumberOfDays

NumberOfDays—any value from 0 (license expiration message is never displayed) through to 100. If omitted or set to a value less than 0, the default value of 30 is used. If set to a value greater than 100, the maximum value of 100 is used. Any other value generates an error message and informs the user that the value will be set to the default.

If specified, this option suppresses the default message and sends an asynchronous message to the Uniface application, enabling it to provide customized handling of the expiration notice.

LM_NOTIFICATION_POSTMESSAGE{=T | true | Y | yes | 1 }

The message that is sent has the following properties:

  • $msgsrc: "UNIFACE"
  • $msgid: "LICENSING"
  • $msgdata:UnifaceList

The UnifaceList contains the following items:

  • LICMGR—license manager used: DLM or Sentinel.
  • FEATURE—license feature abbreviation, for example UDE.
  • REASON—reason for the message: license, lease, version.
  • DAYSLEFT—the number of days that the feature is still valid (license).

This option specifies the license manager DLL to be loaded. By default, this is the DLM library in the Uniface installation.

You can specify the order in which to try loading license manager DLLs. Once a license has been successfully checked out, all subsequent licenses will only be checked out from the same license manager.

LM_LOAD={?} {U} {D} | {uniface | dlm}

  • ?—if a license cannot be checked out using the first DLL, Uniface will unload the DLL and try to load the next DLL and check out a license. Must be specified before the letters.
  • U—DLM library in Uniface installation
  • D—DLM library in DLM installation
  • uniface | ?UD—try loading DLM from the Uniface installation first.
  • dlm | ?DU—try loading DLM from the DLM installation first.

If you are using DLM, you must explicitly provide a value.

Specifying a single letter fixes the license manager to the specified DLL. No other will be used, even if loading the DLL or checking out a license fails.

For DLM, specifying multiple single-letter values, enables you to set a load order when using ?; for example ?DU to try loading the DLL from the DLM installation, and if that fails, to try DLM from the Uniface installation.

This option specifies the frequency with which a client application notifies the DLM license server that a license is still in use. The interval can be from 15 to 300 seconds. If not set, the default is 300.

HEARTBEAT_INTERVAL=Seconds

When using a DLM license server, the Uniface application notifies the license server at regular intervals that checked-out features are still in use. This is known as the heartbeat. If a heartbeat notification is not received by the license server within that time, it checks in (returns) the license, making it available for other applications.

Setting it to a shorter interval enables an application to be restarted more quickly if it crashes, but increases the network and server load.

Note: Although you can use $LICENSE_OPTIONS to set the HEARTBEAT_INTERVAL in the Uniface application's assignment file, you should do this only if you have multiple Uniface applications and you do not want all of them to use the same heartbeat interval.

You can set the heartbeat interval for all Uniface applications in the DLM client's config.xml file. For more information, consult the DLM documentation.