The calculation builder takes inputs in the form of workbook "columns" selected by the user, applies functions and operators to those inputs, and then gives the user a resulting output in the form of a workbook "calculation column".
The Calculation Builder modal is shown below.
The calculation expression is written in this area. Example, SUM(Variable1, Variable2).
The Variable configuration is applied in this area of the modal. The user can change the name of the variable, change the source column and apply point-of-use (POU) configuration to each variable.
The columns and the Functions are found in this area of the modal. The functions such as "SUM", "MAX", and "ROUND" are all found under the "functions" tab.
Creating a Calculation
Step 1
Click on the Add Column drop-down and select "Calculation Column". This will launch the calculation builder modal.
Step 2
Give the calculation a "Name" and add a "Description" using the text input fields at the top of the modal.
Step 3
Select the data type that the calculation produces (Numeric, Boolean or String) and select the unit that the calculation output will be displayed as. In this example, we have selected "kWh" for kilowatt-hours.
Step 4
Build your calculation expression using the functions, operators and column inputs. The example below is simply creating a sum of four pumps.
To add a Function simply find it in the list and click on it. It will then appear in the calculation expression window. You can add columns by clicking on the "+ New Variable" button. They will then appear in the Calculation expression and the Variable configuration table below.
Step 5
Apply any necessary Variable Configuration the each of the variables being used in the calculation expression.
You can:
Change the Variable Name
Change the Source Column
Convert the units
Apply Default Value If Null
Step 6
Save the Calculation by clicking the "Save Calculation Column" button.
The calculation column is then ready to use in a visualisation or a subsequent calculation.