Differences

This shows you the differences between two versions of the page.

--- dglux5_wiki:installation:niagara4 [2019/02/27 19:21]
+++ dglux5_wiki:installation:niagara4 [2021/09/20 14:43] (current)
@@ Line 1: / Line 1: @@
+{{indexmenu_n>2}}
+====== 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
+----
+====== ======
+{{section>dglux5_wiki:installation:niagaraax#browser_compatibility&nofooter}}
+{{anchor:local_bat}}
+===== 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 [[http://dglux.com/download/niagara4-installation|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''.
+  - <WRAP>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.</WRAP>
+  - 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.
+  - Open a command window, and navigate to the directory that contains the ''installLocalWebContent.bat'' file.
+  - In the command window, type ''installLocalWebContent''.
+  - <WRAP>When prompted, choose a **directory** installation.
+The ''niagara_user_home'' directory is now installed.</WRAP>
+  - 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\''.
+  - Add the DGLux5 Service:
+    - Open the DGLogik Palette in the engineering tool.
+    - Copy and paste the ''DGLux5Service'' object under the ''Services'' node in the station database (''station:|slot:/Services'').
+  - Go to ''<server>:port/dglux5'', for example ''localhost:8080/dglux5''.
+  - To request a license, select **Help** > **License**, and then click the **Request License** button.
+----
+{{anchor:local_manual}}
+}
+===== 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:
+  * [[http://windows.microsoft.com/en-us/windows/show-hidden-files#show-hidden-files|Steps to show hidden files in Windows]]
+To install manually:
+  - Download the [[http://dglux.com/download/niagara4-installation|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''.
+  - <WRAP>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.</WRAP>
+  - <WRAP>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 [[http://windows.microsoft.com/en-us/windows/show-hidden-files#show-hidden-files|showing hidden folders]].</WRAP>
+  - 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\''.
+  - Add the DGLux5 Service:
+    - Open the DGLogik Palette in the engineering tool.
+    - Copy and paste the ''DGLux5Service'' object under the ''Services'' node in the station database (''station:|slot:/Services'').
+  - 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.)
+  - To request a license, select **Help** > **License**, and then click the **Request License** button.
+----
+{{anchor:remote}}
+===== How to Install on a Remote Station =====
+Follow these steps to install DGLux5 on a remote computer or remote JACE.
+  - Download the [[http://dglux.com/download/niagara4-installation|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 the ''Services'' node in the station database (''station:|slot:/Services'').
+  - 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
+  - To request a license, select **Help** > **License**, and then click the **Request License** button.
+----
+====== ======
+{{section>dglux5_wiki:installation:niagaraax#how_to_update_the_dglux5_jar_file&nofooter}}
+====== ======
+{{section>dglux5_wiki:installation:niagaraax#how_to_launch_dglux5_and_log_in&nofooter}}
+====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:''
+----
+<WRAP left>[[dsa-dglux5|Previous: Install DGLux5 with DSA]]</WRAP>
+<WRAP right>[[dglux5_wiki:installation:niagaraax|Next: Install DGLux5 for Niagara AX]]</WRAP>