Licensing eggplant Functional

Published on Documentation (http://docs.testplant.com) Home > Getting Started > Licensing Licensing Licensing eggplant Functional To run eggplant Functional on your machine, you must license it. If you need to purchase licenses, please contact your account manager or sales@testplant.com [1]. You can also request a free trial license by visiting the TestPlant website [2]. Licensing Options TestPlant offers two licensing options: a node-locked license and a team license. A node-locked license is one that is tied to a specific workstation. In other words, it's essentially a single-user license, although it's tied to the machine, not the user. This licensing model is appropriate when you'll install and use the software always on the same machine or machines. A team license, also known as a floating license, allows you a certain number of users to run the software concurrently on any machine. The number of instances of eggplant Functional that you can run at any one time is dictated by your license terms. This model is useful for large testing teams and for when users might need to use eggplant Functional from different machines periodically. With team licenses, you install and run the Team License Server (TLS), which is itself node locked, and the TLS tracks how many licenses you have available and whether a user is granted a license when they launch eggplant Functional. For more information about team licenses, see About Team Licenses [3]. greenhouse greenhouse is TestPlant's web-based license management system. All customers are given a login to the greenhouse portal, where you can review and create available licenses and perform other license management tasks for your account. You can also use this portal to submit questions to support and view information about any support cases. You should receive your initial greenhouse login information from your account manager. If you've lost or forgotten your password for the greenhouse site, you can use the link on the login page to have a password resent to you. If you don't have a password, you'll need to contact your account manager or sales@testplant.com [1]. Before you launch eggplant Functional for the first time, you can log in to your greenhouse account and generate an eggplant Functional license [4]. Note that you need your Host ID to create a license in greenhouse. However, it's not necessary to generate a license beforehand as you'll have the option to do so when you launch the application as well. There are two ways to generate eggplant Functional licenses: 1. Generate the licenses through eggplant Functional, as described in the next section. 2. Generate the licenses directly in greenhouse and license manually. See Generating Node-Locked Licenses [5] or Generating Team (Floating) Licenses [6] for more information on this method. Step-by-Step: Licensing eggplant Functional The first time you launch eggplant Functional, you must enter a license key. You'll be presented with a licensing splash screen with several options to either enter or generate your license key: 1

You must enter a license key to run eggplant Functional If you have already generated your license key and username in greenhouse, follow these steps: 1. Enter the Key and User Name from greenhouse in the appropriate fields of the licensing screen. 2. Click Add. If you haven't generated a license key, you can use your greenhouse login credentials to let eggplant Functional retrieve a license for you by following these steps: 1. Click the GreenHouse button on the licensing screen. 2. Enter the Customer Email and Password for your greenhouse account in the appropriate fields. 3. Click Fetch License Info. You should see a message that tells you license information is being retrieved from the TestPlant server. This process can take a few minutes. 4. If multiple licenses are available for your account, you'll be presented with a dialog box that lets you choose which to install on this machine. When you've selected the appropriate license from the list, click Install. From the licensing splash screen, you can click License Panel to go to the full eggplant License Registry panel, described below. To read the licensing agreement, from the eggplant Functional menu, select eggplant > Licenses. By running eggplant Functional, you are agreeing to the terms of the licensing agreement. The eggplant License Registry Panel When you launch eggplant Functional, the license registry checks to make sure there is a license available. The eggplant License Registry panel displays information about the eggplant Functional licenses available and in use on your network. This panel also provides you several license management options: 2

License management options are available in the eggplant License Registry panel 1. Licenses Currently In Use: This section displays information about any licenses currently in use on your network. 2. Licenses Found: This section displays information about the licenses found on the current machine. 3. Free Trial: Use this button to visit the TestPlant website to request a trial license for eggplant Functional. 4. GreenHouse: This button takes you to the greenhouse login page on the web. 5. Remove: Use this button to remove licenses. Select the license in the Licenses Found list, then click Remove. Note: You can not remove a license that is currently in use. 6. Add License: Use this section to add a license that has already been generated through greenhouse. Enter the Key and User Name, then click Add. Note that you can also view your machine's Host ID here; if you plan to visit the greenhouse site to generate keys, you can right-click to copy the Host ID, which you'll need to have to generate keys. 7. Retrieve License from greenhouse: Use this button to retrieve licenses from greenhouse automatically. You'll need your credentials (email address and password) for your greenhouse account. 8. Licenser Host: Use this field to enter the IP address or hostname of the TLS, if necessary. Note that you need to enter this information only if your local machine is on a different subnet from your TLS. See Port Configuration [7] for more information about environments of this type. Sharing a License Between User Accounts Mac OS X and Linux By default, your eggplant Functional license is stored in the /Library/Eggplant directory, which is accessible to all user accounts. However, if the user who installs eggplant Functional does not have permission to write to that directory, the license is stored in the user s own Library directory. To make the license accessible to all users, someone with the appropriate permissions must move the license to /Library/Eggplant. Windows By default, your eggplant Functional license is stored in the C:\Library\Eggplant directory, which is accessible to all user accounts. However, if the user who installs eggplant Functional does not have permission to write to that directory, the license is stored in the user s own Library directory. To make the license accessible to all users, someone with the appropriate permissions must move the license to C:\Library\Eggplant. Note: The eggplant Functional Preferences are stored by individual user account on the eggplant Functional computer. 3

Generating Node-Locked Licenses Generating Node-Locked Licenses for eggplant Functional To generate licenses for eggplant Functional, you will need to access your account on the greenhouse [8] license management portal. You can access greenhouse either directly through your web browser or through the eggplant License Registry panel [9] within eggplant Functional. Step by Step: Generating Node-Locked Licenses Follow these steps to create a node-locked license: 1. You will need: Your log in credentials for greenhouse. If you don't have this information, contact your account manager or sales@testplant.com [1]. Your Host ID for the machine on which you intend to run eggplant Functional. Remember that a node-locked license will be tied to a single machine or workstation. To find your Host ID, launch an unlicensed copy of eggplant Functional on that machine. The Host ID appears on the licensing splash screen, as shown below: The licensing splash screen displays your Host ID Copy the Host ID to your clipboard before going to the next step. Note that you can also find the Host ID on the eggplant License Registry panel, as shown in Licensing [9]. 2. Log in to your greenhouse account. The "Licenses" page in greenhouse shows both the Unused Licenses and Active Licenses for your account. New or unused licenses will show "-not created-" in the Key column instead of an actual license key. The Product column indicates both the platform the license is for and whether it's "Node-Locked" or "Floating" (team). 3. Choose the appropriate license in the list, then select Generate from the drop-down list in the Actions column. [10] Generate your license key from greenhouse (Click image to view larger) 4. On the Generate License Key page, enter the Host ID of the machine where the eggplant Functional license will be installed. Note that if you copied the Host ID to your clipboard previously, you can Paste (Ctrl+V for Windows, Cmd+V for Mac) that value into the Host ID field. 4

Enter your Host ID, then click Generate License Key 5. Click Generate License Key The license key will be displayed on the form after it is generated, and it will be emailed to you. You will also be able to see it on the "Licenses" page in greenhouse, along with its associated User Name. You will need to enter the User Name and the Key value into eggplant Functional to complete your licensing, as described in Licensing eggplant Functional [11]. Generating Team Licenses Generating Team (Floating) Licenses for eggplant Functional To generate licenses for eggplant Functional, you will need to access your account on the greenhouse [8] license management portal. You can access greenhouse either directly through your web browser or through the eggplant License Registry panel [9] within eggplant Functional. For team licenses, you must run the eggplant Functional Team License Server (TLS), which is licensed to a specific machine via a node-locked license. When the TLS is running in your environment, you can install and run the eggplant Functional application on other machines; each machine on which you will run eggplant Functional must have a license entered on it, which is a team or floating license. A more detailed description of this configuration can be found in About Team Licenses [3]. Setting up your environment to run with team licenses is a two-stage process: 1. Install and license the Team License Server (TLS). 2. Generate the eggplant Functional team license and install it on other machines or workstations as needed. Step by Step: Licensing the TLS Detailed information about installing the TLS can be found in Installing and Licensing the TLS [12]. Note that for Windows and Linux, the TLS is installed automatically when you install eggplant Functional; on the Mac, the TLS is in the Utilities folder of the eggplant Functional installation disk image and must be added to the Applications folder manually. Make sure the TLS is installed on the machine on which you want it to run, then follow these steps to license it: 1. You will need: Your log in credentials for greenhouse. If you don't have this information, contact your account manager or sales@testplant.com [1]. Your Host ID for the machine on which you intend to run the TLS. Remember that the TLS requires a nodelocked license, which must be tied to a single machine or workstation. To find your Host ID, launch the unlicensed version of the TLS. The Host ID appears on the licensing splash screen, as shown below: 5

The licensing splash screen displays your Host ID Copy the Host ID to your clipboard before going to the next step. 2. Log in to your greenhouse account. The "Licenses" page in greenhouse shows both the Unused Licenses and Active Licenses for your account. New or unused licenses will show "-not created-" in the Key column instead of an actual license key. The Product column indicates both the platform the license is for and whether it's "Node-Locked" or "Floating" (team). 3. Choose the Team License Server license in the list, then select Generate from the drop-down list in the Actions column. [13] Generate the license for your TLS (Click image to view larger) 4. On the "Generate License Key" page, enter the Host ID of the machine where the TLS license will be installed. Note that if you copied the Host ID to your clipboard previously, you can Paste (Ctrl+V for Windows, Cmd+V for Mac) that value into the Host ID field. Enter your Host ID, then click Generate License Key 5. Click Generate License Key. The license key will be displayed on the form after it is generated, and it will be emailed to you. You will also be able to see it on the "Licenses" page in greenhouse. 6. Enter the Key and User Name values into the licensing splash screen of the TLS to complete your licensing. Be sure to enter both values exactly as they are displayed in greenhouse with no spaces either before or after either value. 7. Click Add on the licensing splash screen to complete the licensing of the Team License Server. Step by Step: Generating the Team License for eggplant Functional 6

After the TLS is installed and licensed, you can create the eggplant Functional floating application license (team license) and tie it to the server. For this stage, you do not need a host ID or any information from the computer or computers that will run eggplant Functional. Follow these steps to generate a team license: 1. In the greenhouse portal, locate the appropriate "Floating" license in the list, then select Generate from the dropdown list in the Actions column. [14] Generate your license key from greenhouse (Click image to view larger) 2. On the "Generate License Key" page, select the appropriate Team License Server from the drop-down list for License Server. If you have only one TLS in your environment, this field will contain only one value. If you have installed more than one TLS, you might want to tie your team license to a server other than the default. 3. Click Generate License Key to generate the new key. Select the appropriate TLS, then click Generate License Key The license key will be displayed on the form after it is generated, and it will be emailed to you. You will also be able to see it on the "Licenses" page in greenhouse. You can use this Key and User Name pair to license eggplant Functional on any machine where you want to run the application, as described in Licensing eggplant Functional [11]. The TLS governs how many instances of eggplant Functional you can launch concurrently with your team license, based on your licensing terms. For more information on licensing eggplant Functional with your team licenses, visit Installing and Licensing the TLS [12] in About Team Licenses [3]. About Team Licenses About Team Licenses This post describes a basic team license configuration for eggplant Functional and the Team License Server set up process. To learn about license generation, please see Generating eggplant Functional Licenses. [15] What Are Team Licenses? Team licenses allow you to run multiple instances of eggplant Functional concurrently in a flexible "team" environment. The number of instances you can run at any given time is dictated by your licensing terms. If you have a 3-user team license, for instance, you can run three copies of eggplant Functional at the same time, but the machines that run the eggplant Functional application can vary. With this model, you can share eggplant Functional licenses within your team; 7

hence the term team license. How Team Licenses Work There are two license keys involved in the eggplant Functional team license setup: The Team License Server (TLS) key: The TLS is installed on a single machine and requires a node-locked license (i.e., it must always run on the same machine where it is licensed). The eggplant Functional team license key: This key is a floating or non-node-locked license that can be installed on as many machines as desired. You need to install it on every machine where your team runs eggplant Functional. Each team license has a designated number of users. For instance, if you purchase an eggplant Functional team license set up with three users, only three computers would be allowed to use eggplant Functional at the same time, even if there were a hundred computers that had that eggplant Functional team license installed. You manage and generate license keys in greenhouse [8], TestPlant's web-based license management system. All customers are given a login to greenhouse to access their account, review and create licenses, and submit questions to support (questions can also be sent via email or through the eggplant Functional application itself). If you don't have login credentials, you'll need to contact your account manager or sales@testplant.com [1]. On the "Licenses" page in greenhouse, you'll see a list of both Unused Licenses and Active Licenses. New licenses appear in the top section, Unused Licenses. For information on how to generate a license key and license the TLS and eggplant Functional, see Generating Team Licenses [6]. After you've generated the license key, it appears in the Active Licenses section: [16] Team Licenses in greenhouse (click image for larger view) In the image above, the TLS license is boxed in purple. The license key for the server (also boxed in purple) is shown in the Key column. You enter the TLS key on only one machine. The eggplant Functional team license is boxed in red in the image. greenhouse refers to the license as "eggplant for Windows+Mobile - Floating" in the example; the license always indicates the platform it's designated for. "Floating" specifies this as a team license; therefore, this key can be entered on any number of machines that might want to run the eggplant Functional application. The number of instances available for concurrent or simultaneous use in this example is 2, which is boxed in yellow. Note, however, that you can license more than two machines with this key. In fact, you can install eggplant Functional with the same team license on as many machines as necessary. The TLS governs how many instances can run at any given time, which in this example would be no more than 2. An Example Team License Setup The image below provides a visual for what an actual team license environment might look like: 8

An example team license setup with a single-user team license The diagram shows a team license setup where the team license allows only one connection. Therefore, if one computer is using the eggplant Functional application, any other computers that try to access it will be denied. The configuration of a multiple-user license setup will naturally be more complex, but it would use the same principle setup. As can be seen, each computer that has the eggplant Functional team license installed on it can ask the TLS for use of the application; if there is an unused license available, the server allows that computer to run eggplant Functional. Port Configuration Port Configuration All communication between the Team License Server and eggplant Functional Floating Licenses takes place on UDP port 5538. Make sure that both machines are accepting two-way communication on that port, and that the port is not being used by any other processes. If any of the eggplant Functional Machines are on a different subnet than the Team License Server (this can be determined by looking at the IP addresses of the different machines) then some extra configuration is required. You must specify the external IP address of the Team License Server Machine in the Licenser Host field of the "eggplant License Registry" panel. This must be done on every eggplant Functional machine that is on a different subnet. 9

The Licenser Host Field Depending on the network configuration, it may also be necessary to configure port forwarding of UDP port 5538, which is something that normally has to be undertaken by a network administrator. We cannot provide specific details on how to perform this configuration, because it is dependent on network topology and the specific network hardware in use. Installing and Licensing the TLS Installing and Licensing the TLS Before Installation Generate a License Before installing the Team License Server, you will need to generate the license for it. Visit Generating Team Licenses [6] for more information. If You Are Updating If you have previously installed the TLS and you are updating it, please make sure that it is not running before attempting to download and install a new version. Step-by-Step: Installing and Licensing the TLS Please find instructions below for installing and licensing the TLS on all platforms: On Mac Mac [17] Windows [18] Linux [19] The first step of the Team License Server installation process is to download eggplant Functional from the downloads 10

page of our website here [20]. When you first download eggplant Functional, open the.dmg package. You will see this in the Finder: The eggplant Functional Installation Package on Mac To install the TLS, open the Utilities folder and drag the TeamLicenseServer.apk (shown below) to the Applications folder and launch it. The Team License Server Application File on Mac You will be presented with the Team License Server license panel. You are given three options on this panel: to enter the license key and username (boxed in blue below), to enter the login credentials to your team's GreenHouse account (boxed in orange), or to show the license panel and license later (boxed in purple). 11

The Team License Server License Panel on Mac Once you have licensed the Team License Server, the below panel will pop up, displaying the Server information. The Team License Server on Mac The below area labeled "eggplant Team Licenses in Use" is a live update of all instances of eggplant Functional associated with the Team License Server that are actively being used. On Windows The first step of the Team License Server installation process is to download eggplant Functional from the downloads page of our website here [20]. When you first download eggplant Functional, open the.exe package and follow the installation instructions provided. 12

The Team License Server will already be available through your file system in: C:Program Files (x86)eggplant To license it, launch the Team License Server from this location. You will be presented with the Team License Server license panel. You are given three options on this panel: to enter the license key and username (boxed in blue below), to enter the login credentials to your team's GreenHouse account (boxed in orange), or to show the license panel and license later (boxed in purple). The Team License Server License Panel on Windows Once you have licensed the Team License Server, the below panel will pop up, displaying the Server information. The Team License Server on Windows 13

On Linux This process will vary some between variations of Linux. The first step of the Team License Server installation process is to download eggplant Functional from the downloads page of our website here [20]. Installation notes are included in the eggplant Functional download for Linux, which can be referenced. This file is called "InstallNotes". There are two routes that can be taken to install eggplant Functional on Linux. The first is to install eggplant Functional through your distribution package manager. The second is to install via the command line, by calling the package manager. To launch the Team License Server on Linux, use the following command line call: efls You will be presented with the Team License Server license panel. You are given three options on this panel: to enter the license key and username (boxed in blue below), to enter the login credentials to your team's GreenHouse account (boxed in orange), or to show the license panel and license later (boxed in purple). The Team License Server License Panel on Linux Once you have licensed the Team License Server, the below panel will pop up, displaying the Server information. 14

The Team License Server on Linux Running the TLS as a Service Running the TLS as a Service The Team License Server (TLS) can be run as a service on Windows. Before Running the TLS as a Service If you have just installed the TLS on your machine, or if you have used it previously and are now setting it up to run as a service, please make sure to quit the process. The TLS cannot be run as a service if it is already running. Step-by-Step: Running the TLS as a Service To run the Team License Server as a service on Windows, please follow the instructions below. 1. Run the "InstallTeamLicenseService" batch file found in one of the following locations: C:\Program Files (x86)\eggplant\installteamlicenseservice.bat 15

C:\Program Files\Eggplant\InstallTeamLicenseService.bat 2. A command prompt window will appear as the batch file runs. You do not need to interact with it; Just let it run and press any key to continue when prompted at the end. 16

3. You can now go into the Services list and see that the Team License Server is listed. You can either manually start the process or re-start your system to get the Team License Server process running as a Windows service. Source URL: http://docs.testplant.com/?q=content/licensing Powered by Drupal Links [1] mailto:sales@testplant.com [2] http://www.testplant.com/eggplant/free-trial/ [3] http://docs.testplant.com/?q=content/about-team-licenses [4] http://docs.testplant.com/?q=content/generating-eggplant-licenses [5] http://docs.testplant.com/?q=content/generating-node-locked-licenses [6] http://docs.testplant.com/?q=content/generating-team-licenses [7] http://docs.testplant.com/?q=content/port-configuration [8] http://docs.testplant.com/?q=content/licensing#greenhouse [9] http://docs.testplant.com/?q=content/licensing#license_registry [10] http://docs.testplant.com/sites/default/files/images/gettingstarted/licensing/assets.png [11] http://docs.testplant.com/?q=content/licensing [12] http://docs.testplant.com/?q=content/installing-and-licensing-tls [13] http://docs.testplant.com/sites/default/files/images/gettingstarted/licensing/generatenewtls.png [14] http://docs.testplant.com/sites/default/files/images/gettingstarted/licensing/generateteam.png [15] http://www.testplant.com/2011/08/05/license-generation/ [16] http://docs.testplant.com/sites/default/files/images/gettingstarted/licensing/tlsinstallation/greenhousefl.png [17] http://docs.testplant.com/?q=book/export/html/186#mac [18] http://docs.testplant.com/?q=book/export/html/186#windows [19] http://docs.testplant.com/?q=book/export/html/186#linux [20] http://www.testplant.com/dlds/eggplant-functional/ 17