Differences

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

--- dglux5_wiki:project_assist:2_0_v10:installation:home [2019/10/31 22:52]
itsarev
+++ dglux5_wiki:project_assist:2_0_v10:installation:home [2021/09/20 15:03]
@@ Line 1: / Line 1: @@
-{{indexmenu_n>2}}
-====== 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 [[http://dglux.com/products/project-assist-2-0|this page]].
-Types of installation are:
-  * [[#dsa|Installation for DSA Users]]
-  * [[#upgrade300|Upgrade Project Assist]]
-  * [[#n4|Installation for Niagara 4 Users]]
-    * [[#n4_viewer_local|Niagara 4 Project Assist Viewer: Local .bat Installation]] (also works for local SoftJACE)
-    * [[#n4_viewer_local_manual|Niagara 4 Project Assist Viewer: Local Manual Installation]] (also works for local SoftJACE)
-    * [[#n4_viewer_remote|Niagara 4 Project Assist Viewer: Remote Installation]] (also works for remote JACE)
-    * [[#n4_dgtemplate_local|Niagara 4 DGLux5 with Project Assist Template: Local Installation]] (also works for local SoftJACE)
-    * [[#n4_dgtemplate_remote|Niagara 4 DGLux5 with Project Assist Template: Remote Installation]] (also works for remote JACE)
-  * [[#nax|Installation for Niagara AX Users]]
-    * [[#nax_viewer_local|Niagara AX Project Assist Viewer: Local Installation]]
-    * [[#nax_viewer_remote|Niagara AX Project Assist Viewer: Remote Installation]] (can also work for remote JACE)
-    * [[#nax_dgtemplate_local|Niagara AX DGLux5 with Project Assist Template: Local Installation]]
-    * [[#nax_dgtemplate_remote|Niagara AX DGLux5 with Project Assist Template: Remote Installation]] (can also work for remote JACE)
-    * [[#nax_dgtemplate_jace|Niagara AX DGLux5 with Project Assist Template: JACE installation]] (conserves space)
-  * [[#upgrade25|Upgrading to Project Assist 2.5]]
-  * [[#update_viewer|Updating Project Assist Viewer on Niagara]]
-<WRAP important>===Important===
-Projects that were created with Project Assist version 8 or earlier cannot be edited in version 10.
-</WRAP>
-----
-{{anchor:dsa}}
-===== Installation for DSA Users =====
-DSA users can install the Project Assist template for DGLux5.
-To install the latest version of Project Assist:
-  - Download the [[http://dglux.com/download/project-assist-installation|Project Assist template]]. (Requires dglux.com password)
-  - <WRAP>To update DGLux5 to the latest revision, choose **sys** > **Update All Components**.
-The Project Assist 2.5 template requires DGLux5 revision 8665 or later.</WRAP>
-  - Install the template:
-    - Choose **Project** > **Export**%%/%%**Import** > **Import Project**.
-    - Click **Choose File**, and choose ''PA2.zip''.
-    - Click **OK**.
-----
-{{anchor:n4}}
-===== Installation for Niagara 4 Users =====
-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.
-{{anchor:n4_viewer_local}}
-==== Niagara 4 Project Assist Viewer: Local .bat Installation ====
-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.
-  - Download the [[http://dglux.com/download/project-assist-viewer-niagara-4-installation|Project Assist 2.5 Viewer (N4) installation file]]. (Requires dglux.com password)
-  - Stop all running stations, and close all instances of the engineering tool.
-  - Change the extension of the distribution 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, or if your vendor is not Tridium, modify the ''.bat'' file with a text editor:
-    - If you are using Niagara 4.1, change ''4.0'' to ''4.1''
-    - If your vendor is not Tridium, change ''tridium'' to the correct vendor name.
-  - 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''.
-  - In the Licensing dialog, submit a license request, including the license type. The license type is either JACE, Supervisor, or Unlimited.
-{{anchor:n4_viewer_local_manual}}
-==== Niagara 4 Project Assist Viewer: Local Manual 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=windows-7|Steps to show hidden files on Windows 7]]
-To install manually:
-  - Download the [[http://dglux.com/download/project-assist-viewer-niagara-4-installation|Project Assist 2.5 Viewer (N4) installation file]]. (Requires dglux.com password)
-  - Stop all running stations, and close all instances of the engineering tool.
-  - Change the extension of your distribution file from ''.dist'' to ''.zip''.
-  - Unzip the file.
-  - <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=windows-7|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''.
-  - In the Licensing dialog, submit a license request, including the license type. The license type is either JACE, Supervisor, or Unlimited.
-{{anchor:n4_viewer_remote}}
-==== Niagara 4 Project Assist Viewer: Remote Installation ====
-The following steps demonstrate how to install the Project Assist Viewer on a remote computer or on a remote JACE.
-  - Download the [[http://dglux.com/download/project-assist-viewer-niagara-4-installation|Project Assist 2.5 Viewer (N4) 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''.
-  - In the Licensing dialog, submit a license request, including the license type. The license type is either JACE, Supervisor, or Unlimited.
-{{anchor:n4_dgtemplate_local}}
-==== Niagara 4 DGLux5 with Project Assist Template: Local Installation ====
-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.
-  - Download the [[http://dglux.com/download/niagara4-installation|DGLux5 Niagara 4 installation file]]. (Requires dglux.com password)
-  - Download the [[http://dglux.com/download/project-assist-installation|Project Assist template]]. (Requires dglux.com password)
-  - Reinstall DGLux5 locally using [[dglux5_wiki:installation:niagara4#local_bat|the .bat file]] or [[dglux5_wiki:installation:niagara4#local_manual|a manual installation]].
-  - Install the template:
-    - Choose **Project** > **Export**%%/%%**Import** > **Import Project**.
-    - Click **Choose File**, and choose ''PA2.zip''.
-    - Click **OK**.
-{{anchor:n4_dgtemplate_remote}}
-==== Niagara 4 DGLux5 with Project Assist Template: Remote Installation ====
-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.
-  - Download the [[http://dglux.com/download/niagara4-installation|DGLux5 Niagara 4 installation file]]. (Requires dglux.com password)
-  - Download the [[http://dglux.com/download/project-assist-installation|Project Assist template]]. (Requires dglux.com password)
-  - Reinstall DGLux5 [[dglux5_wiki:installation:niagara4#remote|remotely]].
-  - Install the template:
-    - Choose **Project** > **Export**%%/%%**Import** > **Import Project**.
-    - Click **Choose File**, and choose ''PA2.zip''.
-    - Click **OK**.
-----
-{{anchor:nax}}
-===== Installation for Niagara AX Users =====
-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.
-{{anchor:nax_viewer_local}}
-==== Niagara AX Project Assist Viewer: Local Installation ====
-The following video demonstrates how to install the Project Assist Viewer on a local workstation.
-<html>
-<left>
-<iframe width="420" height="315" src="https://www.youtube.com/embed/B9nDlGcEJ10" frameborder="0" allowfullscreen></iframe>
-</left>
-</html>
-To install the Project Assist viewer on a local workstation:
-  - Download the [[http://dglux.com/download/project-assist-viewer-niagara-ax-installation|Project Assist 2.0 Viewer (AX) 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.
-  - 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.
-  - When prompted to merge the ''modules'' directories, select **Yes**.
-  - Start the station.
-  - Add the DGLux5 Service:
-    - <WRAP>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.
-{{:dglux5_wiki:installation:dglux5_nax_palette.png?direct|}}</WRAP>
-    - <WRAP>In the palette, browse to the ''dglogik'' module, as shown in the following image, and click **OK**.
-{{:dglux5_wiki:installation:dglux5_nax_dgluxservice.png?direct|}}
-The ''DGLuxService'' module is added to the Palette.</WRAP>
-    - <WRAP>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.
-{{:dglux5_wiki:installation:dglux5_nax_serviceadd.png?direct|}}</WRAP>
-  - Go to ''<server>:port/dglux5'', for example ''localhost:8080/dglux5''.
-  - <WRAP>In the Licensing dialog, shown in the following image, submit a license request.
-{{:dglux5_wiki:installation:paviewerlicense.png?direct|}}
-The license type is either JACE, Supervisor, or Unlimited.</WRAP>
-{{anchor:nax_viewer_remote}}
-==== Niagara AX Project Assist Viewer: Remote Installation ====
-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.
-  - Download the [[http://dglux.com/download/project-assist-viewer-niagara-ax-installation|Project Assist 2.5 Viewer (AX) 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:
-    -If your Niagara Workbench environment does not already include the Palette, add the Palette by selecting **Windows** > **Sidebars** > **Palette**.
-    - <WRAP>In the Palette, browse to the ''dglogik'' module, and click **OK**.
-The ''DGLuxService'' module is added to the Palette.</WRAP>
-    - 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'').
-  - Go to ''<server>:port/dglux5'', for example ''localhost:8080/dglux5''.
-  - <WRAP>In the Licensing dialog, submit a license request.
-The license type is either JACE, Supervisor, or Unlimited.</WRAP>
-{{anchor:nax_dgtemplate_local}}
-==== Niagara AX DGLux5 with Project Assist Template: Local Installation ====
-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.
-  - Download the [[http://dglux.com/download/ax-supervisor-installation|DGLux5 Niagara AX Supervisor installation file]]. (Requires dglux.com password)
-  - Download the [[http://dglux.com/download/project-assist-installation|Project Assist 2.5 template]]. (Requires dglux.com password)
-  - [[dglux5_wiki:installation:niagaraax#local|Reinstall DGLux5 on the local station]].
-  - Install the template:
-    - In DGLux5, choose **Project** > **Export**%%/%%**Import** > **Import Project**.
-    - Click **Choose File**, and choose ''PA2.zip''.
-    - Click **OK**.
-{{anchor:nax_dgtemplate_remote}}
-==== Niagara AX DGLux5 with Project Assist Template: Remote Installation ====
-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.
-  - Download the [[http://dglux.com/download/ax-supervisor-installation|DGLux5 Niagara AX Supervisor installation file]]. (Requires dglux.com password)
-  - Download the [[http://dglux.com/download/project-assist-installation|Project Assist 2.5 template]]. (Requires dglux.com password)
-  - [[dglux5_wiki:installation:niagaraax#remote|Reinstall DGLux5 on the remote station]].
-  - Install the template:
-    - In DGLux5, choose **Project** > **Export**%%/%%**Import** > **Import Project**.
-    - Click **Choose File**, and choose ''PA2.zip''.
-    - Click **OK**.
-{{anchor:nax_dgtemplate_jace}}
-==== Niagara AX DGLux5 with Project Assist Template: JACE Installation ====
-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.
-  - Download the [[http://dglux.com/download/ax-jace-installation|DGLux5 AX JACE installation file]]. (Requires dglux.com password)
-  - Download the [[http://dglux.com/download/project-assist-installation|Project Assist 2.5 template]]. (Requires dglux.com password)
-  - [[dglux5_wiki:installation:niagaraax#jace|Reinstall DGLux5 on the JACE]].
-  - Install the template:
-    - In DGLux5, choose **Project** > **Export**%%/%%**Import** > **Import Project**.
-    - Click **Choose File**, and choose ''PA2.zip''.
-    - Click **OK**.
-----
-{{anchor:upgrade25}}
-===== Upgrading to Project Assist 2.5 =====
-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 [[http://dglux.com/download/project-assist-installation|Project Assist template]].
-<WRAP info>===Notes===
-  * If both templates have the same name, the new template replaces the old one.
-  * This installation replaces both the ''PA2'' project and the ''HVAC2'' library.
-</WRAP>
-**Upgrading Project Assist**
-  - Download the installer zip file.
-  - 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.
-----
-{{anchor:update_viewer}}
-===== Updating Project Assist Viewer on Niagara =====
-==== Latest PA Viewer Build ====
-Download the latest PA viewer here https://dglogik.com/download.
-==== Prerequisites ====
-  - Change the extension of the distribution file from ''.dist'' to ''.zip''.
-  - Unzip the folder.
-  - Stop all the instances before updating.
-  - Back up of all your projects ([[dglux5_wiki:project_assist:2_0_v10:import_export:home|How to Import and Export Files (PA)]])
-==== Update Project Assist Viewer (Local System) ====
-=== General approach ===
-This section covers the process of how to replace **dglogik.jar** and override **app** and **proj** folders.
-  - Download the latest PA Viewer and unzip it.
-  - Copy **dglogik.jar** form ''<unzipped location>\pa-viewer-n4-*niagara_home\modules'' to Niagara 4 modules directory (typically, this is ''<Niagara installation folder>\modules'').
-  - 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.
-=== An alternative approach ===
-This section describes an alternative approach when the above steps don't work.
-=== Step 1: Export user project content from PA2 viewer ===
-  - Open PA viewer.
-  - Click on **Settings** and select **Export File**.
-  - Select the contents from the project's Export panel and click on **Export**.
-  - The file is exported on your local drive.
-=== Step 2: Copy node folder from the exported file and overwrite with the latest downloaded PA Viewer ===
-  - Unzip and open the file exported on Step 1.
-  - 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.
-  - Now your project content is copied or updated to the latest PA Viewer.
-=== Step 3: Updating your existing PA viewer project with modified latest downloaded PA viewer dglux5 and dglogik.jar ===
-  - 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.
-  - Copy **dglogik.jar** form ''<unzipped modified downloaded location>\pa-viewer-n4-*\niagara_home\modules'' to Niagara 4 modules directory (typically, ''<Niagara installation folder>\module'').
-  - Copy ''\dglux5'' folder from ''<unzipped modified downloaded location>niagara_user_home\shared'' and move it to ''<Niagara Installation Folder>\<Tridium or Distech>\Tridium\Shared''
-==== Update Project Assist Viewer (Remote - JACE) ====
-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.
-==== Updating only Project Assist Viewer JAR File (Not the UI) on JACE and Locally ====
-  - Perform the installation on a local machine.
-  - Start workbench and navigate to Nav / Host / Platform / Software Manager.
-  - Verify that **Avail.Version** is the latest version. Please visit http://dglux.com/download/niagara4-installation for details {{:dglux5_wiki:project_assist:2_0_v10:installation:update_viewer_1.png?direct|}}
-  - 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. {{:dglux5_wiki:project_assist:2_0_v10:installation:update_viewer_2.png?direct|}}
-  - In the **Software Manager** view, ''dglogik.jar'' should be marked as **Out of Date**. Select just that row.
-  - Press the **Upgrade** button.
-  - Press the **Commit** button.
-  - Accept all the further steps.
-----
-<WRAP left>[[dglux5_wiki:project_assist:2_0_v10:release_notes:home|Previous: Release Notes]]</WRAP>
-<WRAP right>[[dglux5_wiki:project_assist:2_0_v10:start:home|Next: How to Start and Open Projects]]</WRAP>