Installing Workbench

A wizard manages the installation of Workbench and the web UI. The software installation ZIP file is available for downloading from your software vendor. This procedure describes how to install Workbench for the first time on a computer.
Prerequisites: The PC is connected to the network shared by the remote controller(s). You downloaded the Workbench installation executable ZIP file and have the necessary license(s) to use the software.
This computer could belong to a systems integrator who connects it temporarily to the network that supports a stand-alone controller. Or it could be a computer connected to the network and used daily to manage a complex, company-wide system.
 NOTE: The system supports only English. Additional lexicons are available to Workbench users only. 
Perform the following steps:
  1. Close all open applications.
  2. Extract all files from the software image ZIP file to any folder on your hard drive.
  3. Open Windows Explorer, navigate to the folder you just created, and double-click the Installer_64.exe file.
    The Installation wizard opens.
  4. To begin the installation, click Next, accept the license agreement and click Next.

    The wizard collects information with a series of prompts including:

    • Where to set up the Niagara Home Folder. This folder defaults to:C:\niagara\niagara followed by the version numbers. The System Home (Sys Home or niagara_home) is where the wizard installs Workbench, and from where you use Workbench to commission each remote controller. The System Home contains the core software modules, the JRE (Java Runtime Environment), binary executables, and licenses (in the C:\niagara\niagara[version numbers]\security\licenses subfolder). It contains no configuration files. Except when upgrading, the runtime files in the System Home are read-only. Although you may specify another location for the System Home, the default folder is generally recommended as the remote controllers use this same System Home directory.

      To enable Workbench to commission remote controllers (hosts), leave This instance of ... will be used as an installation tool selected.

      If you select a different location for the System Home, a confirmation window requests approval. The Refresh button recomputes the space available statistic, and can be useful if you change the target drive location from the default C: to another drive partition.

    • Where to set up the User Home folder. This location defaults to C:\ProgramData\Niagara4.x\<brand>. This folder contains all configurable data including stations, templates, registry, logs and other data. Separating data that can be configured from the software System Home (C:\niagara\niagara) is a security feature of the Niagara Framework and is designed to prevent unauthorized software manipulation.
    • What to define for the system passphrase. You may skip this step and set up the system passphrase later.

      The system uses this phrase (which defaults to the factory default platform password: Admin12345) to protect sensitive information stored in file systems, and on the SD card in each controller. The system passphrase encrypts portable files, such as backups and station copies. You should define a strong system passphrase.

      If your installation is licensed for FIPS (Federal Information Processing Standard), the passphrase must be at least 14 characters including at least one number, as well as lower and upper case letters.

       WARNING: Remember, and store the system passphrase in a safe place. If you lose it, you will lose access to encrypted data. 
    • Where to install shortcuts.

    Depending on each individual installation, the wizard may present additional prompts.

  5. When all information is collected, click Next.

    The wizard installs the software and prompts you for what to do next.

    The platform daemon is a program that runs independently from the core runtime. It is pre-installed at the factory on every controller, and runs when the controller boots up. The platform daemon, locally installed and running on a PC, opens the Workbench client platform connection to the local (My Host) platform and enables remote client platform connections to the PC.

  6. To continue, click Finish.
    Workbench confirms that the software is licensed. This may take a minute or so. After confirming the license, the wizard closes and, if you configured it to do so, opens Workbench.