---

Macro Compatibility

---

Usage

Requires a ReportMagic Connection to work.

Each time a ReportMagic Schedule is run, a 'Report Batch Job' is created.

The Report Batch Job:

1. Copies files in the input folder to a temporary folder
2. Lists the files in the input folder
3. Lists the Batch Variables
4. For each combination of input file and input batch variable, produces output files

For a specified Schedule, this macro obtains a list of recently-run Report Batch Jobs.

Note that older Report Batch Jobs information is deleted, so this may not be the full list of Report Batch Jobs to have ever run.

There are a number of properties that you may need to list, but the most common will be Id and Name.

---

Parameter	Type	Deprecation Message	Preferred Parameter	Presence	Purpose	Options	Default
id	Int32	Deprecated	scheduleId		The Schedule ID. Obtain this by running a macro such as [ReportMagic.ReportScheduleProperty: name=My Schedule Name, property=Id]	N/A	N/A
reportScheduleId	Int32	Deprecated	scheduleId		The Schedule ID. Obtain this by running a macro such as [ReportMagic.ReportScheduleProperty: name=My Schedule Name, property=Id]	N/A	N/A
scheduleId	Int32	Use instead of: id reportScheduleId		Mandatory	The Schedule ID. Obtain this by running a macro such as [ReportMagic.ReportScheduleProperty: name=My Schedule Name, property=Id]	N/A	N/A
objectProperties	List<String>			Conditional	The property or properties to insert. Use either this or 'properties' but not both. You can use it like this: objectProperties=Property1;Property2;Property3, or objectProperties=Property1 as Apple;Property2 as Banana;Property3 as Cherry, to rename the actual object properties in the output. Note that since the parameter is a list of strings, the only way to know the ACTUAL properties on an object (such as used by the Batch Job List macro), is to use 'objectProperties'=all. Try this in Report Studio before using the correct names in your report templates. The ACTUAL object properties may also differ from their names when using just the 'properties' parameter, as this is often a predetermined 'enum' value.	All AllAsJObject AllAsJson CleanupDurationMs CreatedBy CreatedDateTimeUtc Description DurationMs ExecutionResult ForceNormalMode Id InputFileTransferDurationMs IsCancellationRequested JsonBatchVariable LastModifiedDateTimeUtc LegacyMacroCount MacroCount Message Name OutputFileTransferDurationMs PreparationDurationMs RenderOption ReportGenerationDurationMs ReportJobs ReportSchedule ReportScheduleId ReportScheduleType StartDateTimeUtc TriggeredBy TriggeredBySuperAdmin Version	N/A
properties	List<ReportBatchJobPropertyType>	Use instead of: property		Conditional	The property or properties to insert. Use either this or 'objectProperties' but not both.	AllAsJObject AllAsJson CleanupDurationMs CreatedBy CreatedDateTime Description ExecutionResult Id InputFileTransferDurationMs MacroCount MacroErrorCount Message Name OutputFileTransferDurationMs PreparationDurationMs ReportGenerationDurationMs ReportJobCount ReportJobIdList StartDateTimeUtc SystemErrorCount TenantName TotalErrorCount TriggeredBy	Id
property	List<ReportBatchJobPropertyType>	Deprecated	properties		The property or properties to insert. Use either this or 'objectProperties' but not both.	AllAsJObject AllAsJson CleanupDurationMs CreatedBy CreatedDateTime Description ExecutionResult Id InputFileTransferDurationMs MacroCount MacroErrorCount Message Name OutputFileTransferDurationMs PreparationDurationMs ReportGenerationDurationMs ReportJobCount ReportJobIdList StartDateTimeUtc SystemErrorCount TenantName TotalErrorCount TriggeredBy	Id
calculate	String			Optional	Post processing formula. Use {value} for the macro output, e.g. {value}/1024.	N/A	N/A
colorTableCell	Boolean			Optional	Whether to color table cells if thresholds are breached, rather than color the text.	true false	true
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
connectionName	String			Optional	The name of a valid ReportMagic Connection (i.e. a ReportMagic API Connection).	N/A	N/A
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
errorOnOverflow	Boolean			Optional	Should NCalc expression evaluation throw error on Overflow	true false	true
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
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
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
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
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
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
fontBold	Boolean			Optional	Change the font weight (true=strong, false=normal). If omitted, no change is made.	true false	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
fontSize	Double			Optional	Change the font size in points. If omitted, no change is made.	From 2 to 200	N/A
format	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
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
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
listDelimiter	Char			Optional	In Legacy Mode, the delimiter to use between each set of items in the output list. Each Batch Job results in a list item.	N/A	;
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 object, e.g. an Int32 or a List etc., rather than a formatted string.	Legacy Normal	Legacy
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
normalFontBold	Boolean			Optional	Change the normal font weight (true=strong, false=normal). If omitted, no change is made.	true false	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
normalFontSize	Double			Optional	Change the normal font size in points. If omitted, no change is made.	From 2 to 200	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
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
outputListsAsJarray Normal mode	Boolean			Optional	Any macros that output lists can optionally (in Normal mode) output a jArray instead.	true false	true
propertyDelimiter	Char			Optional	In Legacy Mode, the delimiter to use between each property in the output. Properties for individual Batch Jobs are delimited by this.	N/A	^
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
singleValueList 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.	true false	false
skip	Int32			Optional	The number of items to skip.	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
storeAsVariableDelimiter	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	;
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
take	Int32			Optional	The maximum number to take.	N/A	N/A
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
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

---

Examples (5)

Example 1: Normal mode

This Normal Mode example find the most recent Schedule, then outputs various properties for the associated Batch Jobs that ran in the last 6 months:

[ReportMagic.ReportScheduleList: properties=Id, mode=Normal, =>ScheduleIdObjects][Json.List: jArray={=ScheduleIdObjects}, jsonPath="$..[-1:].Id", =>ScheduleId]
[ReportMagic.ReportBatchJobList: scheduleId={ScheduleId}, properties=Id;Name;TotalErrorCount;CleanupDurationMs;ReportJobIdList, mode=Normal, endDate=2025-07-10, startDate=2025-01-10, storeAs=A]

---

Example 2: Normal mode

This Normal Mode example find the most recent Schedule, then outputs the IDs for the associated Batch Jobs that ran in the last 6 months, as a single flat list:

[ReportMagic.ReportScheduleList: properties=Id, mode=Normal, =>ScheduleIdObjects][Json.List: jArray={=ScheduleIdObjects}, jsonPath="$..[-1:].Id", =>ScheduleId]
[ReportMagic.ReportBatchJobList: scheduleId={ScheduleId}, mode=Normal, singleValueList=true, properties=Id, endDate=2025-07-10, startDate=2025-01-10, storeAs=B]

---

Example 3: Normal mode

This Normal Mode example find the most recent Schedule, then outputs the Id and Name properties but uses custom names ('The ID' and 'The Name') for the associated Batch Jobs that ran in the last 6 months:

[ReportMagic.ReportScheduleList: properties=Id, mode=Normal, =>ScheduleIdObjects][Json.List: jArray={=ScheduleIdObjects}, jsonPath="$..[-1:].Id", =>ScheduleId]
[ReportMagic.ReportBatchJobList: scheduleId={ScheduleId}, mode=Normal, objectProperties=Id as The Id;Name as The Name, endDate=2025-07-10, startDate=2025-01-10, storeAs=C]

---

Example 4: Normal mode

This Normal Mode example find the most recent Schedule, then outputs all the properties for the associated Batch Jobs that ran in the last 6 months:

[ReportMagic.ReportScheduleList: properties=Id, mode=Normal, =>ScheduleIdObjects]
[Json.List: jArray={=ScheduleIdObjects}, jsonPath="$..[-1:].Id", =>ScheduleId]
[ReportMagic.ReportBatchJobList: scheduleId={ScheduleId}, objectProperties=All, mode=Normal, endDate=2025-07-10, startDate=2025-01-10, storeAs=D]

---

Example 5: Normal mode

This Normal Mode only example lists all Batch Jobs and their Report Jobs for a given Schedule, outputting various properties of each. Note that older Batch Jobs and Report Jobs may have been archived from the system as we only keep a limited history (normally 90 days).

[ReportMagic.ReportScheduleList: properties=Name, mode=Normal, =>Schedules][Json.Item: jArray={=Schedules}, jsonPath="$.[0].Name", =>FirstScheduleName]
[ReportMagic.ReportScheduleProperty: name={FirstScheduleName}, property=Id, mode=Normal, =>ScheduleIdObject][.:ScheduleIdObject.Id, =>ScheduleId]
[ReportMagic.ReportBatchJobList: scheduleId={ScheduleId}, properties=AllAsJObject, startDate=2025-04-11, endDate=2025-07-09, mode=Normal, =>BatchJobObjects]
[ForEach: values={=BatchJobObjects}, storeAs=BatchJobObject][.:BatchJobObject.Id, =>BatchJobId]
Batch Job: [.:BatchJobObject.Name] executed on [.:BatchJobObject.StartDateTimeUtc]
[ReportMagic.ReportJobList: reportBatchJobId={BatchJobId}, startDate=2025-04-11, endDate=2025-07-09, mode=Normal, property=Id, =>ReportJobIdObjects]
[ForEach: values={=ReportJobIdObjects}, storeAs=ReportJobIdObject][.:ReportJobIdObject.Id,=>ReportJobId]
[ReportMagic.ReportJobProperty: id={ReportJobId}, mode=Normal, property=AllAsJObject, =>ReportJobObject]
	Report Job name: [.:ReportJobObject.Name]
	Report Job input filename: [.:ReportJobObject.InputFileName]
	Report Job macro count: [.:ReportJobObject.MacroCount]
[EndForEach:][EndForEach:]