Install DGLux5 for Niagara 4

Use this guide to install the DGLux5 Service on a remote or local Niagara 4 station or on a JACE device.


Niagara 4 Compatibility

The DGLux5 Service is compatible with Niagara 4.0.22 and higher.

The following Niagara 4 modules are required:

  • alarm
  • baja
  • bql
  • control
  • driver
  • file
  • gx
  • history
  • jettyWrapper
  • nre
  • platform
  • web

Browser Compatibility

DGLux5 is a 100% HTML5 application that does not require any special browser plugins. The latest version of Google Chrome is recommended for the best experience.

Currently, the supported web browsers are:

  • Chrome 21+
  • Internet Explorer 11+
  • Firefox 22+
  • Opera 15+
  • Safari 6.1+

How to Install Locally Using the .bat File

These steps demonstrate how to install DGLux5 on a local engineering tool, local Niagara 4 Supervisor, or local SoftJACE, using the .bat file.

  1. Download the DGLux5 Niagara 4 installation file. (Requires dglogik.com password)
  2. Stop all running stations, and close all instances of the engineering tool.
  3. Change the extension of the installation file from .dist to .zip.
  4. Unzip the file.

    If the file unzips successfully, the installLocalWebContent.bat file appears, along with the niagara_home, niagara_user_home, and META-INF directories.

  5. If you are using Niagara 4.1, open the installLocalWebContent.bat file with a text editor, and change 4.0 to 4.1. Save the file.
  6. Open a command window, and navigate to the directory that contains the installLocalWebContent.bat file.
  7. In the command window, type installLocalWebContent.
  8. When prompted, choose a directory installation.

    The niagara_user_home directory is now installed.

  9. Find the niagara_home\modules\dglogik.jar file, and place dglogik.jar in the Niagara 4 modules directory. Typically, this is C:\Niagara\Niagara-4.n.nnn\modules\.
  10. Add the DGLux5 Service:
    1. Open the DGLogik Palette in the engineering tool.
    2. Copy and paste the DGLux5Service object under the Services node in the station database (station:|slot:/Services).
  11. Go to <server>:port/dglux5, for example localhost:8080/dglux5.
  12. Log in as dgSuper / dglux1234.
  13. To request a license, select Help > License, and then click the Request License button.

}

How to Do a Manual Local Installation

If installation using the .bat file does not work properly, you can install manually. Before you can install manually, it's a good idea to enable showing hidden folders:

To install manually:

  1. Download the DGLux5 Niagara 4 installation file. (Requires dglogik.com password)
  2. Stop all running stations, and close all instances of the engineering tool.
  3. Change the extension of the installation file from .dist to .zip.
  4. Unzip the file.

    If the file unzips successfully, the installLocalWebContent.bat file appears, along with the niagara_home, niagara_user_home, and META-INF directories.

  5. Find the niagara_user_home\shared\dglux5 folder, and move it to C:\ProgramData\Niagara4\Tridium\Shared\.

    ProgramData is a hidden directory and can be seen in C:\ only if you have enabled showing hidden folders.

  6. Find the niagara_home\modules\dglogik.jar file, and place dglogik.jar in the Niagara 4 modules directory. Typically, this is C:\Niagara\Niagara-4.n.nnn\modules\.
  7. Add the DGLux5 Service:
    1. Open the DGLogik Palette in the engineering tool.
    2. Copy and paste the DGLux5Service object under the Services node in the station database (station:|slot:/Services).
  8. Go to <server>:port/dglux5, for example localhost:8080/dglux5. (Be sure to define the DGLux5 web port in your Niagara workbench before you attempt to launch DGLux5.)
  9. Log in as dgSuper / dglux1234.
  10. To request a license, select Help > License, and then click the Request License button.

How to Install on a Remote Station

Follow these steps to install DGLux5 on a remote computer or remote JACE.

  1. Download the DGLux5 Niagara 4 installation file. (Requires dglogik.com password)
  2. Stop all running stations.
  3. Open the remote platform.
  4. Open the Distribution File Installer in the remote platform.
  5. When prompted, navigate to the .dist file on your local computer, and click Install.
  6. Start the station.
  7. Add the DGLux5 Service:
    1. Open the DGLogik Palette in the engineering tool.
    2. Copy and paste the DGLux5Service object under the Services node in the station database (station:|slot:/Services).
  8. Go to <server>:port/dglux5, for example localhost:8080/dglux5, where the port is the http/https port configured in Niagara under station/config/web. service
  9. Log in as dgSuper / dglux1234.
  10. To request a license, select Help > License, and then click the Request License button.

How to Update the DGLux5 JAR File

If you need to update only the dglogik.jar file, you can do so from the Niagara workbench.

  1. Stop all running stations.
  2. Go to the Installed Software utility in Niagara AX, and select Install from File.
  3. When prompted, browse to the new dglogik.jar file and select it.
  4. Close and reopen the Workbench.

Out-of-Date Modules

When you use the Installed Software utility in the Niagara workbench, the module versions installed on the remote host are checked against those that are installed locally. If any modules on the remote machine are found to be out of date, you are given the option to install the newer versions.

In general, uncheck modules unless you are sure you want to update them. Do not update modules without a reason to do so.


How to Launch DGLux5 and Log In

By default, after you add the DGLux5Service object to the station Services folder, a new DGLux5 Super User is created under the station's UserService.

  • username: dgSuper
  • password: dglux1234

To launch DGLux5 for the first time as dgSuper, enter localhost in the URL bar. Google Chrome is recommended.

To launch DGLux5 as another user, use a web browser to open <server>:port/dglux5, for example localhost:8080/dglux5.


Niagara Permissions for Non-Super Users

DGLux5 obeys the Niagara security model. Thus, non-Super users need the following permissions to run DGLux5:

  • The DGLux5Service object โ€“ typically slot:/Services/DgLux5Service
  • The Station database โ€“ slot:
  • The History database โ€“ history: