Setting up the Rational Common Licensing token service keys

Set up the Rational® Common Licensing token service key on a Jazz® Team Server.

Before you begin

Verify the following items:

For more details about token licensing, contact your local IBM marketing representative.

Note: The Rational License Key Server does not run on IBM i, Linux for System z, or z/OS. If you use Rational common licensing, you need to set up a separate Jazz Team Server on any other supported platform and connect it to the Common Licensing token server to manage your token licenses. You can then use this Jazz Team Server as a floating license key server for your Jazz Team Server running on IBM i, Linux for System z, or z/OS.

About this task

The Rational Common Licensing Token Service is an extension of the Jazz Team Server that allows token requests to be forwarded to a Rational License Key Server. When the Jazz Team Server requests a certain number of tokens, the extension checks out the tokens from a Rational License Key Server. This integration allows Jazz-based products and non-Jazz based products to share the same tokens.
Note: This integration is only available for IBM Rational products.


  1. If you are using IBM i, Linux for System Z, or z/OS, install a Jazz Team Server and Rational License Key Server on a supported platform. For more information on installing Jazz Team Server, see the interactive install guide. In the topic Running the setup wizard, note the following changes:
    1. Disable email notification.
      You will have no installed applications on this Jazz Team Server.
    2. Do not register any additional applications.
      You will only be using this Jazz Team Server as a floating license server.
  2. Configure Rational License Key Server:
    1. Launch the License Key Administrator.
    2. Download the license.dat file that contains tokens from the License Key Center.
    3. In the License Key Administrator, click License Keys > Import License Key(s).
    4. Select the license.dat file.
    5. Stop and restart the License Key Server. You will be prompted to do this after importing the license.dat file.
    6. Close the License Key Administrator.
  3. Install the token client access licenses on your Jazz Team Server:
    1. Extract the file to a temporary location on your drive.
    2. Log in to the Administration page of the Jazz Team Server. Point your web browser to https://[fully qualified hostname]:9443/jts/admin
      Remember: The [fully qualified hostname] is the host name along with the DNS domain reference of the machine on which the Jazz Team Server is installed.
    3. On the Administration page, click the Server tab.
    4. In the Licensing section, click License Key management.
    5. Scroll down to the Floating License Server section.
    6. In the Floating License Server section, click Add.
    7. In the Upload License Files window, click Choose File and browse for the temporary location that you extracted the file and choose one of the license .jar files.
    8. Click Finish.
      You must accept the license agreement for each license that you upload.
    9. Repeat steps g. and h. to upload other license files.
      After the license keys have been uploaded, you will see the licenses listed under the Floating License Server section.
  4. Enable the token license service on your Jazz Team Server:
    1. Hover over IBM Rational Common Licensing Service until you see the Configure floating license server icon in the Actions column. Click the icon to view the server configuration dialog.
    2. Configure the following two properties in the dialog:
      1. IBM Rational License Key Server: Provide the URL (in the format license_key_port_number@license_key_hostname) for the IBM Rational License Key Server you installed.
        Tip: In the License Key Administrator application, click License Keys > Host Data to display identification information for the server. You can also run the LMTOOLS program (located at License_Key_Server_install_directory/common) and click Status > Perform Status Inquiry to verify the connection information).
      2. Token Lease Timeout: Specify how long (in milliseconds) a user can be inactive before the token lease expires.
    3. Click Finish.
      If the connection succeeds, you'll see a green checkmark (green check icon) in the Status column.
    4. To clear the settings, click the Edit icon again. Clear the hostname field and enter 1800000 in the timeout field. Click Finish.
      Note: The default timeout for token license is 1800000 milliseconds (30 minutes) and the default timeout for floating license is 3600 seconds (60 minutes). The minimum amount of time that can be set for both token and floating licenses timeout is 30 minutes, 1800000 milliseconds for token and 1800 seconds for floating. Note that the timeout is measured differently for these licenses. Token license timeout is measured in milliseconds and floating license timeout is measured in seconds.
  5. Optional: Configure other Jazz Team Servers to point to the floating license server:
    1. Before you can configure your Jazz Team Server to point to a floating licensing server, you must add friend relationship between the two servers and create a functional user ID that is associated with the friend operation. You can use the -createFriend repotools command to create the friend relationship and associate a functional user ID. For more information about the usage of the repotools command, see Repository tools command to create a friend relationship.
    2. On the Administration page of the Jazz Team Server, click the Server tab.
    3. In the Licensing pane, click License Key Management.
    4. In the Server Information section, hover over the Floating License Server row and click the Configure floating license server icon.
    5. In the Configure Floating License Server dialog box, in the Floating License Server field, type the path to the server. For example, http://floating-license-server:9443/jts, where floating-license-server must be replaced with the fully qualified host name of your server.
    6. To test the server connection, click Test Connection.
    7. Click Finish.

What to do next

For users to participate in the pool of Token licenses, you must assign users one of the Token license types. For more information on assigning licenses, see Assigning client access licenses to users or Assigning default licenses to new users.