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 versions starting 4.0.22 and up to 4.9.
The following Niagara 4 modules are required:
- alarm
- baja
- bql
- control
- driver
- file
- gx
- history
- jettyWrapper
- nre
- platform
- web
Browser Compatibility
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.
- Download the DGLux5 Niagara 4 installation file. (Requires dglux.com password)
- Stop all running stations, and close all instances of the engineering tool.
- Change the extension of the installation file from
.dist
to.zip
. Unzip the file.
If the file unzips successfully, the
installLocalWebContent.bat
file appears, along with theniagara_home
,niagara_user_home
, andMETA-INF
directories.- If you are using Niagara 4.1, open the
installLocalWebContent.bat
file with a text editor, and change4.0
to4.1
. Save the file. - Open a command window, and navigate to the directory that contains the
installLocalWebContent.bat
file. - In the command window, type
installLocalWebContent
. When prompted, choose a directory installation.
The
niagara_user_home
directory is now installed.- Find the
niagara_home\modules\dglogik.jar
file, and placedglogik.jar
in the Niagara 4modules
directory. Typically, this isC:\Niagara\Niagara-4.n.nnn\modules\
. - Add the DGLux5 Service:
- Open the DGLogik Palette in the engineering tool.
- Copy and paste the
DGLux5Service
object under theServices
node in the station database (station:|slot:/Services
).
- Go to
<server>:port/dglux5
, for examplelocalhost:8080/dglux5
. - 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:
- Download the DGLux5 Niagara 4 installation file. (Requires dglux.com password)
- Stop all running stations, and close all instances of the engineering tool.
- Change the extension of the installation file from
.dist
to.zip
. Unzip the file.
If the file unzips successfully, the
installLocalWebContent.bat
file appears, along with theniagara_home
,niagara_user_home
, andMETA-INF
directories.Find the
niagara_user_home\shared\dglux5
folder, and move it toC:\ProgramData\Niagara4\Tridium\Shared\
.ProgramData
is a hidden directory and can be seen inC:\
only if you have enabled showing hidden folders.- Find the
niagara_home\modules\dglogik.jar
file, and placedglogik.jar
in the Niagara 4modules
directory. Typically, this isC:\Niagara\Niagara-4.n.nnn\modules\
. - Add the DGLux5 Service:
- Open the DGLogik Palette in the engineering tool.
- Copy and paste the
DGLux5Service
object under theServices
node in the station database (station:|slot:/Services
).
- Go to
<server>:port/dglux5
, for examplelocalhost:8080/dglux5
. (Be sure to define the DGLux5 web port in your Niagara workbench before you attempt to launch DGLux5.) - 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.
- Download the DGLux5 Niagara 4 installation file. (Requires dglux.com password)
- Stop all running stations.
- Open the remote platform.
- Open the Distribution File Installer in the remote platform.
- When prompted, navigate to the
.dist
file on your local computer, and click Install. - Start the station.
- Add the DGLux5 Service:
- Open the DGLogik Palette in the engineering tool.
- Copy and paste the
DGLux5Service
object under theServices
node in the station database (station:|slot:/Services
).
- Go to
<server>:port/dglux5
, for examplelocalhost:8080/dglux5
, where the port is the http/https port configured in Niagara under station/config/web. service - 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.
- Stop all running stations.
- Go to the Installed Software utility in Niagara AX, and select Install from File.
- When prompted, browse to the new
dglogik.jar
file and select it. - 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
A Niagara user with the appropriate permissions outlined below can simply visit:
<server>:port/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: