How to Generate a License Key

License Types
     Windows
     Windows and UNIX/Linux
Generating a License Key
     SU
     CU
     SESS
     PSESS
     PS

License Types

Licensing S-PLUS is handled by the FLEXnet license management system, which replaced the previous Insightful license management system starting with S-PLUS 7.0.

Note that fulfilling a license key request must be completed through keys.insightful.com, except for single-user (SU) licensing on Windows.

Windows

Windows and UNIX/Linux

PSESS and PS Licensing
A hostid of the license manager is required to obtain a license key for CU, SESS, and PSESS licensing. A node-locked hostid is required to obtain a license key for SU and PS licensing.

Licensing the S-PLUS Server to use only a subset of the total CPUs (sub-capacity licensing) is not permitted. You must license a total number of concurrent sessions instead, which requires a PSESS license.

Generating a License Key

For all platforms, you need a license authorization code (LAC) and hostid in order to generate the license key the FLEXnet license manager requires to run S-PLUS. The LAC should have been e-mailed to you after you purchased S-PLUS. If you attempt to start S-PLUS without a license key, the license key wizard is automatically invoked to help fulfill your license (SU licensing on Windows only).

Obtaining a license key for S-PLUS depends on the type of licensing you purchased:

  1. Run the license key wizard on your machine (SU licensing on Windows only).
  2. Access the Web-based Insightful License Fulfillment Center (all license types on Windows and UNIX/Linux) at
    keys.insightful.com

We describe all five (5) licensing types in the following sections. Note that only SU licensing can be fulfilled via the license wizard; all other license types require you to access the Web-based Insightful Fulfillment Center to get a license key.

Single-User (SU) Licensing (Windows)

If you attempt to run S-PLUS without a license key, S-PLUS automatically invokes the Insightful License Fulfillment wizard to help you generate and install a license key. The wizard searches for an existing version of S-PLUS 7.0 or higher on your machine.

You can also invoke the wizard by navigating to Start -> Programs -> S-PLUS 8.0 -> Wizard for License Manager. Note that you must have an Internet connection from your machine to fulfill your license request through the wizard.

If you have S-PLUS 7.0 or higher installed, Update From Previous Version is selected, as shown below. If you do not have S-PLUS 7.0 or higher installed, New Installation is selected. Click Next to continue.

Update From Previous Version is automatically selected if S-PLUS 7.0 or
higher is installed. Note the hostid (your disk serial number) is displayed near
the bottom.

Update From Previous Version

If a license key from S-PLUS 7.0 (or higher) is detected, you are prompted to verify you want to use this existing license key for your S-PLUS 8 installation. Click Next if this is correct or Browse if you want to use a different license key.

This copies the license key from your S-PLUS 7.0 (or higher) installation to
your new S-PLUS 8.0 installation.

The path to the license key is then displayed for confirmation.

Confirming the path to your new license key when the License Authorization
Code (LAC) has been entered correctly.

S-PLUS should now start, and you do not need to repeat this process for license fulfillment. If you continue to have problems with the installation, please go to keys.insightful.com or contact Technical Support.

New Installation

Fulfilling a license key request for S-PLUS 8.0 for a new installation.

Input your License Authorization Code (which should have been e-mailed to you) in the License Authorization Code field, shown below. If you are using a proxy server (or other means) to connect to the Internet, select I connect to the Internet using a proxy server (near the bottom). If you aren’t sure, leave this option set to the default and click Next.

Enter your License Authorization Code. Select I connect to the Internet
using a proxy server
if you are using a proxy server.

This takes you to the Proxy Server dialog, where you can enter the proxy server, port number, username, and password. Click Next.

If you use a proxy server to connect to the Internet, fill in the appropriate fields.
For all other types of connections, this dialog box is skipped.

The path to the license key is then displayed for confirmation. Click Finish or Back to correct anything.

Confirming the path to your new license key when the License Authorization
Code (LAC) has been entered correctly.

The license key has been generated and copied to SHOME/adm/lic/keys by default, where SHOME is your S-PLUS base installation directory.

If you entered the LAC incorrectly or the license cannot be fulfilled for some reason, an error message is displayed providing hints on how to proceed. Read the information carefully before proceeding; if you still experience difficulties, contact Technical Support.

Insightful License Fulfillment Center

This is a Web site hosted by Insightful that allows you to perform a number of tasks related to license management, including generating, re-hosting, and viewing license keys. You can access this site by pointing your browser to

keys.insightful.com
Select I have a License Authorization Code for almost all cases. If you have specifically been issued a Web Registration Code, click I have a Web Registration Code.

Select I have a License Authorization Code unless you have specifically been issued a Web Registration Code.

In the next screen (below), enter your License Authorization Code (which should have been e-mailed to you) and click Login, as shown below. Note that terms such as "License Authorization Code (LAC)" are hyperlinked; you can get help on these terms by clicking the link.

Entering the License Authorization Code (LAC).

A number of licensing options are available in the Generate or View Licenses dialog box (below). For example, if you need to re-install S-PLUS after a hard drive crash, or if are now running S-PLUS on a different machine, click Re-host Licenses. Click one of the following options:

We discuss each of these four (4) options in the following section.

You can generate, re-host, or view licenses in this dialog box.

Generate Licenses

The following is the process for creating a license key and copying it to your SHOME/adm/lic/keys directory so the license manager can find the key and start S-PLUS. Note this example shows only one S-PLUS product in the order, and you could have a number of products in a single order as well as multiple orders. Descriptions of the dialog fields are included below. When you have typed the information in the fields, click Generate.

Information on your given product (including order and serial number) is displayed in this dialog.

Select Items to Fulfill

Select the product (near the top). Optionally, select the product at the bottom of the page (click to select one product, CTRL+click to select more than one product, SHIFT+click for a series of products), and click Filter Products.

License Type

Displays the available license types (SU or PS, which are node-locked) for your machine.

Node-locked Hostid and Server Hostid

This is your disk serial number in Windows, or the output from running ./HOSTINFO from your top-level S-PLUS directory on UNIX or Linux. If you do not know your hostid, there are at least three ways to determine it on Windows:

  1. Start -> Programs -> S-PLUS 8.0 and select Wizard for License Manager. The hostid for your machine is displayed at the bottom of the screen.
  2. Go to SHOME/adm/lic/cmd and double-click lmtools.exe. Click the System Settings tab and the Disk Volume Serial Number field contains your hostid.
  3. Open a Command Prompt and type
  4. dir C:

    The Volume Serial Number is the same as your hostid (18E5-6CF8 in the example below). When you type this hostid to fulfill a license, do not include the dash (-) symbol. You can copy and paste this hostid.

The disk serial number is also called the Volume Serial Number (upper left).

Node-locked Hostid Type and Server Hostid Type

Select one of the following and click the Generate button:

Note: If you are running S-PLUS 7.0 through 7.0.6 on Windows and your hostid is 12 characters, select ETHERNET. If it is 8 characters, select DISK_SERIAL_NUM.

Select Product

Click to select one product, CTRL+click to select more than one product, SHIFT+click for a series of products. Click Filter Products to display specific products.

The confirmation screen (below) verifies this is the product you want to generate a license key for. Note that your order number and serial number are included for verification. If the information is correct, click Confirm.

Confirming your selection for generating license keys.

The next screen displays the license key information. Select one of the following two buttons:

Cautions
If you rename the license key file in either option, the FLEXnet license manager might not recognize the license key if it does not end with .lic. In general, we recommend that you do not rename this file.

You can save your license key anywhere on your machine, but S-PLUS searches the SHOME/adm/lic/keys directory first. In addition, if you put the license key elsewhere, you must set an environment variable.

You should save the license key file in SHOME\adm\lic\keys, where SHOME is your S-PLUS installation directory. Click here for more information on changing this_host.

Re-host Licenses

In the event you have changed machines or had a hard drive failure, you can rehost the license key. Note that this process is very similar to the Generating Licenses section.

Go to keys.insightful.com, type your LAC, and click Login. Click Re-host Licenses.. Select the product you want to return and click Return. The confirmation screen verifies this is the product you want to return. Note that your order number and serial number are included for verification. If the information is correct, click Confirm. You should now see the screenshot below. Select the product you want to rehost (clicking Filter Products if necessary). Click the Hostid Type drop-down to select the type:

Note: If you are running S-PLUS 7.0 through 8.0 on Windows and your hostid is 12 characters, select ETHERNET. If it is 8 characters, select DISK_SERIAL_NUM.

Type the new hostid in Node-locked Hostid. Click Generate to complete the license key re-host.

You can re-host a license key if you have changed machines or replaced a hard disk due to failure.

The next screen displays the license key information. Select one of the following two buttons:

Cautions
If you rename the license key file in either option, the FLEXnet license manager might not recognize the license key if it does not end with .lic. In general, we recommend that you do not rename this file.

You can save your license key anywhere on your machine, but S-PLUS searches the SHOME/adm/lic/keys directory first. In addition, if you put the license key elsewhere, you must set an environment variable as described in Setting the License Key Environment Variable.


View Licenses

You can view just the license information for a specific order or a number of orders.

Go to keys.insightful.com, type your LAC, and click Login. Click View Licenses, and you should see the screenshot below.

Type your hostid (select Match HostID Exactly if you want to filter by the full hostid), and click Filter Products to filter the products by order. Click View to see the license information for a single product, View All to see the information for all your products, or Return if you want to skip this page and see more options. Select Display licenses only (no wrapper) if you want to view the license information only (without the header information).

You can view license key information for one product or a number of products.

Redeem

Enter your Web Registration code (issued only if you downloaded S-PLUS from www.e-academy.com or you ordered a book from Insightful) and click this button to generate a license key. Note this is not a common method for fulfilling a license key request, and special instructions will be sent to you if you have been issued a Web Registration code. Click Redeem.

Redeeming a Web Registration code.

Concurrent User (CU) Licensing (Windows and UNIX/Linux)

Go to keys.insightful.com, enter the License Authorization Code (LAC), and click Login, as shown in the dialog below.

Entering the LAC to generate a CU license key.

Click Generate Licenses to generate a license key, as shown below. You can also Re-host Licenses or View Licenses by clicking the appropriate button.

You can generate, re-host, or view licenses in this dialog box.

Select the product (near the top), or highlight the product(s) and select Filter Products (near the bottom). Since the license keys for CU license are normally controlled by a license server, you need to enter the hostid for the server machine.Click here to obtain instructions for determining the Server Hostid Type and Server Hostid of this server. Type them (below). Note that you can designate Server 2 Hostid and Server 3 Hostid to provide support as redundant license servers; normally, these should be left blank. Click Generate to generate the license key(s).

Consult the FLEXnet Licensing End User Guide in your SHOME/adm/lic/cmd directory for more information.

Example five (5) user concurrent user (CU) licensing. When the number of requests exceeds the number of
issued keys, the license request is denied. In the Quantity to Fulfill field, you can enter any number of
licenses (limited by the total available).

The remaining steps are completed as if you are fulfilling an SU license, starting with confirming your license key.

Concurrent Session (SESS) Licensing (Windows and UNIX/Linux)

Go to keys.insightful.com, enter the License Authorization Code (LAC), and click Login, as shown in the dialog below.

Entering the LAC to generate a SESS license key.

Click Generate Licenses to generate a license key, as shown below. You can also Re-host Licenses or View Licenses by clicking the appropriate button.

You can generate, re-host, or view licenses in this dialog box.

Select the product (near the top), or highlight the product(s) and select Filter Products (near the bottom). Click here to obtain instructions for determining the Server Hostid Type and Server Hostid of this server. Note that you can designate Server 2 Hostid and Server 3 Hostid to provide support as redundant license servers; normally, these should be left blank. Click Generate to generate a SESS license key.

Example five (5) user concurrent session (SESS) license. When the number of active sessions is at its limit,
S-PLUS will not start. In the Quantity to Fulfill field, you can enter any number of licenses (limited by the
total available).

The remaining steps are completed as if you are fulfilling an SU license, starting with confirming your license key.

Production Concurrent Session (PSESS) Licensing (Windows and UNIX/Linux)

Go to keys.insightful.com, enter the License Authorization Code (LAC), and click Login, as shown in the dialog below.

Entering the LAC to generating a PSESS license key.

Click Generate Licenses to generate a license key, as shown below. You can also Re-host Licenses or View Licenses by clicking the appropriate button.

You can generate, re-host, or view licenses in this dialog box.

Select the product (near the top), or highlight the product(s) and select Filter Products (near the bottom). Click here to obtain instructions for determining the Server Hostid Type and Server Hostid of this server. Note that you can designate Server 2 Hostid and Server 3 Hostid to provide support as redundant license servers; normally, these should be left blank. Click Generate to generate a PSESS license key.

Example five (5) user production current session (PSESS) license. In the Quantity to Fulfill field, you can enter
any number of licenses (limited by the total available).

The remaining steps are completed as if you are fulfilling an SU license, starting with confirming your license key.

Production Server (PS) Licensing (Windows and UNIX/Linux)

Go to keys.insightful.com, enter the License Authorization Code (LAC), and click Login, as shown in the dialog below.

Entering the LAC to generating a PS license key.

Click Generate Licenses to generate a license key, as shown below. You can also Re-host Licenses or View Licenses by clicking the appropriate button.

You can generate, re-host, or view licenses in this dialog box.

Select the product (near the top), or highlight the product(s) and select Filter Products (near the bottom). Type the Node-locked Hostid and select the Node-locked Hostid Type (contact your system administrator if you do not know the node-locked hostid or node-locked hostid type). Click Generate to generate a PS license key.

Example 2-CPU production server (PS) license. This type of licensing allows an unlimited number of
sessions to be run, because licensing is based on number of CPUs.

Because an unlimited number of sessions are allowed on the machine, a license manager is not necessary; however, you still must obtain and install a license file to run S-PLUS.

The remaining steps are completed as if you are fulfilling an SU license, starting with confirming your license key.

Modifying the License Manager for Concurrent User (CU) and Windows Terminal Services Users (SESS, PSESS)

Special instructions are required to install and modify the license manager for concurrent user (CU) licensing and server licensing for Windows Terminal Services users with concurrent session (SESS) and production concurrent session (PSESS) licensing.

This section shows how to change the settings for the FLEXnet license manager for any of these licensing scenarios. After you’ve generated a license key, do the following:

  1. Go to your SHOME/adm/lic/cmd (where SHOME is your base installation directory) and double-click lmtools.exe. This invokes the LMTOOLS dialog, shown below.
  2. The Service/License File page of the LMTOOLS dialog. This dialog is used to modify the license manager settings,
    primarily for concurrent user (CU) licensing and Terminal Services users (SESS and PSESS).

  3. Click the Service/License File tab (displayed by default) and select Configuration Using Services. The field below the option indicates what FLEXnet services are currently installed on this machine, if any.
  4. Click the System Settings tab, and in the Hostid Settings group, verify that Disk Volume Serial Number is the hostid (18e56cf8 in the example below) you used when obtaining your S-PLUS license key from the Insightful License Fulfillment Center (keys.insightful.com).
  5. The System Settings page of the LMTOOLS dialog. Verify that the Disk Volume Serial Number is the hostid used
    when you obtained your S-PLUS license key.

  6. Click the Config Services tab, select the name of the service in Service Name. You can enter a new name for a service, or select an existing service you want to delete and click Remove Service. In the other fields, type the paths (the example uses the defaults) or navigate to them using the Browse button; the debug log file can be in any directory. A summary of the fields:
  7. Field Enter or Type
    Service Name IFUL_Report (this can be any name you select to identify this service on your system)
    Path to the lmgrd.exe file C:\Program Files\Insightful\splus80\adm\lic\cmd
    Path to the license file C:\Program Files\Insightful\splus80\adm\lic\keys
    Path to the debug log file C:\splus80_debug

    The page should look like the figure below when complete:

    The Config Services page of the LMTOOLS dialog. Enter the Service Name (type a new one or select an existing one
    to update/remove), and type the path to the appropriate file (or use the Browse button to navigate to it).

    Click Save Service when you are done. Note that if S-PLUS is installed in a different directory, you must change the paths you entered above accordingly.

  8. Go to the Start/Stop/Reread tab. You should see the service name you specified above in this list; make sure it is highlighted and click Start Server.
  9. The Start/Stop/Reread page of the LMTOOLS dialog. This displays the available services, and you can start, stop,
    re-read the license file, force a server shutdown, and change advanced settings.

    The license server should now be running. Close the LMTOOLS dialog.

Borrowing a License (CU, SESS, and PSESS)

If you want to use a license on a computer that is intermittently connected to a license server system, that license can be issued as a floating license with specific features. This borrowed license is generated from a license server system via a special checkout, and can be used later to run an application on a computer that is no longer connected to the license server system. License borrowing must be enabled by a vendor before an end user can borrow licenses.

After you’ve generated a license key, do the following:

  1. Go to your SHOME/adm/lic/cmd (where SHOME is your base installation directory) and double-click lmtools.exe. This invokes the LMTOOLS dialog.
  2. Click the Borrowing tab, which takes you to the dialog shown below. You can set the date and time when a borrowed license should be returned, list borrowed features, and return borrowed licenses early.
  3. The Borrowing page of the LMTOOLS dialog.

To learn about other ways of borrowing licenses, see p.96 of the FLEXnet Licensing End User Guide, located in SHOME/adm/lic/cmd/LicensingEndUserGuide.pdf.

Setting the License Key Environment Variable

S-PLUS needs to know the location of the license manager server for Windows and UNIX/Linux in order to obtain a license to start up. You can set an environment variable to do this:

   IFUL_LICENSE_FILE=@server

where server is the name of the machine where the license manager is running. Setting the license key environment variable is discussed in the following section.

You can save the license key to any location on your machine, but if you do not use the default location (SHOME/adm/lic/keys), you have to set the license key variable IFUL_LICENSE_FILE as a system environment variable.

Windows

Setting the environment variable this way is typical for concurrent user (CU) licensing or if the license manager is installed on a different machine.

When starting S-PLUS for the first time, the Insightful License Fulfillment Wizard appears. When this appears, click Cancel. To set a user-defined environment variable, go to Start -> Settings -> Control Panel, and select System. Select the Advanced tab, click Environment Variables, and in the User variables field, set the IFUL_LICENSE_FILE and its associated path, as shown below.

Setting a user-defined environment variable.

If other users may be starting S-PLUS on this machine set a System environment variable.

S-PLUS should start normally. If not, check the path and make sure the license key is there. If this doesn’t work, contact Insightful Technical Support.

UNIX/Linux

The IFUL_LICENSE_FILE=@server environment variable should be added to your S-PLUS script when you run the CONFIGURE script. If it has not been added, add it:

   export IFUL_LICENSE_FILE=@server

When you run S-PLUS, a file called .flexlmrc is added to your home directory. License key information for IFUL_LICENSE_FILE, such as the name(s) of license servers on the network, is stored in this file.

Changing this_host in the license key file

If you have clients who are unable to open S-PLUS and you have already set the IFUL_LICENSE_FILE environment variable, try changing 'this_host' in the license key file to the actual server name. Restart the license server after you make this change.

Installing the License Manager on a Separate Machine

In some cases, you may want to install the license manager on a different machine than the one where S-PLUS is installed. This is typically done on networks, where a machine is dedicated to license management.

Windows

  1. On the machine where you want to install the license manager only, run FLEXnetInstall.exe from the top level of the S-PLUS 8.0 CD.
  2. This invokes the FLEXnet license manager installation wizard. Request a license key for the license manager by navigating to keys.insightful.com and entering your license authorization code (LAC). You also need the hostid of the license manager machine to fulfill your license; to find this, run

       lmhostid -vsn

    from a Command Prompt (Start -> Run, and type cmd) in the SHOME/adm/lic/cmd directory, where SHOME is your installation directory (C:\Program Files\Insightful\splus80 by default).

  3. Configure the license manager as shown in Modifying the License Manager for Concurrent User (CU) and Windows Terminal Services Users (SESS, PSESS).
  4. Install S-PLUS on your client machine(s). Set the environment variable IFUL_LICENSE_FILE as described in section Setting the License Key Environment Variable.
  5. This completes the installation, and you should now be able to run S-PLUS on one machine and the FLEXnet license manager on another.

UNIX/Linux

The FLEXNET.TZ file contains the stand-alone FLEXnet license manager. The steps to unpack this tar file and install it on your network follows:

  1. Make a directory for unpacking the distribution and cd to it:

       mkdir flextest
       cd flextest

  2. As either a regular user (yourself or splus) or as root, unpack the tar file from the CD-ROM into the new directory using tar as follows:

       cat /[mount_point]/FLEXNET.TZ | uncompress | tar xvf -

    where [mount_point] is the absolute path to the CD-ROM drive. If your system has the zcat command, you can use it to shorten your extraction command (zcat combines the cat and uncompress commands):

       zcat /[mount_point]/FLEXNET.TZ | tar xvf -

  3. Find your server hostid by running lmhostid. Copy this hostid.
  4. Go to keys.insightful.com, type your license authorization code (LAC), and click Login.
  5. Click Generate Licenses.
  6. Paste your server hostid (from Step 3.) in Node-locked Hostid, and enter the appropriate license type in Node-locked Hostid Type: If your hostid provided by the ./HOSTINFO script is eight (8) characters long, select Long. If it is 12 characters, select Ethernet. Click Generate.
  7. Save the license key to the directory you created in the first step. For example,

       /homes/username/flextest/license_123.lic.

  8. Navigate to your FLEXHOME directory (the location of the FLEX license manager). Run the lmgrd utility to run the license manager:

       ./lmgrd -c /homes/username/flextest/license_123.lic

If you are having difficulty obtaining licenses after installing your license manager, try setting an environmental variable:

   setenv IFUL_LICENSE_FILE @denny

Go to the Setting the License Key Environment Variable if you have any questions.