Niagara Analytics Explorer

Niagara Analytics Explorer helps you quickly build dashboards to visualize historical and real-time Niagara Analytics data.

About Permissions

Dashboards can be public or non-public. You determine whether a dashboard is public when you save a dashboard or edit dashboard settings. On the landing page, public dashboards appear in Public Dashboards, and non-public dashboards appear in My Dashboard. If you created a public dashboard, it has a blue icon. If someone else created it, it has a gray icon. A non-public dashboard can be seen only by the person who created it.

Anyone who has read-only permission or higher can:

Only a user with higher than read-only permission can:

  • Use the Save or Save As command to save dashboards that this user created.
  • Use the Save As command to save a new version of a public dashboard.
  • Delete dashboards that this user created.

Only the creator of a public dashboard can:

  • Use the Save command to replace this dashboard with the current version.
  • Delete this dashboard.

Install Niagara Analytics Explorer

You can install Niagara Analytics Explorer on a local workstation or remote workstation. After installing, you must add the service to the station.

Before installing:

  • Make sure that you have the dglux-ax-analytics.dist file provided by Tridium.
  • Stop all running stations, and close all instances of the engineering tool (Workbench).

Local Installation

Follow these steps to install Niagara Analytics Explorer module on a local workstation or Niagara supervisor.

  1. Rename the .dist file, so that the extension is .zip instead of .dist.

    Installing Niagara Analytics Explorer
    Installing Niagara Analytics Explorer
    Installing Niagara Analytics Explorer

  2. Unzip the file.

    Installing Niagara Analytics Explorer
    Installing Niagara Analytics Explorer

  3. Move the contents of the directory into your Niagara installation folder according to the following table.

    Item Move to…
    META-INF directory Niagara installation directory, Niagara-3.n.nnn
    dglux5 directory Niagara installation directory, Niagara-3.n.nnn
    Contents of the modules directory Niagara modules directory, Niagara-3.n.nnn/modules

    Installing Niagara Analytics Explorer
    Installing Niagara Analytics Explorer

Next, you must add the service to the station and configure permissions.

Remote Installation

Follow these steps to install Niagara Analytics Explorer on a remote computer or on a JACE device.

  1. Open the remote platform.
  2. Open the Distribution File Installer in the remote platform. When prompted, navigate to the dglux-ax-analytics.dist file, and click Install.

Next, you must add the service to the station and configure permissions.


Add the Service

After installing, add the Niagara Analytics Explorer service to the station:

  1. Start the engineering tool (Workbench), and start the station.
  2. If the Palette is not visible, add it by selecting Window > Side Bars > Palette.

    Installing Niagara Analytics Explorer

  3. In the Palette, browse to the dglogikNAnalytics module, and click OK.

    Installing Niagara Analytics Explorer

    The dglogikNAnalyticsService module is added to the Palette.

  4. Drag the dglogikNAnalyticsService module from the Palette, and drop it on the Services node in the station database in the panel above.

    Installing Niagara Analytics Explorer


Configure Permissions

When you add the service, a new user is automatically created. By default, the permissions for this user are the same as for Category 1, or the User category. The automatically created user is disabled by default. To enable it, edit the user and set Enabled to true.

To change permissions for this automatically created user or other users:

  1. Double-click Config/CategoryService.
  2. In the Category Browser view, expand Config/Services, and for DGLux5AnalyticsService, ensure that the correct user category is selected. Either use an existing category, or create a new one. Ensure that the selected user category also has access to the nAnalytics, Files, and History trees.

    Installing Niagara Analytics Explorer

  3. If you made changes, save them by double-clicking some other module and then clicking Yes when prompted.

    Installing Niagara Analytics Explorer

  4. Ensure that the user category that you selected in step 2 is associated with the automatically created user, and any other user that needs access to Niagara Analytics Explorer.

    Installing Niagara Analytics Explorer

    If you make changes to a user, click Save.

Read-Only Permission

If you give a user read-only permission to the user category, the user can view and create dashboards in Niagara Analytics Explorer but can't save them.


Configure Nav Files

The automatically created user is already associated with a Nav file, so you don't need to assign one to this user.

If you are using a different user, you can associate it with the Nav file module://dglogikNanalytics/rsc/na.nav, which is automatically installed when you add the service. To do this, click the folder icon next to Nav File, and then browse to the path of this Nav file.

Installing Niagara Analytics Explorer
Installing Niagara Analytics Explorer

If you want to use your own Nav file, make sure that the Nav file uses ord=dglux5na:. To do this, edit the Nav file, and enter dglux5na: in the Home Ord field.

If you make changes to a user, click Save.


Open Niagara Analytics Explorer

  1. In a web browser, navigate to <yourServer>/dglux5/na/index.html.

    Installing Niagara Analytics Explorer

    If you use the automatically created user, you do not need to enter the full path. You can simply enter <yourServer>.

  2. If you use the automatically created user, create a new password when prompted.

    Installing Niagara Analytics Explorer


Create a Dashboard

To create a new dashboard:

  1. From the landing page, choose Create a New Dashboard.

    Niagara Analytics Explorer

    Niagara Analytics Explorer opens.

    Niagara Analytics Explorer

  2. Click the Layout icon in the top right corner. Then, select a configuration for your dashboard, and click Apply.

    Niagara Analytics Explorer

  3. Drag a widget type from the bottom of the screen to one of the specified areas.

    Niagara Analytics Explorer

  4. Select a node in the Data Model and a definition in the Data Definitions. Drag the definition to the widget. You can add multiple series to the same widget.

    Niagara Analytics Explorer

    A series is added for the specified node and definition.

  5. If you want to remove a series, right-click it in the widget's legend and select Remove Series.

    Niagara Analytics Explorer

  6. If you want to create a relative series, press and hold the Shift key while you drag a data definition to the widget.

    Niagara Analytics Explorer

    A relative series is added. This series changes based on which data model node is selected. You can add multiple series to the same widget.

  7. To edit a widget's properties, click the Niagara Analytics Explorer Edit button on the widget, and use the Properties pop-up.

    Niagara Analytics Explorer

    See the descriptions of the properties, below.


Change the Date Range

To change the global date range for historical widgets in this dashboard, use the date range picker at the top of the page. Date range changes are saved with the dashboard.

A dashboard with an absolute date range will display the same data no matter when it is opened. To select an absolute date range, use one of the following:

  • Select the Day or Week button and use the calendar.
  • Select the Month or Year button and use the drop-down menus.

    Niagara Analytics Explorer
    Setting an absolute date range

A dashboard with a relative date range will display data that depends on the date when it is opened. To select a relative date range, use one of the following:

  • Select the Relative button and use the drop-down menus and number field.
  • Select the Day, Week, Month, or Year button and use the relative buttons: Today, Yesterday, This Week, Last Week, This Year, or Last Year.

    Niagara Analytics Explorer
    Setting a relative date range

All historical widgets on the page use this global date range by default. However, you can override the date range using a widget's properties.


Save a Dashboard

To save a dashboard that you are editing:

  1. Click Save As or Save.

    If this is your first time saving the dashboard, or if it is a public dashboard created by a different user, Save As is the only option.

    Niagara Analytics Explorer

  2. Name the dashboard.

    Niagara Analytics Explorer

    If you want, add a description, and specify whether this is a public dashboard. A public dashboard can be viewed by anyone who can log in to this Niagara station, but only the creator can delete it or overwrite it. A non-public dashboard can be seen only by the person who created it.


View a Dashboard

To view a dashboard:

  • From the landing page, click the dashboard.

    If you created a dashboard, it has a blue icon. If someone else created it, it has a gray icon.

    Niagara Analytics Explorer


Delete a Dashboard

You can delete public dashboards only if you created them.

To delete a dashboard:

  • From the landing page, right-click the dashboard, and select Delete Dashboard.

    Niagara Analytics Explorer


Edit a Dashboard

There are two ways to edit a dashboard that has already been created:

  • From the landing page, right-click the dashboard, and select Edit Dashboard.

    This option is available only for dashboards that you created.

    Niagara Analytics Explorer


Edit Dashboard Settings

To edit the name or description of a dashboard, or whether the dashboard is public:

  • From the landing page, right-click the dashboard, and select Edit Settings.

    Niagara Analytics Explorer


Return to the Landing Page

To return to the landing page from a dashboard, click Back or Home.

Niagara Analytics Explorer Niagara Analytics Explorer


Widget Properties

Area Chart

Area Chart

Area Chart
The Area Chart widget
The Area Chart widget

Setting Purpose
Set Label Set the title text at the top of the widget.
Series Type

Set whether series are added together. "Overlaid" specifies that each chart series is plotted without being changed. "Stacked" specifies that data values are added with values in previous series, so that the total combined height of all the series is the total of the Y values for the X value.

Overlaid Stacked
Overlaid and Stacked Area Chart widgets

Show Legend Show or hide the chart legend.
Range

Set whether the chart shows:

  • The dashboad's global date range
  • The next date range relative to the global range
  • The previous range relative to the global range
Interval Set the interval for the chart rollup. One point is plotted per instance of the interval. The default interval is 15 minutes.
Rollup Set the type of data that is shown for each date/time interval.
Custom Range Override the dashboard's global date range.
Remove Series Click Invoke to remove the last series that was added.

Note Regarding Axes

On an area chart, a numeric axis is rendered for numeric data and a boolean axis for boolean data. If the chart includes both numeric and boolean data, two y-axes appear, one of each type.

Line Chart

Line Chart

Line Chart
The Line Chart widget
The Line Chart widget

Setting Purpose
Set Label Set the title text at the top of the widget.
Show Legend Show or hide the chart legend.
Range

Set whether the chart shows:

  • The dashboard's global date range
  • The next date range relative to the global range
  • The previous range relative to the global range
Interval Set the interval for the chart rollup. One point is plotted per instance of the interval. The default interval is 15 minutes.
Rollup Set the type of data that is shown for each date/time interval.
Custom Range Override the dashboard's global date range.
Remove Series Click Invoke to remove the last series that was added.

Note Regarding Axes

On a line chart, a numeric axis is rendered for numeric data and a boolean axis for boolean data. If the chart includes both numeric and boolean data, two y-axes appear, one of each type.

Column Chart

Column Chart

Column Chart
Historical Column Chart Real-Time Column Chart
The Column Chart widget with historical and real-time data

Setting Purpose
Set Label Set the title text at the top of the widget.
Show Current Value

Set whether historical or real-time data is shown. A false value is the default and indicates historical data.

Notes Regarding Axes

On a column chart, when historical data is shown, a numeric axis is rendered for numeric data and a boolean axis for boolean data. If the chart includes both numeric and boolean data, two y-axes appear, one of each type.

However, when real-time data is shown, only a numeric axis is included. If there is a boolean series on a real-time chart, false values are displayed as 0 and true values as 1.

Historical Boolean Data Real-Time Boolean Data
Historical and real-time boolean data

Series Type

For historical charts, set column placement and whether series are added together. "Overlaid" specifies that each chart series is plotted without being changed. "Stacked" specifies that data values are added with values in previous series, so that the total height of a column is the total of the data values for that column's X value. "Clustered" is identical to Overlaid, except for where the columns are positioned. In a Clustered layout the columns are laid out next to one another.

Overlaid Stacked Clustered
Overlaid, Stacked, and Clustered Column Chart widgets

Range

Set whether the chart shows:

  • The dashboard's global date range
  • The next date range relative to the global range
  • The previous range relative to the global range
Interval Set the date/time interval between points. One point is plotted per instance of the Interval. The default interval is 15 minutes.
Rollup Set the type of data that is shown for each date/time interval.
Custom Range Override the dashboard's global date range.
Show Legend Show or hide the chart legend.
Remove Series Click Invoke to remove the last series that was added.

Bar Chart

Bar Chart

Bar Chart
Historical Bar Chart Real-Time Bar Chart
The Bar Chart widget with historical and real-time data

Setting Purpose
Set Label Set the title text at the top of the widget.
Show Current Value

Set whether historical or real-time data is shown. A false value is the default and indicates historical data.

Notes Regarding Axes

On a bar chart, when historical data is shown, a numeric axis is rendered for numeric data and a boolean axis for boolean data. If the chart includes both numeric and boolean data, two x-axes appear, one of each type.

However, when real-time data is shown, only a numeric axis is included. If there is a boolean series on a real-time chart, false values are displayed as 0 and true values as 1.

Historical Boolean Data Real-Time Boolean Data
Historical and real-time boolean data

Series Type

For historical charts, set bar placement and whether series are added together. "Overlaid" specifies that each chart series is plotted without being changed. "Stacked" specifies that data values are added with values in previous series, so that the total length of a bar is the total of the data values for that bar's Y value. "Clustered" is identical to Overlaid, except for where the bars are positioned. In a Clustered layout the bars are laid out next to one another.

Overlaid Stacked Clustered
Overlaid, Stacked, and Clustered Bar Chart widgets

Range

Set whether the chart shows:

  • The dashboard's global date range
  • The next date range relative to the global range
  • The previous range relative to the global range
Interval Set the date/time interval between points. One point is plotted per instance of the Interval. The default interval is 15 minutes.
Rollup Set the type of data that is shown for each date/time interval.
Custom Range Override the dashboard's global date range.
Show Legend Show or hide the chart legend.
Remove Series Click Invoke to remove the last series that was added.

Pie Chart

Pie Chart

Pie Chart
The Pie Chart widget
The Pie Chart widget

Setting Purpose
Set Label Set the title text at the top of the widget.
Show Legend Show or hide the chart legend.
Remove Series Click Invoke to remove the last series that was added.

Callout

Callout

Callout
The Callout widget
The Callout widget

Setting Purpose
Set Label Set the title text at the top of the widget.

Node List

Node List

Node List
The Node List widget
The Node List widget

Setting Purpose
Set Label Set the title text at the top of the widget.
Remove Series Click Invoke to remove the last item that was added.

Gauge

Gauge

Gauge
The Gauge widget
The Gauge widget

Setting Purpose
Label Set the title text at the top of the widget.
Gauge Min Set the minimum of the gauge range.
Gauge Max Set the maximum of the gauge range.
Remove Series Click Invoke to remove the last data value that was added.

Weather

Weather

Weather
The Weather widget
The Weather widget

Setting Purpose
Postal Code Set the postal code to display weather information for.
Country Set the country that goes with the postal code.
Units Choose between Fahrenheit and Celsius.