Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 2 Next »

Periscope Prerequisites

  • Periscope must run on a Niagara4 station, version 4.0 or higher.  It is recommended that Periscope run on a Niagara Web Supervisor or SoftJACE due to increased storage capacity and speed but it can also run on any Niagara4 compatible JACE.
  • Any station running Periscope must have at least 6MB available.
  • Periscope is a web application and requires a modern browser. Officially supported browsers include IE10+ as well as the latest versions of Chrome and Firefox.

Periscope will soon support SkySpark as well as Niagara4

Installing Periscope

Saving and stopping your station:

 • Open your Platform and access the Application Director

• Save your running station (Save Bog)
• Stop the station (Stop)

* The menu shown is located on the right side of the Application Director window

• Close Workbench

Installing jar, license and certificate files to your Workbench to be transferred to the WS:

• Using Windows Explorer, navigate to your current build of Niagara

• Place the periscope.jar file in the modules folder under your Niagara build

• Place your Periscope license file in the licenses folder under your Niagara build

Adding the Periscope Service in Niagara4

• Open Workbench, reopen your Platform and access the Application Director

• Start the station

• Open the periscope palette

• Drag and drop the PeriscopeService from the pallete into your station's Services

• After which, Periscope installation will be complete and you may open Periscope by going to http:/(IP address of the Web Supervisor/JACE)/periscope

User Setup

Important Notes:

• If your dashboard locks up, try refreshing the page.
• You can delete a user’s dashboard by deleting the folder station:\files\Periscope\users\[username]
techsupport@activelogix.com for support questions

Installing Periscope

Saving and stopping your station:

 • Open your Platform and access the Application Director

• Save your running station (Save Bog)
• Stop the station (Stop)


* The menu shown is located on the right side of the Application Director window

• Close Workbench

Installing jar, license and certificate files to your Workbench to be transferred to the WS:

• Using Windows Explorer, navigate to your current build of Niagara

• Place the alxPeriscope JAR file in the modules folder under your Niagara build

• Place your Periscope license file in the licenses folder under your Niagara build

• Place your certificate in the certificate folder under your Niagara build

Adding the Periscope Service in NiagaraAX

• Open Workbench, reopen your Platform and access the Application Director

• Start the station
• Make sure you have added oBIX Network to your drivers if it is not already present


• Open the alxPeriscope palette

• Drag and drop the PeriscopeService from the pallete into your station's Services

• Perform the basic dashboard user setup (see below)

• After which, Periscope installation will be complete and you may open Periscope by going to http:/(IP address of the Web Supervisor/JACE)/periscope

User Setup

Users cannot be created until there is a CategoryService for the dashboard users. To set this up, first navigate to Category Service > Category Manager via the drop-down on the right side after selecting the Category Service.

Then, click "New" at the bottom of the window to add a new category called whatever you like ("Periscope" or "DashboardUser" are recommended). When creating this new category be sure to set the index for the category to something other than zero so that it will become enabled.

All users are capable of accessing their own Periscope dashboard if they meet these requirements:

  • Operator Read access to all mapped points is enabled
  • Admin Invoke on the PeriscopeService, Meter and Rollover objects
  • (Optionally) Periscope HTML folder if you wish for the user to be able to navigate to "/periscope" by navigating to the host server directly instead of having to type "/periscope"

Below is an example configuration of this category (DashboardUser):

Finally, navigate to the user that was created earlier specifically for dashboard purposes and click the arrows beside "permissions". (Note: if you don't see this user, the station has not been started yet. On station start, this user will be created if it does not exist already.)

If using Niagara 4, permissions are now handled in the Role Manager. Create a new role for "DashboardUser" and follow the steps below but complete them by ensuring that the checkbox for "DashboardUser" is checked in the list of roles (once the DashboardUser role has been added).

and ensure that the newly created category for the dashboard user is set up like so:

• Periscope has now been successfully installed on your Web Supervisor!

Initial Periscope Configuration

To configure Periscope, go to http://(IP address of the Web Supervisor/JACE)/periscopeconfig and log in as a super user. Initial Periscope setup must be performed by a super user. Under the locations tab, add several locations or buildings by selecting the new location button at the bottom of the screen. Also make sure to enter a square footage and a blended rate for electricity, and other utilities as desired. At least one trend, point, meter, or web/PX page should be added before accessing Periscope. Periscope’s automatic discovery wizard will instantly import all available numeric points and trends, as well as any meters or PX pages discovered in the Web Supervisor/JACE database. Any additional variables added after the initial discovery will not show up in Periscope until the user does a manual discovery. This is done by pressing the “discover” button at the bottom of the respective variable’s configuration screen. Once configured, the user can access Periscope by going to http://(IP address of the Web Supervisor/JACE)/periscope and entering their credentials.

You can open Periscope by going to http://(IP address of the Web Supervisor/JACE)/periscope

Important Notes:


• If your dashboard locks up, try refreshing the page.
• You can delete a user’s dashboard by deleting the folder station:\files\Periscope\users\[username]
• techsupport@activelogix.com for support questions

  • No labels