Applies to ReadyAPI 3.0, last modified on November 15, 2019

Floating License Server is needed to control and activate ReadyAPI floating licenses. To configure the license server, perform the following steps:

  1. Get a license file.

  2. Install the license server.

  3. Connect to the license server.

  4. Install the license and assign it to users.

Note: If you have a working license server and you need to adjust it, skip the beginning of the guide and start with connecting to the server.

If you installed the license server before June 6, 2018, you need to make sure that your license server is up-to-date.

About

To control floating licenses, ReadyAPI uses Protection! Licensing Server.

This server can be installed on any network machine. It does not require specific hardware to function, unless you have a very large number of licenses to control.

When you run the license server on a headless machine, use the Licensing Server Management Console to configure it.

1. Get a license file

You need to have a license file at hand when installing and configuring the license server. To get this file, please contact the SmartBear Sales Team. The license key includes encoded information on the IP address of the license server computer and the port number it will use to handle license requests. Please be ready to provide this information to the Sales Team when requesting a license. By default, the server will use port 1099. If you cannot use this port on the server computer for some reason, choose another available port.

We will then send you a license file, which you will need to install in the Licensing Server Management Console. See below.

Important notes:

  • Licenses are tied to a specific IP address and port of the license server. You cannot activate your license on a different server. To have several license servers, you will need an individual license file for each server.

  • The proxies and firewalls running in your network should allow access to the license server at the specified IP address and port ( by default, 1099).

  • We recommend that you have one license per tool (SoapUI, LoadUI, ServiceV, and VirtServer) on your license server. If you want to increase the number of seats, use a supplemental license rather than installing one more license. This will help you manage license usage easily. To get a supplemental license, contact your sales representative or write to sales@smartbear.com.

2. Install Protection! Licensing Server

2.1. Install Java

The Protection! Licensing Server software requires the Java runtime environment:

  1. Download the latest Java 8 version. You can do this on the following web site:

    http://www.java.com/en/download/manual.jsp

    We do not support other Java versions (Java 9 and later).

  2. Install it on the computer where you will install Protection! License Server.

2.2. Install Protection! Licensing Server

After you install Java on the server computer, you can install Protection! Licensing Server. Follow the steps below.

Note: The license server installation includes the License Management Console that is needed for managing licenses.
  1. Make sure your computer meets the Licensing Server requirements.

  2. Download Protection! Licensing Server:

      Windows Linux macOS
    32-bit Win Linux macOS
    64-bit Win
    By downloading our software, you agree to our terms of use and privacy policy.
  3. Run the downloaded installer and follow the installation wizard instructions.

You need to configure the license server settings before using it. See below.

3. Connecting to the license server

To configure the license server, connect to it by using the Protection! License Management Console. If you configure a license server for the first time, follow these steps:

  1. Open ports on the license server, if needed.

  2. Create a connection.

  3. Connect to the license server.

3.1. Open ports

By default, the license server uses the following ports:

Port Description
1099

The license server uses this port to handle license requests. You specified this port when requesting the license.

The license is bound to this port number. If you want to change this port, you will have to request another license file.

10991

Another port that the license server uses by default for license requests. If needed, you can change the port number in the license server settings.

9998 and 9999

The Protection! License Management Console uses these ports to communicate with the license server. If needed, you can select some other ports in the license server settings.

Make sure that your firewalls and proxies allow connecting to the license server through these ports. Quite often, these ports are already open.

If you are not sure whether these ports are open, or if you need assistance with configuring your proxies, please ask your system administrators for help. You will need to restart the license server to apply the changes you have made. For information on how to specify other ports, please see Protection! License Server Administrator Guide (pdf).

3.2. Create a connection

  1. Start the Protection! Management Console.

    You are asked to create a connection:

    New Connection dialog

    Click the image to enlarge it.

  2. Specify the collection parameters:

    • Enter the server Name and (optionally) Description.

    • Enter the Server Address.

      The Management Console can configure license servers working on most other computers, including those headless.

      Note: If the Management Console and the license server are on the same machine, leave localhost in this field.
    • Enter a Port number (the default is 9999).

    • Enter a Login and a Password.

      Note: Default credentials are –
      Login: admin
      Password: {empty}
    • Click OK.

You can change the credentials in the Management Console later.

3.3. Connect to the license server

  1. In the server Management Console, switch to the Summary view:

    Console: Summary view

    Click the image to enlarge it.

  2. Click Connect to connect to the server.

    You will see summary statistics for the server:

    Console: Summary view after connecting

    Click the image to enlarge it.

4. Install the license

  1. Install the license file.

  2. Assign the license to users.

    Important: You must assign a license to at least one user or a user group. Otherwise, nobody will be able to use the license.

4.1. Install the license file

  1. If you received the license file in a .zip archive, extract it from the archive to a directory on your computer.

  2. In the server Management Console, switch to the Summary view:

    Console: Summary view

    Click the image to enlarge it.

  3. Click Connect to connect to the server.

    You will see summary statistics for the server:

    Console: Summary view after connecting

    Click the image to enlarge it.

  4. In the menu on the left, select License Storage. Then select File > Import Licenses from the main menu:

    Console: Selecting Import Licenses from the menu

    Click the image to enlarge it.

  5. In the subsequent Open File dialog, select the license file you received from SmartBear and click Open:

    Note: If you received a .zip file from SmartBear, then, in the dialog, you need to specify the extracted license file.
    Selecting the license file

    Click the image to enlarge it.

    This will install the license on the server computer.

4.2. Assign the license to users

To provide users with access to the license, you need to assign the installed license to users. The easiest way to do that is to assign the license to the Everyone user group that is available by default. This will make the license available to all the users who connect to your license server.

If you need more control, you can assign the license to an individual user or user group that you create on the license server. You can also assign the license to users from an LDAP server (Lightweight Directory Access Protocol) that is available in your network. See Managing Users and Groups for complete information.

To assign the license to users:

  1. Select the license file from the License Entries list, then click Add User on the Allocation tab toolbar on the right:

    Console: Adding a user

    Click the image to enlarge it.

  2. The following dialog will appear:

    Console: Add Users/Groups dialog

    Click the image to enlarge it.

  3. Select the desired group and click OK.

Note: You can examine the configuration of the assigned user or group by double-clicking it. For example, the Everyone group has the following configuration:
Granting permissions to all users

Click the image to enlarge it.

Now, the selected license will be available to the specified users in the network.

The license server is now installed and configured to control the licenses.

Verify that your license server is up-to-date

Protection! License Server requires a license for functioning. This is a license for the server itself, not for ReadyAPI. The license file is included in the installation package.

If you installed the license server before June 6, 2018 and you have not updated its license, it will expire soon. In this case, you need to make sure you have the latest license file. You can also update the license right away.

Should my license be updated?

To make sure you have the latest license file, do the following:

  1. Download the License Manager package from the SmartBear website.

    Note: The License Manager requires Java 8 (JRE 1.8.x.x).
  2. Unpack and run the License Manager with the -o parameter that specifies the path to the bin folder of the license server installation:

    <Java>/bin/java.exe -jar ready-api-license-manager-1.2.7.jar -o <ProtectionLS>/bin

  3. Possible messages:

    Message Description
    You are using the latest license There is no need to update the license file.
    Your license needs to be updated You need to update the license file.
    License file was not found The license manager could not find the license file. Make sure you specified the correct path to the license server.

We assume the computer, where the license server is installed, is connected to the Internet. If it is not, please see the corresponding instructions below.

To get the updated license file:

  1. Unpack and run the License Manager with the -u parameter that specifies the path to the bin folder of the license server installation:

    <Java>/bin/java.exe -jar ready-api-license-manager-1.2.7.jar -u <ProtectionLS>/bin

    If you use a proxy server, specify the http.proxyHost and http.proxyPort system properties:

    <Java>/bin/java.exe -Dhttp.proxyHost=proxy-address
    -Dhttp.proxyPort=proxy-port
    -jar ready-api-license-manager-1.2.7.jar -u <ProtectionLS>/bin

    For Windows users: if your license server is installed in the Program Files directory, you may need administrative privileges.

  2. Restart the license server.

If the license server computer is not connected to the Internet, you will need to find an intermediate machine with Internet connection to download the license file:

  1. On the intermediate computer:

    • Download the License Manager .jar file from the SmartBear website, and

    • Run this .jar to download the license file to some folder on the intermediate machine:

      <Java>/bin/java.exe -jar ready-api-license-manager-1.2.7.jar -u <some-folder>

      If needed, specify the proxy address and port (see above).

  2. Copy the downloaded license file (ProtectionLS.license) to your license server computer to the <ProtectionLS>/bin folder.

    You must replace the existing license file. You can create a backup of the existing file, if needed.
  3. Restart the license server.

Advanced server settings

In some cases, you may experience issues when connecting to the license server. It may happen when you, for example, access the server from a different domain. To fix this issue, you need to specify the host name explicitly:

  1. Open the bin/server.xml file in the license server installation folder.

  2. Specify the name of the server computer to the hostName attribute of the server element. For example:

    XML

    <server hostName="licenseserver" port="1099" exportPort="10991" mgmtPort="9999" mgmtExportPort="9998" allowRestart="false">
    ...

    Save the file.

  3. Restart the license server.

Restart the license server

If you need to restart the license server, do the following:

  1. Open Control Panel.

  2. Select System and Security > Administrative Tools.

  3. Open the Services utility.

  4. Right-click the ProtectionLS service and select Restart.

  1. Open a terminal and set the working directory to the bin directory of the license server installation.

  2. Run the following command:

    ProtectionLS restart

Next steps

Once you activate a floating license on your server, you need to check out (that is, consume) the license on the computers where you will use it. See Applying Floating Licenses.

More information

For more information on managing your licenses and license user groups, see the Protection! License Server Administrator Guide (pdf).

See Also

Floating License Activation
License Server - System Requirements
Managing Users and Groups
Possible Issues With Floating Licenses

Highlight search results