ReportMagic

[CronHumanReadable:]

Converts a CRON expression to human-readable text.

Compatibility

The macro can be used in all input document types and in Report Studio.

Parameters (106)

Grouped View

Mandatory (1)

Parameter	Type	Purpose	Options	Default
value	String	The string value.	N/A	N/A

Behaviour (2)9 additional

Parameter	Type	Presence	Purpose	Options	Default
errorOnInvalidCron	Boolean	Optional	Whether to generate a macro parameter error when the CRON is invalid. When set to false (and the specified CRON cannot be parsed), the error text will be output in the document and there will be no macro error.	true false	true
verbose	Boolean	Optional	Whether to use verbose output, e.g. 'At 12:00 every day' (verbose) instead of 'At 12:00' (non-verbose).	true false	true

Additional (9)

Parameter	Type	Presence	Purpose	Options	Default
calculate	String	Optional	Post processing formula. Use {value} for the macro output, e.g. {value}/1024.	N/A	N/A
errorOnOverflow	Boolean	Optional	Should NCalc expression evaluation throw error on Overflow	true false	true
fatalIf	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
hidden	Boolean	Optional	Whether to hide the macro output.	true false	false
if	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
mode	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 theObject, e.g. an Int32 or a List etc., rather than a formatted string.	Legacy Normal	Legacy
obfuscation	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 UkTown DeviceName Company IpAddress PrivateIpAddress	None
redact	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).	true false	false
warning	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

Colours (6)

Parameter	Type	Presence	Purpose	Options	Default
colorTableCell	Boolean	Optional	Whether to color table cells if thresholds are breached, rather than color the text.	true false	true
fontBackgroundColor	Color	Optional	The font background color to use.	A named color or an HTML-encoded color .Note that 'transparent' is a valid color that you can use in any macro parameter that expects a color.	N/A
fontColor	Color	Optional	The font color to use.	A named color or an HTML-encoded color .Note that 'transparent' is a valid color that you can use in any macro parameter that expects a color.	N/A
normalFontBackgroundColor	Color	Optional	The normal font background color to use. If omitted, no change is made.	A named color or an HTML-encoded color .Note that 'transparent' is a valid color that you can use in any macro parameter that expects a color.	N/A
normalFontColor	Color	Optional	The normal font color to use. If omitted, no change is made.	A named color or an HTML-encoded color .Note that 'transparent' is a valid color that you can use in any macro parameter that expects a color.	N/A
normalTableCellBackgroundColor	Color	Optional	The normal table cell background color to use. If omitted, no change is made.	A named color or an HTML-encoded color .Note that 'transparent' is a valid color that you can use in any macro parameter that expects a color.	N/A

Formatting (4)

Parameter	Type	Presence	Purpose	Options	Default
fontBold	Boolean	Optional	Change the font weight (true=strong, false=normal). If omitted, no change is made.	true false	N/A
fontSize	Double	Optional	Change the font size in points. If omitted, no change is made.	From 2 to 200	N/A
normalFontBold	Boolean	Optional	Change the normal font weight (true=strong, false=normal). If omitted, no change is made.	true false	N/A
normalFontSize	Double	Optional	Change the normal font size in points. If omitted, no change is made.	From 2 to 200	N/A

Conditional Formatting (69)

Parameter	Type	Presence	Purpose	Options	Default
criticalAfter	DateTimeOffset	Optional	The macro is considered 'critical' if the output is after this DateTime UTC.	N/A	N/A
criticalBefore	DateTimeOffset	Optional	The macro is considered 'critical' if the output is before this DateTime UTC.	N/A	N/A
criticalEq	String	Optional	The macro is considered 'critical' if the output is equal to this value.	N/A	N/A
criticalFontBackgroundColor	Color	Optional	The critical font background color to use. If omitted, no change is made.	A named color or an HTML-encoded color .Note that 'transparent' is a valid color that you can use in any macro parameter that expects a color.	N/A
criticalFontBold	Boolean	Optional	Change the font weight (true=strong, false=normal). If omitted, no change is made.	true false	N/A
criticalFontColor	Color	Optional	The critical font color to use. If omitted, no change is made.	A named color or an HTML-encoded color .Note that 'transparent' is a valid color that you can use in any macro parameter that expects a color.	N/A
criticalFontSize	Double	Optional	Change the critical font size in points. If omitted, no change is made.	From 2 to 200	N/A
criticalGe	String	Optional	The macro is considered 'critical' if the output is greater than or equal to this value.	N/A	N/A
criticalGt	String	Optional	The macro is considered 'critical' if the output is greater than this value.	N/A	N/A
criticalIf	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
criticalLe	String	Optional	The macro is considered 'critical' if the output is less than or equal to this value.	N/A	N/A
criticalLt	String	Optional	The macro is considered 'critical' if the output is less than this value.	N/A	N/A
criticalNe	String	Optional	The macro is considered 'critical' if the output is not equal to this value.	N/A	N/A
criticalTableCellBackgroundColor	Color	Optional	The critical table cell background color to use.	A named color or an HTML-encoded color .Note that 'transparent' is a valid color that you can use in any macro parameter that expects a color.	N/A
errorAfter	DateTimeOffset	Optional	The macro is considered 'error' if the output is after this DateTime UTC.	N/A	N/A
errorBefore	DateTimeOffset	Optional	The macro is considered 'error' if the output is before this DateTime UTC.	N/A	N/A
errorEq	String	Optional	The macro is considered 'error' if the output is equal to this value.	N/A	N/A
errorFontBackgroundColor	Color	Optional	The error font background color to use. If omitted, no change is made.	A named color or an HTML-encoded color .Note that 'transparent' is a valid color that you can use in any macro parameter that expects a color.	N/A
errorFontBold	Boolean	Optional	Change the error font weight (true=strong, false=normal). If omitted, no change is made.	true false	N/A
errorFontColor	Color	Optional	The error font color to use. If omitted, no change is made.	A named color or an HTML-encoded color .Note that 'transparent' is a valid color that you can use in any macro parameter that expects a color.	N/A
errorFontSize	Double	Optional	Change the error font size in points. If omitted, no change is made.	From 2 to 200	N/A
errorGe	String	Optional	The macro is considered 'error' if the output is greater than or equal to this value.	N/A	N/A
errorGt	String	Optional	The macro is considered 'error' if the output is greater than this value.	N/A	N/A
errorIf	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
errorLe	String	Optional	The macro is considered 'error' if the output is less than or equal to this value.	N/A	N/A
errorLt	String	Optional	The macro is considered 'error' if the output is less than this value.	N/A	N/A
errorNe	String	Optional	The macro is considered 'error' if the output is not equal to this value.	N/A	N/A
errorTableCellBackgroundColor	Color	Optional	The error table cell background color to use.	A named color or an HTML-encoded color .Note that 'transparent' is a valid color that you can use in any macro parameter that expects a color.	N/A
fatalAfter	DateTimeOffset	Optional	The macro is considered 'fatal' if the output is after this DateTime UTC.	N/A	N/A
fatalBefore	DateTimeOffset	Optional	The macro is considered 'fatal' if the output is before this DateTime UTC.	N/A	N/A
fatalEq	String	Optional	The macro is considered 'fatal' if the output is equal to this value.	N/A	N/A
fatalFontBackgroundColor	Color	Optional	The fatal font background color to use. If omitted, no change is made.	A named color or an HTML-encoded color .Note that 'transparent' is a valid color that you can use in any macro parameter that expects a color.	N/A
fatalFontBold	Boolean	Optional	Change the fatal font weight (true=strong, false=normal). If omitted, no change is made.	true false	N/A
fatalFontColor	Color	Optional	The fatal font color to use. If omitted, no change is made.	A named color or an HTML-encoded color .Note that 'transparent' is a valid color that you can use in any macro parameter that expects a color.	N/A
fatalFontSize	Double	Optional	Change the fatal font size in points. If omitted, no change is made.	From 2 to 200	N/A
fatalGe	String	Optional	The macro is considered 'fatal' if the output is greater than or equal to this value.	N/A	N/A
fatalGt	String	Optional	The macro is considered 'fatal' if the output is greater than this value.	N/A	N/A
fatalLe	String	Optional	The macro is considered 'fatal' if the output is less than or equal to this value.	N/A	N/A
fatalLt	String	Optional	The macro is considered 'fatal' if the output is less than this value.	N/A	N/A
fatalNe	String	Optional	The macro is considered 'fatal' if the output is not equal to this value.	N/A	N/A
fatalTableCellBackgroundColor	Color	Optional	The fatal table cell background color to use.	A named color or an HTML-encoded color .Note that 'transparent' is a valid color that you can use in any macro parameter that expects a color.	N/A
infoAfter	DateTimeOffset	Optional	The macro is considered 'info' if the output is after this DateTime UTC.	N/A	N/A
infoBefore	DateTimeOffset	Optional	The macro is considered 'info' if the output is before this DateTime UTC.	N/A	N/A
infoEq	String	Optional	The macro is considered 'info' if the output is equal to this value.	N/A	N/A
infoFontBackgroundColor	Color	Optional	The info font background color to use. If omitted, no change is made.	A named color or an HTML-encoded color .Note that 'transparent' is a valid color that you can use in any macro parameter that expects a color.	N/A
infoFontBold	Boolean	Optional	Change the info font weight (true=strong, false=normal). If omitted, no change is made.	true false	N/A
infoFontColor	Color	Optional	The info font color to use. If omitted, no change is made.	A named color or an HTML-encoded color .Note that 'transparent' is a valid color that you can use in any macro parameter that expects a color.	N/A
infoFontSize	Double	Optional	Change the info font size in points. If omitted, no change is made.	From 2 to 200	N/A
infoGe	String	Optional	The macro is considered 'info' if the output is greater than or equal to this value.	N/A	N/A
infoGt	String	Optional	The macro is considered 'info' if the output is greater than this value.	N/A	N/A
infoIf	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
infoLe	String	Optional	The macro is considered 'info' if the output is less than or equal to this value.	N/A	N/A
infoLt	String	Optional	The macro is considered 'info' if the output is less than this value.	N/A	N/A
infoNe	String	Optional	The macro is considered 'info' if the output is not equal to this value.	N/A	N/A
infoTableCellBackgroundColor	Color	Optional	The info table cell background color to use.	A named color or an HTML-encoded color .Note that 'transparent' is a valid color that you can use in any macro parameter that expects a color.	N/A
warningAfter	DateTimeOffset	Optional	The macro is considered 'warning' if the output is after this DateTime UTC.	N/A	N/A
warningBefore	DateTimeOffset	Optional	The macro is considered 'warning' if the output is before this DateTime UTC.	N/A	N/A
warningEq	String	Optional	The macro is considered 'warning' if the output is equal to this value.	N/A	N/A
warningFontBackgroundColor	Color	Optional	The warning font background color to use. If omitted, no change is made.	A named color or an HTML-encoded color .Note that 'transparent' is a valid color that you can use in any macro parameter that expects a color.	N/A
warningFontBold	Boolean	Optional	Change the warning font weight (true=strong, false=normal). If omitted, no change is made.	true false	N/A
warningFontColor	Color	Optional	The warning font color to use. If omitted, no change is made.	A named color or an HTML-encoded color .Note that 'transparent' is a valid color that you can use in any macro parameter that expects a color.	N/A
warningFontSize	Double	Optional	Change the warning font size in points. If omitted, no change is made.	From 2 to 200	N/A
warningGe	String	Optional	The macro is considered 'warning' if the output is greater than or equal to this value.	N/A	N/A
warningGt	String	Optional	The macro is considered 'warning' if the output is greater than this value.	N/A	N/A
warningIf	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
warningLe	String	Optional	The macro is considered 'warning' if the output is less than or equal to this value.	N/A	N/A
warningLt	String	Optional	The macro is considered 'warning' if the output is less than this value.	N/A	N/A
warningNe	String	Optional	The macro is considered 'warning' if the output is not equal to this value.	N/A	N/A
warningTableCellBackgroundColor	Color	Optional	The warning table cell background color to use.	A named color or an HTML-encoded color .Note that 'transparent' is a valid color that you can use in any macro parameter that expects a color.	N/A

Time & Date (1)

Parameter	Type	Presence	Purpose	Options	Default
use24HourTimeFormat	Boolean	Optional	Whether to use 24-hour time format, e.g. '00:00' instead of '12:00 AM'.	true false	true

Filtering & Sorting (4)

Parameter	Type	Presence	Purpose	Options	Default
find	List<String>	Optional	The string value(s) to find in the value.	N/A	N/A
regexFind	List<String>	Optional	The Regex pattern(s) to find in the value.	N/A	N/A
regexReplaceWith	List<String>	Optional	The Regex string value(s) to use to replace the string specified in the regexFind parameter. Ignored if the regexFind parameter is not specified. Mandatory if the regexFind parameter is specified and the number of replacements must match the number of regexFinds.	N/A	N/A
replaceWith	List<String>	Optional	The string value(s) to use to replace the string specified in the find parameter. Ignored if the find parameter is not specified. Mandatory if the find parameter is specified and the number of replacements must match the number of finds.	N/A	N/A

Output (1)5 additional

Parameter	Type	Presence	Purpose	Options	Default
delimiter	Char	Optional	When using selectDistinct or find/replaceWith or regexFind/regexReplaceWith, this specifies the delimiter character.	N/A	;

Additional (5)

Parameter	Type	Presence	Purpose	Options	Default
failureText	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
failureVariable	String	Optional	The name of a variable to create should the macro fail to execute. The variable will be a text variable, and will contain either the failure text (only if the failureText parameter is set), otherwise it will contain the exception / failure message.	N/A	N/A
storeAs	String	Optional	The variable to store the result as.	N/A	N/A
storeAsHidden	String	Optional	The variable to store the result as, while hiding the output. Equivalent to 'storeAs=ThisValue, hidden=true'.	N/A	N/A
storeFormattedValueAs	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

General (1)4 additional

Parameter	Type	Presence	Purpose	Options	Default
value	String	Mandatory	The string value.	N/A	N/A

Additional (4)

Parameter	Type	Presence	Purpose	Options	Default
comment	String	Optional	Add a comment to make your document template more readable. The comment is discarded in the output document.	N/A	N/A
desiredExecutionResult	ExecutionResult	Optional	If specified, asserts the expected execution result of the macro. The macro executes normally; if the actual result matches the desired value, the result is converted to Success. If the actual result does not match, the result is converted to MacroError with a descriptive message. This is primarily used for testing and diagnostic purposes. Valid values are: Unknown, Success, MacroError, WorkerStopped, Running, Warning, NeverRun, Cancelled, Pending, Paused, SystemError, Deferred, Stopped.	Cancelled Deferred MacroError NeverRun Paused Pending Running Stopped Success SystemError Warning WorkerStopped	N/A
expectedType	String	Optional	If specified, asserts the expected output type of the macro result. The macro executes normally; if the actual type does not match, a macro error is generated. Requires 'storeAs', 'storeAsHidden', or 'storeFormattedValueAs' to be set for typed validation. Valid types include CLR names (e.g. Int32, Int64, Single, Double, Boolean, String, JArray, JObject) and C# keyword aliases (e.g. int, long, float, double, bool, string, uint, ulong, short, ushort, byte, sbyte, decimal, char, object). The special value 'Number' matches any numeric type.	N/A	N/A
expectedValue	String	Optional	If specified, asserts the expected output value of the macro result. The macro executes normally; if the actual value does not match, a macro error is generated. When 'storeAs' or 'storeAsHidden' is set, the stored variable value is compared. Otherwise, the document output text is compared.	N/A	N/A

Examples (18)

Example 1

[CronHumanReadable: value="0 0 * * *", storeAs=A]

Outputs: At 00:00, every day

Example 2

[CronHumanReadable: value="0 0 * * *", verbose=false, storeAs=B]

Outputs: At 00:00

Example 3

[CronHumanReadable: value="0 0 * * *", use24HourTimeFormat=false, verbose=false, storeAs=C]

Outputs: At 12:00 AM

Example 4

[CronHumanReadable: value="0 0 * * *", use24HourTimeFormat=false, storeAs=D]

Outputs: At 12:00 AM, every day

Example 5

[CronHumanReadable: value="0 0 * * 1", storeAs=E]

Outputs: At 00:00, only on Monday

Example 6

[CronHumanReadable: value="0 0 * * 1,2,3,4,5", storeAs=F]

Outputs: At 00:00, only on Monday, Tuesday, Wednesday, Thursday, and Friday

Example 7

[CronHumanReadable: value="0 0 * * 1-5", storeAs=G]

Outputs: At 00:00, Monday through Friday

Example 8

[CronHumanReadable: value="0 13 * * 6-7", storeAs=H]

Outputs: At 13:00, Saturday through Sunday

Example 9

[CronHumanReadable: value="1 15 1 1 *", storeAs=J]

Outputs: At 15:01, on day 1 of the month, only in January

Example 10

This example has an invalid CRON, and normally causes a macro error (with the reason), but in this case we use 'errorOnInvalidCron=false', and so the macro succeeds and outputs the error message into the document and the variable 'K':

[CronHumanReadable: value="xxx", storeAs=K, errorOnInvalidCron=false]

Outputs: Error: Expression only has 1 parts. At least 5 part are required.

Example 11

This example uses the 'find' and 'replaceWith' parameters to change the input CRON's meaning FROM midnight only on a Monday, TO midnight only on a Friday:

[CronHumanReadable: value="0 0 * * 1", find=1, replaceWith=5, storeAs=L]

Outputs: At 00:00, only on Friday

Example 12

This example uses the 'find' and 'replaceWith' parameters to change the input CRON's meaning FROM midnight only on Monday through Friday, TO midnight only on Monday through Wednesday and Saturday through Sunday. It also uses the 'delimiter' to indicate the separator character which delimits each item specified by the 'find' and 'replaceWith' parameters (i.e. multiple items separated by a % sign). Omit this parameter to use the default semi-colon:

[CronHumanReadable: value="0 0 * * 1,2,3,4,5", find=4%5, replaceWith=6%7, delimiter=%, storeAs=M]

Outputs: At 00:00, only on Monday, Tuesday, Wednesday, Saturday, and Sunday

Example 13

This example uses the 'find' and 'replaceWith' parameters to change the input CRON's meaning FROM midday only on a Monday, Tuesday, and Sunday TO 2pm only on a Monday, Tuesday, and Sunday:

[CronHumanReadable: value="0 0 12 ? * MON,TUE,SUN *", find=12, replaceWith=14, storeAs=N]

Outputs: At 14:00, only on Monday, Tuesday, and Sunday

Example 14

This example uses the 'find' and 'replaceWith' parameters to change the input CRON's meaning FROM 3am only on Monday through Friday, TO 3am only on Monday through Sunday:

[CronHumanReadable: value="0 0 3 ? * MON-FRI *", find=FRI, replaceWith=SUN, storeAs=O]

Outputs: At 03:00, Monday through Sunday

Example 15

This example uses the 'find' and 'replaceWith' parameters to change the input CRON's meaning FROM midday only on a Monday, Tuesday and Sunday, TO midday only on Friday through Sunday. It also uses the 'delimiter' parameter to indicate the separator character which delimits each item specified by the 'find' and 'replaceWith' parameters (i.e. multiple items separated by a % sign). Omit this parameter to use the default semi-colon:

[CronHumanReadable: value="0 0 12 ? * MON,TUE,SUN *", find=MON%TUE, replaceWith=FRI%SAT, delimiter=%, storeAs=P]

Outputs: At 12:00, only on Friday, Saturday, and Sunday

Example 16

This example uses the 'regexFind' and 'regexReplaceWith' parameters to change the input CRON's meaning FROM midnight only on a Monday, TO midnight only on a Tuesday. Note the use of back-ticks in the '{Parameters.RegexFind}' parameter which is used to ensure that square brackets in the regex expression do not affect macro parsing:

[CronHumanReadable: value="0 0 * * 1", regexFind=`([1])`, regexReplaceWith=2, storeAs=Q]

Outputs: At 00:00, only on Tuesday

Example 17

This example uses the 'regexFind' and 'regexReplaceWith' parameters to change the input CRON's meaning FROM midnight only on Monday through Friday, TO midnight only on Monday through Wednesday and Saturday through Sunday. It also uses the 'delimiter' parameter to indicate the separator character which delimits each item specified by the 'find' and 'replaceWith' parameters (i.e. multiple items separated by a % sign). Omit this parameter to use the default semi-colon. Note the use of back-ticks in the 'regexFind' parameter which is used to ensure that square brackets in the regex expression do not affect macro parsing:

[CronHumanReadable: value="0 0 * * 1,2,3,4,5", regexFind=`([4])%([5])`, regexReplaceWith=6%7, delimiter=%, storeAs=R]