Installing Project Assist

Before installing, Niagara AX and Niagara 4 users must know whether to install the Project Assist Viewer or DGLux5 with the Project Assist template. A Viewer installation includes Project Assist features only. A DGLux5-and-template installation includes the much fuller feature set of DGLux5. You need DGLux5 if you want to do certain advanced tasks related to your Project Assist project, such as creating custom widgets and modifying dataflow. For more information, see this page.

Types of installation are:

• Installation for DSA Users
• Upgrade Project Assist
• Installation for Niagara 4 Users
  • Niagara 4 Project Assist Viewer: Local .bat Installation (also works for local SoftJACE)
  • Niagara 4 Project Assist Viewer: Local Manual Installation (also works for local SoftJACE)
  • Niagara 4 Project Assist Viewer: Remote Installation (also works for remote JACE)
  • Niagara 4 DGLux5 with Project Assist Template: Local Installation (also works for local SoftJACE)
  • Niagara 4 DGLux5 with Project Assist Template: Remote Installation (also works for remote JACE)
• Installation for Niagara AX Users
  • Niagara AX Project Assist Viewer: Local Installation
  • Niagara AX Project Assist Viewer: Remote Installation (can also work for remote JACE)
  • Niagara AX DGLux5 with Project Assist Template: Local Installation
  • Niagara AX DGLux5 with Project Assist Template: Remote Installation (can also work for remote JACE)
  • Niagara AX DGLux5 with Project Assist Template: JACE installation (conserves space)
• Upgrading to Project Assist 2.5
• Updating Project Assist Viewer on Niagara

DSA users can install the Project Assist template for DGLux5.

To install the latest version of Project Assist:

1. Download the Project Assist template. Requires dglux.com account.

2. To update DGLux5 to the latest revision, choose sys → Update All Components.

Install the template:

1. Choose Project → Export/Import → Import Project.
2. Click Choose File, and choose PA2_main.zip.
3. Click OK.

For either the Project Assist Viewer installation or the DGLux5-and-template installation, Niagara 4 users can install locally or remotely. Local installations can be done via the .bat file or manually.

These steps demonstrate how to install the Project Assist Viewer on a local engineering tool, local Niagara 4 supervisor, or local SoftJACE using the .bat file.

1. Download the Project Assist 2.5 Viewer (N4) installation file. (Requires dglux.com password)
2. Stop all running stations, and close all instances of the engineering tool.
3. Change the extension of the distribution 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, or if your vendor is not Tridium, modify the .bat file with a text editor:
   1. If you are using Niagara 4.1, change 4.0 to 4.1
   2. If your vendor is not Tridium, change tridium to the correct vendor name.
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. In the Licensing dialog, submit a license request, including the license type. The license type is either JACE, Supervisor, or Unlimited.

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:

• Steps to show hidden files on Windows 7

To install manually:

1. Download the Project Assist 2.5 Viewer (N4) installation file. (Requires dglux.com password)
2. Stop all running stations, and close all instances of the engineering tool.
3. Change the extension of your distribution file from .dist to .zip.
4. Unzip the file.

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.
9. In the Licensing dialog, submit a license request, including the license type. The license type is either JACE, Supervisor, or Unlimited.

The following steps demonstrate how to install the Project Assist Viewer on a remote computer or on a remote JACE.

1. Download the Project Assist 2.5 Viewer (N4) installation file. (Requires dglux.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.
9. In the Licensing dialog, submit a license request, including the license type. The license type is either JACE, Supervisor, or Unlimited.

The Project Assist 2.5 template requires DGLux5 revision 8665 or later. Updating to revision 8665 or later requires reinstalling DGLux5. Reinstalling ensures that the module, JAR file, HVAC2 library, and DGLux5 version are all updated.

1. Download the DGLux5 Niagara 4 installation file. (Requires dglux.com password)
2. Download the Project Assist template. (Requires dglux.com password)
3. Reinstall DGLux5 locally using the .bat file or a manual installation.
4. Install the template:
   1. Choose Project > Export/Import > Import Project.
   2. Click Choose File, and choose PA2.zip.
   3. Click OK.

The Project Assist 2.5 template requires DGLux5 revision 8665 or later. Updating to revision 8665 or later requires reinstalling DGLux5. Reinstalling ensures that the module, JAR file, HVAC2 library, and DGLux5 version are all updated.

1. Download the DGLux5 Niagara 4 installation file. (Requires dglux.com password)
2. Download the Project Assist template. (Requires dglux.com password)
3. Reinstall DGLux5 remotely.
4. Install the template:
   1. Choose Project > Export/Import > Import Project.
   2. Click Choose File, and choose PA2.zip.
   3. Click OK.

For either the Project Assist Viewer installation or the template installation, Niagara AX users can install on a local workstation, remote station, or JACE device.

The following video demonstrates how to install the Project Assist Viewer on a local workstation.

To install the Project Assist viewer on a local workstation:

1. Download the Project Assist 2.0 Viewer (AX) installation file. (Requires dglux.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.
5. Move the dglux5 and modules directories to the system root directory of the version of Niagara being used. Typically, this is C:\Niagara\Niagara-3.n.nnn\, where 3.n.nnn is the Niagara version number.
6. When prompted to merge the modules directories, select Yes.
7. Start the station.
8. Add the DGLux5 Service:

   1. If your Niagara Workbench environment does not already include the Palette, add the Palette by selecting Windows > Sidebars > Palette, as shown in the following image.

      

   2. In the palette, browse to the dglogik module, as shown in the following image, and click OK.

      

      The DGLuxService module is added to the Palette.

   3. Drag the DGLux5Service module from the Palette, and drop it on the Services node in the station database in the panel above (station:|slot:/Services), as shown in the following image.

      

9. Go to <server>:port/dglux5, for example localhost:8080/dglux5.

10. In the Licensing dialog, shown in the following image, submit a license request.

    

    The license type is either JACE, Supervisor, or Unlimited.

The following steps demonstrate how to install the Project Assist Viewer on a remote computer or on a remote JACE device with sufficient space. The Viewer requires 56.1 MB of storage.

1. Download the Project Assist 2.5 Viewer (AX) installation file. (Requires dglux.com password)
2. Stop all running stations.
3. Open the remote platform.
4. Open the Distribution File Installer in the remote platform. When prompted, navigate to the .dist file on your local computer, and click Install.
5. Start the station.
6. Add the DGLux5 Service:
   1. If your Niagara Workbench environment does not already include the Palette, add the Palette by selecting Windows > Sidebars > Palette.

   2. In the Palette, browse to the dglogik module, and click OK.

      The DGLuxService module is added to the Palette.

   3. Drag the DGLux5Service module from the Palette, and drop it on the Services node in the station database in the panel above (station:|slot:/Services).
7. Go to <server>:port/dglux5, for example localhost:8080/dglux5.

8. In the Licensing dialog, submit a license request.

   The license type is either JACE, Supervisor, or Unlimited.

The Project Assist 2.5 template requires DGLux5 revision 8665 or later. Updating to revision 8665 or later requires reinstalling DGLux5. Reinstalling ensures that the module, JAR file, HVAC2 library, and DGLux5 version are all updated.

1. Download the DGLux5 Niagara AX Supervisor installation file. (Requires dglux.com password)
2. Download the Project Assist 2.5 template. (Requires dglux.com password)
3. Reinstall DGLux5 on the local station.
4. Install the template:
   1. In DGLux5, choose Project > Export/Import > Import Project.
   2. Click Choose File, and choose PA2.zip.
   3. Click OK.

The Project Assist 2.5 template requires DGLux5 revision 8665 or later. Updating to revision 8665 or later requires reinstalling DGLux5. Reinstalling ensures that the module, JAR file, HVAC2 library, and DGLux5 version are all updated.

1. Download the DGLux5 Niagara AX Supervisor installation file. (Requires dglux.com password)
2. Download the Project Assist 2.5 template. (Requires dglux.com password)
3. Reinstall DGLux5 on the remote station.
4. Install the template:
   1. In DGLux5, choose Project > Export/Import > Import Project.
   2. Click Choose File, and choose PA2.zip.
   3. Click OK.

The Project Assist 2.5 template requires DGLux5 revision 8665 or later. Updating to revision 8665 or later requires reinstalling DGLux5. Reinstalling ensures that the module, JAR file, HVAC2 library, and DGLux5 version are all updated.

1. Download the DGLux5 AX JACE installation file. (Requires dglux.com password)
2. Download the Project Assist 2.5 template. (Requires dglux.com password)
3. Reinstall DGLux5 on the JACE.
4. Install the template:
   1. In DGLux5, choose Project > Export/Import > Import Project.
   2. Click Choose File, and choose PA2.zip.
   3. Click OK.

To upgrade to Project Assist 2.5, you must have revision 8665 or higher of DGLux5. If you need to upgrade DGLux5, see http://wiki.dglux.com/dglux5_wiki:installation:updating for details.

Download the Project Assist template.

Upgrading Project Assist

1. Download the installer zip file.
2. In DGLux5, choose Project > Export/Import > Import Project and import the downloaded zip file.

NOTE: If your Project Assist 2.X project is not named PA2, unzip the downloaded installer, rename its PA2 project folder to match your Project Assist project folder, and re-zip the contents of the downloaded zip file before importing it.

Upgrading Project Assist Viewer

For details about upgrading Project Assist Viewer, see http://wiki.dglux.com/dglux5_wiki:project_assist:2_0_v10:installation:home

If you need to install the upgrade manually, download and unzip the upgrade and copy its “app” and “proj” folders to your DGLux5 installation, overwriting the folders that are there. If you are installing on Windows 10, note that the DGLux5 /proj folder resides under the \Users\<yourusername> directory. In Niagara, update the dglogik module using the dglogik.jar file from the upgrade zip file.

Download the latest PA viewer here https://dglogik.com/download.

1. Change the extension of the distribution file from .dist to .zip.
2. Unzip the folder.
3. Stop all the instances before updating.
4. Back up of all your projects (How to Import and Export Files (PA))

This section covers the process of how to replace dglogik.jar and override app and proj folders.

1. Download the latest PA Viewer and unzip it.
2. Copy dglogik.jar form <unzipped location>\pa-viewer-n4-*niagara_home\modules to Niagara 4 modules directory (typically, this is <Niagara installation folder>\modules).
3. Override app and proj from an unzipped folder (<unzipped location>\pa-viewer-n4-*\niagara_user_home\shared\dglux5) to Tridium or Distech shared folder, typically it would be <Niagara Installation Folder>\<Tridium or Distech>\Shared\dglux5. Note: overwrite the old folder to keep custom files that were created there. Don't delete it.

This section describes an alternative approach when the above steps don't work.

1. Open PA viewer.
2. Click on Settings and select Export File.
3. Select the contents from the project's Export panel and click on Export.
4. The file is exported on your local drive.

1. Unzip and open the file exported on Step 1.
2. Copy the node folder from <unzipped folder>\PA\node and copy over the node folder to <unzipped-downloaded folder>\niagara_user_home\shared\dglux5\proj\dglogik-project_assist_2\PA. It overwrites the existing node folder.
3. Now your project content is copied or updated to the latest PA Viewer.

1. After performing above Steps 1 & 2, latest PA is loaded with user's project content. Move or copy the modified latest downloaded PA Viewer dglux5 folder to your project path.
2. Copy dglogik.jar form <unzipped modified downloaded location>\pa-viewer-n4-*\niagara_home\modules to Niagara 4 modules directory (typically, <Niagara installation folder>\module).
3. Copy \dglux5 folder from <unzipped modified downloaded location>niagara_user_home\shared and move it to <Niagara Installation Folder>\<Tridium or Distech>\Tridium\Shared

The above 2 approaches work for JACE and remote servers as well. However, in this case, you need to use FTP tools to update the PA Viewer manually.

1. Perform the installation on a local machine.
2. Start workbench and navigate to Nav / Host / Platform / Software Manager.
3. Verify that Avail.Version is the latest version. Please visit http://dglux.com/download/niagara4-installation for details
4. In case, versions don't match between Avail.Version and http://dglux.com/download/niagara4-installation, please download it on your local machine and import it.
5. In the Software Manager view, dglogik.jar should be marked as Out of Date. Select just that row.
6. Press the Upgrade button.
7. Press the Commit button.
8. Accept all the further steps.