Automated configuration during installation (Licensing.ini)

The Licensing.ini is a configuration file that empowers administrators to automatically preset the ETAS License Manager (LiMa) settings during the installation of an ETAS product (e.g., INCA).

This process eliminates the need for any individual to manually configure settings like license servers or borrowing options after installation. It simplifies software deployment and ensures that the software operates with the correct license settings from the start.

How the file works

  • Location: For every product that uses electronic licensing, there is a Licensing.ini file in the installer product directory (e.g., ..\Packages\INCA\Licensing.ini).

  • Format: The file is a simple text file using the INI format. All settings belong under the [Licensing] section.

  • Comments: The system ignores any line that begins with a semicolon (;). You can use these lines to add comments.

If the software package is already installed on the machine, the following applies:

Values specified in the .ini file overwrite the existing settings. For example, if the autoborrow function was previously deactivated manually, a corresponding entry in the .ini file reactivates it.

If a parameter is not explicitly set in the .ini file, the current setting remains unchanged. This is the case, for instance, if a new installation is performed over an existing INCA installation, and the new .ini file defines some, but not all, of these parameters.

Key parameters

This section explains the available parameters, The system requires values to be in single quotes (e.g., 'true', '60', 'C:\Temp').

ImmediateBorrow

ImmediateBorrow sets the value to true or false.

EXAMPLE

LicenseFileName

LicenseFileName specifies the path to a license file (.lic). The installer automatically copies this file to the local machine during the installation process.

EXAMPLE

LicensesToBorrow

LicensesToBorrow defines a list of licenses (features) for automatic borrowing. Separate the feature names with spaces.

EXAMPLE

BorrowExpiryMode

BorrowExpiryMode triggers a one-time borrow after installation. The way the end date of a borrow is calculated is defined by the value Interval or Date.

EXAMPLE

(If you use Interval as the value, you need to set the option BorrowExpiryInterval. For more information, see BorrowExpiryInterval.

EXAMPLE

(If you use Interval as the value, you need to set the option BorrowExpiryDate. For more information, see BorrowExpiryDate.

BorrowExpiryInterval

Defines the number of days for a single execution of borrowing. Only valid if BorrowExpiryMode = 'Interval'.

EXAMPLE

BorrowExpiryDate

Defines the end date of the borrowing action. Only valid if BorrowExpiryMode = 'Date'. Format is 'yyyy-mm-dd'.

EXAMPLE

BorrowAutomaticExtensionInterval

BorrowAutomaticExtensionInterval specifies the number of days for the borrowing period (e.g., 60 days), If autoborrow is active (see AutoborrowActive). In the LiMa interface, this corresponds to the Borrow Interval (in Days) column.

EXAMPLE

The value 60 extends the borrowing so the end date is in today + 60 days.

ExecuteBorrowAutomaticExtensionInterval

ExecuteBorrowAutomaticExtensionInterval determines how many days before the borrowing period expires the system attempts to automatically renew the license for another interval, If autoborrow is active (see AutoborrowActive). In the LiMa interface, this corresponds to the Renewal Period (in Days) column.

EXAMPLE

AutoborrowActive

AutoborrowActive defines if the autoborrow mode is active ('true') or inactive ('false'). The values defined in BorrowAutomaticExtensionInterval and ExecuteBorrowAutomaticExtensionInterval specify the detailed behavior.

AutoborrowCutterActive

In case the Flexera License server forgets borrowed entries, the so called cutter is raised in interactive mode. A pop up dialog occurs, where you are is asked if you want to remove the borrow item from registry. In case of an automated mode like autoborrow, this interactive mode is not wanted.

To handle this situation automatically, set AutoborrowCutterActive = 'true' in the Licensing.ini file.

When this parameter is active, the system will automatically handle the specific license server error (-124). Instead of displaying a pop-up, it silently removes the invalid borrow entry from the registry in the background. This cleanup allows the autoborrow process to proceed without interruption and successfully borrow a new license.

CustomLicenseFolder

CustomLicenseFolder defines a custom folder where LiMa searchs for license files.

EXAMPLE

Ports

The LiMaServer.exe process listens for connections on port 32200 by default. Because license borrowing is a user-specific action, the system launches a separate LiMaServer instance for each active account rather than running it as a single system service.

To support multiple concurrent sessions on the same machine, for example, when a build agent like Jenkins runs in parallel with an interactive desktop session, you can define a range of available ports.

During Installation, specify the ports in the Licensing.ini file using a space-separated list:

EXAMPLE

If additional ports are not explicitly defined, LiMa will automatically search for the next available port for any subsequent instances.

You can modify the port configuration directly in the Windows Registry after installation.

  1. Open the Windows Registry.

  2. Navigate to the LiMa key under Wow6432Node.

  3. Create or modify the string value named Ports.

  4. Enter the port numbers separated by a semicolon (e.g., 32200;32201;32202).

ActivationIdentifiers

ActivationIdentifiers specifies the license activation during the installation for licenses based on FlexNet Embedded.

To activate multiple licenses simultaneously, provide a space-separated list of their identifiers.

EXAMPLE

ActivationMode

ActivationMode triggers an automatic online activation during installation.

Note  

For online activation to succeed, you need a working internet connection with access to the ETAS license portal.

EXAMPLE

ActivationMode='online'

ActivationPath

ActivationPath defines the default folder location for storing the request and response bin files.

EXAMPLE

LiMaOption.exe tool

While the Licensing.ini file is used to configure settings during product installation, the LiMaOption.exe command-line tool allows you to modify these same settings after installation. Since LiMa version 1.8.6, you can configure the values from the option dialog via this tool or via entries in the Licensing.ini file.

Using the LiMaOption Tool

You can find the tool in the bin folder of the LiMa installation directory:

C:\Program Files\Common Files\ETAS\Licensing\bin\

  1. For futher details, open a command prompt in that directory and execute the following command:

    The allowed options are displayed.

Option

Explanation

Show help

Show current status of all properties

Show and make migration from FNP to FNE items

Value '0' off, value '1' on

Value '0' to '3' for possible retries during checkout

Value '0' off, value '1' on

Value '0' off, value '1' on

Value '0' off, value '1' on

Value '0' off, value '1' on

Value '0' off, value '1' on

Value '0' off, value '1' on

Value '0' off, value '1' on

Value '0' off, value '1' on

Value '0' off, value '1' on

Value '0' off, value '1' on

Value like YYYY-MM-DD

Value like 'off', 'once', 'always'

Example of Licensing.ini file

The installer needs the [Licensing] section header to correctly identify and apply the settings within the Licensing.ini file.

While it is acceptable for the section to contain no configuration parameters, the file is considered invalid without this header line enclosed in square brackets.