License Installation

Overview

After purchasing a license for a module, you can assign it to a Niagara Host ID. To assign licenses or change your license assignments sign in to your account and go to your Licenses page.

For the module to work on your Niagara host, you must install our License Service. If your host is connected to the internet, the License Service will automatically communicate with our servers and download any product licenses assigned to your host's Host ID. You can also download and copy license files to your host manually.

NiagaraMods License Service

The License Service module is required to be installed on your station for any module purchased from NiagaraMods.

Download & Install the NiagaraMods License Service

The License Service is required for most modules to function – even in free trial mode. Follow the instructions below to download and install the License Service on your station.

  1. Download the NiagaraMods License Service
  2. Open the downloaded file and copy the nmodslicense-rt.jar file to your Niagara modules directory. If you're not sure where your modules directory is, it can typically found at C:\Niagara\Niagara-4.x.x\modules
  3. If Workbench is already open, close it and then relaunch it
  4. Install the nmodslicense-rt.jar module on to your station and restart it
  5. Connect to your station in Workbench and open the nmodslicense palette
  6. Drag the NiagaraModsLicenseService component from the palette to your station's Services folder, under Config
  7. Don't forget to save your station by right-clicking on the station and going to Save

Automatic License Updates

As soon as you've installed the NiagaraMods License Service on to your station, it will attempt to connect with our servers and download your Host ID's license file. This single file contains all of the products that you have assigned to the host on the Licenses page.

Host ID license files expire one year after they are generated so its important to ensure that they are refreshed regularly. Thankfully,  the License Service will attempt to connect with our servers once every 24 hours to automatically refresh your Host's license file.

Force Refreshing the Host License File

If you have recently added or changed products on your Host, you may not want to wait for the next automatic license refresh. To manually force a refresh of the Host's license file, follow these instructions:

  1. Navigate to the License Service in your station's component tree. If you followed the installation instructions above, it will be in the Config/Services folder
  2. Right-click on the NiagaraModsLicenseService component in the tree, go to Actions, and click Refresh License
  3. To confirm that the license has refreshed you can check the Application Director logs in your platform. You will see a message simliar to [nmodslicense] NiagaraMods License Refreshed if things were successful or an error message if there was an issue communicating with our servers

Verifying your License File

The Host's license file is stored in the station file system and named niagaramods.license.

  • You can verify that the license file has been downloaded by opening your station in the nav tree and expanding the Files tree. You should see a file named niagaramods.license.
  • You can open the niagaramods.license file by double-clicking on it in the nav tree. The file is formatted in XML and viewing it will reveal its details including the date it was generated and any products that are included (as "features" in the XML).
  • Editing the niagaramods.license file will cause the license to be invalid and may cause your modules to crash. Never edit this file manually.

Manual License Installation

In cases where your station does not have internet connectivity including if a VPN or firewall is preventing your station from reaching out to the internet, you can install your Host's license file manually. To do this, follow the instructions below:

  1. Sign in to the NiagaraMods website and go to your Licenses page.
  2. Click on the Host ID whose license you want to install in the list under the Host IDs section of the page.
  3. On the Host Details page, click on the Niagara License tab in the middle of the page. This page will give you options to download or email the niagaramods.license file for the Host. Save this file in a location that you can access from Workbench
  4. In Workbench, navigate to where you saved your niagaramods.license file in the My File System nav tree. Right-click on the niagaramods.license file and go to Copy
  5. Connect to your station in Workbench. Open its nav tree and right-click on Files, then click on Paste in the menu.

Manual Installation Notes

  • You still need to have the License Service installed and running in your station for our modules to read and recognize the license file
  • If you do not have internet connectivity on your station, you will need to repeat the manual installation each year before the license file expires
  • If you do not have internet connectivity on your station, you will need to manually install a new license file after renewing or adding products

We're here to help

License installation throwing you for a loop?
We're standing by – just a click away.