Skip to main content
Pentaho Documentation

Managing Pentaho Licenses

You can manage the licenses from a the Pentaho User Console (PUC), Pentaho client (Spoon), or the command line interface. Licenses for Pentaho software are provided in the form of .lic files.

License files are needed after installation of the software, when subscribing or renewing your subscription, or when these licenses change or expire. If you are a new customer, your Pentaho Welcome Kit will contain the necessary licenses. If you are an existing customer, the licenses will be emailed. If you did not receive your welcome kit, did not receive the licenses, or are having any other problems contact Pentaho Support.

Evaluation Period: Thirty to sixty days after the software evaluation period, the temporary licenses included will expire. 

The required licenses for various Pentaho Business Analytics components are listed in the table below. However, your subscription may not feature all of the components or licenses listed.

Required License Installed Component(s)*
Pentaho Analysis Enterprise Edition Analysis Design Tools
Pentaho BI Platform Enterprise Edition Pentaho Server, Analyzer, Reporting Design Tools, Analysis Design Tools, and Interactive Reporting
Pentaho Dashboard Designer Dashboard Designer
Pentaho Hadoop Enterprise Edition Big Data Shims
Pentaho Mobile

Pentaho Mobile

Pentaho will no longer ship Pentaho Mobile with the product in 7.1 and will remove support for Pentaho Mobile in 8.0. Contact Pentaho Support for more information.

Pentaho PDI Enterprise Edition Pentaho Server and Data Integration (ETL)
Pentaho Reporting Enterprise Edition Reporting Design Tools

*Please note that shims and plugins licensed for use with some components have not been included in this table. 

Manage Licenses Using PUC

Follow the procedure below to install the licenses using PUC.

  1. Copy your license files to a convenient location.
  2. Log on to PUC. If you do not have valid licenses and your user role has administration privileges, the first time you log on, the License page will appear. You must enter licenses.

File:/ssBaservInstallLicense.png 

  1. Click the Add button (+) and then browse to the license files that you want to install. Double-click the license to install it. 
  2. Repeat the previous step until all needed licenses are installed.

To remove unwanted license files, select the files you want to remove then click the Delete button (X). When prompted, click Yes to delete the license.

File:/ssBaservAdminLicense.png

Manage Licenses Using Spoon

Follow the procedure below to install the licenses using Spoon.

  1. Copy your license files to a convenient location.
  2. Start the PDI client. If no valid license for the PDI client exists, the Pentaho License Manager dialog box appears. You must enter licenses to proceed. 
  3. From within the Pentaho License Manager, click the Add button (+).
  4. Browse to the license file that you want to update. Select or multi-select the license file(s) (.lic) you want to install. 

    A green check appears in the Status column to indicate that the license file (as displayed in the Product Name column) is correctly installed. The dialog box also provides the version, and installation and expiration dates of the license.
     
  5. Repeat the previous step until all needed licenses are installed. 
  6. Click Close to close the dialog box.

To remove unwanted license files, select or multi-select the files you want to remove then click the Delete button (X). When prompted, click Yes to delete the license.

Manage Licenses using the Command Line Interface

Setting the License Path Environment Variable

To ensure that the Pentaho Server uses the same location to store and retrieve your Pentaho licenses, you must create a PENTAHO_INSTALLED_LICENSE_PATH system environment variable for your Pentaho user account if it does not exist. It does not matter what location you choose; however, the location needs to be available to the user account(s) that run the Pentaho Server. 

Set the License Path Environment Variable on Linux

  1. Edit your /etc/environment file with a text editor. 
  2. Add this line in a convenient place (changing the path as explained above, if necessary): 
    export PENTAHO_INSTALLED_LICENSE_PATH=/home/pentaho/.installedLicenses.xml
  3. You must log out and log back into the operating system for the change to take effect.
  4. Verify that the variable is properly set.
    env | grep PENTAHO_INSTALLED_LICENSE_PATH

The PENTAHO_INSTALLED_LICENSE_PATH variable is now set. 

Set the License Path Environment Variable on Windows

  1. In Windows, right-click on Computer, then select Properties from context menu, then click Advanced System Settings. The System Properties window will appear.
  2. In the System Properties window, click the Advanced tab, then click Environment Variables.
  3. In the System Variable section, click New.
  4. A dialog box will ask for a variable name and value. Type PENTAHO_INSTALLED_LICENSE_PATH into the name field, and the directory you intend to install licenses to plus .installedLicenses.xml in the value field, then click OK.
    C:/pentaho/.installedLicenses.xml
  5. In the parent window, click Apply Changes.
  6. You must restart your computer for the change to take effect.
  7. Verify that the variable is properly set, using a command prompt:
    echo %PENTAHO_INSTALLED_LICENSE_PATH%
The PENTAHO_INSTALLED_LICENSE_PATH variable is now set.
 
If you run Tomcat automatically as a Windows service, you must also configure it to run on the Windows user account where the .installedLicenses.xml file is located.

Install or Update License Files from the Command Line

To install or update license files, follow the steps below.

  1. Download the .lic file(s) you want to install.
  2. Navigate to the /license-installer/ directory where Pentaho PDI tool is installed (the license-installer subfolder).
  3. Copy your .lic files to the /license-installer/ directory.
  4. Run the license installation script:
    • Linux: Run install_license.sh with the install switch and the location and name of your .lic file as a parameter. You can specify multiple .lic files separated by spaces. Be sure to use backslashes (\) to escape any spaces in the path or file name.
       ./install_license.sh install Pentaho\ BI\ Platform\ Enterprise\ Edition.lic 
    • Windows: Run install_license.bat with the install switch and the location and name of your license file as a parameter. Be sure to use quotation marks (") to escape any spaces in the path or file name.
      install_license.bat install "C:\Users\username\Downloads\Pentaho BI Platform Enterprise Edition.lic"
  1. Repeat the previous step for all needed licenses. 

List or Remove License Files from the Command Line

To list or remove license files, follow the steps below.

  1. Navigate to the /pentaho/server/license-installer/ directory.
  2. Run the following scripts with the display switch:
Linux: ./install_license.sh display
Windows: install_license.bat display

If you have installed any Enterprise Edition license files, a list of them will appear, along with the products they cover and the duration of the license.

  1. To remove a license, run the same script with the uninstall switch. A list of installed licenses will appear, followed by a prompt for the license ID you would like to remove. If you press Enter at this prompt, it will exit without taking any action.
  2. Type in the license ID number that you want to remove, then press Enter

After removing a file, if you had more than one installed, the list will regenerate and the prompt will reappear. You can choose to remove another license file, or you can press Enter to exit the script. 

If you would prefer not to be prompted for confirmation, or if you intend to call this program as part of a script, use the -q switch to suppress prompting.