1. Periscope Home . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31.1 Periscope Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51.2 Understanding the Basics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 61.3 Getting Started . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7

1.3.1 Installation (Niagara) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 81.3.2 Installation (SkySpark) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 101.3.3 Configuring Users (Niagara) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 131.3.4 Configuring Users (SkySpark) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 151.3.5 Tagging (Niagara) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17

1.3.5.1 Tagging Sites . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 191.3.5.2 Tagging Points & Histories . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 211.3.5.3 Tagging Equipment . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 241.3.5.4 Relations / Refs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 251.3.5.5 Hierarchies . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26

1.3.6 Tagging (SkySpark) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 281.3.6.1 Tagging Sites (SkySpark) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 291.3.6.2 Tagging Points & Histories (SkySpark) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 311.3.6.3 Tagging Equipment (SkySpark) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 331.3.6.4 Relations / Refs (SkySpark) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 341.3.6.5 Hierarchies / NavTrees (SkySpark) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37

1.4 Using Periscope . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 381.4.1 Navigation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 391.4.2 Context Sensitive Views . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 401.4.3 Kiosk Mode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 421.4.4 Dynamic Histories (Niagara) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 431.4.5 Managing Views . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 441.4.6 Duplicating a View (Niagara) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 481.4.7 Duplicating a View (SkySpark) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 501.4.8 Unit Conversions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 531.4.9 Series Transform (Niagara Only) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 54

1.5 Licensing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 561.6 Viewlets . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 57

1.6.1 Alarm Timeline . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 581.6.2 Baseline . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 591.6.3 Demand Duration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 611.6.4 Energy Profile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 631.6.5 Green Tips . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 651.6.6 IFrame . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 681.6.7 Image . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 691.6.8 KPI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 701.6.9 Live Point . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 721.6.10 Multi Chart . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 731.6.11 Pie Chart . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 751.6.12 Point Table . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 771.6.13 Ranking Chart . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 781.6.14 Simple Gauge . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 801.6.15 Site Scatter Plot . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 821.6.16 Speedometer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 841.6.17 Liquid Gauge . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 861.6.18 Map . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 88

1.7 Views . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 891.7.1 Alarm Timeline View (Niagara) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 911.7.2 Dashboard View . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 931.7.3 Heat Map View . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 951.7.4 IFrame View . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 961.7.5 Map View and Viewlet . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 971.7.6 PX Connect View . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 101

1.7.6.1 Guide to Hyperlinking PX Views . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1021.7.7 Spark Timeline (SkySpark) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1031.7.8 Tree Map View . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 105

1.8 Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1061.8.1 About . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1071.8.2 Database . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1081.8.3 General Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1091.8.4 Kiosk . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1101.8.5 Style / Themes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1111.8.6 View Manager . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 113

1.9 Developer API . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1141.10 FAQs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 115

3

Periscope Home

Search this documentation

Table of

Contents

Periscope OverviewUnderstanding the BasicsGetting Started

Installation (Niagara)Installation (SkySpark)Configuring Users (Niagara)Configuring Users (SkySpark)Tagging (Niagara)

Tagging SitesTagging Points & HistoriesTagging EquipmentRelations / RefsHierarchies

Tagging (SkySpark)Tagging Sites (SkySpark)Tagging Points & Histories (SkySpark)Tagging Equipment (SkySpark)Relations / Refs (SkySpark)Hierarchies / NavTrees (SkySpark)

Using PeriscopeNavigationContext Sensitive ViewsKiosk ModeDynamic Histories (Niagara)Managing ViewsDuplicating a View (Niagara)Duplicating a View (SkySpark)Unit ConversionsSeries Transform (Niagara Only)

LicensingViewlets

Alarm TimelineBaselineDemand DurationEnergy ProfileGreen TipsIFrameImageKPILive PointMulti ChartPie ChartPoint Table

Recently Updated Pages

MapJan 11, 2018 created by • Paul Ogle

Liquid GaugeJan 11, 2018 created by • Paul Ogle

Getting StartedDec 19, 2017 updated by • Mark Fenimore • view change

Tagging Equipment (SkySpark)Dec 04, 2017 updated by • Mark Fenimore • view change

Configuring Users (SkySpark)Dec 04, 2017 updated by • Mark Fenimore • view change

Space Contributors

Mark Fenimore (1 day ago)Charles Patton Jr (13 days ago)Joseph Page (16 days ago)Paul Ogle (27 days ago)Tucker Watson (188 days ago)...

4

Ranking ChartSimple GaugeSite Scatter PlotSpeedometerLiquid GaugeMap

ViewsAlarm Timeline View (Niagara)Dashboard ViewHeat Map ViewIFrame ViewMap View and ViewletPX Connect View

Guide to Hyperlinking PX ViewsSpark Timeline (SkySpark)Tree Map View

SettingsAboutDatabaseGeneral SettingsKioskStyle / ThemesView Manager

Developer APIFAQs

5

Periscope Overview

About Periscope

PeriscopeTM is a rich internetapplication (RIA) built on HTML5, anopen source framework for buildingand maintaining expressive webapplications that deploy consistentlyon all major browsers, desktops, andoperating systems. Periscope runsas a service on a Niagara4 station (aplatform marketed by most of themajor controls suppliers) and can beeasily integrated with third partyBACnet, LonWorks, Modbus andother standard protocols. It providesa web-based client that cangraphically display and analyze anyinformation contained in theautomation control system, as wellas related items like weather,occupancy, and production fromother traditional databases.

Periscope Benefits

Periscope is unique in its ability to allow each and every user the ability to easily customize (in minutes) their own “views” of various data,histories, and metrics, including energy trends, building comparisons, weather data, network status, consumption efficiencies, key performanceindices, and more. Periscope can even display the custom pages built with proprietary graphics tools, thus preserving prior investments whileenabling side-by-side comparisons of operating graphics with related variables and performance trends.

Periscope Goals

Designed to promote behavioral change through wider access to critical facility control parameters, Periscope enables a high level of engagementby facility stakeholders that, for the first time, can see the real-time impact of the choices they make in utilization of facility resources like lighting,electricity, water and other consumables. Using Periscope, facility stakeholders can truly become “agents of change”, with the ability todramatically influence the demand on limited facility resources.

6

Understanding the BasicsHosting Platforms

JACE®

JACE controllers are embedded computersrunning the Niagara Framework® software.JACEs are distributed throughout thecustomer’s network and they provideconnectivity to the many different physicaldevices and systems within a building.JACEs connect to common buildingautomation systems, metering, lighting andother smart devices using protocols such asLonWorks, BACnet, Modbus, or variousproprietary protocols. The JACE providescontrol logic, trending, scheduling andalarming and allows real-time point data tobe brought into Periscope.

Web Supervisor™

The Web Supervisor is a desktop server orPC running the Niagara Framework. TheSupervisor is designed to manage anetwork of JACEs or to monitor points fromthird party servers. It reduces the costs ofmanaging and controlling multiple buildingsand allows centralized engineering,alarming, scheduling and trending of remoteequipment. The Web Supervisor supportsmultiple client workstations, and has anextensive security/password model toprotect user information. A Web Supervisoris often the best location for Periscopesoftware because historical data trends fromnetworks of JACEs and points from thirdparty servers are generally stored here. Livedata points must also be mapped to theSupervisor if displayed in Periscope.

SkySpark®

SkySpark by SkyFoundry is an openplatform that will run on almost anycomputer from a laptop to a cloud hostingprovider. SkySpark is an analytics platformthat automatically analyzes data fromautomation systems, meters, sensors, andother smart devices in order to identifyissues, faults, trends, correlations, andopportunities for operational improvementsand cost reduction.

 

Dashboard Terminology

Views

The core user interface components ofPeriscope are "views".  Views are chosenfrom an ever-expanding library and containthings such as a Dashboard View, AlarmingView, IFrame View, Map View and more. Views are unique per user, and each usercan add their own views and configure themas they choose.  Views can be assigned toa specific level of the hierarchy, whichmeans that some views appear only at thetop-level or perhaps only when viewingsites. Views appear as a vertical list of iconson the left-hand side of Periscope's UI.   

Viewlets

Sometimes referred to as a widget or pod,viewlets are the data windows used topopulate a user’s “Dashboard View”, whichrefers to the Periscope user’s layout of theirinformation. Viewlets can work with livepoint data and/or historical data, or theymay display analytical information such asalarms or analytics results.  Each viewlethas different capabilities and configurationoptions which are covered later in thedocumentation.

Dashboard Basics

Setup

The user can modify their dashboard and itsviewlets in a variety of ways. Viewlets canbe added, moved and resized to fill user'sViews with useful information.  The “plus”button allows users to choose to add newviewlets to their dashboard from the viewletlibrary.  Viewlet configuration options areaccessible through a menu (wrench icon) ineach viewlet. Site colors will remainconsistent across multiple viewletsautomatically for ease of identification.

Points

”Points” refer to data within the Niagaranetwork that consists of live, real-timevalues or setpoints. Viewlets which rely onpoint data have the ability to update inseconds, and provide immediate indicationof a change of status or value. The PointTable Viewlet is an example of a viewletthat uses points.

Trends

“Trends” refer to data sets that containhistoric information. Trends can consist ofdata points plotted for time periods reachingas far back as data is available. Certainviewlets rely on trend data to give users adetailed view of energy usage for auser-selected time range. This can beuseful in identifying areas of concern oropportunities to reduce energyconsumption.

7

Getting Started

Click on the links below to learn about the steps required to get Periscope Versions 3.0+ licensed, installed and configured for operation. 

Installation (Niagara)Installation (SkySpark)Configuring Users (Niagara)Configuring Users (SkySpark)Tagging (Niagara)Tagging (SkySpark)

8

1. 2.

Installation (Niagara)

Periscope Prerequisites

Periscope (versions 3.0+) must run on a Niagara4 station, version 4.0 or higher.  It is recommended that Periscope run on a Niagara WebSupervisor 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 versionsof Chrome and Firefox.

Installing Periscope

Saving and Stopping your Station

Open your Niagara Platform and open the Application DirectorSave your running station (Save Bog)Stop the station (Stop)

Installing Periscope JAR file

Using Windows Explorer, navigate to your   of Niagaracurrent buildTypically: C:/Niagara/Niagara-4.X

Place the  file and any other Periscope-related modules in the   folder under your Niagara buildperiscope-rt.jar  modules

Adding the Periscope Service in Niagara4

Open Workbench, reopen your Platform and access the Application DirectorStart the stationOpen the   palette:periscope

In Workbench's upper options menu, select Window > Side Bars > PaletteIn Palette on lower-left corner of Workbench, select the folder icon and search for periscope

Drag and drop the PeriscopeService from the periscope palette into your station's Services container

Installing License File

The Periscope license file is not a normal Niagara license and needs to be installed separately.  The license can be automatically "fetched" fromour licensing server as long as the Niagara server has access to the internet.

Automatic Installation

To automatically install or "fetch" your license:

Navigate to   within your Workbench stationServices/PeriscopeServiceRight-click on   and select PeriscopeService Action > Fetch License

At this point your license file will be downloaded from Periscope servers, copied into the appropriate directory, and loaded. You should now beable to access Periscope through a browser at http://IP_of_host/periscope.

Manual Installation

To manually install the license, copy the license file into the following folder:

Alternatively, in 4.0 this is possible via the page as an administrator.About

9

{STATION_HOME}/shared/periscopeOn a typical CPU, this will be: C:\ProgramData\Niagara-4.X\{brand}\station\{station_name}\shared\periscope

The "periscope" folder should be created if it does not already exist in your station shared folder. 

Debug LicenseThe "Debug License" action will generate some additional information about your license file into the Station Output. This can be auseful tool to identify license problems or assist tech support.

• Contact techsupport@activelogix.com for support questions

10

Installation (SkySpark)

Periscope Prerequisites

SkySpark is a supported platform on Periscope 4.0 versions and higherAny station running Periscope must have at least 6MB available.Periscope is a web application and requires a modern browser. Officially supported browsers include the latest versions of Chrome,Firefox and IE (Edge).Java 8 - ( )Oracle Download Link

Click here to expand...

While SkySpark will technically run on it's own with Java 7, Periscope itself has dependencies on Java 8 - remaining in-line withNiagara's Java 8 dependencies.

If not on JAVA 8, it will be immediately obvious when attempting to enable the extension later on because you will receive an error: ""Method not mapped to java.lang.reflect correctly

Installing Periscope

Installing Periscope Pod file

Copy the file distributed by Activelogix into the  directory of the SkySpark installationperiscopeExt.pod  lib/fan

It's important that the host this pod is installed on matches up with the host ID that was licensed. You may find your skyspark Host ID in thediagnostics tab of the debug app.

11

Enabling the Extension

As an  , navigate to the project in SkySpark that you would like to use the extension withadministratorNavigate to the  app, then click the  tab and select  in the tree-menu on the leftSettings Exts Extensions Scroll until you see  and click Periscope Enable

       

Installing License File

The Periscope license needs to be installed separately.  The license can be automatically "fetched" from our licensing server as long as theinstallation server has access to the internet.  

Automatic Installation

In Periscope 4.0+, automatic installation is possible via the page as an administrator next to the site chooser.About

After clicking , your license file will be downloaded from Periscope servers, copied into the appropriate directory, and loaded. YouFetch Licenseshould now be able to access Periscope through a browser at   Where "{proj}" is the name of thehttp://{IP_of_host}/api/{proj}/ext/periscope.SkySpark project the extension was enabled for previously (without the open and closing brackets).

If enabled for the demo project the URL would be:

http://host/api/demo/ext/periscope

Manual Installation

To manually install the license, copy the license file into the following folder:

Enabling this extension will automatically use the existing Folio database and create the necessary tagged records forperiscopeoperation. Disabling this extension will not remove these records.

Periscope works on the latest version of SkySpark version at the time of writing. It's possible the old style apps (such as3.0 2.0extensions/settings) may change in later versions, if so, please see Skyspark documentation on enabling extensions.

12

{SKYSPARK_INSTALL_DIRECTORY}/var/lic

13

Configuring Users (Niagara)

Each Niagara user has their own Periscope space to create views and viewlets.  This means that two users could create their own Periscopedashboard with unique viewlets and they would not conflict.  Periscope uses the Niagara4 security model; In order for a Periscope user to seespecific data, they need access to it in Niagara.  This is configured using the Niagara and .RoleService CategoryService

Minimum User Requirements

Users must have access on the  as well as every component in the station that will be accessed withinOperator Read PeriscopeService Periscope.  This includes components in the Hierarchy as well as point or trends that may appear in views.  Users must also have Operator Writeaccess to every component in the station that the user may modify using the Database view..

Hiding Views

Individual views or viewlets can be hidden from a user by modifying the categories.  Views can be found in PeriscopeService/PeriscopeDatabase/.  The Add View dialog will only show views that the user has access operator read access to.  Additionally, viewlets can be hidden byViews

modifying permissions of the components within PeriscopeService/PeriscopeDatabase/Viewlets.

Hiding Settings 

Individual settings pages can be hidden in the same way that views and viewlets are hidden (see above). Settings pages are locatedHiding Viewsin  . Additionally, the settings icon itself can be hidden from a user's dashboard by adding aPeriscopeService/PeriscopeDatabase/Settingsbaja:Boolean marker tag of ID "hs:showSettings" to a Periscope user folder, located in  Setting thePeriscopeService/PeriscopeDatabase/Users. value to "false" will hide the settings icon. 

Read-Only

Users can be converted to read-only access by adding a baja:Boolean marker tag of ID "hs:readOnly" to a Periscope user rec, located in PeriscopSetting the value to "true" will restrict the user from editing any dashboard Views or Viewlets. eService/PeriscopeDatabase/Users.

Hiding the Settings icon does not make a user secure - it only modifies the user interface. It's important that proper Niagara permissionsare set up in addition to hiding the settings icon

14

1. 2. 3.

Duplicating Users & Dashboard Setups

Periscope user dashboards can be easily duplicated, which can serve as a backup or as a default view for new users. To duplicate a userdashboard:

Navigate to /PeriscopeService/PeriscopeDatabase/UsersDuplicate the user folder you would like to duplicate; in the event of copying/pasting be sure to preserve all links and relationships presentSet the name of the duplicated user to the new/target user

The next time the new user logs in they will have a new copy of all views and viewlets from the original user.

The new user must first be created in the Niagara UserService before duplicating a dashboard in their name

15

1. 2. 3.

Configuring Users (SkySpark)

Each SkySpark user has their own Periscope views and viewlets.  This means that two users could create their own Periscope dashboard withunique viewlets and they would not conflict. Periscope on SkySpark uses to control what is visible to the user.access filters

Hiding Views

Individual views or viewlets can be hidden from a user by using access filters. For instance, if we wanted to disable the Map View for our superuser, the following could be done from the user management screen on the host.

Hiding Settings

You may want to disable the settings cog wheel at the upper right hand corner of the dashboard screen. To do so, simply navigate to the General tab underneath settings and toggle the  option.Show Settings

Duplicating Users

Periscope user dashboards can be easily duplicated, which can serve as a backup or as a default view for new users. To duplicate a userdashboard:

Navigate to the  app in SkySpark for your projectFolioLocate the ids for the periscope users you are copying with the following input: readAll(periscope and user)Execute the following, replacing the user_to_copy and the new_periscope_user with the respective periscopeUser ids:

Note that views here are called  when filtering. This is due to a naming conflict with SkySpark requiring the periscopeperiscopeViewprefix. Viewlet filtering would be done using a  not periscopeViewletAccessFilter. If you require assistance withviewletAccessFilteraccess filters please contact techsupport@activelogix.com

Hiding the Settings icon does not make a user secure - it only modifies the UI. It's important that proper permissions are set up inaddition to hiding the setting.

16

3.

copyPeriscopeUser(readById(@user_to_copy),readById(@new_periscope_user))

The next time the new user logs in they will have a new copy of all views and viewlets from the original user.

Periscope users and SkySpark user records are not the same. SkySpark manages users at the host level where-as periscope users aremanaged at the project level. When duplicating users, be sure you are using the IDs for the Periscope user. You can verify that therecord is the periscope user because it will have both and marker tags.periscope user

The new user must exist before duplicating a dashboard in their name. The new user record is created upon first logging in with theuser's credentials.

17

1. 2. 3.

Tagging (Niagara)

Adding

the

Haystack

Tag

Dictionary

Periscope usesthe ProjectHaystacktag-basedmodel (http://www.project-hay

 asstack.org)the underlyingstructure forthedashboard'ssetup. Thesetags and theircorrespondingrelations/refsallowPeriscope tomakeassumptionsabout the dataand eliminatesthe need formanual datadiscovery andmapping inPeriscope (asrequired inPeriscopeConfig in versions 2.x and prior).  

Niagara4 has support for Haystack out of the box, and it can be enabled by completing the following steps:

Navigate to the Services > TagDictionaryServiceOpen the palettehaystackDrag the Haystack tag dictionary from the palette into your Tag Dictionary Manager

Once the Haystack Tag Dictionary is installed a new tag namespace "hs" is available which Periscope will use for queries in the dashboard userinterface.  At this point, all data that needs to be viewed within Periscope should begin to be tagged according to the . Project Haystack standards

Tagging Tools

There are several tools available to assist tagging, including:

Creating your Own Tag Dictionary:  A custom tag dictionary can be created which can contain rules defining haystack tags.  For example,this could be used to map naming conventions to Haystack Tags for batch tagging.Implied Tags: Niagara4 can automatically tag records based off of the component type, properties, or placement within the station, suchas "point" to Control Points.  This is a powerful feature that can vastly speed up tagging time.  It's recommended that you create a newSmart Tag Dictionary that uses implied tagging to automate all tags where possible. You can view implied tags of a component in the"Edit Tags" dialog.Periscope Database View: The Database View in Periscope's settings menu allows users to manage tags or create new haystackrecords through Periscope's own user interface.Using the Program Service: The Program Service (Services > ProgramService) allows for the batch tagging of points in Niagara. Pointscan be dragged and dropped into the Program Service pane from the tree on the left, or they can be searched for and added manually. 

Tagging Continued

For more information on tagging your data for Periscope, see the following tutorials:

18

Tagging SitesTagging Points & HistoriesTagging EquipmentRelations / RefsHierarchies

 

19

Tagging Sites

Periscope requires that a user has " " defined in the system. Periscope is licensed with 10 sites by defaultsites(more can always be added), and each user must ensure that they have tagged these sites properly in theNiagara database for Periscope to recognize them. 

To begin tagging your sites, you should first determine which buildings or locations will serve as your definedPeriscope sites. Once determined, a good practice is to create a file folder under your Niagara Station named"PeriscopeSites". Under this folder, individual folders for each site can be created and these folders can thenbe tagged with the Haystack tag. In the module palette, there is also a "site" component thaths:site haystack can be used instead of the folders shown on the right. 

To tag a site, right-click the folder or station object and choose "Edit Tags". Open the Haystack tagdictionary, search for "site", and select it from the list. Be sure to hit "save" and the folder is nowtagged. 

Additional hierarchical folders within these site folders could be added as needed for things like equipment, orpossibly campuses or states above the site level (requires a custom hierarchy setup). For more on editing yourhierarchy and adding additional levels of navigation, see editing hierarchies. 

Additional important tags whicha user may want to manuallyadd to a site:

:hs:area This tagdefines the squarefootage of a site. 

 hs:image: This tag isnot a default Haystacktag, but it can bespecified by selectingthe "AddTag" button,choosing "baja:Ord"from the bottom list oftag types, and entering" " in thehs:image"TagId" field. You willthen be able to locatethe image on the localstation using the FileOrd Chooser folder onthe right. The Image

can thenViewletreference this imagepath if the "Tag" optionis selected in itsconfiguration. More Project Haystacktags related to sitescan be found . here

The other tags seen in theimage to the right are the resultof the location having aplacement on the , asMap Viewwell as several other PeriscopeUI related details. 

Data should now be referenced to these sites and other hierarchical elements using Niagara4's "Relation Mark" reference tags. This will allowPeriscope to know what data is associated with what site and/or potential equipment in order to create context-sensitive graphics. These "Refs"also automatically generate Niagara4 hierarchies used as Periscope navigation levels.  For more information on creating references, click . here

Alternative Method for Site TaggingIn an alternative method to creating and tagging folders, a user could instead tag corresponding Networks or Network Devices with hs:si

 or   tags if they neatly aligned with particular buildings and equipment. te hs:equip

20

 

21

Tagging Points & Histories

Point Tags

Tagging your points in your station should be done in accordance to the standards listed in their . The basicProject Haystack tag documentationmethod involves right-clicking the point you would like to tag in the Niagara tree and selecting "Edit Tags". From there a user can open and searchthe Haystack tag dictionary (click to learn how to add if it does not show up for you) and add the appropriate tags for each point.here

Minimum Requirements

The following are the minimum requirements for tagging points and histories.  However, we recommend following the full haystack standard whichallows more advanced querying (for example, querying for site meters).  

Points Histories

Tags hs:point

hs:kind

hs:his

n:history

hs:kind

Relations hs:siteRef hs:siteRef

Tagging with the Program Service

To add tags in a batch method, a user can utilize Niagara4's Program Service (Station > Config > Services > ProgramService). In this service,points can be selected in groups, dragged and dropped into the Program Service Batch Editor pane, and then batch-tagged by selecting the "AddTags" button. 

Point Tagging Standards

Below are links to Project Haystack tagging standards for common point types to help ensure you are using the correct tags on your points:

EnergyZonesFans and VFDsVAVsChillersBoilers

In addition to point tagging, "equip" tagging is also extremely useful and necessary for creating proper references between the points and theirrespective equipment. Click for more information on tagging equipment.here

Using the "disMacro" tag

22

Niagara Proxy Points

By default, proxy points (those imported to a supervisory level from a remote device) in the Niagara Network lose all tags that were defined in theremote station (typically a JACE).  This is especially problematic when dealing with points that may contain a history that's also imported.  Startingin Niagara 4.2 you can now keep specific tags, including history tags.

To force an import of these tags from your remote station, navigate to the property sheet view of the Niagara Network and set "Persist FetchedTags" to  This will cause any dynamically fetched tag to persist on the proxy point.  To force a sync, right click on the Niagara Network andtrue.  click Actions > Force Update Niagara Proxy Points.  

  

This forced update will look at each proxy point, check to see if a matching history is being imported, and add the appropriate history tags(typically n:history and the string value of the history's ord). If executed properly, your data points should now have their corresponding importedhistories automatically identified and defined for you, as shown in the graphic below. 

Do you have a lot of energy trends all with the same name like "kWh"? Try batch-adding the "disMacro" tag to your points.

disMacro uses $ to define template parts, so if you wanted your point to display the equipment name followed by the point name, you'dset your disMacro (String) tag as: "$equipRef $navName"

Haystack CacheWhen a user updates tags or other items in the station, they should navigate to Station > Config > Services > PeriscopeService >Haystack Cache, right-click on "Haystack Cache" and choose Actions > Load Cache. This will force the load of any recent Haystacktags that were applied on the station, and ensure that Periscope will show that data appropriately as well.

Implied History TagsIf the history extensions are created at the supervisory level, Niagara will automatically add the and tags as implied tagshs:his n:history

23

1. 2. 3. 4.

5.

Manually Adding Histories (Niagara)

Sometimes a station may have histories that are created outside of a normal history extension, which causes it to lack the appropriate historytags.  These types of trends can be manually added to the Haystack database by creating a new component and tagging the historyappropriately.  For example, let's assume a trend was imported from a .CSV file located at .  To add this to Periscope:/Weather/CharlotteOAT

Create a new Component (or Folder) called CharlotteOATOpen up the Property SheetDrag the "HistoryTags" component from the palette into the property sheetSet the value of "n;history" to the path to the history (case-sensitive) like "/Weather/CharlotteOAT" for a history  on the CharlotteOAT Weat

history deviceherChange the value of "hs:kind" to "Enum" or "String" if appropraite (this tag will not be created if you are using a control point).

for you. 

As with regular histories, manually added histories also need a and  tag. Kind is typically a string tag "Number" and thekind  siteRefsiteRef associates it with the site the trend belongs to. Since licensing is done by site, ensure the site referenced is enabled in thelicense via "Choose Sites".

The  tag may be added via the Database settings view but  must be added natively via Niagara or Skyspark.siteRef kind

24

Tagging Equipment

Tagging equipment in the Niagara database with " " tags allows the controls system (and Periscope) to understand what mechanicalhs:equipequipment the user has discovered. More specific equipment tags (such as ) can also give the software information on the specifichs:elecMetertype of equipment (an electric meter in this case). When these "equips" are paired with references to points, these systems will then know whichpoints are "children" of said equipment and hierarchies can be automatically created in Niagara and Periscope. 

To tag equipment, users should right-click and select "Edit Tags" on the appropriate equipment folders or Network Devices as created/determinedin a similar manner to the process of . This process can be done in batch edits using the Program Service as well. All equipmenttagging sitesshould receive the tag as a mandate, but complementary tags can and often should be added depending on the equipment type. hs:equip

Below are links to Project Haystack tagging standards for common equipment types to help ensure you are using the correct tags on yourequipment:

MetersElectric PanelsAHUsFans and VFDsVAVsUnitary EquipsChillersBoilersLighting 

Assuming site and equip tags are in place, "Relation Marks" should now be implemented to link points to their respective sites andequipment so that Niagara and Periscope know how the data is related. See for more information on setting up theseRelations / Refsrelationships. 

25

Relations / Refs

"Relations" or "references" are the backbone of Niagara hierarchies, and they allow for the navigation schemeof Periscope to be automatically created within the dashboard's user interface. They also enablecontext-sensitive views, viewlets, date ranges and more, which streamlines workflow and drastically reducesthe setup time for dashboard displays. Best practices call for points, sites and equips to all be tagged beforeproceeding with the reference tagging. 

Creating Refs

The following will allow you to create relationships in Niagara:

Select a group of points in the Niagara tree structure that you want to reference to a site, equip, orother hierarchical levelRight-click on this group of points and select "Relation Mark"Navigate to the folder or Network Device that serves as your site or equip, right-click and select"Relate From...X" This should launch a Relation drop-down list for you to choose the type of "Ref" you would like to addbetween the data and its target (shown right)Select the appropriate Ref and your data will now have a relation to this equip or site createdTaking advantage of the Relation Mark already created on the group of points, the user should createall additional Refs for that data in succession. If an was created in the previous step, thehs:equipRefuser could now simply select the site folder or device, right-click and chose "Relate From...X" withoutneeding to trigger another Relation Mark as beforeUsers also need to create Refs between equips and sites, since sites are "parents" of the equipsunderneath them

Determining the Proper Refs

Which type of Ref tag you need to add depends on the relationship between the data and its target. Typically,you would add the following Refs to acheive a Site > Equip > Point hierarchy structure:

hs:equipRef: point to equip hs:siteRef: point to site AND equip to site

Additional information on the proper Ref tags can be found in the Project Haystack documentation on . If completed properly, Periscopestructureshould now be ready to use and should be able to automate navigation and context-based views for the user, assuming the user selects thedesired hierarchy structure in Periscope's . To learn more about creating custom hierarchies outside of a typical site > equip >General Settingspoint structure, click . here 

Viewing RelationsTo view relations in Niagara at any time, right-click on an object or point and select Views > Relations Sheet for a list of incoming andoutgoing Refs.

26

Hierarchies

Relations created in the Niagara database result in hierarchies that are generated automatically inthe Niagara station as well as Periscope. After tagging these Refs, a user's current hierarchy can beviewed in Niagara at the Station > Hierarchy container. This is a good way to check the outcome ofthe relations a user has created.

To edit a hierarchy by creating an additional tier or level outside of the common Site > Equip > Pointstructure discussed in the documentation up to this point, a user will need to complete severalsteps:

Determine a tag for this new level in the hierarchy. For the purpose of this explanation, wewill use the tag " " which would reside at the top level of the hierarchy, above anyhs:campuspredefined sites. Tag your campus level(s) in the same manner you would tag a or . site equipCreate references between all existing points, equips and sites to the newly definedcampus level folder or station object. Ideally, this level of hierarchy would have beencreated when relation marks were being added between levels previously. The user now needs to create and edit a new hierarchy structure in Niagara's HierarchyService (Station > Config > Services > HierarchyService). The user can duplicate theexisting "Periscope_Site_Equip_Point" structure block and add in an additional level for the"campus" in the query structure of the new hierarchy setup, with the added  and hs:campus

relations specified as shown in the image below. hs:campusRef With the new hierarchy structure defined in Niagara Hierarchy Service, the last stepinvolves the user setting this new structure as the preferred hierarchy in Periscope's Gener

drop-down menu. al Settings

27

28

Tagging (SkySpark)

Overview

Periscope uses the Project Haystack tag-based model (  as the underlying structure for the dashboard's setup.http://www.project-haystack.org)These tags and their corresponding relations/refs allow Periscope to make assumptions about the data and eliminates the need for manual datadiscovery and mapping in Periscope (as required in PeriscopeConfig in versions 2.x and prior).  

Tagging all data that needs to be viewed within Periscope is a crucial step to getting up and running. Adhering closely to the Project Haystack is advisable as it will lead to a lower cost of maintenance over time to adhere to a easily-referenced naming convention.standards

Tagging Tools

The primary tagging tool of Periscope is the .inside Database View

Folio: the built-in SkySpark database app is supported for power users who are familiar with the .Axon scripting languagePeriscope Database View: The Database View in Periscope's settings menu allows users to manage tags or create new haystackrecords through Periscope's own user interface.     

Tagging Continued

For more information on tagging your data for Periscope, see the following tutorials:

Tagging Sites (SkySpark)Tagging Points & Histories (SkySpark)Tagging Equipment (SkySpark)Relations / Refs (SkySpark)Hierarchies / NavTrees (SkySpark)

 

29

Tagging Sites (SkySpark)

Periscope requires that " " are defined in the SkySpark project. Periscope is licensed with 10 sites by default (more can always be added),sitesand each user must ensure that they have tagged these sites properly in the Folio database for Periscope to recognize them. Periscope willautomatically read-in all records tagged with a  marker tag as sites.site

To begin tagging your sites, you should first determine which buildings or locations will serve as your defined Periscope sites. Most SkySparkprojects will likely already have some sites that are already configured but if not, it is easy to add a new site.

To start with adding a new site, navigate to the  app and select the  tab.Builder Site

From here, you may select  >  to create a new site and begin building out your hierarchy.New New Site

Additional hierarchical folders within these site folders could be added as needed for things like equipment, or possibly campuses or states abovethe site level (requires a custom hierarchy setup). For more on editing your hierarchy and adding additional levels of navigation, see editinghierarchies. For more information on the Builder app in general, see the (requires a login).official SkySpark training resources

Additional important tags which a user may want to manually add to a site:

:area This tag defines the square footage of a site.  image: This tag is not a default Haystack tag, but it can be specified by selecting the "Add Tag" button and entering the path to the image

uploaded to SkySpark. The can then reference this image path tag if the "Tag" option is selected in its configuration.Image ViewletTo upload an image to SkySpark, navigate to the Folio app in your project and select the tab; then select Files Upload

30

After uploading the image, click the info icon next to the record to display the  of the image. The URI string should be what is used inURIthe image tag. More Project Haystack tags related to sites can be found .here

Map View, as well as several other Periscope UI elements have their own associated tags as well that you may see appear on site records.

For more information on creating references, click .here

 

31

Tagging Points & Histories (SkySpark)

Point Tags

Tagging your points in your SkySpark project should be done in accordance to the standards listed in their .Project Haystack tag documentationThe basic method involves using the Builder app in SkySpark to create the hierarchy as well as add or delete tags.

From the Builder app, a SkySpark administrator can create new sites, equips, points, or even import them from a connector. More details andtutorials for these apps can be found via the (login required).official SkySpark documentation

Minimum Requirements

The following are the minimum requirements for tagging points and histories.  However, we recommend following the full haystack standard whichallows more advanced querying (for example, querying for site meters).  

Points Histories

Tags point

kind

his

kind

Relations siteRef siteRef

Tagging with Axon

To add tags in a batch method, a user can utilize SkySpark's Axon scripting language in the Folio app or in a custom function. This is anadvanced topic so it's recommended to not attempt this method unless familiar with the Axon scripting language.

For instance, if you had a bunch of  equips already tagged and you wanted to additionally specify that these were electrical meters bymeteradding an  tag it would be as easy as invoking the following in Folio:elec

readAll(meter).each(r => r.diff({ elec, batch }).commit)

Remember to always back up your database before performing batch edits. It's also good practice to add an additional tag (like  inbatchthe above example) so that you can quickly re-query just that tag that isn't used anywhere else so you can easily reverse the operationif needed.

32

More information on Axon can be found in the (login required).official SkySpark documentation

Point Tagging Standards

Below are links to Project Haystack tagging standards for common point types to help ensure you are using the correct tags on your points:

EnergyZonesFans and VFDsVAVsChillersBoilers

In addition to point tagging, "equip" tagging is also extremely useful and necessary for creating proper references between the points and theirrespective equipment. Click for more information on tagging equipment.here

Using the "disMacro" tagDo you have a lot of energy trends all with the same name like "kWh"? Try batch-adding the "disMacro" tag to your points.

disMacro uses $ to define template parts, so if you wanted your point to display the equipment name followed by the point name, you'dset your disMacro (String) tag as: "$equipRef $navName"

33

Tagging Equipment (SkySpark)

Tagging equipment in the Folio database with " " tags allows SkySpark (and Periscope) to understand what mechanical equipment the userequiphas discovered. More specific equipment tags (such as ) can also give the software information on the specific type of equipment (anelecMeterelectric meter in this case). When these "equips" are paired with references to points, these systems will then know which points are "children" ofsaid equipment and hierarchies can be automatically created in SkySpark and Periscope. 

To tag equipment, users should select the equipment in either the or SkySpark's own Builder app in a similar manner to theDatabase viewprocess of . This process can be done in batch edits using the Axon scripting language as well. All equipment should receive the tagging sites equi

tag as a mandate, but complementary tags can and often should be added depending on the equipment type. p

Below are links to Project Haystack tagging standards for common equipment types to help ensure you are using the correct tags on yourequipment:

MetersElectric PanelsAHUsFans and VFDsVAVsUnitary EquipsChillersBoilersLighting 

Assuming site and equip tags are in place, "Relations" should now be created to link points to their respective sites and equipment sothat Niagara and Periscope know how the data is related. See for more information on setting up these relationships.Relations / Refs

34

Relations / Refs (SkySpark)

"Relations" or "references" are the backbone of SkySpark navigation hierarchies, and they allow for the navigation scheme of Periscope to beautomatically created within the dashboard's user interface. They also enable context-sensitive views, viewlets, date ranges and more, whichstreamlines workflow and drastically reduces the setup time for dashboard displays. Best practices call for points, sites and equips to all betagged before proceeding with the reference tagging. 

Creating Refs

Establishing relationships is easy if using the Builder app that comes with SkySpark since creating new Equips, Points, etc already contain theappropriate references. When creating new equips, points in this fashion you'll notice that the newly created item will have a  and/or siteRef equip

tag already populated.Ref

Batch editing is also possible from this app view. As an example, let's say you have points underneath RTU-1 but you want to move them to adifferent equip.

Start out by holding down CTRL and clicking each item you wish to modify.SkySpark will alert you to the fact that you are batch editing with a notification at the top of the windowCheck the box of the tag(s) you wish to batch-modify

35

 

Change the value(s) to the desired value and then click the  button that becomes enabled at the top of the screenSave

Creating entirely new relationships is also equally possible by adding a new  type tag like so:Ref

36

After adding a ref tag (making sure to end with "Ref" when naming), you will be able to point that Ref to your intended record. In our example with  note that we would need at least one other record with a  marker tag for SkySpark to detect it.districtRef district

Determining the Proper Refs

Which type of Ref tag you need to add depends on the relationship between the data and its target. Typically, you would add the following Refs toacheive a Site > Equip > Point hierarchy structure:

equipRef: point to equip siteRef: point to site AND equip to site

Additional information on the proper Ref tags can be found in the Project Haystack documentation on . If completed properly, Periscopestructureshould now be ready to use and should be able to automate navigation and context-based views for the user, assuming the user selects thedesired hierarchy structure in Periscope's . To learn more about creating custom hierarchies outside of a typical site > equip >General Settingspoint structure, click . here

37

Hierarchies / NavTrees (SkySpark)

Relations created in SkySpark's folio database result in hierarchies (called "NavTrees" in SkySpark) thatare generated automatically in the Builder app as well as Periscope. After tagging these Refs, a user'scurrent hierarchy can be viewed in SkySpark in the Builder app. This is a good way to check theoutcome of the relations a user has created.

To edit a hierarchy by creating an additional tier or level outside of the common Site > Equip > Pointstructure discussed in the documentation up to this point, a user will need to complete several steps:

Determine a tag for this new level in the hierarchy. For the purpose of this explanation, we willuse the tag " " which would reside at the top level of the hierarchy, above any predefinedcampussites. Tag your campus level(s) in the same manner you would tag a  or . site equipCreate references between all existing points, equips and sites to the newly defined campuslevel record. Ideally, this level of hierarchy would have been created when relation marks werebeing added between levels previously. The user now needs to edit the specific project's  . Navigation meta information isnavMetastored in a special record that can be queried in folio.

Here, to reflect our earlier  changes, we would want to change equipPath to be "/campus/site/[floor]/equip/point" to indicate that atcampusthe top level there should always be a campus. This will immediately take effect and be visible in our Builder app and Periscope after arefresh.To see all navTrees available in a project you can execute the  function in the Folio app. This is the same function that isnavTreesinvoked to populate the hierarchies dropdown inside of Periscope's general settings view.

For more detailed information surrounding Nav Trees please see the (requires login).official SkySpark documentation

38

Using Periscope

Selecting Sites

Before using Periscope the user must choose which " " in the database are available to Periscope, each of which will consume one site in thesiteslicensed allotment. Periscope comes standard with 10 sites licensed, and additional sites can be purchased and added at any time. A site can bedefined by any metered square footage, enabling sub-metering, etc., but is typically considered to be a single facility. A site is designated inNiagara by the haystack tag . For more on tagging sites, click . hs:site here  

To choose your sites in Periscope after they have been tagged properly, navigate to Periscope in your browser and go to Settings (gear cog at thetop right of the page).  This will take you to the "About" lick on the "Choose Sites" button to select which sites are usable by settings page.  CPeriscope. Once chosen, these sites will be tagged with an marker tag in the Niagara4 database.  hs:periscopeSite

Additional Interface Controls

NavigationContext Sensitive ViewsKiosk ModeDynamic Histories (Niagara)Managing ViewsDuplicating a View (Niagara)Duplicating a View (SkySpark)Unit ConversionsSeries Transform (Niagara Only)

39

Navigation

Periscope supports navigation between by using the Navigation Bar (pictured below).  The navigation tree is defined in andcontexts  Settings maps to a Niagara Hierarchy or SkySpark NavTree.  Navigation trees can be different per user and can be simple (such as just viewing sites) oras complex as needed.  Periscope automatically installs and defaults to a hierarchy which consists of every haystack  defined and accessiblesiteby the current user in your database.

When navigating within Periscope you're either at the top-level (  or click on the Periscope icon) or viewing a specific context, which isdisplayed in the navigation bar.  The top level can be thought of as a global view level - any view on this level can contain information about theentire system.  The top level is a good place for an Alarm View, a Map View or a dashboard that may compare sites across the entire system.  

From the top-level, one can begin navigating the hierarchy by clicking on the ( ) icon.  This will drop down a list of elements in the hierarchywhich can then be selected, similar to a a typical tree chart.

Context

"Context" is an important concept in Periscope and is defined as the currently selected hierarchy item.  For example, if you used the navigationbar to reach a site called "Building_X" your context is "Building_X", or more specifically, the ID of the Building_X component.  One reason this isimportant is because views within Periscope are "context sensitive" and can be reused as the context changes across the same hierarchy level. For example, one dashboard can be created which works across  site, as Periscope will copy the layout and settings, while maintaining theeverycontext-dependent data within the Views and Viewlets.  The user can then switch sites using the navigation bar and each viewlet within thedashboard will dynamically update to the new context. 

Views at the "top level" aren't targeting a specific component and are considered to have NO context.

40

1. 2. 3. 4. 5. 6.

Context Sensitive Views

One of the most powerful features of Periscope is that views are  .  That means that one view can be reused across differentcontext sensitivecontexts (such as sites) which can save configuration time as well as help tell a story about how the data changes.  In this document I'll walk youthrough setting up a context sensitive dashboard (View) that can be reused across all sites.

Step 1: Create a new Dashboard View

The first thing we'll do is create a new Dashboard view that is assigned to all sites.  To do this, navigate to your View Settings page or click the

 button in the bottom left of Periscope.  The "Select View" dialog will appear, choose the "Dashboard" view and click OK.  The next dialogthat appears allows us to configure our view.  

In the above dialog I set the name to "Site Dashboard", chose a new icon of a building and set the  to .  This caused our new viewTarget All Sitesto appear on every site in our database.  Now if we navigate to a Site we should see a building icon on the left which takes us to our newDashboard view.

Step 2: Creating context sensitive viewlets

Now that we have a dashboard that is being reused across all of our sites we need to setup viewlets that are context sensitive.  As we changefrom one site to another we want our viewlets to change as well.  To do this:

Click the small + button in the top right to add a new viewlet and choose the Multi Chart Viewlet.Click on the wrench within the viewlet to configure the viewlet, and expand the "Left" axis config section.Click on the "Data" button to choose which trends are showing on our left axisChange the  to Mode QuerySet the query to  and press enter to preview the query resultsenergyClick the "context" tag on the far right of the Query field

41

In the above example my chosen context is the site Barnard and the query returned one result as expected.  The query is a whichHaystack Filtercontains a variable of "context".  This is the only dynamic variable available in Periscope today and it can be used to insert the ID of the currentcontext.

42

Kiosk Mode

Kiosk Mode enables Periscope to be used as a simplified digital signage solution that automatically navigates through all of your views. This is agreat way to add interest and provide a high level view of the data you want to share. 

Enabling Kiosk Mode

There is a single switch in that makes it easy to turn Kiosk Mode ON or OFF. Once Kiosk is turned on it will stay on, evenKiosk Mode Settingsafter refreshing the browser. 

Using Kiosk Mode

The settings page for Kiosk Mode contains a single field for view timing. This field controls the delay behavior of Kiosk Mode.

Pause Kiosk Mode

To pause Kiosk Mode, simply move your mouse over Periscope or press a key on your keyboard with Periscope in focus.

Resume Kiosk Mode

Kiosk Mode will resume once no interactions have occurred for the amount of time determined by the View Timing value.

Notifications

Kiosk Mode uses our built-in notification system to inform you on changes to the running status of Kiosk Mode. There will be notifications for thefollowing events:

Enabled (on load)PauseResume

Affected ViewsOnly views are affected by Kiosk Mode; settings pages are not affected by enabling Kiosk Mode.

43

1. 2.

1. 2. 3.

Dynamic Histories (Niagara)

Periscope has the ability to create two types of dynamic histories on the Niagara platform:

Group: Combine multiple histories into a single history and optionally convert to a new unitScale: Scale a history by some scalar value

Dynamic histories will show up within Periscope views and in the haystack database but don't actually exist in the Niagara History Database. 

Group Dynamic History

A group dynamic history can aggregate any number of histories into a single history which can the be used throughout Periscope.  Group dynamichistories only support "sum" but will later be improved to support other aggregation types.  The following tags are required to create a new groupdynamic history.

Haystack Tag NiagaraType

Description

hs:his Marker The tag is used to define a historized pointhis

hs:dynamicHis Marker The tag denotes a Periscope Dynamic HistorydynamicHis

hs:hisQuery String Haystack filter which returns historized recs that will be aggregated. For example: would allowsiteMeter and hisa user to aggregate all energy for all Sites

hs:convertTo(optional)

String Haystack Unit that the resulting aggregated trend will be converted to ("BTU")

Example Setup

Create a new NumericWritable in your station (location is not significant)Add the following tags: hs:dynamicHis, hs:his, hs:hisQuery:"siteMeter and his", hs:convertTo:"BTU"Update Periscope Haystack Cache

Scale Dynamic Histories

A scale dynamic history is a history that is multiplied by a scalar value.  This can be used to perform basic calculations such as Energy to Cost ($)or to some unit that doesn't exist in our database.  The following tags are required to create a new scale dynamic history.

Haystack Tag Niagara Type Description

hs:his Marker The tag is used to define a historized pointhis

hs:dynamicHis Marker The tag denotes a Periscope Dynamic HistorydynamicHis

hs:hisRef Ref Reference to the source history that will be scaled

hs:scale Num Scalar value

This feature still exists in Periscope but is obsolete due to Series Transform support. This page is hidden from public users. We maychoose to re-enable this functionality.

Dynamic histories are an advanced feature and require configuration on the Niagara back-end.

Group Dynamic Histories are calculated on the fly and should be used cautiously to avoid overloading the server. For example, adynamic history that aggregates 50 histories will still individually query all 50 of the histories behind the scenes. This would occur anytime the aggregate trend is used in a viewlet or view. In this case it would be better to use a standard Niagara History Extension withthe total calculated in the wire sheet. The result would be one history query for each view.

44

Managing Views

Periscope is organized by ' . This has replaced 'tabs' in the earlier revisions of Periscope. Views are context sensitive, meaning they can beviews'set up to display only on certain types of levels of the hierarchy.  For example, you could have a Map view that only displays at the top-level and asite dashboard that displays only if a "site" is selected.  Views are represented by the icons on the left-hand side of Periscope, as shown below.

Adding, Modifying, and Deleting Views

There are two different ways to configure views:

1. By accessing the settings menu in the top right corner of the window

While in the settings configuration, select the bottom icon to access the views. 

45

1. 2.

3. 4. 5.

This will show you all the views that are currently set up, what their id is and the context they are associated with.

The Views main setting page is broken into 5 columns:

Drag Handle: This can be used to re-order views by clicking and dragging on a row.Icon: You can set whichever icon you'd like to best represent the view that you're building. Chose from dozens of options to best fit yourproject.Name: What  you'd like to call your view.View ID: These id's are assigned to the components that are created for Niagara behind the scenes.Context: The assigned location that the particular view will reside and be visible when navigating. IE if you had a "Database" viewassigned to the top level (^), you would see this view when you're on the 'home' page. If you added a "Dashboard" view on a site level(site) when you navigate to any site, that dashboard would be available on the left side menu. The top 'home' page would not have thisdashboard view as it was assigned to the 'site' level and not the 'top' level.

2. Or simply clicking the button on the bottom-left once you're already in the correct context for the view you'd like to add.+

46

Creating a View

When Creating a view, click the 'Add' button at the bottom of the view pane. You're given a choice of 7 different view types, as seen below.(Availability may vary depending on your licensed feature set)

Once you select the view you'd like to add, give it a name, a unique icon, and most importantly a target designation for context.

Views can only be deleted or edited once created through the view settings (Method #1).

47

48

1.

2.

3.

4.

5.

Duplicating a View (Niagara)

To duplicate a user's View in Periscope in order to avoid recreating specific styles and layouts used on another View, the user will needto access the the Periscope Database in their Niagara 4 Workbench software:

Station > Config > Services > PeriscopeService > Periscope Database

Under the Periscope Database, access the "Users" folder and navigate to the user for which you would like to duplicate a view

Select the View you would like to duplicate, right-click, and select " uplicate"D

Give the duplicate view a new name*

View Naming*Note that the View name given in step #3 above is not the View's name that is used in Periscope. The user will need to edit

field that is displayed in the right-side pane Property Sheet when the viewthe "hs:viewName" field in the View Instance Rec is double-clicked. See below for highlighted example:

49

5.

6.

Right-click on "Haystack Cache" under the PeriscopeService tree and select "Actions > Load Cache". Refresh the user's Periscopedashboard browser if still connected. 

The duplicated View will now appear in the user's  in the dashboard page. Note that the "context" of the View andView Manager Settings all relative links and information will attempt to remain the same. The user will need to edit these items as necessary. 

50

1.

2.

3.

4.

5.

Duplicating a View (SkySpark)

To duplicate a user's View in Periscope in order to avoid recreating specific styles and layouts used on another View, the user will needto access the the Folio app in their SkySpark instance:

Obtaining the id for the view is as easy as inspecting the URL while on the view you wish to duplicate. The ID for theview immediately follows " " in the URL. For instance the view id for the URL:view"/api/demo/ext/periscope/#/view/p:demo:r:21af3bb6-49c05b37" would be "p:demo:r:21af3bb6-49c05b37".

To copy the view to a new user you will need the ID for the user you wish to copy the view to. This can be obtainedthrough the Folio app as well by querying for all periscope user records with:

readAll(periscope and user)

Now, with the new user ID: invoke the following command (where is the fully qualified ID of the other user you are copying to -id_of_userlike - and the with the id of the view you're trying to copy):@p:demo:r:otherUser

copyViewInstanceToUser(readById(@id_of_viewInstance),readById(@id_of_user))

The duplicated view will now appear in the user's   in the dashboard  page. Note that the "context" of the View andView Manager Settingsall relative links and information will attempt to remain the same. The user will need to edit these items as necessary. 

The user you are copying to must have logged in first to exist in the Folio database

51

5.

1.

2.

Understanding how the AXON view copying works isn't required, but for the curious - here is a breakdown of it step by step:

readAll(id==viewInstance->id or viewInstanceRef==viewInstance->id) // 1 .swizzleRefs // 2 .removeCol("mod") // 3 .map(r => // 4 if (r.has("userRef")) // 5 r.merge({userRef: otherUser->id}) else r ) .each(r => diff(null, r, { add }).commit) // 6

readAll: Here we are capturing the viewletInstance making up our "view" that we are copying as well as all references tothat viewletInstance - which makes up the viewlets belonging to the view. If we were to only execute our command on the view itself we'dlose all of our viewlets!swizzleRefs: is a SkySpark library function that takes all the IDs of all the records passed in via a grid and transforms those IDs to newIDs; this is necessary so that we have new IDs to add to our folio database (since we couldn't re-use the existing unique IDs). This

52

2.

3.

4. 5.

6.

function also ensures that all references that existed in the grid are maintained so that although our viewInstance is getting a new ID, allthe viewInstanceRefs are updated to this new ID preserving what viewlets existed in our view.removeCol("mod"): this removes the SkySpark "mod" column that tracks modification dates for the record, these are new records beinginserted so they can't have a pre-existing mod column.map(r => doStuff): map is a SkySpark Axon library function that takes in all the records in the grid and performs a transformation on themif statement: our if-statement takes any records with an existing userRef and transforms that userRef to be our new user that we arecopying to (in this case "otherUserId"). Note that this user id will more likely look something like  in the wild. In our@p:project:r:usercase, the only record with a userRef is our viewInstance.each statement: here we are taking our final grid of results and creating a SkySpark Folio database "Diff" for each record so that we canthen commit it to the database thus creating the new records for the user. 

53

Unit Conversions

Many viewlets within Periscope have the ability to convert to other units on the fly by using the "Convert To" unit selector.

Once a new unit is selected all data within the viewlet will be converted on the fly.  The  button will remove all conversions and switchClear Unitback to the default unit.  

Sustainability Equivalencies

Some of the sustainability focused units require the Sustainability Bundle in order to be used.  These units are denoted by a leaf icon ( ).  Thisincludes equivalencies for:

Metric Tons of CO2Barrels of Oil consumedCarbon sequestered by acres of U.S. forests in a yearCO2 emissions from homes' enregy use for one yearGreenhouse gas emissions from miles driven by an average car

Calculation information is available .here

54

Series Transform (Niagara Only)

Periscope has the ability to use trends created by the  feature of Niagara 4.  This is a powerful feature that allows a user toSeries Transformperform calculations on some input histories.  This includes things such as combining or scaling histories as well as data cleansing.  

Using a Series Transform Graph

In order to to use a Series Transform graph within Periscope a special "seriesTransform" record must be created.  This record tells Periscopewhich histories are being input into the Series Transform graph and where to find them.  The following table shows the tags required:

Haystack Tag NiagaraType

Description

hs:his Marker The tag is used to define a historized pointhis

hs:seriesTransform BOrd The BOrd to the Transform Graph component

hs:sourceName# String The name of the History Source within the Transform Graph. The '#' allows configuration of multiple historysources. This number should start at "1" and continue up to the number of sources.n

hs:sourceOrd# BOrd The BOrd to the history that will be plugged into the transform graph.

hs:unit String The unit facet (the value facet used in the transform graph is not used with Periscope).

Example

Here we have a simple TransformGraph located at  . This graph contains one History Sourcestation:|slot:/PeriscopeTechDemo/TransformGraphNode simply called "HistorySource" which goes through a Scale Node and finishes at the Terminal.  In order to apply this transformation andmake the result usable in Periscope we need to setup a record with the appropriate tags.

This screenshot shows the correctly applied tags so that we can use our Series Transform graph within Periscope.  Note that we only have oneHistory Source input in our Transform Graph so our "sourceName" and "sourceOrd" end in 1.  If we had a 2nd history source then we'd have a

Series Transforms are an advanced feature and require configuration on the Niagara back-end.

55

sourceName1, sourceOrd1, sourceName2, sourceOrd2.

 In this case we're using a BNumericWritable as our component type but any BComponent can be used.  The benefit of using aBNumericWritable is that we can easily apply a "unit" facet which is then passed to Periscope.

Series Transform histories are calculated on the fly and should be used cautiously to avoid overloading the server.

56

LicensingSites

Periscope is licensed by the number of  being used in your installation (minimum of 10).  A "site" according to Project Haystack is:sites 

A site entity models a single facility using the site tag. A good rule of thumb is to model any building with its own street addressas its own site. For example a campus is better modeled with each building as a site, versus treating the entire campus as onesite.

 Certain views, viewlets, and other features are licensed individually and require a certain part number in order to operate.   

Periscope Views and Viewlet Bundles

All installations of Periscope contain the "base" bundle which includes generic and commonly used views and viewlets.  Additionally, Periscopehas three optional bundles available: Energy, Sustainability, and Analytics.  These bundles contain a carefully chosen group of viewlets andfeatures pertaining to a specific usage.  The list of available features for each bundle is below: 

Base Views & Viewlets

Included with all installations:

Live PointMulti-ChartPoint TableKPISimple GaugeSpeedometerDashboard ViewIFrame ViewPX Connect View

Optional Views & Viewlets

The following groups of viewlets areoptional and can be purchased separately: 

Energy (PER-ENERGY)

BaselineDemand DurationEnergy ProfilePie Chart

Analytic (PER-ANALYTIC)

Site Scatter Plot

Tree MapHeat Map

Sustainability (PER-SUSTAIN)

Ranking Chart

Green TipsImageKiosk Mode (feature)Equivalencies - the ability toconvert trends to sustainableequivalencies such as CO2, milesdriven, etc.

Optional Features and Views

Periscope also has some unique featuresand views which are licensed separately. These can be added to any installation butare not included by default in the basepackage or in a bundle.

Themes (PER-THEME) - enablesthe ability to create custom themeswith your logo and colors.Map View and Viewlet (PER-MAP)- enables the map view. Alarm Timeline View (PER-ALARM) - enables the usage of theAlarm Timeline view / viewlet.

Point RelationsPoints and trends must be associated with a tagged site in order to work in Periscope. See our documentation on forrelations taggingmore information.

57

Viewlets

Viewlets are data windows used to populate a user’s dashboard. Periscope comes with an expanding library of viewlets, each allowing the user todisplay their information in a unique way. Viewlets can be added, moved, and deleted from the user’s display with ease. Select from the list belowto learn more about each individual viewlet. 

Alarm TimelineBaselineDemand DurationEnergy ProfileGreen TipsIFrameImageKPILive PointMulti ChartPie ChartPoint TableRanking ChartSimple GaugeSite Scatter PlotSpeedometerLiquid GaugeMap

58

Alarm Timeline

See Alarm Timeline View (Niagara)

59

Baseline

The Baseline Viewlet allows comparison of any two periods for a given trend.  This is a useful viewlet to answer questions such as "Is my buildingconsuming more energy compared to yesterday or this time last year?".

 

Configuration

60

Configuration Options

Title: Set a custom viewlet title.Data: Select from available trends using either the Picker or Query mode.Date: Fine tune when the trend's data is shown. Can be set to auto (global control), a preset date range, or a user selected date range.Rollup: Select auto, or manual for more rollup control over rollup time, and rollup types such as Avg, Min, Max, Sum values of the trendbased on selected date ranges.Baseline: Compare the current period's data with the previous period data if set to auto,  or pick a specific time range.Convert To: Convert the data to comparable units such as kWh to MWh or kWh to BTU's.Align Days: Shift the baseline weekday to start on the same day of the  week (+ or -). Example: "today vs yesterday" with "align days"will end up comparing the same day against each other. 

This feature requires the part number PER-ENERGY

61

Demand Duration

The Demand Duration viewlet enables the display of the amount of time a variable is above a specific level during the selected interval.

 

Configuration

Configuration Options:

Set a custom viewlet title.Title:Data: Select from available trends using either the Picker or Query mode.Date: Fine tune when the trend's data is shown. Can be set to auto (global control), a preset date range, or a user selected date range.Convert To: Convert the data to comparable units such as kWh to MWh or kWh to BTUs.

This feature requires the part number PER-ENERGY

62

63

Energy Profile

The Energy Profile Viewlet enables users to quickly identify anomalies in data and compare average profiles to different periods of times ordifferent trends.

Configuration

Configuration Options

64

Set a custom viewlet title.Title:Data: Select from available trends using either the Picker or Query mode.Date: Fine tune when the trend's data is shown. Can be set to auto (global control), a preset date range, or a user selected date range.Profile Period: Pick from Daily or Weekly energy profiles.Rollup Type: Average, sum, min/max, or count the records for the date or date range provided.

This feature requires the part number PER-ENERGY

65

Green Tips

The Green Tips viewlet display an animated slideshow of images and text.  Periscope provides a "green tips" slideshow out of the box which isfocused on sustainability but users also have the ability to create their own slideshows with custom images and text. 

Configuration

Configuration Options

ID: Each slideshow that is created is given a custom ID in Niagara. Entering a different ID will show a different slideshow.Timing: In seconds, the duration of each slide being shown.Show Text: Show the accompanying text for the image or not.Transition: fade, horizontal, or vertical rotation to the next slide image.

Custom Slideshows

66

The Green Tips viewlet has the ability to display custom slideshows with images and text.  This task should be completed by someone withNiagara knowledge since it requires manual modification of the database and installation of files (images).  

Step 1 - Upload Images

The first step of creating a slideshow is to place the images onto your Niagara server so that Periscope can access them.  To do this, copy yourimages to the "shared" folder of your Station Home.  It may be best to create a new folder within your shared folder.  Once images are placed intoyour Niagara Station, they are served from the URL: http://{ip}/file/{folder}/{image} - for example, if I created a folder in my shared directory called"sustainability" and added "solar.jpg" I would access it by navigating to http://localhost/file/sustainability/solar.jpg.

Step 2 - Create Slideshow Record

Now we need to create a new slideshow record which will be referenced by all of our images.  To do this, navigate to your "Database" view withinPeriscope Settings and click on "New Record" to create a new Record.  This new record should contain:

slideshow (Marker Tag)slideshowId (String) - the ID the viewlet will reference to load your slideshow 

Step 3 - Create Records for each image

The next step is to create a new record for each image within the slideshow.  This record will contain a link to the image, text to display while theimage is showing, and a reference to our new slideshow record created in Step 2.  For each image, create a new record as follows:

slideshowRef (Ref) - reference to our slideshow record in Step 2text (String) - information to display as your image is displayedimage (String) - URI to the image 

67

1. 2. 3.

Step 4 - Configure the Green Tips viewlet

We can now use our new slideshow in a Green Tips viewlet.  To do this:

Add a new Green Tips viewletClick on Configure to access the viewlet configurationSet the Slideshow ID to "myslideshow" (the used in Step 2)slideshowId

This feature requires the part number PER-SUSTAIN

68

IFrame

See IFrame View

69

1. 2.

a.

b. c. d.

e. 3. 4. 5.

Image

The Image Viewlet allows embedding of images directly into a viewlet.  Images can be linked from 3rd party websites or served locally from the Niagara server.  

Configuration

Image Options (URL or Tag): Allows switching of the image source

imageURL: The URL of the image fileimageTag: The Haystack tag name on the current context that contains a path to the image 

URL vs. Tag Mode

When in URL mode the configuration will contain a single "URL" property which can be configured to point to a static image file.  

Tag mode allows a user to reference a dynamic image tag that can do things such as change based off of the currently selected context.  For example, let's say each site in your database contains an hs:image tag pointing to specific building image.  The Image viewlet could be set up to dynamically change based off of which site was selected. See below for more on how to setup the image tags. 

Using an Image Tag

Add your desired images to the Niagara station where Periscope is installed. Typically these images are placed in an "image" folder within the Station > Files folder. Tag your respective sites in Niagara with the hs:image and add the proper file path:

Select your tagged sitefolder or device in Niagara, right-click and select "Edit Tags"Press the "AddTag" buttonEnter "hs:image" in the TagId field and "baja:Ord" in the Type selector. Press OK.The tag should now display a blank entry. Select "File Ord Chooser" from the folder to the right of the blank entryhs:imagespace, and find your imported image. Repeat this process above for your remaining sites, etc. that you would like to tag with an image file. 

Go to an Image Viewlet in Periscope and change the Image selector to "Tag"Set the "imageTag" property to "image" (since "image" is the name of the tag on the site that contains an image URL)The image for the context should now display in the dashboard.  

This feature requires the part number PER-SUSTAIN

70

KPI

The KPI viewlet can be configured to show the current value of any monitored variable or total value for a period of time. For example, "YearlySavings to Date", "Avoided CO2", "Campus kWh this Month", etc.  It can be configured to mirror real-time point data or calculate an accumulatedvalue over a period of time such as “This Month”.

Configuration

71

Configuration Options:

Data: Choose to select a specific point or trend. Select from available trends using either the Picker or Query mode.Convert to: Convert the data to comparable units such as kWh to MWh or kWh to BTU's.Date: Fine tune when the trend's data is shown. Can be set to auto (global control), a preset date range, or a user selected date range.Rollup: Select auto, or manual for more rollup control over rollup time, and rollup types such as Avg, Min, Max, Sum values of the trendbased on selected date ranges.Compare: Compare the point or trend showing to another point, trend, or static number. There are options to colorize, reverse, or set aspercentage the comparison.Title: Set a custom viewlet title.Prefix & Suffix: Add a word, letter, number or symbol before or after the value displayed.Precision: How many digits past a decimal you'd like there to be displayed.Background: Set the color and opacity of the background field.

 

72

Live Point

The Live Point viewlet allows viewing one or more points in real-time with streaming updates.

Configuration

Configuration Options:

Point: Make a selection of which point trends to use.Poll Interval: Set the time (in seconds) for the viewlet to update.Rollover Limit: How many points should be displayed at once per trend on the viewlet.

73

Multi Chart

The Multi Chart viewlet can be used to plot the aggregate or relative value for multiple variables over time. For each interval over the selectedtime period, the viewlet can plot the Max, Min, Average, or Sum of the variable.

Configuration

The following configuration will produce a multi axis graph similar to what is shown above.

74

(The left and right images show configuration for the left and right axes, respectively)

Configuration Options:

Title: Set a custom viewlet titleAxis: Select the Left or Right axis. This control also expands to allow for independent control of each axisEnabled (Right axis only): Choose whether to display the right axisData: The familiar data picker use to select trends or points for each axisRollup Type: Avg, Min, Max, Sum, or Count the values of trends based on selected date rangeConvert To: Used Convert data to comparable units, such as kWh to MWh or kWh to BTU'sChart Type: Select the method that data is visualizedDate: Fine tune when the trend's data is shown. Can be set to auto (global control), a preset date range, or a user selected date rangeRollup Interval: Determine how frequently you would like the summarized data to be displayed

75

Pie Chart

The Pie Chart viewlet can be used to show the relative value of multiple variables over time. For each interval over the selected time period, theviewlet can plot the Max, Min, Average, or Sum of the variable. This particular viewlet can be displayed in a standard pie, a doughnut, or a polararea chart. 

 

Configuration

Configuration Options

Title: Set a custom viewlet title.Data: Select from available trends using either the Picker or Query mode.Date: Fine tune when the trend's data is shown. Can be set to auto (global control), a preset date range, or a user selected date range.

76

Rollup: Select auto, or manual for more rollup control over rollup time, and rollup types such as Avg, Min, Max, Sum values of the trendbased on selected date ranges.Convert To: Convert the data to comparable units such as kWh to MWh or kWh to BTU's.Chart Type: Select the format the data is displayed as either a Pie, Doughnut, or Polar Area (displayed). 

This feature requires the part number PER-ENERGY

77

Point Table

The Point Table provides a tool to configure and view real-time values of any variable in the network.

Configuration

Configuration Options:

Point: Select from available trends using either the Picker or Query mode.

78

Ranking Chart

The Ranking Chart enables the user to display comparative values for similar variables, ranked in either increasing or decreasing order. Ifappropriate, values may be normalized based on certain criteria, such as conditioned area (SF).

Configuration

79

Configuration Options:

Title: Set a custom viewlet title.Data: Select from available trends using either the Picker or Query mode.Date: Fine tune when the trend's data is shown. Can be set to auto (global control), a preset date range, or a user selected date range.Rollup Type: Select Avg, Min, Max, Sum values of trends based on selected date ranges.Convert To: Convert the data to comparable units such as kWh to MWh or kWh to BTU's.Sort: Display the chart in either ascending or descending order.Normalize By: Normalization averages data such as energy consumption based upon common units of measurement such as squarefootage. Select between None or Site Area.Show Goal: Enable goal line or not.Goal Value: If Show Goal is enabled, enter a value you'd like to see as a goal line drawn across your graph.Limit: Limits the number of trends shown - for example, "5" would result in a maximum of 5 trends.

This feature requires the part number PER-SUSTAIN

80

Simple Gauge

The Simple Gauge provides a "doughnut" style display to monitor the real-time value of any variable in the network.

Configuration

81

Configuration Options:

Data: Select from available trends using either the Picker or Query mode.Title: Set a custom viewlet title.Gauge Type: Select Circle or Semi CircleMax Value: Select the maximum value that your data could reach.Precision: Select how many digits past the decimal that are displayed.Prefix: Add a word, number, or symbol in front of the value.Background: Set a custom or context color.Color: Set the color of the fill area in the gauge.Track Color: set the off (non fill) color of the gauge.

82

Site Scatter Plot

The Site Scatter Plot displays points on an x and y-axis. This visualization enables easy visualization of relationship and how they change overtime. 

Configuration

83

Configuration Options:

Title: Set a viewlet title.custom Select the Trend to be used on the X and Y axis. Trend:

Data: Select from available trends using either the Picker or Query mode. Select Avg, Min, Max, Sum values of trends based on selected date ranges.Rollup Type:

 Convert To: Convert the data to comparable units such as kWh to MWh or kWh to BTU's. Normalize By: Normalization averages data such as energy consumption based upon common units of measurement such as square

footage. Select between None or Site Area. Fine tune when the trend's data is shown. Can be set to auto (global control), a preset date range, or a user selected date range.Date:

 

This feature requires the part number PER-ANALYTIC

84

Speedometer

The Circular Gauge provides a "Speedometer" style display to monitor the real-time value of any variable in the network.

Configuration

85

Configuration Options:

Data: Select from available trends using either the Picker or Query modeTitle: Set a custom Viewlet titleColors: Set each of the colors for the color bandsStop Values: Control where each color band should endMax Value: Select the maximum value that your data could reach

86

Liquid Gauge

The Liquid Gauge Viewlet displays real-time point or trend data as animated liquid in a circular container.

Configuration

87

Configuration Options

Title: Set a custom viewlet title.Data: Select points or trends.Fold: Select rollup types such as Avg, Min, Max, Sum values based on the point or trend.Convert To: Convert the data to comparable units such as CFM to GPM or L/min to L/hr.Percentage: Choose to display your data in either a percentage of the whole, or true value.Max Value: Depending on how large the number is, you can elect to 'calibrate' the gauge so the liquid gauge shows up in a reasonablerange.Precision: Set the resolution of your value with digits after a decimal.Colors: Set the colors of the gauge.

88

Map

The Map Viewlet serves as a navigational page to different buildings as well as an analytics tool. Users can visualize building KPIs and setup newmaps in minutes. For more information see .Map View

89

Views

Available Views: 

Alarm Timeline View (Niagara)Dashboard ViewHeat Map ViewIFrame ViewMap View and ViewletPX Connect ViewSpark Timeline (SkySpark)Tree Map View

View Controls

Views have unique controls that modify the data displayed.  These controls include:

Date Range: Allows changing the time frame of a viewTimeline: Puts historical data in motion similar to a DVRConfig: Contains additional options to modify the view behavior

Date Range

The Date Range selector allows the user to select a date range from a list of pre-configured date ranges.  It also allows for the selecting of acustom date range by clicking "Custom", which causes a calendar component to appear. 

Timeline

Selecting the clock icon will open up the animated timeline which you can play and see the changes as they happened over a set period of time.

 

The timeline settings (wrench) offer more control over the playback speed and timeline range.  Options include:

: Choose previous number of days or manually select a date range to animateDate: What rollup interval to animatePeriod: How quickly the animation moves through the timelineSpeed

Configuration

90

 Selecting the wrench icon will bring up the configuration which will be unique to each view.  

Some views may not have additional configuration

91

Alarm Timeline View (Niagara)

The Alarm Timeline View allows visualization of Niagara Alarms and Niagara Analytics.  The timeline chart improves upon a typical tabular viewand enables better visualization of alarm frequency and correlation between alarms.  This chart supports filtering of the data to view alarms fromspecific sites or specific priorities.

Clicking on an alarm will bring up an alarm details page as seen below.

Clicking  will set the state on the Niagara alarm to "Acknowledged" and  will acknowledge all alarms of theAcknowledge Acknowledge Seriescurrently selected series in batch. The visual timeline representations shown in the Alarm View will also disappear when the correspondingacknowledgements are made. 

 Configuration

Show Acked: After acknowledging an alarm, it will disappear from the view, by checking 'Show Acked' you can view all acknowledgedalarmsData: Show alarm data on all alarms, current context, or specific sitesPriority Min: The minimum priority level that will be displayed on the chart

92

1. 2. 3.

1. 2.

Priority Max: The maximum priority level that will be displayed on the chart

Niagara Alarm Setup

In order for alarms to show up in the Alarm Timeline chart they must contain  s within the Alarm Metadata which point to the correct Niagararef  Components.  Refs are needed in order for the "Site" selection as well as the "Current Context" feature within the  property.   Periscope willDatauses these metadata properties to detmine which alarms should show up for a given context or site selection.

To set these up for a given Alarm Extension:

Click on the ">>>" button in the propertyMeta Data Click "+" button to add a new metadata itemType  in the "key" column and the handle of your site as the value (for example, "h:123")siteRef

Now when Periscope reads the Alarm Database it will understand that this alarm belongs to your Site "h:123".  If you plan on using the AlarmTimeline down to the equipment level (or further) you would need to add the appropriate refs.  For equipment this would be " ".equipRef

Niagara Analytics Setup

Periscope has the ability to view   generated by Niagara Analytics.  To set this up, for each Alert:Alerts

Navigate to the property sheet of your AlertEnsure that "Alarm" is set to true

This causes all alerts generated by Niagara Analytics to be routed to the Niagara Alarm Database.  Periscope will attempt to look up your alerts"refs" to determine which site or equipment it belongs.  

Since there is no "Source Name" of a Niagara Alert and because Alerts may be generated for multiple points, Periscope displays the Alert plusthe display name of the point causing the error. 

This feature requires the part number PER-ALARM

93

Dashboard View

The dashboard view is the most common screen seen in Periscope. The dashboard view is intuitive, responsive, and user-configurable.Dashboards can be setup to visualize any aspect of your building or an entire campus of buildings by utilizing a growing library of viewlets. Oncein place, viewlets can be moved around and organized however you see fit. Just grab them and pull them around the screen. Viewlets can also bescaled so some are larger than others if for instance some charted data were more important than other data, simply grab the bottom right cornerand drag to a desired size. Some viewlets can also be interacted with directly by either double clicking or alt-clicking their legend to show and hidespecific trends or points. On mobile devices, the views will dynamically scale to fit the screen's proportions.

Adding Viewlets

 Selecting the plus button will open up the "Add Viewlet" window. Here you'll find descriptions of each viewlet that can be added to thedashboard view.

94

Configuration

This will allow for further customization of how you desire the dashboard to look, including options such as margins, colors, and styles. This canbe useful if you're setting up a view for a specific display such as a kiosk, and it needs to look perfect.

Margin - amount of pixels margin around viewletsColumns - how many columns are available for the viewletsBackground - color, gradient, or image of the dashboard backgroundViewlet

Background - background color of viewletsBorder Size - width of viewlet bordersBorder Color - color of viewlet bordersText Color - text color within viewlets

Title StyleHeight - size in pixels of viewlet titlesBackground - background color of viewlet titlesText - Text color of viewlet titlesBorder Size - border size of viewlet titlesBorder Color - border color of viewlet titles

95

Heat Map View

The heat map provides a unique hourly spectrum of any trend. Using this view, one can quickly identify anomalies and visualize trends acrossdata.

Rolling over the individual cells will show a time-stamp and value for that point in time.

ConfigurationData - trend picker to choose the data displayed in the Heat MapRollup - change how the data is rolled upTypeColors - the gradient of colors that are mapped to the low, medium, and high values of data

Low - Lowest colorMid - Medium ColorHigh - High Color

This feature requires the part number PER-ANALYTIC

96

IFrame View

The IFrame view allows embedding 3rd party websites into a view or viewlet.  

Configuration

URL - URL of the external party website (must include the appropriate protocol, '  or 'https://')http://'

HTTP vs. HTTPSMost browsers do not allow mixed active content, that is mixing HTTP and HTTPS frames in a single webpage. In other words, if youare hosting Periscope on HTTP, you will only be able to embed other HTTP sites.

97

Map View and ViewletThe Map View serves as a navigation page to different buildings as well as an analytics tool by displaying real-time alarm information andspectrum data. Users can visualize building KPIs and setup new maps in minutes.

Configuration Outline

Edit ModeCoordsView LinkShow LabelsAlarming

SpectrumSpectrum DataSpectrum Style

Edit Mode

98

Enable Edit Mode if you would like to:

Associate buildings to sitesAdjust the default map center and zoom level

With Edit Mode enabled, you will notice buildings on the Map have a dotted outline, indicating they are available to have a site associated to them.To associate a building to a site, first click on an available building. A dialog will appear containing all the sites available to be associated. Select asite and press OKAY. Now, the site and building outline are tied.

Disable Edit Mode for normal Map operation.

Coords

The default center coordinates of the Map, as “latitude,longitude”. This field will automatically update when in Edit Mode changes are completed.

View Link

This field is used to create a hyper-link from buildings on the Map to a site-level view, allowing for further exploration of a particular site. The fieldexpects a ViewID. This tag beginning with “h:” can be found in the browser’s URL when viewing the desired View. For example, if the view youwould like to link to has the URL, “/#/view/h:1234”, the ViewID would be “h:1234”.

Show Labels

Labels show the site’s name on their associated building.

Alarming - [ Off, Filter, Priority ]

99

Alarms on the Map are displayed as an“alarm bell” icon on buildings where there is acurrent (and unacknowledged) alarm.Alarming has three options; the first of which,“Off”, disables alarms on Map entirely. Theother two options, “Filter” and “Priority,” allowfor control over how alarms are viewed.

Alarming Options

Off

Disable alarms. (Alarms will not display with this option set to "Off")

Filter

Min EnabledMin ValueMax EnabledMax Value

Alarms can be filtered by priority value here. Priority is a value between 0-255.

Priority

This is where different alarm priorities get colors associated to them. There are settings for three priority ranges, each with an On/Off switch,“Color”, “Min” value, and “Max” value.

Spectrum

100

Spectrum mode colorizes buildings accordingthe data chosen in the Spectrum Dataconfiguration options. Colors are determinedfirst by finding the Min, Max, and Averagevalues from the data, then applying colors toeach of the value. Colors are customized inthe Spectrum Style configuration settings.

Spectrum Style

Spectrum is colorized from three colors, Low,Mid, and High. Since a Low value may ormay not indicate positive performance, theuse of appropriate colors is important.Typically, red indicates off-target readings,while green indicates on-target readings.

Auto

High, Mid, and Low colors automaticallymapped to data’s High, Mid (average), andLow values.

Manual

Same color options as when ‘Auto’ is selected, except High, Mid, and Low values are overridden. This allows for some corrections to outliers inthe data. This is also an easy way see how buildings are performing relative to a certain target value.

Spectrum Data

Data selection, Rollup Type, and Normalize are all described in other areas of this document, and behave the same way here. Baseline comparesthe current value of each site against that site’s previous value. View the documentation for the Baseline Viewlet for further information regardingbaseline configuration.

This feature requires the part number PER-MAP

101

PX Connect View

PX Connect view allows users to embed PX pages into a Periscope View. The user should have full control and functionality through the page asone would normally have in the Niagara Workbench. 

Configuration

PX  URI or Context Page:URI: Provide a URL to the PX pageContext - The view will attempt to load the PX page for the given context

PX Cropping and Display RecommendationsPX Views will sometimes behave abnormally when a PX page is another browser window in addition to Periscope. The solution is toclose any other browser tabs or windows that are viewing the PX page and refresh the Periscope dashboard.

If the PX View exhibits alignment issues, we recommend aligning any PX CanvasPanes to top-left by setting the 'valign' and 'halign' to'Top' and 'Left', respectively.

To present PX Views as cleanly as possible, set user Default Web Profile and Mobile Web Profile types to 'Handheld Hx Profile' inConfig/Services/UserService/{user}.

Regarding Hyperlinks in PX ViewsIt's possible that when using the default hyperlinking scheme in PX views that you'll run into: Cannot read property 'env' of undefined, when clicking on the hyperlink.

If this occurs, or generally for more information regarding linking in PX views, please see our Guide to Hyperlinking PX Views

102

1. 2.

1. 2. 3. 4.

1. 2. 3. 4.

Guide to Hyperlinking PX Views

Generally there are two types of linking that are needed:

Linking from a PX page to a separate Periscope view (which could be another PX page)Linking from a PX page to another PX page (without changing Periscope views)

Linking from a PX page to a separate Periscope View

Steps:

Replace the regular PX hyperlink with an Enhanced Hyperlink BindingSet the "ORD" to any component (just needs to be filled in, doesn't matter)Set the "hyperlinkFormat" to the URL of the Periscope view you'd like to navigate toSet the browserTarget to "_parent"

Linking from a PX page to another PX page

Steps:

Replace the regular PX hyperlink with an Enhanced Hyperlink BindingOpen your browser and navigate to your PX page that you wish to link toCopy and paste the URL into "ord" and "hyperlinkFormat" while adding "?fullScreen=true" to the end of the URLSet the browserTarget to "_self"

VykonPro requiredThe VykonPro module has an "Enhanced Hyperlink Binding" that is necessary to continue. Currently the VykonPro module only shipswith VYKON branded versions of N4 which will be located under niagara-central's software section when the "Vykon" brand is selected.

ExampleLet's say you created a PX page that contains individual pieces of equipment and you want each piece of equipment to link to a PXpage inside of a Periscope view.

You've already created a "view" in Periscope for each of the equipment's PX pages but now you need to be able to navigate to them.

To do this, open Periscope in a browser and navigate to one of your equipment PX views. Copy/paste the URL from that page into your"Enhanced Hyperlink Binding" and now the PX page containing all the equipment will navigate there.

103

Spark Timeline (SkySpark)

The Spark Timeline View allows visualization of Sparks.  The timeline chart improves upon a typical tabular view and enables better visualizationof spark frequency and correlation between sparks.  This chart supports filtering of the data to view sparks from specific sites or specific priorities.

Clicking on a spark will bring up a spark details page as seen below.

104

 Configuration

Data: Show spark data on all sparks, current context, or specific sitesMin: The minimum priority level that will be displayed on the chart; defaults to 'all'.Show Cost: Displays a label next to the spark showing the cost if one is configured.

This feature requires the part number PER-ALARM

105

Tree Map View

The tree map provides a unique visualization into hierarchical structures. It is effective in showing anomalies and patterns across different depthsof a hierarchy.

Configuration

Title: Set a title for the ViewTrend: Size / Color.  Both Size and Color data must be selected in order to generate a Tree Map.

Data - The trend data for the size or color trendsRollup Type - The rollup type for the size or color trendsConvert To - The unit conversion for the size or color trendsNormalize By - Normalization by sqft option for the size or color trends

Height: Select the vertical fill of the group of blocks on the screen.Date: Either pick 'Auto' to run off the global time frame (calendar), Pick a common 'Date Range', or a custom time range with 'Manual'.

This feature requires the part number PER-ANALYTIC

106

Settings

 

To view Periscope's different settings, click the cog icon in the top right corner of the dashboard screen.

AboutDatabaseGeneral SettingsKioskStyle / ThemesView Manager

107

About

The first settings tab is the "About" information page. Here you'll find the version number of Periscope installed, a link to documentation andlicense details.  The "Choose Sites" button allows you to manage which sites within your database are being used by Periscope.  Moreinformation about using this feature can be found in the page. The user will also see which Periscope features were purchased and areLicensingenabled.  

Code NameEach major release of Periscope starting with version 3.0 will now have an aquatic-themed code name for internal naming purposes.The third letter of the alphabet, 'C', corresponds with the third version of Periscope, hence "Coral". Each subsequent version releasedwill have a new code name and relative image on this page. Feel free to suggest the next code name to our team at sales@activelogix.

!com

108

Database

The Database allows for the querying and modifying of the underlying Haystack database. There is also an option for "Niagara Navigation" (ifusing Niagara instead of SkySpark) in the drop-down list that allows a user to view the station's structure. Users can quickly search for records,create new records, tag or modify existing records, or delete them as needed. 

For instance, if a user enters "his" into the Haystack Query entry bar and presses return, they will be presented a list of all history recordsthat have been tagged with an " " tag in the Niagara4 database or all "his" tagged records in a Folio database. hs:his 

Adding Tags 

To add tags through the Database View, the user will need to first discover the desired record(s) using the Haystack Query or Niagara Navigationsearches first. Once the record is found that the user would like to modify, it should be highlighted and the "Edit Selected" button should bepressed. 

109

General Settings

User Settings

The third settings tab, indicated by the cog on the left side menu, is the general settings page.  Hierarchies are navigation trees created in Niagaraor SkySpark based on existing relations or references created. Periscope automatically creates three structures using different combinations ofthe typical Site > Equipment > Point hierarchy setups. Custom hierarchies can be created if the supporting tags exist and corresponding settingsare configured in Niagara's  (or SkySpark's ). Hierarchy Service NavTrees

The "User Settings" hierarchy will be the hierarchy used for the logged in user and affect other users.will not

110

Kiosk

The fourth settings tab, Kiosk Mode, enables automatic cycling of top-level Views, staying on each View for as long as specified in the ViewTiming section. Ideal uses for Kiosk Mode might be in an entrance to a public space, such as a school or office lobby on a large monitor or TV.Once enabled, Kiosk Mode will always run unless it is disabled from this window. Click for more information on Kiosk Mode. here 

This feature requires the part number PER-SUSTAIN

111

Style / Themes

Standard Themes

The standard themes that are provided with Periscope are 'Dark' and 'Light', which can be chosen in the drop-down menu under the Theme. 

Cu

sto

m

Th

emes

If the user has purchased the option to create their own custom themes, they will have the ability to duplicate an existing theme and create a newuser interface to their liking. Duplicating a theme will open up a naming window. The user should name the custom theme and will then have theoption to modify its settings.  

Once the new theme is created, select 'Edit' to open up the settings for the theme. The user will have the ability to insert a custom logo in place ofthe Periscope logo, and select a wide array of color options to personalize the dashboard design.  

112

113

View Manager

 Views

The 6th and final window in the Settings pages will give you control of the Views seen in the dashboard. Users can re-order, change names andcontexts of the Views, and more.  .More info on Views can be found here

114

Developer API

x

115

1.

2.

3.

4.

FAQs

Below are many of our frequently asked questions. Please contact   if you need additional assistance related to yourtechsupport@activelogix.comPeriscope installation. 

Q. I have tagged my site(s) and data and created the necessary references / relations in Niagara. What do I do next? A. You should now select which "sites" you want defined in Periscope. Navigate to Periscope's settings page and hit " " toChoose Sitesmake sure you have at least one site selected. 

Q. I get a "404 Error" on my screen when first loading my dashboard. What's wrong?A. Nothing is wrong, you just need to add a view to your dashboard! Click the '+' button at the bottom-left side of your dashboard to add a view, and begin building your dashboard.

Q. I just updated my Periscope JAR/module, why won't my dashboard load now?A. You must re-fetch your license after a JAR/module update. Navigate  for instructions on fetching your license. here

Q. Why is my PX View not displaying properly (the graphic is cropped)? A. PX Views will sometimes behave abnormally when a PX page is opened in a browser window in addition to Periscope. The solution isto close any other tabs or windows that are viewing the PX page and refresh the Periscope dashboard.