ReportMagic

[Jira.InsertMarkup:]

Formats any Jira field into a formatted output (bulleted lists, bold fonts, thumbnails etc. are preserved).

Macro Compatibility

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

Parameter	Type	Deprecation Message	Preferred Parameter	Presence	Purpose	Options	Default
jObject 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 varible 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
jsonPath	String	Use instead of: path		Conditional	The JSON Path. Only has an affect when 'jObject' is set.	N/A	N/A
path	String	Deprecated	jsonPath		The JSON Path. Only has an affect when 'jObject' is set.	N/A	N/A
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 the Jira Connection	N/A	N/A
errorOnOverflow	Boolean			Optional	Should NCalc expression evaluation throw error on Overflow	true false	true
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
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
key	String			Optional	The Jira Key, e.g. ABC-123. This is needed in order to show images / thumbnails. If you do NOT provide this, they will be rendered as Jira markup (e.g. '!image.jpg\|thumbnail!').	N/A	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
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
value	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
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

Examples (2)

Example 1: Legacy mode

[Jira.IssueProperty: key=PRJ-123, mode=Legacy, properties=Description, storeAsHidden=description1][Jira.InsertMarkup: key=PRJ-123, value=`{description1}`]

Example 2: Normal 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]

[Jira.InsertMarkup:]

Macro Compatibility

Examples (2)

Example 1: Legacy mode

Example 2: Normal mode

Search