Inserts a list of Report Batch Job properties.
Compatibility
The macro can be used in all input document types and in Report Studio.
Usage
Requires a Magic Suite Connection to work.
Each time a ReportMagic Schedule is run, a 'Report Batch Job' is created.
The Report Batch Job:
- Copies files in the input folder to a temporary folder
- Lists the files in the input folder
- Lists the Batch Variables
- 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.
.Behaviour (9)
| Parameter | Type | Presence | Purpose | Options | Default |
| String | Optional | Post processing formula. Use {value} for the macro output, e.g. {value}/1024. | N/A | N/A | |
| Boolean | Optional | Should NCalc expression evaluation throw error on Overflow |
|
true | |
| 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 | |
| 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 | |
| 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 |
|
Legacy | |
| 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 | |
| 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 | |
| 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 |
| Boolean | Optional | Whether to color table cells if thresholds are breached, rather than color the text. |
|
true | |
| Color | Optional | The font background color to use. |
|
N/A | |
| Color | Optional | The font color to use. |
|
N/A | |
| Color | Optional | The normal font background color to use. If omitted, no change is made. |
|
N/A | |
| Color | Optional | The normal font color to use. 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 |
Formatting (5)
| Parameter | Type | Presence | Purpose | Options | Default |
| Boolean | Optional | Change the font weight (true=strong, false=normal). If omitted, no change is made. |
|
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 | Change the normal font weight (true=strong, false=normal). 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 |
Conditional Formatting (69)
| Parameter | Type | Presence | Purpose | Options | Default |
| 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 | |
| Color | Optional | The error table cell background color to use. |
|
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 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 | |
| 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 | |
| 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 |
Output (2)7 additional
| Parameter | Type | Presence | Purpose | Options | Default |
| 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 | ; | |
| 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 | ^ |
Additional (7)
| Parameter | Type | Presence | Purpose | Options | Default |
| 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 | |
| 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 | |
Normal mode |
Boolean | Optional | Any macros that output lists can optionally (in Normal mode) output a jArray instead. |
|
true |
| 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 |
General (2)6 additional
| Parameter | Type | Presence | Purpose | Options | Default |
| 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. |
|
N/A | |
| List<ReportBatchJobPropertyType> | Conditional | The property or properties to insert. Use either this or 'objectProperties' but not both. |
|
Id |
Additional (6)
| Parameter | Type | Presence | Purpose | Options | Default |
| String | Optional | Add a comment to make your document template more readable. The comment is discarded in the output document. | N/A | N/A | |
| String | Optional | The name of a valid Magic Suite Connection (i.e. a Magic Suite API Connection). | N/A | N/A | |
| 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. |
|
N/A | |
| 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 | |
| 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 | |
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 |
Deprecated (3)
| Parameter | Type | Preferred Parameter | Purpose | Options | Default |
| Int32 | scheduleId | The Schedule ID. Obtain this by running a macro such as [MagicSuite.ReportScheduleProperty: name=My Schedule Name, property=Id] | N/A | N/A | |
| Int32 | scheduleId | The Schedule ID. Obtain this by running a macro such as [MagicSuite.ReportScheduleProperty: name=My Schedule Name, property=Id] | N/A | N/A | |
| List<ReportBatchJobPropertyType> | properties | The property or properties to insert. Use either this or 'objectProperties' but not both. |
|
Id |
Examples (5)
Example 1Normal 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:
[MagicSuite.ReportScheduleList: properties=Id, mode=Normal, =>ScheduleIdObjects][Json.List: jArray={=ScheduleIdObjects}, jsonPath="$..[-1:].Id", =>ScheduleId]
[MagicSuite.ReportBatchJobList: scheduleId={ScheduleId}, properties=Id;Name;TotalErrorCount;CleanupDurationMs;ReportJobIdList, mode=Normal, endDate=2026-06-15, startDate=2025-12-15, storeAs=A]Example 2Normal 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:
[MagicSuite.ReportScheduleList: properties=Id, mode=Normal, =>ScheduleIdObjects][Json.List: jArray={=ScheduleIdObjects}, jsonPath="$..[-1:].Id", =>ScheduleId]
[MagicSuite.ReportBatchJobList: scheduleId={ScheduleId}, mode=Normal, singleValueList=true, properties=Id, endDate=2026-06-15, startDate=2025-12-15, storeAs=B]Example 3Normal 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:
[MagicSuite.ReportScheduleList: properties=Id, mode=Normal, =>ScheduleIdObjects][Json.List: jArray={=ScheduleIdObjects}, jsonPath="$..[-1:].Id", =>ScheduleId]
[MagicSuite.ReportBatchJobList: scheduleId={ScheduleId}, mode=Normal, objectProperties=Id as The Id;Name as The Name, endDate=2026-06-15, startDate=2025-12-15, storeAs=C]Example 4Normal 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:
[MagicSuite.ReportScheduleList: properties=Id, mode=Normal, =>ScheduleIdObjects]
[Json.List: jArray={=ScheduleIdObjects}, jsonPath="$..[-1:].Id", =>ScheduleId]
[MagicSuite.ReportBatchJobList: scheduleId={ScheduleId}, objectProperties=All, mode=Normal, endDate=2026-06-15, startDate=2025-12-15, storeAs=D]Example 5Normal 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).
[MagicSuite.ReportScheduleList: properties=Id, take=1, =>Schedules][Json.Item: jArray=`{=Schedules}`, jsonPath="$[0].Id", =>ScheduleId]
[MagicSuite.ReportBatchJobList: scheduleId={ScheduleId}, properties=Id;Name;StartDateTimeUtc, =>BatchJobObjects]
[ForEach: values={=BatchJobObjects}, storeAs=BatchJobObject][.:BatchJobObject.Id, =>BatchJobId]
Batch Job: [.:BatchJobObject.Name] executed on [.:BatchJobObject.StartDateTimeUtc]
[MagicSuite.ReportJobList: reportBatchJobId={BatchJobId}, startDate=2026-03-17, endDate=2026-06-14, mode=Normal, properties=Id, =>ReportJobIdObjects]
[ForEach: values={=ReportJobIdObjects}, storeAs=ReportJobIdObject][.:ReportJobIdObject.Id, =>ReportJobId]
[MagicSuite.ReportJobProperty: id={ReportJobId}, mode=Normal, properties=AllAsJObject, =>ReportJobObject]
Report Job name: [.:ReportJobObject.Name]
Report Job input filename: [.:ReportJobObject.InputFileName]
Report Job macro count: [.:ReportJobObject.MacroCount]
[EndForEach:][EndForEach:]