Event Name

This is the name of the event that will be created from this custom event. This value can be whatever you want.

Type Code

This is the type code of the event that will be created from this custom event.

This can be whichever type code you want, however the list is filtered by type.

For all events except the Condition Formula, the typecode must be numeric because it outputs numeric values.

The Condition Formula can be either numeric or string.

Description

Enter a meaningful description.

Aggregation Level

Note that there will be additional filtering of the data streams based on product/event.

While this option is called device level, it is more accurately device/thing level. This will only take data from data streams that are directly on the device/thing itself.

So, this type is good for transposing data on the device directly (Dividing a data stream by 1000), or in a thing it is useful to layer custom events on other custom event (for example create a hierarchy custom event for Occupied Desks, another hierarchy event for Unoccupied desks, and then create a thing level event to sum those data streams. Note that order of the events is relevant as they are calculated in order)

Groups

This can only be created on group templates, this will aggregate the data streams of all the Devices directly in the group, so for example if I have multiple energy meter devices in a room, I can use this to combine them into the total room energy consumption.

This can only be created on group templates. This will add all the data streams from exactly one level down the hierarchy, but not include devices in the group itself. This is useful in hierarchy situations where you want to aggregate things from one level down. For example if you want to create a floor energy consumption which consolidates the data from the room level energy consumption readings.

This can only be created on group templates. This will add all the data streams from all the devices/things that are underneath this group in the hierarchy regardless of depth.

Logical type

Setting a range will affect coloring for the readings in widgets/diagrams, etc. (This is the same as for a regular event).

Precision

How many digits should be displayed after the decimal point to show for this event. (This is the same as for a regular event).

Unit to display

The unit of the reading. (This is the same as for a regular event).

Icon

Sets the Icon for the reading. (This is the same as for a regular event).

Color

Sets the color for the reading. (This is the same as for a regular event).

Data to aggregate

This tells the calculation engine what event we are working on (this is then crossed with the aggregation level to choose the data stream we will be aggregating. To help you find the event it is broken down by product.

The options are:

Note that if you choose an Aggregation Level of Device you can only choose Current Product Events. This is because the aggregation level will filter out anything that isn’t the current device.

Aggregation Method

This sets what aggregation method to do on all the data streams that were found on device/things based on the aggregation level and the event filtering, the options are:

Event

This tells the calculation engine what event we are working on (this is then crossed with the aggregation level to choose the data stream we will be aggregating. To help you find the event it is broken down by product.

The options are:

Note that if you choose an Aggregation Level of Device you can only choose Current Product Events. This is because the aggregation level will filter out anything that isn’t the current device.

Aggregation Times

This is what historical period we want to include in our aggregation:

Single aggregation/Bucket aggregation

The calculation engine will allow you to support either a single aggregation for the entire historical data or a two-step process where you aggregate the data twice. If you chose single aggregation you choose between the various aggregation methods available, if you chose bucket aggregation you will be able to do two separate roll ups:

The calculation engine will first roll up the data into the bucket interval selected, with the bucket aggregation method, and then roll up the rolled-up data points into one data point, with the outer aggregation method selected.

This allows you to create scenarios like, create the sum of the energy consumption per day, and then create an average of the daily energy consumptions per month.

Event to aggregate

This tells the calculation engine what event we are working on (this is then crossed with the aggregation level to choose the data stream we will be aggregating. To help you find the event it is broken down by product. For count by value, you cannot choose a cross product event

Single Product Events

This lets you find any product/group template and choose any event from them:

Anything that is not in the time frame will be ignored, so if you chose the door event, on value open and within last 24 hours, if the current reading of a specific door is open, but that reading was sent 3 days ago, it will not be counted.

Numerator

The numerator hast to be a numeric event.

Denominator

Can be either a numeric event or property.

Variables

Variables have five types:

You can create as many variables as you want and then use them in a formula.

Formula

This is an open text field where you can input an expression using the variables you created, in addition you can use +,-,*,/,() and numbers. Remember that every variable will create just one number so the expression will be a simple expression after the variables are resolved. Example formulas can be:

Note that when introducing a division into your formula you must make sure that you do not divide by zero, as that will cause the event to not be calculated.