Prerequisites

Niagara certification

As the systems integrator or data model designer, you have completed Niagara certification training and are familiar with the Workbench interface.

Supported hosts

Niagara Analytics Framework runs on a Niagara 4 Supervisor, JACE-8000 orNiagara Edge 10 host.

Memory requirement

The number of points, algorithms and history records a host (PC or remote host) can process is limited by available memory. Compared to running in a JACE or Edge device, more memory resources are available when running a Supervisor station on a PC.

A lack of adequate memory (heap memory) to run the framework can cause a Supervisor station to fail. The amount of available heap memory on a PC is determined by the Xmx property as configured in the nre.properties (Niagara Runtime Environment) file. This text file is located in the etc folder under the daemon user home directory. Your PC must have enough physical memory resources to accommodate any change you make to the Xmx property.

NOTE: You can choose the daemon user home location during Workbench installation. Assuming you install on a “C” drive, the default location is C:\ProgramData\Niagara4.x\<brandname>. See the Selecting the Daemon User Home location topic for related information about daemon user home.

License requirement and limitations

Niagara Analytics Framework must be licensed for your host (Supervisor PC, JACE or Edge device). You add the feature to an engineering license using the standard Niagara licensing model.

The license limits the number of points the framework can use. An a:a tag on a point marks it as being used by the framework. The AutoTagAnalyticPoint property on the AnalyticService controls the automatic tagging of points used by the framework. When this property is set to true, the framework applies the a:a tag to any point referenced by an analytic request.

Modules required

These modules run under all framework versions.

analytics-lib-ux.jar
analytics-rt.jar is required by both stations and engineering platforms running tools ( Workbench)
analytics-ux.jar
analytics-wb.jar is the user interface. This module is required to run the engineering tool ( Workbench).

Core software and modules required

The framework requires the latest version of Niagara. The specific modules the framework requires include:

alarm.jar
baja.jar
bajaui.jar
bql.jar
control.jar
driver.jar
email.jar
file.jar
fox.jar
gx.jar
history.jar
niagaraDriver.jar
platform.jar
schedule.jar
wbutil.jar
web.jar
workbench.jar

These modules reside in the modules folder.

Browser requirement

The framework’s visualization tools include web charts (Ux charts) with scalable, vector graphics. These graphics require a browser that supports HTML5.

Station configuration

The procedures in this guide assume that you have configured the network with at least one remote host and station whose device drivers and points have been set up and configured for your application. It also assumes that all proxy points have been discovered and configured in any remote host station, and in your Supervisor station.