The formula is the mathematical driver of your custom analytics calculations.
Formulas combine Components with numeric inputs and operands from the Formula Function List to create calculations based on values within your project.
Add Components
To create a formula, first define the input Components
Each component is represented by a single letter, like `A`. Use these letters to create a formula that captures the value you'd like to see.
Add as many components as necessary to complete your calculation.
Build your formula
Remember that each component has a letter assigned at the left side? Input that letter in the formula to pull that value as an input.
Formula text must be in ALLCAPS
Use + - * / for calculations or explore Formula Function List for more complex operands. Add fixed values into the formula. Use ( ) for order of operations.
For example, a 10% contingency cost for two items can be represented by `(A + B) * 0.1`.
Here are a couple examples:
A Simple Formula
Use case: Report the total gross building area of the project.
This only requires one component: gross building area property
The formula only requires the A to pull that component value into the report.
A Complex Formula
Use case: calculate Terminal Value for a project proforma
This requires a few pre-computed calculations - rent, vacancy rate, and cap rate. You then call those calculations in as components.
The formula for calculating Terminal Value requires order of operations, multiple operands, and the three component values.
Calculating Null Values
When calculating formulas, geometries that do not have a property value set are treated as Null (not 0).
IE: when calculating cost as hardCost * area, a geometry with no hardCost set will be skipped rather than counted as hardCost=0.
This helps avoid divide by 0 errors.
Preview results
A preview of your calculated value will appear in the result. You will also be notified of any unused components or evaluation errors in this section.
On the left: Per Feature
Review the formula calculation on each individual geometry included.
Cycle through geometries with the left/right arrow buttons.
Per feature will only display if the calculation includes a Property component. If there is no property component used, you will see this message:
On the right: Results
Review the calculated result.
This is the rolled up total based on the applied Operation.
You will also see a report of calculation errors and unused components, if applicable.
