Aggregate Groups in Hyper Historian


Hyper Historian can log raw data at a very fast rate without compromising performance. It may result in a large amount of data which needs to be further analyzed. In order to speed up the client access Hyper Historian can perform the analysis on the server side and provide the results of the evaluation to the clients. Each such configured evaluation is called an aggregate. In the Hyper Historian Logger’s address space, aggregates are represented as nodes.


A tag's aggregate calculation evaluation runs in the background independently and its results are stored by the Hyper Historian logger based on the parameters defined by the aggregate group.

Configuring Aggregate Group

An aggregate group is the definition of a calculation period for aggregating data. You can have multiple aggregate groups in a logging group. Each Hyper Historian tag can have multiple aggregates configured for it, and each aggregate points to a different aggregate group.

  1. Assuming that you have a Logging Group (e.g. My Logging Group) configured under the Groups folder right-click on it and add an Aggregate Group.

Figure 1 - Adding an Aggregate Group

  1. Enter the name of the Aggregate Group. Give it a name that describes what it does.

  2. Specify the Calculation period. The Calculation period is the frequency with which the Hyper Historian Logger is to perform the aggregate calculation.

  3. Enter a percentage next to Percent Good. If the percentage of good values collected during the calculation period is greater than or equal to this percentage, the aggregate is considered good. The default value is 80%.

  4. Enable the Treat Uncertain As Bad check box if you would like collected data with an unknown quality to be considered bad for the aggregate's Percent Good calculation.

  5. Enter a description of the aggregate group. Provide enough information so that its precise function is obvious to anyone who may need to maintain it now or later.

  6. Click the Apply button to enter the changes.

Figure 2 - Aggregate Group

Defining Aggregate for Hyper Historian Tag

Tag aggregates are defined for a Hyper Historian tag. In other words, you can configure a Hyper Historian tag to use aggregation. 

  1. In the Project Explorer, expand the collector group of the tag you want to include in an aggregation (e.g. Sine1).

  2. Double-click the tag to open the Hyper Historian Tag form. Go to the form's Tag Aggregates sub-tab as shown below.

Figure 3 - Tag Aggregates Sub-Tab for the Hyper Historian Tag

Hyper Historian Aggregate Type Drop-down List

  1. Select the Aggregate Group from the Aggregate Group drop-down list. The drop-down list contains all of the aggregate groups defined for all collector groups. If you don't see an aggregate group that you recently defined, click the Refresh Aggregate Group button, then look for it again.

  2. From the Aggregate Type drop-down list, specify how you want the tag's information to aggregate. See "Aggregate Type Descriptions" below for descriptions of these options. Notice that once you choose the group and type, information in other columns populates.

  3. Note that Hyper Historian names the aggregates for you. Each aggregate is given an abbreviated name (in the Aggregate Name column) as well as a display name (in the Display Name column). These names are made up of the Aggregate Type + Aggregate Group. You can modify the name to suit your convention.

  4. Make sure you Enable the aggregates, or they won't be collected.

  5. If you want to override the sampling rate, you can click a check mark in the Override Sample column. Then change the sampling rate by clicking the ellipsis button in the Sampling Rate column and change the rate on the Enter Sampling Rate dialog box that appears.

  6. Click the Apply Button to save the changes.

  7. You can repeat these steps to add additional aggregates for the current tag or other tags.

  8. Once you have finished your aggregate tags configuration, start the Hyper Historian service.

You can view the data logged for each aggregate tag the same way you would for any Hyper Historian tags. In Data Browser, the aggregate is presented as a property of the aggregated tag.


NOTE: Once you add a historical tag to a TrendWorX Viewer, you can also choose aggregates mentioned in this topic. You can still use the viewer to request aggregate values from the HDA server regardless whether you did or did not configure an aggregate in Hyper Historian.

Recalculation of Aggregates

In Hyper Historian, aggregates are calculated in accordance with their calculation period on an ongoing basis. There may be a time at which you will want to recalculate the aggregates that are already stored in Hyper Historian, for example after new historical data is added or historical data has been updated, or a new aggregate was added to a Hyper Historian tag. You can recalculate aggregates by using the Aggregate Tasks Management form, available in Hyper Historian under the System Administration node. You can schedule a task to run at a specific time in the future, or you can run it immediately.


Figure 4 - Re-Calculating Aggregates


Note.  Tasks are stored in a text file that you can update manually or by using an automated process; you are not required to use the Hyper Historian form provided for you in the GENESIS64 Workbench. The Aggregation Tasks file's default location is:



Aggregate Type Descriptions

Here is the list of available Aggregate types.