Analytic web chart binding

This binding configures a trend request and returns trend data. You can use it wherever a traditional table chart binding can be used.

Figure 215. AnalyticWebChartBinding properties

You access this view of the Analytic Web Chart Binding properties when you double-click the web widget in the Px view.

Property	Value	Description
degradeBehavior	`Disable` or `None`	Specifies the framework’s behavior when the binding analytic ORD cannot be resolved or used due to security permissions.
data	tag or algorithm name	Specifies the an algorithm (or tag) used to retrieve data. The purpose of an alert is to detect a fault condition (Boolean value result). In most cases, you would pick an algorithm that has a Boolean result when configuring this property for an alert. Algorithms with a numeric or enum value greater than zero are considered true and less than zero are considered false. This is how output from one algorithm becomes the input data source to another algorithm. The prefix for algorithms is alg:.
node	ORD (defaults to a relative ORD slot, which is resolved against the config space to which the Px view is assigned)	Defines the ORD to the desired slot.
dataFilter	ORD parameter	Identifies data sources in the subtree of the request node. When a predicate accepts a node that contains the desired data, the system does not search the node’s subtree for additional values (including the root node).
timeRange	ORD parameter (defaults to `Today`)	Defines the time period used to query historical data.Defines the beginning and end of a period of time over which to count the number of occurrences or weight. If the alert depends on a certain number of occurrences or weight over time, this property is required, otherwise, it is optional.
interval	ORD parameter	Refers to the BInterval component, which the framework uses to identify the time between values in a trend (time series). When specified, a rollup is required, which causes the system to combine all values that fall into a single interval. Options range from `None` to a `Year`. Above the drop-down list, the `Use This Value` check box turns on and off the check box next to `Interval` in the Settings window (you access this window by clicking the Edit button (), followed by clicking the Settings button () on the chart). The availability of this check box provides an easy way for a user to enable and disable the use of intervals in chart calculations.
aggregation	ORD parameter	Configures the default function to apply when the analytic request needs to combine values from multiple data sources into a single value. This applies to both value and trend requests. If aggregation is not enabled in the binding/settings window, the aggregation value defined in the Data Definition applies to all chart bindings, reports and tables. `And` returns the logical “and” of Boolean values. `Avg` returns the statistical mean, which is determined by calculating the sum of all values and dividing by the number of values. `Count` returns the total number or quantity of values in a combination. If you request this value on a binding in a PX view, the system counts the number of values based on the properties defined by the data source block and the algorithm’s Property Sheet. `First` returns the first value in the combination. `Last` returns the last value in the combination. `Max` returns the highest value in the combination. `Median` returns the value in the middle of a sorted combination—the number that separates the higher half from the lower half. `Min` returns the lowest value in the combination. `Mode` returns the statistically most frequently occurring number in the combination. `Or` returns the logical “or” of Boolean values. `Range` returns the statistical difference between the largest and smallest values in the combination. `Sum` adds together all values in the combination resulting in a single value. `Load Factor` returns the average value divided by peak value. `Std Dev` returns the standard deviation of the values in the combination.
rollup	ORD parameter (rollup=option)	Configures the default function to apply when the analytic request needs to rollup records from a single data source into less granular records. This typically only applies to trend request, but may also apply to value requests where the `Id` is an algorithm that contains a block like Runtime or Sliding Window, which processes a trend request. If rollup is not enabled in the binding/settings window, the rollup value configured in the Data Definition applies to all chart bindings, reports and tables. `And` returns the logical “and” of Boolean values. `Avg` returns the statistical mean, which is determined by calculating the sum of all values and dividing by the number of values. `Count` returns the total number or quantity of values in a combination. If you request this value on a binding in a PX view, the system counts the number of values based on the properties defined by the data source block and the algorithm’s Property Sheet. `First` returns the first value in the combination. `Last` returns the last value in the combination. `Max` returns the highest value in the combination. `Median` returns the value in the middle of a sorted combination—the number that separates the higher half from the lower half. `Min` returns the lowest value in the combination. `Mode` returns the statistically most frequently occurring number in the combination. `Or` returns the logical “or” of Boolean values. `Range` returns the statistical difference between the largest and smallest values in the combination. `Sum` adds together all values in the combination resulting in a single value. `Std Dev` calculates the standard deviation of the values in the combination. `Load Factor` calculates the average divided by peak (Max) value.
unit	unit of measure	Selects the unit name and display symbol to associate with a data source.
seriesName	BFormat (defaults to %node.navDisplayName-data.name%	Defines the node and tag name configured by the `Data` property. The BFormat value may contain static text or scripts that use the percentage symbol delimiter, such as %node.navDisplayName%. The default value is %node.navDisplayName%-%data.name%, which resolves to the navDisplayName of the node and the name of the tag configured by the `Data` property, such as ”Building1-Power.” The %data.name% script drops the tags namespace, such as “hs:” or the algorithm reference, such as “alg:.” If you enter an invalid value, the system displays, “Problem with seriesName BFormat,” and logs a message in the station console. The name you enter here displays as the legend and tool tip in the Web chart. If left blank, no legend displays for the tool tip.
daysOfWeek	ORD scheme	Specifies the days of the week to include.
totalize	`true` or `false`	Turns on (`true`) and off (`false`) value accumulation. By default, the framework totalizes (accumulates) all consumption history values in charts, tables and reports. To prevent cumulative values, disable this property (set it to `false`).
missingDataStrategy	chooser	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.

Figure 216. Sample table configured with an analytic web chart binding

Settings window

Clicking the wrench icon opens the Settings window with which to configure table properties.

Figure 217. Settings window

For history data, the table shows the timestamp history value and status. Pagination and search features are available for the table.

Property	Value	Description
Interval	optional drop-down list (defaults to the optimal number of records on reports)	Defines the frequency at which the framework displays a history record.
Rollup	value (when configured in the Data Definition, defaults to `First`, when configured elsewhere, defaults to the value as defined in the Data Definition)	Configures the default function to apply when the analytic request needs to rollup records from a single data source into less granular records. This typically only applies to trend request, but may also apply to value requests where the `Id` is an algorithm that contains a block like Runtime or Sliding Window, which processes a trend request. If rollup is not enabled in the binding/settings window, the rollup value configured in the Data Definition applies to all chart bindings, reports and tables. `And` returns the logical “and” of Boolean values. `Avg` returns the statistical mean, which is determined by calculating the sum of all values and dividing by the number of values. `Count` returns the total number or quantity of values in a combination. If you request this value on a binding in a PX view, the system counts the number of values based on the properties defined by the data source block and the algorithm’s Property Sheet. `First` returns the first value in the combination. `Last` returns the last value in the combination. `Max` returns the highest value in the combination. `Median` returns the value in the middle of a sorted combination—the number that separates the higher half from the lower half. `Min` returns the lowest value in the combination. `Mode` returns the statistically most frequently occurring number in the combination. `Or` returns the logical “or” of Boolean values. `Range` returns the statistical difference between the largest and smallest values in the combination. `Sum` adds together all values in the combination resulting in a single value. `Std Dev` calculates the standard deviation of the values in the combination. `Load Factor` calculates the average divided by peak (Max) value.
Aggregation	check box (if optional, and) drop-down list (property, defaults to `First`) or ORD parameter (aggregation=option)	Configures the default function to apply when the analytic request needs to combine values from multiple data sources into a single value. This applies to both value and trend requests. If aggregation is not enabled in the binding/settings window, the aggregation value defined in the Data Definition applies to all chart bindings, reports and tables. `And` returns the logical “and” of Boolean values. `Avg` returns the statistical mean, which is determined by calculating the sum of all values and dividing by the number of values. `Count` returns the total number or quantity of values in a combination. If you request this value on a binding in a PX view, the system counts the number of values based on the properties defined by the data source block and the algorithm’s Property Sheet. `First` returns the first value in the combination. `Last` returns the last value in the combination. `Max` returns the highest value in the combination. `Median` returns the value in the middle of a sorted combination—the number that separates the higher half from the lower half. `Min` returns the lowest value in the combination. `Mode` returns the statistically most frequently occurring number in the combination. `Or` returns the logical “or” of Boolean values. `Range` returns the statistical difference between the largest and smallest values in the combination. `Sum` adds together all values in the combination resulting in a single value. `Load Factor` returns the average value divided by peak value. `Std Dev` returns the standard deviation of the values in the combination.
Units	drop-down list of units of measure	Defines the unit of measure for the data gathered from each point.
Data	tag or algorithm name	Specifies the an algorithm (or tag) used to retrieve data. The purpose of an alert is to detect a fault condition (Boolean value result). In most cases, you would pick an algorithm that has a Boolean result when configuring this property for an alert. Algorithms with a numeric or enum value greater than zero are considered true and less than zero are considered false. This is how output from one algorithm becomes the input data source to another algorithm. The prefix for algorithms is alg:.
Data Filter	optional NEQL predicate (property) or ORD parameter (`dataFilter=query`)	Identifies data sources in the subtree of the request node. When a predicate accepts a node that contains the desired data, the system does not search the node’s subtree for additional values (including the root node).
Days to Include	days-of-the-week selector	Specifies the days of the week to include.
Series Name	BFormat	Defines the node and tag name configured by the `Data` property. The BFormat value may contain static text or scripts that use the percentage symbol delimiter, such as %node.navDisplayName%. The default value is %node.navDisplayName%-%data.name%, which resolves to the navDisplayName of the node and the name of the tag configured by the `Data` property, such as ”Building1-Power.” The %data.name% script drops the tags namespace, such as “hs:” or the algorithm reference, such as “alg:.” If you enter an invalid value, the system displays, “Problem with seriesName BFormat,” and logs a message in the station console. The name you enter here displays as the legend and tool tip in the Web chart. If left blank, no legend displays for the tool tip.
Totalize	`true` or `false`	Turns on (`true`) and off (`false`) value accumulation. By default, the framework totalizes (accumulates) all consumption history values in charts, tables and reports. To prevent cumulative values, disable this property (set it to `false`).
Missing Data Strategy, Use This Value	check box	Enables and disables missing data interpolation for the current value. When enabled, the framework applies this strategy to all requests. When enabled, the framework applies this strategy to all requests.
Missing Data Strategy, Aggregation Strategy	drop-down list	Configures how the framework handles missing trend data (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. NOTE: If the analytic trend request specifies `Interval` = `none`, the framework ignores the Missing Data Strategy. `Ignore Series` ignores the entire series if any record even one interval is missing. `Ignore Point` ignores any missing records and aggregates the values in the existing records.
Missing Data Strategy, Interpolation Algorithm	drop-down list	Defines the algorithm used to interpolate values for missing values (missing records). `None` does not interpolate values for missing records. `Linear Interpolation` replaces a missing record by linearly interpolating the missing value using the prior and next records on either side of the missing record. `K-Nearest Neighbor` is for numeric, enum and Boolean records. This strategy replaces a missing value by calculating the majority value recorded for the item’s nearest K number of neighbors.
Missing Data Strategy, K Value	number	Defines the number of records used by the configured interpolation algorithm when a record is missing to calculate the interpolated value.

Analytic web chart binding

Figure 215. AnalyticWebChartBinding properties

Figure 216. Sample table configured with an analytic web chart binding

Settings window

Figure 217. Settings window

Related Links