A Guide to Using

CMG 2009 Licensing

By Computer Modelling Group Ltd.

-1-

Overview

About This Document

This manual describes the CMG licensing, the steps necessary to get your
software working, and how to troubleshoot licensing problems.
To use CMGs software, you will need to have valid licensing in place. This
means the licensing system needs to be installed and running with valid
authorization codes tied to your computer.
Later sections will go in depth on the following:

Installing the software with the licensing.

Determining the HostID information.

Receiving and installing a License File.

Checking the licensing status.

Going beyond basic licensing.

About the Reprise License Manager

CMG uses the Reprise License Manager (RLM) from Reprise Software.
Additional information about RLM is available on their website at
www.reprisesoftware.com. In particular, the RLM End-User Manual
(http://www.reprisesoftware.com/RLM_Enduser.html) and the End-User
Frequently-Asked-Questions (http://www.reprisesoftware.com/enduser_faq.htm)
should be noted.
All support issues should go directly to CMG technical support.
Reprise Software does not provide end user support.

Technical Support
Clients seeking technical support from CMG should first contact our head office
in Calgary via phone (North America: 403-531-1300) or email
(support@cmgl.ca). Support is available during normal Canadian business
hours, Mountain Time.

-2-

Additional support is available from our world-wide staff of Sales Support

Engineers:

Houston ............................ (281) 872-8500

London ............................. (44-1491) 832-447

Caracas ............................. (58-212) 993-3091

Rio de Janeiro................... (55-22) 25469897

Dubai................................ +971 (4) 434 5190

-3-

An Overview of the Installation

and Licensing Process

There are a number of steps to be followed when setting up your CMG software
for the first time.
The first step is to install the software on your computer. As a part of this step,
you will be prompted to generate a unique fingerprint for your computer (the
HostID). You need to send this HostID to us so that we may generate your
License File.
After we have generated your License File, you need to install it on your
computer. After this, you will be able to run your CMG software.
Depending on your license configuration you may not need to perform all these
steps for every computer you are installing on.

Types of Licensing
CMG software supports two different types of licensing: Standalone licensing,
where the software will only work on a single designated computer, and
etwork licensing, where the authorization codes are on a designated server and
multiple clients can use that servers licenses.
The type of licensing you use is determined by how you have licensed the
software from CMG.

Standalone
Standalone licensing restricts usage of CMG products to the computer the
License File is installed on.
With Standalone licensing, you are allowed to run multiple simultaneous copies
of CMGs graphical applications on your computer. CMG simulators are limited
to a fixed number of simultaneous copies as per your license agreement.

Network
Network licensing allows multiple computers to use the software over a
network. One computer is the etwork License Server and all other computers
are etwork License Clients.

-4-

The Network License Server is the computer where the RLM licensing server is
running and the License File is installed. Applications on the Network Licensing
Client pull licenses from this computer when they need them.

The Installation and Authorization Process

Setting Up a Standalone Installation
Step 1: Install the Software. For more information on how to install CMG
software, see A Guide to Installing CMG Software on Windows or A Guide to
Installing CMG Software on Linux and AIX Workstations.
Step 2: Generate a HostID and email it to CMG. See Generating a in this
document for more information.
Step 3: Install the License File. See Installing in this document for more
information.

Setting Up a Network Installation

Setting up a Network Installation requires the configuration of the Network
License Server and configuration of each Network License Client
Configuration the etwork License Server
The steps involved to setup up a Network Installation are similar to those for
setting up a Standalone Installation.
Step 1: Install the Software. For more information on how to install CMG
software, see A Guide to Installing CMG Software on Windows or A Guide to
Installing CMG Software on Linux and AIX Workstations.
Step 2: Generate a HostID and email it to CMG. See Generating a in this
document for more information.
Step 3: Install the License file. See Installing in this document for more
information.
Configuration of the etwork License Clients
Configuring a Network License Client requires only that the CMG software be
installed on the client computer. During installation, you will be prompted for
the name of the Network License Server. See A Guide to Installing CMG
Software on Windows or A Guide to Installing CMG Software on Linux and AIX
Workstations for more information.

-5-

Generating a HostID and

Sending it to CMG

To use the CMG software you will require a License File that is locked to your
system. This file is locked to a combination of unique characteristics of your
computer called the HostID. For example, the HostID may include your
computers Ethernet MAC address.
You will need to send us the HostID information for us to generate your License
File. You will not be able to run CMG software until we have this information
and have issued you the file.
The HostID information can be generated automatically during installation and
also at any time afterward.

Generating a HostID during Installation

Windows
When the installation is almost complete, you will be asked if you want to
generate your HostID information. Fill in the required information and then
save it to your disk.

Linux and AIX

When the installation is almost complete, you will be asked if you want to
generate your HostID information. If you do so, it will automatically be saved
to the file <CMG_HOME>/hostid.info.

Generating a HostID after Installation

It may sometimes be necessary to generate HostID information after you have
installed the software. There are custom utilities provided by both CMG and
Reprise that allow you to do that.

Windows
The recommended way to check the HostID information on Windows is to use
the CMG License Utility.

-6-

The CMG License Utility may be started from the Start menu. Press the Get
HostID button to bring up the following dialog:

Enter your information into the dialog.

The information you enter does not affect the actual HostID that
is generated. It just helps ensure that we can find your order in
our system.
You may save this information to a text file to email to CMG for generation of
your authorization codes. See Sending the HostID Information to CMG.

Other Methods of Generating HostID Information

The rlmhostid Utility
RLM supplies a HostID utility (rlmhostid) which can be found in the
RLMSecure directory. It is a console application, so it must be used from within
the Windows Command Interpreter (also known as the command prompt or
DOS shell).
Basic usage is
rlmhostid

This will yield the HostID (the 32-bit hard drive number) of the computer
with this output:
rlmhostid v4.0 Copyright (C) 2006-2008, Reprise
Software, Inc. All rights reserved
Hostid of this machine: d8ffec1d

For complete instructions on how to use rlmhostid, check the section Going
Beyond the Basics: Reprise utilities.

-7-

Direct Method
The values that the CMG HostID utility and rlmhostid report are not encrypted
and you may therefore simply report the Ethernet MAC address, IP address,
hostname and hard disk ID to us if you have access to that information. This
should be a last resort as we would much rather have the information as
provided by one of our utilities this guarantees that the licensing is looking at
the correct values.

Sending the HostID Information to CMG

Once you have your HostID information, you need to send it to us. There are
two ways of doing this. The preferred method is to send it by email to
licenses@cmgl.ca. Alternatively, you can fax it to us at 403-282-6495.
Once we have received this information we will use it to generate the License
File you are entitled to and send it back. We try our best to have your codes sent
to you as soon as possible, but due to the volume of requests we receive, it could
take up to two business days.

-8-

Starting the License Server

The License Server runs as a Windows Service on Windows and as a daemon on

Linux and AIX.

Starting the License Server on Windows

By default, the CMGL RLM Service is set to start as an Automatic startup
service. If for some reason you need to change this or restart the service, you
may do this via the Services Control Panel applet which is located in the
Administrative Tools area.

Starting the License Server on Linux and AIX

The CMGL RLM Service on Linux and AIX runs as a daemon process. You
may start this process using the RestartRLM script located in the CMG_HOME
directory.

-9-

Installing Your License File

There are two ways you can install your License File.
The recommended method is to use the CMG License Utility. This application
consolidates most of the CMG-specific licensing functions into a single interface
and ensures that your License File is loaded properly.
You may also use the Reprise Server Administration Interface to install your
License File.

Installing Your License File Using the CMG License

Utility
The CMG License Utility runs only on Windows. To install a
License File on Linux or AIX see Installing Your License File
Using the Reprise Server Administration Interface.
To install your License File using the CMG License Utility, follow these steps.
1.

If you received your License File via email, save to a file on disk.

2.

Start the CMG License Utility from the Start menu.

- 10 -

3.

Press the Load License File button and browse to the License File on
your disk. Press OK. The CMG License Utility will scan the file for
correctness and load it into the RLM License Server.

Installing Your License File Using the Reprise Server

Administration Interface
You may also install your License File through the Reprise Server
Administration Interface. Follow these steps on the license server computer.
1. Copy the file to the <CMG_HOME>\RLMSecure directory.
2. Rename it cmgl.lic if it does not already have that name.
If you have Windows Explorer set up to hide file extensions, the
file may be renamed to cmgl.lic.txt instead of cmgl.lic. If this is
the case, open a command prompt and rename the file from
there.
3.
4.

Open an Internet Web Browser (for example, Internet Explorer,

Mozilla Firefox or Opera).
In the Address/URL bar, enter http://localhost:9000/. This accesses the
Reprise License Server Administration page for the local computer.

If this address doesnt work, try http://127.0.0.1:9000. If this

doesnt work, ensure the CMGL RLM Service is running.
5.

Once the Reprise License Server Administration page is displayed,

click on the Reread/Restart Servers link. The Reread/Restart Servers
page will be displayed.

- 11 -

6.

Enter cmgl into the ISV field (as shown in figure 3 above) and click
the REREAD LICESES button.

You should now be able to use any CMG application that you are entitled to.

- 12 -

Checking License Status

Checking License Status Using the CMG License

Utility
The CMG License Utility allows you to see what licenses are installed the
license server you are connected to.
Licenses are grouped by server and by product. Some products (such as the
simulators) may have multiple types of licenses available.

The computer you are getting licenses from is shown in the first line of the grid.
Standalone configurations will show either localhost or 127.0.0.1.
If the RLM Service is running on your computer, this is shown as well.
The CMG License Utility does not show expired licenses, nor does it account
for licenses that have been checked out.
CMG applications require twenty keys in the authorization
codes file per use. This is indicated by the count in the
Number of Licenses column.

- 13 -

Checking License Status Using the Reprise License

Server Administration Page
You can get further information about the licenses available by using the
Reprise License Server Administration Page. This page is accessed via your
internet web browser.
You do not need to be connected to the internet to access the
Reprise License Server Administration Page.
1.
2.

Open an Internet Web Browser (for example, Internet Explorer,

Mozilla Firefox or Opera).
In the Address/URL bar, enter http://localhost:9000/. This accesses the
Reprise License Server Administration page for the local computer.

If you have changed the port number the RLM Administration

Web Service is listening on, use that number instead of the
default of 9000.
3.

Click the Status link. This will take you to the Status page.

4.

If your CMG software has been installed correctly with proper

authorization codes, there will be a CMG row in the table of ISV
Servers. Click on the Server Status button in the cmgl row. This
takes you to the ISV cmgl status page.

- 14 -

Table entries are as follows:

Product: The name of the license.
Pool: Each pool has a unique number. Multiple similar licenses may be
collapsed into a single pool by the RLM service.
Ver: The version of the software that can be run with this license. In this case
STARS 2008.99 or earlier can be run with the current licenses.
Count: This is the number of keys available for each license.
Soft lim: CMG does not use soft limits on licensing. This field can be ignored.
in use: The number of license keys currently in use. The Show License Usage
button will tell you who is using these licenses. Remember, CMG applications
use licenses in multiples of twenty.
res: The number of licenses reserved. CMG does not allow reserved licenses
so this field can be ignored.
hostid: If this field is blank, it indicates a network license that can be used by
any client computer. If the field has a HostID in it, it is a stand-alone license
that can only be used by the computer with the matching HostID.
timeout: The TIMEOUT value for the license after which an idle license is
checked back into the pool freeing it up for other users.
share: The sharing criteria for the license. This allows multiple instances of an
application to share a license. Currently only Builder, Results, CMOST Studio
and WinProp use sharing.
hold: The hold time for the license. CMG does not allow license holding so
this field can be ignored.
transactions: The number of times that this license has been used to run an
application.

- 15 -

Show License Usage: Click to show any current users of the license.
For more information on using the Reprise License Server Administration
page, see http://www.reprisesoftware.com/RLM_Enduser.html.
You may also access the Reprise License Server Administration
page from another computer. Just use
http://computername:9000 (where computername is the name of
the license server computer) as the address in your web
browser. If you have changed the port number the RLM web
server is listening on, use that number instead of 9000.

- 16 -

Going Beyond the Basics

Getting Diagnostic Information

On occasion you may have trouble accessing your CMG licenses. The CMG
License Utility can provide you with diagnostic information to help troubleshoot
this situation.
You may access the diagnostic information as follows:
1.

Start the CMG License Utility.

2.

Click the arrow button at the bottom of the screen and select Create
Diagnostic File.:

3.

Provide a name for the file.

4.

Open the file in Notepad or another text editor to view the contents of the
file.

The diagnostic information provided includes information about your computer

environment (including your HostID), the contents of your license file (if your
computer is a Standalone computer or a Network License Server), and
diagnostics from the RLM subsystem.

- 17 -

CMG Support may ask you for this diagnostic information when
troubleshooting a problem.

Configuring RLM in a Firewall Environment

The RLM license server will use two TCP ports to make CMG licenses
available to CMG Applications:

The RLM license server listens on a port (by default, port 2700) for
license requests from any ISV application.

The CMG license server listens on a port (by default, port 3137) for
CMG-specific license requests. The RLM server will provide CMG
applications with this value.

If you want to serve licenses across a firewall you will need to have a known
port for the RLM server and the CMG ISV server and these ports must be open
through the firewall. Although the CMG ISV server port number may be
dynamically assigned by the RLM server, CMG recommends always setting a
specific port number for the CMGL ISV server.
By default, the CMGL ISV server is set to port 3137 in the License File on the
ISV line as follows:
ISV cmgl cmgl cmgl.opt 3137

You may change the port to any other open port by changing this value and
restarting the RLM server. If you remove this value, RLM will assign a port
dynamically at startup. It may assign different values each time the server is
started, so this may be difficult to configure in a firewall environment.
By default, the RLM Server is set to port 2700 in the License File on the HOST
line as follows:
HOST UNKNOWN 66393ca9 2700

You may change the port that the RLM server listens on by changing the value
on the HOST line in the license file and restarting the RLM server. If you do
this, you must edit your CMG_LIC_HOST environment variable to reflect this.
The syntax of the CMG_LIC_HOST environment variable is as follows:
CMG_LIC_HOST=hostname:port

For example, if a Network License Server is on computer computer123 and it is

listening on port 2727, CMG_LIC_HOST should be set to the following:
CMG_LIC_HOST=computer123:2727

The Options Files

You can configure how the licensing works at your organization using options
files.
The RLM Options file controls the behavior of the RLM server itself. It is
located in:
<CMG_HOME>\RLMSecure\<Platform>\rlm.opt

- 18 -

where <Platform> is platform directory where the RLM license manager

executable is stored. <Platform> will be one of:

AIX_p4

Linux32

Linux_p4

Linux_x64

Win32

Win_x64

The CMG Options file, which controls the behavior of the CMGL ISV server, is
located in:
<CMG_HOME>\RLMSecure\cmgl.opt

This is the same directory as the cmgl.lic authorization code file.

In some situations the cmgl.opt file may be created in your
Windows\System32 directory.
Complete information and syntax for these options files is available from the
RLM End-User Manual. http://www.reprisesoftware.com/RLM_Enduser.html
CMG does not create these files on installation.

Configuring License Timeout

CMG applications are configured to release licenses they have checked out
when they are finished with them, or when they experience a non-standard
program termination. Under some situations, such as when the network
connection to the Network License Server has been lost, the license server may
not be told the licenses are no longer needed and they will not be released. This
condition will persist until an administrator explicitly releases the licenses
through the RLM Administration Page.
You can configure your system to automatically check licenses back in to the
server if the client application has not been heard from for a period of time.
1.

Connect to the RLM Server using a web browser.

2.

Find the cmgl ISV Server on the Status page.

- 19 -

3.

Click EDIT OPTIONS to bring up the Edit ISV Options page.

4.

Add the following line to the file:

TIMEOUTALL 120

The value after the TIMEOUTALL directive is the number of seconds of

inactivity that should pass before the server checks the license back in. As all
CMG applications contact the server on a regular basis, any value above 2
minutes is reasonable.
If a license is checked back in because of a timeout situation, the following will
happen:

- 20 -

The checked-in license is available for any other application instance to

use. If a simulator run has been queued up waiting for a license, it will
start running when it acquires this license.

If the application that had the license that was checked in is still
running, it will try to reacquire the license for 30 minutes. If no other
application has checked the license back out, the running application
will require it and will continue running. If it cannot reacquire a license
within 30 minutes, it will exit.

Reprise utilities
All of the Reprise utilities are also available through the Reprise License
Server Administration web page.

rlmdown
Shuts down the license server(s).
Usage for rlmdown is:
rlmdown [isv]

isv is the name of the software vendor. To shut down all rlm servers, enter
rlmdown. To shut down only the CMGL server, while leaving other license
servers alone, enter rlmdown cmgl.

rlmhostid
Reports the HostID information for the computer.
Usage for rlmhostid is:
rlmhostid -q [[-]32|ether|ip|internet|host]

Each command line option reports a different piece of HostID information, as

follows:

rlmhostid -32 reports the computers 32-bit hard-disk ID.

rlmhostid -ether reports the Ethernet MAC address.

rlmhostid -ip and rlmhostid -internet report the computers IP

address.

rlmhostid -host reports the computers hostname.

The q option suppresses the utilitys banner and copyright information.

rlmnewlog
Creates a new logfile for recording licensing transactions and errors.
Usage for rlmnewlog is:
rlmnewlog isv log-file-name

isv is the software vendor cmgl for example and log-file-name is the name of
the new logfile.

- 21 -

rlmremove
Forces an in-use license back into the pool to be used by subsequent
applications.
Usage for rlmremove is:
rlmremove [-q] server-host port isv handle

server_host is the machine that the license server is on.

port is the port used to communicate with the server.
isv is name of the software provider cmgl for CMG licenses.
handle is the handle of the application using the license.
Server-host, port and handle are all provided by rlmstat.

rlmreread
Forces the license manager to reread the License File.
Usage for rlmreread is:
rlmreread [isv]

isv is the name of the software vendor. To reread all License Files for all
software vendors, enter rlmreread. To reread only the CMG License File, while
leaving other license servers alone, enter rlmreread cmgl.

rlmstat
Retrieves status from the license servers and prints it. Control over the status
retrieved from rlmstat is specified as follows:
rlmstat [-a] [-i [isv]] [-l [isv]] [-n [node]] [-p
[product]] [-u [user]]
option

parameter

-a

(no parameters)

-avail
-i
-l
-n
-p
-u

[-i isv] [-p product] -b

display this isv only
display this isv only
display licenses from this host only
display licenses for this product only
display licenses from this user only

result
Print all status from rlm and all ISV
servers.
Reports free license availability.
Display license checkout info from ISVs.
Display license pooling info from ISVs.
Display license checkout info from ISVs.
Display license checkout info from ISVs.
Display license checkout info from ISVs.

rlmswitch
Switches the debug log info to a new file
Usage for rlmswitch is:
rlmswitch [isv] new-file

rlmswitch causes the server isv to close the current debug log file and begin
output to new-log-file-name. If isv is not specified, or if specified as rlm, the rlm
server's debug log is switched.

- 22 -

How CMG Applications Are

Licensed

Each copy of a CMG application you have licensed is enabled by a License Key
Line in the License File we provide to you. CMG uses a model where each copy
of an application you have licensed requires a count of twenty on the License
Key Line. For example, if you have licensed three copies of GEM, there will be
a count of 60 on the gem_unlimited License Key Line.
The CMG graphical applications (Builder, Results, WinProp, and CMOST
Studio) are licensed on a per-user basis. This means that if more than one copy
is run by a user on a given computer, it still only checks out one license. The
simulators, however, are licensed on a per-instance basis. Each time a simulator
is run a license is checked out. For example, if you run two simultaneous copies
of STARS in a session, two licenses (or a License Key count of 40) are checked
out.
CMG enables options through License Key Lines as well. If you have licensed
an option from us (such as Parallel Tokens or Dynagrid) you will see these
options enabled through License Key Lines as well. Note that some older
options (such as a link between IMEX and Forgas) are now enabled for all
customers, and therefore License Key Lines for these options will appear in
every License File.
University licenses enable the use of any of the simulators (IMEX, STARS, or
GEM), but with a limit on the number of grid blocks that may be used in any
model. These licenses are intended for academic usage and may not be used for
commercial work.

- 23 -