AnalyticService (BAnalyticService)

This is the root container of nearly all analytical components except analytic proxy points, which are scattered throughout the station tree. The properties on this component configure global aspects of the framework.

Under the service container, are folders and properties for:

Alerts
Algorithms
Definitions
Pollers
Analytics Subscription
Reports contains HTML versions of seven charts that service the energy suite
Missing Data Strategy

These folders may have sub-folders.

Figure 51. AnalyticService properties

To view the component's Property Sheet in Workbench, right-click the Config > Services > AnalyticService container in the Nav tree, and click Views > Property Sheet. The same properties are available in the web UI.

Property	Value	Description
Status	read-only	Displays the current state of the component or extension. The platform connection will be in fault if any of the following occurs: Supervisor has no ProvisioningNwExt under its NiagaraNetwork (for example, it has been deleted). Supervisor is not licensed for provisioning. NiagaraStation is in fault. The station’s platform daemon rejects the platform connection’s credentials. The extension is disabled if its `Enabled` property is set to `false` or the ProvisioningNwExt is disabled.
Fault Cause	read-only	Indicates the reason why a system object (network, device, component, extension, etc.) is not working (in fault). This property is empty unless a fault exists.
Enabled	`true` or `false`	Activates (`true`) and deactivates (`false`) use of the object (network, device, point, component, table, schedule, descriptor, etc.).
Rt Version	read-only	Displays the installed version of the Niagara Analytics Framework runtime (Rt) modules.
Wb Version	read-only	Displays the installed version of the Workbench modules.
Ux Version	read-only	Displays the installed version of the Ux chart modules.
Alert Count	read-only number	Reports the current number of alerts in the Alert folder.
Algorithm Count	read-only number	Reports the current number of algorithms in the station. Algorithms are the rules you create.
Point Count	read-only number	Reports how many analytic points you are using. `Auto Tag Analytic Point` configures the framework to add an a:a tag to each point used in each algorithm. The framework uses this tag to return this `Point Count`.
Proxy Ext Count	read-only number	Sums all Analytic proxy extensions used by the framework.
Caching	read-only `true` or `false`	Returns `true` if the framework is currently in the process of caching memory. Otherwise, returns `false`.
Cache Built	read-only `true` or `false`	Returns `true` if the framework has completed the process of caching memory. Otherwise, returns `false`.
Caching Startup Delay	Number (Defaults to 1 minute)	Configures the amount of time to delay before refreshing cache at station startup. Stations with a lot of connected equipment may need a longer delay before refreshing cache. You can see this delay in the console. If you add elements to the model after starting the station, just use the Refresh Cache action.
Auto Tag Analytic Point	`true` or `false` (default)	Configures the automatic assignment of an a:a tag to each point used in an algorithm. `true` does two things when rebuilding cache memory by right-clicking AnalyticService > Actions > Refresh Cache: includes the point data in the algorithm result. updates the counts when rebuilding cache memory. Knowing how many points are used by the framework is related to licensing. Auto tagging continues until it reaches the maximum number of points allowed by your license. When it reaches the maximum, it stops tagging. `false` does not automatically assign an a:a tag to each point. This does two things when rebuilding cache memory: excludes the point data from the algorithm result. does not add the point to the counts on this Property Sheet. A `false` setting for this property may explain why algorithms may not work.
Test Cov Neql	`namespace` (defaults to hs:hisInterpolate = ‘cov’)	The Analytics engine uses this expression to identify cov points. The engine automatically inserts cov points using the interval mentioned in the request.
Totalized Points	text	Defines the tag used to identify points to be totaled.
Area Tag	namespace:tagname	Defines the value tag from the tag dictionary to use for the `Floor Area` normalization calculation on the Average Profile and Load Duration reports.
Oat Tag	namespace:tagname	Defines the outside air temperature used by the Average Profile and Load Duration reports in their `Degree Day` normalization calculation.
Alerts	container	Serves a a container for all diagnostics.
Algorithms	container	Serves as a container for all algorithms.
Definitions	container	Serves as a container for all Data Definitions.
Pollers	container	Serves as a container for all pollers used to execute alerts and analytic proxy points.
Skip Data Source Cache	`true` or `false` (default)	The framework automatically caches the data source in memory. If you do not want this feature, set this property to `true`.
Analytics Subscription	additional properties	As with other Niagara features, use of this framework is based on a subscription, which you must renew periodically. The Analytics Subscription properties configure an alarm to remind you that your subscription is about to expire. Refer to Analytics Subscription properties.
Reports	container	Serves as a location for analytic reports.
Missing Data Strategy	additional properties	Configures how the framework handles missing data in a series when processing analytic requests and one or more records are missing for an interval. It applies when even a single record for an interval is missing. It does not apply to value requests. Refer to Missing Data Strategy
Chart Render Capacity	additional properties	These properties are only visible after removing the hidden flag on the chartRenderCapacity slot. Refer to Chart Render Capacity (advanced property)

Actions

Action	Description
Refresh Cache	Calculates data cache memory requirements without searching all hierarchies. You should invoke this action after adding new tags.
Stop Caching	Terminates caching.

Chart Render Capacity (advanced property)

This property configures the default number of records used to render data on charts and reports. The default limitations help to provide acceptable framework performance.

IMPORTANT: Increasing these values may significantly degrade framework performance.

To access the Chart Render Capacity property you must first un-check the chartRenderCapacity hidden flag on the slot sheet, then expand the AnalyticService node in Workbenchor the web UI.

Figure 52. Chart Render Capacity property as it appears in the web UI