Creates an object array and stores the result. This macro never outputs to the report directly.

Determines the count of items in an array and stores the result. This macro never outputs to the report directly.

Breaks out of a [ForEach:] or [While:] loop, and uses a similar structure to traditional "break" syntax in common programming languages. When loops are nested, it breaks out of the innermost one. Typically used in conjunction with an [If:] macro.

Stops processing a document. Can fire conditionally on an expression.

This is used to calculate a result based on other macros and calculations.

Outputs a hex-encoded colour string based on the percentage difference and specified intensity of an input colour. Input colours can be specified by name (e.g. white) or hex-encoded (e.g. #FFFFFF, also white)

Does nothing. Useful for adding comments.

Skips the rest of the current iteration of a [ForEach:] or [While:] loop, similar to "continue" syntax in common programming languages. When loops are nested, it applies to the innermost one.

Marks a location in your document.

Inserts a document break into a Word or HTML output document, e.g. a page break, column break, line break etc).

Insert a section of the input document, which has previously been created with the [DocumentSection:] macro. A section must be defined before it can be inserted, in other words, the [DocumentInsertSection:] macro must come after the [DocumentSection:] macro that defines the name of the section.

Use the [DocumentSection:] / [DocumentEndSection:] macro to define a section of the input document, which can be moved to a predefined bookmark in your Word document.

Bookmarks can be manually created in Word, or you can use the [DocumentBookmark:] macro.

Note that the [DocumentSection:] / [DocumentEndSection:] macro requires that bookmarks do not span a selection of text, in other words they should be inserted at a single character position in the input document.

Sections can be nested. Each [DocumentSection:] pairs with its own [DocumentEndSection:], and an inner section is finished first, so the outer section includes whatever the inner one left in place.

The document section is inserted at the bookmark specified (or saved in a variable) when fully processed, i.e. graphs, and tables etc will be fully rendered and processed first.

The storeAs parameter can be used to reference the section by name, and inserted using the [DocumentInsertSection:] macro.

Use the [ForEach:] / [EndForEach:] macros to loop over a number of values, repeating a section of the input template as it does so.

Ignore (i.e. do not process macros) a section of your input document. This is particularly useful when testing macros using Report Studio, if you want to temporarily disable large chunks of input processing. Blocks can be nested: an [Ignore:] block ends at its own [EndIgnore:], not at the first one inside it.

Increments a variable, or decrements it if using a negative value. If the variable is not already set, it is assumed to be zero (0).

Determines whether a variable is set. Can be used with the [Unset:] macro (see example, below).

The Linear regression macro takes any number of DateTime^Number, input values and calculates the line of best fit for:Y = MX + C... where: Y is the numeric value; X is the number of days since the Epoch; and M and C are constants.Three output values are returned: M, C and R-squared ("Goodness of fit" - a percentage). See the example.

Inserts a hyperlink into the output document. The [EndLink:] macro marks the end of the hyperlink.

Note that the macro does not check whether the URL specified is well-formed. Authentication of the user on any end system is NOT supported, so if the destination URL requires a username/password, you may have to log into the site before the link will work as expected.

Creates an object and stores the result. This macro never outputs to the report directly.

Generates a random integer or double, optionally between min and max values.

Uses Regular Expressions to extract strings from other strings. Match groups are stored delimiter-separated. Within each match group, individual entries are stored carat-separated. The "g" modifier, as used in Javascript and Perl languages is always applied to obtain multiple regex groups. Search the web for 'online regex tools' for practical assistance in constructing regular expressions.

Copies the current table row a number of times below this row, setting a variable for each line.

Performs a case-sensitive "Search and Replace". In Word and HTML it can be global (default) or can be limited to just the previous table. In PowerPoint it covers the current slide (default) or, with the 'powerPointScope' parameter, every slide in the presentation; 'scope=previousTable' limits it to the table on the current slide. As with other macros, these are run in the order they appear in the template, so may affect each other. Note that the contents of the report at the time the macro is run are considered.

Useful to indicate in Progress screens where a named section starts.

Stops the current Report Job. No further Macros will be processed. Other Report Jobs in the Batch Job will continue to run.

Controls a stopwatch. The value returned is the stopwatch value at the moment the macro was executed, but before any reset.

Locates the first position of one string within another. If the sub-string is not found, outputs -1.

Conditionally includes a section of the Word document, and uses a similar structure to traditional 'switch' syntax in common programming languages.

Throws an exception. Used for testing.

Unsets one or more variables. Does not error if the variable is already not set. Use with the [IsSet:] macro (see example, below).

Use the [While:] / [EndWhile:] macros to repeat a section of the input template while a condition evaluates to true. This is useful for paginated API calls or other scenarios where the iteration count is not known upfront.