Calculated Fields
Introduction
The calculated fields feature allows you to make calculations on numeric and textual fields inside the report itself, so there is no obligation to export the report to Excel. In addition, there is full support for filtering the fields according to the calculation results.
This feature can also be used in schedule reports, saved as favorites, etc.
Basic points
There is a differentiation between textual to numeric fields. The user has to select “numeric” or “textual” in the calculated fields toggle, depending on the required calculation. As a result, different fields will be available for each type of calculation engine. Only system parameters which return numeric values will be available in the numeric engine, while in the textual engine all fields will be available (but will be considered as strings).
The engine is case-insensitive when using functions names
Supported Mathematical Functions
Basic mathematical functions
Advanced numerical mathematical functions
In numerical formulas, line breaks (Enter) are not permitted, as otherwise the calculation is not
performed and we are left with 0 as a result.
Function | Explanation | Examples |
|---|---|---|
| The function will display the smallest/largest number between two or more fields or numbers | Min(unit_id; 1000) |
AVG | The function will display the average between two or more fields or numbers | AVG(a1; a2; a3; ...) |
ABS | The ABS function returns the absolute value of the given number | ABS(-10) |
| The “IF” function is a decision-making condition function between numerical fields. The following boolean operations are supported in numeric fields: "<", ">", "==", "!=" 0 == 0 -> True 0 != 0 -> False |
|
Advanced Textual functions
All text/string in textual fields must be written inside single quotes, i.e., ‘Text’ (not including function names).
You must use a semicolon (;) sign to separate the clauses in the equation instead of a regular comma.
Textual fields are case sensitive. For example, CONTAINS(‘OFFGRID’ ; ‘off’) returns false, but CONTAINS(‘OFFGRID’ ; ‘OFF) returns true.
To concatenate several And/Or conditions, add parentheses for each condition, as in the following example: IF(('unit_is_stationary' = 'Yes')&&('unit_is_stationary' = 'Yes'); 'OK';'Not OK')
Single quotes are supported inside a value only by prefixing them with the escape string(\) i.e. a formula
can look like this: 'unit_name' + ' Te\'st' and the result will be unit name Test
Function | Explanation | Examples |
|---|---|---|
SWAP | The function will convert a numeric field to a text field | Swap(’real_time_status’ ; ‘0:Down’ ; ’999:Off Grid’) |
| The “IF” function is a decision-making condition function between textual fields. Syntax: IF(‘a’ ; ’b’ ; ‘c’) -> if “a” is true then “b” else “c”. We support the following Boolean operations in text fields: ‘a’ = ‘a’ -> True ‘a’ != ‘a’ -> False |
|
CONTAINS | The function CONTAINS('String' ; 'Substring') returns True if 'String' contains 'Substring'. Most of the times will be sued inside an IF function, to check a specific substring in a system field. | CONTAINS('site_layout' ; 'OFFGRID') -> True/ False IF(CONTAINS('site_layout' ; 'OFFGRID') ; 'off-grid' ; 'on-grid') -> 'off-grid'/ 'on-grid' |
NUM | The function can be used to perform numeric calculations in a textual field. Most of the times will be used inside a function, to perform numeric comparisun and return a string. Note that the entire expression inside the NUM function should be inside single quotes. In addition, the entore expression inside the NUM function should follow the syntax of numeric fields, so the following boolean opearions are supported inside the function: NUM('0 == 0') ->True NUM('0 != 0') -> False | NUM('DG1FuelConsumed > 0') -> True/ False IF(NUM('DG1FuelConsumed > 0') ; 'Fuel Consumed' ; 'No Fuel Consumed') -> 'Fuel Consumed'/ 'No Fuel Consumed' |
+ | Simple concatenation function | 'Danielle Unit' + 'Test' -> 'Danielle Unit Test' |
Calculation Field Creation
The process of creating a calculated field is detailed in the following link