Formats any Jira field into a formatted output (bulleted lists, bold fonts, thumbnails etc. are preserved).
Compatibility
The macro can be used in the highlighted input document types only. A greyed-out icon indicates not supported.
Usage
NOTE: only supported in Word, HTML and Report Studio input documents.
Updates
When the markup contains an image, macros after this one in the same paragraph now run, and the image, or its name when no 'key' is given, stays in its place in the text. Previously those macros were skipped and left in the output as text, in Word when no 'key' was given and in Report Studio when one was, which for example ended a loop over Jira comments at the first comment with an image. In Report Studio the image or its name was also shown out of order with the text around it. In PowerPoint and RM Script, which this macro does not support, it now gives an error saying so, where it previously gave an unclear error, or none when there was nothing to insert. The help now says which input documents it supports, and the help for 'key' describes how an image is shown without it.
History (4)
Dashes and underscores used as ordinary punctuation are no longer mistaken for formatting. A line such as 'Mon - Wed - Fri' previously had the words between the dashes struck through, and a date range such as '2026-08-15 - 2026-08-16' was struck through from inside the first date. Genuine formatting is unchanged: a marker still applies when it starts a word and sits directly against the text it formats, as Jira itself requires.
Lists written with dashes now produce valid HTML. The square bullet style was written with a misplaced quotation mark, which browsers and Word both tolerated, so lists rendered correctly either way. No change to how a list looks is expected.
Panel titles are now the same size in every output format. The title size was written without a unit, which Word interpreted as pixels but a web browser discarded as invalid, so an HTML report showed panel titles at a different size from the same report in Word. Word and PDF output are unchanged; HTML output now matches them.
Now supports images from Jira tickets. Added jObject and jPath parameters.
Behaviour (8)
| Parameter | Type | Presence | Purpose | Options | Default |
| List<ExecutionResult> | Optional | If specified, asserts the expected execution result of the macro. Accepts a single value or a semicolon-separated list of acceptable values (e.g. 'Success;Warning'). The macro executes normally; if the actual result matches any of the desired values, 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' and 'Stopped'. |
|
N/A | |
| Boolean | Optional | Should NCalc expression evaluation throw error on Overflow |
|
true | |
| 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 | |
| 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 legacy mode (default for Schedules), the variable created is a string and formatted. In normal mode (default for Report Studio), the output variable is stored as a strongly-typed object, e.g. an Int32 or a JArray etc., rather than a formatted string. |
|
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 | |
| 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 |
Output (2)
| 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 |
General (4)1 additional
| Parameter | Type | Presence | Purpose | Options | Default |
Normal mode |
JObject | Conditional | The JObject variable. If present, the 'value' parameter cannot be used. Typically, if you use other macros (such as Jira.IssueProperty) in Normal mode, and your variable is a JObject, then you should use this parameter to accept the JObject. Use back-ticks around the parameter unless you are using late evaluation. | N/A | N/A |
| String | Optional | The name of the Jira Connection | N/A | N/A | |
| String | Optional | The Jira Key, e.g. ABC-123. This is needed in order to show images / thumbnails. If you do NOT provide this, each image is shown as its file name and any size or thumbnail setting, on its own line (e.g. 'image.jpg|thumbnail'). | N/A | N/A | |
| String | Optional | The Jira markup/text to process. Can be a variable e.g. value=`{myvariable}`. It is advised to use back-ticks around the value parameter or use late evaluation. If present, the 'value' parameter cannot be used. | N/A | N/A |
Examples (2)
Example 1Legacy mode
[Jira.IssueProperty: key=PRJ-123, mode=Legacy, properties=Description, storeAsHidden=description1][Jira.InsertMarkup: key=PRJ-123, value=`{description1}`]Example 2Normal mode
This normal mode example stores the Issue property into a JObject called 'myvar', then the InsertMarkup macro sets the 'jObject' and 'jObject' parameters to extract the Jira markup itself.
[Jira.IssueProperty: key=PRJ-123, mode=Normal, properties=Description, storeAsHidden=description2][Jira.InsertMarkup: key=PRJ-123, jObject=`{description2}`, jsonPath=Description]
