Page Comparison

Number Expressions

Number expressions are a sequence of digits that result in a number context-item.

1
1234

Text Expressions

Text expressions are text content enclosed in quotation marks that result in a text context-item.

'Bug'
 
"admin"

Composite Expression Operators

Composite expressions are a combination of two separate expressions using an operator, the result is a single context-item.

The possible operators are:

Operator =

Compares the two expressions for equality, the two expressions must both be either a number or a text. The result expression is a boolean context-item.

$.issuetype = 'Bug'

Operator <>

Compares the two expressions for inequality, the two expressions must both be either a number or a text. The result expression is a boolean context-item.

$.key <> 'TST-10'

Operator +

Combines the two expressions using addition semantics, the two expressions must both be either a number or a text. The result expression is either a number or a text depending on the expression context-items.

$.key + ' ' + $.summary

Operator <

Compares the two expressions with less semantic, the two expressions must be a number. The result expression is a boolean context-item.

$groups.count < 3

Operator >

Compares the two expressions with greater semantic, the two expressions must be a number. The result expression is a boolean context-item.

$projects.count > 10

Expression "."

The dot expression refers to a path element on the current context-item.

Please note that the path can also be empty, in this case the default value of a context-item is substituted.

For example if the context-item is a JIRA issue then the following expression

[[$.key]]

will evaluate to the JIRA issue key and will be substituted in the Word contents with e.g.

TST-1

Expression "baselines"

Status
colour Green title Data center only

The baselines expression will be evaluated to result in a Baselines context-item for further use in expressions.

[[$baselines]]

Expression "currentIndex"

The currentIndex expression can be used to determine the current iteration of a loop statement.
The expression evaluates to a number context-item starting at zero for the first iteration of a loop. With each iteration number is increased by one. 
This expression can be used with the each-, filter- and jql-statement. 

Example:

[[\each $selectedProject]]
	[[$currentIndex + 1]]. [[$.name]]
[[/each]]

Expression "durationDays"

Status
colour Green title Data center only

The durationDays expression itself must be followed by an expression evaluating to a duration context-item such as a JIRA issue estimated value.

Example : 

[[$durationDays $.estimate]]

Will result in a text representation of the fractional day value like

1.25

Expression "durationHours"

Status
colour Green title Data center only

The durationHours expression itself must be followed by an expression evaluating to a duration context-item such as a JIRA issue estimated value.

Example : 

[[$durationHours $.estimate]]

Will result in a text representation of the fractional hour value like

10.45

Expression "durationJira"

Status
colour Green title Data center only

The durationJira expression itself must be followed by an expression evaluating to a duration context-item such as a JIRA issue estimated value.

Example : 

[[$durationJira $.estimate]]

Will result in a text representation in the JIRA duration format # weeks , # day, # hours, # minutes

Expression "durationShortJira"

Status
colour Green title Data center only

The durationShortJira expression itself must be followed by an expression evaluating to a duration context-item such as a JIRA issue estimated value.

Example : 

[[$durationShortJira $.estimate]]

Will result in a text representation in the JIRA short duration format # w , # d, # h, # m

Expression "durationTimespan"

Status
colour Green title Data center only

The durationTimespan expression itself must be followed by an expression evaluating to a duration context-item such as a JIRA issue estimated value.

Example : 

[[$durationTimespan $.estimate]]

Will result in a text representation in format HH:MM:SS

Expression "durationWeeks"

Status
colour Green title Data center only

The durationWeeks expression itself must be followed by an expression evaluating to a duration context-item such as a JIRA issue estimated value.

Example : 

[[$durationHours $.estimate]]

Will result in a text representation of the fractional week value like

0.012

Expression "exportLongDate"

Status
colour Green title Data center only

The exportLongDate expression will be evaluated to a String context-item of the date and time representation at which the export has been performed.

[[$exportLongDate]]

Expression "exportShortDate"

Status
colour Green title Data center only

The exportShortDate expression will be evaluated to a String context-item of the date representation at which the export has been performed.

[[$exportShortDate]]

Expression "metadata"

The metadata expression will be evaluated to result in a Metadata context-item for further use in expressions.
This expression enables the output of template information.

[[$metadata]]

Expression "projects"

Status
colour Green title Data center only

The projects expression will be evaluated to result in a Projects context-item for further use in expressions.

[[$projects]]

Expression "property"

Status
colour Green title Data center only

The property expression will be evaluated to result in a Property context-item for further use in expressions.

Example:

[[$property.description]]
[[$property.keywords]]
[[$property.subject]]
[[$property.title]]

Expression "selectedBaseline"

Status
colour Green title Data center only

The selectedBaseline expression may contain a Baseline context-item that is passed to the template execution by a user selection.

If no baseline is selected upon export, the selectedBaseline evaluation results in an empty text. To use this expression, you must be in the baseline details of the baseline to be exported.

[[$selectedBaseline]]

Expression "selectedProject"

The selectedProject expression may contain a Project context-item that is passed to the template execution by a user selection.

If no project tree is selected upon export (e.g exporting outside of the project tree), the selectedProject evaluation results in an empty text.

[[$selectedProject]]

Expression "selectedFilter"

Status
colour Green title Data center only

The selectedFilter expression may contain a text context-item of the JIRA filter that has been passed to the template generation by a user selection.

If no filter is applied to the project tree upon export, the selectedFilter evaluation results in an empty text. This applies also to an advanced filter selection with a JQL.

[[$selectedFilter]]

Expression "selectedTreeFolder"

The selectedTreeFolder expression may contain a Folder context-item that is passed to the template generation by a user selection.

If no folder is selected upon export, the selectedTreeFolder evaluation results in an empty text.

[[$selectedTreeFolder]]

Expression "selectedTreeIssue"

The selectedTreeIssue expression may contain an Issue context-item that is passed to the template generation by a user selection.

If no issue is selected upon export, the selectedTreeIssue evaluation results in an empty text.

[[$selectedTreeIssue]]

Expression "selectedTreePage"

Status
colour Green title Data center only

The selectedTreePage expression will contain a Page context-item that is passed to the template generation by a user selection.

If no page is selected upon export or page information cannot be retrieved due to application link errors, the selectedTreePage evaluation results in an empty text. There are a few limitations with using this expression – see Restrictions.

[[$selectedTreePage]]

Expression "selectedItem"

Status
colour Green title

v4.17

The selectedItem expression will contain an Item context-item that is passed to the template generation by a user selection.

If no item is selected upon export, the selectedItem evaluation results in an empty text.

[[$selectedItem]]

Expression "server"

Status
colour Green title Data center only

The server expression will be evaluated to result in a Server context-item for further use in expressions.

[[$server]]

Expression "users"

Status
colour Green title Data center only

The users expression will be evaluated to result in a Users context-item for further use in expressions.

[[$users]]

Expression "variable"

The variable expression can be used to retrieve the value of a variable created by the variable statement.
To access the value of the variable the expression requires the corresponding variable name.
The expression will then be evaluated to the context-item stored in the variable.

[[$variable.variable_name]]