[Calculate:]
Performs a calculation.
Purpose
This is used to calculate a result based on other macros and calculations.
Macro Compatibility
The macro can be used in all input document types and in Report Studio.
Usage
NCalc is used for expression evaluation (see https://github.com/pitermarx/NCalc-Edge/wiki for documentation). Note: Because ReportMagic uses commas to delimit parameters, either surround the condition with quotes or use backticks(`) instead of commas where needed. For example:
[Calculate:value="if(1<=2, 'AAA', 'BBB')"]Note that you can use the shorthand for this macro i.e. '[=:' instead of '[Calculate:'. The following additional functions may be used:
- capitalise(<expression>): returns the string with the first letter of the first word capitalised (see examples, below)
- contains('haystack containing needle', 'needle'): returns 'True' or 'False'
- count('string'): returns the count of characters in the string
- countBy('list', 'predicate', 'NCalc expression'): counts the number of items, grouped by a calculation.
- endsWith('haystack containing needle', 'needle'): returns 'True' or 'False'
- humanize(value, '<timeUnit>'): humanizes the expression (see examples, below)
- in('needle', 'straw', 'straw', 'straw', 'needle', 'straw', ): returns 'True' if the searched-for item is present in the list of items.
- indexOf('haystack containing needle', 'needle'): returns the integer offset of the first instance of the needle within the haystack, or -1 if not present
- isNaN(<expression>): returns 'True' or 'False' (see examples, below)
- isInfinite(<expression>): returns 'True' or 'False' (see examples, below)
- JArray(items): generates a JArray.
- JObject(items): generates a JObject. You can also include more JObjects inside to generate complex objects
- lastIndexOf('haystack containing needle', 'needle'): returns the integer offset of the last instance of the needle within the haystack, or -1 if not present
- list(items): generates a list or jArray. You can also put more lists inside to generate tables, effectively
- length('the string'): returns the integer length of the string
- startsWith('haystack containing needle', 'needle'): returns 'True' or 'False'
- round(value, decimal places): returns the rounded value, which can be stored in a variable and/or displayed. For DISPLAY purposes, you MUST use the format parameter, else the value will be output to 2 decimal places.
- timeSpan('<fromDate>', '<toDate>', '<timeUnit>'): returns the amount of time between fromDate and toDate. Time should be specified like so: '1975-02-17' or '1975-02-17 06:00'. Supported time units are: Milliseconds, Seconds, Minutes, Hours, Days, Weeks, and Years. Can be negative. (see examples, below)
- toLower(<expression>): returns the string in lower case (see examples, below)
- toUpper(<expression>): returns the string in upper case (see examples, below)
Note: The value will be stored in output variables (e.g. using storeAs, storeAsHidden or the '=>' shorthand) as the original type and at full precision. For example, if you output a DateTime, the full precision will be stored, including hours, minutes and seconds. For an integer of 12345, the integer value will be stored. However, the value output into the document must formatted as a string. The conversion from original output to string is achieved using the format parameter and the way in which this happens will depend on the type of the output. For example, the output of a DateTime written to the document might be '2023-02-17'. The integer may be formatted as '12,345'. If you would like to additionally store the formatted string to a variable, use the storeFormattedValueAs parameter.
Parameter | Type | Presence | Purpose | Options | Default |
---|---|---|---|---|---|
String | Mandatory | An expression to calculate. May use variables previously calculated and stored using storeAs / storeAsHidden. All functions supported by NCalc are supported, as well as some additional functions (see below). | N/A | N/A | |
String | Optional | Post processing formula. Use {value} for the macro output, e.g. {value}/1024. | N/A | N/A | |
Boolean | Optional | Whether to color table cells if thresholds are breached, rather than color the text. |
|
true | |
String | Optional | Add a comment to make your document template more readable. The comment is discarded in the output document. | N/A | N/A | |
DateTimeOffset | Optional | The macro is considered 'critical' if the output is after this DateTime UTC. | N/A | N/A | |
DateTimeOffset | Optional | The macro is considered 'critical' if the output is before this DateTime UTC. | N/A | N/A | |
String | Optional | The macro is considered 'critical' if the output is equal to this value. | N/A | N/A | |
Color | Optional | The critical font background color to use. If omitted, no change is made. |
|
N/A | |
Boolean | Optional | Change the font weight (true=strong, false=normal). If omitted, no change is made. |
|
N/A | |
Color | Optional | The critical font color to use. If omitted, no change is made. |
|
N/A | |
Double | Optional | Change the critical font size in points. If omitted, no change is made. |
|
N/A | |
String | Optional | The macro is considered 'critical' if the output is greater than or equal to this value. | N/A | N/A | |
String | Optional | The macro is considered 'critical' if the output is greater than this value. | N/A | N/A | |
String | Optional | The macro is considered 'critical' if the expression evaluates to true. Use 'value' as the macro output in the expression. | N/A | N/A | |
String | Optional | The macro is considered 'critical' if the output is less than or equal to this value. | N/A | N/A | |
String | Optional | The macro is considered 'critical' if the output is less than this value. | N/A | N/A | |
String | Optional | The macro is considered 'critical' if the output is not equal to this value. | N/A | N/A | |
Color | Optional | The critical table cell background color to use. |
|
N/A | |
DateTimeOffset | Optional | The macro is considered 'error' if the output is after this DateTime UTC. | N/A | N/A | |
DateTimeOffset | Optional | The macro is considered 'error' if the output is before this DateTime UTC. | N/A | N/A | |
String | Optional | The macro is considered 'error' if the output is equal to this value. | N/A | N/A | |
Color | Optional | The error font background color to use. If omitted, no change is made. |
|
N/A | |
Boolean | Optional | Change the error font weight (true=strong, false=normal). If omitted, no change is made. |
|
N/A | |
Color | Optional | The error font color to use. If omitted, no change is made. |
|
N/A | |
Double | Optional | Change the error font size in points. If omitted, no change is made. |
|
N/A | |
String | Optional | The macro is considered 'error' if the output is greater than or equal to this value. | N/A | N/A | |
String | Optional | The macro is considered 'error' if the output is greater than this value. | N/A | N/A | |
String | Optional | The macro is considered 'error' if the expression evaluates to true. Use 'value' as the macro output in the expression. | N/A | N/A | |
String | Optional | The macro is considered 'error' if the output is less than or equal to this value. | N/A | N/A | |
String | Optional | The macro is considered 'error' if the output is less than this value. | N/A | N/A | |
String | Optional | The macro is considered 'error' if the output is not equal to this value. | N/A | N/A | |
Boolean | Optional | Should NCalc expression evaluation throw error on Overflow |
|
true | |
Color | Optional | The error table cell background color to use. |
|
N/A | |
String | Optional | The text to display should the macro fail to execute. Note that a poorly-specified macro (e.g. omitting mandatory parameters) will still result in an error message. | N/A | N/A | |
DateTimeOffset | Optional | The macro is considered 'fatal' if the output is after this DateTime UTC. | N/A | N/A | |
DateTimeOffset | Optional | The macro is considered 'fatal' if the output is before this DateTime UTC. | N/A | N/A | |
String | Optional | The macro is considered 'fatal' if the output is equal to this value. | N/A | N/A | |
Color | Optional | The fatal font background color to use. If omitted, no change is made. |
|
N/A | |
Boolean | Optional | Change the fatal font weight (true=strong, false=normal). If omitted, no change is made. |
|
N/A | |
Color | Optional | The fatal font color to use. If omitted, no change is made. |
|
N/A | |
Double | Optional | Change the fatal font size in points. If omitted, no change is made. |
|
N/A | |
String | Optional | The macro is considered 'fatal' if the output is greater than or equal to this value. | N/A | N/A | |
String | Optional | The macro is considered 'fatal' if the output is greater than this value. | N/A | N/A | |
String | Optional | The macro is considered 'fatal' if the expression evaluates to true. Use 'value' as the macro output in the expression. | N/A | N/A | |
String | Optional | The macro is considered 'fatal' if the output is less than or equal to this value. | N/A | N/A | |
String | Optional | The macro is considered 'fatal' if the output is less than this value. | N/A | N/A | |
String | Optional | The macro is considered 'fatal' if the output is not equal to this value. | N/A | N/A | |
Color | Optional | The fatal table cell background color to use. |
|
N/A | |
Color | Optional | The font background color to use. |
|
N/A | |
Boolean | Optional | Change the font weight (true=strong, false=normal). If omitted, no change is made. |
|
N/A | |
Color | Optional | The font color to use. |
|
N/A | |
Double | Optional | Change the font size in points. If omitted, no change is made. |
|
N/A | |
String | Optional | The formatting to use for numbers. You can also specify 'format=string' to force numbers to be treated as strings. | N/A | N/A | |
Boolean | Optional | Whether to hide the macro output. |
|
false | |
String | Optional | The condition that must be true in order for the macro to be executed/evaluated. Must either evaluate to true or false, for example: "3+5=8" or "contains('abcd', 'z'). | N/A | true | |
DateTimeOffset | Optional | The macro is considered 'info' if the output is after this DateTime UTC. | N/A | N/A | |
DateTimeOffset | Optional | The macro is considered 'info' if the output is before this DateTime UTC. | N/A | N/A | |
String | Optional | The macro is considered 'info' if the output is equal to this value. | N/A | N/A | |
Color | Optional | The info font background color to use. If omitted, no change is made. |
|
N/A | |
Boolean | Optional | Change the info font weight (true=strong, false=normal). If omitted, no change is made. |
|
N/A | |
Color | Optional | The info font color to use. If omitted, no change is made. |
|
N/A | |
Double | Optional | Change the info font size in points. If omitted, no change is made. |
|
N/A | |
String | Optional | The macro is considered 'info' if the output is greater than or equal to this value. | N/A | N/A | |
String | Optional | The macro is considered 'info' if the output is greater than this value. | N/A | N/A | |
String | Optional | The macro is considered 'info' if the expression evaluates to true. Use 'value' as the macro output in the expression. | N/A | N/A | |
String | Optional | The macro is considered 'info' if the output is less than or equal to this value. | N/A | N/A | |
String | Optional | The macro is considered 'info' if the output is less than this value. | N/A | N/A | |
String | Optional | The macro is considered 'info' if the output is not equal to this value. | N/A | N/A | |
Color | Optional | The info table cell background color to use. |
|
N/A | |
MacroMode | Optional | The mode in which variables are stored. In the legacy mode (default for Schedules), the variable created is a string and formatted. In the normal mode (default for Report Studio), the output variable is stored as a strongly-typed object, e.g. an Int32 or a List |
|
Legacy | |
Color | Optional | The normal font background color to use. If omitted, no change is made. |
|
N/A | |
Boolean | Optional | Change the normal font weight (true=strong, false=normal). If omitted, no change is made. |
|
N/A | |
Color | Optional | The normal font color to use. If omitted, no change is made. |
|
N/A | |
Double | Optional | Change the normal font size in points. If omitted, no change is made. |
|
N/A | |
Color | Optional | The normal table cell background color to use. If omitted, no change is made. |
|
N/A | |
ObfuscationType | Optional | Obfuscation type. Use obfuscation to write reports where sensitive data is hidden. When used, ReportMagic guarantees that the same input string will map to the same output string for the whole of the report (but the next time the report runs, it will most likely map to a different value). If you use obfuscation, the property in your macro will not show up and instead, you will see a fake item of the obfuscation type chosen. |
|
None | |
Normal mode |
Boolean | Optional | Any macros that output lists can optionally (in Normal mode) output a jArray instead. |
|
true |
Boolean | Optional | Whether substituted variables are hidden from macro results (and the word 'REDACTED' will appear in progress screens and elsewhere in the web UI). |
|
false | |
Normal mode |
Boolean | Optional | In Normal Mode and for macros that output JArrays only, whether to convert a JArray of single-property jObjects into a flat JArray of values. |
|
false |
String | Optional | The variable to store the result as. | N/A | N/A | |
String | Optional | The variable to store the result as, while hiding the output. Equivalent to 'storeAs=ThisValue, hidden=true'. | N/A | N/A | |
Char | Optional | The delimiter used by storeAs to split the input (Legacy mode only), when there are multiple stored variables. For example, in this macro, we indicate that the value to be stored should be split by the asterisk when being stored: [String:value=a*b*c*d, storeAs=var1;var2;var3;var4, storeAsVariableDelimiter=*] | N/A | ; | |
String | Optional | The name of the STRING variable to store the result as and output (both will use the same format) into the report. Note that if you also use 'storeAsHidden' in the same macro, you should not expect the output to be hidden, as this parameter overrides that. | N/A | N/A | |
String | Optional | If specified, adds a warning message for this macro. This is processed as an NCalc, and the warning message will ALWAYS be present and will be the value of the evaluated NCalc expression. | N/A | N/A | |
DateTimeOffset | Optional | The macro is considered 'warning' if the output is after this DateTime UTC. | N/A | N/A | |
DateTimeOffset | Optional | The macro is considered 'warning' if the output is before this DateTime UTC. | N/A | N/A | |
String | Optional | The macro is considered 'warning' if the output is equal to this value. | N/A | N/A | |
Color | Optional | The warning font background color to use. If omitted, no change is made. |
|
N/A | |
Boolean | Optional | Change the warning font weight (true=strong, false=normal). If omitted, no change is made. |
|
N/A | |
Color | Optional | The warning font color to use. If omitted, no change is made. |
|
N/A | |
Double | Optional | Change the warning font size in points. If omitted, no change is made. |
|
N/A | |
String | Optional | The macro is considered 'warning' if the output is greater than or equal to this value. | N/A | N/A | |
String | Optional | The macro is considered 'warning' if the output is greater than this value. | N/A | N/A | |
String | Optional | The macro is considered 'warning' if the expression evaluates to true. Use 'value' as the macro output in the expression. | N/A | N/A | |
String | Optional | The macro is considered 'warning' if the output is less than or equal to this value. | N/A | N/A | |
String | Optional | The macro is considered 'warning' if the output is less than this value. | N/A | N/A | |
String | Optional | The macro is considered 'warning' if the output is not equal to this value. | N/A | N/A | |
Color | Optional | The warning table cell background color to use. |
|
N/A |
Examples (44)
Example 1:
[Calculate: value=1, storeAs=a]
Outputs:
1Example 2:
[Calculate: value=2, storeAs=b][Calculate: value=3, storeAs=c]
Outputs:
23Example 3:
[Calculate: value=3+5, storeAs=c]
Outputs:
8Example 4:
[Calculate: value=1, storeAsHidden=a] [Calculate: value=2, storeAsHidden=b] [Calculate: value=3, storeAsHidden=c] [Calculate: value=({a}+{b})/{c}, errorGe=0.01, format=N2]
Example 5:
[Calculate: value=1, storeAsHidden=a] [Calculate: value=2, storeAsHidden=b] [Calculate: value=3, storeAsHidden=c] [Calculate: value="if({a}={b},1,2)", errorGe=0.01, format=N2]
Example 6:
[Calculate: value=1, storeAsHidden=a] [Calculate: value=2, storeAsHidden=b] [Calculate: value=3, storeAsHidden=c] [Calculate: value="if({b}>{a},'OK','Not OK')"]
Example 7:
[Calculate: value=5+3, storeAsHidden=Result] [Calculate: value={Result}, warningGe=2, warningFontColor=Orange, warningFontBackgroundColor=#ddd, warningFontBold=True, warningFontSize=20, errorGe=4, errorFontColor=Blue, errorFontBackgroundColor=Yellow, errorFontBold=True, errorFontSize=50]
Example 8:
[Calculate: value="contains('haystack containing needle', 'needle')"]
Outputs:
TrueExample 9:
[Calculate: value="startsWith('haystack containing needle', 'needle')"]
Outputs:
FalseExample 10:
[Calculate: value="endsWith('haystack containing needle', 'needle')"]
Outputs:
TrueExample 11:
[Calculate: value="indexOf('haystack containing a needle and another needle', 'needle')"]
Outputs:
22Example 12:
[Calculate: value="lastIndexOf('haystack containing a needle and another needle', 'needle')"]
Outputs:
41Example 13:
[Calculate: value="lastIndexOf('haystack containing no sharp pointy things', 'needle')"]
Outputs:
-1Example 14:
[Calculate: value="length('haystack containing needle')"]
Outputs:
26Example 15:
[Calculate: value="in(1, 1, 2, 3)"]
Outputs:
TrueExample 16:
[Calculate: value="in(99, 1, 2, 3)"]
Outputs:
FalseExample 17:
[Calculate: value="isNaN(1/2)"]
Outputs:
FalseExample 18:
[Calculate: value="isNaN(1/0)"]
Outputs:
FalseExample 19:
[Calculate: value="isInfinite(1/2)"]
Outputs:
FalseExample 20:
[Calculate: value="isInfinite(1/0)"]
Outputs:
TrueExample 21:
[Calculate: value="isInfinite(-1/0)"]
Outputs:
TrueExample 22:
[Calculate: value="if(in(1, 1, 2, 3), 'Passed', 'Failed')"]
Outputs:
PassedExample 23:
[Calculate: value="timeSpan('1975-02-17', '2017-02-17', 'Days')"]
Outputs:
15341Example 24:
[Calculate: value="timeSpan('1975-02-17 16:00', '2017-02-17 17:00', 'Hours')"]
Outputs:
368185Example 25:
[Calculate: value="toUpper('aBc def')"]
Outputs:
ABC DEFExample 26:
[Calculate: value="toLower('aBc def')"]
Outputs:
abc defExample 27:
[Calculate: value="capitalise('aBc def')"]
Outputs:
Abc defExample 28:
[Calculate: value="if(2.368475785867E-16 < 0`'-ve'`if(2.368475785867E-16 < 0.01`'<0.01'`2.368475785867E-16))"]
Outputs:
<0.01Example 29:
[Calculate: value="Round(12.34, 0)", format=F0]
Outputs:
12Example 30:
[Calculate: value="Round(12.34, 1)", format=F1]
Outputs:
12.3Example 31:
Calculate and store the value 12.34 into a variable (at 1 decimal place precision), and DISPLAY at 1 decimal place too by using the 'format' parameter:
[Calculate: value="Round(12.34, 1)", format=F1, storeAs=Output]
Outputs:
12.3Example 32:
Calculate and store the value 12.34 into a variable (at 1 decimal place precision), but DISPLAY at 1 decimal place (by omitting the 'format' parameter):
[Calculate: value="Round(12.34, 1)", storeAs=Output]
Outputs:
12.30Example 33:
[Calculate: value="humanize(0.25, 'days')"]
Outputs:
6 hoursExample 34:
[Calculate: value="humanize(24, 'hours')"]
Outputs:
1 dayExample 35:
Stores what you can see in ReportStudio (to 2 decimal places) as the variable B and stores the hidden output (to 0 decimal places) in A.
[Calculate: value="Round(12.34, 0)", storeAs=A, storeFormattedValueAs=B]<br/>A is '[String: value={A}]' and B is '[String: value ={B}]'
Outputs:
12:00A is '12' and B is '12.00'
Example 36:
You can create JObjects directly and access the values using the [.:] shorthand. Note this example uses the Calculate macro shorthand i.e. starts with '[=:' instead of '[Calculate:]' :
[=:`jObject('v', null, 'w', 'Some text', 'y', jObject('z', 1))`, =>x][.:x.y.z]
Outputs:
1Example 37:
This example creates a jArray:
[=:`list(1, 2, 3, 4, 5)`, =>MyList]
Example 38:
This example creates a jArray:
[=:`jArray(jObject('a', 1, 'b', null), jObject('a', 2, 'b', #2024-06-21#))`, =>jArray]
Outputs:
[ { "a" : 1, "b" : null }, { "a" : 2, "b" : "2024-06-21T00:00:00" } ]Example 39:
This example creates a string URL and uses the Calculate macro shorthand i.e. starts with '[=:' instead of '[Calculate:]' :
[=:'https://en.wikipedia.org/wiki/Alphabet', =>CustomerUrl1]
Outputs:
https://en.wikipedia.org/wiki/AlphabetExample 40:
This example creates a string URL and uses the Calculate macro shorthand i.e. starts with '[=:' instead of '[Calculate:]' :
[=:'http://www.google.com/', =>CustomerUrl2]
Outputs:
http://www.google.com/Example 41:
Counts the number of characters in a string
[Calculate: value="count('Report Magic')"]
Outputs:
12Example 42:
Counts the number of characters in a string
[Calculate: value="count('ReportMagic')"]
Outputs:
11Example 43:
Counts by how many of each number there are in a list, i.e. grouped by the values themselves, and stores the results as a new JObject (dictionary) variable:
[Calculate: value="countBy(list(1, 1, 1, 1, 1, 2, 2, 3, 3, 3, 4), 'n', 'toString(n)')", =>Count]
Outputs:
{ "1" : 5, "2" : 2, "3" : 3, "4" : 1 }Example 44: Normal mode
This Normal Mode example counts 'Tickets' grouped by their name and stores the result as a new jObject (dictionary) variable:
// First create a list of JObjects: [Calculate: value="list( jObject('name', 'A', 'description', 'yaaay'), jObject('name', 'B', 'description', 'houpla'), jObject('name', 'C', 'description', 'woowoo'), jObject('name', 'C', 'description', 'yay'), jObject('name', 'B', 'description', 'woo'), jObject('name', 'B', 'description', 'blah') )", mode=Normal, =>Tickets] // Now calculate how many there are for each of the name properties, i.e how many are called 'A', 'B', and so on: [Calculate: value="countBy(Tickets, 'n', 'getProperty(n, \'name\')')", mode=Normal, =>Output]
Outputs:
{ "A" : 1, "B" : 3, "C": 2 }