Install a floating license
In this chapter, you will find out how to install floating licenses in the Ranorex License Manager on server machines with or without an internet connection. Also, find out how to install the Ranorex License Manager, which manages floating licenses, about the different types of floating licenses, and how to connect client machines to the server machine so they can lease floating licenses.
In this chapter
Ranorex License Manager
Use Ranorex License Manager to install and manage floating licenses. The machine that has Ranorex License Manager installed acts as a license server. It automatically distributes and revokes floating licenses to and from client machines. That is why you need to install the License Manager on a machine that can be reached through the network by all machines you want to use a floating license on.
In the Licensing chapter, the server machine is “the server” and the client machines are “the client(s)”.
Install the Ranorex License Manager
Normally, the Ranorex License Manager is installed automatically when you install Ranorex Studio on a machine. However, if you do not want to install Ranorex Studio on the server, you can also install only the License Manager.
When you buy a floating license, you will receive an email with instructions. It also contains a download link for the License Manager.
To install only the License Manager:
From the link in the email for your floating license, download the License Manager to the server.
Install the License Manager following the instructions in the installation wizard.
C++ libraries will be installed if not already present on the server and the server may have to be restarted during the installation.
- Always install the latest version of the License Manager
- The License Manager works with networks based on IPv4, IPv6, and a mix between them.
- Port 7266 TCP/UDP must be open.
After the installation, the License Manager starts:
In rare cases, the Windows service (Windows Task Manager > Services) for the License Manager may not be started. In this case, the License Manager will display the following error message and won’t work.
Error message in the Ranorex License Manager
Windows Task Manager showing the stopped RanorexLicenseService
The service may trigger a false positive in some anti-virus programs, causing them to deactivate the service.
Restart the service in the Windows Task Manager. If it still doesn’t work, reinstall the License Manager. If the problem persists, please contact [email protected].
Install with internet connection
Before you can use a floating license, it needs to be installed in the Ranorex License Manager on your server. This way, it is registered and authenticated by the Ranorex License Authentication Server. (The Ranorex License Authentication Server is not the server for your client machines; it’s a Ranorex company server.)
To install floating licenses:
Under Install licenses, paste the license key(s) you received by email.
Click Install license(s).
The floating license(s) appear in the list of installed licenses. This means they have been authenticated by the Ranorex License Authentication Server and installation is complete.
Install without internet connection
If you try to install a license and the server isn’t connected to the internet, the following error message will appear:
In this case, do the following:
On a machine with an internet connection, go to http://auth.ranorex.com/license/.
Under License Key, enter your license key.
Under Machine Name, enter the machine name of your server.
Click Authenticate and confirm the machine name of your server.
The Ranorex License Authentication Server creates an authenticated license file based on your data. You need to download this file and transfer it to the offline machine.
Click Download Authenticated License File and transfer the downloaded file to the offline machine, e.g. using a USB stick.
In the License Manager, click Load license….
Browse to the authenticated license file.
Click OK. The license appears under the installed floating licenses.
Once the license has been installed and authenticated on the server, clients can lease it. The server doesn’t have to be connected to the internet for normal operation. (It must be connected to the same network as the clients, however.)
Configure a client
Once you’ve installed a floating license on the server, you need to configure the clients so they can lease the license.
Make sure the client is connected to the same network as the server and can access it.
To configure a client:
On the client, open Ranorex Studio.
Go to Help > Licensing. The license configuration dialog opens.
Under Server, enter the machine name or IP address of your server, or click the Refresh icon to see a list of machines with installed Ranorex License Managers in the network.
The other fields are configured automatically.
Click this button to reset all fields. Useful if you also have a node-locked license installed on the machine and want to use only it.
There are three types of floating licenses: Runtime, Professional, and Premium.
When configuring a client, you can use the Type drop-down menu to specify the type of license you want this client to use. For example, if you plan to only run tests on this client, then Runtime would suffice. However, we recommend you leave Type on Auto.
The client automatically requests the correct license for the current operation from the server.
The client can only request a Runtime Floating License. This license type is limited to running tests via an Agent, the command line, or the Ranorex Test Suite Runner.
The client can only request a Professional Floating License. This license types is limited to Runtime Floating operations and using Ranorex Spy and tracking.
The client can only request a Premium Floating License. This license type has no limitations and is required for using the full functionality of Ranorex Studio, e.g. starting it, recording tests, or editing test suites (including through the API).
How license leasing works
Leasing works based on what you’re doing in Ranorex Studio or one of its tools. For example, simply starting Ranorex Studio triggers the lease of a Premium Floating License. Running a test on a Ranorex Agent, on the other hand, triggers the lease of a Runtime Floating License, but if that isn’t available, it can also use a Premium Floating License. To see what the different license types allow, see License types above.
When a client has leased a license from the server, the license becomes unavailable to other clients. After the triggering operation is finished (e.g. the test run has finished, Ranorex Studio is closed), the client returns the license to the server and it’s available to other clients again.
If a floating license can’t be returned to the server because of a network error, it will be blocked for 5 minutes, meaning it’s completely unavailable for lease during that time. We therefore strongly recommend a stable network infrastructure.
The License Manager shows that the Premium Floating License is currently leased and therefore unavailable to other clients.
Under Clients, you can see the machine name and user who’s leasing the license.