Simpack

Installation and
Licensing
Documentation

Simpack Release 2018

Copyright © 2017 Dassault Systemes Simulia Corp. All rights reserved.
2 CONTENTS

Contents

A Installation and Licensing 5

A.1 Overview 6

A.2 Hardware and Software Requirements 7

A.2.1 Simpack Hardware and Software Requirements . . . . . . . . . . . . . . . . . . 7
A.2.2 Accessing Simpack Remotely . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8
A.2.3 System Installation and Licensing Information . . . . . . . . . . . . . . . . . . . 9
A.2.4 User Routines Compilers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9
A.2.5 MATLAB Interfaces . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10
A.2.5.1 SIMAT . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10
A.2.5.2 MatSIM . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10
A.2.5.3 MATLAB Result Export . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11
A.2.6 FMU Import and FMU Export . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11
A.2.7 Realtime . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11
A.2.8 IPC Co-Simulation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11
A.2.9 FE Interfaces . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11
A.2.9.1 Flexible Body Integration . . . . . . . . . . . . . . . . . . . . . . . . . . . 12
A.2.9.2 Loads Stress & Strain Analysis . . . . . . . . . . . . . . . . . . . . . . . . 12
A.2.9.3 Fatigue Analysis . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12

A.3 Licensing 13
A.3.1 About Simpack Licensing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13
A.3.2 Licensing with DS License Server . . . . . . . . . . . . . . . . . . . . . . . . . . 14
A.3.3 Licensing with the OLicense Server . . . . . . . . . . . . . . . . . . . . . . . . . 15
A.3.3.1 About the OLicense Server . . . . . . . . . . . . . . . . . . . . . . . . . . 15
A.3.3.2 Command Line Tool - olixtool . . . . . . . . . . . . . . . . . . . . . . . . . 16
A.3.3.3 Network Licenses . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16
A.3.3.4 Installation, Con guration, and Start . . . . . . . . . . . . . . . . . . . . . 18
A.3.3.5 Obtaining License Key File(s) for your Servers . . . . . . . . . . . . . . . 20
A.3.3.6 Importing License Key File(s) into your Server(s) . . . . . . . . . . . . . . 24
A.3.3.7 Alert Email Before License Expiration . . . . . . . . . . . . . . . . . . . . 24
A.3.3.8 Checking the Simpack License Con guration and Key Usage . . . . . . 25
A.3.4 Providing Simpack Access to your License Server . . . . . . . . . . . . . . . . 26
A.3.4.1 License Server Con guration File . . . . . . . . . . . . . . . . . . . . . . 27
A.3.4.2 DS License Server Settings . . . . . . . . . . . . . . . . . . . . . . . . . . 27
A.3.4.3 OLicense Server Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . 28
A.3.4.4 General Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30
A.3.5 Checking the License Con guration and Usage from the Simpack GUI . . . . . 31
A.3.5.1 License Servers Status . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32
A.3.5.2 License Key Usage for Current Simpack Pre Session . . . . . . . . . . . 33
A.3.5.3 Current Model License Key Requirements . . . . . . . . . . . . . . . . . 34
A.3.6 Loss of License . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36
A.3.6.1 Loss of GUI license(s) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36

Simpack 2018 Documentation. Copyright © 2017 Dassault Systemes Simulia Corp. All rights reserved.
CONTENTS 3

A.3.6.2 Loss of Solver license(s) . . . . . . . . . . . . . . . . . . . . . . . . . . . 36

A.3.7 Academic Licenses . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37

A.4 Simpack Installation 38

A.4.1 Actions taken by the Simpack Installation . . . . . . . . . . . . . . . . . . . . . 38
A.4.2 Installation from the Wizard . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38
A.4.3 Installation from the Command Line . . . . . . . . . . . . . . . . . . . . . . . . . 42
A.4.3.1 Unattended Mode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43
A.4.3.2 Text Mode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46
A.4.3.3 Building Simpack User Routines . . . . . . . . . . . . . . . . . . . . . . . 46
A.4.4 Installation Log le . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47
A.4.5 Uninstaller . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47
A.4.6 Usage Notes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47

B DS License Server Documentation 49

C OLicense Documentation 203

Simpack 2018 Documentation. Copyright © 2017 Dassault Systemes Simulia Corp. All rights reserved.
4 CONTENTS

Simpack 2018 Documentation. Copyright © 2017 Dassault Systemes Simulia Corp. All rights reserved.
Simpack Documentation

Guide A
Installation and
Licensing

Simpack Release 2018

Copyright © 2017 Dassault Systemes Simulia Corp. All rights reserved.
6

A.1 Overview

This guide provides information on obtaining, installing, and con guring your Simpack version.
It also describes how to install and con gure the license server used by Simpack.
The Simpack installer offers the following advantages:
ˆ The installer works across the supported platforms in exactly the same way.
ˆ The installer can be run in either GUI (wizard), text, or unattended modes.
ˆ The installer generates an installation log le.
ˆ The installer includes an uninstall binary to allow the complete Simpack installation to be
easily uninstalled.
It is recommended that you go through this guide in the following order:
ˆ A.3 - Describes how to install and con gure the Simpack licensing manager, as well as
obtaining and importing your license key les. In addition, you may also need to refer to
the following external guides: the DS License Server Documentation (B) or the OLicense
Documentation (C).
ˆ A.4 - Describes how to acquire and install the Simpack version, as well as explaining what
is performed during the installation.
The Program Directory (http://media.3ds.com/support/progdir) (DS Passport required) that ac-
companies this release describes the hardware and software requirements for the supported
systems, including the supported compilers.

Simpack 2018 Documentation. Copyright © 2017 Dassault Systemes Simulia Corp. All rights reserved.
A.2.1 Hardware and Software Requirements Simpack Hardware and Software Requirements7

A.2 Hardware and Software

Requirements

This describes the hardware and software requirements for both Simpack and the third party
software it works with. This includes the OLicense server, but does not include the require-
ments for the DS License Server. The requirements are listed in the the DS License Server
Documentation (B).
If you are having problems with your installation or licensing, you can call the System Installation
and Licensing Information (A.2.3) tool.

A.2.1 Simpack Hardware and Software Requirements

The current hardware and software requirements for Simpack 2018 are available from the Pro-
gram Directory (http://media.3ds.com/support/progdir) (DS Passport required). In addition, the
hardware and software requirements are available in this section and represent the require-
ments when Simpack 2018 was released.
Simpack has the following minimum hardware and operating system requirements. For certain
functionality and applications other requirements are needed; these are listed in the following
sections.

Windows Linux
CPU Intel x86 / EM64T or AMD x86 / AMD64
RAM Minimum 2GB 32-bit and 4GB 64-bit. Swap space requires twice the avail-
able RAM.
Disk Space 1.5GB
Resolution Minimum WXGA+ (1440 x 900)
Graphics Card A dedicated NVIDIA OpenGL capable graphics card is mandatory; an
NVIDIA Quadro M2000 (4GB GDDR5) or better is strongly recommended to
ensure graphics problems do not occur. The NVIDIA graphics driver must be
version 350 or higher. For more information on the recommended NVIDIA
setting see the note below.

Simpack 2018 Documentation. Copyright © 2017 Dassault Systemes Simulia Corp. All rights reserved.
8 A.2.2 Hardware and Software Requirements Accessing Simpack Remotely

OS Windows 7, Red Hat Enterprise Linux

Windows 8 and 8.1, 6.0 through to 6.7
Windows 10, SUSE 11.1
Windows 2008 Server R2,
Windows 2012 Server R2
Software OpenGL version 3.2 (see note below) OpenGL version 3.2 (see note below)
KDE recommended or GNOME ≥
2.30

Table A.2.1: Simpack hardware and operating system requirements

OpenGL version 2.1 can be used if the shaders are deactivated in the user-speci c settings
from the the Use shaders option in the Graphics tab, see the Simpack main documenta-
tion. Deactivating the shaders reduces the rendering performance and the graphics quality. To
check that you have the correct OpenGL version you can use the Simpack command line tool,
'oglinfo'. For more information see the Simpack main documentation.

Note:

ˆ Be aware that some of the interfaces to third party software are not available for all
platforms. Please see the respective interface documentation for more details on the
supported platforms.
ˆ The hardware and software requirements for the DS License Server are different, see
the the DS License Server Documentation (B).
ˆ The NVIDIA graphics card driver version, e.g. 310.90, can be seen by clicking on
'System Information' in the 'NVIDIA Control Panel' dialog accessed from the operating
system 'Control Panel'.
ˆ The NVIDIA graphics card setting (available with the recommended Quadro graphic
cards) should be set to 'Workstation app - dynamic streaming' or 'Dassault Systemes
Catia - compatible' for the optimum graphics performance. This setting can be found
in the 'NVIDIA Control Panel' dialog. Once in the NVIDIA Control Panel the user sets
the '3D Settings' to one of those mentioned above, located in the tree view 'Manage
3D settings' and then the tab 'Global Settings'.
ˆ Linux: The environment variable '__GL_THREADED_OPTIMIZATIONS' should be
set to '1'.

A.2.2 Accessing Simpack Remotely

You can access Simpack remotely from another computer; for example, via the Windows re-
mote desktop or redirecting the display on Linux. For remotely accessing the Simpack GUI
(Simpack main user interface or Simpack Post user interface) there are additional require-
ments. Any remote display solution, which is based on the VirtualGL libraries, requires the
VirtualGL version greater or equal to 2.4. The following remote con gurations are available:

Simpack 2018 Documentation. Copyright © 2017 Dassault Systemes Simulia Corp. All rights reserved.
A.2.4 Hardware and Software Requirements User Routines Compilers 9

ˆ Running Simpack on Linux and displaying remotely on Windows requires:

Either Exceed onDemand 13.8.9 (8 SP9). Cursor keys will only work if on the server
side the environment variable 'XKB_DEFAULT_RULES' is set to 'base'.
Or Nice DCV version 2016.0.
Or VirtualGL 2.5.2 and TigerVNC Server 1.3.0.
ˆ Running Simpack on Windows and displaying remotely on Windows requires an NVDIA
graphics driver version 350 (same as for standard Simpack usage) or higher.
ˆ Running Simpack on Linux and displaying remotely on Linux requires VirtualGL 2.5.2 and
TigerVNC Server 1.3.0.
ˆ Running Simpack on Windows and displaying remotely on Linux
Either VNC (this is very slow and not recommended)
Or Nice DCV version 2016.0

A.2.3 System Installation and Licensing Information

You can use the this tool, if you want to nd out the status of your system and installation to
check if they ful l the requirements and, if necessary, to provide the information to the Simpack
support team. The tool returns the following information:
ˆ Operating system
ˆ Simpack release
ˆ Detailed information on the available CPUs
ˆ Disk space in the temporary and installation directories
ˆ System memory
ˆ Detailed information for the graphic cards
ˆ Open Graphics Library (OpenGL) information under oglinfo
ˆ License server and license key (availability and usage) information
ˆ Library dependency check (the option '-c' is required when calling the tool from the com-
mand line); that is, the libraries which were successfully loaded and those that were not.
You can call the tool either from Help ⇒ System and Support Info. . . or from the command
line, see the Simpack main documentation.

A.2.4 User Routines Compilers

The following compilers are supported with Simpack User, see the Simpack main documenta-
tion.
Simpack requires a combination of a Fortran compiler together with a C compiler and linker.

Windows Linux
C Compiler Microsoft® Visual Studio 2008 Standard SP 1 gcc 4.3.3 through to 4.9.2
and Linker Microsoft® Visual Studio 2010 Professional SP 1
®
Microsoft Visual Studio 2012 Professional
Microsoft® Visual Studio 2013 Professional

Simpack 2018 Documentation. Copyright © 2017 Dassault Systemes Simulia Corp. All rights reserved.
10 A.2.5 Hardware and Software Requirements MATLAB Interfaces

Fortan Compiler Intel® Fortran Compiler 2010 SP1 (11.1) update-7 or newer 2010 updates
(only together with Microsoft® Visual Studio 2008)
Intel® Fortran Compiler 2011 SP1 (12.1) update-11 or newer 2011 updates
(only with Microsoft® Visual Studio 2008 or 2010)
Intel® Fortran Compiler 2013 SP1 (14.0) and all 2013 updates
Intel® Fortran Compiler 2015 (15.0) and all 2015 updates

Note:

ˆ Microsoft Visual Studio must be installed before Intel Fortran Compiler, otherwise the
user shared library cannot be created.
ˆ Microsoft Visual Studio 2013 requires Intel Fortran Compiler 2013 SP1 update 2 as a
minimum.
ˆ All Microsoft Visual Studio Express versions are not supported.

A.2.5 MATLAB Interfaces

A.2.5.1 SIMAT

The interface is supported on 32- and 64-bit platforms for MATLAB® R2010a/b, R2011a/b,
R2012a/b, R2013a/b, R2014a/b, R2015a/b, and R2016a.

Note:

R2012a is the last MATLAB release for 32-bit Linux.

A.2.5.2 MatSIM

The interface is supported on for MATLAB® R2011a/b, R2012a/b, R2013a/b, R2014a/b,

R2015a/b, and R2016a with the following compilers.

Compilers
Windows Microsoft® Visual Studio (32- and 64-bit)
Linux gcc 4.3.x

Table A.2.3: Compilers required with MatSIM

Simpack 2018 Documentation. Copyright © 2017 Dassault Systemes Simulia Corp. All rights reserved.
A.2.9 Hardware and Software Requirements FE Interfaces 11

A list of the supported compilers by Simulink Coder can be found on the following links:
ˆ http://www.mathworks.com/support/compilers/
ˆ http://www.mathworks.com/support/sysreq/previous_releases.html

Note:

R2012a is the last MATLAB release for 32-bit Linux.

A.2.5.3 MATLAB Result Export

The MATLAB binary (.mat) le can be exported using the MATLAB Result Export module (see
the Simpack main documentation) for MATLAB versions R2006b or later (.mat le version 7.3).
The .mat le is platform independent.

A.2.6 FMU Import and FMU Export

Simpack FMU Import and FMU Export support the Functional Mock-up Interface (FMI) versions
1.0 and 2.0.

A.2.7 Realtime

Simpack Realtime supports Intel x86-based processors, multiple cores each with a high base
frequency.
Simpack Realtime is of cially supported on the following real-time OS (RTOS):
ˆ RedHawk Linux operating system (recommended) provided by Concurrent. This RTOS
is available with iHawk system purchase and includes many features to shield (reserve)
CPUs for realtime simulations.
ˆ SUSE Linux Enterprise Real Time Extension. Based on SUSE Linux, this OS includes a
realtime kernel. It has limited CPU shielding options compared with RedHawk.

A.2.8 IPC Co-Simulation

The module IPC Co-Simulation requires a C Compiler. The supported C Compilers are listed
in Table A.2.2.

A.2.9 FE Interfaces

The releases of the respective third-party nite element software which are compatible with
Simpack are as follows:

Simpack 2018 Documentation. Copyright © 2017 Dassault Systemes Simulia Corp. All rights reserved.
12 A.2.9 Hardware and Software Requirements FE Interfaces

A.2.9.1 Flexible Body Integration

ˆ ANSYS: 13, 14, 14.5, 15, 16

ˆ Abaqus: 6.7, 6.8, 6.9, 6.10, 6.11, 6.13, 6.14 and 2016. For Abaqus 6.13, 6.14 and 2016
the interface is supported via Abaqus .sim le. Abaqus 6.12 is not supported since the
Abaqus .sim application programming interface (API) is not backward compatible.
ˆ NX Nastran: 7.0, 8.0, 8.1, 8.5
ˆ MSC Nastran: 2008, 2010, 2011, 2012
ˆ PERMAS: 12, 13, 14
ˆ RADIOSS: 11.0
Please note:
ˆ The interface to Abaqus is only available on Linux 64-bit and Windows 64-bit.
ˆ Both PERMAS and RADIOSS write Flexible Body Input (.fbi) les for Simpack Classic.
These can be converted into .fbi les for release 9.

A.2.9.2 Loads Stress & Strain Analysis

ˆ ANSYS: 13, 14, 14.5, 15, 16

ˆ Abaqus: 6.7, 6.8, 6.9, 6.10, 6.11, 6.12, 6.13, 6.14, 2016
ˆ NX Nastran: 7.0, 8.0, 8.1, 8.5
ˆ MSC Nastran: 2010, 2011, 2012
Please note:
ˆ The interface to Abaqus is only available on Linux 64-bit and Windows 64-bit.

A.2.9.3 Fatigue Analysis

ˆ ANSYS: 13, 14, 14.5, 15, 16

ˆ Abaqus: 6.7, 6.8, 6.9, 6.10, 6.11, 6.12, 6.13, 6.14, 2016
ˆ NX Nastran: 7.0, 8.0, 8.1, 8.5
ˆ MSC Nastran: 2010, 2011, 2012
ˆ fe-safe: 2016 FP1621
ˆ FEMFAT max: 5.0
Please note:
ˆ The interface to Abaqus is only available on Linux 64-bit and Windows 64-bit.

Simpack 2018 Documentation. Copyright © 2017 Dassault Systemes Simulia Corp. All rights reserved.
A.3.1 Licensing About Simpack Licensing 13

A.3 Licensing

This section describes how to install and con gure your license server, how to obtain and import
your license key les, and how to troubleshoot the Simpack licensing mechanism.

A.3.1 About Simpack Licensing

Simpack uses either the internal DS License Server tool or OLicense. We recommend that you
install and con gure your licensing before con guring the Simpack access to it. Depending
on which tool you are using, after reading this section refer to sec. A.3.2 'Licensing with DS
License Server' or sec. A.3.3 'Licensing with the OLicense Server'. You can then move on to
Providing Simpack Access to your License Server (A.3.4).
A client-server approach is used with the licenses provided by the license servers. The license
servers are installed and run separately from the Simpack installation. Simpack licensing sup-
ports both single license servers and redundant license servers.
Licenses are delivered as oating licenses; that is, the licenses can be used by any Simpack
client that can access the license server. The respective licenses are checked-out/-in from the
license server by the Simpack clients. For example, you could have ve Simpack installations
and two Simpack licenses. Any of the ve Simpack installations can use the licenses; however,
once the maximum number of two licenses has been reached, you will not be able to start
a third application of Simpack until one of the two licenses has been returned to the server
(unlocked).
The Simpack solvers can be parallelized. The number of licenses required depends upon how
many threads you select in the active Solver Setting (see the Simpack main documentation).
The number of licenses required is described in detail in the Simpack main documentation.
Different functionalities (for example, modules, ViewSets, Modeling Elements, solvers, inter-
faces, etc.) are licensed via the different license keys. You can see which keys are available
on the license servers and which keys are required by a model (see sec. A.3.5 'Checking the
License Con guration and Usage from the Simpack GUI' and sec. A.3.5.3 'Current Model Li-
cense Key Requirements', respectively). Each of the different Simpack modules is licensed
with the respective license keys, as shown in each module description (see the Simpack main
documentation).

Simpack 2018 Documentation. Copyright © 2017 Dassault Systemes Simulia Corp. All rights reserved.
14 A.3.2 Licensing Licensing with DS License Server

Note:

ˆ Some modules require that additional modules are also licensed. Please contact your
SIMULIA sales partner for more information.
ˆ Some functionality can be licensed via different licenses; for example, some Control
Elements can be licensed with 'Automotive', 'Rail', or 'Control'. If one of the possible
licenses has already been checked out, no additional licenses are required. For more
information, see the documentation of the individual functionality.

The following types of license keys are available:

ˆ All user interfaces and associated functionality are licensed through sharable (concurrent)
licenses.
ˆ Solvers and functionality when a solver is running are usually licensed through Simpack
Tokens (see the Simpack main documentation). There are exceptions for existing cus-
tomers.
Simpack has a number of interfaces to third-party products. When using these interfaces li-
censes are required for both the interface and for the third-party product. Some third-party
products can also be licensed directly by the Simpack license key (see the respective module
description in the Simpack main documentation).

A.3.2 Licensing with DS License Server

This section describes how to acquire, install, and con gure the DS License Server. You can
then access the license server from your Simpack installation.
The installation of the DS License Server includes the Installation and Con guration Guide (the
DS License Server Documentation (B)), which contains instructions for con guring the license
server and administering licenses. The DS License Server installer is available directly from the
Simpack installer. You need to select the DS License Server when selecting the components
during the Simpack installation. Refer to this guide for all DS License Server licensing opera-
tions. To install the DS License Server, you must be an Administrator on Windows or root on
Linux. The supported operating systems for the DS License Server are different from those for
Simpack (see 'Operating System Prerequisites' in the the DS License Server Documentation
(B)).
The DS License Server supports standalone license servers, as well as failover clusters. The
server is managed from the administration tool integrated into the DS License Server. You
can also use the command line to manage and retrieve information from the server. You can
activate e-mail noti cations; for example, to monitor the server usage or license expiration
dates.
The DS License Server should be installed on only one computer unless you are using a redun-
dant license server con guration. The server computers that you choose for licensing should
be accessible by all computers on the network where you plan to run Simpack and should be
stable machines that are not frequently rebooted or shut down.

Simpack 2018 Documentation. Copyright © 2017 Dassault Systemes Simulia Corp. All rights reserved.
A.3.3 Licensing Licensing with the OLicense Server 15

Automatic con guration is recommended for most users, particularly those whose primary re-
sponsibility is not computer system or network administration. You can allow the DS License
Server installer to install, con gure, and start the DS License Server automatically.
After installation, you can use the dslsstat utility to check the DS License Server status (see
'Using the dslsstat utility for a Dassault Systemes license server'). You can also call the licens-
ing information tool (from Simpack) to check the status of your license server(s) and available
licenses, see sec. A.2.3 'System Installation and Licensing Information'.
We recommend you use the DS License Server version delivered with this Simpack release
(Simpack 2018 requires DS License Server version R2017x (6.419.0) or higher and a license
with the RANK 20 or higher). Once you have started the installer, follow the instructions in
the dialogs that appear to complete the installation. After the installation nishes, you must
use the DS License Server Administration Tool to enroll the licenses on the license server (see
'Enrolling Product Licenses' in the the DS License Server Documentation (B)). You must enroll
the licenses before starting to work with Simpack.

Note:

ˆ Virtual machines, such as VMware, are not supported. It is not possible to install or
run the DS License Server on a virtual machine.
ˆ Simpack does not support the DS License Server licensing extraction feature (bor-
rowing).
ˆ The hardware and software requirements for the DS License Server are different from
those required by Simpack and other third- party software (see the the DS License
Server Documentation (B)).

A.3.3 Licensing with the OLicense Server

This section describes how to acquire, install, and con gure the OLicense server. You can then
access the license server from your Simpack installation.

A.3.3.1 About the OLicense Server

This section describes the most important features of the OLicense suite and the required
OLicense version and hardware/software requirements for running the OLicense server.
All licenses are sharable (concurrent) network licenses (see A.3.3.3).
The OLicense server is a stand-alone web server, which runs either on Windows or Linux
operating systems. The server can be managed by a browser frontend.
In addition, the OLicense suite offers a command line tool to retrieve information from the
OLicense server. For more information, see A.3.3.2.
You can set the OLicense server to automatically send alert emails before licenses expire. For
more information, see A.3.3.7.
Simpack 2018 requires the following OLicense version:

Simpack 2018 Documentation. Copyright © 2017 Dassault Systemes Simulia Corp. All rights reserved.
16 A.3.3 Licensing Licensing with the OLicense Server

ˆ 'OLicenseServer 4.7.5', as a minimum; that is, the oldest supported version,

ˆ 'OLicenseServer 4.9.0', this is the recommended version for Simpack 2018.
When the Simpack License Server is set, a check is performed for the correct OLicense server
version. For more information, see sec. A.3.4.3 'OLicense Server Settings'. You can call the
licensing information tool (from Simpack) to check the status of your license server(s) and
available licenses, see sec. A.2.3 'System Installation and Licensing Information'.

A.3.3.2 Command Line Tool - olixtool

You can use the command line tool, olixtool, to retrieve information via the command line from
the OLicense server.
You can use olixtool in batch processes or to write information to a log le. Some of the most
common uses are as follows:
ˆ Identify who has currently locked which modules of Simpack
ˆ Check whether the server is running
ˆ Determine which Simpack modules are licensed
ˆ Generate the le that contains your server ID's, which should be sent to your Simpack
distributor.
The olixtool executable is found in the following directories:
<installdir>/extern/win32/olicense/ (Windows) or
<installdir>/extern/linux32/olicense/ (Linux).

Note:

The olixtool is available only as a 32-bit executable.

The following example shows how to use olixtool on Windows to check which licenses are
currently locked and by whom for an OLicense license server running locally on the Simpack
client:
...\olixtool.exe -OLicenseServer localhost:80:0 -lck

On Linux the executable is called olixtool.lin instead of olixtool.exe.

To return all of the available options, enter the following on Linux:
.../olixtool.lin -h

For detailed information on the available options, see the OLicense Documentation (C).

A.3.3.3 Network Licenses

Network licenses are licenses that are available from within a network. This can include the
following con gurations.
ˆ The OLicense license server and Simpack client are the same machine.

Simpack 2018 Documentation. Copyright © 2017 Dassault Systemes Simulia Corp. All rights reserved.
A.3.3 Licensing Licensing with the OLicense Server 17

ˆ The OLicense license server and Simpack client are separate machines. The license
server must be available from the Simpack client though the company network or through
the internet.
OLicense can use the following server con gurations:
ˆ Single server - There is only one OLicense server running, which can be accessed by the
Simpack clients (see A.3.3.3).
ˆ Multiple servers - There are multiple servers running, and each server provides a speci-
ed number of licenses (see A.3.3.3).
ˆ Redundant servers - There are multiple servers running, each supplied with the same
licenses. This con guration provides a back-up system so that if one (or more) server
fails, the back-up servers can provide the Simpack client with the license (see A.3.3.3).
OLicense refers to redundant server systems as 'Highest availability server systems'.
ˆ Mixed multiple/redundant server modes, see A.3.3.3.
For more information on accessing your server from the Simpack client, see A.3.4.
For information about installing OLicense, see sec. A.3.3.4.1.

Single Server With a single server installation you will have only one instance of the OLicense
server running in your network. The Simpack client (or clients) can access only the one server.
This is often the case when the OLicense server and Simpack client are the same machine.

Multiple Servers Multiple servers are installations of the OLicense server on different ma-
chines with each installation holding a given number of licenses. For example, you could have
a total of 5 licenses of which 2 licenses are on one server and 3 licenses are on another server.
Multiple servers are typically used in the following cases:
ˆ For companies that have license servers at a number of locations. For example, the rst
server could be the server where the department is located. The other servers could be
central license servers located at an administrative headquarters.
ˆ For laptop usage where both a USB stick and a network license server are used for the
authentication.

Note:

The more servers you enter on the Simpack client side, the slower the performance of the
Simpack client license call. We recommend not entering more than three servers. For
additional information, see A.3.4.

Redundant Servers Redundant servers are also multiple installations of the OLicense server
on different machines. The difference between redundant servers and multiple servers is that in
a redundant server con guration each server is provided with the same licenses. If one server
fails, another one of the servers can provide the required licenses.
If you again had ve licenses (similar to the example in the Multiple Servers (A.3.3.3)) and this
time three servers (three servers is a minimum), you would have all ve licenses on each of

Simpack 2018 Documentation. Copyright © 2017 Dassault Systemes Simulia Corp. All rights reserved.
18 A.3.3 Licensing Licensing with the OLicense Server

the servers. Therefore, if one server fails, the licenses are served automatically by the other
servers. It is possible to con gure more servers if required. For more information, see the
Simpack section on con guring your Simpack client to access redundant servers in A.3.4.
Redundant server systems are used for critical systems when licenses are at a premium. This
is often the case when running lengthy simulations or batch jobs that require a number of hours
or days. For more information, see the discussion of redundant servers in A.3.4.

Mixed Multiple/Redundant Server Modes Mixed server modes use a combination of the
multiple servers and redundant servers modes. For more information on mixed modes, see the
OLicense Documentation (C).
Mixed modes are commonly used if a company is distributed over different locations with a
redundant server setup in each location. Each location should be able to access the licenses
from other locations. The redundant server pools are then speci ed and can be used as multiple
servers.

A.3.3.4 Installation, Con guration and Start of the License Server

This section describes how to install, con gure, and start the server.

A.3.3.4.1 Installing the License Server

You start the OLicense server installers directly from the Simpack installer.
For more information on installing or uninstalling OLicense, see the OLicense Documentation
(C).

Important Notes for the Installation You should be aware of the following:
ˆ To install OLicense, you need local administrator privileges on Windows and root privi-
leges on Linux.
ˆ The OLicense server must be installed on a local drive of a network-ready computer. UNC
paths (for example, \\computer-name\shared) are not supported.

Upgrade of the License Server to a Newer Version If you have just installed a new version
of Simpack and you already have an installation of the OLicense server that you used with a
previous Simpack version, you can check if the OLicense server ts the minimum OLicense
server requirements (see A.3.3.1).
If you require a newer OLicense version or would like to upgrade your version, you must do the
following:
1. If the OLicense server is running, you must stop it.
2. Back up the <database>.odb (database) le, which is located in the directory where
OLicense is installed.
3. Deinstall OLicense.

Simpack 2018 Documentation. Copyright © 2017 Dassault Systemes Simulia Corp. All rights reserved.
A.3.3 Licensing Licensing with the OLicense Server 19

4. Install the new version.

5. Copy the backed-up database le (<database>.odb) back to the installation directory.
6. Start the newly installed server; your licenses should be available.
7. If the Simpack version also requires a new license, go through the steps in A.3.3.6 to
import your new license, which you should have received from your Simpack distributor.

A.3.3.4.2 Con guring the License Server

The server reads-in a con guration le to control certain parameters. These are all described
in the OLicense Documentation (C).
This section describes some of the most commonly used options. The settings are accessed
from the OLicense Server-Control program - 'Server-INI-File tab, as shown in the gure below.

Server Port -port=80

The default port of the license server is port 80. If you want to use another port, modify this
parameter.

Simpack 2018 Documentation. Copyright © 2017 Dassault Systemes Simulia Corp. All rights reserved.
20 A.3.3 Licensing Licensing with the OLicense Server

It is important that the same port is used in Simpack. For more information, see A.3.4.3.

Servers -servers=www.foo.com,192.168.5.77,bla.de:8080
This parameter is required only for redundant server modes.
It is set on the servers accessing the servers holding the licenses. The servers and the respec-
tive ports are entered here. The servers are separated by commas.

Info on Currently Locked Floating Licenses -allowOccupancyInfoGlobal

This parameter controls whether the Simpack users can see who has currently locked the
oating licenses. By default, , this information cannot be seen (for privacy reasons). For more
information on checking the license server status, see A.3.3.8.

A.3.3.4.3 Starting the License Server

You can start each of the servers once they have been installed.
The servers can be started as follows:
ˆ By starting the OLicense Server-Control program and clicking on 'Start Service'.
ˆ Automatically as a service/daemon during the system boot process. Administrator/root
privileges are required for this con guration.
For more information on starting the server, see the OLicense Documentation (C).

A.3.3.5 Obtaining License Key File(s) for your Servers

Once you have installed the OLicense server, you need to provide your server ID to your
Simpack distributor so that a license key le can be generated. This section explains how you
obtain the IDs and then send this information to your Simpack distributor so that a license key
le can be generated.

A.3.3.5.1 License Version Required

Simpack 2018 requires that the licenses include the version 201800 (for example, 0-201800 or
higher) or a range that includes 201800.
You can check the licenses, which are available on the servers (for more information see
sec. A.3.3.8). For an overview of the license key le syntax, see sec. A.3.3.5.4.
The license version number, 201800, is based upon the internal Simpack release name.

A.3.3.5.2 Obtaining the License Server ID

You must obtain your license server IDs so that your distributor can generate your license keys.
To obtain the license server IDs, you must do the following:

Simpack 2018 Documentation. Copyright © 2017 Dassault Systemes Simulia Corp. All rights reserved.
A.3.3 Licensing Licensing with the OLicense Server 21

1. Start the OLicense Server-Control program. This program starts automatically once the
installation has been completed. It can also be started from the 'Start' menu on Windows:
'OLicenseServer → OLicense-Server-Control'
or from the 'OLicenseServerCtr' executable on Linux.
2. To start the server, select Start Local:

3. To administrate the server, open the Browser Frontend:

Simpack 2018 Documentation. Copyright © 2017 Dassault Systemes Simulia Corp. All rights reserved.
22 A.3.3 Licensing Licensing with the OLicense Server

4. The OLicense server Browser Frontend starts in your web browser. Click on:
Administrate Server...

You will be asked for a password. It is possible for the OLicense admin to control who
has access to the server settings. In the rst instance, and if a password has not been
set, this works just by clicking on OK.

Simpack 2018 Documentation. Copyright © 2017 Dassault Systemes Simulia Corp. All rights reserved.
A.3.3 Licensing Licensing with the OLicense Server 23

Then, in the page that opens, copy and paste the Preferred Server ID from the screen
(do not click on "Export Server Info ..."). If, and only if, the 'Preferred Server ID' is unavail-
able, copy the Alt. Server ID 2 from the screen. Use the copied string as the target ID
when sending the license information to your sales partner. Target IDs starting with 'U3_'
(dongle) or ending with '_V' (virtual server) or '_S(manually edited MAC address) are not
allowed. You must contact your sales partner if you get a target ID of this kind. Once you
have received your license key le, you must then import it into the license server. This is
explained in A.3.3.6.
This is also where you can set a password for access to the OLicense settings under
User & Password.
For more information, see the OLicense Documentation (C).

A.3.3.5.3 Overview of the Server ID's - UUID, MAC, HMAC

When you export the server information to the le OLicense.olsiml, you can see the respective
IDs if you open this le in an ASCII editor.
The server IDs are as follows:
ˆ UUID This is a compound made up from the network card, hardware, and software.
This is the preferred ID.
ˆ MAC The address from your network card. This is the preferred ID if the UUID is not
available on your computer.
ˆ HMAC This ID cannot be used.

A.3.3.5.4 Overview of the License Key File

This section provides a brief overview of the license key le, which you should have received
from your Simpack distributor.
The Simpack license key le is an ASCII le in xml format. The most important keywords are
as follows:
ˆ <licenseId> - Each license key le has an ID. Importing a license key le with the same
ID will overwrite a previous instance of this le on your license server.
ˆ <major> - Shows the Simpack version range for which this license key le is valid. For
more information on which license version Simpack 2018 requires, see sec. A.3.3.5.1.
ˆ <procedure> - This is the name of the Simpack module that is licensed. The license le
is made up of blocks; each block licenses a different module.
ˆ < oating> - The number of licenses of each module.

Simpack 2018 Documentation. Copyright © 2017 Dassault Systemes Simulia Corp. All rights reserved.
24 A.3.3 Licensing Licensing with the OLicense Server

ˆ <serverKey> - The license server ID. The different IDs are described in more detail in
A.3.3.5.3.

A.3.3.6 Importing License Key File(s) into your Server(s)

This section describes how to import your license key le, which was sent by your Simpack
distributor, into your license server.
The license key le is imported from the Browser Frontend from:
License Import.

Provided the license can be imported correctly, you will see that the license has been accepted.
Your license server is now ready to be accessed from Simpack. Under 'View Licenses', you
can see the licenses that have been imported to the server.
If the license cannot be imported correctly, you will see an error message with error code.
Check your error code against those in the the OLicense Documentation (C).
The most common problem is if the license does not match with the server upon which you are
trying to start the license. Make sure that the license server matches the license server with
which OLicense.olsiml was generated.

Note:

Each license key le has an ID. Importing a license key le with the same ID will overwrite
a previous instance of this le on your license server.

A.3.3.7 Alert Email Before License Expiration

Once the license key le has been imported into your server, you can con gure the server to
automatically send an email to your Simpack license administrator before the license expires.
The number of weeks before the expiration can be speci ed.
You can con gure the server to automatically send an email alert set by clicking on:
Administrate Server... from the OLicense Browser Frontend.
Accessing the server administration window is explained in more detail in sec. A.3.3.5.2 'Ob-
taining the License Server ID'.

Simpack 2018 Documentation. Copyright © 2017 Dassault Systemes Simulia Corp. All rights reserved.
A.3.3 Licensing Licensing with the OLicense Server 25

A.3.3.8 Checking the Simpack License Con guration and Key Usage

This section describes how to check the available licenses, license servers, and Simpack con-
guration, as well as the current license key usage.
You can check the following:
ˆ How Simpack accesses the license server
ˆ The state of the license servers
ˆ Which Simpack license keys for which version are available on the server
ˆ The license usage for the current Simpack Pre session (see sec. A.3.5.2 'License Key
Usage for Current Simpack Pre Session')
ˆ The license requirements for the current model (see sec. A.3.5.3 'Current Model License
Key Requirements')

A.3.3.8.1 Checking the License Con guration and Usage from the Simpack GUI

This is described in sec. A.3.5 'Checking the License Con guration and Usage from the Sim-
pack GUI'.

A.3.3.8.2 Checking the License Server Con guration from the Command Line - olixtool

You can check the status of the license servers by using the OLicense command tool. This
tool is particularly useful if you want to continually check the status of the license servers; for
example, in batch mode.
The options needed to check the license server status are described in detail in the OLicense
Documentation (C).
The olixtool is also described in more detail in A.3.3.2.

A.3.3.8.3 Checking the License Server Con guration from the OLicense Browser Fron-
tend

You can check the licenses you have imported to your servers by using the OLicense server
Browser Frontend, which is started from OLicense-Server-Control GUI on the machine running
the server.The browser frontend can be opened once the server is running.
Click on:
Administrate Licenses...

Simpack 2018 Documentation. Copyright © 2017 Dassault Systemes Simulia Corp. All rights reserved.
26 A.3.4 Licensing Providing Simpack Access to your License Server

If a password for the OLicense administration has been set, you must enter it; otherwise, click
ok. For more information, see sec. A.3.3.5.2 'Obtaining the License Server ID'.
You will see the licenses that have been imported to the server as well as information on each
of the different modules (or license keys) that are contained in each of the imported license key
les.

A.3.3.8.4 Simpack Client Log

You can log the licenses that have been checked in and out for each of the entered license
servers for the respective Simpack executable.
In the 'Simpack Options - Licensing' dialog, available from Extras ⇒ Licensing..., activate the
setting: 'Generate license client log le'.
If you are having problems with the licensing, send the respective log le to your Simpack
distributor.
When you set this option, a log le is generated for each Simpack executable. The le is stored
in the log le directory entered in the 'Simpack Options' dialog under the 'General' tab, available
from 'Extras'→'Options...'
The log le contains the name of the executable and the server name and port. For example,
when a model is open in Simpack Prewith the license server running locally on port 80, the
following log le is generated:
<logfile_dir>\spck_lic_client.simpack-gui.localhost_80_0.log

A.3.4 Providing Simpack Access to your License Server

You now have your license server up and running, and Simpack must be able to nd the license
server. The license server can be accessed via the selected port.
First, you need to select whether the DS License Server or the OLicense is used to license
Simpack.
You then need to tell Simpack the server name and port so that Simpack can be started. You
enter your server details in in the 'Simpack Options - Licensing' dialog in the Simpack GUI

Simpack 2018 Documentation. Copyright © 2017 Dassault Systemes Simulia Corp. All rights reserved.
A.3.4 Licensing Providing Simpack Access to your License Server 27

under Extras ⇒ Licensing. When you click Apply or OK in the 'Licensing' dialog, a check is
performed to con rm that the correct license server version is installed. Therefore, the license
server must be running and accessible through your network.
On Windows the rewall is active by default. If you are using any port number other than the
default (port 80), you must deactivate the rewall for the communication ports on the license
server and Simpack client.

A.3.4.1 License Server Con guration File

You can enter the license servers directly in Simpack, or you can enter them in a con guration
le and access this le from Simpack.
Entering the license servers in a con guration le is particularly useful in the following cases:
ˆ Installations with a large number of Simpack clients
ˆ If the name or ports of the used license servers are changed frequently by the license
administrator.
The administrator need only modify the contents of the con guration les; it is not necessary
for you to modify your con guration. Therefore, it is recommended that the con guration les
be located centrally on a server.

A.3.4.2 DS License Server Settings

This section describes options that are speci c to the DS License Server.
In the gure below the DS License Server speci c eld is left blank, therefore accessing the
con guration le.

Figure A.3.1: 'Simpack Options - Licensing' dialog

The following options are speci c to the OLicense license server:

− OLicense
See the OLicense Server Settings (A.3.4.3)
− DSLS
This must be active.
− DSLS
− License server:
You enter the license servers and ports. This will be one server with a stan-
dalone server, and three severs with redundant servers. The port number must
be the same port number that is set for the license server. If a port number is

Simpack 2018 Documentation. Copyright © 2017 Dassault Systemes Simulia Corp. All rights reserved.
28 A.3.4 Licensing Providing Simpack Access to your License Server

not entered, the default port 80 is used. The hostname and port number are
separated by a colon ':'. For more information on setting the license server port
in the DS License Server, see 'Con guring the DS License Server and Clients'
in the DS License Server Documentation (B).
You can also use the con guration le, which contains the names of the license
servers and respective ports. Simpack will access the con guration le if you
leave this blank. The con guration le is:
Windows: 'C:\ProgramData\DassaultSystemes\Licenses\DSLicSrv.txt'
Linux: '/var/DassaultSystemes/Licenses/DSLicSrv.txt'
For more information on the syntax of the le, see 'Con guring Clients' in the
the DS License Server Documentation (B).

A.3.4.3 OLicense Server Settings

This section describes options that are speci c to the OLicense license server.
In the gure below ....

Figure A.3.2: 'Simpack Options - Licensing' dialog OLicense speci c - accessing the local
machine

The following options are speci c to the OLicense license server:

− OLicense
This must be active
− DSLS
See the DS License Server Settings (A.3.4.2)
− OLicense
− License server/ le
You can either enter the license servers (hostname) with ports, or you can enter
a con guration le. For single servers, you enter one server name and the port
number. The port number must be the same port number that is set for the
license server. If a port number is not entered, the default port 80 is used. The
hostname and port number are separated by a colon ':'. See the Con guration
Examples (A.3.4.3.1). For more information on setting the license server port in
OLicense, see sec. A.3.3.4.2 'Server Port'.
Multiple independent servers are separated by a semicolon, ';'. It is recom-
mended that no more than three multiple servers are speci ed in the list. Each
server call takes time, which will slow the start of Simpack. Redundant servers
must be separated by a comma, ','.
If you want to use a con guration le, enter the name and path to the le here;
for example:

Simpack 2018 Documentation. Copyright © 2017 Dassault Systemes Simulia Corp. All rights reserved.
A.3.4 Licensing Providing Simpack Access to your License Server 29

'c:\simp_license\license.dat'
You enter the license servers and respective ports in the license con guration
le. The le syntax is explained in sec. A.3.4.3.2.
− Generate license client log le
When you activate this setting, a log le (in the selected log le directory, see
Logging in the the Simpack main documentation) is generated for each Sim-
pack executable that is started. All calls from the Simpack client executable to
the license server are logged. If you are having problems with the licensing,
activate this setting and send the respective log le to your Simpack distributor.

A.3.4.3.1 Con guration Examples

The examples below show how to con gure the server in different con gurations.
ˆ Single Server:
hostname (will use default port 80)
hostname:port
ˆ Multiple Servers - The servers are separated by a semicolon ";":
hostname1;hostname2:port2;...
hostname1:port1;hostname2:port2;...
The server preference is determined by the order in which the servers are entered; that is,
in this case the server called rst is hostname1. The more servers you enter, the slower
the performance will be. We recommend not entering more than three servers.
ˆ Redundant Servers - The servers are separated by a comma "," All the available OLicense
servers are always con gured:
server1:port1,server2:port2,server3:port3
The order in which the servers are entered does not in uence the order in which they are
called.
ˆ For combined server modes (that is, mixed multiple/redundant systems) the same sepa-
rators as shown above are used.
hostname1:port1;server1:port1,server2:port2,server3:port3

A.3.4.3.2 Con guration File Syntax

Examples of the license con guration le syntax are shown below.

For a single server system:
# --- bof ---------------
# Hash are comments
myserver # myserver with port 80 (default)
# --- eof --------------

For a combined server system (that is, multiple and redundant servers):
# --- bof ---------------
server1 # independent server with port 80 (default)
server2:8080 # another independent server with port 8080
server1:8080,server2:8080,server3:8080 # redundant servers, each on port 8080
# --- eof --------------

Simpack 2018 Documentation. Copyright © 2017 Dassault Systemes Simulia Corp. All rights reserved.
30 A.3.4 Licensing Providing Simpack Access to your License Server

You can enter more than one con guration le in the 'Simpack Options - Licensing' dialog. The
full path and name of the con guration les must be separated by a semicolon, ';'. For example,
the same information can be entered in the different con guration les. Therefore, if one of the
con guration les cannot be accessed, the server and port information can still be retrieved
from another con guration le.
For more information on selecting the con guration le, see A.3.4.

A.3.4.4 General Settings

This section describes the general license server settings.

Figure A.3.3: 'Simpack Options - Licensing' dialog OLicense speci c - accessing the local
machine

− License server timeout:

This option is used to tell Simpack how long to wait when checking if the entered license
servers are valid or not. Simpack checks if the servers are available and, when available,
if at least one key is available on the server. If a key is not available, the server is
considered invalid. This timeout determines how long this check is performed. If set to
less than '1', the default value of 10 seconds per entered server is used. For example,
if three multiple servers are entered with the value set to '10', Simpack tries for a total
of 30 seconds. Redundant servers are considered, however, to be one server instance.
For example, if three servers are entered, Simpack tries for a total of only 10 seconds. If
this option is set to greater than '1', the number of seconds applies for the entire call to
the license servers and not for each individual server, if multiple servers are entered. For
example, if three multiple servers are entered and this variable is set 20, Simpack tries
for a total of 20 seconds.
− License checkout timeout:
This option is used to tell the Simpack executable how long it should wait for the re-
sponse of the license servers to provide Simpack with the required licenses when the
respective executable is started. If all licenses cannot be obtained in the speci ed time,
the executable will not start. If this option is set to less than 0, the servers will keep trying

Simpack 2018 Documentation. Copyright © 2017 Dassault Systemes Simulia Corp. All rights reserved.
A.3.5 Licensing Checking the License Con guration and Usage from the Simpack GUI 31

inde nitely.
The default is 0 seconds. This is appropriate in most cases; however, if Simpack is having
problems in accessing all the required licenses, this value can be increased.
This option applies to all the different ViewSets and executables.
− License loss timeout:
This option is used to tell Simpack how to react when one or more of the required licenses
are no longer available. You enter the number of seconds before the simulation quits. If
set to '-1', Simpack waits inde nitely. This option applies only to the solver and to scripting
(however, it does not apply to scripts called from the user interface).
− Token based licensing
Tokens will be checked out from the license server for the Solver s and Simpack Post in
silent mode. This option must be set explicitly. If not enough tokens are available, the
respective process will not start. You are warned if this option is selected and none of the
entered license servers have tokens.
− Perform License Enquiry
See sec. A.3.5.1 'License Servers Status'.
− Show Overall License Usage
See sec. A.3.5.2 'License Key Usage for Current Simpack Pre Session'.
− Show Current Model License Requirements
See sec. A.3.5.3 'Current Model License Key Requirements'.

A.3.5 Checking the License Con guration and Usage from the
Simpack GUI

You can check the current license con guration and usage from the Simpack main user inter-
face.
You can also check the licensing environment (that is, the con guration) and the current status
of the license servers (for example, how many licenses are available and who is currently using
the licenses). You can see which licenses are being used in either the current Simpack Pre
session or model.
The 'Simpack Options - Licensing' dialog is accessed from:
Extras ⇒ Licensing...
The following options are available from this dialog:
ˆ Perform License Enquiry shows the respective license server information (see
sec. A.3.4 'Perform License Enquiry').
ˆ Show Overall License Usage shows the license keys used in the current Simpack Pre
session (see sec. A.3.5.2 'License Key Usage for Current Simpack Pre Session').
ˆ Show Current Model License Requirements shows the license key requirements (in
Simpack Pre) for the current model (see sec. A.3.5.3 'Current Model License Key Re-
quirements').

Simpack 2018 Documentation. Copyright © 2017 Dassault Systemes Simulia Corp. All rights reserved.
32 A.3.5 Licensing Checking the License Con guration and Usage from the Simpack GUI

A.3.5.1 License Servers Status

You can check the status of the license servers.The 'Simpack Options - Licensing' dialogis
available from Extras ⇒ Licensing....
Click on Perform License Enquiry to call the license servers and to return the following infor-
mation to the window:
ˆ 'Used Server(s)' - The server names, ports, and versions.
ˆ 'Command' - This call uses the command line tool to access the servers. The respective
command line options are shown.
ˆ 'Server(s)' - The server names and ports.
ˆ 'List of requested licenses:' - Displays the following:
'VersionRange' - The versions with which the license can be used.
'Licensee' - Your company name, which licenses are available, and the name of the
server.
'License-ID' - The encrypted ID of your imported license key le.
'Modules' - The name of the key and the model (for example, oating). The total
number of licenses on the server and, if locked, by whom. The respective OLi-
cense server setting must be active to see who has locked the oating licenses (see
A.3.3.4.2). The expiration date is also available.

Figure A.3.4: Perform License Enquiry

An OLicense example is shown below:

Enquiry for server: localhost:80:0
----------------------------------------------------------------------------
Command ... E:/SIMPAC~1.0/extern/win32/olicense/olixtool.exe -OLicenseServer localhost:80:0 -AppName SIMPACK

Simpack 2018 Documentation. Copyright © 2017 Dassault Systemes Simulia Corp. All rights reserved.
A.3.5 Licensing Checking the License Con guration and Usage from the Simpack GUI 33

Output .... /
|olixtool - OLicense XML Status Application
|Copyright (C) 2007-2008 Optimum GmbH, Karlsruhe, Germany
|
|Server: <localhost:80:0> (Proxy: <>)
|
|List of requested licenses:
|
|==============================================
|Application: SIMPACK
|VersionRange: 0-90900
|Licenser:
|Licensee: FCB, 2013-04-15_CL_tokens_wizard, messi
|License-ID: FCB-1bd0d4a3@1319800046312eMTJtjgrDCd
|Modules:
| Name; LicenseType; FloatCount; Expiration
| --------------------------------------------
| token; FreeFloating; 5000; 2013-08-31 00:00:00;
| wizard_gui; FreeFloating; 1; 2013-08-31 00:00:00;
|
|==============================================
|Application: SIMPACK
|VersionRange: 0-98000
|Licenser:
|Licensee: FCB, 2013-04-15_CL_gearwheel, villa
|License-ID: FCB-1cd0d4a3@645311eNTJtjgrXCdbroUjoC
|Modules:
| Name; LicenseType; FloatCount; Expiration
| --------------------------------------------
| ani; FreeFloating; 2; 2013-12-31 00:00:00;
| gearwheel_gui; FreeFloating; 2; 2013-12-31 00:00:00;
| gearwheel_slv; FreeFloating; 2; 2013-12-31 00:00:00;
| gui; FreeFloating; 2; 2013-12-31 00:00:00;
| 1 FloatsLockedBy:
| [email protected]
|
| plot; FreeFloating; 2; 2011-12-31 00:00:00;
| solver; FreeFloating; 2; 2011-12-31 00:00:00;

This information can be copied and pasted from the 'License Status Enquiry' dialog.
You can also check the licenses you have imported to your servers by using the OLicense
server Browser Frontend, which is started from the OLicense-Server-Control user interface on
the machine running the server. The Browser Frontend can be opened once the server is
running.

A.3.5.2 License Key Usage for Current Simpack Pre Session

You can check which license keys are in use for the current Simpack Pre session.
Click on Extras ⇒ Licensing..., and then select the push-button Show Overall License Us-
age.
*********************************************************
* License Usage for Current Session:
*********************************************************

Simpack 2018 Documentation. Copyright © 2017 Dassault Systemes Simulia Corp. All rights reserved.
34 A.3.5 Licensing Checking the License Con guration and Usage from the Simpack GUI

1x KAU(autoplus_gui)
1x KRO(rolling_bearing_gui)
1x KPR(gui)
*********************************************************

A.3.5.3 Current Model License Key Requirements

You can check which license keys are required to load the current model in Simpack Pre.
Click on Extras ⇒ Licensing..., and then select the push-button Show Current Model Li-
cense Requirements.
Each of the different Modeling Elements that require speci c modules are listed for the current
model. Some Modeling Elements can be licensed via different modules; this is the case if more
than one license key is shown. The preferred (that is, checked out rst) license key is shown
rst.
In the example below, the Modeling Element $C_Controller can be licensed with either: con-
trol_gui, autoplus_gui, or wheelrail_gui. See About Simpack Licensing (A.3.1) for information
about Modeling Elements that can be licensed via multiple keys.
*********************************************************
License Requirements for Model:
CE_168_SIMPACK_demo_01.spck
*********************************************************
KPR(gui):
- CE_168_SIMPACK_demo_01.spck

KAU(autoplus_gui):
- $J_Chassis
- $F_Tire_fl
- $F_Tire_fr
- $F_Tire_rl
- $F_Tire_rr

KCO(control_gui), KAU(autoplus_gui):
- $M_Chassis_steering
- $C_Sensor

KCO(control_gui), KAU(autoplus_gui), KRL(wheelrail_gui):

- $C_Controller
*********************************************************

In addition to this check, a le is generated in the model result directory (see the Simpack main
documentation) when the model is loaded by one of the Simpack executables (for example,
Simpack Pre). This le has the model basename with the extension '.licreg.log'. It contains the
same information as when you click the push-button Show Current Model License Require-
ments, as well as the licensing information sorted by each Modeling Element category. For
each Modeling Element that requires a license, the Modeling Element name and type, as well
as the license key ('feature') is shown. If a '-' is shown under 'Alternative feature', this Modeling
Element can be licensed only with the key under 'Mandatory features'. If keys are shown under
'Alternative feature', this Modeling Element can also be licensed with one of these keys. The
additional information is shown here:

Simpack 2018 Documentation. Copyright © 2017 Dassault Systemes Simulia Corp. All rights reserved.
A.3.5 Licensing Checking the License Con guration and Usage from the Simpack GUI 35

Body requirements:
==================
./.

Marker requirements:
=====================
1. Type = 85
Name = $M_Chassis_steering
Mandatory features = control_slv
Alternative feature = autoplus_slv
-------------------------------------------------------------

Joint requirements:
===================
1. Type = 19
Name = $J_Chassis
Mandatory features = autoplus_slv
Alternative feature = -
-------------------------------------------------------------

Force requirements:
===================
1. Type = 253
Name = $F_Tire_fl
Mandatory features = autoplus_slv
Alternative feature = -
-------------------------------------------------------------
2. Type = 253
Name = $F_Tire_fr
Mandatory features = autoplus_slv
Alternative feature = -
-------------------------------------------------------------
3. Type = 253
Name = $F_Tire_rl
Mandatory features = autoplus_slv
Alternative feature = -
-------------------------------------------------------------
4. Type = 253
Name = $F_Tire_rr
Mandatory features = autoplus_slv
Alternative feature = -
-------------------------------------------------------------
5. Type = 168
Name = $C_Sensor
Mandatory features = control_slv
Alternative feature = autoplus_slv
-------------------------------------------------------------
6. Type = 151
Name = $C_Controller
Mandatory features = control_slv
Alternative feature = autoplus_slv wheelrail_slv
-------------------------------------------------------------

Constraint requirements:
=========================
./.

Result requirements:
=========================

Simpack 2018 Documentation. Copyright © 2017 Dassault Systemes Simulia Corp. All rights reserved.
36 A.3.6 Licensing Loss of License

./.

Filter requirements:
====================
./.

Primitive requirements:
====================
./.

A.3.6 Loss of License

This section describes the behavior for Simpack Pre and the solver if you lose your either your
GUI or solver license.
When the respective executable is started, the required license keys are checked out from the
license server and remain so until the executable is closed. Simpack continually checks that
the license servers are available while the executable is running. Therefore, it is possible to
lose one or more license servers during modeling or running a simulation (for example, if the
connection is interrupted or the server has been stopped).
To prevent licenses being lost when working with Simpack, especially when performing a sim-
ulation, you can set up a redundant server system. If one server fails, the other servers can
provide the licenses. For more information on network licenses, see A.3.3.3.

A.3.6.1 Loss of GUI license(s)

If any of the required 'gui' license keys are no longer available, the following dialog Figure A.3.5
appears:

Figure A.3.5: Loss of license server

You are informed every 30 seconds that the license is not available, and Simpack eventually
closes. If the license is available once again, these dialogs will stop appearing and you can
carry on working as normal. If the license is not found again within ve minutes, Simpack
closes. You can save the model before it is closed.

A.3.6.2 Loss of Solver license(s)

If any of the required solver licenses are no longer available, the Simpack solver pauses. You
can controll the behavior of Simpack (that is, whether Simpack waits until the license is available
again and for how long or whether the simulation ends immediately). For more information, see
A.3.4.4.

Simpack 2018 Documentation. Copyright © 2017 Dassault Systemes Simulia Corp. All rights reserved.
A.3.7 Licensing Academic Licenses 37

A.3.7 Academic Licenses

The use of academic licenses is limited. Details can be found in the transaction documents.
For any questions, please contact your SIMULIA sales partner.
The following modules are available in an academic version:
ˆ Simpack Pre, see the Simpack main documentation,
ˆ Simpack Post, see the Simpack main documentation,
ˆ Simpack Tokens, see the Simpack main documentation,
ˆ Simpack Solver, see the Simpack main documentation (for maintenance purposes only).
The academic licenses use is printed when the solver starts and terminates. Usage of the
academic license is also shown in the decoration of the Simpack user interface and in the
'About Simpack' dialog.
If Simpack Post runs on an academic license or accesses a Simpack result le generated with
an academic license, then:
ˆ The decoration and about dialog are adapted accordingly and,
ˆ The Simpack academic logo is displayed in the Footer of each Page:

Some users may have both academic and commercial licenses. If both commercial and aca-
demic licenses are available, the commercial licenses will always be checked out. An academic
license key is requested only if the corresponding commercial license key is not available.
Academic licenses and commercial licenses cannot be mixed on the same license server.
Therefore, you will need to set-up to two separate license servers: one running the commercial
licenses and the other running the academic licenses. The Simpack license con guration must
be modi ed respectively to use the required server. For more information on modifying the
con guration, see sec. A.3.4 'Providing Simpack Access to your License Server'.

Simpack 2018 Documentation. Copyright © 2017 Dassault Systemes Simulia Corp. All rights reserved.
38 A.4.2 Simpack Installation Installation from the Wizard

A.4 Simpack Installation

This section describes what actions are performed during the installation, how to acquire Sim-
pack, and how to run the installation in the different modes.

A.4.1 Actions taken by the Simpack Installation

This section describes the actions performed by the Simpack installation.

The installation does the following:
ˆ Extracts the selected components of the installer binary to the desired destination direc-
tory.
ˆ Generates the uninstaller binary. The uninstaller removes all the components, including
icons, created by the install process.
ˆ Creates a log le of the installation.
ˆ Creates desktop icons.
ˆ Adds entries to the Windows Start menu: 'Simpack 2018', as well as a shortcut to 'Sim-
pack 2018 Documentation'. The shortcut is not 32-/64-bit speci c; if both versions are
installed, the shortcut points to the last installed version. This menu item contains the
same items as the desktop icons. In addition, it adds a shortcut to the Uninstaller (A.4.5).
ˆ Creates the Simpack speci c le extensions (for example, .spck) that can be associated
with the operating system as an option during the installation (Windows only). For more
information, see the Simpack main documentation.

A.4.2 Installation from the Wizard

You can install Simpack from the wizard.

When you start the wizard from the command line, you can pass command line arguments to
the wizard that will be used instead of the default values described in this section. For more
information on the allowed arguments, see sec. A.4.3.1.1.
If you start the binary from the command line on Linux and the display is neither set nor avail-
able, the installer automatically switchs to 'text' mode (see A.4.3.2).
To install Simpack from the wizard, you need to perform the following steps:

Simpack 2018 Documentation. Copyright © 2017 Dassault Systemes Simulia Corp. All rights reserved.
A.4.2 Simpack Installation Installation from the Wizard 39

1. Start the installer binary either directly from the explorer on Windows or from the shell on
Linux. The installer binary can also be started from the Command Prompt on Windows.
2. This will start the installer, and the splash screen appears before the welcome page ap-
pears:

3. Click Next to proceed to the 'Installation Directory' page. Select the directory where you
want to install Simpack. The default directory is:
ˆ %SYSTEMDRIVE% (normally 'C:\)\Program Files\SIMPACK-9.8 on Windows,
ˆ On Linux when running as root, the directory is /opt/SIMPACK-9.8. When running as
a standard user, the directory is $HOME/SIMPACK-9.8.
See Usage Notes (A.4.6) for more information on the installation directories and paths
that can be used.

4. Proceed to the 'Select Components' page to select which components are to be installed:

Simpack 2018 Documentation. Copyright © 2017 Dassault Systemes Simulia Corp. All rights reserved.
40 A.4.2 Simpack Installation Installation from the Wizard

Simpack, the OLicense license server, and/or DS License Server. See sec. A.3.2 'Licens-
ing with DS License Server' or sec. A.3.3 'Licensing with the OLicense Server', respec-
tively.

5. Proceed to the 'File Associations' page to register the le name extensions with the Sim-
pack executables (see the Simpack main documentation).

6. Proceed to the 'Ready to Install' page. Click Next.

Simpack 2018 Documentation. Copyright © 2017 Dassault Systemes Simulia Corp. All rights reserved.
A.4.2 Simpack Installation Installation from the Wizard 41

7. The binary starts to unpack the selected components to your destination directory.

8. Once the unpack completes, you can start Simpack.

Simpack 2018 Documentation. Copyright © 2017 Dassault Systemes Simulia Corp. All rights reserved.
42 A.4.3 Simpack Installation Installation from the Command Line

A.4.3 Installation from the Command Line

You can call the installer from the command line, either with or without starting the wizard.
There are four modes available on Linux and two modes available on Windows:
ˆ Linux:
gtk or xwindow - These modes both start the wizard; that is, the installer GUI (see
Installation from the Wizard (A.4.2)). If either of these modes is selected and the
display is not set or available, the mode switches to Command Line Arguments
(A.4.3.1.1).
'text' - This mode prompts the user to enter the required options via prints from the
standard output (see sec. A.4.3.2 'Text Mode'). This mode can be started explicitly
or it is switched to automatically when the display is not set or available.
'unattended' - This mode is run without user input once the binary is executed and
can be included in an install script (see Unattended Mode (A.4.3.1)).
ˆ Windows:
win32 - This mode starts the Installation from the Wizard (A.4.2). If this mode is
selected and the display is not set or available, the mode switches to Command
Line Arguments (A.4.3.1.1).
'unattended' - This mode is run without user input once the binary is executed and
can be included in an install script (see Unattended Mode (A.4.3.1)).
The 'unattended' and 'text' modes are explained in more detail in this section. The 'gtk', 'xwin-
dow', and 'win32' modes all start the wizard, which is explained in sec. A.4.3.2 'Text Mode'.
See Usage Notes (A.4.6) for more information on the installation directories and paths that you
can use.

Simpack 2018 Documentation. Copyright © 2017 Dassault Systemes Simulia Corp. All rights reserved.
A.4.3 Simpack Installation Installation from the Command Line 43

A.4.3.1 Unattended Mode

Unattended mode runs without the user having to enter any more inputs once the binary has
been called.
This is particularly useful when automating the installation process or running the installation
from a shell script (for example, as a large install process throughout an entire company). You
can use environment variables for the installation directory (see Usage Notes (A.4.6)).
Unattended mode can be run using command line arguments or with an options le. The
options are the same in both cases and are described in sec. A.4.3.1.1 'Command Line Argu-
ments'. If an argument is not entered, the default value is used.
You can activate unattended mode using the following:
--mode unattended
Once the installation has been run, you can view the Installation Log le (A.4.4).

Note:

You can display certain pop-up dialogs to show the status of the installation (see
sec. A.4.3.1.1 'unattendedmodeui').

A.4.3.1.1 Command Line Arguments

The command line arguments set the options for the installation.
The available command line options are described below. The option 'mode' is shown for the
different operating systems; otherwise, the output is shown for Windows.
Simpack 9.10
Usage:

--help Display the list of valid options

--version Display product information

--unattendedmodeui <unattendedmodeui> Unattended Mode UI

Default: none
Allowed: none minimal minimalWithDialogs

--optionfile <optionfile> Installation option file

Default:

--mode <mode> Installation mode (win)

Default: win32
Allowed: win32 unattended

--mode <mode> Installation mode (linux)

Default: gtk
Allowed: gtk xwindow text unattended

Simpack 2018 Documentation. Copyright © 2017 Dassault Systemes Simulia Corp. All rights reserved.
44 A.4.3 Simpack Installation Installation from the Command Line

--debugtrace <debugtrace> Debug filename

Default:

--enable-components <enable-components> Comma-separated list of components

Default: Simpack
Allowed: Simpack OLicense

--disable-components <disable-components> Comma-separated list of components

Default: OLicense
Allowed: Simpack OLicense

--installer-language <installer-language> Language selection

Default: en
Allowed: en ar bg ca da nl et fr fi de el es es_AR he hr hu it ja lt ko

--prefix <prefix> Installation Directory

Default: C:\Program Files (x86)/Simpack-9.10

--registerExtension <registerExtension> Register filename extensions?

Default: 1

help The available options are printed to the standard output along with the required syntax
and allowed arguments. There should be a space between the respective option and its
argument; for example,
--enable-components simdoc

In addition, the respective defaults for each option are shown. If the option is not entered, these
defaults are used.

version This option returns the Simpack version along with the build date.

unattendedmodeui This option determines the amount of user interaction in Unattended

Mode (A.4.3.1). Certain pop-up dialogs can be displayed to show the installation process or
even to end the installation. The following options are available:
ˆ 'none' (default) - No pop-up dialogs are shown
ˆ 'minimal' - A progress pop-up dialog is displayed showing the installation progress
ˆ 'minimalWithDialogs' - Same as minimal

option le The name of the le that contains the options is entered as the argument. For
more information, see sec. A.4.3.1.2 'Options File Approach'.

mode This option selects the installation mode. All platforms types can be run using the
wizard (win32/64 or xwindow on Windows and Linux, respectively) or in 'unattended' mode

Simpack 2018 Documentation. Copyright © 2017 Dassault Systemes Simulia Corp. All rights reserved.
A.4.3 Simpack Installation Installation from the Command Line 45

(see sec. A.4.2 'Installation from the Wizard' and Unattended Mode (A.4.3.1)). Linux can also
be installed using 'text' mode, whereby the options are entered in the standard output when
prompted (see sec. A.4.3.2 'Text Mode').
If the wizard cannot be started on Linux when 'xwindow' is selected, the installer automatically
switches to 'text' mode.

debugtrace This option produces a debug binary le. This le can be read only by BitRock.
If you are having problems with the installation, please send your Installation Log le (A.4.4),
rather than running the debugtrace.

enable-components This option adds the selected components to those that are to be in-
stalled.
ˆ Simpack
ˆ OLicense
If more arguments are entered, they should be separated with a comma and without spaces.

disable-components This option removes the selected components from the installation.
The syntax is the same as for '--enable-components'.

installer-language Sets the language for the texts provided by BitRock (software upon which
the Simpack installer is built). The Simpack speci c texts are always displayed in English.

pre x This option sets the directory in which the selected components are installed.
The directory syntax can be as follows:
ˆ C:/SIMPACK (Windows) or /home/simpack (Linux)
ˆ ./mysimpack
ˆ $MYSIMPACK - Environment variables cannot be used in an options le.
See the Usage Notes (A.4.6).

registerExtension Registers the Simpack speci c le extensions with the operating system
(Windows only) and are associated with the respective Simpack executable. For more informa-
tion, see the Simpack main documentation.
Entering '1' (default) in the argument registers the les, '0' does not.

A.4.3.1.2 Options File Approach

The options le approach reads-in a le to set the installation options. The options used in the
options le are the same as those described in Command Line Arguments (A.4.3.1.1).
The respective options and arguments in the options le must be separated by an = sign. The
options are entered without the preceding hyphens (-).

Simpack 2018 Documentation. Copyright © 2017 Dassault Systemes Simulia Corp. All rights reserved.
46 A.4.3 Simpack Installation Installation from the Command Line

The following example shows the syntax of the options le:

disable-components=codexport
mode=unattended

Note:

ˆ The path to the options le can be either absolute or relative.

ˆ Environment variables cannot be used in an options le.

A.4.3.2 Text Mode

In text mode the user is prompted to enter the required options via prints from the standard
output.
This mode can be explicitly started or is switched to automatically when the display is not
available.
It is available only for Linux.
You can start text mode explicitly from the command line by using the following option:
--mode text
The options available in text mode mirror those available from the wizard (see sec. A.4.2 'In-
stallation from the Wizard').

A.4.3.3 Building Simpack User Routines

It is often necessary not only to install Simpack itself but also to make existing Simpack user
routines available for all users. User routines exist as source code (Fortran or C) in a speci c
directory (the user routines directory), and the build process compiles them and links them into
a shared library that will be read by Simpack.
The automatic build process can be invoked from the command line. If a valid Simpack user
con guration initialization le (see the Simpack main documentation) already exists and the
build is executed on the computer where Simpack has been installed, the build process runs
automatically. Otherwise, the build must be controlled by command line parameters (for more
information, see the Simpack main documentation).
The necessary compilers and the linker need to be properly installed before Simpack.
Once the shared user routines library has been created, there are two ways to distribute the
routines over the various user installations:
ˆ A common Simpack initialization (.ini) le containing prede ned user routines settings
and the user routines path can be created and distributed to the users (see the Simpack
main documentation). The user routines shared library must then be copied to the individ-
ual user routines subdirectories (see the Simpack main documentation). This method is
recommended only if default user routines are provided that the users can modify them-
selves.

Simpack 2018 Documentation. Copyright © 2017 Dassault Systemes Simulia Corp. All rights reserved.
A.4.6 Simpack Installation Usage Notes 47

ˆ Alternatively, the user routines shared library can be copied to a default subdirectory of
the individual Simpack installations, where it will be automatically found if the user has not
speci ed his own user routines path. The default directory is the '/defaults/lib/<platform>'
subdirectory of the Simpack installation directory, where '<platform>' is one of 'win32',
'win64', 'linux32', or 'linux64'. The 'defaults' directory already exists in each installation.
This method is recommended particularly if the users are not allowed to create or modify
the user routines.

A.4.4 Installation Log le

Independent of which mode you use to install Simpack, the installer generates an installation
log le.
The installation log le has the name bitrock_installer_*.log.
The log le is located in the following directory:
ˆ Windows %TMP% usually:
C:\Documents and Settings\USER\Local Settings\Temp
ˆ Linux in /tmp

A.4.5 Uninstaller

The Simpack uninstaller removes all the components selected during the installation.
In addition to removing all the components selected during the installation, the Simpack in-
staller removes the icons and start menu items. The uninstaller will not, however, remove the
directories generated by the user con guration.
The uninstallation on Windows can be run from the 'Start' menu:
'Settings → Control Panel → Add/Remove Programs'

A.4.6 Usage Notes

This section describes particular items to note when using the Simpack installer.
ˆ UNC paths on Windows are not supported; for example, \\mycomputer. Network drives
can, however, be used; for example, L:/.
ˆ When using the Simpack User module (see the Simpack main documentation), the path
to the Simpack installation directory and to the user routines directory (see the Simpack
main documentation) must not contain any non-ASCII characters.
ˆ The install directory must be writable.
ˆ The binary must be executable; for example, set with the command 'chmod 755'.
ˆ The Simpack installation does not require administrator/root privileges. However, the
installation of the license server, OLicense, does require administrator/root privileges.
For the OLicense installation guide, see sec. A.3.

Simpack 2018 Documentation. Copyright © 2017 Dassault Systemes Simulia Corp. All rights reserved.
48 A.4.6 Simpack Installation Usage Notes

ˆ Simpack requires the Microsoft® Visual C++ redistributables Studio 2005, 2008, and
2010. If these are not already installed, they will be installed during the Simpack in-
stallation; their installation requires administrator privileges.
ˆ Unattended mode uses the defaults when not explicitly entered.
ˆ The path to the options le can be relative or absolute
ˆ The path must have forward slashes in msys or on Linux. On Windows from the command
prompt either back- or forward slashes can be used.
ˆ The installer uses the following defaults:
Wizard mode
All components are enabled
Installation directory -
Windows is %SYSTEMDRIVE% (normally C:\)\Program Files\SIMPACK-9.8.
On Linux when running as root the directory is /opt/SIMPACK-9.8. When running as
a standard user the directory is $HOME/SIMPACK-9.8.

Simpack 2018 Documentation. Copyright © 2017 Dassault Systemes Simulia Corp. All rights reserved.
Simpack Documentation

Guide B
DS License
Server
Documentation

Simpack Release 2018

Copyright © 2017 Dassault Systemes Simulia Corp. All rights reserved.
DS License Server
Installation and Configuration Guide
3DEXPERIENCE R2016x
Contains JAVA SE RUNTIME ENVIRONMENT (JRE) VERSION 8
Contains IBM(R) 64-bit SDK for AIX(TM), Java(TM) Technology Edition, Version 8
(c) Copyright Oracle and/or its affiliates, 1992 - 2014
(c) Copyright IBM Corporation, 1998 - 2012
(c) Copyright The Apache Software Foundation, 1999 - 2007

All rights reserved.

Contents
Overview..........................................................................................................................1
What's New?....................................................................................................................2
Installing the DS License Server...................................................................................3
Before Starting the Installation..........................................................................................................3
Operating System Prerequisites..................................................................................................................3
License Server and Client Typical Setup.....................................................................................................3
Preliminary Remarks...................................................................................................................................4
Upgrading Your License Server...................................................................................................................4
Installing the DS License Server on Windows...................................................................................5
Installing Only the License Administration Tool on Windows...........................................................12
Installing the DS License Server on UNIX......................................................................................20
Upgrading Your License Servers in a Failover Cluster....................................................................21
Uninstalling the DS License Server.................................................................................................22
Uninstall on Windows................................................................................................................................22
Uninstall on UNIX......................................................................................................................................23
Configuring the DS License Server and Clients........................................................25
Starting the License Administration Tool.........................................................................................25
Configuring and Activating a Standalone License Server...............................................................26
Configuring and Activating a Cluster in Failover Mode....................................................................38
Maintaining Continuous Failover Cluster Operation........................................................................53
Replace a Failover Member.......................................................................................................................53
Rename a Member....................................................................................................................................55
Replace the Network Card of a Failover Member......................................................................................56
Repair Corrupted Data of a Member.........................................................................................................58
Starting and Stopping the DS License Server................................................................................59
Configuring Clients..........................................................................................................................62
Communicating through Forward and Reverse Proxies..................................................................63
Implement a Forward Proxy for the License Administration Tool...............................................................63
Implement a Reverse Proxy for the DS License Server............................................................................65
Managing Licenses.......................................................................................................68
Enrolling Licenses...........................................................................................................................68
Administering Licenses...................................................................................................................70
Getting Information About License Usage......................................................................................75
Recycling Named User Licenses....................................................................................................82
Setting License Authorization Rules...............................................................................................83
Importing and Exporting License Authorization Rules..................................................................102
Export Authorization Rules......................................................................................................................102
Import Authorization Rules......................................................................................................................104
Getting Information About the Authorized Country of Use for Licenses........................................108
Tracking License Server Operation...........................................................................113
Tracking License Statistics............................................................................................................113
Tracking Server Logs.....................................................................................................................116
Monitoring the Server....................................................................................................................118

DS License Server 3DEXPERIENCE R2016x Installation and Configuration Guide i

Contents

Reference....................................................................................................................123
DSLicSrv Command......................................................................................................................123
DSLicTarget Command Syntax.....................................................................................................136
Protocol and Cipher Suite Control.................................................................................................137
File Locations, Settings and Registry Entries................................................................................138
Port Management..........................................................................................................................141
Troubleshooting.............................................................................................................................141
Client cannot communicate with server...................................................................................................141
Poor communication performance between a Windows client and any server........................................142
Poor client performance at startup..........................................................................................................143
Nodelock or extracted offline license cannot be granted to the client application...................................143
Reducing launch duration........................................................................................................................143
Reducing timeout when a failover member is down................................................................................143
Error, Information and Warning Messages....................................................................................144

ii DS License Server 3DEXPERIENCE R2016x Installation and Configuration Guide

 Overview

Overview
Welcome to the DS License Server 3DEXPERIENCE R2016x Installation and Configuration Guide, designed
to answer all your questions about installing and configuring the DS License Server.

DS License Server 3DEXPERIENCE R2016x Installation and Configuration Guide 1

What's New?

What's New?
This section describes the new and enhanced functionality in the DS License Server.

New Functionality
New command line options for startInstLicServ command on UNIX: new -licensingPort
installation on UNIX nnn and -enroll filename options.
New license server initialization DSLicSrv -initServer command: new -licensingPort
command line options nnn and -enroll filename options.
License usage tracing The new USGTRACING category provides detailed license usage
tracing in the license server logs.
Protocol and Cipher Suite Selection
You can now control the list of SSL protocols and cipher suites the
license server is allowed to use.
New options added to DSLicSrv -startServer command:
• -disableSSLProtocol protocol
• -cipherSuitesPath filename

Enhanced Functionality
Installation enhancements
• all input data is concentrated in only one dialog box panel for license server
installation on Windows
• ability to enroll a license file at installation time
• ability to set administration and licensing ports at installation time.

Allow/Deny authorization It is now possible to set allow and deny authorization rules for further restricting
rule for offline license the offline extraction. The -rule option has been added correspondingly to the
extraction createOfflineRestrictions command, the
listOfflineRestrictions command now lists the new rules, in addition
to keywords and maximum durations, and the already existing
<authorizationlist> block can now appear in the
<offlinerestrictions> block within an XML file containing authorization
rules.

Removed Functionality

Customizing Preferences

User Assistance

2 DS License Server 3DEXPERIENCE R2016x Installation and Configuration Guide

 Installing the DS License Server

Installing the DS License Server

This section explains how to install the DS License Server.

Before Starting the Installation

This section briefly presents what a typical license server and license client setup looks like, and highlights
certain points you must keep in mind before performing the installation.

Operating System Prerequisites

The following operating systems are supported:
• Windows 7 SP1 64-bit x86 (not for failover)
• Windows 8.1 64-bit x86 (not for failover)
• Windows Server 2008 R2 SP1 64-bit x86
• Windows Server 2012 R2 64-bit x86
• Red Hat Enterprise Linux 6.n 64-bit x86 (where "n" is greater than or equal to 5)
• SUSE Linux Enterprise Server 11 SPn 64-bit x86 (where "n" is greater than or equal to 3)
• SUSE Linux Enterprise Server 12
• AIX 7.1 TL2 SP3 64-bit Power
A minimum of 2GB of RAM is required, 4GB of RAM are recommended for a standalone server, 8GB for
failover.
For more detailed information about prerequisites, see the Program Directory.

License Server and Client Typical Setup

A license server helps the administrator to guarantee the license control is implemented in compliance with
purchased licensed products embedding the license client.
A typical license server and client setup looks like this:

DS License Server 3DEXPERIENCE R2016x Installation and Configuration Guide 3

Installing the DS License Server

The DS License Server is installed on a server machine on your network. The license administrator enrolls the
product licenses on the server. The applications embedding license clients communicate with the license server
over the network and retrieve the licenses from the license server.

Preliminary Remarks
Before you start the installation, keep the following points in mind.
Virtual machines, such as VMWare, are not supported. It is not possible to either run or install the DS License
Server on a virtual machine. Furthermore, extracting an offline license and using a nodelock license in a virtual
machine are not supported.
Only one DS License Server can be installed and configured on a given computer, either as a standalone or as
a failover member.
License servers and license client must be synchronized. An absolute time difference of one hour maximum is
tolerated.

Upgrading Your License Server

Keep in mind the following when you install a new version of the DS License Server:
• each version of (or hot fix for) the DS License Server is complete, in other words, it is installed in place of
the existing version, so the existing version must be uninstalled beforehand
• uninstalling the DS License Server does NOT remove license keys, settings or log files
• failover members can communicate with each other only if they are at the same license server code level.
Be aware that upgrading failover cluster members from a given license server code level to a higher code
level will prevent the failover cluster from functioning while you are upgrading the second member. Once
the second cluster member has been upgraded, normal failover operation resumes.
To upgrade your license servers in a failover cluster, refer to Upgrading Your License Servers in a Failover
Cluster.

4 DS License Server 3DEXPERIENCE R2016x Installation and Configuration Guide

 Installing the DS License Server

Installing the DS License Server on Windows

This task explains how to unload the DS License Server on a single computer running a supported Windows
operating system.
Installation and de-installation rely on Windows-compliant tools enabling anyone familiar with Windows
procedures and concepts to install the software without assistance.

1. Log on as an administrator.
You must belong to the Administrators group, or have the privileges assigned to the Administrators group.
Otherwise, you will not be able to start the installation.
2. Insert the media into the drive.
A dialog box appears informing you that the installation is about to commence, followed by the dialog box
welcoming you to the DS License Server setup wizard:

Click the Next button to move to the next step.

3. Specify the installation folder and installation type.

The Installing DS License Server dialog box appears:

DS License Server 3DEXPERIENCE R2016x Installation and Configuration Guide 5

Installing the DS License Server

The default destination folder is:

C:\Program Files\Dassault Systemes\DS License Server
If the default destination folder is not suitable, click the Browse... button and navigate to select another folder
and click OK. The folder you choose must be empty. You can also specify a new folder: if the folder does
not exist, you will be prompted to specify that you want the folder to be created, in which case you must
click the Yes button to create the folder.
Then select the installation type. You have two choices:
Install only Administration Tool Allows you to install only the License Administration Tool.
See Installing Only the License Administration Tool on
Windows for more details.
Install License Server and Administration Default.
Tool

In our example, we are going to install both the License Server and the License Administration Tool, so use
the default Install License Server and Administration Tool option.

4. Decide whether to install from scratch or not.

Installing from scratch means that you are installing the DS License Server and also deleting all previous
licenses in the license repository. This may be necessary, for example, if your licenses have been corrupted.

6 DS License Server 3DEXPERIENCE R2016x Installation and Configuration Guide

 Installing the DS License Server

To do so, check the Install Server from scratch check button. The warning is displayed again, informing
that all licenses will be deleted if you continue:

You can of course install the license server and use the existing licenses, for example when you are upgrading
the license server. In this case, the options enabling you to enroll a license and specify ports are not displayed.
Click OK to clear the warning, then decide whether to continue installing from scratch, or uncheck the check
box if you want to keep your existing licenses.
If you decide NOT to install from scratch, you will be ready to launch the installation. Note that you will
need to configure and activate the license server later.
If you DO decide to install from scratch, additional options become available, enabling you to enroll a license
file and configure and activate the license server at installation time:
Enroll a License File Check this option and browse to select a license file to quickly enroll your
licenses at installation time.
Administration Port The port number you set is used to listen to DS License Server
administration tool requests. The default is 4084.
Licensing port: The port number you set is used to listen to licensing client requests. The
default is 4085.

If you do not specify different ports now, the default port numbers will be used.

DS License Server 3DEXPERIENCE R2016x Installation and Configuration Guide 7

Installing the DS License Server

Click the Next button to move to the next step.

5. Install the DS License Server.
The Ready to install DS License Server dialog box appears:

Click the Install button to install the DS License Server. If prompted by UAC to confirm, click the Yes
button.
A progress bar is displayed while the DS License Server files are installed and the corresponding Windows
service is started. Once the installation has been completed, the following dialog box appears:

8 DS License Server 3DEXPERIENCE R2016x Installation and Configuration Guide

 Installing the DS License Server

informing you that the installation has been completed, and the License Administration Tool is launched
automatically.

6. Click the Finish button to exit the setup wizard.

The Server Definitions tab now looks like this:

DS License Server 3DEXPERIENCE R2016x Installation and Configuration Guide 9

Installing the DS License Server

Note: The License Administration Tool may communicate with forward and reverse proxies. For
more information, refer to Communicating through Forward and Reverse Proxies.

7. Connect to the license server.

You must connect to the server to be able to use it. If you point to the icon in the status column, next to
the computer name, a message like this will be displayed:
server xxx not connected
To connect to the server:
• Select the Servers - Connect command and select the server name from the list.
• Or, point to the icon, right click and select the Connect command.

• Or, you can also click the icon to connect all servers at the same time.

If you did not enroll a license during the installation, the icon appears over the computer icon like this
:

Pointing to the icon displays the following message:

licensing port not configured; check server properties
The Server Definitions tab contains the following fields:
Status Status of the license server.
Computer Name Name of the machine hosting the license server.
Computer ID Computer id of the machine hosting the license server.
Version Software version number.
Build Date Software version build date.
Operating System Operating system on which the license server is running.

10 DS License Server 3DEXPERIENCE R2016x Installation and Configuration Guide

 Installing the DS License Server

Comment
Contains an optional comment enabling you, for example, to distinguish one license
server from another when several server definitions are displayed in the list.
To edit a comment, point to a line containing a server definition line, under the
Comment column, and double-click: an editable field with a cursor is displayed.
Enter the text, then click ENTER to validate.
The comment field supports NLS characters, including DBCS. A comment can
be added and modified even if the connection to the license server is not established
or is established in restricted mode. Editing comments does not modify the license
server itself, but only the license administration tool user settings.
In the case of a failover cluster, each member has its own comment field.

When several lines are present in the Server Definitions tab, you can select multiple lines (using Shift or
Control keys and left-clicking) to connect several servers at the same time, for example.
When selecting a failover, then connecting, the connection is made to the three members at once. If a password
has been set, it has to be entered only once. To connect to only one member, do not select (left-click) but just
display the contextual menu (right-click) then connect.
When you select then copy (using Ctrl-C) one or more lines, the fields copied can be pasted together in
any other text processing program (for example, Excel). You can also simply drag lines from the License
Administration Tool and drop them into another program, without the need to copy then paste.
You can also sort the lines in ascending or descending order, by clicking on the appropriate column title.

Note: Both techniques work also in any tab containing table-formatted data, such as the Administration
tab, License Usage tab, Detailed License Usage dialog box, and Recycling tab.

When the Server Definitions tab contains several lines, by default, the lines are displayed in the order
according to the time at which the lines were added. The first line contains the first license server added. You
can change this default order by dragging and dropping a line:
• click anywhere on the line you want to move to select it
• click the line again, and hold then move the line to the appropriate location
• release to drop the line at its new location: the next time you start the License Administration Tool, the
line will be displayed by default at its new location.

Note: You can only move one line at a time.

When you add a new server in the Server Definitions tab, by selecting the Servers > New... command
or right-clicking in the tab and selecting the Add new server command, it is added to the server list bar
and automatically pre-selected. This bar is displayed at the top of the following tabs: Administration, License
Usage, Recycling, Statistics and Geolocation.
You must configure the firewall on the machine hosting the license server to enable license clients to access
the license server, using the port numbers specified in Port Management. For example, you can configure
the Microsoft firewall on Windows server machines by creating a new rule for the license server using the
Server Manager application as illustrated below:

DS License Server 3DEXPERIENCE R2016x Installation and Configuration Guide 11

Installing the DS License Server

You must now configure the server as a standalone server or a member of a cluster in failover mode and
activate it before being able to use it, as explained in Configuring and Activating a Standalone License Server
and Configuring and Activating a Cluster in Failover Mode respectively.

The installation results in the following:

• a DS License Server is installed on the local machine
• the service DS License Server is added to the list of Windows services, and is started automatically in the
Network Service account
• an installation log file is created in:
%TEMP%\DSLSmsi.log
• in the Start -> All Programs menu, the entry DS License Server is added, containing the commands License
Server Administration and License Server Documentation.

Installing Only the License Administration Tool on Windows

This task explains how to unload only the License Administration Tool (without the DS License Server) on a
single computer running a supported Windows operating system.

12 DS License Server 3DEXPERIENCE R2016x Installation and Configuration Guide

 Installing the DS License Server

Several License Administration Tool instances can be connected simultaneously to the same license server.
Only one License Administration Tool instance has complete administration access to the license server: either
the local License Administration Tool or the first one that connects to the license server remotely. The remote
License Administration Tool will have the complete administration access only if the option full is set for
the Remote administration authorization option on the license server: if the option restricted is set, the
remote tool can connect to the license server but only in restricted mode, even if no other administration tool is
connected to this license server.
The other License Administration Tool instances operate in restricted mode with the following limitations:
• no modifications are allowed in the Server Configuration dialog box
• no licenses can be deleted using the License Administration tab
• no licenses can be released using the License Release tab
• creation and/or modification operations in the Authorizations tab are not allowed.

1. Log on as an administrator.
You must belong to the Administrators group, or have the privileges assigned to the Administrators group.
Otherwise, you will not be able to start the installation.
2. Insert the media into the drive.
A dialog box appears informing you that the installation is about to commence, followed by the dialog box
welcoming you to the DS License Server setup wizard:

Click the Next button to move to the next step.

3. Specify the installation folder and installation type.

The Installing DS License Server dialog box appears:

DS License Server 3DEXPERIENCE R2016x Installation and Configuration Guide 13

Installing the DS License Server

The default destination folder is:

C:\Program Files\Dassault Systemes\DS License Server
If the default destination folder is not suitable, click the Browse... button and navigate to select another folder
and click OK. The folder you choose must be empty. You can also specify a new folder: if the folder does
not exist, you will be prompted to specify that you want the folder to be created, in which case you must
click the Yes button to create the folder.
Then select the installation type. You have two choices:

Install only Administration Tool Allows you to install only the License Administration Tool.
See Installing Only the License Administration Tool on
Windows for more details.
Install License Server and Administration Default.
Tool

In our example, we are going to install only the License Administration Tool.

4. Check the Install only Administration Tool check button.

14 DS License Server 3DEXPERIENCE R2016x Installation and Configuration Guide

 Installing the DS License Server

Click the Next button to move to the next step.

5. Install the Administration Tool.
The Ready to install DS License Server dialog box appears:

DS License Server 3DEXPERIENCE R2016x Installation and Configuration Guide 15

Installing the DS License Server

Click the Install button to install the License Administration Tool:

A progress bar is displayed while the License Administration Tool files are installed. Once the installation
has been completed, the following dialog box appears:

16 DS License Server 3DEXPERIENCE R2016x Installation and Configuration Guide

 Installing the DS License Server

informing you that the installation has been completed, and the License Administration Tool is launched
automatically.

6. Click the Finish button to exit the setup wizard.

The Server Definitions tab now looks like this:

DS License Server 3DEXPERIENCE R2016x Installation and Configuration Guide 17

Installing the DS License Server

Note: The License Administration Tool may communicate with forward and reverse proxies. For
more information, refer to Communicating through Forward and Reverse Proxies.

7. Click the Finish button to exit the setup wizard.

The License Administration Tool remains open. You now have to create a server definition for the license
server to which you want to connect using the License Server Connection Parameters dialog box:

8. Enter the name of the license server (the name of the machine hosting the server, typically), set the listening
port number for the License Administration Tool, then click OK.
You will only be able to administer a remote license server if you checked the Enable remote administration
check button when configuring the license server.

Note: The License Administration Tool may communicate with forward and reverse proxies. For
more information, refer to Communicating through Forward and Reverse Proxies.

The License Administration Tool now looks like this:

18 DS License Server 3DEXPERIENCE R2016x Installation and Configuration Guide

 Installing the DS License Server

9. Connect to the license server.

You must connect to the server to be able to use it. If you point to the icon in the status column, next to
the computer name, a message like this will be displayed:
server xxx not connected
To connect to the server:
• Select the Servers - Connect command and select the server name from the list.
• Or, point to the icon, right click and select the Connect command.

• Or, you can also click the icon to connect all servers at the same time.

The icon appears over the computer icon like this :

The installation results in the following:

DS License Server 3DEXPERIENCE R2016x Installation and Configuration Guide 19

Installing the DS License Server

• a License Administration Tool is installed on the local machine

• an installation log file is created in:
%TEMP%\DSLSmsi.log
• in the Start -> All Programs menu, the entry DS License Server is added, containing the commands License
Server Administration and License Server Documentation.

Installing the DS License Server on UNIX

This task explains how to unload the DS License Server from scratch on a single computer running a supported
UNIX operating system.

1. Log on as root.
2. Change directory to the media mount point.
3. Change directory to the appropriate sub-directory for your UNIX platform, for example on AIX:
AIX
4. Check that the DISPLAY variable is exported appropriately before continuing (or perform the installation
using the -noUI option).
5. Run the command:
./startInstLicServ
The command can be run with the following options:
Option Description
-p Set the installation path. The default value is:
/usr/DassaultSystemes/DSLicenseServer

-n Set the administration port number. The default value is: 4084

-licensingPort Set the licensing port at installation time (avoids having to set it later).

-enroll filename Enroll a .LICZ license file at installation time (avoids having to enroll it later). If enrollment fails, the
installation succeeds. Only a warning is added in the license server logs. This can happen, for example, if
the license file does not exist.

-x Prevent system file update managing automatic startup when rebooting your machine

-onlyAdminTool Installs only the License Administration Tool (without the license server)

-f Installing from scratch means that you are installing the DS License Server and also deleting all previous
licenses in the license repository. This may be necessary if your licenses have been corrupted.

-noUI Do not launch the License Administration Tool GUI. Useful when no display is available.

-noStart Do not start the license server after having installed it.

-h Display help

The installation starts and the system outputs the following:

/tmp/DSLS/AIX64
Check free port
Chosen port 4084

Installing server in /usr/DassaultSystemes/DSLicenseServer

Creating directory /usr/DassaultSystemes/DSLicenseServer
mkdir -p -m 755 /usr/DassaultSystemes/DSLicenseServer
Directory /usr/DassaultSystemes/DSLicenseServer was successfully created

20 DS License Server 3DEXPERIENCE R2016x Installation and Configuration Guide

 Installing the DS License Server

Installation directory: /usr/DassaultSystemes/DSLicenseServer

TarCmd: tar -xf /tmp/DSLS/AIX64/DSLS.tar

Untar DSLS.tar was successful
Server initialization:
/usr/DassaultSystemes/DSLicenseServer/aix_a64/code/bin/DSLicSrv -initServer
-adminPort 4084
2015/07/25 16:13:13:044 I INITSERVER Initializing license server on /var
args [-adminPort, 4084]
2015/07/25 16:13:13:044 I REPOSITORY LicenseDB.dat written to disk
2015/07/25 16:13:13:044 I REPOSITORY LicenseRT.dat written to disk
2015/07/25 16:13:13:044 I INITSERVER Server version 6.418.0 built on
Jun 30, 2015 1:04:39 PM
2015/07/25 16:13:13:044 I INITSERVER ComputerId HRE-425A10DEF1780905
Server was successfully initialized

Server start:

Server was successfully started

Sending nohup output to nohup.out.

Admin Console start:
/usr/DassaultSystemes/DSLicenseServer/aix_a64/code/bin/DSLicSrv -adminUI
The License Administration Tool dialog box is displayed. The License Administration Tool has the same
graphic user interface and works the same way as on Windows.

Note: If you intend to install the DS License Server on a UNIX machine which does not use a display,
to avoid automatically displaying the License Administration Tool, perform the installation by running
the following command:
startInstLicServ -noUI
To access administration functions, launch the License Administration Tool in command line mode
as follows:
/usr/DassaultSystemes/DSLicenseServer/OS/code/bin/DSLicSrv -admin

You must configure the firewall on the machine hosting the license server to enable license clients to access
the license server, using the port numbers specified in Port Management.
When installing the DS License Server on SuSE, some messages related to insserv may be displayed.
They can be safely ignored.

Upgrading Your License Servers in a Failover Cluster

This section explains one possible method for upgrading your license servers in a failover cluster.

1. From a License Administration Tool tool on a fourth machine outside the cluster (to find out how to install
just the License Administration Tool without the license server, see Installing Only the License Administration
Tool on Windows) :
a. Connect to the three failover members, and check that the failover cluster is green.
b. Stop one of the failover members using the Servers - Stop command.
c. Check that the failover cluster status goes from green to yellow (meaning the cluster is still running).
2. On the failover member that you stopped:

DS License Server 3DEXPERIENCE R2016x Installation and Configuration Guide 21

Installing the DS License Server

• On Windows:
- Check that there is no local License Administration Tool running.
- Uninstall the DS License Server.
- Install the new DS License Server version.

• On UNIX:
- Check that there are no DSLicSrv processes running on the member using the command:
ps -ef | grep DSLicSrv
.
- Delete the installation directory as follows:
rm -rf /usr/DassaultSystemes/DSLicenseServer
- Install the new DS License Server version as follows: startInstLicServ -noUI

3. Return to the fourth machine:

a. Reconnect to the upgraded failover member, and check that the member is running a different license
server version from the two other members.
b. Stop the server on the second member. The failover cluster status is now red.
4. On the second member, repeat the same steps performed on the first member.
5. Return to the fourth machine:
a. Reconnect to the second upgraded failover member, then check the license server version and that the
failover cluster status is now yellow.
b. Stop the server on the third member.
6. On the third member, repeat the same steps performed on the other two members.
7. Return to the fourth machine:
a. Reconnect to the third upgraded failover member.
b. Check the license server version and that the failover cluster status is now green.

Uninstalling the DS License Server

This section explains how to uninstall the DS License Server on both Windows and UNIX.

Uninstall on Windows
Uninstalling relies on Windows-compliant tools enabling anyone familiar with Windows procedures and concepts
to uninstall the software without assistance.
Before you begin: Before uninstalling a DS License Server version on Windows OS, be sure to close:
• all browser applications, such as Internet Explorer or Firefox
• all DS License Administration Tools.

1. Log on as an administrator.
You must belong to the Administrators group, or have the privileges assigned to the Administrators group.
Otherwise, you will not be able to uninstall the software.

2. On the Windows desktop, select the Start > Control Panel, then double-click the Programs and Features
control.

22 DS License Server 3DEXPERIENCE R2016x Installation and Configuration Guide

 Installing the DS License Server

A dialog box is displayed containing the list of programs and features installed on your computer.

3. Double-click the item DS License Server from the list.

The list looks something like this (depending on the software installed on your computer):

4. When prompted to confirm, click the Yes button each time to confirm.

The program removes:

• the installation folder
• the Windows service named DS License Server
• all entries in the Start > All Programs menu
• all registry entries.
Note that the following are NOT removed:
• license keys
• settings
• logs.

Uninstall on UNIX
This section explains how to uninstall the DS License Server on UNIX.

1. Log on as root.
2. Stop the license server by running the following command:
/usr/DassaultSystemes/DSLicenseServer/OS/code/bin/DSLicSrv -stopServer
or by using the Servers - Stop command provided by a local or remote License Administration Tool.
If you are using a local administration tool, exit this tool.
3. Delete the installation directory as follows:
rm -rf /usr/DassaultSystemes/DSLicenseServer

4. If you did not use the -x option with the ./startInstLicServ command when you installed the license
server, delete the remaining system files created at this moment by running the following commands, depending
on the UNIX platform:

DS License Server 3DEXPERIENCE R2016x Installation and Configuration Guide 23

Installing the DS License Server

On AIX:
rmitab DSLicSrv
On Linux:
/usr/lib/lsb/remove_initd /etc/init.d/dsls
rm /etc/init.d/dsls
rm /etc/sysconfig/dsls

24 DS License Server 3DEXPERIENCE R2016x Installation and Configuration Guide

 Configuring the DS License Server and Clients

Configuring the DS License Server and

Clients
This section explains how to configure the DS License Server and clients.

Starting the License Administration Tool

This section explains how to launch the tool if it is not running, and obtain the computer id required for ordering
licenses.

1. Select Start - All Programs - DS License Server - License Server

Administration.
On UNIX, start the License Administration Tool by running the following command, for example on AIX:
/usr/DassaultSystemes/DSLicenseServer/aix_a64/code/bin/DSLicSrv -adminUI
The License Administration Tool is displayed.
The tool has a menu bar and several tabs. The View menu contains a list of tabs with check marks. Click the
check marks to hide or display tabs as required.
Optionally, you may wish to select another display scheme by selecting the View > Look and Feel command.
2. Connect to the license server, then locate the Computer id column in the dialog box.
The computer id will be required when you order your licenses.

Note: An alternative method of obtaining the computer id is to go to the following installation directory:
C:\Program Files\Dassault Systemes\DS License Server\win_b64\code\bin
and run the following command:
DSLicTarget -t

The DSLicTarget tool is also available in the appropriate operating system folders on your media.
On Windows and Linux, the computer ID is based on the network card. Link aggregation (implemented in
various ways and with wording such as teaming/bridging/bonding/trunking/bundling) of network cards is
not supported.
A possible workaround is to add another network card which does not need to be connected to the network,
but needs to be powered on.
Multiple network cards
On Windows and Linux, if your machine hosts several network cards and the computerID managed by the
license server is not from the network card you wish, you can change it. Be aware that, if license keys are
already enrolled in the license server, they will become invalid. So you will need license keys generated for
the desired computerID.
When installing the first time, the license server retrieves the computerID and stores it in its database. If the
computerID is changed later by using the DSLicTarget -s command, the license server will not take it
into account.

DS License Server 3DEXPERIENCE R2016x Installation and Configuration Guide 25

Configuring the DS License Server and Clients

In order to reset the computerID in the license server database, you can follow these steps:
1. Run the command DSLicTarget -l to list the IDs available on the machine.
2. Run the command DSLicTarget -s (in an elevated command prompt) to set the desired ID in the
Windows registry or Linux file.
3. Uninstall the license server.
4. Remove the License Administration Tool settings file:
C:\Users\userid\AppData\Roaming\DassaultSystemes\LicenseAdminUI (Windows)
$HOME/LicenseAdminUI (UNIX)
5. Reinstall the license server and check the Install Server from scratch check button to force the license
server to read the ID value stored in the registry or Linux file, instead of the value in the license server
database.

Configuring and Activating a Standalone License Server

This section explains how to configure and activate your license server in standalone mode.
The installation created a license server on your machine. But you must first configure and activate the license
server before a client process can be served.
You must choose to configure the server:
• as a standalone server
• or in failover mode as a member of a cluster.
These choices are mutually exclusive. Once you have configured the server in either standalone or failover mode,
you cannot modify your configuration. In particular, license keys are different.

1. Select Start - All Programs - DS License Server - License Server

Administration to launch the License Administration Tool if it is not already launched:

2. Connect the License Administration Tool to the server.

26 DS License Server 3DEXPERIENCE R2016x Installation and Configuration Guide

 Configuring the DS License Server and Clients

You must connect to the server to be able to use it. If you point to the icon in the status column, next to
the computer name, a message like this will be displayed:
server xxx not connected
To connect to the server:
• Select the Servers - Connect command and select the server name from the list.
• Or, point to the icon, right click and select the Connect command.

• Or , you can also click the icon to connect all defined servers at the same time (only one in the current
scenario).
Note that you can connect the tool to several license servers simultaneously. To disconnect from one license

server, select the Disconnect command. To disconnect all license servers, click the icon.

If you did not enroll a license during the installation, the icon appears over the computer icon like this
:

If you did not enroll a license during the installation, pointing to the icon displays the following message:
licensing port not configured; check server properties
The columns available in the Server Definitions tab are:

Status Status of the license server.

Computer Name Name of the machine hosting the license server.
Computer ID Computer id of the machine hosting the license server.
Version Software version number.
Build Date Software version build date.
Operating System Operating system on which the license server is running.

DS License Server 3DEXPERIENCE R2016x Installation and Configuration Guide 27

Configuring the DS License Server and Clients

Comment
Contains an optional comment enabling you, for example, to distinguish one
license server from another when several server definitions are displayed in the
list.
To edit a comment, point to a line containing a server definition line, under the
Comment column, and double-click: an editable field with a cursor is displayed.
Enter the text, then click ENTER to validate.
The comment field supports NLS characters, including DBCS. A comment can
be added and modified even if the connection to the license server is not established
or is established in restricted mode. Editing comments does not modify the license
server itself, but only the license administration tool user settings.

When several lines are present in the Server Definitions tab, you can select multiple lines (using Shift or
Control keys and left-clicking) to connect several servers at the same time, for example.
When you select then copy (using Ctrl-C) one or more lines, the fields copied can be pasted together in
any other text processing program (for example, Excel). You can also simply drag lines from the License
Administration Tool and drop them into another program, without the need to copy then paste.
You can also sort the lines in ascending or descending order, by clicking on the appropriate column title.

Note: Both techniques work also in any tab containing table-formatted data, such as the License
Administration tab, License Usage tab, Detailed License Usage dialog box, and License Recycling
tab.

When the Server Definitions tab contains several lines, by default, the lines are displayed in the order
according to the time at which the lines were added. The first line contains the first license server added. You
can change this default order by dragging and dropping a line:
• click anywhere on the line you want to move to select it
• click the line again, and hold then move the line to the appropriate location
• release to drop the line at its new location: the next time you start the License Administration Tool, the
line will be displayed by default at its new location.

Note: You can only move one line at a time.

When you add a new server in the Server Definitions tab, by selecting the Servers > New... command
or right-clicking in the tab and selecting the Add new server command, it is added to the server list bar
and automatically pre-selected. This bar is displayed at the top of the following tabs: License Administration,
License Usage, License Recycling, Statistics and Geolocation.
3. Configure the license server.
• Select the Servers - Properties command and select the server name from the list.
• Or, point to the icon, right-click and select the Display properties command.
• Or, double-click the line containing the computer name.
The Server Configuration dialog box appears:

28 DS License Server 3DEXPERIENCE R2016x Installation and Configuration Guide

 Configuring the DS License Server and Clients

You do not have to set any other options for the moment, but for information purposes here is a list of the
information and options in the dialog box:
Name: Name of the machine hosting the license server.
Computer id: Computer id of the machine hosting the license server.
Software Internal software version number.
version:
Build date: Internal software version build date.
Administration Listening port for the License Administration Tool.
port:

DS License Server 3DEXPERIENCE R2016x Installation and Configuration Guide 29

Configuring the DS License Server and Clients

Licensing For the Licensing port, you can either accept the default port number (4085) or set another
port: port number.
Set Clicking this button opens the Administrative Credentials dialog box which lets you set
password... passwords required to administer your server using the License Administration Tool.
When the passwords are already present, the button name is Change passwords....
If needed, you must set the password by clicking the Set password... button and typing
the new password for full access mode:

Warning: if the password has been lost, the only possibility to recover administrator access
is to re-install the license server from scratch.
Once you have set the password, an additional field appears in the upper area allowing you
to enter the current password for full access mode before modifying it. The field for entering
the password for restricted access mode is also activated, allowing you to set or modify
the password for restricted access mode, as illustrated:

30 DS License Server 3DEXPERIENCE R2016x Installation and Configuration Guide

 Configuring the DS License Server and Clients

Remote Allows you to deny access, or grant restricted or full access to a license server from a
administration remote License Administration Tool installed on a remote computer.
authorization
Several License Administration Tool instances can be connected simultaneously to the
same license server. Only one License Administration Tool instance can have full
administration access to the license server: either the local License Administration Tool
or the first one that connects to the license server remotely.
Furthermore, a local License Administration Tool takes priority over one started on a
remote computer. When a local License Administration Tool connects to a local license
server, if another administration tool is already connected in full mode, it is disconnected.
This happens even if the License Administration Tool already connected is also a local
one, irrespective of whether the tool is running in GUI or CLI mode.
• full: a remote License Administration Tool can connect to the license server and act
with the same privileges as if it was running locally. This mode allows you complete
control of the license server. Even if you have the right to fully administrate the license
server, you may decide to connect to the server in restricted mode if you do not intend
to make any modifications to the server. You connect to the server in this way using
the Servers - Connect restricted command.
• restricted:
This mode enables a remote License Administration Tool to connect to the license
server but only in restricted mode, even if no other administration tool is connected to
this license server.
You can only set the password for restricted access mode if the password for full access
mode has already been set.
Restricted mode features the following limitations:
- no modifications are allowed in the Server Configuration dialog box
- no licenses can be deleted using the License Administration tab
- no licenses can be recycled using the License Recycling tab

DS License Server 3DEXPERIENCE R2016x Installation and Configuration Guide 31

Configuring the DS License Server and Clients

- creation and/or modification operations in the Authorizations tab are not allowed
- the dump buttons in the Monitoring tab are disabled.

• none: remote administration is denied.

The following table summarizes which passwords are requested at connection time when
administering a local server or a remote server, and remote administration is fully authorized:

Connect Command Connect restricted

Command

No password set No password requested No password requested

Only password for Full mode set Password for Full mode must be No password requested
entered

Both Full and Restricted mode Password for Full mode must be Password for Full or Restricted
passwords set entered mode must be entered
If password for Restricted mode is
entered, connection is forced in
Restricted mode

The following table summarizes which passwords are requested at connection time when
administering a remote server, and remote administration is restricted:
Connection from remote tool Connection from remote tool
using Connect Command using Connect
restricted Command
No password set No password requested No password requested
Connection is forced in Restricted
mode

Only password for Full mode set No password requested No password requested
Connection is forced in Restricted
mode

Both Full and Restricted mode Password for Full or Restricted Password for Full or Restricted
passwords set mode must be entered mode must be entered
Connection is forced in Restricted
mode

The following table summarizes which passwords are requested at connection time when
administering a remote server, and remote administration is denied:
Connection from remote tool Connection from remote tool
using Connect Command using Connect
restricted Command
No password set Connection denied Connection denied

Only password for Full mode set Connection denied Connection denied

Both Full and Restricted mode Connection denied Connection denied

passwords set

Mode is only taken into account at connection time. For example, if the mode is changed
from restricted to none, the remote tools already connected in restricted mode will stay
connected.

32 DS License Server 3DEXPERIENCE R2016x Installation and Configuration Guide

 Configuring the DS License Server and Clients

Checkbox status is only taken into account once the license server has been activated.
Before activation, remote administration is allowed.
The License Administration Tool level must be higher than or equal to the license server
level.

Note: There's no connection timeout between a License Administration Tool

remotely connected to a license server and this license server. However, if a network
problem occurs or if the License Administration Tool runs from a laptop which
disconnects, the connection between both processes is broken and the status in the
Server Definitions tab returns to . Once disconnected, the License Administration
Tool doesn't automatically reconnect to the license server(s).

Enable offline Check this box to enable offline license extraction when configuring the license server.
license This box is checked by default. Uncheck it to forbid offline license extraction.
extraction
Enable license Enables license usage statistics using the Statistics tab.
usage
If you check this checkbox, the license server collects statistical data. If you uncheck it,
statistics
the license server will NOT collect statistical data, and data already collected will not be
deleted.

Enable Enables automatic recycling of all named user licenses which have not been used for at
Automatic least 30 days.
Recycling
Using the License Recycling tab, you can manually recycle a named user license tied to
a named user if this license has been used by this user for more than 30 days, and if the
terms of the license contract (user retirement, etc.) allow you to do so. Enabling automatic
recycling avoids manual license recycling.
Irrespective of whether this option is activated, the license server stores and displays the
last usage date of a given named user license in the Last used at field when detailed
license usage information is requested:

As soon as it is granted to a named user, the last usage value is set. The value is updated
every time the named user logs in or logs out (and also when internal heartbeats occur).
If you manually recycle a license, the last usage value is emptied.
The license server initiates automatic recycling every day at 00h00 UTC.
A license cannot be recycled if a given process is still using the license.
Casual usage named user licenses are not managed by this process: casual licenses are
already automatically recycled at the beginning of every month.

DS License Server 3DEXPERIENCE R2016x Installation and Configuration Guide 33

Configuring the DS License Server and Clients

The last usage value of offline named user licenses is initially set to the date of the extraction.
The date is updated:
• at the exact time when the end of offline duration occurs
• at the exact time the user extends the offline license
• at the exact time the user manually returns the offline license.
If you install on top of a V6R2013x version or lower, the last usage value of all tied named
user licenses is initialized with the new installation date, and the last usage value of all
non-tied named user licenses is initialized to an empty value.
When a License Administration Tool manages a V6R2013x or lower license server, the
Last used at field normally displayed when detailed license usage information is
requested will not be displayed.

Note: Note the following limitation: if the license server is not running at 00h00
UTC, automatic recycling of named user licenses is not postponed until the license
server restart, but to the next 00h00 UTC.

License usage Displays the License Usage Tracing dialog box allowing you to select the licenses for
tracing... usage tracing:

This dialog box is only useful after importing licenses.

You have to select at least one license to activate usage tracing. You can select individual
licenses by checking the box next to the license(s), or select and unselect all the licenses
using the Select all licenses and Un-select all licenses buttons respectively.
If activated, license usage tracing events are logged and can be viewed using the Server
Logs tab.
If the Select all licenses button is checked, then you enroll licenses for new features, the
new features and checkboxes will be added automatically, and the boxes will be checked,

34 DS License Server 3DEXPERIENCE R2016x Installation and Configuration Guide

 Configuring the DS License Server and Clients

which avoids having to access this dialog box again and click the Select all licenses button
again.
If another License Administration Tool is already connected, the dialog box is in read-only
mode and the contents are grayed out.

Mail Displays the Mail Configuration dialog box allowing you to send license server event
configuration... notifications to specified mail addresses:

The fields are as follows:

• SMTP server name: specify the name of the mail server to which the license server
will send notifications. By default, the SMTP port number is 25. But the port number
can be set to a different value, separated from the name by a colon (:). For example:
MySMTPserver:26. Note that SMTP servers requiring authentication and/or SSL
are not supported.
• Recipients: specify the e-mail addresses to which to the notifications will be sent. You
can specify several e-mail addresses, each separated by commas (,).
• Events: Mail notifications are available for the following types of events:
- when server starts: a notification is sent when the license server starts
- when server stops: a notification is sent when the license server stops
- when partition usage exceeds: the license server needs to regularly
write data in its data folder (C:\ProgramData\DassaultSystemes on
Windows, or /var/DassaultSystemes on UNIX). When there is no more
space in the data folder, the license server stops. Even if disk space may typically
already be monitored by other tools, you can configure your e-mail server to send
an e-mail to the license server administrator when the disk space is below a given
percentage. By default, this event is not triggered. The administrator has to activate
it, with an appropriate percentage value. The default is 80%. An event is sent once
this percentage has been reached, and every time an incremented or decremented
percentage exceeding the limit has been reached (for example, at 81%, 82% etc...).
- when licenses will expire: a notification is sent when a license is about
to expire. When several licenses are about to expire, only one notification is sent.
Notifications are sent at 1:00H AM server local time, each day the condition is still
valid. You can set the number of days prior to license expiration by adjusting the
slider to set a value between one and thirty days.

DS License Server 3DEXPERIENCE R2016x Installation and Configuration Guide 35

Configuring the DS License Server and Clients

Every time a notification is sent, the information is also added to the server log.
The subject, content and footer in the notification of each event type can be customized by
clicking the ... button which displays the Mail Template dialog box, for example:

Click the Test button to send a mail notification to validate the SMTP server name and
e-mail addresses.

Server log Point to this option to display the path of the directory containing license server logs. The
directory full pathname is displayed in a tooltip, and can also be selected when clicking on it (or
double-clicking or triple-clicking). The path may be located either on the local machine or
on a remote machine. The server log directory path can only be set in command line mode
(using the -logDir option of the DSLicSrv batch command).
Standalone This option is checked by default and signifies that you are configuring a standalone server,
server not a server belonging to a failover cluster.
Failover
Refer to Configuring and Activating a Cluster in Failover Mode.
cluster

4. Set the licensing port number, then click the Apply button, then click OK.

Pointing to the icon now displays the following message:

no license enrolled
For the moment, the license server is configured but not activated. You cannot use the license server until it
has been activated. To activate the license server, you must enroll a special license: the Activation license.
However, this license is typically embedded in the .LICZ file containing the product licenses, so you don't
have to manage it in a special way. If you have licenses for several editors, you will need several activation
licenses.

5. Enroll the license as follows:

a. Select the License - Enroll command or click the icon.

36 DS License Server 3DEXPERIENCE R2016x Installation and Configuration Guide

 Configuring the DS License Server and Clients

The Open dialog box is displayed.

b. Select the appropriate .LICZ file containing your licenses, then click the Open button.
License keys and their activation key are provided in the form of archive files named something like this
(with the .LICZ suffix):
DLD-430814856494DBA7_7KLXM-UVSBG-8VFDL-GPMGS-V1ED3_0001_1
The License Enrollment dialog box opens, containing messages confirming that the licenses have been
enrolled on your server:
License enroll starting
lw5ses1dsy : License enroll starting
Sending files to server lw5ses1dsy

E:\Licenses418\DLD-430814856494DBA7_7KLXM-UVSBG-8VFDL-GPMGS-V1ED3_0001_1.LICZ/FEAT-1-of-8.LIC

E:\Licenses418\DLD-430814856494DBA7_7KLXM-UVSBG-8VFDL-GPMGS-V1ED3_0001_1.LICZ/FEAT-2-of-8.LIC

E:\Licenses418\DLD-430814856494DBA7_7KLXM-UVSBG-8VFDL-GPMGS-V1ED3_0001_1.LICZ/FEAT-3-of-8.LIC

E:\Licenses418\DLD-430814856494DBA7_7KLXM-UVSBG-8VFDL-GPMGS-V1ED3_0001_1.LICZ/FEAT-4-of-8.LIC

E:\Licenses418\DLD-430814856494DBA7_7KLXM-UVSBG-8VFDL-GPMGS-V1ED3_0001_1.LICZ/FEAT-5-of-8.LIC

E:\Licenses418\DLD-430814856494DBA7_7KLXM-UVSBG-8VFDL-GPMGS-V1ED3_0001_1.LICZ/FEAT-6-of-8.LIC

E:\Licenses418\DLD-430814856494DBA7_7KLXM-UVSBG-8VFDL-GPMGS-V1ED3_0001_1.LICZ/FEAT-7-of-8.LIC

E:\Licenses418\DLD-430814856494DBA7_7KLXM-UVSBG-8VFDL-GPMGS-V1ED3_0001_1.LICZ/FEAT-8-of-8.LIC

lw5ses1dsy : 8 licenses received

c. Click OK.

The icon confirms that your server has been activated:

DS License Server 3DEXPERIENCE R2016x Installation and Configuration Guide 37

Configuring the DS License Server and Clients

If you point to the icon, a tooltip like this will be displayed:

server lw5ses1dsy (10.232.49.82) connected
confirming that your license server is up and running.

Note: Once you have configured and activated your server as a standalone server, you can no
longer change your mind and configure it as part of a failover cluster. That is why the corresponding
options are grayed out.

Warning: the Activation license included in .LICZ files with the product licenses is valid for only 30 days.
You must activate the license server within 30 days after having received the license file. If you need to
activate the server a second time, after the first 30 days, the original activation license included in the original
.LICZ file will no longer be valid, in which case another activation license included in another .LICZ file
is required. You only have to activate the license server once. The 30 days apply to the life of the activation
license, not to how long the license server remains active.

Configuring and Activating a Cluster in Failover Mode

This section explains how to configure and activate your license servers in failover mode.
When configuring the license server, you can configure the server:
• as a standalone server
• or in failover mode as a member of a cluster.
In the preceding section of this guide, you learned how to configure a license server in standalone mode.
These choices are mutually exclusive. Once you have configured the server in either standalone or failover mode,
you cannot modify your configuration. In particular, license keys are different.
Before you begin:
Before commencing this task, keep the following points in mind:
• The objective of a failover configuration is to increase reliability, not capacity.

38 DS License Server 3DEXPERIENCE R2016x Installation and Configuration Guide

 Configuring the DS License Server and Clients

• You must install and start a license server on three different machines. A failover cluster of license servers is
composed of exactly 3 computers. The three machines can be any supported Windows or UNIX machines: they
do not have to be all Windows or all UNIX machines.
• In order to maximize quality of service, we recommend that the three machines be on the same subnetwork.
• At least two machines must be up and running and connected to each other in order to have a working failover
cluster.
• The three machines have the same role: there is no master/slave concept.
• The three machines exchange messages every time license data is modified (for example, in case of new license
enrolled or license granted to a client). Only the modifications are transmitted and not all license data.
• Each machine has its own log file management: the logs are not synchronized between failover members.
In our scenario, you will start the License Administration Tool on a license server on Windows, then build the cluster
using three existing UNIX machines.

1. On any machine on which a license server has been installed, launch the License Administration Tool if it
is not already launched.
In our scenario, this tool is launched from a computer which will not be part of the cluster, but it can also be
run from a future member of the cluster.

2. Create a connection to one of the license servers to be part of the cluster using the Servers > New... command.
3. Connect the License Administration Tool to the server.
You must connect to the server to be able to use it. If you point to the icon in the status column, next to
the computer name, a message like this will be displayed:
server xxx not connected
To connect to the server:
• Select the Servers - Connect command and select the server name from the list.
• Or, point to the icon, right click and select the Connect command.

• Or, you can also click the icon to connect all servers at the same time.
The status now looks like this:

Pointing to the icon displays the following message:

licensing port not configured; check server properties
The columns available in the Server Definitions tab are:
Status Status of the license server.
Computer Name Name of the machine hosting the license server.
Computer ID Computer id of the machine hosting the license server.
Version Software version number.
Build Date Software version build date.
Operating System Operating system on which the license server is running.

DS License Server 3DEXPERIENCE R2016x Installation and Configuration Guide 39

Configuring the DS License Server and Clients

Comment
Contains an optional comment enabling you, for example, to distinguish one license
server from another when several server definitions are displayed in the list.
To edit a comment, point to a line containing a server definition line, under the
Comment column, and double-click: an editable field with a cursor is displayed.
Enter the text, then click ENTER to validate.
The comment field supports NLS characters, including DBCS. A comment can
be added and modified even if the connection to the license server is not established
or is established in restricted mode. Editing comments does not modify the license
server itself, but only the license administration tool user settings.
In the case of a failover cluster, each member has its own comment field.

When several lines are present in the Server Definitions tab, you can select multiple lines (using Shift or
Control keys and left-clicking) to connect several servers at the same time, for example.
When selecting a failover, then connecting, the connection is made to the three members at once. If a password
has been set, it has to be entered only once. To connect to only one member, do not select (left-click) but just
display the contextual menu (right-click) then connect.
When you select then copy (using Ctrl-C) one or more lines, the fields copied can be pasted together in
any other text processing program (for example, Excel). You can also simply drag lines from the License
Administration Tool and drop them into another program, without the need to copy then paste.
You can also sort the lines in ascending or descending order, by clicking on the appropriate column title.

Note: Both techniques work also in any tab containing table-formatted data, such as the License
Administration tab, License Usage tab, Detailed License Usage dialog box, and License Recycling
tab.

When the Server Definitions tab contains several lines, by default, the lines are displayed in the order
according to the time at which the lines were added. The first line contains the first license server added. You
can change this default order by dragging and dropping a line:
• click anywhere on the line you want to move to select it
• click the line again, and hold then move the line to the appropriate location
• release to drop the line at its new location: the next time you start the License Administration Tool, the
line will be displayed by default at its new location.

Note: You can only move one line at a time.

When you add a new server in the Server Definitions tab, by selecting the Servers > New... command
or right-clicking in the tab and selecting the Add new server command, it is added to the server list bar
and automatically pre-selected. This bar is displayed at the top of the following tabs: License Administration,
License Usage, License Recycling, Statistics and Geolocation.

4. Configure the license server.

• Select the Servers - Property command and select the server name from the list.
• Or, point to the icon, right click and select the Property command.
• Or, double-click the line containing the computer name.
The Server Configuration dialog box appears:

40 DS License Server 3DEXPERIENCE R2016x Installation and Configuration Guide

 Configuring the DS License Server and Clients

You do not have to set any other options for the moment, but for information purposes here is a list of the
information and options in the dialog box:
Server name: Name of the machine hosting the license server.
Server id: Computer id of the machine hosting the license server.
Software Internal DS License Server software version number.
version:
Build date Internal software version build date.
Administration Listening port for the License Administration Tool.
port:

DS License Server 3DEXPERIENCE R2016x Installation and Configuration Guide 41

Configuring the DS License Server and Clients

Licensing The Licensing port: field is displayed in yellow, informing you that you can either accept
port: the default port number (4085) or set another port number.
Set Clicking this button opens the Administrative Credentials dialog box which lets you set
password... passwords required to administer your server using the License Administration Tool.
When the passwords are already present, the button name is Change passwords....
If needed, you must set the password by clicking the Set password... button and typing
the new password for full access mode:

Warning: if the password has been lost, the only possibility to recover administrator access
is to re-install the license server from scratch.
Once you have set the password, an additional field appears in the upper area allowing you
to enter the current password for full access mode before modifying it. The field for entering
the password for restricted access mode is also activated, allowing you to set or modify
the password for restricted access mode, as illustrated:

42 DS License Server 3DEXPERIENCE R2016x Installation and Configuration Guide

 Configuring the DS License Server and Clients

Remote Allows you to deny access, or grant restricted or full access to a cluster in failover mode
administration from a remote License Administration Tool installed on a remote computer.
authorization
Furthermore, a local License Administration Tool takes priority over one started on a
remote computer. When a local License Administration Tool connects to a local cluster,
if another administration tool is already connected in full mode, it is disconnected. This
happens even if the License Administration Tool already connected is also a local one,
irrespective of whether the tool is running in GUI or CLI mode.
The three modes are:
• full: a remote License Administration Tool can connect to the cluster and act with
the same privileges as if it was running locally. This mode allows you complete control
of the cluster.
A failover cluster is considered as a single logical server. Consequently, only one
License Administration Tool can be connected in full mode to the failover. In other
words, only one License Administration Tool gets full access to the three failover
members at a given time.
When a remote License Administration Tool is connected in full mode to one of
failover members:
- no other tool can connect to this member
- no other tool can connect to both other members
- only the remote tool connected in full mode to one member (or a local tool) can
connect to both other members.
When a local License Administration Tool connects to one failover member, it
disconnects:
- the remote tool connected in full mode to this member (if any)
- the other local tool connected to this member (if any)
- the remote tools connected in full mode to both other members (if any)
- the local tools connected to both other members (if any).

DS License Server 3DEXPERIENCE R2016x Installation and Configuration Guide 43

Configuring the DS License Server and Clients

Even if you have the right to fully administrate the cluster, you may decide to connect
to the cluster in restricted mode if you do not intend to make any modifications to the
cluster. You connect to the cluster in this way using the Servers - Connect
restricted command.
The Servers - Connect all command connects to all the members of a cluster
and only prompts you once to enter the cluster password.
• restricted:
This mode enables a remote License Administration Tool to connect to the cluster
but only in restricted mode, even if no other administration tool is connected to this
cluster.
You can only set the password for restricted access mode if the password for full access
mode has already been set.
Restricted mode features the following limitations:
- no modifications are allowed in the Server Configuration dialog box
- no licenses can be deleted using the License Administration tab
- no licenses can be recycled using the License Recycling tab
- creation and/or modification operations in the Authorizations tab are not allowed
- the dump buttons in the Monitoring tab are disabled.

• none: remote administration is denied, except from both other members, for which full
access is always granted.
The following table summarizes which passwords are requested at connection time when
administering a local cluster or a remote cluster, and remote administration is fully
authorized:

Connect Command Connect restricted

Command

No password set No password requested No password requested

Only password for Full mode set Password for Full mode must be No password requested
entered

Both Full and Restricted mode Password for Full mode must be Password for Full or Restricted
passwords set entered mode must be entered
If password for Restricted mode is
entered, connection is forced in
Restricted mode

The following table summarizes which passwords are requested at connection time when
administering a remote cluster, and remote administration is restricted:
Connection from remote tool Connection from remote tool
using Connect Command using Connect
restricted Command
No password set No password requested No password requested
Connection is forced in Restricted
mode

Only password for Full mode set No password requested No password requested
Connection is forced in Restricted
mode

44 DS License Server 3DEXPERIENCE R2016x Installation and Configuration Guide

 Configuring the DS License Server and Clients

Connection from remote tool Connection from remote tool

using Connect Command using Connect
restricted Command
Both Full and Restricted mode Password for Full or Restricted Password for Full or Restricted
passwords set mode must be entered mode must be entered
Connection is forced in Restricted
mode

The following table summarizes which passwords are requested at connection time when
administering a remote cluster, and remote administration is denied:
Connection from remote tool Connection from remote tool
using Connect Command using Connect
restricted Command
No password set Connection denied Connection denied

Only password for Full mode set Connection denied Connection denied

Both Full and Restricted mode Connection denied Connection denied

passwords set

Mode is only taken into account at connection time. For example, if the mode is changed
from restricted to none, the remote tools already connected in restricted mode will stay
connected.
Checkbox status is only taken into account once the license server has been activated.
Before activation, remote administration is allowed.
The License Administration Tool level must be higher than or equal to the license server
level.

Note: There's no connection timeout between a License Administration Tool

remotely connected to a license server and this license server. However, if a network
problem occurs or if the License Administration Tool runs from a laptop which
disconnects, the connection between both processes is broken and the status in the
Server Definitions tab returns to . Once disconnected, the License Administration
Tool doesn't automatically reconnect to the license server(s).

Enable license Enables license usage statistics using the Statistics tab.
usage
If you check this checkbox, the license server collects statistical data. If you uncheck it,
statistics
the license server will NOT collect statistical data, and data already collected will not be
deleted.

Enable Enables automatic recycling of all named user licenses which have not been used for at
Automatic least 30 days.
Recycling
Using License Recycling tab, you can manually recycle a named user license tied to a
named user if this license has been used by this user for more than 30 days, and if the terms
of the license contract (user retirement, etc.) allow you to do so. Enabling automatic
recycling avoids manual license recycling.
Irrespective of whether this option is activated, the license server stores and displays the
last usage date of a given named user license in the Last used at field when detailed
license usage information is requested:

DS License Server 3DEXPERIENCE R2016x Installation and Configuration Guide 45

Configuring the DS License Server and Clients

As soon as it is granted to a named user, the last usage value is set. The value is updated
every time the named user logs in or logs out (and also when internal heartbeats occur).
If you manually recycle a license, the last usage value is emptied.
The license server initiates automatic recycling every day at 00h00 UTC. In the context of
a failover cluster, the action is triggered on each member, and is not propagated to the
others. If a member is down at 00h00 UTC, the action cannot be triggered on this member.
But when this member restarts, it will get appropriate data from the other members during
startup synchronization in the usual way.
A license cannot be recycled if a given process is still using the license.
Casual usage named user licenses are not managed by this process: casual licenses are
already automatically recycled at the beginning of every month.
The last usage value of offline named user licenses is initially set to the date of the extraction.
The date is updated:
• at the exact time when the end of offline duration occurs
• at the exact time the user extends the offline license
• at the exact time the user manually restitutes the offline license.
If you install on top of V6R2013x or a lower version, the last usage value of all tied named
user licenses is initialized with the new installation date, and the last usage value of all
non-tied named user licenses is initialized to an empty value.
When a License Administration Tool manages a V6R2013 or lower license server, the
Last used at field normally displayed when detailed license usage information is
requested will not be displayed.

Note: Note the following limitation: if the license server is not running at 00h00
UTC, automatic recycling of named user licenses is not postponed until the license
server restart, but to the next 00h00 UTC.

License usage Displays the License Usage Tracing dialog box allowing you to select the licenses for
tracing... usage tracing:

46 DS License Server 3DEXPERIENCE R2016x Installation and Configuration Guide

 Configuring the DS License Server and Clients

This dialog box is only useful after importing licenses.

You have to select at least one license to activate usage tracing. You can select individual
licenses by checking the box next to the license(s), or select and unselect all the licenses
using the Select all licenses and Un-select all licenses buttons respectively.
If activated, license usage tracing events are logged and can be viewed using the Server
Logs tab.
If the Select all licenses button is checked, then you enroll licenses for new features, the
new features and checkboxes will be added automatically, and the boxes will be checked,
which avoids having to access this dialog box again and click the Select all licenses button
again.
If another License Administration Tool is already connected, the dialog box is in read-only
mode and the contents are grayed out.

Mail Displays the Mail Configuration dialog box allowing you to send license server event
configuration... notifications to specified mail addresses:

DS License Server 3DEXPERIENCE R2016x Installation and Configuration Guide 47

Configuring the DS License Server and Clients

The fields are as follows:

• SMTP server name: specify the name of the mail server to which the license server
will send notifications. By default, the SMTP port number is 25. But the port number
can be set to a different value, separated from the name by a colon (:). For example:
MySMTPserver:26. Note that SMTP servers requiring authentication and/or SSL
are not supported.
• Recipients: specify the e-mail addresses to which to the notifications will be sent. You
can specify several e-mail addresses, each separated by commas (,).
• Events: Mail notifications are available for the following types of events:
- when server starts: a notification is sent when the license server starts
- when server stops: a notification is sent when the license server stops
- when partition usage exceeds: the license server needs to regularly
write data in its data folder (C:\ProgramData\DassaultSystemes on
Windows, or /var/DassaultSystemes on UNIX). When there's no more
space in the data folder, the license server stops. Even if disk space may typically
already be monitored by other tools, you can configure your e-mail server to send
an e-mail to the license server administrator when the disk space is below a given
percentage. By default, this event is not triggered. The administrator has to activate
it, with an appropriate percentage value. The default is 80%. An event is sent once
this percentage has been reached, and every time an incremented or decremented
percentage exceeding the limit has been reached (for example, at 81%, 82% etc...).
In the context of a failover, each member is monitored individually.
- when failover member is isolated: in a failover configuration, a
notification can optionally be sent when a member cannot connect to both other
members for a given number of minutes. The default value is 5mins. and can be set
from 1min. to 60mins, in 1min. increments. The notification is sent by the isolated
member, not by the other two members. If the issue is related to the network itself,
the notification might not be received by the SMTP server. The notification is sent
only once while the member is isolated, no matter how long the member remains
isolated.
- when licenses will expire: a notification is sent when a license is about
to expire. When several licenses are about to expire, only one notification is sent.
Notifications are sent at 1:00H AM server local time, each day the condition is still
valid. You can set the number of days prior to license expiration by adjusting the
slider to set a value between one and thirty days. In a failover configuration, one
notification is sent by each member, so three notifications will be received for the
same event.

Every time a notification is sent, the information is also added to the server log.
The subject, content and footer in the notification of each event type can be customized by
clicking the ... button which displays the Mail Template dialog box, for example:

48 DS License Server 3DEXPERIENCE R2016x Installation and Configuration Guide

 Configuring the DS License Server and Clients

Click the Test button to send a mail notification to validate the SMTP server and e-mail
addresses.

Server log Point to this option to display the path of the directory containing license server logs. The
directory path may be located either on the local machine or on a remote machine. The server log
directory path can only be set in command line mode (using the -logDir option of the
DSLicSrv batch command).
Standalone This option is checked by default and signifies that you are configuring a standalone server,
server not a server belonging to a failover cluster.
Failover Check this option to configure the server as member of a cluster in failover mode.
cluster

5. Set the Failover port: number.

The default is 4086.
6. Check the Failover cluster option.
The lower section of the Server Configuration dialog box now looks like this:

7. Specify the remaining server names.

DS License Server 3DEXPERIENCE R2016x Installation and Configuration Guide 49

Configuring the DS License Server and Clients

A failover cluster comprises three server names. Note that your server name and its server id are already
declared. As you type in the names of the other two servers, the names appear in red while the software
checks that the server machines exist. The letters are then displayed normally once the existence of the server
machine has been checked.
Once you have defined three valid members, a ... button is displayed after each server id.
8. Click the Apply button.
The Server Configuration dialog box now looks like this (note the presence of the ... button after each server
id):

Click one of the ... buttons. The Modify Cluster Member dialog box appears:

For more information about modifying your cluster, refer to Maintaining Continuous Failover Cluster
Operation.
9. Click the OK button.
The License Administration Tool now contains the following:

The cluster is represented as a single connection comprising three machines. The first machine (in bold) is
connected, the others (not in bold) are not connected.

10. Enroll the license for the cluster.

50 DS License Server 3DEXPERIENCE R2016x Installation and Configuration Guide

 Configuring the DS License Server and Clients

Pointing to the icon now displays the following message:

No license enrolled
For the moment, the failover cluster has been created and configured but not activated. You cannot use the
failover cluster until it has been activated. To activate it, you must enroll your product license .LICZ file
which contains the Activation license.

Note: Note that this is a special failover cluster license. When ordering the failover cluster license,
you must provide the computer id of each of the three machines.

a. Select the License - Enroll command or click the icon.

The Open dialog box is displayed.
b. Select the appropriate .LICZ file containing your licenses, then click the Open button.
License keys and their activation key are provided in the form of archive files named something like this
(with the .LICZ suffix):
DLD-430814856494DBA7_7KLXM-UVSBG-8VFDL-GPMGS-V1ED3_0001_1.LICZ
The License Enrollment dialog box opens, confirming that the server has been activated and cluster
licenses have been enrolled on your server.
c. Click the OK button.
The green background confirms that your failover cluster has been activated and is now up and running:

If you point to the green background, a message like this will be displayed:
cluster is up
confirming that your failover cluster is up and running.

Note: Once you have configured and activated your cluster, you can no longer change your mind
and try to configure one of the three machines as a standalone server. This is why the corresponding
options are grayed out when you display the cluster properties:

Enrolling the licenses on one cluster member also enrolls them automatically on the other cluster members.
11. Consult the Status column to evaluate cluster status.
The first server name is in bold because you connected to it when building the failover cluster. The other
server names are not in bold: they are members of the cluster but you have not connected to them.

DS License Server 3DEXPERIENCE R2016x Installation and Configuration Guide 51

Configuring the DS License Server and Clients

Note that the presence of a server in a cluster does not stop you from being able to connect to it to benefit
from the other services provided by the License Administration Tool not directly involved in cluster license
management, for example logging and monitoring.
A symbol like this:

displayed in certain tabs indicates that a cluster is present. Servers to which you are connected are in bold.
Check the option button to use the relevant function with the cluster.
Furthermore, in certain tabs, the servers can be chosen from a pull-down list. The list contains servers to
which you are connected.
The meaning of colors and symbols is described in the following table:
Symbol Meaning

The cluster member is connected to the License Administration Tool.

The cluster member is connected to the License Administration Tool in read-only mode.

The cluster member is NOT connected to the License Administration Tool.

A communications link has been established between two members of the cluster.

? No information is available about the communication status between both members. Connect to at
least one of both members to determine the status of this particular link.

A green background indicates that the cluster is up and running. At least two links exist.

A yellow background indicates that the cluster is up and running, but indicate that there is a problem:
only one link exists. For example, one of the three servers may be unreachable for a variety of reasons,
but the cluster remains up and running as long as at least two servers can exchange information
between them.

Red icons indicate IN ALL CASES that the cluster is down. No links exist.

The following table illustrates some typical examples of cluster status symbols that may be displayed during
cluster operation:

52 DS License Server 3DEXPERIENCE R2016x Installation and Configuration Guide

 Configuring the DS License Server and Clients

This symbol... means that...

You have not connected to a cluster member: cluster status is undetermined.

The cluster is up and running. One of the servers is connected to the other two, but we don't know if these
two servers are inter-connected or not. Not enough information exists about the link between the
non-connected servers.

The cluster is still up and running but one of the servers is not linked to any other (maybe it was shut
down or is unreachable over the network for some reason or other). Even though two up and running
servers are enough to keep the cluster up, if another server goes down, the cluster will go down also.

The cluster is down: no links exist.

Maintaining Continuous Failover Cluster Operation

This section describes the different operations you can perform following failure of one of the members of a DS
License Server cluster, without having to stop the cluster.
In the event of a hardware failure involving a member of a DS License Server failover cluster, the cluster remains
active, and it is not necessary to stop the cluster in order to replace the failed member by a new one.
Remember that, if one of the three members of a failover cluster goes down, the failover itself remains active
and can continue to serve licensing clients without interruption. The status of the failover is yellow in the License
Administration Tool.
Even if the replacement can be planned, the fact that the failover cluster is down even only for a few minutes
can impact operations. You can perform the following actions for the failed member, to restore the failover status
to green, without stopping the failover cluster:
• replace a failover member
• change the hostname of a failover member
• replace the network card hosting the computerID of a failover member
• repair a corrupted license server database of a failover member.

Note: Once a computer has been excluded from a failover cluster, it has to be re-initialized in order to
be re-used as a standalone server or as a member of a failover (even if it is the same as before).

Replace a Failover Member

Before you begin: In the following scenario, let's assume you have a failover cluster with the following three
cluster members, M1, M2 and M3:
• M1: iclin1plp
• M2: icaix1plp
• M3: iclin3plp
Let's assume member M1 is broken and must be replaced with member M4.

1. Install a DS License Server from scratch on member M4.

DS License Server 3DEXPERIENCE R2016x Installation and Configuration Guide 53

Configuring the DS License Server and Clients

2. Do not configure M4.

3. Obtain replacement failover license keys for the computer IDs M2, M3 and M4.
4. From failover member M2, start the License Administration Tool.
5. In the Server Configuration dialog box for your cluster, click the ... button after member M1:

The Modify Cluster Member dialog box appears.

6. Check the option Replace computer with and enter the name of M4, for example nuq32plp, which will
replace computer iclin1plp, as illustrated below:

Then, click the OK button.

The following warning is displayed:
Warning: Enrolled licenses will be invalidated within 24 hours. You should be ready after this operation to
enroll a full set of licenses. Do you want to proceed?
Click the Yes button.
Your modified cluster now contains the following members:
• M4: nuq32plp
• M2: icaix1plp
• M3: iclin3plp

7. Enroll new licenses generated for the cluster nuq32plp-icaix1plp-iclin3plp.

New cluster licenses are needed because one of the three computerIDs in the failover cluster has changed.
For practical reasons, we strongly recommend that you obtain the new licenses BEFORE changing the
computerID of a cluster member.

54 DS License Server 3DEXPERIENCE R2016x Installation and Configuration Guide

 Configuring the DS License Server and Clients

Note: Keep in mind that as long as two members are active, the failover cluster remains operational.
As soon as one computerID of the failover is changed, the cluster remains up but the old licenses are
considered still valid for a maximum duration of 24 hours only. The new licenses containing the
replacement computerID must be enrolled during this 24-hour period. Obtaining the new licenses
before is critical.

After enrolling the new licenses, your new cluster licenses are Active:

Right-click the old licenses and select Delete to delete them.

At any time during these steps, licensing clients were able to receive licenses.

Rename a Member
Before you begin: In the following scenario, let's assume you have a failover cluster with the following three
cluster members, M1, M2 and M3:
• M1: icwvc1plp
• M2: icaix1plp
• M3: icw8s4plp
Let's assume you need to rename M1 from icwvc1plp to icw7c1plp.

1. Stop failover cluster member M1 icwvc1plp.

2. Rename M1 and restart the computer.
3. Install a DS License Server from scratch on member M1.
4. Do not configure M1.
5. From failover member M2, start the License Administration Tool.
6. In the Server Configuration dialog box for your cluster, click the ... button after member M1:

The Modify Cluster Member dialog box appears.

7. Check the option Change computer name and enter the name of computer icw7c1plp as illustrated below:

DS License Server 3DEXPERIENCE R2016x Installation and Configuration Guide 55

Configuring the DS License Server and Clients

Then, click the OK button.

Your modified cluster now contains the following members:
• M1: icw7c1plp
• M2: icaix1plp
• M3: icw8s4plp

Note: This scenario can also be useful if you want to change hardware but keep the network card on
the replaced computer.

Note: You do not need new license keys because the three computer IDs remain the same.

Replace the Network Card of a Failover Member

Before you begin: In the following scenario, let's assume you have a failover cluster with the following three
cluster members, M1, M2 and M3:
• M1: icwvc1plp
• M2: icaix1plp
• M3: icw8s4plp

1. Stop failover member M1 and replace the network card of M1 with a new network card.
2. Install a DS License Server from scratch on member M1.
3. Do not configure M1.
4. Obtain replacement failover license keys for the computer IDs M1, M2 and M3.
5. From failover member M2, start the License Administration Tool.
6. In the Server Configuration dialog box for your cluster, click the ... button after member M1:

56 DS License Server 3DEXPERIENCE R2016x Installation and Configuration Guide

 Configuring the DS License Server and Clients

The Modify Cluster Member dialog box appears.

7. Check the option Update computer id as illustrated below:

Then, click the OK button.

The following warning is displayed:
Warning: Enrolled licenses will be invalidated within 24 hours. You should be ready after this operation to
enroll a full set of licenses. Do you want to proceed?
Click the Yes button.
Your cluster will be updated with a new computer id for member M1.
8. Enroll new licenses generated for the cluster.
New cluster licenses are needed because one of the three computerIDs in the failover cluster has changed.
For practical reasons, we strongly recommend that you obtain the new licenses BEFORE changing the
computerID of a cluster member.

Note: Keep in mind that as long as two members are active, the failover cluster remains operational.
As soon as one computerID of the failover is changed, the cluster remains up but the old licenses are
considered still valid for a maximum duration of 24 hours only. The new licenses containing the
replacement computerID must be enrolled during this 24-hour period. Obtaining the new licenses
before is critical.

After enrolling the new licenses, your new cluster licenses are Active:

DS License Server 3DEXPERIENCE R2016x Installation and Configuration Guide 57

Configuring the DS License Server and Clients

Right-click the old licenses and select Delete to delete them.

At any time during these steps, licensing clients were able to receive licenses.

Repair Corrupted Data of a Member

Before you begin: In the following scenario, let's assume you have a failover cluster with the following three
cluster members, M1, M2 and M3:
• M1: nuq32plp
• M2: icaix1plp
• M3: iclin3plp
Let's also assume that license data on cluster member M2 is corrupted.

1. Stop failover cluster member M2.

2. Install a DS License Server from scratch on member M2.
3. Do not configure M2.
4. From failover member M1, start the License Administration Tool.
5. In the Server Configuration dialog box for your cluster, click the ... button after member M2:

The Modify Cluster Member dialog box appears.

6. Check the option Repair computer as illustrated below:

58 DS License Server 3DEXPERIENCE R2016x Installation and Configuration Guide

 Configuring the DS License Server and Clients

Click the OK button to repair the corrupted data.

Note: You do not need new license keys because the three computer IDs remain the same.

Starting and Stopping the DS License Server

Tools are provided to start and stop the DS License Server.

1. The first and simplest way is to use the standard Windows Services management tool and stop the DS License
Server Windows service.
When you installed the DS License Server, a Windows service named DS License Server was created and
configured automatically to start the license server. The service guarantees that the DS License Server is
always started automatically when you log on:

Since the DS License Server complies with Windows Service standards, you can also start and stop the DS
License Server service using the following commands in an elevated command prompt:
net start "DS License Server"
net stop "DS License Server"

DS License Server 3DEXPERIENCE R2016x Installation and Configuration Guide 59

Configuring the DS License Server and Clients

Information and errors related to the DS License Server service are logged in the Windows event log and
can be viewed using the Event Viewer, under License Server in the Source column in the Application section,
as illustrated below:

2. Additionally, particularly when you are administering a remote license server, to stop the license server, you
can also select Start - All Programs - DS License Server - License Server
Administration to launch the License Administration Tool if it is not already launched.
3. Connect to the license server by pointing to the icon, right-clicking and selecting the Connect command.
4. Select the Servers - Stop command and select the server name.

A dialog box appears prompting you to confirm that you want to stop the server:

60 DS License Server 3DEXPERIENCE R2016x Installation and Configuration Guide

 Configuring the DS License Server and Clients

5. Click OK.
You are immediately disconnected from the server:

If you try to connect to the server, the following dialog box appears:

prompting you to check the server hostname and port number, and to check if the server is running, which
is not the case, because it has just been stopped. Click OK to access the license server configuration parameters
enabling you to check the server hostname and port number. Click Cancel to exit.
If you access the Windows services and refresh the list, you will notice that the DS License Server service
has been stopped.

DS License Server 3DEXPERIENCE R2016x Installation and Configuration Guide 61

Configuring the DS License Server and Clients

Note: The License Administration Tool remains active because you can use it to connect to a remote
server even if your local license server has been stopped.

6. To start the license server again, restart the DS License Server using the Windows Services GUI tool.

Note: On UNIX, start the license server by running the following command, for example on
AIX:
/usr/DassaultSystemes/DSLicenseServer/aix_a64/code/bin/DSLicSrv
-startServer
and stop the license server using the command:
/usr/DassaultSystemes/DSLicenseServer/aix_a64/code/bin/DSLicSrv
-stopServer

or the Servers - Stop command using the License Administration Tool.

Configuring Clients
Once your license server is up and running, and your licenses have been enrolled, you must configure the license
clients.

1. On Windows, on each client computer, create the following directory:

C:\ProgramData\DassaultSystemes\Licenses
On UNIX, create the following directory:
/var/DassaultSystemes/Licenses

2. Go to the directory and create an ANSI file (multi-bytes such as UNICODE are not supported) named:
DSLicSrv.txt
3. Edit the file to declare the license server to which the client can connect.
The syntax of the declaration is as follows:
servername:portnumber
The server name can be declared as:
• a simple hostname, for example: lw5ses1dsy:4085
• a full qualified domain name, for example: lw5ses1dsy.dsy.com:4085
• an IPV4 address, for example: 10.232.70.1:4085
• an IPV6 address, for example: [2a00:4b00:220:172::103]:4085
The port number is the license server listening port, not the administration port.
Note that if the license server is on the same computer as the client computer, you must use the special
keyword localhost instead of the computer name, for example:
localhost:4085

Note: The syntax for failover servers is different. The three failover servers must all be referenced
on the same line as follows:
server1:4085,server2:4085,server3:4085

62 DS License Server 3DEXPERIENCE R2016x Installation and Configuration Guide

 Configuring the DS License Server and Clients

By default, load balancing of the three failover members is performed automatically by the licensing
client code. At startup, the licensing client process selects randomly the failover member to contact
from the three members declared. If the first selected member is down, the second member is randomly
selected, and so forth. This ensures that the three members are statistically contacted by the same
number of clients and results in automatic load balancing on the three members.
However, it is also possible to specify the order of priority in which failover members are contacted
by the licensing client, replacing randomization by an explicit order defined by the administrator. This
can be useful in the following cases, for example if:
• one member is more (or less) powerful than the others
• one member is located much closer to (or further from) the licensing clients than the others
• one member cannot be reached due to proxy constraints
• one member is temporarily down.
Note that you cannot mix both automatic and manual configurations: in other words, the three failover
members are either randomly accessed or are accessed through the specified order. So you cannot, for
example, declare the first member then set random access to the remaining two members.
To explicitly specify an order of priority order between the failover members, use the following
separator:
>
instead of:
,
which is reserved for automatic load balancing.
The following declaration is valid, for example:
licmbr1:4085>licmbr2:4085>licmbr3:4085

4. If several logical (i.e. standalone or failover) license servers need to be accessed, add a new line for each
logical license server.
In this context, when a client requests a license and this license is not already granted by one of the declared
logical servers, then the order in which the logical license servers is declared is observed: if a license is
available on the first declared logical server, this one is taken; if not, if a license is available on the second
declared logical server, then this one is taken, and so forth.
5. Optionally, check that the file is correctly configured.
The license client-side DSCheckLS command parses the DSLicSrv.txt file to check license server
availability, and reports errors if, for example, the file is incorrectly configured. For more information, see
the documentation of your license client product.

Communicating through Forward and Reverse Proxies

The machine hosting the License Administration Tool can communicate with a license server located behind
a forward proxy, and the license client and the License Administration Tool can communicate with a license
server located behind a reverse proxy, as explained in the following sections.

Implement a Forward Proxy for the License Administration Tool

The machine hosting the License Administration Tool can communicate with a license server located behind
a forward proxy.

DS License Server 3DEXPERIENCE R2016x Installation and Configuration Guide 63

Configuring the DS License Server and Clients

1. Configure the forward proxy in HTTPS mode.

Note: All of the following configuration examples reflect the configuration of an Apache 2.2 forward
proxy, purely for illustration purposes, and are in no way intended to reflect other proxy configurations.

Add the following lines to the httpd.conf file:

ProxyRequests On
ProxyVia On
<Proxy *>
Order deny,allow
Allow from all
</Proxy>
AllowCONNECT 4084 4085
where the AllowCONNECT command references the licensing and administration tool ports.
2. Start the License Administration Tool.
3. Select the Servers - New command.
The License Server Connection Parameters dialog box appears:

4. Enter the name of the license server (the name of the machine hosting the server, typically), set the listening
port number (default is 4084), then check the option Use a proxy server and enter the proxy name and proxy
port number, then click OK.

64 DS License Server 3DEXPERIENCE R2016x Installation and Configuration Guide

 Configuring the DS License Server and Clients

The License Administration Tool can now communicate with a license server located behind a forward proxy.

Implement a Reverse Proxy for the DS License Server

The license client and the License Administration Tool can also communicate with a license server located
behind a reverse proxy.

1. Configure the reverse proxy in HTTPS mode and map the communications between the reverse proxy and
the license server.
The maps are:
https://myreverseproxyname:443/DSLS/client https://mylicenseserver:4085/DSLS/client
https://myreverseproxyname:443/DSLS/admin https://mylicenseserver:4084/DSLS/admin
where myreverseproxyname is the reverse proxy hostname and mylicenseserver is the license
server hostname.

Note: All of the following configuration examples reflect the configuration of an Apache 2.2 reverse
proxy, purely for illustration purposes, and are in no way intended to reflect other reverse proxy
configurations.

Uncomment the following lines in the reverse proxy configuration file (httpd.conf):
#LoadModule proxy_module modules/mod_proxy.so
#LoadModule proxy_http_module modules/mod_proxy_http.so
#LoadModule ssl_module modules/mod_ssl.so
#Include conf/extra/httpd-ssl.conf
#Include conf/extra/httpd-default.conf
then edit the httpd-default.conf file and reset the value of the KeepAliveTimeout parameter:
KeepAliveTimeout 5
to a more appropriate value, for example:
KeepAliveTimeout 60

DS License Server 3DEXPERIENCE R2016x Installation and Configuration Guide 65

Configuring the DS License Server and Clients

Add the following lines in the SSL configuration file for the reverse proxy (httpd-ssl.conf), before
the </VirtualHost> tag:
SSLProxyEngine on
ProxyPass /DSLS/client https://mylicenseserver:4085/DSLS/client
ProxyPassReverse /DSLS/client https://mylicenseserver:4085/DSLS/client

ProxyPass /DSLS/admin https://mylicenseserver:4084/DSLS/admin

ProxyPassReverse /DSLS/admin https://mylicenseserver:4084/DSLS/admin
where mylicenseserver is the name of your license server.
Install your own certificate or a self-signed certificate you can generate by following the instructions on this
site:
http://httpd.apache.org/docs/2.0/ssl/ssl_faq.html#selfcert
This certificate will be presented by the reverse proxy to the license client and the License Administration
Tool.
2. Configure all licensing client computers to point to the reverse proxy.
To do so, add the following declaration to the DSLicSrv.txt file on each licensing client:
myreverseproxyname:443
where myreverseproxyname is the reverse proxy name and 443 is the proxy port number (443 by
default).
3. If you also want the License Administration Tool to be able to cross the reverse proxy, configure the License
Administration Tool to point to the reverse proxy.
To do so, start the License Administration Tool, and select the Servers - New command. When the
License Server Connection Parameters dialog box appears:

specify the reverse proxy hostname (rever1dsy in our example) in the License server name field (instead
of the license server name), and set the SSL port number (443 by default) in the Administration port field,
for example like this:

66 DS License Server 3DEXPERIENCE R2016x Installation and Configuration Guide

 Configuring the DS License Server and Clients

Only check the Use a proxy server option if you are also using a forward proxy.

Note: If you are using a failover cluster, you need to set up three ports on the reverse proxy,
corresponding to the three license servers. For example, the DSLicSrv.txt file on each licensing
client may contain in this case:
myreverseproxy:443, myreverseproxy:444, myreverseproxy:445

Once the reverse proxy has been implemented, there are two different names for the servers displayed in the
License Administration and License Recycle tabs and in the detailed view in the License Usage tab. The
name of the reverse proxy is displayed at the top, and the real license server name is displayed below, for
example:

The licensing clients and the License Administration Tool can now communicate with a license server located
behind a reverse proxy.

DS License Server 3DEXPERIENCE R2016x Installation and Configuration Guide 67

Managing Licenses

Managing Licenses
This section explains how to manage licenses.

Enrolling Licenses
Once your license server has been configured and activated, you can enroll your licenses.

1. Select Start - All Programs - DS License Server - License Server

Administration to launch the License Administration Tool if it is not already launched:

2. Connect to the server.

To connect to the server:
• Select the Servers - Connect command and select the server name from the list.
• Or, point to the icon, right click and select the Connect command.

• Or, you can also click the icon to connect all servers at the same time.

The icon confirms that your server is operational:

68 DS License Server 3DEXPERIENCE R2016x Installation and Configuration Guide

 Managing Licenses

3. Enroll your licenses as follows:

a. Select the License - Enroll command or click the icon.

The Open dialog box is displayed.
b. Go to the directory containing your licenses and select the appropriate licenses, then click the Open
button.
Note that you may receive either individual license keys (which are in files with the obsolete .LIC extension),
or license keys grouped in a single file (which has the .LICZ extension). With a .LICZ group of license
keys, you enroll all the licenses at the same time.
A .LICZ file will be named something like this (with the .LICZ suffix):
DLD-430814856494DBA7_7KLXM-UVSBG-8VFDL-GPMGS-V1ED3_0001_1.LICZ
The License Enrollment dialog box opens, informing you that license enrollment has been started, followed
by confirmation that your licenses have been successfully enrolled on your server:
License enroll starting
lw5ses1dsy : License enroll starting
Sending files to server lw5ses1dsy

E:\Licenses418\DLD-430814856494DBA7_7KLXM-UVSBG-8VFDL-GPMGS-V1ED3_0001_1.LICZ/FEAT-1-of-8.LIC

E:\Licenses418\DLD-430814856494DBA7_7KLXM-UVSBG-8VFDL-GPMGS-V1ED3_0001_1.LICZ/FEAT-2-of-8.LIC

E:\Licenses418\DLD-430814856494DBA7_7KLXM-UVSBG-8VFDL-GPMGS-V1ED3_0001_1.LICZ/FEAT-3-of-8.LIC

E:\Licenses418\DLD-430814856494DBA7_7KLXM-UVSBG-8VFDL-GPMGS-V1ED3_0001_1.LICZ/FEAT-4-of-8.LIC

E:\Licenses418\DLD-430814856494DBA7_7KLXM-UVSBG-8VFDL-GPMGS-V1ED3_0001_1.LICZ/FEAT-5-of-8.LIC

E:\Licenses418\DLD-430814856494DBA7_7KLXM-UVSBG-8VFDL-GPMGS-V1ED3_0001_1.LICZ/FEAT-6-of-8.LIC

DS License Server 3DEXPERIENCE R2016x Installation and Configuration Guide 69

Managing Licenses

E:\Licenses418\DLD-430814856494DBA7_7KLXM-UVSBG-8VFDL-GPMGS-V1ED3_0001_1.LICZ/FEAT-7-of-8.LIC

E:\Licenses418\DLD-430814856494DBA7_7KLXM-UVSBG-8VFDL-GPMGS-V1ED3_0001_1.LICZ/FEAT-8-of-8.LIC

lw5ses1dsy : 8 licenses received

4. Click OK to return to the License Administration Tool.

The icon confirms that your server has been activated:

If you point to the icon, a tooltip like this will be displayed:

server lw5ses1dsy (10.232.49.82) connected
confirming that your license server is up and running.

Note: Once you have configured and activated your server as a standalone server, you can no longer
change your mind and configure it as part of a failover cluster. That is why the corresponding options
are grayed out.

Administering Licenses
You can perform simple license administration tasks on licenses after enrolling them.

1. Click the Administration tab:

70 DS License Server 3DEXPERIENCE R2016x Installation and Configuration Guide

 Managing Licenses

2. Check the check box next to the desired server name (there may be several server names) to view the licenses
enrolled on that server.
The licenses you enrolled are listed:

A tool tip is displayed on the vertical scrollbar to display the total number of lines and the range of lines
displayed.
Time values displayed in UTC.

3. Right-click a license and select the Save command to save a single license. If the license belongs to a
replacement group, all lines corresponding to this group are automatically selected, and all lines selected will
be saved as a whole.

DS License Server 3DEXPERIENCE R2016x Installation and Configuration Guide 71

Managing Licenses

Note: Note that in the vast majority of cases, your licenses will be shipped as license groups.

4. Right-click a license and select the Delete command to delete the license. If the license belongs to a
replacement group, all lines corresponding to this group are automatically selected, and all lines selected will
be deleted as a whole.
5. Click the Display superseded licenses button if you wish to list licenses belonging to a replacement group
which is not the highest. Click again to revert back to the default (Hide superseded licenses).
This button is grayed out if no superseded licenses exist.
If you want to delete these superseded licenses, select all the lines with Superseded status, then right-click
and select the Delete command.
6. Click the Save all licenses... button to save all licenses to a separate directory of your choice.
7. The next button to the right displays one of three choices, depending on the context:
• if any licenses have expired, and can be removed, the Remove expired licenses button will be displayed.
Click this button to remove any licenses from the list which have expired. This option is grayed out in
read-only mode (when another License Administration Tool is connected).
• click the Hide expired licenses button to hide from the GUI the expired licenses belonging to a replacement
group containing non-expired licenses and which cannot be removed. Expired licenses belonging to a
replacement group can be removed only if all licenses in this group have expired, since a replacement
group can only be removed as a whole.
• click the Display expired licenses button to display the expired licenses belonging to replacement groups
also containing non-expired licenses.
When the button remains grayed out, no licenses have expired.
8. Click the Select columns... button to choose which columns to display in the tab.
The Select Columns dialog box is displayed:

72 DS License Server 3DEXPERIENCE R2016x Installation and Configuration Guide

 Managing Licenses

The columns you can display are:

Status The license status can be:

• Active: the license has been enrolled and is valid
• Expired: the license validity date has expired. The line appears in red.
• Not yet available: the license has been enrolled, but its validity date
has not yet been reached. The line appears in blue.
• Invalid: replacement group has been partially enrolled. You have to
remove it and re-enroll it properly. The line appears in red.
• Superseded: the license is no longer available, because a replacement
group with the same License ID and a higher Group Index has been
enrolled. Expired and Not yet available status are not valued for
Superseded licenses. If desired, superseded licenses can be safely deleted
by right-clicking on them. By default, line is not displayed.

Server Name of the license server.

Editor The editor can be, for example:
• Dassault Systemes
• Dassault Systemes V5

DS License Server 3DEXPERIENCE R2016x Installation and Configuration Guide 73

Managing Licenses

• Dassault Systemes V4.

Model Licensing model with which the license complies:

• NamedUser
• ConcurrentUser
• Token.

Feature Feature name, such as product trigram (for example, MD2) or custom
configuration.
Quantity Number of licenses enrolled.
Start Date Date from which the license is valid.
End Date Date after which the license is no longer valid.
Duration License validity duration (in hours).
Max Release Number Feature release level authorized by the license. Only licensing clients having
a release level lower or equal to this number are allowed. The Max Release
Number can be equal to 0. In this case, the license server does not perform
any check related to release number: the license can be granted whatever the
release level of the licensing client.
Max Release Date Client release date authorized by the license. Only licensing clients having a
release date lower or equal to this number are allowed.
Max Usage Duration Displays one of two values:
• the value is "0" for a full named user license
• the value is "40" for a casual usage named user license. The value
corresponds to the number of hours the license can be used by a given named
user during a given month.

Max Usage Period Displays one of two values:

• the value is "0" for a full named user license
• the value is "2" for a casual usage named user license.

License Type Type of license enrolled on the license server, depending on how your license
server is configured:
• Floating (for standalone license servers)
• Failover (for failover clusters).

Commercial Type Commercial types are:

• STD (for standard commercial licenses)
• DEMO (for demonstration licenses)
• EDU (for educational licenses).

License ID This character string is the license identifier. A license ID can exist either for
a single feature or a group of features.
Group Index License replacement group index. For a given License ID, the highest
number is active and the other numbers are superseded (if they have not been
removed).

74 DS License Server 3DEXPERIENCE R2016x Installation and Configuration Guide

 Managing Licenses

File Index Number of a particular feature in the replacement group.

File Quantity Number of individual features included in the replacement group.
Computer ID Computer ID of the machine hosting the license server.
Computer Name Name of the computer hosting the license server (when available).
Customer Site License owner.
Customer Country Country of license owner (3-letter international code).
Customer ID License owner ID.
Generation Date Date on which the license was generated.
Generator Company which generated the license.
Generator ID ID of the company which generated the license.
Editor ID Editor ID.
Additional Info Optionally used for specific needs.

What are License Replacement Groups?

The Group Index column displays the license replacement group index.
A given license id can exist either for a single feature or a group of features.
When you enroll the feature licenses for a given license ID and for the first time, the number in the Group
Index column is set to "0", and the Status is Active. When your licensing needs evolve, you may need to replace
an existing feature or group of features referenced by the same license ID. This is referred to as a license
replacement group. When you enroll the new license replacement group for the same license ID:
• the Status of the previous license changes to Superseded and is no longer displayed. If you wish to display
superseded replacement groups, click on the Display superseded licenses button. To gain useful space, after
a given period of validation, we recommend that you remove superseded licenses.
• a new line containing the same license ID is added, the number in the Group Index column is incremented,
and the status of the license is Active.

Getting Information About License Usage

The License Usage tab allows you to monitor license usage.

1. Select Start - (All) Programs - DS License Server - License Server

Administration to launch the License Administration Tool if it is not already launched.
2. Connect to the server.
3. Click the License Usage tab.
Based on the licenses previously enrolled, the License Usage tab looks like this:

DS License Server 3DEXPERIENCE R2016x Installation and Configuration Guide 75

Managing Licenses

You can sort columns by clicking on the column headers. If you want to sub-sort several columns, press the
Ctrl key while clicking.
A tool tip is displayed on the vertical scrollbar to display the total number of lines and the range of lines
displayed.
Editor Dassault Systemes, for example.
Feature Trigram of the product or custom configuration license. Keep in mind that the
license can be a named user license, a concurrent user license or a token license.
In use The number of licenses currently being used for a particular feature.
Count Total number of licenses enrolled for a particular feature.

4. Start a process (from the client or elsewhere) requiring a particular license.

In the rest of this section, the product license trigrams used are totally fictitious and do not exist, and
are used for illustration purposes only.
When the license server grants the license, for example, to a license client, the License Usage tab looks
something like this:

76 DS License Server 3DEXPERIENCE R2016x Installation and Configuration Guide

 Managing Licenses

The number in the In use column for the coresponding license is incremented by 1. Each time a license is
consumed, the number is incremented.
5. To find out details about the license (who is using the license, what type of license it is, etc.), double-click
the line containing the corresponding license (which is a named user license).
The Detailed License Usage box appears:

Time values displayed are formatted according to the local time (time zone) of the computer on which the
License Administration Tool is running.

Server Name of license server computer.

License type Type of license: NamedUser or Concurrent.
User Named user or concurrent user to whom the license is granted.
Host Name of the client computer on which the licensed process is running.
Granted since Time and date at which the license was originally granted to the user.
Last used at Time and date at which the license was last used.
Active process
Name of the active client process to which the license is granted. The prefix Offline
is used to identify extracted offline licenses. Note that in the case of an application server
process, the process name may not be displayed permanently.
Set the following variable:
MX_NUL_FULL_USAGE_REPORT=true
in the enovia.ini file (Windows) or mxEnv.sh (UNIX) to ensure that the process
name is displayed. For more information about this variable, see the Live Collaboration
server documentation.

DS License Server 3DEXPERIENCE R2016x Installation and Configuration Guide 77

Managing Licenses

Granted at Time and date at which the license was granted to the current process(es).
Max Release Feature release level authorized by the license. Only licensing clients having a release
Number level lower or equal to this number are allowed. The Max Release Number can be
equal to 0. In this case, the license server does not perform any check related to release
number: the license can be granted whatever the release level of the licensing client.
Expiration Date on which the granted license will expire. If expiring during a session, another license
Date will be automatically granted (if possible). This field is empty for license server levels
lower than R2015x.
Max Release Client release date authorized by the license. Only licensing clients having a release date
Date lower or equal to this number are allowed.
Internal ID Reserved for internal use.
Customer ID Customer id.
Casual usage
This field is only displayed once a casual license has been granted. It indicates, for the
(mn)
current month, the cumulative casual usage for a given casual license, measured by the
license server in minutes, as illustrated:

N/A is displayed in the field for full named user licenses, indicating that this field is not
applicable to full named user licenses. The value in minutes is highlighted in red if the
maximum allowed usage duration is exceeded.
Role of the License Server
When the license server receives a named user license request, it checks if it is for a full
license or a casual license. In the case of casual license, the license server then:
• measures the monthly usage of casual usage named user licenses by named users
• compares the monthly usages with maximum usage duration
• generates monthly reports pointing the over-use (if any).
The license server measures usage only for casual usage named user licenses. It does not
measure usage of full named user licenses, concurrent user licenses or token licenses.
In the event of license over-use, the following message is displayed in the casual usage
log file:
Usage of XXX (Dassault Systèmes) by YYY in excess of ZZZ mn
and also in the Server Logs tab.

Note: The month is managed as a calendar month between the 1st of month 00:00
UTC and the last day of month 24:00 UTC. The usage measurement is the same if
the calendar month comprises 28, 29, 30 or 31 days or if it contains holidays.

Monthly Usage Reporting

78 DS License Server 3DEXPERIENCE R2016x Installation and Configuration Guide

 Managing Licenses

At the beginning of every calendar month, the license server generates a usage report.
This monthly report file is generated only if at least one active casual usage named user
license is enrolled in the license server. It is generated even if no over-use occurred during
the calendar month.
All casual usage values in Detailed License Usage dialog boxes on the license server are
reset to "0" the following month.
The report is generated at 00h00 UTC. If the license server is not running at this particular
moment, the report is generated the next time the license server is restarted.
In case of failover, each member generates the same report. The report files on each of
the three members are the same.
Please see File Locations, Settings and Registry Entries for a description of the report's
location and contents.

6. This time, start another application (for illustration purposes, LIV) and connect to a data source different
from the 3DSpace server (you are not connected to the 3DSpace server), for example by opening a 3DXML
file.
You will be prompted to choose the appropriate license using the License Manager tab.
The License Administration Tool box now looks like this:

A license for the product is consumed, so the number in the In use column is incremented by 1.

7. To find out details about the license (who is using the license, what type license it is, etc.) double-click the
line containing the appropriate license.
The Detailed License Usage box appears and looks like this (divided into three parts in the following
screenshots):
This is the left section showing the user:

DS License Server 3DEXPERIENCE R2016x Installation and Configuration Guide 79

Managing Licenses

and this section shows the active process:

You will find the same type of information (the license type is NamedUser), except that the user is not a
named user (because you are not connected to the 3DSpace Server) but the operating system user. When you
exit the session, therefore releasing the license, the number in the In use column becomes "0".

8. Then, start the LIV-MDEVPM configuration and log on as DemoReviewer (this time, you are connected to
the 3DSpace server as a named user).
The License Administration Tool box now looks like this:

The LIV-MDEVPM license is a named user license. The number of LIV-MDEVPM licenses in use is now
"1", and the number of CPF licenses in use is now "2" because when DemoReviewer consumes a
LIV-MDEVPM license, a CPF license is also consumed.

Note: It may occur for a given feature that the numbers in the In use and the Count columns are
identical. This means that no more license are available. When this is the case, the corresponding line
is highlighted in bold.

80 DS License Server 3DEXPERIENCE R2016x Installation and Configuration Guide

 Managing Licenses

9. Double-click the line containing the LIV-MDEVPM license.

The Detailed License Usage box appears and looks like this:

Which License is Served to a Client When Several Licenses Can Satisfy the Client Request?
A license key contains several fields. When a licensing client requests a license, it passes several parameters to
the license server, such as the feature name for example.
When several licenses with different fields can satisfy the request, the license server must decide which license
will be granted.
First, the license server performs filtering based on the following criteria:
• the license must be active:
- Start Date < current date < End Date
- the highest valid Group Index is taken into consideration.

• the remaining available quantity must be higher than 0

• the Editor ("Dassault Systemes V5" for example) must match the client request
• the Feature (MD2 for example) must match the client request
• the Model (ConcurrentUser for example) must match the client request
• the Max Release Number must be 0 or must be higher than or equal to the Release Number passed
by the client
• the Max Release Date must be higher than or equal to the Release Date passed by the client
• the Commercial Type must match the client request (if passed)
• the Customer ID must match the client request (if passed)
• authorization rules (if any) must be satisfied.
Then, the license server performs sorting based on the following criteria:
1. Commercial Type: STD, then EDU, then DEMO
2. then, Max Release Number: from the lowest to the highest (0 is considered as infinite)
3. then, Max Release Date: from the lowest (the more distant in the past) to the highest (the more distant
in the future)
4. then, Additional Info:
• from the lowest number of fields to the highest number of fields
• then, from the lowest string to the highest string (locale alphanumeric order).

5. then, End Date: from the highest (the more distant in the future) to the lowest (the nearest in the future)
6. then, File Index: from the lowest to the highest (for a given License ID)
7. then, Generation Date: from the highest (the less distant in the past) to the lowest (the more distant in
the past).

DS License Server 3DEXPERIENCE R2016x Installation and Configuration Guide 81

Managing Licenses

The license granted is the one on top of the filtered sorted list. When an in-use license expires or belongs to a
Group Index which becomes superseded, the license server tries to silently grant another license, using the
same algorithm. If no license can be granted, the client will be informed at its next heartbeat.

Recycling Named User Licenses

This section describes how named user licenses are consumed and the steps you must take to recycle them when
you need to reassign them to other users.
If you do not have any named user licenses, you may want to hide this tab by going to the View menu and
unchecking License Recycling.
Named user licenses are consumed immediately when a user starts a session, remain consumed after the user
logs out, and continue to be consumed until the license expiration date.
The need occasionally arises, under exceptional circumstances (for example, when employees leave the company),
to unassign licenses to sever the tie between these employees and licenses assigned to them, and reassign the
licenses to another user.
When a named user license is recycled, the license server removes the link between a given named user license
and a given named user. After recycling, the named user license is no longer tied to a specific user but is available
for any user (including the previous user).
The Live Collaboration Server-side Assign Licensing by Product tool (discussed in the Dassault Systemes
Licensing Essentials Guide) is used to assign licenses to and unassign licenses from users, but this may not be
sufficient in some cases (if the 3DSpace server cannot contact the license server, for example).
The licenses can also be recycled on the license server. This is the role of the Recycling tab which allows you
to recycle named user licenses only.

1. Select the Recycling tab.

In the rest of this section, the product license trigrams used are totally fictitious and do not exist, and
are used for illustration purposes only.
In this example, several named user licenses have been granted:

A tool tip is displayed on the vertical scrollbar to display the total number of lines and the range of lines
displayed.

Note: Since they cannot be manually recycled, casual usage named user licenses do not appear. At
the beginning of every month, the license server automatically recycles all casual usage named user

82 DS License Server 3DEXPERIENCE R2016x Installation and Configuration Guide

 Managing Licenses

licenses. If a casual usage named user license is in use at that moment, recycling of that license is
cancelled for this month for this user.

2. To recycle a license, double-click the line containing the license for user DemoReviewer, or right-click
the line and select the recycle licenses command.
You are prompted to confirm:
Do you really want to recycle named user licenses granted to DemoReviewer on server lw5sesdsy?
Click Yes or No. If you click Yes, another dialog box informs you that all the licenses for the selected user
on the selected server will be recycled.

Note: It is not possible to recycle simultaneously licences for several users.

3. Click OK.
The license may or may not be recycled. If it cannot be recycled, another dialog box appears with a message
like this:
Licenses granted to DemoReviewer on server lw5sesdsy were not recycled: CPF is locked until 8/4/13 7:24
PM LIV-MDEVPM is locked until 8/4/13 7:24 PM
If the user did not close the session, you will be informed that the user's licenses are locked by a running
process.
4. Click OK to exit.

Note: You can configure your license server to automatically recycle named user licenses which have
not been used for at least 30 days. For more information, see the Enable Automatic Recycling option.

Setting License Authorization Rules

This section describes how to set up license authorization rules for concurrent user licenses, token licenses and
named user licenses for users or machines.
Concurrent user licenses can be shared among users and are not tied to specific users. Certain licences can be
sold as shareable, which can be granted and released, for example, during a session using the Shareable Products
tab. Shareable licenses comply with the Concurrent User Licensing model and are network licenses served by
the DS License Server. By default, concurrent user licenses can be used without prior authorization by the DS
License Server.
Token licenses are similar to concurrent user licenses. The main differences are that a token cannot be shared
by several client processes (even running on the same computer), and that several tokens can be granted to a
given client process.
Named user licenses are typically granted to users managed by the 3DSpace-side Platform Management
or Manage My P&O and Content tools, or by the Assign Licensing by Product command.
However, in certain cases, you may need to enforce an additional stricter level of license control of named user
licenses on the DS License Server. To do so, you can optionally set authorization rules for named user licenses.

Note: A license authorization rule for a specific named user license takes precedence over license
assignments made on the 3DSpace server. This mechanism is particularly useful when you have several
instances of a 3DSpace server and a single DS License Server. In this case, for example, the number of
potential named users declared on the 3DSpace server instances (and to whom licenses are assigned) may

DS License Server 3DEXPERIENCE R2016x Installation and Configuration Guide 83

Managing Licenses

exceed the number of licenses available. Centralizing named user license rules on the single DS License
Server will enable you to enforce exactly the number of licenses granted to your company.
However, when managing authorization rules for a pre-V6R2012x license server, a License Administration
Tool cannot manage named user licenses. When upgrading the DS License Server, existing authorization
rules are automatically set to the concurrent user model.

The role of the Authorizations tab is to set authorization rules for licenses. There are four types of rules:
• Allow: authorize users or groups of users, computers or groups of computers, IP ranges and IP range groups
to use licenses
• Deny: deny authorization to the above
• Reserve: reserve a given quantity of licenses for a list of users, computers or IP ranges
• Limit: limit a list of users, computers or IP ranges to a given quantity of licenses.
Only one rule type can be applied to a given license.

1. Select the Authorizations tab.

The license servers available are listed to the left (highlighted in red). The list to the right contains the enrolled
licenses classified first by editor, then by license model (Concurrent User, Token, Named User), followed
by license feature then license id.
Our example illustrates separate sections for both concurrent and named user licenses you can authorize or
deny for the selected license server. For example, the concurrent licenses enrolled on the server for M3D for
the editor Dassault Systemes are visible, along with a number of named user licenses:

2. Right-click in the space below Users/Hosts/IP Ranges and select the Add command to create a User,
Host or IP Range.
The New User/Host/IP Range dialog box appears:

84 DS License Server 3DEXPERIENCE R2016x Installation and Configuration Guide

 Managing Licenses

Note: When the licensing client you are using is connected to the 3DSpace, the user name is the P&O
login name. When the client is not connected, the user name is the operating system login name.

3. Enter the name and check the appropriate option for what you are creating: user or host name, then click
OK.

User
Enter the user name or host name.
or
Host User and host names are case-insensitive, whatever the input method (by the GUI, command line mode or
XML file). For example, "Bob" and "BOB" are considered to be the same user. When entering user names
and host names, all characters are converted to lowercase.
If upgrading from an existing DS License Server, user names and host names are migrated to lowercase.
Whenever migration leads to a collision (for example, "BOB" and "Bob" are both migrated to "bob"), only
one set of rules is kept, randomly. Behavior was unpredictable anyway.
Note that group names can still contain uppercase characters.
A host name cannot contain the "." character. For FQDN host names, the comparison is performed with the
very first part of the hostname. Note that:
• you cannot enter a "." using the GUI
• a name truncated at the first "." in command line mode, when using an an XML file, or when migrating
from a previous DS License Server level.
In our example, the User/Host Definition field contains two users (administrator and
demodesigner):

DS License Server 3DEXPERIENCE R2016x Installation and Configuration Guide 85

Managing Licenses

IP
Enter the IP range name. This is slightly different from the user/host names because for IP range the name
Range
and the value are different.
Then click the IPRange button to display the following:

86 DS License Server 3DEXPERIENCE R2016x Installation and Configuration Guide

 Managing Licenses

Declare the IP ranges by clicking either the Classless Inter-Domain Routing button or the IPv4
or IPv6 range: button:
• Classless Inter-Domain Routing (CIDR)
Example: 127.0.0.1/32 is an individual IPv4 address in CIDR notation
fd00::/10 is a range of IPv6 addresses in CIDR notation.
• IPv4 or IPv6 range (classful network)
Example: 10.232.0.0-10.232.255.255 is a range of IPv4 addresses in classical notation.

4. Click on the symbol next to the M3D license. Do not select the individual license id if the imported license
is a license group (which is nearly always the case). Then, right-click and select the Add new rule -
Allow command.
Click Yes when asked to confirm.
The Rule properties dialog box appears:

DS License Server 3DEXPERIENCE R2016x Installation and Configuration Guide 87

Managing Licenses

Note that you can select multiple lines for creating the same authorization rule for several licenses in one
shot.

Select the type: Select the type: User, Host, IPRange, User Group, Host Group, or IPRange
Group.
Choose the name: Click and choose the User, Host, IPRange, User Group, Host Group or
IPRange Group name.

5. To authorize the user we created to use the M3D license, select the type, choose the name, click the Add
button then click OK.
The Authorizations tab now looks like this:

The M3D license is now highlighted in green, signifying that a rule has been created allowing the user to use
the license.
If a user other than the authorized user attempts to log in, the following message is displayed:
No license available at this time for this product

88 DS License Server 3DEXPERIENCE R2016x Installation and Configuration Guide

 Managing Licenses

Click OK and a second message appears confirming that the license is not authorized, for example:
Failed to request license for M3D version: 10 or higher) Error: License not authorized for this user License
server configuration file path: C:\ProgramData\DassaultSystemes\Licenses\DSLicSrv.txt (default path) List
of license servers: [01/01] lw5ses1dsy:4085 OK: License server is running

6. To cancel the rule, click the M3D license and select the Remove rule command.
When prompted, confirm that you want to remove the rule by clicking OK. The M3D license is no longer
highlighted in green.
You can multi-select several rules for deletion.

7. To deny authorization, click the M3D license and select the Add new rule - Deny command. Select
the type, choose the name, click the Add button then click OK.
The Authorizations tab now looks like this:

The M3D license is now highlighted in red, signifying that a "deny" rule has been created.
Click the user name and select the Properties command to display the user properties:

If the user then selects the Shareable Products tab in a client session and tries to reserve the license
for M3D, a popup message appears:
No license available at this time for this product
Click OK and a second popup message appears confirming that the license is not authorized:
Failed to request license for M3D (version: 10 or higher) Error: License not authorized for this user License
server configuration file path: C:\ProgramData\DassaultSystemes\Licenses\DSLicSrv.txt (default path) List
of license servers: [01/01] lw5ses1dsy:4085 OK: License server is running
If you click the Server Logs tab and scroll the log, you will see a message like this:

DS License Server 3DEXPERIENCE R2016x Installation and Configuration Guide 89

Managing Licenses

2014/08/07 18:04:40:402 W LICENSESERV M3D not granted, user administrator not authorized (from
client LW5SES1DSY (42721022FAFE292A-0ae84648.0):administrator:administrator:C:\Program
Files\Dassault Systemes\B418\win_b64\code\bin\3DEXPERIENCE.exe)

Note:
You can also set Allow and Deny authorization rules directly on the Editor name: Dassault
Systemes, Dassault Systemes V5 or Dassault Systemes V4. This type of rule acts as a preliminary
filter: the other rules set on the feature name or LicenseID are also taken into account, but only
after the rule on the Editor has been processed. These rules are also applied to offline extraction.
However, you cannot activate offline controls: keyword and maximum extraction duration cannot be
set at the Editor name level.
When an Allow rule is set, the Editor name icon appears with a green background:

When an Deny rule is set, the Editor name icon appears with a red background:

8. To create a group, right-click in the space below Group definition and select the Add command.
The Create new group dialog box appears:

90 DS License Server 3DEXPERIENCE R2016x Installation and Configuration Guide

 Managing Licenses

Note: Note that operating system user groups are not supported.

a. Enter a name for the group.

b. Check the User, Host or IPRange option.
c. Select the user or host name or IP range, then click the Add>> button and click OK.
The group is created. Click the group name and select the Properties command to display the group's
properties:

DS License Server 3DEXPERIENCE R2016x Installation and Configuration Guide 91

Managing Licenses

Note: When you display the properties of a group, the Group name field can be modified.

9. You can also copy user, host and group definitions and rules to another license server by clicking the
appropriate item and selecting the Copy to server command.
10. Click on a user, host, user group or host group and right-click to select the Remove command to delete the
object.
Contrary to V6R2014 and previous levels, you can delete a user, host, IPRange, user group, host group or
IP range group even if it is referenced by a rule or belongs to a group. This behavior avoids modifying all
rules tied to a user/host/group/IP range before deleting this user/host/group/IP range. When deleting the latter,
the rules and groups which become empty (if any) are also deleted.
11. To reserve a quantity of licenses, click the M3D feature and right-click to select the Add new rule -
Reserve command.
The Define a rule on the feature dialog box appears:

92 DS License Server 3DEXPERIENCE R2016x Installation and Configuration Guide

 Managing Licenses

Select the type: Select the type: User, Host, IPRange, User Group, Host Group, or
IPRange Group.
Choose the name: Click and choose the User, Host, IPRange, User Group, Host Group
or IPRange Group name.
Quantity of licenses: Specify the number of licenses to reserve.

Select the type, choose the name, specify the quantity of licenses then click the Add button then OK.
The Authorizations tab now looks like this:

The M3D license is now highlighted in blue, signifying that a "reserve" rule has been created.
12. Right-click a license feature in the tree on the right to access the Control offline command.
Select the command to display the Extract offline license configuration dialog box:

DS License Server 3DEXPERIENCE R2016x Installation and Configuration Guide 93

Managing Licenses

which allows you to set the maximum extraction duration, keyword protection and additional rules.
Licenses can be extracted for a maximum duration of 30 days in all cases. You can decide to reduce the
maximum duration for offline extraction of a given license feature, from 30 days (default) to 0 day, by 1-day
increments. When set to 0, offline extraction is prevented for this license feature.
End users then attempting to extract the offline license from the licensing client side for a license feature
controlled by a rule will only be able to extract the offline license for the duration specified in the rule.

When an offline restriction is set, the following icon is displayed:

When both an authorization rule and an offline restriction are set, the previous icon is displayed with the

colored background matching the rule type. For example, in the case of an ALLOW rule:

94 DS License Server 3DEXPERIENCE R2016x Installation and Configuration Guide

 Managing Licenses

You can also associate a keyword to each license feature using the Extraction keyword : field. When
a license is protected by a keyword, the end user has to enter the keyword on the licensing client side.
Keywords are not passwords: they are not encrypted. They appear unscrambled in several places, for example
in the XML file containing the authorization rules.
You can also set standard allow and deny authorization rules for fine-tuning offline extraction restriction. In
the dialog box, the choices are:
• None: by default, there are no restrictions.
• Allow: offline extractions are granted only to the selected User, Host, IPRange, User Group, Host Group
or IPRange Group. Click the Define rule button to define the rule using the standard method.
• Deny: offline extractions are denied only to the selected User, Host, IPRange, User Group, Host Group
or IPRange Group. Click the Define rule button to define the rule using the standard method.
The Allow/Deny authorization rule for restricting the offline extraction is the third level filter:
• if a rule is set on the EditorID, then it must be satisfied
• if so, if a rule is set on the Feature or the LicenseID, then it must be satisfied
• if so, the rule on the offline extraction is checked at this step
• If this new check is successful, then the user has to enter the keyword if one has been set by the license
server administrator.
When a license has expired or has been deleted, the above controls are kept (if they had been set) by the
license server and appear as ghost controls, as for ghost authorization rules.
As for rules, ghost offline restrictions can appear at the bottom of the tab:

13. To ensure that either a list of users or a list of hosts cannot consume more than a limited quantity of licenses,
proceed in the same way, this time by selecting the Add new rule - Limit command.

Note:
Mixing users and computers or users and IPRanges is not allowed for RESERVE and LIMIT rules. It
is only allowed for ALLOW and DENY rules. In this case, if both users and hosts are declared, then
both are checked when granting a license. For example:
• ALLOW USER1 and HOST1: only USER1 on HOST1 will obtain the license
• DENY USER2 and HOST2: USER2 cannot obtain the license whatever the computer. No user
can obtain the license if logged onto HOST2.

The Authorizations tab now looks like this:

DS License Server 3DEXPERIENCE R2016x Installation and Configuration Guide 95

Managing Licenses

The M3D license is now highlighted in brown, signifying that a "limit" rule has been created.
Here is an example to illustrate RESERVE and LIMIT rules:
Let's assume there are 100 licenses of ABC enrolled in a license server, and that you create a group of users
composed of 25 members:
• If you reserve 12 ABC licenses for this group, then you guarantee that at least 12 members of the group
can obtain an ABC license. The remaining 25-12=13 members can obtain or not a license depending on
the consumption of the 100-12=88 non-controlled licenses. With this rule, a maximum of 88 users not
belonging to the group can obtain a license, even if no group member consumes any license.
• If you limit to 12 ABC, then only 12 members of the group can obtain a license. The remaining 25-12=13
members cannot obtain one of the 100-12=88 other licenses, even if some of them are not consumed.
With this rule, 100 users not belonging to the group can obtain a license, if they are not consumed by any
member group.
How to prevent users or hosts not declared in a license authorization rule from acquiring licenses
A situation may arise in which all the licenses you have acquired have not yet been assigned to existing
users/hosts by existing authorization rules. As long as this situation continues, you may consider that there
is a risk that users/hosts not referenced by a license authorization rule may acquire licenses.
Consequently, you may wish to be able to partition both existing licenses and licenses purchased in the future
in an authorization rule. Using this technique, each declared user/host group will only be granted a specific
number of licenses which cannot be used by any other users/hosts.
To illustrate this mechanism in a concurrent user license context, let's assume you have the following users:
A,B,C,D,E,F,G,H,I,J,K,L. You want to partition the users into 3 groups: A,B,C in Group1 sharing only one
license, D,E,F in Group2 sharing two licenses, G,H,I in Group3 also sharing two licenses. You want to deny
access to users J,K,L. The license name is XXX, and you have purchased 10 licenses.
The solution is as follows:
1. create a RESERVE rule for Group1, quantity=1
2. create a RESERVE rule for Group2, quantity=2
3. create a RESERVE rule for Group3, quantity=2
4. create dummy group DummyGroup and create a RESERVE rule linked to DummyGroup, quantity=5.

96 DS License Server 3DEXPERIENCE R2016x Installation and Configuration Guide

 Managing Licenses

As a result, the remaining 5 licenses are assigned to the dummy group containing no users, so users J,K,L
will be denied access to any licenses since they are not referenced by any license authorization rule.
The authorization rules you just set up will be sufficient until you purchase and enroll additional licenses.
So yet again there will be a risk that they can be granted to anyone not referenced in the rule. The solution
is to reset, once and for all, the quantity of licenses assigned to the dummy group to an exceedingly high
number which by far exceeds the number of licenses that you will ever purchase (for example, 1000). Using
this technique, even the new licenses will be denied to users/hosts not referenced by the rule, and you will
not have to edit the rule each time you add additional licenses.
The fourth RESERVE rule in this context would then be, for example: create a RESERVE rule for
DummyGroup, quantity=1000.
To illustrate this mechanism in a named user license context, let's assume that 70 licenses for ABC have been
enrolled. You could create the following RESERVE rules:
• reserve 30 ABC licenses for HostA: HostA users are granted access to 30 ABC licenses
• reserve 30 ABC licenses for HostB: HostB users are granted access to 30 ABC licenses
• reserve 1000 ABC licenses for a non-existing dummy host, for example named "NonExistingHostName":
nobody (including HostA/B) can use the remaining 10 ABC licenses (70-30-30=10), because firstly the
number of licenses reserved is greater than the number of currently enrolled ABC licenses, and secondly
because in any case nobody can log onto host "NonExistingHostName" which of course does not exist.
The rule must be modified to enable anybody else to use the 10 ABC licenses and any future licenses.

Note: The number of reserved licenses can be greater than the number of enrolled licenses not only
when a RESERVE rule has been configured this way, but also for example when some licenses expire
after the RESERVE rule has been configured.

14. To set a rule for a named user license, proceed in the same manner.
When you assign a rule to a named user license, this rule takes precedence over all assignments for the same
license made on the Live Collaboration Server.
Let's take the following example.
User1 is granted access (on the Live Collaboration Server) to the named user license for the feature
LIV-MDEVPM (this feature is just an example and does not exist).
You then set an ALLOW authorization rule (on the DS License Server) granting User2 (who must previously
have been declared as a named user in the P&O database on the Live Collaboration Server) access to the
named user license for the feature LIV-MDEVPM.
The result is as follows:
• User2 can use the feature LIV-MDEVPM
• User1 CAN NO LONGER use the feature LIV-MDEVPM: the reason is that an ALLOW-type authorization
rule has now been set for this feature on the DS License Server side. This rule grants the feature license
to ONLY User2. And even though User1 was previously granted access via an Live Collaboration
Server-side tool, the authorization rule takes precedence. If User1 attempts to log on, the following
message will be displayed:
No license assigned to this user

DS License Server 3DEXPERIENCE R2016x Installation and Configuration Guide 97

Managing Licenses

Note:
If a license is removed or expires, and a rule had been assigned to that license, the rule is not deleted.
It becomes a ghost rule and is displayed in the lower right-hand corner:

This allows the administrator to avoid having to create the rule again if a new license is added. To
display the properties of the ghost rule, click on its name. To remove the ghost rule, click the red icon.

Note:
In the case of named user licenses, if you add a rule after some licenses have already been granted to
named users, then you may have to manually recycle them.
In example 1, let's assume that named user ABC license is granted to Steve:
1. Add a rule DENY Steve on ABC.
2. Steve can no longer use ABC, but the ABC license cannot be used by someone else.
3. You have to recycle Steve's licenses.
In example 2, let's assume that there are 10 named user XYZ licenses and that 2 of them are granted
to Alan and Barbara:
1. Add a rule RESERVE 9 XYZ to UserGroup1. (Alan and Barbara don't belong to UserGroup1).
2. Alan and Barbara can still use XYZ and only 8 users of UserGroup1 can use XYZ.
3. You have to recycle either Alan's or Barbara's licenses.

15. Edit an authorization rule to monitor the number of licenses consumed by the user, user group, host, host
group, IP range or IP range group linked to the rule.
In this simple example, we created an ALLOW rule for the user plmadm on the LIV-MDEVPM feature. To
edit the rule, click on the rule and right-click to select the Edit rule command. The Currently
consumed column specifies that one LIV-MDEVPM license has been consumed by user plmadm:

98 DS License Server 3DEXPERIENCE R2016x Installation and Configuration Guide

 Managing Licenses

Note: The term "currently consumed" means that the license has been granted to the user and the
licensed process has been effectively executed at least once, in particular for named user licenses: it
does not mean that the licensed process is being executed at the same time as you edit the rule. The
Currently consumed column is not displayed when setting a rule, only when editing a rule.

In the following example, we created a user group named MyGroup (containing the users demoreviewer
and administrator), and created a rule reserving five licenses for the group. The Currently
consumed column specifies that one LIV-MDEVPM license has been consumed by a member of the group:

DS License Server 3DEXPERIENCE R2016x Installation and Configuration Guide 99

Managing Licenses

The list may also contain several lines. For each line (corresponding to a user, a host machine, a group of
users or a group of host machines), the number of licenses currently consumed is displayed.
The number displayed is the number of licenses, even if the rule is declared for host machines. For example,
this number can be very high for only one host machine declared in the rule, if the host machine is an
application server hosting a 3DSpace server.
When the number is red, it means that the rule is not enforced. This can happen when the rule has been applied
after a named user license has been previously granted to a named user.
For example, in the following LIMIT rule related to the IFW license, the following rules have been set: 100
IFW maximum for GroupA and 2 IFW maximum for GroupB. 2 IFW are consumed by GroupA and 4 IFW
are consumed by GroupB:

100 DS License Server 3DEXPERIENCE R2016x Installation and Configuration Guide

 Managing Licenses

“4” appears in red, because it is a case of over-use: the rule limiting to 2 has been set after the 4 named user
IFW licenses have been granted to 4 named users.
For a DENY rule, usually the number is equal to 0. However, if it is not the case it is displayed in red.
When a name is present in a rule as an individual item and also as a member of one or several groups, then
only the individual declaration is taken into account by the rule.
For example, if Oliver belongs to UserGroup1 and a RESERVE rule is defined as 1 license for Oliver and 4
licenses for UserGroup1, we consider that Oliver was not a member of UserGroup1: when a license is granted
to Oliver, 4 licenses are still reserved for other members of UserGroup1.
When a name is present in several groups (and not as an individual item), only the group having the lowest
alphabetical name is taken into account by the rule.
For example, if Oliver belongs to UserGroup1 and UserGroup2, and a RESERVE rule is defined as 10 licenses
for UserGroup1 and 15 licenses for UserGroup2, we consider that Oliver was not a member of UserGroup2:
when a license is granted to Oliver, only 9 licenses are now reserved for other members of UserGroup1, but
15 licenses are still reserved for other members of UserGroup2.
When a user uses the same license from several computers, only the last grant is taken into account by the
rule. This can happen when a named user uses IFW from several application servers: the last computer will
be used in the rule.
For example, if a LIMIT rule is defined as 10 licenses for Computer1 and 15 licenses for Computer2, and
Oliver logs on to Computer1 then on to Computer2 while staying logged on to Computer1, the same IFW
license is granted to Oliver but it is first counted among the 10 licenses for Computer1 then, when Oliver
logs on to Computer2, counted among the 15 licenses for Computer2 (and no longer among the 10 licenses
for Computer1).
You can also monitor license usage by connecting to the license server in command-line mode then running
the getLicenseUsage command. For each license currently consumed, if the license has been granted
by an authorization rule, the individual name or group name will be displayed in the authorization
item field.
In our example in which we created the group MyGroup, the getLicenseUsage command returns the
following information:
Dassault Systemes (5E756A80-1C80-478D-B83A-1D5913677621)
.....
IFW maxReleaseNumber: 17 type: NamedUser count: 11 inuse: 2 customerId:
DSFRA123
internal Id: PLMADM granted since: Jul 5, 2014 6:45:30 PM last used at:
Jul 5, 2014
7:29:58 PM by user: PLMADM on host: WIN-KNKSL07ILFV
(FFFFFFFFFFFFFFFF-c0a81f80.0)
internal Id: demoreviewer granted since: Jul 5, 2013 7:24:02 PM last used
at: Jul 10, 2014
10:32:50 AM by user: demoreviewer on host: WIN-KNKSL07ILFV
(FFFFFFFFFFFFFFFF-c0a81f80.0)
...
internal Id: demoreviewer granted since: Jul 5, 2014 7:24:15 PM last used
at: Jul 10, 2014
10:02:50 AM by user: demoreviewer on host: WIN-KNKSL07ILFV
(FFFFFFFFFFFFFFFF-c0a81f80.1)
authorization item: MyGroup
...
...

16. Display or edit the properties of a user/host/IPrange, a group or a rule by either double-clicking on it or
right-clicking then selecting Properties or Edit.

DS License Server 3DEXPERIENCE R2016x Installation and Configuration Guide 101

Managing Licenses

Note: When a licensing client requests a license, the license server checks the authorization rules before
granting the license. Later, the client can check that the previously granted license is still granted by the
license server. At this moment, the license server checks only the ALLOW and DENY rules, but not the
RESERVE and LIMIT rules. Consequently:
• if the license server administrator added, changed or removed an ALLOW or DENY rule during the
client session, then the client can receive a KO, but
• if the license server administrator added, changed or removed a RESERVE or LIMIT rule during the
client session, then the client cannot receive a KO for this reason.

Importing and Exporting License Authorization Rules

This section explains how to back up license authorization rules and corresponding data (users, hosts, groups)
by exporting the data to an XML file, and how to import an XML file containing previously backed up
authorization data.

Export Authorization Rules

1. Select the Authorizations tab.
A toolbar is located in the top right corner of the tab:

The toolbar looks like this :

102 DS License Server 3DEXPERIENCE R2016x Installation and Configuration Guide

 Managing Licenses

The first two buttons, from left to right (Export and Reset) are grayed out because at this stage you do not

have any authorization data to export. However, the Import button is activated since you can at least
import authorization data backed up in an existing XML file.
2. Create some users, hosts, IP ranges and/or groups, and create some authorization rules linked to the data you
created (as explained in Setting License Authorization Rules).
Once you have created all the data and rules, all the icons are activated like this:

3. Click the Export button and specify a file name in the dialog box displayed to save the file to XML
format.
The XML file is structured as follows, for example:
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<authorizations xsi:schemaLocation="http://www.3DS.com/DSLS
DSLSAuthorizations.xsd" xmlns="http://www.3DS.com/DSLS"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<users>
<user id="1">anna</user>
<user id="2">bob</user>
<user id="3">chuck</user>
</users>
<usergroups>
<usergroup id="1">
<name>UsrGroup1</name>
<user id="1"/> <!-- anna -->
<user id="2"/> <!-- bob -->
</usergroup>
</usergroups>
<hosts>
<host id="1">computera</host>
<host id="2">computerb</host>
</hosts>
<hostgroups>
<hostgroup id="1">
<name>ComputerGroup</name>
<host id="1"/> <!-- computera -->
<host id="2"/> <!-- computerb -->
</hostgroup>
</hostgroups>
<ipranges>
<iprange id="1" cidr="10.232.0.0/16">local10232</iprange>
<iprange id="2"
range="192.168.0.1-192.168.0.255">local1921680</iprange>
<iprange id="3" cidr="127.0.0.1/32">localcomputer</iprange>
<iprange id="4" cidr="fd00::/10">localipv6</iprange>
</ipranges>
<iprangegroups>
<iprangegroup id="1">
<name>localgroupipv4</name>
<iprange id="1"/> <!-- local10232 -->
<iprange id="2"/> <!-- local1921680 -->
<iprange id="3"/> <!-- localcomputer -->
</iprangegroup>
</iprangegroups>

DS License Server 3DEXPERIENCE R2016x Installation and Configuration Guide 103

Managing Licenses

<editor name="Dassault Systemes">

<model type="NamedUser">
<feature name="CPF">
<authorizationlist ruletype="Deny">
<name>CPF</name>
<user id="2"/> <!-- bob -->
</authorizationlist>
</feature>
<feature name="ENG">
<authorizationlist ruletype="Allow">
<name>ENG</name>
<host id="1"/> <!-- computera -->
</authorizationlist>
</feature>
<feature name="LIB">
<authorizationlist ruletype="Reserve">
<name>LIB</name>
<usergroup quantity="2" id="1"/> <!-- UsrGroup1 -->
</authorizationlist>
</feature>
<feature name="PRG">
<authorizationlist ruletype="Limit">
<name>PRG</name>
<hostgroup quantity="1" id="1"/> <!-- ComputerGroup -->
</authorizationlist>
</feature>
<feature name="VCN">
<authorizationlist ruletype="Allow">
<name>VCN</name>
<iprange id="2"/> <!-- local1921680 -->
<iprangegroup id="1"/> <!-- localgroupipv4 -->
</authorizationlist>
</feature>
<feature name="IFW">
<offlinerestrictions>
<name>IFW</name>
<keyword>secret</keyword>
<maxduration>21</maxduration>
</offlinerestrictions>
</feature>
</model>
</editor>
</authorizations>

Note: The <authorizationlist> tag can appear directly under the <editor name> tag and
not only under the <feature name> tag .

Import Authorization Rules

1. Before importing authorization data, decide whether or not to remove the existing authorization data on your
license server.
Removing existing authorization data guarantees that the result will be exactly the content of the imported
file. If you do not remove it, you will be prompted to merge manually the imported data with the existing
data.

Click the Reset button and click OK when prompted to remove existing data if required.

104 DS License Server 3DEXPERIENCE R2016x Installation and Configuration Guide

 Managing Licenses

2. To import authorization data, click the Import button and use the dialog box to select an XML file to
import.
If you removed existing authorization data from your license server, the imported data simply replaces it.
For example, importing the example XML file above creates the following rules illustrated below:

3. If required, edit the original XML file you imported.

For example, declare new user Chuck, and remove the rule linked to the ENG license.
4. Validate your XML file.
Use your favorite XML tool to reference the following XSD file:
DSLS_installpath\OS\resources\xsd\DSLSAuthorizations.xsd
to parse the XML file and validate its structure and syntax.
5. Re-import the file.
This time, because you did not remove the existing authorization data from your license server, a dialog box
will be displayed prompting you to merge the existing and imported data:

DS License Server 3DEXPERIENCE R2016x Installation and Configuration Guide 105

Managing Licenses

Expand each highlighted node to see the full details:

6. Resolve the merge.

106 DS License Server 3DEXPERIENCE R2016x Installation and Configuration Guide

 Managing Licenses

The role of each column is as follows:

Structure Compare
The Structure Compare column provides a synthetic view resulting from
the comparison of the existing and imported data, in the following order:
• user definitions
• host definitions
• IPRange definitions
• user group definitions
• host group definitions
• IPRange group definitions.
Note that:
• a red item with a warning symbol indicates that something is different
• a red item with a "+" symbol indicates that something has been added
• a red item with a "-" symbol indicates that something has been removed.

Server Authorizations The Server Authorizations column lists the existing server authorizations
for each category.
Imported
The Imported Authorizations column highlights in blue the imported
Authorizations
authorizations.

Navigate to the next or previous difference using the up and down arrows. Click the left arrow to accept the
highlighted difference.
In our example, the line "chuck" is highlighted in blue. It is highlighted because it is the first difference.
Click the down arrow to navigate then, for example, to the rule linked to the ENG license (which has been
has been removed), then to the other rules.
In our example, user "chuck" is highlighted in the Structure Compare and Imported
Authorizations column because it is the first difference detected. The "+" symbol on the rule chuck
in the Structure Compare indicates that the definition has been added.
To accept this first difference, click the left arrow: in this case, the user "chuck" is added to the Server
Authorizations column, and the "+" symbol is removed.
Click the down arrow to navigate to the next difference detected, and click the left arrow each time if you
accept the new rule.
All text in red becomes black once you accept the difference.
7. Click Apply or OK to accept the changes.
The updated data is then displayed in the Authorizations tab.
In our example, the user "chuck" has been added, and the rule has been removed from ENG:

DS License Server 3DEXPERIENCE R2016x Installation and Configuration Guide 107

Managing Licenses

Getting Information About the Authorized Country of Use for Licenses

The Geolocation tab identifies for a given license server the country in which the licenses enrolled on the server
are authorized, not the country in which the licenses are really being used.

1. Select Start - (All) Programs - DS License Server - License Server

Administration to launch the License Administration Tool if it is not already launched.
2. Connect to the server.
3. Click the Geolocation tab, then select if necessary the desired server.
The Geolocation tab looks, for example, like this:

108 DS License Server 3DEXPERIENCE R2016x Installation and Configuration Guide

 Managing Licenses

4. Zoom in on the world map by left-clicking and dragging a box around the region you are interested in.

The symbol identifies a country for which licenses are authorized:

DS License Server 3DEXPERIENCE R2016x Installation and Configuration Guide 109

Managing Licenses

The country is the one indicated in the Customer Country column in the License Administration tab.
Zooming on France displays the following:

110 DS License Server 3DEXPERIENCE R2016x Installation and Configuration Guide

 Managing Licenses

5. Point to the symbol to obtain additional information:

DS License Server 3DEXPERIENCE R2016x Installation and Configuration Guide 111

Managing Licenses

This displays:
• the authorized country
• the name of the license server on which the licenses are enrolled
• the number of licenses.

6. Click the symbol to the right to reframe the map.

7. Click the symbol to toggle to be able to move the map by dragging it.

8. To return to zoom mode, click the symbol.

112 DS License Server 3DEXPERIENCE R2016x Installation and Configuration Guide

 Tracking License Server Operation

Tracking License Server Operation

This sections presents the tools and techniques used for tracking license server operation.

Tracking License Statistics

Different types of license statistics are available using the Statistics tab.

1. In the Server Configuration dialog box, accessible when viewing your license server properties, check the
Enable license usage statistics option.
2. Select the Statistics tab.

3. Check the check box for the name of the license server:
This displays the statistics tools for the selected server:

DS License Server 3DEXPERIENCE R2016x Installation and Configuration Guide 113

Tracking License Server Operation

4. Use the Sort by: pull-down list to select how the license statistics are presented in the chart:

Name License statistics are presented according to the feature name (this is the
default and is illustrated above).
Number of In Use Licenses The features for which the highest number of licenses is currently being
used are presented at the top of the list.
Number of Available Licenses The features for which the highest number of licenses are available are
presented at the top of the list.
Percentage of In Use Licenses The features for which the highest percentage of licenses are currently
being used are presented at the top of the list.

5. Use the Model: pull-down list to specify the models of licenses for which you want to view statistics:
Any No filter is applied: all licence models are displayed.
Named user Only named user license statistics are displayed.
Concurrent Only concurrent user license statistics are displayed.
Token Only token license statistics are displayed.

6. Use the From: pull-down and navigate to specify the month when license usage statistics logging is started.
By default, the starting month is the current month of the preceding year.
You can extend (but not shrink) this one-year period by specifying the starting month of the statistics to be
logged.
Use the << and >> symbols to select the year. Use the < and > symbols to select the month.
7. Check the Display all checkbox if required.

114 DS License Server 3DEXPERIENCE R2016x Installation and Configuration Guide

 Tracking License Server Operation

This checkbox will help you avoid losing statistical information about expired licenses which are not renewed.
By default, only features with licenses which are still valid are displayed in this tab.
However, checking this check button displays features whose licenses have expired or have been deleted.
Activating this option is CPU-intensive since it consumes a lot of resources on the server side, and consequently
has to be used with caution.
You can use this possibility with the From : pull-down, keeping in mind that the further back logging begins,
the more resources are consumed on the server.
The minimum duration is 12 months.
8. Use the Editor: pull-down list to specify the editor of licenses for which you want to view statistics:

Dassault Systemes Only Dassault Systemes 3DExperience license statistics are

displayed.
Dassault Systemes V5 Only Dassault Systemes V5 license statistics are displayed.
Dassault Systemes V4 Only Dassault Systemes V4 license statistics are displayed.

9. Analyze the statistics.

Whichever way you filter the results, named user licenses are represented by a solid light grey chartbar, and
concurrent user licenses by a light grey chartbar with stripes. A three-letter code for the license is displayed,
alongside figures specifying the number of licenses used/total originally available, for example:IFW : 1/
11
When licenses are currently being used, a section of the chartbar proportional to the percentage of total
licenses being used for a given feature is displayed in green.
An increasing percentage of license usage will change the color of the chartbar. Here is a list of the colors
used and the percentages:
• Green: less than or equal to 75%
• Orange: between 75% and 90%
• Red: greater than or equal to 90%.

10. Point to the chartbar to display a magnifying glass which in turn displays information about the licenses.
Three numbers are displayed for each feature:
• the number of currently used licenses (1 in the example below)
• the total number of currently valid licenses (11 in the example below)
• the percentage of licenses currently used (9% in the example below).

11. Click the chartbar.

Another dialog box opens displaying month-by-month statistics.
The dialog box displays license usage statistics over the past 12 months or more, depending on the From:
value you set. Click the chartbar for the desired month for daily information about license usage for a specific
license. Click again for hourly information.
A tooltip containing detailed data is displayed when mousing over the vertical chartbar, for example:

DS License Server 3DEXPERIENCE R2016x Installation and Configuration Guide 115

Tracking License Server Operation

July 2014 : 21 licenses used, 4600 total

The green section represents the maximum usage rate for the given period, and not the maximum used. For
example, the following two statistics imply different maximum usage rates:
July 2014 : 21 licenses used, 4600 total
July 2014 : 23 licenses used, 5200 total
The maximum usage rate is the ratio of licenses used over the total number of licenses: the highest value is
always used (the first line in the above example).
The results may be unpredictable for the periods during which the server was stopped.

Note: The main section of the Statistics tab reports the licenses currently in use, at the present moment.
So the numbers displayed in this panel can go up and down, depending on instantaneous usage. When
you click on a specific license (using the chartbar), you enter the historical mode, with vertical chartbars
for monthly, daily or hourly usages. This provides access to the maximum usage for the given period.

Tracking Server Logs

You can consult license server logs using the Server Logs tab.

1. Select the Server Logs tab.

The tab looks like this:

116 DS License Server 3DEXPERIENCE R2016x Installation and Configuration Guide

 Tracking License Server Operation

Ctrl-F allows searching in the log.

Clicking at the top of the column headers allows you to sort the lines by timestamp, severity, type or message.
2. Specify the dates from when and until when you want to view log information, and select the server:

The exact moment corresponding to the From : date is at 00H01 local time (time zone) of the computer on
which the License Administration Tool is running.
The exact moment corresponding to the To : date is at 23H59 local time (time zone) of the computer on
which the License Administration Tool is running.
However, time values displayed are formatted according to the local time (time zone) of the computer on
which the license server is running.
The From : date value (respectively To :) is automatically set to the To : date value (respectively From :)
if the To : date value (respectively From :) is manually set to a value lower (respectively higher) than the
current From : (To :) date value.
Every event is time-stamped.
The log contains:
• information (identified by the letter I) about license server events such as starting and stopping the server,
enrolling licenses, etc.
• warning messages (identified by the letter W) displayed in blue
• error messages (identified by the letter E) displayed in red
organized into categories, each describing a specific area being monitored. For a full list of categories, see
Error, Information and Warning Messages
In the case of a failover cluster, each member has its own log files.
If you activated the License usage tracing... option in the Server Configuration dialog box, detailed traces
of license request and detach operations and timeouts will be logged.
Detailed monitoring of license usage is available with the USGTRACING category. The messages comprise
13 fields separated by the character "!":
• Field 1: Action; The possible values are:
- Grant: the license server has received a license request from a client, and the license server has
granted a license
- Detachment: the license server has received an end-of-use event from a client, and the license
server has then detached the license.
- TimeOut: the license server has not received a still-alive (heartbeat) event during the expected period,
and the license server has then detached the license.

Note: Detaching of licenses granted to the 3DSpace server is not traced by default. Instead,
timeouts appear for these licenses unless you set the following variable:
MX_NUL_FULL_USAGE_REPORT=true
in the enovia.ini file (Windows) or mxEnv.sh (UNIX). For more information about this
variable, see the 3DSpace server documentation.

DS License Server 3DEXPERIENCE R2016x Installation and Configuration Guide 117

Tracking License Server Operation

- Extraction: the license server has received a license offline extraction request from a client, and
the license server has granted an offline license
- Return: the client has returned an offline license
- Recovery: the offline extraction duration has ended.

• Field 2: Offline extraction duration (in days), or empty if field 1 is different from Extraction
• Field 3: Feature.
• Field 4: ID.
Every time a session is opened by a client, the license server allocates it an ID. Several different licenses
granted to a given session share the same ID (but not the same feature). Several different sessions do not
share the same ID, even if run by the same user on the same client computer.
For example, if a user launches simultaneously two CATIA V5 sessions requesting an HD2 license, only
one HD2 license is granted, but two grants are logged with two different IDs. This allows very precise
matching between grants and detachments, for example.
The format of this ID is slightly different between offline licenses and non-offline licenses.
• Field 5: Editor Name
• Field 6: Model: refers to the type of license (such as named user or concurrent user)
• Field 7: Quantity: 1, or N in the case of tokens
• Field 8: Commercial Type
• Field 9: Client Hostname.
FQDN appears if the following environment variable is set on the Windows client process environment
and if the Windows client process takes it into account:
DSY_SendFQDNtoDSLS=TRUE
• Field 10: Client IPv4/IPv6 address
• Field 11: Client Username
• Field 12: Client InternalID
• Field 13: Client exe name for non-offline licenses, or Client ComputerID for offline licenses. Note that
client exe name may be blank for some UNIX clients.
Examples: 3DEXPERIENCE.exe, CATAsyncProcess.exe, CATBatchStarter.exe,
CATUTIL.exe.

The following example illustrates log information for offline extraction of an MDG V6 license:
Extraction!20!MDG!2DA0Q-ZO8S2-YC5ST-874ZO-JJVXI!
Dassault Systemes!NamedUser!1!STD!COMPUTER2 (426814856456C759- 0a32103f.1)
!10.50.16.63!V6USER!V6USER!CSR-426814856456C759
In the case of an offline extension, two lines are logged:
• the first one is a Return, with the same ID as the one tagged in the previous matching Extraction
• The second one is an Extraction, with a new different ID.
When the license server is stopped, it cannot receive end-of-use and still-alive (heartbeat) events from clients.
When the server is restarted, if the expected period has passed, a TimeOut is logged.

Monitoring the Server

You can monitor license server performance using the Monitoring tab. Monitoring data is reset every time the
license server is restarted, so prior data is not displayed. Monitoring is particularly useful in comparison tasks:

118 DS License Server 3DEXPERIENCE R2016x Installation and Configuration Guide

 Tracking License Server Operation

different loads between servers, different loads depending on time, why is there a peak or null activity a particular
moment, etc.

1. Select the Monitoring tab.

2. Select a standalone server to monitor.
The tab looks like this by default when you are monitoring a standalone license server:

Activity over the last 24 hours is displayed in green bar graphs. The monitoring interval is one minute.
Time values displayed are formatted according to the local time (time zone) of the computer on which the
License Administration Tool is running.
3. Use the zoom slidebar to zoom on a particular period over the last 24 hours.
You can zoom down to display a period in intervals of 5 minutes:

The upper part of the display monitors the average duration of processing, by the license server, of client
messages which the license server receives.
The lower part of the display monitors the average number of client messages per minute processed by the
license server.
The different graphs are displayed on a logarithmic scale to be able to show both very high and very low
traffic. With a non-overloaded server, the average message processing duration should be a few milliseconds.
4. Set the Show longest durations check button to display the longest message processing durations.

DS License Server 3DEXPERIENCE R2016x Installation and Configuration Guide 119

Tracking License Server Operation

The red bar graph represents the longest duration of a client message for each minute of the displayed activity
period:

5. Point anywhere over the window to move a vertical line over the specific minute of interest and display
additional information.
For example:

This displays, for the specified minute, the average processing duration, the longest processing duration and
the number of client messages received.
6. In standalone server mode, choose Client traffic or Admin traffic.

Client traffic
Monitors messages sent by the license clients to the license server. The license
clients are the processes which request licenses to the license server.

Admin traffic Monitors messages sent by the License Administration Tools to the license
server.

7. If you select a failover server, similar tools become available:

120 DS License Server 3DEXPERIENCE R2016x Installation and Configuration Guide

 Tracking License Server Operation

The following modes are available in the pulldown menu:

Client
These perform the same monitoring functions as for a standalone server.
traffic/Admin
traffic
Failover
Because the selected server is configured as a member of a failover cluster:
traffic
• the upper part of the display monitors the average duration of processing, by the failover
member, of messages sent to the two other members
• the lower part of the display monitors the number of messages per minute sent to the two
other members
as illustrated below:

8. In case of suspected server performance problems or if the server hangs, and if requested, you can dump
server performance information using the dump buttons:
Dump heap The server memory is dumped in a file named HeapDumpxxxxxxxx.hprof in the
same folder as the ordinary server logs.

Note: On AIX, the file extension is .phd.

DS License Server 3DEXPERIENCE R2016x Installation and Configuration Guide 121

Tracking License Server Operation

Dump threads
The state of all threads of the license server is written to a file named
ThreadDumpxxxxxx.txt. This information could be requested from you in
exceptional cases where the server no longer replies to clients (in the case of deadlocks)
and no explanation can be found in server machine system reports.

It is now no longer possible to run such actions when connected in restricted mode from the GUI of the
license administration tool, and the dump buttons in the Monitoring tab are greyed out:

This ensures that no potentially very large files can be created by someone having only restricted access to
the license server.
This is not the case when connecting in restricted mode from the command line using the monitor
-dumpHeap command which does not create files on the license server machine. There is, however, one
exception where this remains possible, when you are connected to localhost only, in which case files
are created on the license server machine.

122 DS License Server 3DEXPERIENCE R2016x Installation and Configuration Guide

 Reference

Reference
This section contains reference information about batch commands and file locations. Command parameters are
case-sensitive.

DSLicSrv Command
The DSLicSrv command initializes and starts the license server and its associated administration tool.

Command Location and Syntax

On Windows, the DSLicSrv command is located by default in:
C:\Program Files\Dassault Systemes\DS License Server\win_b64\code\bin
On UNIX, the DSLicSrv command is located by default in:
/usr/DassaultSystemes/DSLicenseServer/OS/code/bin
This is the syntax:
DSLicSrv
-initServer [-adminPort nnnn] [-licensingPort nnn] [-enroll filename]
[-force]
-startServer [-echo] [-logDir path_to_log] [-logFileSize number]
[-compressLog]
[-disableSSLProtocol protocol] [-cipherSuitesPath filename]
-stopServer
-adminUI [-resetSettings] [-locale en_US]
-admin [-i input_file] [-o output_file] [-t output_file] [-ks
[keystore_file]]

Initialize the Server

Option Description

-initServer [-adminPort nnnn] Initializes the license server.

[-licensingPort nnn] [-enroll
• -adminPort nnnn: administration listening port number; mandatory only
filename] [-force] if -force is also used; if -force is not used, then -adminPort nnn is
ignored if passed
• -licensingPort nnnn: set the licensing port at installation time (avoids
having to set it later)
• -enroll filename: enroll a .LICZ license file at installation time (avoids
having to enroll it later). If enrollment fails, the installation succeeds.
Only a warning is added in the license server logs. This can happen, for
example, if the license file does not exist.
• - force: licenses must be re-enrolled (including the activation license)

Example:
DSLicSrv -initServer -adminPort 4084

DS License Server 3DEXPERIENCE R2016x Installation and Configuration Guide 123

Reference

Note: You must run this command as root on UNIX, and in an elevated command prompt on Windows.

Start the Server

Option Description

-startServer [-echo] [-logDir Start the license server:

path_to_log] [-logFileSize
• -echo: display messages in addition to logging them
number] [-compressLog]
• -logDir path: specify a different log directory; if you specify a remote
[-disableSSLProtocol protocol]
directory, the license server may hang if the remote directory can no
[-cipherSuitesPath filename] longer be accessed
• -logFileSize number: specify the maximum size of each server log file.
The number is in MB: the default is 1MB. As soon as this size is reached,
a new log file is created by the license server.
• -compressLog: compress server log files, in .gz format. Compression
is performed by the license server every time the uncompressed size of
the current log file reaches the logFileSize value (1MB by default),
and every time the license server is stopped. Note that an uncompressed
log file is created every time the license server is initialized (typically
at installation time).
• -disableSSLProtocol: specify the protocol to disable. For example:
-disableSSLProtocol SSLv3

• -cipherSuitesPath filename: specify cipher suite path.

Example
DSLicSrv -startServer

Note: You must run this command as root on UNIX, and in an elevated command prompt on Windows.

On Windows, you may prefer to use the following command in an elevated command prompt to start the server
as a Windows service:
net start "DS License Server"
Setting options in the DSLS Windows service
You can configure the DSLS Windows service to use the start options as follows:
1. Open an elevated command prompt.
2. Check the current properties of the license server service by running the following Windows command:
sc.exe qc "DS License Server"
The displayed BINARY_PATH_NAME line should match something like this:
"C:\Program Files\Dassault Systemes\DS License
Server\win_b64\code\bin\DSLicSrv.exe" -startServer

3. Modify the BINARY_PATH_NAME by running a command like the following one:

sc.exe config "DS License Server" binpath= "\"C:\Program Files\Dassault
Systemes\DS License
Server\win_b64\code\bin\DSLicSrv.exe\" -startServer -logFileSize 20
-compressLog"

124 DS License Server 3DEXPERIENCE R2016x Installation and Configuration Guide

 Reference

Note: note the space character after " binpath= ".

4. Check the new properties of the license server service:

sc.exe qc "DS License Server"
5. Stop and restart the service to take the changes into account.
6. Repeat this configuration after every installation, because an installation resets license server service properties.
On Linux, the start options can be set in /etc/init.d/dsls.
On AIX, the start options can be set in /etc/inittab.

Stop the Server

Option Description

-stopServer Stops the license server

Example:
DSLicSrv -stopServer

Note: You must run this command as root on UNIX, and in an elevated command prompt on Windows.

Start the License Administration Tool GUI

Option Description

-adminUI [-resetSettings] Starts the License Administration Tool GUI:

[-locale en_US]
• -resetSettings: resets License Administration Tool GUI settings
• -locale en_US: forces the License Administration Tool to be displayed
in English.

Example
DSLicSrv -adminUI
starts the License Administration Tool user interface.

Start the License Administration Tool in Command Line Mode

The majority of the tasks explained in this guide involve the use of the GUI version of the License Administration
Tool. However, you can perform the same tasks in command line mode.

Option Description

-admin [-i input_file] [-o Starts the License Administration Tool in command line mode
output_file] [-t output_file]
• -i input_file: input file containing list of commands
[-run "list of commands"] [-ks
• -o output_file: redirects output to an output file
[keystore_file]
• -t output_file: redirects output both to an output file and to the command
line window

For more information, see Redirecting Output.

DS License Server 3DEXPERIENCE R2016x Installation and Configuration Guide 125

Reference

Option Description

• -run "list of commands: runs a concatenated list of commands, as

explained in Running Several Commands at the Same Time
• -ks keystore_file: creates or uses an existing encrypted password file, as
explained in Managing Passwords.

The following command prompt appears:

License Administration Tool Version 6.418.0 Built on Jun 27, 2015 1:01:10
PM.
admin >
As you can see, when the prompt is:
admin >
you are inside the command line administration tool.
You have to connect to a license server after having launched the command line administration tool.
To list the commands available, enter one of the following commands:
admin > ?
admin > help
Most commands have both a long and abbreviated format, as indicated by the "|" separator which means "or",
for example: getConfig|gc. Running either the getConfig or gc command displays the same result.
To get help about a specific command, use the help|h command, for example:
help getConfig
help gc
Here is the list of available commands:

Operation Command Syntax Options

Connect to a license server connect|c server port [ -proxy server: license server host name
| -p proxyHost proxyPort] port: administration port number
[-restricted | -r]
-proxy|-p proxyHost proxyPort: proxy host
name and proxy port number

-restricted|-r: forces connection in restricted

mode (replaces -readOnly which remains valid
for backward compatibility reasons)

Get current license server getServerInfo|gsi

information

Disconnect from connected disconnect|disc|d

license server

Get license server configuration getConfig|gc

Get license information getLicenseInfo|gli This command no longer displays by default
[-superseded] the superseded licenses. To display the
superseded licenses, use -superseded option.

126 DS License Server 3DEXPERIENCE R2016x Installation and Configuration Guide

 Reference

Operation Command Syntax Options

Retrieve license data (save getLicenseData|gld [-editorID -editorID: editor identifier

license keys in a directory) editor] [-release release] -release: release number
[-licenseID license]
-licenseID: license identifier
[-groupIndex index]
[-fileIndex index] -out -groupIndex: replacement group number
directory -fileIndex: replacement file index

-out: output directory

Show current license usage getLicenseUsage|glu [-feature -feature: display usage on specified feature
feat] [-all|-short]
-all: display detailed client usage (including
casual license usage in minutes, last used date
for automatic recycling purposes, etc.) and
running processes

-short: display global usage only

This command now displays the Max Release

Date and the Expiration Date, in addition to
already displayed data. Expiration Date is
only displayed when connected to a R2015x
license server or a higher level.

Get license usage tracing flags getLicenseUsageTraces|dut

Activate/Deactivate license usage setLicenseUsageTraces|sut license1 license2 ...: licenses to manage usage
trace all|license1 license2 ... tracing, or all to manage all licenses
-trace|-t yes|no [-editorId|-e -trace yes|no: to activate or deactivate trace
editor]
-editorID: editor

Display logged server messages showLog|sl [-from fromDate] -from: lower limit (default midnight)
[-to toDate] -to: upper limit (default now)

Date format: YYYY/MM/DD

[HH:MM:SS]

Modify server configuration setConfig|sc -licensingPort: listening port for license client
[-licensingPort|-lp port] access
[-adminPort|-ap port] -adminPort: listening port for administration
[-failoverPort|-fp port] usage
[-password|-pwd]
-failoverPort: listening port for intra cluster
[-restrictedPassword|-rpwd] communications
[-remoteAdmin|-ra
-password: ask to be prompted to
none|restricted|full]
enable/disable password protection
[-failoverMode|-fm yes|no]
administration
[-clusterName1|-cn1 name]
[-clusterName2|-cn2 name] -restrictedPassword: ask to be prompted to
[-clusterName3|-cn3 name] enable/disable restricted mode password
[-enableLicenseStats|-els protection administration

DS License Server 3DEXPERIENCE R2016x Installation and Configuration Guide 127

Reference

Operation Command Syntax Options

yes|no] -remoteAdmin: disable administration from a

[-automaticRecycling|-ar remote machine or enable in full or restricted
yes|no] [-enableOffline|-eo mode
yes|no] -failoverMode: change standalone/failover
mode

-clusterName1: host name of the first machine

of the failover configuration

-clusterName2: host name of the second

machine of the failover configuration

-clusterName3: host name of the third machine

of the failover configuration

-enableLicenseStats: activates statistics

-automaticRecycling: activates automatic

license recycling.

-enableOffline: enable offline license

extraction.

Modify cluster modifyCluster|mc [-repair|-r -repair: repair server when license database is
host] [-update|-u host] corrupted
[-changeName|-cn host newHost] -update: update cluster when host computer id
[-changeMachine|-cm host has changed
newHost]
-changeName: modify cluster when a host
name has changed, computer id still the same

-changeMachine: modify cluster when a

machine has been replaced (computer id no
longer available)

Enroll licence files enrollLicense|e -dir inputDir -dir: input directory

-file file1 file2... -file: input files or regular expression

Erase licence data deleteLicense|dl -licenseID -licenseID: license identifier

uid [-group index] -group: replacement group number

Delete expired licenses deleteExpiredLicenses|dxl

Delete superseded licenses deleteSupersededLicenses|dsl
Create group of users to manage createUserGroup|cug groupName -users: list of users contained in that group
authorization lists -users user1 user2 ... -replace: replace existing group of users if any
[-replace]
Create group of hosts to manage createHostGroup|chg groupName -hosts: list of hosts contained in that group
authorization lists -hosts host1 host2 ... -replace: replace existing group of hosts if any
[-replace]

128 DS License Server 3DEXPERIENCE R2016x Installation and Configuration Guide

 Reference

Operation Command Syntax Options

Create an authorization list createAuthorizationList|cal -type: type of authorization list

name -type t -editorId ID (ALLOW|DENY|RESERVE|LIMIT)
[-product prd [-model -editorId: unique editor identifier
ConcurrentUser|Token|NamedUser]
-product: feature name to manage (optional);
[-licenseId id]] [-users
when not used, the rule is applied at the Editor
user1[,number] ...] [-hosts level.
host1[,number] ...] [-ipranges
ipr1[,number] ...] -model: ConcurrentUser|Token|NamedUser

[-iprangegroups -licenseId: licenseID number (optional)

iprgrp1[,number] ...] -users: list of individual users with optional
[-usergroups usrgrp1[,number] number of licenses
...] [-hostgroups
-hosts: list of individual hosts with optional
hostgrp1[,number] ...]
number of licenses
[-replace]
-ipranges: list of IPRanges with optional
number of licenses

-iprangegroups: list of groups of IPRanges

with optional number of licenses

-usergroups: list of groups of users with

optional number of licenses

-hostgroups: list of groups of hosts with

optional number of licenses

-replace: replace existing list if any

Create offline extraction createOfflineRestrictions|cor -editorId: editor unique identifier

restrictions -name -editorId id -product -product: product name to manage
prd -model m [-licenseId id]
-model: model of product to manage
[-keyword kw] [-maxDuration n]
(NamedUser|ConcurrentUser|Token)
[-replace] [-rule ALLOW|DENY
[-users user1 ...] -licenseId: license product number
[-usergroups usrgrp1 ...] -keyword: keyword to be provided to extract
[-hosts host1 ...] offline license.
[-hostgroups hostgrp1 ...] -maxDuration: maximum duration of
[-ipranges ipr1 ...] extraction validity, between 0 and 30 days
[-iprangegroups iprgrp1 ...]]
-replace: replace existing restriction name if
any

At least option -keyword or -maxDuration

must be passed.

-rule: specifies allow/deny restriction rules for

User, Host, IPRange, User Group, Host Group
or IPRange Group.

Delete user deleteUser|du userName

Delete host deleteHost|dh hostName
Delete group of users deleteUserGroup|dug groupName

DS License Server 3DEXPERIENCE R2016x Installation and Configuration Guide 129

Reference

Operation Command Syntax Options

Delete group of hosts deleteHostGroup|dhg groupName

Delete an authorization list deleteAuthorizationList|dal listname: name of list
listname
Delete offline restrictions deleteOfflineRestrictions|dor listname: name of list
listname
List users listUsers|lu
List hosts listHosts|lh
List groups of users listUserGroups|lug
List groups of hosts listHostGroups|lhg
Rename user group renameUserGroupName|rug
currentName newName
Rename host group renameHostGroupName|rhg
currentName newName
Rename authorization list renameAuthorizationList|ral
currentName newName
Rename offline restrictions renameOfflineRestrictions|ror
currentListName newListName
List all authorization lists listAuthorizationLists|lal
List all offline restrictions listOfflineRestrictions|lor
(keywords, maximum durations
and rules)

Create IP range createIPRange|cipr name -ip -ip: internet address range, (firstIP-lastIP or
iprange [-replace] CIDR notation)

-replace: replace existing item if any

Examples:

• cipr local1921680 -ip

192.168.0.1/24
-replace
• cipr localcomputer -ip
127.0.0.1/32 -replace
• cipr local10232 -ip
10.232.0.0-10.232.255.255
-replace
• cipr localipv6 -ip
fd00::/10 -replace

Create IP range group createIPRangeGroup|ciprg name -ip: IPRanges

-ip iprange1 iprange2 ...
-replace: replace existing item if any
[-replace]
Example:

130 DS License Server 3DEXPERIENCE R2016x Installation and Configuration Guide

 Reference

Operation Command Syntax Options

ciprg localgroup -ip

localcomputer
local1921680 local10232
localipv6 -replace

List all IPRanges listIPRange|lipr

List all IPRange groups listIPRangeGroup|liprg
Rename IPRange renameIPRange|ripr currentName
newName
Rename IPRange group renameIPRangeGroup|riprg
currentName newName
Delete IPRange deleteIPRange|dipr name
Delete IPRange group deleteIPRange|diprg name
Export authorizations to file in exportAuthorizations|ea -o -o file: path of XML file to generate
XML format file
Import authorizations from file importAuthorizations|ia -f -f file: path of XML file to read
in XML format file Note that all differences are automatically
accepted: existing data is removed and the new
data is added.

Monitor licence server monitor|mon [-dumpHeap|-dh] -dumpHeap|-dh: obtain server heap dump
[-dumpThreads|-dt] [-outDir|-o -dumpThreads|-dt: obtain server threads status
dir]
-outDir|-o dir: directory storing result of
command (mandatory for -dumpHeap option)

Display mail configuration getMailConfig|gmc

Set mail configuration setMailConfig|smc [-test|-t] -test|-t: test mail configuration
[-smtp servername] [-from -smtp servername: SMTP server name
sender] [-to
-from sender: sets the sender of the e-mails. It
email1,email2,...]
can be useful when certain security rules set
[-activate|-a event yes|no]
on the smtp server prevent the default sender
[-parameter|-p event param name value. The default value is
value] [-subject|-s event %host%@noreply. %host% is a placeholder
"..."] [-body|-b event "..."] matching the hostname of the license server.
[-mailBodyFooter|-footer %host% is very useful in failover mode, to
"..."] clearly identify which member sends an e-mail.
Note that this value cannot be set nor even
displayed using the GUI.

-to email1,email2,...: names of recipients

separated by comma (,)

-activate|-a event yes|no: activate or deactivate

the event, where event can be:

• OnServerStart: when server starts

DS License Server 3DEXPERIENCE R2016x Installation and Configuration Guide 131

Reference

Operation Command Syntax Options

• OnServerStop: when server stops

• OnDiskShortage: with parameter
Threshold in range 1 - 99
• OnLicenseSoonExpiring: when licenses
expire, with parameter Threshold in range
1 - 30
• OnMemberIsolated: with parameter
Threshold in range 1 - 60

-parameter|-p event param value: value of the

event parameter

-subject|-s event "...": subject of the mail for

the event

-body|-b event "...": set the body header of the

mail for the event

-mailBodyFooter|-footer "...": body footer of

all mails.

For example, to send mail notifications 25 days

before license expiration, run the command:
smc -activate
OnLicenseSoonExpiring yes
-parameter
OnLicenseSoonExpiring
Threshold 25
Manage SSL certificate manageSSLCertificate|msc Replaces the default self-signed SSL certificate
[-install -crt embedded in the license server by another one
file_path_to_server.crt -key you provided.
file_path_to_server.key] | -install: installs the certificate on the license
[-uninstall] [-nofailover] server and stores it in the repository folder.

-crt: file path to certificate file (server.crt)

-key: file path to RSA key (server.key)

-uninstall: uninstall certificate previously

installed (and use the default self-signed one)

-nofailover: do not propagate to both other

failover members. This option is useful when
installing a certificate on a failover member
and the certificate is not a domain certificate.
By default, the certificate is sent to the three
failover members.

This command can be useful when security

rules prevent access to HTTPS servers with a
self-signed SSL certificate or a certificate
whose duration is too long. It is your
responsibility to periodically renew the
certificate installed on the license server. If
this SSL certificate expires, licensing clients

132 DS License Server 3DEXPERIENCE R2016x Installation and Configuration Guide

 Reference

Operation Command Syntax Options

will refuse to connect to the license server and

licenses will not be granted.

To revert back to the default behavior (for

example, use the default self-signed
certificate), you must delete the previously
imported certificate using the -uninstall
option.

Stop licence server stopServer|ss

Exit the license administration quit|q|exit|x|bye
tool

Display help information help|h|? [command] command: (optional) display help information
relative to this command

Redirecting Output
By default, the DSLicSrv -admin command does not redirect output. The following table sums up the
different redirection possibilities available:

To perform this operation... Run this command...

Start the License Administration Tool in command line mode DSLicSrv -admin -o outputfile or DSLicSrv
and direct output to a newly created output file only -admin > outputfile
where outputfile is the name of the output file.

Start the License Administration Tool in command line mode DSLicSrv -admin >> outputfile
and append output to an existing output file only
where outputfile is the name of the output file.

Start the License Administration Tool in command line mode DSLicSrv -admin -t outputfile
and redirect output both to an output file and to the command
where outputfile is the name of the output file.
line window

After starting the License Administration Tool in command

Use the > sign to redirect command output, for example:
line mode, redirect output from individual commands to a
newly created output file glu -admin > outputfile
where outputfile is the name of the output file.

These new redirections take precedence over previous global redirections.

After starting the License Administration Tool in command

Use the >> sign to redirect command output, for example:
line mode, redirect output from individual commands to an
existing output file glu -admin >> outputfile
where outputfile is the name of the output file.

These new redirections take precedence over previous global redirections.

Here is a more elaborate example of how to use the different redirection possibilities:

DS License Server 3DEXPERIENCE R2016x Installation and Configuration Guide 133

Reference

Output from the commands highlighted in yellow is not redirected.

Output from the command highlighted in blue is appended to the existing file C:\temp\usage.txt.
Output from the pink command is redirected to the newly created file C:\temp\info.txt.

Managing Passwords
You may not want to enter passwords each time you run DSLicSrv -admin, particularly if full and restricted
passwords are set, or if passwords are different between license servers. Furthermore, writing passwords in batch
files is not secure.
You can store passwords in an encrypted file and reference this file when connecting to license servers. Adding
the option -keyStore [file.ks] (or -ks [file.ks] ) instructs the License Administration Tool to
work with the encrypted file containing the passwords.
The default pathname of the .ks file is:
• C:\Users\userid\AppData\Roaming\DassaultSystemes\LicenseAdmin.ks (Windows)
• $HOME\.LicenseAdmin.ks (UNIX).
but any pathname can be used.
The .ks file is encrypted with the OS username and the pathname in lowercase. This partially prevents different
users from using the same .ks file, or from moving a .ks file from one folder to another.
The .ks file can contain full and restricted passwords for several license servers. When the -keyStore option
is used and the .ks file does not exist or does not contain the valid password for the license server, you will be
prompted to enter a password. If you enter the correct password, it will be stored in the .ks file.
When the -keyStore option is used and the .ks file contains a valid password for the license server, no
password prompt is displayed and the access will be granted.

134 DS License Server 3DEXPERIENCE R2016x Installation and Configuration Guide

 Reference

License servers are identified by their names in a .ks file. Consequently, connecting a license server with an
IP address whereas the name has been stored in the .ks file will lead to a password prompt. The behavior is the
same if a license server is accessed both via localhost and its name, for example.
At the beginning of the following example, the -keyStore option has not been used already, therefore a .ks
file does not already exist, and you are trying to connect to a password-protected license server:

In the case of the command highlighted in yellow, you are prompted to enter a password because there is no
existing .ks file yet, so it will be created once you enter the password.
In the case of the command highlighted in blue, you are NOT prompted to enter a password because it can be
found in the .ks file which has just been created in the previous step.
In the case of the command highlighted in pink, you are prompted to enter a password because you started the
License Administration Tool without the -keyStore option.

Running Several Commands at the Same Time

You can run several commands at a time:
• using a batch file as input file containing the commands: in the input file, several commands can be entered
as if they were entered interactively
• or by concatenating the commands from the command line, eliminating the need for a batch file.

DS License Server 3DEXPERIENCE R2016x Installation and Configuration Guide 135

Reference

This is done using the -run "list of commands" option. Each command in the list of commands is
separated by a semicolon ;. The first command in the list must be the connect command (or help
command). Note that disconnect and quit commands are not mandatory at the end of the list.
If the server is protected by a full or restricted password, the password can be either entered interactively or
using a .ks file. You cannot enter the password in the list of commands after the -run option.
For commands requiring a confirmation, you must place the "yes" string immediately after the ";" without a
space between ";" and "yes".
Only one -run option can be passed.

The following table illustrates how to use both methods.

To perform this operation... Run this command...

Start the License Administration Tool in command line mode DSLicSrv -admin -i input file
and execute a command parameter file
The input file contains commands executed in command line mode.

Start the License Administration Tool in command line mode DSLicSrv -admin -run "list of commands"
and run a list of commands
Examples:
DSLicSrv -admin -run "c localhost 4084; glu"

displays license usage.

DSLicSrv -admin -run "c localhost 4084; gc; gli > C:\temp\gli.txt;
glu >> C:\temp\glu.txt"

displays the license server configuration, redirects the license information to

a new file, then appends license usage information to an existing file.
DSLicSrv -admin -run "c protcomp 4084 -r;
glu -all" -ks
displays the detailed license usage of a password-protected license server
accessed in restricted mode.

DSLicTarget Command Syntax

The DSLicTarget command returns the computer id.
Option Description

-t Display the computer id

-l List available network adapters

-c Clear data containing the reference to the current ComputerID: Windows registry key or Linux file (not
available on AIX). You must run this command in an elevated command prompt.

-s {...} Windows and Linux only. Use a specific device identifier (provided by the -l parameter) to generate the
computer id, for example:
DSLicTarget -s {558CBA02-9E12-33F7-49A9-1154BED416A6}
You must run this command in an elevated command prompt.

-h Display help

136 DS License Server 3DEXPERIENCE R2016x Installation and Configuration Guide

 Reference

Protocol and Cipher Suite Control

This section discusses protocol and cipher suite control.

Overview
The DS License Server uses https for communications. https is based on http and adds a security layer. This
security is implemented by various protocols and cipher suites. From time to time, certain weaknesses may be
found on a given protocol or a given cipher suite. Depending on the type of the security exposure discovered,
the consequences can be unpleasant when communicating on the Internet.
DS license servers are not on the Internet, but on the LAN of the company. So they are not vulnerable to attacks
exploiting the security issues. However, some companies use tools for reporting security vulnerabilities on all
computers of their network. These tools can then identify the computer hosting a DS License Server as unsecure,
even if this is not the case.
To obtain a clean report for these tools, a dynamic solution allows you to remove the protocols and cipher suites
considered as unsecure, by providing the ability to restrict the list of protocols and to set the list of cipher suites
that can be used in DS License Server communications.
When running a failover cluster, each member can start with its own protocols and cipher suites. To ensure that
the three members use the same protocols and cipher suites, the same modifications must be applied on the three
members.
If an administrator removes a protocol and/or a cipher suite, it is possible that an older licensing client may be
unable to communicate with the license server. This can happen if none of the allowed protocols and cipher
suites are enabled on the licensing client.

Supported Protocols
The DS License Server currently supports the following protocols:
• SSLv3
• TLSv1
• TLSv1.1
• TLSv1.2
You can remove the support for one or several protocols by adding a parameter when starting the license server:
-disableSSLProtocol.

Cipher Suites
The DS License Server supports a lot of cipher suites. This list can be found in the following file under the
license server installation path:
install_path/startup/DSLSJRE/CipherSuites.txt
The file is different for Windows/Linux and AIX.
Each line not beginning with a # character is an allowed cipher suite. Each line beginning with a # character is
a supported cipher suite, but not allowed.
If the content of this file is not appropriate in the company context, it can be copied in any folder and modified
to match what is desired.
Adding a leading # character removes the cipher suite from the list of allowed suites. Removing a leading #
character adds the cipher suite to the allowed list.

DS License Server 3DEXPERIENCE R2016x Installation and Configuration Guide 137

Reference

If an unsupported cipher suite (in other words, not already present in the delivered file) is added to the file, it
will be ignored.
When starting the DS License Server, the path of this customized file can be specified by using the
-cipherSuitesPath parameter. In this case, the original file will not be taken into account.
The delivered cipher suites file is installed every time the license server is installed. It is the responsibility of
the license server administrator to check whether the customized file needs to be updated or not.

Unlimited Strength Cipher Suites

We recommend that you do not use an "unlimited strength" cipher suite: they decrease performance and do not
provide more security in the context of the DS License Server.
An example of such a cipher suite is a cipher suite based on AES 256 bits. They require additional steps to be
activated:
• Download a Java Cryptography Extension Policy zip file from:
- Windows/Linux: http://www.oracle.com/technetwork/java/javase/downloads/
jce8-download-2133166.html
- AIX: https://www14.software.ibm.com/webapp/iwm/web/
preLogin.do?source=jcesdk

• Unzip the file, to extract local_policy.jar and US_export_policy.jar files.

• Overwrite both delivered files already installed in .../startup/DSLSJRE/lib/security with the
unzipped ones.

File Locations, Settings and Registry Entries

This section specifies where the different files, settings and registry entries are created when you install and
administer the DS License Server.
Entries marked (*) indicate items that are intentionally left in place after uninstallation.

Reference Table
File Type Location

License Repository (*) The license repository containing enrolled licenses is located in:
On Windows:
C:\ProgramData\DassaultSystemes\LicenseServer\Repository

On UNIX:
/var/DassaultSystemes/LicenseServer/Repository

Warning: THIS FOLDER AND THE FILES INCLUDED IN IT MUST NOT BE

CHANGED NOR EVEN MOVED, RENAMED NOR ACCESS RIGHTS MODIFIED
WHEN THE DS LICENSE SERVER IS NOT RUNNING. CERTAIN BACKUP OR
SECURITY SOFTWARE PRODUCTS PERFORM SUCH FORBIDDEN CHANGES.
CONFIGURE YOUR BACKUP SOFTWARE TO NOT BACKUP THIS FOLDER.
CONFIGURE YOUR SECURITY SOFTWARE TO NOT SCAN FILES WITH THE
.DAT EXTENSION IN THIS FOLDER. IF THESE RULES ARE NOT FOLLOWED,
THE NEED FOR REFRESHED LICENSE KEYS AND FOR RE-ENROLLING THE
LICENSE KEYS WILL BE MANDATORY. ONE OF THE BEST WAYS TO AVOID
THIS INCONVENIENCE IS TO STOP THE DS LICENSE SERVER FOR ONLY THE
FEW MINUTES NECESSARY TO UPGRADE IT.

138 DS License Server 3DEXPERIENCE R2016x Installation and Configuration Guide

 Reference

File Type Location

Log Files (*) On Windows, an installation log file is created in:
%TEMP%\DSLSmsi.log

This file is not created if the installation was performed by double-clicking the .msi file.
Furthermore, server statistics files (if enabled) and log files are stored by default in:
On Windows:
C:\ProgramData\DassaultSystemes\LicenseServer\LogFiles

On UNIX:
/var/DassaultSystemes/LicenseServer/LogFiles

A new log file is created each time the license server is started, and also once the size of the active
log file exceeds 1MB. Old files can be freely removed or archived.

Casual usage named user license On Windows:

monthly report (*)
C:\ProgramData\DassaultSystemes\LicenseServer\LogFiles

On UNIX:
/var/DassaultSystemes/LicenseServer/LogFiles

Its name is CasualUsage.YearMonth.txt and it contains the following information in plain text:

• Generation date
• License server name
• License server computerID
• List of CustomerSite value(s) present in the license keys
• List of overuses (if any) comprising lines with:

- Product name
- User name
- Measured usage duration
- Max allowed usage duration
- LicenseID

• Signature.

Settings (*) The License Administration Tool user interface settings file (LicenseAdminUI) is located in:
On Windows:
C:\Users\userid\AppData\Roaming\DassaultSystemes

On UNIX:
$HOME

Password keystore (*)

On Windows:
C:\Users\userid\AppData\Roaming\DassaultSystemes\LicenseAdmin.ks

On UNIX:
$HOME/.LicenseAdmin.ks

License Client Configuration (*) Nodelock licenses, extracted offline licenses and the licensing client configuration file
(DSLicSrv.txt) are located in:
On Windows:
C:\ProgramData\DassaultSystemes\Licenses

On UNIX:
/var/DassaultSystemes/Licenses

Warning: THIS FOLDER AND THE FILES INCLUDED IN IT MUST NOT BE

CHANGED NOR EVEN MOVED, RENAMED NOR ACCESS RIGHTS MODIFIED.

DS License Server 3DEXPERIENCE R2016x Installation and Configuration Guide 139

Reference

File Type Location

CERTAIN BACKUP OR SECURITY SOFTWARE PRODUCTS PERFORM SUCH

FORBIDDEN CHANGES. CONFIGURE YOUR BACKUP SOFTWARE TO NOT
BACKUP THIS FOLDER. CONFIGURE YOUR SECURITY SOFTWARE TO NOT
SCAN FILES WITH THE .LIC EXTENSION IN THIS FOLDER. IF THESE RULES
ARE NOT FOLLOWED, THE EXTRACTED OFFLINE LICENSES WILL NO LONGER
BE AVAILABLE ON THE CLIENT COMPUTER, AND WILL BECOME AVAILABLE
ON THE LICENSE SERVER ONLY AFTER THE EXTRACTION DURATION HAS
EXPIRED.

Note: You can change the default value for the path of the client configuration
file (but not the path of the license files) by setting the environment variable
DSLS_CONFIG to the full pathname of the file, for example on Windows:
set
DSLS_CONFIG=C:\SpecialProject\DSLicSrv.txt

Windows Registry Entries Standard Windows entries for managing the DSLS service.
Standard Windows entries for managing the DSLS installation.
The key:
HKEY_LOCAL_MACHINE\SOFTWARE\Dassault Systemes\Admin
(*)
manages ComputerID related info.
The key:
HKEY_CURRENT_USER\SOFTWARE\Dassault Systemes\LClient
(*)
may be present on the licensing client computer side.

Windows Shortcuts Start > Programs > DS License Server

UNIX system files The following system files are modified if you do not perform the installation using the -x option.
On AIX:
The file /etc/inittab is updated
On Red Hat:
/var/DassaultSystemes/Licenses/.Identifier
contains a reference to the ComputerID
The file /etc/init.d/dsls is created
The file /etc/sysconfig/dsls is created
The symbolic link /etc/rc.d/rc0.d/K02dsls is created
The symbolic link /etc/rc.d/rc1.d/K02dsls is created
The symbolic link /etc/rc.d/rc2.d/K02dsls is created
The symbolic link /etc/rc.d/rc3.d/S98dsls is created
The symbolic link /etc/rc.d/rc4.d/K02dsls is created
The symbolic link /etc/rc.d/rc5.d/S98dsls is created
The symbolic link /etc/rc.d/rc6.d/K02dsls is created
On SuSE:
/var/DassaultSystemes/Licenses/.Identifier
contains a reference to the ComputerID
The file /etc/init.d/dsls is created
The file /etc/sysconfig/dsls is created
The symbolic link /etc/init.d/rc3.d/Kxxdsls is created
The symbolic link /etc/init.d/rc3.d/Syydsls is created
The symbolic link /etc/init.d/rc5.d/Sxxdsls is created
The symbolic link /etc/init.d/rc5.d/Kyydsls is created

140 DS License Server 3DEXPERIENCE R2016x Installation and Configuration Guide

 Reference

File Type Location

(where xx and yy depend on your system configuration)

Port Management
This section describes port management.

DS License Server Ports

There are three ports involved when managing the DS License Server:
• Administration port (https protocol): default 4084, used by the License Administration Tool to
connect to the server
• Licensing Port (https protocol): default 4085, used by license clients to request licenses
• Failover port (https sockets): default 4086, used by intercommunication between cluster members.

Note:
• The https protocol is of the tcp type.
• The license administration tool and licensing clients can communicate with a license server through
a VPN if this VPN is properly configured to support https.

Troubleshooting
This section contains license server troubleshooting information.

Client cannot communicate with server

If this problem occurs:
• On the client, run the DSCheckLS tool to get the result of some automatic checks.
• Check that client and server have an absolute time difference lower than one hour (whatever the time zones,
which are ignored). A warning message Incompatible clock setting can be found in the server
log in such a case.
• Check that the .txt extension is not duplicated for the DSLicSrv.txt file on a Windows client:

DS License Server 3DEXPERIENCE R2016x Installation and Configuration Guide 141

Reference

This type of issue can occur when your Windows explorer is configured to Hide extensions for
known file types.
• Check that the DSLicSrv.txt file is at least in read access for everyone on the client.
• Check that the server is declared in the DSLicSrv.txt file with a full qualified domain name if your
network settings require it.
• Check that the DSLS_CONFIG environment variable has not been set on the client, or has been set to an
appropriate value.
• Check that the C:\Windows\System32\drivers\etc\hosts file on a Windows client, or /etc/
hosts file on a UNIX client, does not contain a configuration preventing server access.
• Check that the license server version is able to serve the client application version. A simple rule is that the
latest server version should be always installed, because it's compatible with all existing client application
versions. The latest license server version can be downloaded from here:
http://www.3ds.com/support/download-documentation/dassault-systemes-license-server

• Check that the proxy settings declared in the Windows Internet Options of the Windows client do not prevent
server access.
• Check that the client firewall, server firewall, network equipment and security software are properly configured.
The TCP (HTTPS) protocol must be allowed from client to server typically on port 4085, or another port
number if your server is configured to listen to a non-default port number.

Poor communication performance between a Windows client and any server

The DS License Server communication protocol is based on HTTPS. By default, the license client on Windows
uses the Microsoft implementation of this protocol, WinInet, which is part of the Microsoft Internet Explorer
browser.
By default, the Microsoft implementation of the HTTPS protocol needs to contact Microsoft servers to check
SSL certificate revocation. These servers are the same as the ones accessed by Windows Update.
When the Windows client computer cannot access the Microsoft servers, a typical 15s timeout occurs before the
communication between the license client and license server takes place.
In this type of case, the server log contains Duration of message exceeds threshold messages
with the IP address of the client.
There are several workarounds to this issue:

142 DS License Server 3DEXPERIENCE R2016x Installation and Configuration Guide

 Reference

• Either, allow the Windows client to access the Microsoft servers used by Windows Update
• Or, switch from the Microsoft implementation of HTTPS protocol to the OpenSSL implementation. This
can be done by setting the following environment variable in the Windows client environment:
DSY_DISABLE_WININET=TRUE. However a drawback exists when this variable is set: forward proxies
(declared in Windows Internet Options) are not taken into account.
• Or, turn off Automatic Root Certificates Update on the client. To do so:
1. Run the Local Group Policy Editor on client (if you don't know what Windows group policy
is, it's better not to follow this workaround).
2. Go to Computer Configuration - Administrative Templates - System - Internet Communication Management
- Internet Communication Settings.
3. Set Turn off Automatic Root Certificates Update to Enabled.
WARNING: SETTING THIS PARAMETER TO ENABLED IS A SECURITY RISK IF THE CLIENT
COMPUTER IS OR WILL BE CONNECTED TO THE INTERNET

Poor client performance at startup

• Reduce the number of lines declared in the DSLicSrv.txt file. All logical servers declared are contacted
at startup, not only the first one. This ensures that an already granted license is shared.

Nodelock or extracted offline license cannot be granted to the client application

• Check that the process does not run in remote mode, such as Remote Desktop on Windows or by exporting
DISPLAY on UNIX. When running in remote mode, nodelock and offline licenses are not taken into account.
• Check that the process does not run in a virtual machine. When running in a virtual machine, nodelock and
offline licenses are not taken into account.
• Check that your backup software is configured to not backup .LIC files located in C:\Program Files\
DassaultSystemes\Licenses, and that your security software is configured to not scan the same
files.

Reducing launch duration

If starting the DS License Server or the License Administration Tool takes a long time, check that the number
of files in your temporary directory is reasonable (less than 10,000).
Here are typical temporary directories to check:
• C:\Windows\Temp
• %USERPROFILE%\AppData\Local\Temp
• /tmp
• /var/tmp

Reducing timeout when a failover member is down

When one of the three members of a DS License Server failover is down, it may occur that logon takes longer
than usual. This may be due to an inappropriate configuration of TCP parameters on the UNIX computer hosting
the Live Collaboration Server:
• On Linux, check that the tcp_syn_retries parameter value is not too high.
• On AIX, check that the tcp_keepinit parameter value is not too high.

DS License Server 3DEXPERIENCE R2016x Installation and Configuration Guide 143

Reference

These parameters are managed at operating system level. This means that all running processes will benefit from
the changes and not only the Live Collaboration Server. Decreasing their value will not only reduce the logon
time when a DS License Server failover member is down, but also will potentially not leave enough time to
another server for responding. For example, a bad consequence could be that the Live Collaboration Server is
no longer able to contact a database server or that a third party application is no longer able to contact another
server.
Ask your system administrator and your network administrator before modifying such parameters.

Error, Information and Warning Messages

This section contains a list of informational, warning and error messages displayed in the license server logs and
classified into different categories.
Message types are identified by a one-letter prefix:
• E (error)
• I (information)
• W (warning)
and are organized into the following categories, each describing a specific area being monitored:
• INITSERVER: server initialization
• STARTSERVER: server startup
• STOPSERVER: server shutdown
• USGTRACING: license usage tracing
• REPOSITORY: license repository management
• RUNTIMEDATA: license server runtime management
• ADMINSERVER: server administration
• ENROLL: license enrollment
• LICENSEDATA: license data management
• MONITORING: server monitoring
• STATISTICS: server statistics
• LICENSESERV: license server
• FAILOVERSRV: failover server management.

Type Category Message

I INITSERVER Server version 6.218.0 built on yymmddhhmmss

I INITSERVER Initializing license server on pathName args [...]

I INITSERVER ComputerId XXX-XXXXXXXXXXXXXXXX

I INITSERVER Server successfully initialized.

I INITSERVER License server already initialized on pathName

I INITSERVER Use -force option for reinitialization.

E INITSERVER -adminPort option invalid : pppp

E INITSERVER -adminPort option missing
E INITSERVER Cannot create pathName

144 DS License Server 3DEXPERIENCE R2016x Installation and Configuration Guide

 Reference

Type Category Message

E INITSERVER Cannot create lock file fileName

E INITSERVER Cannot initialize repository

E INITSERVER Cannot initialize server on pathName

E INITSERVER Cannot obtain a valid computer ID

E INITSERVER Cannot retrieve computer name (...)

E INITSERVER Cannot retrieve data from hostName on port pppp(...)

E INITSERVER Cannot retrieve data from hostName. Authentication is required

E INITSERVER Cannot retrieve data from hostName. Remote administration is not allowed

E INITSERVER Cannot retrieve data from hostName. Unknown host

E INITSERVER Existing license data has been created by a license server with a higher level than the
one being installed. Either install a higher level license server or install license server
from scratch.

E INITSERVER Network adapter or motherboard previously used for generating Computer ID is no

longer available. Either re-install this piece of hardware or install license server from
scratch for changing Computer ID.

E INITSERVER Check integrity of license data has failed. License server must be re-installed from scratch.

E INITSERVER Data received from hostName cannot be used by this computer

E INITSERVER File version ver cannot be read by current software version ver

E INITSERVER Invalid computerId; XXX-XXXXXXXXXXXXXXXX cannot be used

E INITSERVER Invalid folder pathName

E INITSERVER Invalid port specified pppp for option -adminPort

E INITSERVER Unknown option(s) : -option

E INITSERVER Write time : yymmddhhmmss, Change time : yymmddhhmmss

I STARTSERVER Server version 6.209.0 built on Jan 17, 2010 5:28:47 PM started

I STARTSERVER java version "1.6.0_18"

I STARTSERVER Java(TM) SE Runtime Environment (build 1.6.0_18-b07)

I STARTSERVER Java HotSpot(TM) Client VM (build 16.0-b13, mixed mode)

I STARTSERVER ComputerId XXX-XXXXXXXXXXXXXXXX ( based on device ... )

I STARTSERVER Ready : administration port pppp, licensing port pppp

I STOPSERVER Stopping license server...

I STOPSERVER License server stopped

E REPOSITORY IOException writing file fileName

E REPOSITORY Invalid repository directory pathName

E REPOSITORY cannot delete file ( fileName )

DS License Server 3DEXPERIENCE R2016x Installation and Configuration Guide 145

Reference

Type Category Message

E REPOSITORY cannot rename file ( fileName -> fileName )
I REPOSITORY fileName written to disk

E RUNTIMEDATA Check integrity of license data has failed. License server must be re-installed from scratch.

E RUNTIMEDATA Clock has been changed

E RUNTIMEDATA Clock has been moved to the future (nnn ms)

E RUNTIMEDATA Clock has been moved to the past (nnn ms)
E RUNTIMEDATA Computer ID XXX-XXXXXXXXXXXXXXXX no more available.

E RUNTIMEDATA ComputerId XXX-XXXXXXXXXXXXXXXX is not compatible with the cluster

configuration

E RUNTIMEDATA ComputerId XXX-XXXXXXXXXXXXXXXX is not compatible with the server

configuration

E RUNTIMEDATA Existing license data has been created by a license server with a higher level than the
current one. Either install a higher level license server or install license server from
scratch.

E RUNTIMEDATA File version ver cannot be read by current software version ver

E RUNTIMEDATA License data cannot be read: invalid format. License server must be re-installed from
scratch.

E RUNTIMEDATA Network adapter or motherboard previously used for generating Computer ID is no

longer available. Either re-install this piece of hardware or install license server from
scratch for changing Computer ID.

E RUNTIMEDATA Serialization error on runtime data

E RUNTIMEDATA Write time : yymmddhhmmss, Change time : yymmddhhmmss

E RUNTIMEDATA writeRuntime error :...

E RUNTIMEDATA XXX-XXXXXXXXXXXXXXXX cannot be used
W RUNTIMEDATA Error : AAA has no runtime

W RUNTIMEDATA Error : feature "AAA" refers to "SSSSSSS" which is not owned by a client

W RUNTIMEDATA Error : inconsistent feature AAA expected count = nnn registered nnn

W RUNTIMEDATA Error : inconsistent feature AAA no license

I RUNTIMEDATA System has been suspended

I RUNTIMEDATA System has been resumed

W ADMINSERVER Administration request denied from hostName(IP address) : invalid

credentials

W ADMINSERVER Connection from hostName(IP address) terminated : a local administration

console is connecting

W ADMINSERVER Remote administration not allowed : refuse connection from hostName(IP

address)
I ADMINSERVER Administration connection ended with hostName(IP address)
I ADMINSERVER Administration connection started with hostName(IP address)

146 DS License Server 3DEXPERIENCE R2016x Installation and Configuration Guide

 Reference

Type Category Message

I ADMINSERVER Administration port changed to pppp

I ADMINSERVER Failover port changed to pppp

I ADMINSERVER Licensing port changed to pppp

I ADMINSERVER adminCommand command issued

I ADMINSERVER License usage trace turned on for AAA

I ADMINSERVER License usage trace turned off for AAA

W ENROLL Enrollment authorization license has expired for editor Dassault Systemes

W ENROLL License XXXXX-XXXXX-XXXXX-XXXXX-XXXXX is not valid

I ENROLL Enrollment authorized for editor Dassault Systemes

E LICENSEDATA Cryptographic error : ...

E LICENSEDATA Error in signature key extraction ...

W LICENSEDATA RepGroupIndexnof license id XXXXX-XXXXX-XXXXX-XXXXX-XXXXX

has been invalidated

W LICENSEDATA incomplete data for license id XXXXX-XXXXX-XXXXX-XXXXX-XXXXX,

RepGroupIndex n missing RepFileIndex n

I LICENSEDATA Activating group n for license id XXXXX-XXXXX-XXXXX-XXXXX-XXXXX

I LICENSEDATA Adding data for license id XXXXX-XXXXX-XXXXX-XXXXX-XXXXX

RepGroupIndex n RepFileIndex n Features AAA Quantity nnn

I LICENSEDATA Deactivating group n for license id XXXXX-XXXXX-XXXXX-XXXXX-XXXXX

I LICENSEDATA Deleting data for license id XXXXX-XXXXX-XXXXX-XXXXX-XXXXX

RepGroupIndex n

W MONITORING dumpAllThreads not available on this platform

W MONITORING dumpHeap not available on this platform

E STATISTICS Exception occurred; license usage no more logged

E STATISTICS Exception occurred; license usage not logged

E STATISTICS pathName specified is invalid; license usage not logged

E LICENSESERV Cannot listen on port pppp

W LICENSESERV Waiting for failover server(s)

W LICENSESERV Invalid or expired client token nnnnnnnnnnnnnnnn (from client ...)

W LICENSESERV No license for editor XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX

(from client ...)

W LICENSESERV AAA not granted, host hostName not authorized (from client ...)

DS License Server 3DEXPERIENCE R2016x Installation and Configuration Guide 147

Reference

Type Category Message

W LICENSESERV AAA not granted, host not authorized (from client ...)
W LICENSESERV AAA not granted, internal failover error (from client ...)
W LICENSESERV AAA not granted, license already used by user userName on host userName
(from client ...)

W LICENSESERV AAA not granted, license used on another host (from client ...)
W LICENSESERV AAA not granted, no ConcurrentUser license available (from client ...)
W LICENSESERV AAA not granted, no NamedUser license available (from client ...)
W LICENSESERV AAA not granted, no NamedUser nor ConcurrentUser license available (from client ...)

W LICENSESERV AAA not granted, no license enrolled (from client ...)

W LICENSESERV AAA not granted, no license enrolled for tenant tenantId (from client ...)
W LICENSESERV AAA not granted, no license for editor
XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX (from client ...)
W LICENSESERV AAA not granted, no license of type TYPE can be granted (from client ...)
W LICENSESERV AAA not granted, no more available license (from client ...)
W LICENSESERV AAA not granted, no suitable release date yymmddhhmmss (from client ...)
W LICENSESERV AAA not granted, no suitable release number n (from client ...)
W LICENSESERV AAA
not granted, user userName not authorized (from client ...)

W LICENSESERV AAA queued request suppressed , no more available license (from client ...)
I LICENSESERV Editor editorName not registered

I LICENSESERV Invalid or expired session nnnnnnnnnnnnnnnn

I LICENSESERV Licensing service started

I LICENSESERV AAA granted to client ...

I LICENSESERV AAA detached from client ...

I LICENSESERV AAA detached by timeout from client ...

I LICENSESERV n tokens of AAA granted to client ...

I LICENSESERV n tokens of AAA detached from client ...

I LICENSESERV n tokens of AAA detached by timeout from client ...

I LICENSESERV AAA granted; offline license XXXXX-XXXXX-XXXXX-XXXXX-XXXXX has been

generated for host hostName XXX-XXXXXXXXXXXXXXXX

I LICENSESERV AAA detached; offline license XXXXX-XXXXX-XXXXX-XXXXX-XXXXX restituted

(generated for host hostName XXX-XXXXXXXXXXXXXXXX)

I LICENSESERV AAA detached; offline license XXXXX-XXXXX-XXXXX-XXXXX-XXXXX expired

(generated for host hostName XXX-XXXXXXXXXXXXXXXX)

E FAILOVERSRV Cannot listen on port pppp

E FAILOVERSRV Cannot retrieve member of cluster

W FAILOVERSRV Cluster host hostName : computer id changed to XXX-XXXXXXXXXXXXXXXX

148 DS License Server 3DEXPERIENCE R2016x Installation and Configuration Guide

 Reference

Type Category Message

W FAILOVERSRV Cluster host hostName changed to hostName

W FAILOVERSRV Cluster host hostName repaired

W FAILOVERSRV Cluster host hostName replaced with hostName

(XXX-XXXXXXXXXXXXXXXX)

W FAILOVERSRV Connection lost with hostName

W FAILOVERSRV Unsuccessful handshake with hostName

W FAILOVERSRV hostName does not run a compatible runtime version ( version : nnn, release : n,
servicePack : n

W FAILOVERSRV hostName's computerId XXX-XXXXXXXXXXXXXXXX does not match

expected XXX-XXXXXXXXXXXXXXXX

W FAILOVERSRV hostName is not synchronized

I FAILOVERSRV Connection established with hostName

DS License Server 3DEXPERIENCE R2016x Installation and Configuration Guide 149

Simpack Documentation

Guide C
OLicense
Documentation

Simpack Release 2018

Copyright © 2017 Dassault Systemes Simulia Corp. All rights reserved.
 Page 1 of 59

OLicense-Server 4.8
(V4.8.0)

Manual
 Page 2 of 59

Optimum GmbH
Hirschstr. 12-14
D-76133 Karlsruhe

E-Mail: [email protected]
Internet: http://www.optimum-gmbh.de

© Copyright by Optimum GmbH, also in case of industrial property rights registration.

All possessive rights including copyright and passing on at Optimum GmbH.
 Page 3 of 59

1 Table of contents
1 Table of contents ................................................................................................. 3
2 List of figures ....................................................................................................... 5
3 Welcome ............................................................................................................. 6
4 General information ............................................................................................. 7
4.1 About this manual......................................................................................... 7
4.1.1 Conventions .......................................................................................... 7
4.1.2 Abbreviations and definitions ................................................................ 8
4.1.3 Pictograms ............................................................................................ 8
4.2 User roles referenced in this manual ............................................................ 9
5 Interaction of Olicense-Suite roles ..................................................................... 10
6 Language support.............................................................................................. 11
6.1 Language selection .................................................................................... 11
7 Installing the OLicense-Server .......................................................................... 12
7.1 System requirements ................................................................................. 12
7.2 Starting the installation process.................................................................. 12
8 Uninstalling the Olicense-Server ....................................................................... 13
8.1 Starting the uninstallation process.............................................................. 13
9 Overview ........................................................................................................... 13
10 Starting and Stopping Olicense-Server .......................................................... 14
10.1 General information .................................................................................... 14
10.2 Default startup ............................................................................................ 15
10.3 Starting with an arbitrary TCP/IP port number ............................................ 16
10.4 Starting with arbitrary database path settings ............................................ 17
10.5 All start options and INI file ......................................................................... 17
10.6 All Controller-Startparameter ...................................................................... 21
11 Administrating OLicense-Server .................................................................... 23
11.1 Use case “License Request” ...................................................................... 24
11.2 Use case “License Import” ......................................................................... 24
11.3 Use case "License Report” ......................................................................... 25
11.4 Use case “Server Administration“ ............................................................... 27
11.5 Use case “License Check In/Out“ ............................................................... 30
11.5.1 Checking out licenses ......................................................................... 30
11.5.2 Checking in licenses ........................................................................... 31
11.6 Use case „License Administration“ ............................................................. 31
11.6.1 Unload licenses ................................................................................... 32
 Page 4 of 59

11.6.2 Changing the OLicense-Server’s hardware......................................... 33

11.6.3 Enable/disable licenses ....................................................................... 34
11.6.4 Activate/deactivate licensee feedback (supply additional information) 34
11.6.5 Check out settings ............................................................................... 34
11.6.6 Group-Pool .......................................................................................... 34
11.7 Sub use case „Change check out privileges“ ............................................. 34
11.8 Sub use case „Admin Group Floating Licenses“ ........................................ 36
11.9 Use case „Floating License Reservation“ ................................................... 39
11.9.1 Examples for reservation..................................................................... 39
11.10 Use case "Group Floating Blacklist" ....................................................... 40
12 High availability server system ....................................................................... 41
12.1 Server system configurations ..................................................................... 42
12.1.1 Optimal ................................................................................................ 42
12.1.2 Minimal ................................................................................................ 42
12.1.3 Critical ................................................................................................. 42
12.1.4 Mixed Mode......................................................................................... 43
12.2 Starting/Stopping of servers in a server system ......................................... 43
12.3 Starting/Stopping of proxies in a server system ......................................... 43
12.4 Second High-Availability Variant ................................................................ 45
13 Backup and Restore ...................................................................................... 47
13.1 Administration of database files.................................................................. 47
13.2 Backup database files ................................................................................ 47
13.3 Restoring database files ............................................................................. 47
13.4 Reinstallation of OLicense-Server .............................................................. 48
13.5 Backup in batch mode ................................................................................ 49
14 (U3)-USB-Memory-Stick ................................................................................ 50
14.1 Specifics for Linux ...................................................................................... 50
15 Serverstatistics............................................................................................... 52
16 olixtool – the command line tool ..................................................................... 52
17 Appendix: Messages...................................................................................... 55
17.1 Transaction errors ...................................................................................... 55
17.1.1 Communication failure ........................................................................ 55
17.1.2 Protocol error ...................................................................................... 56
17.1.3 OLicense-Server errors ....................................................................... 57
17.2 Transaction ok ............................................................................................ 58
17.3 Error (exception) caused by erroneous programming with OLicense API .. 58
18 Further information......................................................................................... 59
 Page 5 of 59

2 List of figures
Figure 1: OLicense-Server Controller .................................................................... 15
Figure 2: Olicense-Server Controller; Local start ................................................... 16
Figure 3: OLicense-Server administration screen .................................................. 23
Figure 4: Committing successful license uploading ............................................... 25
Figure 5: Error message caused by an erroneous license uploading .................... 25
Figure 6: License report example .......................................................................... 26
Figure 7: OLicense-Server configuration window .................................................. 28
Figure 8: License administration ............................................................................ 32
Figure 9: OLicense-Server’s response after license removal (except for floating and
pay-per-use licenses) ........................................................................................ 33
Figure 10: Removal code for floating and pay-per-use licenses........................... 33
Figure 11: Admin Group Floating License ........................................................ 37
Figure 12: Floating license reservation................................................................. 39
 Page 6 of 59

3 Welcome
With this software package you should have purchased OLicense-Server
which is a tool for license management.
There is no need to add a second instance of OLicense-Server to an
existing framework if there is already an OLicense-Server running.
OLicense-Server is one component of OLicense-Suite, a modern tool for
software license management and user rights deployment in a network
environment.
Further information and the latest server release for download is provided
at http://olicense.com.
We use the term „server“ analogous to other popular web-servers like
Apache-HTTP-server because OLicense-Server is a stand-alone web-
server. On a windows environment the server is just another kind of
service, in a UNIX-like environment it’s a daemon. The server can be
installed either locally on a notebook or on a server-host in the internet
(notice the ambiguity of the term “server”).
The OLicense-Server can be installed and administrated easily. In the best
case scenario the software-manufacturer has used all features of the
OLicense-Suite to minimize your administration costs.
 Page 7 of 59

4 General information

4.1 About this manual

4.1.1 Conventions
In this manual the following typographic conventions are used:

Object Appearance
Names for menus, tabs, Font: Times New Roman
buttons, dialogs, fields, paths, (C:\Programs\Optimum\Olicense)
files and so on
Commands, code samples Font : Courier
(cd c :\\programme\…)
Compulsory values to be <in angle brackets>
defined by the user
Optional fixed values [in squared brackets]
Optional values to be defined [<in angle and squared brackets>]
by the user
Input for command shells is described for Windows operating systems. In
Linux the string ./ has to be prepended and the extension for executables
has to be converted from .exe to .lin.
Example:
on Windows:
OLicenseServerCtrl.exe
on Linux:
./OLicenseServerCtrl.lin
 Page 8 of 59

4.1.2 Abbreviations and definitions

MajVersMin Minimum major version of a software product.

MajVersMax Maximum major version of a software product.

POP Post office protocol; a protocol used to receive e-mails

from a mail server.

SMTP Simple mail transfer protocol; a protocol used to send

e-mails to a mail server.

Server Service or daemon. A software program, that runs in the

background and is started automatically during the
system boot process.

Server host The network computer on which the server programs are
running.

SW Software

XML Extended Markup Language; a data format to represent

structured data as a string.

4.1.3 Pictograms
Hint

Attention, important notice

 Page 9 of 59

4.2 User roles referenced in this manual

Name(s) Description
Software- Person or organization, who manufactures software
manufacturer products.
Distributor, Software- Person or organization, who ships the software
vendor product to it’s customer. This may be the software
manufacturer himself or a distribution organization.

Licenser Person or organization, who generates and ships

licenses for licensed software products. This may
be a person or group within the software
manufacturer or the distributor.
Licensee Person or organization utilizing the licensed
software product i.e. generally you
 Page 10 of 59

5 Interaction of Olicense-Suite roles

This scenario matches, if your software-manufacturer has utilized only the
minimal possible functionality of Olicense-Suite. Your manufacturer could
be able to extend the system to a fully automatic machine which implies
that you only have to insert your customer data in a dialog box of the
software.

Licenser Licensee

Customer orders software product

Ships the software product and the

Olicense-Server to the customer.

Installs the software product and the

OLicense-Server and returns the
licensee and server information
required for license generation to the
licenser.

Creates a license key and ships it

to the licensee.

Uploads the license file into his

Olicense-Server and utilizes the
software product. The OLicense-
Server checks the availability of a
license according to the information
in the uploaded license file.
 Page 11 of 59

6 Language support
Graphical Manual
User
Interface
Olicense-Server German
and Controller German
English
English
Japanese

6.1 Language selection

OLicense-Server and its graphical Controller frontend are multilingual. The
used language is specified by the operating system of the computer, i.e.
on a German operating system installation, the programs will use German
language, on an English operating system installation, it will use English
language. The default language, i.e. if all dictionaries are missing, is
English.
You can force the Server and Controller to start on a different language if
you call the tool with the following commandline-parameter (for the Server
you can also append the INI-file with): –lang <language id>. Currently
the language Ids de for German, en for English and ja for Japanese are
supported. See 10.5 All start options and INI file.
Other languages can be supported. Please contact us, if you need help for
other languages or if you want to create a dictionary for other languages
yourself.
 Page 12 of 59

7 Installing the OLicense-Server

7.1 System requirements
For a proper operation of Olicense-Suite components, the following
system resources are recommended:

Olicense-Server

Processor Pentium min. 600 MHz

Operating system (see the actual list on olicense.com)

tested with:
Hard disk: Approx. 15MB
RAM: Approx. 6 MB (real free)
Screen resolution: Arbitrary
Network protocol TCP/IP
Internet Browser
Mozilla Firefox >14
tested with:

7.2 Starting the installation process

Required privileges:
local administrator privileges on Windows, root privileges on UNIX if you
want to install the server as service/daemon.
Call the installer application. On Windows:
OLicenseServer-4.8...-Setup.exe. On Linux:
OLicenseServer-4.8...-Setup.lin.
Follow the instructions.
OLicense-Server has to be installed on a local drive of a network ready
computer.
 Page 13 of 59

8 Uninstalling the Olicense-Server

8.1 Starting the uninstallation process
Uninstallation of the software can be accomplished by:
 Start -> Settings -> System -> Software (Windows)
respective
SuSE/Gnome-Menu -> OLicense-Server -> Uninstall (Linux).

9 Overview
OLicense-Server is a special type of web server. It provides a web service
that supervises the utilization of licensed software in an intra/internet
environment. It uses state of the art encryption techniques to stem misuse.
Installation and administration can be accomplished easily without
requiring extensive system resources. It uses a widespread network
protocol (TCP/IP) in combination with XML/SOAP as transmission protocol
for selective conveyance bypassing firewalls.
In a Windows-XP and higher environment the firewall is blocked by
default. To enable external requests to the server, you have to open the
firewall for the server.
 Page 14 of 59

10 Starting and Stopping Olicense-Server

10.1 General information
If there is already one OLicense-Server running in your network, you don’t
have to install a second one. One instance is sufficient.
To install OLicense-Server as service/daemon you need Administrator-
privileges !
OLicense-Server and the corresponding database files have to be
installed on a local disc.
OLicense-Server is, if installed as service/daemon, started automatically
by the operating system during the system boot process.
You can administrate OLicense-Server with the OLicense-Server-Control
frontend either by invoking the corresponding entry in your start menu or
by clicking the desktop icon if installed:
( Start -> Programs or SuSE.Menu)-> Olicense-Server -> Olicense-Server-
Control)
Once installed as service/daemon, the server can be controlled also using
the Windows service dialog. This dialog can be opened using
 Start -> Settings -> System -> Administration -> Services
 On Linux you can control OLicense-Server with /etc/init.d in a similar
fashion as the other servers in your system. Further information is
provided by the operating system manual.
If your OLicense-Server supervises licenses distributed on different clients
in a network environment, it is recommended that your host computer runs
permanently. Special attention has to be paid to following items:
 Ensure that OLicense-Server is already started when licensed
software is called.
 Your host computer doesn’t require extensive system resources to
run OLicense-Server but high stability and availability is strongly
recommended. If using critical applications you can establish an
emergency server system consisting of several redundant OLicense-
Servers. Further information can be found on chapter 12:
 Page 15 of 59

Highest availability servers on page 41.

Alternatively you can install a local copy of OLicense-Server and your

licensed software to use it for instance on a mobile computer.

If possible, do not run OLicense-Server on a host computer that operates

another web-server which usually uses HTTP port 80 by default. If this
cannot be avoided you can start OLicense-Server on another port, e.g.:
8080. To start OLicense-Server on a different port number see chapter
10.3 Starting with an arbitrary TCP/IP port.

10.2 Default startup

After installation you can start OLicense-Server-Control frontend. If you
wish to install the Server as service/daemon you must call the Controller
with Administrator/root rights. On Linux an additional button is visible to
obtain root rights if necessary tools like kdesu are installed.

Figure 1: OLicense-Server Controller

 Page 16 of 59

In the Start/Stop tab you can de/install the server as service/daemon,

you can start/stop an installed service, or you can start/stop the server
serviceless.
If you click the button: Open Browser Frontend, the Controller tries to start
your local installed Internet-Browser and opens the homepage of
OLicense-Server.
If you installed the server as service you may close the Controller, it is
not needed for the operation. If the server is started serviceless, the
Controller must be active but you may ‘park’ it in the system tray of your
operating system by clicking: Close To Tray.
You may operate more than one server on one machine, but only one
can run as service and only one can serve Floating licenses. If you try
to start a second server you will get an error message that you can start
only if you deactivate Floating licenses.

Figure 2: Olicense-Server Controller; Local start

In this case uncheck the checkbox: Enable Floating, …, and start again.

10.3 Starting with an arbitrary TCP/IP port number

In the Controller tab: Server-INI-File, you may define miscellaneous start
parameters.
During server start the Controller will inform you if the current port is in
use. In this case you must change the parameter: -port in the INI-file.
Set another port number and click: Save. Switch back to the Start/Stop tab
and try to start the server again.
It can be possible that a port is reported as ‘in use’ but no application is
using it. This can happen if e.g. a program crashed and the operating
system needs some time to deblock. In this case the start dialog permits
you to start the server on that port by force.
 Page 17 of 59

10.4 Starting with arbitrary database path settings

To save the database files of OLicense-Server (OLicenseServerDB.odb and
OLicenseServerDB.odx) in a local directory different from the installation
directory, add parameter –dbFile <path> to your command line.
Proceed as described in chapter 10.3 (Starting with an arbitrary TCP/IP
port, page 16) to access the command line and append the desired
database path to your program call.
You may only use forward ( / ) slashes in your database path. Filename
extensions have to be omitted as well.

10.5 All start options and INI file

All start options are listed below:

Name Meaning
-timeout <sec> Maximum period of time the server is allowed to
wait for client data.
-port <number> Port where the server is listening, see Chapter
10.3
-dbFile <filename> Database file for the server, see Chapter 10.4
-logFile <filename> A file to store special debug information. This file
can give details if a (composit)server does not
start orderly. Please attach this file if you send a
support request to Optimum.
-proxyOnly If you are going to use OLicense-Server in an
emergency server system and direct client
requests have to be suppressed by your server.
See also –fallback…
-servers <s1>[,<s2>,<sn>] If the server is intended to be used as a proxy-
server in an emergency server system. See also
–fallback…
-denyReportCols Suppresses the display of the specified columns
 Page 18 of 59

Name Meaning
<n1>[,<n2>,<nn>] in your license report.
-lang <country code> Starts the server in the given language. Default
is: en. For other codes the corresponding
dictionaries must be present:
olicenseserver_<code>.qm, e.g.:
olicenseserver_de.qm for German.

-allowOccupancyInfoGlobal By default the server information: „Who has

currently locked which Floating-License“, is
blocked for privacy protection. This information
can be released separately for every license via
the License Administration page. Is a global
release for all licenses desired then use this
parameter.
-respondHttpErrors HTTP errors will be send without the triggered
question in the error message per default.
Setting this parameter will embed the question.
-deviceWait <sec> If a given database file is located on a (e.g. U3)
device which is not available during server
startup, the server will test every 3 seconds up to
the given seconds if the device is now available.
(On Windows the server will wait 21 seconds per
default even if this parameter is not given)
-noAutoBoot Prohibits under Linux that autoboot-scripts are
automatically created in /etc/init.d during server-
startup. This is of interest if own boot-scripts
must be used.
 Page 19 of 59

-initialPw <MD5 user:pw> Some server web pages can be protected by a

password to avoid unmeant access in the
licensee’s network. On delivery there is no
password set. Via this parameter an initial
password can be set, that will be active as long
as no password is set via the server’s admin
page. The parameter’s value is the HEX string of
the MD5 Hashsum of the string:
<user>:<password>, e.g.: Hugo:MyPW (see
also –makeInitialPw)
-makeInitialPw Creates the MD5 Hash needed by –initialPw
<user>:<passwort> Output takes place on STDOUT
-allowedFrontEndPeers Defines from which network addresses it is
<TCP-Addr>[;<TCP- allowed to acces the server’s web pages. The
Addr2>;…] addresses must be separated by ‘;’. Wildcards
(*) are allowed, e.g. –allowedFontEndPeers
127.0.0.1;192.168.*.*

-runAs <login (Linux only!) If the server starts with root rights, it
name|uid:gid> will switch automatically to the given user
account.
-u3ScanOnly <dev Usually the server scans cyclic all connected
1>[;<dev2>;…] USB/U3-disks. If a list of U3-IDs is given with this
parameter, the server scans in the following only
those drives on which an ID is found. This is
helpful if single USB disks would lose
performance through a scan access.
-fallbackMyself <tcp- All three parameters must be given to create an
addr>[:<port>] emergency server system in a second variant.
-fallbackServer1 <tcp- addr See chapter 12.4. The tcp-addr must be in
>[:<port>] numerical form.

-fallbackServer2 <tcp- addr

>[:<port>]
 Page 20 of 59

-initialLogPath <path> As long as no path is written for the protocol file

to the database, the server writes the protocol
file in its installation directory. This parameter
changes this behaviour and forces the protocol
file to the given path.
-overrideLogPath <path> This parameter forces the protocol file to the
given path. The path from the database is
ignored.
You can get additional information by inspecting the sample INI-file
included in your installation.
 Page 21 of 59

10.6 All Controller-Startparameter

The graphical controller dialog can also be started with parameters.
All start options are listed below:
Name Beschreibung
-start [-enableFloating After the controller dialog is started, he tries
true|false] to start the configured server automatically.
On success the controller will be minimized to
system tray. On failure the dialog will be left
open and will show an error message.
If a controller dialog is already open during
execution of this command, the command will
be forwarded to this controller.
The additional parameter –enableFloating
defines whether the server shall be started
with or without Floating licenses enabled.
This has an effect only if a second server is
already running on the same operating
system, see Figure 2: Olicense-Server
Controller; Local start.
-stop Stops the server which was started via the
controller. An open controller must exist
during execution of this command.
-import <filename> Passes filename to the controller. The file can
then be imported in the server with a click.
-raise|<leer> Starts the controller or moves an existing
controller to the foreground, if the operating
system allows it.
 Page 22 of 59

-lang <language id> Forces the Controller to start with the given
language. Precondition: A dictionary of the
language must be present.
Possible languages:
en: English
de : German
ja : Japanese
 Page 23 of 59

11 Administrating OLicense-Server
The fastest way to the administration window of OLicense-Server is to
click the button: Open Browser Frontend, on the Controller.
Only if you do not have a registered standard browser in your operating
system, you need to start your browser by hand. Set the following URL:
http://localhost
If a different port number is preferred or if you want to open the window
from an arbitrary computer that is not the host computer - call your
browser and set the URL:
http://<name>[:<Port>]

where <name> is the name or the TCP/IP address of your host computer
and <port> is the port number being used by OLicense-Server. If port
80 is used the -port option may be omitted.
E.g.: http://www.foo.bar:8080
This is the administration window of OLicense-Server:

Figure 3: OLicense-Server administration screen

If you cannot establish a connection with your OLicense-Server, this may
be caused by the proxy or firewall settings of your browser. For more
 Page 24 of 59

information see chapter Fehler! Verweisquelle konnte nicht gefunden

werden. Fehler! Verweisquelle konnte nicht gefunden werden. on
page Fehler! Textmarke nicht definiert..
The following chapters deal with use cases for OLicense-Server-
administration.
The use cases License Check In/Out, Server Administration, License
Administration, Floating License Reservation and Group Floating Blacklist are
password protected.
The corresponding fields have to be left empty unless you specify
administrator’s name and password in the authorization dialog.
Each use case offers a chance to return to the main window of OLicense-
Server administration by clicking the link Back to Homepage or the Back
button of your browser.

11.1 Use case “License Request”

This use case is automatically applied when a licensed software requests
or releases a license. There is no possibility or need for manual
interaction.

11.2 Use case “License Import”

Since version 3.2.8 the server registers olixml file extensions on a window
platform as import-files, meaning that you can import license-files into
OLicense-Server just by double clicking them in the windows-explorer. The
same applies for license-import from an e-mail application.
Another possibility is, that the manufacturer has implemented a separate
import-dialog box in his software-product. In this case, manual importation
is not required.
For all other cases importation has to be done in the mainwindow of the
server.
At first save the license file, that you have received from the licenser, on
your computer. Then press the button File open in the OLicense-Server
administration window and select the license file in the appearing file
select dialog.
 Page 25 of 59

Ensure to set File type to All files (*.*) otherwise you will not see the XML
license files.
Confirm your selection by pressing the Ok button. The path of the selected
file is transferred to the corresponding field in the administration window.
To upload the licenses to the OLicense-Server press button Send.
If a license is changed or extended, the old license entry will be replaced
during the upload process.
Expired licenses are automatically removed from OLicense-Server’s
database.
Successful uploading of a license file will be committed by the OLicense-
Server:

Figure 4: Committing successful license uploading

If one or more licenses in the license-file could not be uploaded the
following error message occurs:

Figure 5: Error message caused by an erroneous license

uploading

11.3 Use case "License Report”

Clicking the button View Licenses leads to a listing of all licenses stored in
the OLicense-Server’s database:
 Page 26 of 59

Figure 6: License report example

Description of the license report columns:

Attention! Be aware that you can hide columns by setting the corresponding start
option.

Column Description

Application Name of the licensed software

Version Version range of the licensed software for which the license is
valid. If this information is missing, the license is valid for all
versions.

Module Names of the licensed features/modules of the licensed software.

If the license is valid for all modules this field is empty.

Options Names of the licensed options of the licensed software. Unlike

Modules options do not require extra licenses

License License type, e.g. Floating.

Type

Floating Number of concurrent users available for a floating license. The

(in use) value in brackets shows the number of currently allocated
licenses. If two values are shown the first entry represents the
number of checked out licenses. For other license models this
field is empty.

Users Licensed users of named-user licenses. For other license types

this field is empty.
 Page 27 of 59

Column Description

Hosts Computer ID’s for node-locked and pay-per-use licenses. For

other license models this field is empty.

Expiration The last day the license is valid. Values of oo or 7999-12-31

date represent an unlimited validity.

License Identifier of the license data record.

Licenser Licenser’s name.

Licensee Licensee’s name.

Key Identifier of the licensed software.

Upload Date at which the license was uploaded.

date

Group size/ For Group Floating licenses. Shows the pool size and the lifetime
Lifetime of the pool entries.

11.4 Use case “Server Administration“

Pressing button Administrate Server opens a dialog where you can modify
your OLicense-Server configuration:
 Page 28 of 59

Figure 7: OLicense-Server configuration window

To change the OLicense-Server settings, check the checkbox in the first
column of the corresponding row; enter your changes and press the
change the checked attributes now button.
Your changes won’t be applied, if the checkbox in the first column of the
corresponding row isn’t checked.
Description of rows:
Column Description
User & Name and password of the server administrator account.
Password: Retype your password into input box Confirm to avoid
mistakes. All characters in input box Password and Confirm
are shown as asterisks (*).
It’s recommended to choose a password which is different
from your other passwords because communication
between browser and OLicense-Server is not encrypted.
The account can be deleted if the checkbox 'delete
account is checked. After deletion the forms can be
accessed without password.
Log file: Enable or disable logging. Select Yes and enter a valid
path for the log file directory to enable logging. The log file
will contain information about license utilization and
possible error messages. OLicense-Server will create a
separate log file for each month.
Default setting is to write log files in the installation
directory of OLicense-Server.
 Page 29 of 59

Column Description
Alert E-Mail: Enter your SMTP-Server’s name or address and the mail
address of a person who should receive an e-mail before
licenses will elapse.
If you do not know your SMTP server’s name or address,
please check your browser settings. For more information
see chapter Fehler! Verweisquelle konnte nicht
gefunden werden. Fehler! Verweisquelle konnte nicht
gefunden werden.e on page Fehler! Textmarke nicht
definiert..
Pay-Per-Use This information is only relevant, if pay-per-use licenses
File path: are in use. Enter the name of the directory where you want
OLicense-Server to save the pay-per-use log files.
OLicense-Server will create a separate log file for each
month.
Default setting is the installation directory of OLicense-
Server.
Check The preferred server (URL) from whom this server is
In/Out intended to check in/out licenses. You should always type
Server the full name of the URL including the port name. For
instance http://www.xxx.de:80

Preferred The preferred server ID for Floating and PayPerUse

Server ID licenses. It is based on some hardware and software
informations from your system. If it is not visible the
hardware manufacturer has lodged too less information, in
this case you have to use one of the alternative IDs.
Alternative A compound ID of NICs
Server-ID 1
Alternative MAC of active NIC. (Inadvisable if your host computer uses
Server-ID 2 variable MAC-addresses)
U3-ID The IDs of common (U3-)USB-Memory-Sticks/Drives. As
long as the stick(s) is/are plugged into the USB-slot(s) the
licenses for that ID remain valid.
 Page 30 of 59

The line ‘Preferred Server ID’ has a button: Export-Server-Info. If you click it a
file will be created which contains all ID information. Mail this file to your
licenser when applying for a license.

11.5 Use case “License Check In/Out“

This use case is applied when single floating licenses are to be checked-in
or -out from a main-server to a local host (notebook). “Daily licenses for
notebooks” is a synonym for this use case. To perform this task the
licenses have to be granted by the licenser for this use case. Input box
“URL of the remote server” has to contain the URL of the preferred main
server. You can predefine a value for this field by using the server
administration dialog.

11.5.1 Checking out licenses

Pressing button Check Out Licenses opens the form shown below:

Listed are all licenses, that may be checked out from the specified main
server to be used by this server(notebook).
To check out licenses, you have to check the appropriate checkbox of
column check out. If needed, modify the check-out parameters then press
button check out checked licenses now. Afterwards you will receive a receipt
informing you if the check-out process was successful.
The check-out parameters are limited by the licenser and possibly by the
main server administrator to the values shown in brackets. You can
strengthen the limitations but not extend them.
Example: If the run time is limited to 30 days you may change them to 5
days but not to 31.
 Page 31 of 59

A value of 0 means infinity. According to the previous example: If the value

in brackets is 0 you may set the run time to 30 days. If the value is 30 you
may not set the run time to 0.
After completion of the previous check-out steps, the desired quantity of
floating licenses will be removed from the main server and placed to credit
to the (notebook) server’s account.
The reverse process (check-in) is either done manually or automatically
according to the runtime set by the values in brackets.

11.5.2 Checking in licenses

Pressing button Check In Licenses opens the following form:

Listed are all licenses, that may be checked in from this (notebook) server
to the specified main server.
Check the appropriate checkbox of column check in for each license that
has to be checked in and press button check in checked licenses now.
Afterwards you will receive a receipt informing you if the check-in process
succeeded.
You can’t check in licenses that are used by other applications at the same
time.

11.6 Use case „License Administration“

Pressing button Administrate Licenses opens a form to:
1. discharge (remove) licenses,
2. change the computer, on which OLicense-Servers is running,
3. disable licenses
 Page 32 of 59

4. verify/change check out’s,

5. release user information for floating licenses.

6. view/change Group Floating license entries.

Figure 8: License administration

To change the license settings, check the checkbox in the first column of
the corresponding row, enter your changes and press the Apply Changes
button.
Your changes won’t be applied, if the checkbox in the first column of the
corresponding row isn’t checked.

11.6.1 Unload licenses

Depending on the license model being used, a license that had been
removed once from OLicense-Server’s database cannot be reloaded
again. Do only execute this operation if you really intend to remove
licenses.
To remove a license from the OLicense-Server’s database, check the
corresponding checkbox in column Remove.
 Page 33 of 59

For all licenses, except floating and pay-per-use licenses OLicense-Server

returns the following message:

Figure 9: OLicense-Server’s response after license removal

(except for floating and pay-per-use licenses)
When removing a floating or pay-per-use license, a removal code will be
returned which has to be shipped to the licenser. The removal code is
shown and sent automatically to the e-mail address that has been set in
the administration window for notification. More information is supplied on
chapter 11.4 Use case “Server Administration“ on page 27.

Figure 10: Removal code for floating and pay-per-use licenses

11.6.2 Changing the OLicense-Server’s hardware

Floating and pay-per-use licenses require the server key (host ID of the
computer on which OLicense-Server is running). On PC’s, the server ID is
derived from the hardware address (MAC address) of the first network
adapter of the computer. Therefore changing the computer without taking
along the network adapter invalidates these licenses.
On workstations, the hardware ID is used for that purpose.
Except in the special case where the old and the new server are PC’s and
the network adapter can be taken along to the new server, all floating and
pay-per-use licenses have to be regenerated by the licenser for the new
server ID. For this purpose, all floating and pay-per-use licenses have to
be removed from the old OLicense-Suite and the removal codes have to
be sent to the licenser. Only after importing the removal codes into the
 Page 34 of 59

OLicense-Manager, the licenser will be able to change the server keys of

the licenses and re-generate them for the new server ID.

11.6.3 Enable/disable licenses

A disabled license will not be granted by the OLicense-Server. This may
be useful for testing purposes. To disable a license uncheck the checkbox
in column Enabled.To enable a license check the checkbox in column
Enabled.
Newly uploaded licenses are always enabled.

11.6.4 Activate/deactivate licensee feedback (supply additional

information)
For floating licenses, extended feedback information of OLicense-Server
can be enabled. In this case OLicense-Server returns, in conjunction with
a license request, a list of those computers that have locked the available
floating licenses. How this list is being followed up depends on the
licensed software.
To enable feedback check the checkbox in column allow info.

To disable feedback uncheck the checkbox in column allow info.

For newly uploaded licenses this feature is disabled at first, in case the
server isn’t started with –allowOccupancyInfoGlobal, see Chapter
10.5.

11.6.5 Check out settings

If the licenser granted a license for check-out you can determine who has
currently checked out licenses and you can impose additional limitations to
the licensee. To do this press button change. See the chapter 11.7.

11.6.6 Group-Pool
In the case it is an active Group Floating license, you see here who has
actually reserved a license and how long the license is reserved for a that
user/host. You can see more details, edit entries and add new entries. To
do this press button view details/edit. See the chapter 11.8

11.7 Sub use case „Change check out privileges“

 Page 35 of 59

Open this form by pressing button Administrate Licenses followed by

pressing button change in column check out license table if it is released by
the licenser.

The third row lists common data of that license that is going to be changed
with respect to its check-out privileges. From the sixth row on all server
ID’s are listed that may check out. Each server is represented by one row.
Server ID “{all}“ is an alias for arbitrary servers.
If your licenser has granted check out privileges for all servers, an
additional row will be shown with an empty field where you can fill in a
named server with different settings than the other servers. After
committing your changes, another empty row will be displayed where you
can continue in the same fashion…
The following table lists the limitations you can set. Be aware that you can
only strengthen the limitations as given by the licenser but not extend
them.
 Page 36 of 59

Column Description
Max runtime (days) The maximum period of time for license check-out i.e. if
the license isn’t checked in on the main server before
expiration date, the license automatically becomes
invalid on expiration day and the license will be credited
to the corresponding license account on the main server.
Set this value to 0 for infinite duration
Set this value to –1 if the specified server may not check
out licenses. There is a margin of one extra day i.e. the
expiration date of a license on a notebook will be
extended for one day. This is done to compensate
possible time intersection between license utilization on a
notebook and the main server.
Max Floats Maximum number of floating licenses that may be
checked out. Set this value to 0 to enable usage of all
available licenses.
Delete The entry will be removed i.e. the upper level settings will
be restored.

11.8 Sub use case „Admin Group Floating Licenses“

On a Group Floating license, a user pool of a defined size is connected
upstream of a floater pool. Each client who wants to lock a floating license
is first directed through a user pool. If the client is already entered here
with their name or computer ID, or if there is still room in the pool, the
client is passed on to the floater pool. By default, the licenser defines the
lifetime for the pool entries. The license is left reserved within that lifetime,
regardless if the license is effectively in use or not.
 Page 37 of 59

Figure 11: Admin Group Floating License

The first row shows information about the license, especially the pool size,
how long the entries will be allocated and how long a deleted entry will be
blocked against reassigning. This data is specified by the licenser.
It follows a four column table with the pool entries:
Column Description
client-ID User names or host IDs, according to the licensers
presetting
last usage Time when the client used the license at last
status Active: The client has or had used the license and it is
still reserved. The reservation duration results in the last
usage plus the lifetime.
Inactive: The validation is expired, the slot is free.
Client lock If the checkbox is checked, the entry remains reserved
forever. The button: ‚Change client locks now‘ saves the
changes.

Active or inactive entries can be deactivated with the button: ‘deactivate’.

On deactivation the pool entry is freed immediately and its ID is put to the
deactivation list.
Note: A currently used license by this entry will not be interrupted.
 Page 38 of 59

Entries on the deactivation list cannot be reassigned to the pool within the
blocking time. The blocking time is defined by the licenser.
Active and inactive entries can be deactivated and blacklisted at the same
time by clicking the button: ‘Deactivate and Blacklist’. Entries on the
blacklist are always blocked from requesting a license.
Inactive entries can be reactivated with the button: ‘Reactivate’. A
reactivated entry is subject to the pool lifetime.
Another four column table follows the pool table:
Column Description
Add client IDs Add user names or host IDs ( depending on the presets
of the licenser) manually to the pool.
Deactivated client Deactivated list (read only). Entries on that list cannot be
IDs reassigned to the pool.
Automatic activation Enabled: Default. The pool is automatically filled by
requesting clients.
Disabled: Entries can only be added manually through
this form.
Blacklist See chapter: 11.10
 Page 39 of 59

11.9 Use case „Floating License Reservation“

In general a floating license permits a predefined (as defined in the
license) quantity of simultaneous utilizations of the licensed software on
arbitrary computers and arbitrary users. Despite of that, it might be
reasonable to restrict or reserve the usage of a license to a particular
group of users or computers. This can be accomplished by clicking button
Reserve Floating Hosts. The following form will be opened:

Figure 12: Floating license reservation

If the field client IDs is filled out by your licenser you cannot make changes.
To restrict the usage of a floating license to a limited group of computers,
set the ID’s of those users/computers separated with comma in the
corresponding row at column client IDs. You may append an alias to each
ID if it is separated by a colon (:), e.g.:
08154711:myComputer, 4812ebd3:yourComputer,
hh:Hugo Hurtig
Floating licenses with column client IDs left empty may be allocated from
any computer in the network.
You may add an access limit for all entered IDs. This limit describes how
much licences each several uUser/host may lock. ‘0’ means unlimited.

11.9.1 Examples for reservation

One Floating pool shall be available unlimited and solely to the users
Hans, Emma and Luise:
IDs: Hans,Emma,Luise
Limit : 0
 Page 40 of 59

One Floating pool shall be available to all users but Hans and Emma shall
have access to one license at any time :
IDs: Hans,Emma
Limit : 1
(Floating pool size must be greater than 2 ! {Pool > Limit * NumberOfIDs})

You have 3 Floating pools. One pool of 4 (A) shall be available exclusively
to Fred and Bob. One pool of 2 (B) shall be available exclusively to John,
Bill, Dick and Harry. One pool of 6 (C) shall be available to all users:
A: IDs: Fred, Bob
Limit : 2
B : IDs : John, Bill, Dick, Harry
Limit: 1
C: IDs:
Limit: 0
Fred and Bod have access to ever 2 licenses from A. For more licenses
they must switch to C if there is any license free.
John, Bill, Dick and Harry have access to ever 1 of 2 licenses. Do e.g.
John and Dick currently using one license from B, all 4 must switch to C if
they need more licenses.

11.10 Use case "Group Floating Blacklist"

Via this form, named users/hosts can be excluded from the use of a Group
Floating license.
The column 'Client ID type' indicates whether the pool is operating with
user IDs or with host IDs. According to this, only user IDs or host IDs can
be excluded per license.
Declare the IDs as shown in the group pool column of the license
administration, exclusive all clamped terms. A comment can be added with
':', e.g.: 0815cdef:MyHost:MAC
 Page 41 of 59

12 High availability server system

For all license models, except for pay-per-use and floating licenses, you
may easily establish a high availability server system by setting up several
servers on different hosts, supplying each server with the same licenses.
You may specify up to three servers in your client application that can be
checked automatically for available licenses. Even if two of three servers
should fail the application will work anyway.
Pay-per-use licenses work in the same fashion, however the licenser has
to create an own license for each server and he has to use the log-files of
all servers for payoff.
Floating licenses require to setup a special highest availability server
system, which is available in two main variations. First variation can be
achieved by combining different servers with one or more OLicense-Proxy-
Servers. This framework can be again established with different variations.
Each framework consists of at least three standard OLicense-Server
(called server), each of it with its own database files and at least one
OLicense-Server running in proxy mode (called proxy).
Server and proxies evidently are web services that can be requested in the
intranet/internet without restrictions.
The proxy is responsible for hiding the complete server framework from
the licensed client application as well as administration by using a
browser. The client application can access only the URL’s of the proxies.
The proxy ’s job is to select, control and synchronize the servers. The
proxy isn’t bound to a particular host but the servers are i.e. to be able to
get a license from the licenser the proxy must be provided with the server
ID’s of all servers that are part of the license framework.
Caution! The server IDs cannot be requested through the proxy! You have
to contact each server separately.
Before requesting a license from the licenser, you have to define your
server ID’s and the number of servers to be used in your framework.
Evidently you can also use proxies for the other license models.
 Page 42 of 59

12.1 Server system configurations

Depending on the number of computers, we will propose three variants
(optimal, minimal and critical) in the following sections:

12.1.1 Optimal
This requires five computers:

computer 1-3 each hosts a server, computer 4-5 each hosts a proxy.
In this configuration, the failure of one server and one proxy can be
compensated without loosing functionality.
This system has a moderate redundancy with outstanding performance.

12.1.2 Minimal
This requires three computers: computer 1-3 each hosts a server,
computer 1-2 each hosts a proxy.
In this configuration, the failure of one server or one proxy can be
compensated without loosing functionality.
This system has a single redundancy with good performance. Apply this
configuration only, if you haven’t enough computers available. See the
annotation in section starting/stopping proxies.

12.1.3 Critical
This requires a total of eight computers: computer 1-5 each hosts a server,
computer 6-8 each hosts a proxy. In this configuration, the failure of two
 Page 43 of 59

servers and two proxies can be compensated without loosing

functionality.
This system has high redundancy with sufficient performance. You can
increase redundancy at your own preference at the cost of decreasing
performance. Conceivably are for instance twelve computers with nine
servers and three proxies. This configuration withstands the failure of four
servers and two proxies. Proxy failure is not critical, because if three proxy
hosts are broken you may start three new proxies on different hosts. In
this case you should inform the licensees about the new addresses.

12.1.4 Mixed Mode

In a server system, only multi-server-floating licenses are synchronized i.e.
all other license models in the framework (including single-server-floating
licenses) remain unchanged on the server. Therefore a licensed
application can use the licenses either directly via server or via proxy.
Also conceivable is to combine servers that are located in different
departments of your company and supplied with single licenses to a highly
availability server system by using proxies. This facilitates multi-server-
license operation.

12.2 Starting/Stopping of servers in a server system

No difference compared to a single server.
If required, you can start the server with parameter –proxyOnly which
enforces proxy control. In this case you cannot use mixed mode operation.

12.3 Starting/Stopping of proxies in a server system

Through the Controller frontend or from the command line:
olicenseserver [-port <port number>] –servers
<server1>,
<server2>,<server3>[,<serverN>,...]
If parameter –port isn’t specified port 80 will be used as default.
Parameter –server expects a list of all servers that are members of your
server system; each entry has to be separated by a comma.
 Page 44 of 59

For instance:
olicenseserver –servers
www.hugo.de,192.168.5.10:8080,ernie.local.de:8090
If the proxy-server is started for the first time, it registers itself as a service
and it will be available automatically after each reboot. If you intend to
change the server parameters or other parameters you must remove the
proxy-service at first (olicenseserver –uninstallService) and
then restart it with the modified parameters.
If you use a browser to administrate the proxy and you receive a message
box for more than 60 seconds stating that the server is in synchronization
mode this may be caused by the inability to find the specified servers. We
advise to start the proxy temporarily with parameter -logFile <bla.log> to
find the cause. One possible cause could be that the server names are not
specified full qualified.
Annotation for operation in minimal configuration (see above):
If you intend to use a server and a proxy as service on the same host,
ensure that their service names are different. This can be accomplished by
renaming the server binary and the INI file at first:
change olicenseserver.exe to olicenseproxyserver.exe (do. for
the INI file)
afterwards you can start in a similar way as described before:
olicenseproxyserver [-port <port>] –servers
<server1>,...
Additional parameters (as described) for proxies and servers are
-suspendService, -resumeService, -stopService,
-lang <language ID>
 Page 45 of 59

12.4 Second High-Availability Variant

All status information is constantly mirrored in variant 1. The advantage of
this is that if a server fails, the remaining servers will be provided with all
the previous knowledge required to continue operating the existing license
locks after they have been synchronized.

Such a system naturally loses performance as a result of the mirroring

process. In borderline cases, if the server needs to operate a very large
number of modules from a high number of users at very short time
intervals, the delays can be substantial and, depending on the
programmed tolerance of the client, the latter can lose the license
(possibly even permanently).

If this critical status is observed or foreseeable, the configuration according

to variant 2 is recommended.

In this variant, 3 servers are installed on 3 computers without proxies. A

maximum of one server may fail. Each server is configured with the -
fallback… parameters such that separate communication between the
servers themselves is possible.

The general syntax for each server is as follows:

olicenseserver [-port <port number>] –fallbackMyself

<my tcp>[:<my port>] –fallbackServer1 <its tcp>[:<its
port>]>] –fallbackServer2 <its tcp>[:<its port>]

The entry for “tcp“ must be made in numeric form, i.e. DNS names are not
permitted.

E.g.:

PC 1 on 192.168.0.1

olicenseserver -port 8080 –fallbackMyself

192.168.0.1:9090 –fallbackServer1 192.168.0.2:9090
–fallbackServer2 192.168.0.3:9091

PC 2 on 192.168.0.2
 Page 46 of 59

olicenseserver -port 8080 –fallbackMyself

192.168.0.2:9090 –fallbackServer1 192.168.0.3:9091
–fallbackServer2 192.168.0.1:9090

PC 3 on 192.168.0.3

olicenseserver -port 8085 –fallbackMyself

192.168.0.3:9091 –fallbackServer1 192.168.0.1:9090
–fallbackServer2 192.168.0.2:9090

The TCP paths between the servers themselves must be stable. Frequent
interruptions will lead to the servers being permanently blocked, which will
necessitate a reboot.

A license that must be obtained from the manufacturer requires the server
ID of all 3 servers. This type of license also functions in variant 1 with 3
servers.

The client application will be informed of all 3 servers according to the

manufacturer’s guidelines.

Via the start parameters, as standard: -OLicenseServer

E.g.:

myApp –OLicenseServer
192.168.0.1:8080,192.168.0.2:8080,192.168.0.3:8085

(DNS names may also be entered here.)

Advantages of variant 2:

• Almost the same performance as a single server system

• Lower resource consumption
• No proxies

Disadvantages:
• If servers fail, clients can lose their current license locks and need to go
through the assignment procedure again.
 Page 47 of 59

13 Backup and Restore

13.1 Administration of database files
By default, the server saves the uploaded license information in an
encrypted, object oriented database, consisting of three files located in it’s
installation directory (default: C:/Program Files/optimum/olicense).
The default file names are:
1. OlicenseServerDB.odb:
Contains all information entered or uploaded into the OLicense-Server.
2. OlicenseServerDB.odx:
Index file for OLicenseServerDB.odb.
3. OlicenseServerDB.ini:
Contains the configuration settings for OLicenseServerDB.odb.
By default, each *.odb file has a minimum size of 100 kB that is increased
in steps of 100 kB if required until it reaches 1 GB. A single license
allocates an average size of about 5 kB, meaning the default configuration
can handle about 200.000 licenses.

13.2 Backup database files

For backup, all *.odb files as well as all <name>.ini and <name>.odx have to
be saved.
As long as the OLicense-Server is running, the database files are locked.
Stop the OLicense-Server as described in chapter 10.2 on page 16.

13.3 Restoring database files

To restore the backup database files, stop OLicense-Server as described
in chapter 10.2 on page 16. Replace the database files by your backup
files. For security reasons, we recommend to remove the old database
files completely from the directory before restoring the backup files.
Afterwards restart the OLicense-Server as described in chapter 10,
Starting and Stopping Olicense-Server on page 14.
 Page 48 of 59

13.4 Reinstallation of OLicense-Server

Case 1: Reinstallation on the same computer:
1. Make a backup of your database files as described in chapter 13.2,
Backup database files on page 47.
2. Reinstall the OLicense-Server from the CD.
3. Restore the database files as described in chapter 13.3 Restoring
database files on page 39.
4. Restart OLicense-Server as described in chapter 10, Starting and
Stopping Olicense-Server on page 14.
Case 2: Reinstallation on a different computer:
If you have only licenses that don’t depend on the server-ID, you can
proceed as described in case 1.
In all other cases, proceed as described in chapter 11.6.2 Changing the
OLicense-Server’s hardware on page 28.
 Page 49 of 59

13.5 Backup in batch mode

To realize automatic backup of the OLicense-Server’s database files, you
can write a simple batch job.
Example:
olicenseserver –stopService
copy ...odb ...
copy ...ini ...
copy ...odx ...
olicenseserver –startService
 Page 50 of 59

14 (U3)-USB-Memory-Stick
Each stick/disk is assigned an individual hardware ID to which licenses
can be bound. This facilitates it to create a pluggable OLicense-Server,
that can be used on different computers. This means that the licenses are
only valid on that computer where the OLicense-stick is plugged in.
U3 sticks are USB sticks with extended functionality. Since 2012 sale and
support is no longer available. But OLicense still supports the readout of
the U3-ID.
The server recognizes all plugged sticks and shows the IDs on the admin
page. Every single ID may be used for licensing.

14.1 Specifics for Linux

Under Linux, the rights for reading the relevant parameters are usually
only accessible to the root user. If the server does not have root rights for
the parameter –runAs <user>:<group>, it will not be able to read the
stick. In this case, you will need to register the sticks to which licenses are
linked in the system. Proceed as follows:
Plug the stick into the computer.
Enter the command lsusb to find the manufacturer ID of the stick. The
command output contains several lines of the following type:
BUS 001 Device 001: ID <XXXX>:<NNNN> <plain text description>

Using the plain text description, localize your stick and note the two
number blocks by ID. XXXX stands for the vendor ID and NNNN for the
product ID.
Switch to the directory /etc/udev/rules.d and create a file with the
name 80-OLicense.rules. (If this directory contains different name
syntax, please adhere to this syntax).
Open the file in a text editor and for each licensed stick write a line in the
following format:
SYSFS{idVendor}==“XXXX“, SYSFS{idProduct}==“NNNN“,
MODE=“0660“, GROUP=“GGGG“
 Page 51 of 59

Replace the Xs and Ns with the IDs you have read. Replace the Gs with
the group name that you entered in the server with –runAs
<UUUU>:<GGGG>.
Now remount the stick.

(Note: The procedure described above refers to SuSE Linux 11. It is

theoretical possible that other distributions handle this in a different
manner. Please check your system documentation).
 Page 52 of 59

15 Serverstatistics
Please use external applications for that purpose.
(see e.g.: x-formation.com)

16 olixtool – the command line tool

olixtool is a non graphical application which offers mainly the information
functions from the OLicense-Support-API. It’s purpose is to retrieve
information from the client- but mainly the server-side by hand or batch
mode.
Calling it without any parameter will show a short help.
The following optional parameters are available:
Parameter Value Description
Global
-OLicenseServer <serveraddress>[:<Port>] Address of the server
to retrieve information
-sv
from. Default:
local,localhost
-OLicenseHttpProxy [<user>:<pw>@]<serverad Address and logindata
-pr dress>[:<Port>] of a proxyserver if
existent. Default: No
Proxy
Output
-ListOutput The result is printed as
simplified, single-line
-lst
list without comments.
Default: human
readable
-XmlOutput The result is printed as
complete XML
-xml
structure. Default:
 Page 53 of 59

human readable
Licensestatus-Filter
-LicenserKey <License-root-keyname of Rootname of the
the application> licenser key, see
-lk
column: Key (without
key number) in the
license report of the
server.
-AppName <applicationname> Name of the
-an application, see
column: Application in
the license report of the
server.
-AppVersion <versionnumber> Versionnumber of the
-av application

-ModuleName <modulename> Name of the application

-mn module, see column:
Module in the license
report of the server.
-Licenser <name of licenser> See column: Licenser
-lr in the license report of
the server.
-Licensee <name of licensee> see column: Licensee
in the license report of
-le
the server.
-LockedOnly Lists only Floating
licenses which are
-lck
currently locked by
users.
-ClientIDs [<ID1>[,<ID2>,…]] Lists only licenses
which match the given
-cid
IDs. If no IDs are given
the local ID is used, i.e.
 Page 54 of 59

an ID which a client
would have.
Host-ID
-HostIDs [-user <OLicenseAdmin> - Reports all server- and
pw <password>] client IDs. If the server
-hid
is protected by an
[-IdLockedOnly accont the loginname
-ido] and password must be
given. Is the additional
parameter –
IdLockedOnly present,
only the client Ids are
reported.
Version
-ServerVersion Reports the version
-v string of the addressed
server..
Import
-Import <filename> Imports the given file in
the server.
-imp

Examples:

Who has currently locked which modules of application foo:

olixtool –sv bla.fasel.de:8080 –an foo –lck
(Caution! To retrieve user information the server administrator has to
enable this information before, siehe Chapter: 11.6.4, Page 34)
Which modules does application foo have:
olixtool –sv localhost –an foo –lst
Which prospective host IDs can I send to my licenser:
olixtool –hid –xml > myIds.txt
 Page 55 of 59

17 Appendix: Messages

17.1 Transaction errors

17.1.1 Communication failure

Sender No. Text Description

OlComm 408 Receive timeout OLicense-API didn’t receive a reply within 10

seconds. This may be caused by a blocked server
host or the License-Server process was
suspended etc.
OlComm 450 Receive out of Reply has too much data. Possibly the reply
memory doesn’t belong to OLicense-Server.
OlComm 451 Request cannot Socket error of client. This may be caused by
open socket insufficient resources or TCP/IP protocol isn’t
supported.
OlComm 452 Request cannot Unable to get the hostname of the computer on
find hostname which the licensed software is running. This may
be caused by wrong operating system settings.
OlComm 453 Request cannot Unable to reuse client port. Port is probably being
reuse clientport used by another program. Choose another port or
disable client port.

OlComm 454 Request cannot The connection to OLicense-Server failed. Check

connect to target the address settings of the computer on which
OLicense-Server is running. Check proxy and
firewall settings.

OlComm 455 Request cannot An error occured during transmission of data to

send to target the OLicense-Server. Possible cause: broken
down network.
OlComm 550 Receive error: %d Network subsystem error. The error code
indicates the type of error. Lookup in the operating
system error table to get more information.
 Page 56 of 59

17.1.2 Protocol error

Sender No. Text Description

OlSoap 560 Message to short; Reply has wrong format.

invalid HTTP This message cannot result from a OLicense-
Server.
OlSoap 561 Message invalid Reply is not HTTP.
HTTP
This message cannot result from a OLicense-
Server.
OlSoap 562 Message cannot Reply has no response code.
scan HTTP
This message cannot result from a OLicense-
response code Server.

OlSoap 601 Message Reply has no data.

response data This message cannot result from a OLicense-
error/Missing Server.

OlSoap 602 Message Wrong transaction code. Reply cannot result from
transaction code a send message. Probably caused by a network
error error.
OlSoap 603 Message Reply with transaction code missing.
transaction code
This message cannot result from OLicense-
missing
Server.
 Page 57 of 59

17.1.3 OLicense-Server errors

Sender No. Text Description

OlServer 700 Transaction Sent message has no transaction number.

number missing
This message cannot result from a OLicense-
Server.

OlServer 703 No floating license All floating licenses are being used.
free

OlServer 704 Server can’t write OLicense-Server is unable to write log-file for pay-
Pay-per-Use time per-use licenses. Check the settings in the
administration form of OLicense-Server.
OlServer 705 No licenses No license available for this user or host. Check if
available for user has a valid named-user- or floating-license or
user/host if a node locked license is available for this host.
Check if user name respective host name are
correct.

OlServer 706 No licenses No valid license for this product. Check if product
available for has a license or if product name is correct.
product

OlServer 707 Invalid date or key Wrong key or invalid date in request.
mismatch in Check the date settings of server and client they
request must be equal.
OlServer 708 Invalid license Check the license file into OLicense-Server again.
(key missing)
OlServer 709 No license Request a new license from the manufacturer.
available for
request key

OlServer 710 <...> Server/Database error. To resolve this you may

restore the database files of OLicense-Server.

OlServer 711 Group pool fully The Group pool is fully occupied or the user/host
occupied has been excluded from usage
 Page 58 of 59

17.2 Transaction ok

Sender No. Text Description

OlServer 200 Ok After successful license check OLicense-Server

has unlocked the licensed application.

17.3 Error (exception) caused by erroneous

programming with OLicense API

Sender No. Text Description

OlLicense 100 Object not initialized OLicense API wasn’t initialised.

OlLicense 101 Unbalanced lock count Missing log-off of licenses

OlLicense 102 Cannot change user name Wrong point of time for usage of this
while locks are active function.

OlLicense 103 Cannot change server Wrong point of time for usage of this
address while locks are function.
active
OlLicense 104 Object already initialized Multiple initialization of OLicense API
 Page 59 of 59

18 Further information
Our postal address is:

Optimum GmbH
Hirschstr. 12-14
D-76133 Karlsruhe

The e-mail address of our support is:

[email protected]

Optimum GmbH
to get further information about Optimum and our products just visit our homepage at:
http://www.optimum-gmbh.com

We offer products and services regarding following topics:

 Data- and workflow-management

 Development of machine vision applications

 Development of client-server applications

 License management and software protection