A Calculated Wiki Text custom field displays text calculated using a Groovy script and optionally supporting wiki-style formatting (like the Description field). |
To add a Calculated (Scripted) Wiki Text custom field type to your instance:
Issues - > Custom fields.
Add custom field
.Advanced
in the left panel.Calculated (scripted) Wiki Text Field
and select it.Next
.Create.
Configure
and create a formula (explained below) for the fieldWhen creating a Calculated (scripted) Wiki Text custom field type, you can configure the Search template as
Using these searchers you will be able to search issues either with a free text or the exact text for that custom field value. The default search template is Exact text searcher (Statistics-compatible)
. If you select “None” for the searcher, then you won’t see any reference to this field in the Issue Navigator search fields. Note that changing a custom field searcher requires a re-index.
Exact text searcher (Statistics-compatible) is a custom statistics compatible searcher provided by JMCF that allows Text type custom fields of Jira and JMCF to be used in statistics gadgets. If you select “None” for the searcher, then you won’t see any reference to this field in the Issue Navigator search fields. Note that changing a custom field searcher requires a re-index.
To write a formula for the Calculated (scripted) Wiki Text custom field type;
Configure.
Edit Groovy Formula.
Save.
Upon saving the formula, the fields' renderer is automatically changed to "Wiki Style Renderer". |
As documented on the Expected Value tab of the Groovy help editor, the Groovy formula must return either a simple String with/without wiki markup or null
Examples of Groovy formula for a Calculated Wiki Text custom field:
A simple String:
"JMCF 2.0.1" |
is displayed as JMCF 2.0.1
on the issue
A Groovy expression to reference any field of the issue that returns a String, for example, the Summary of the issue.
issue.summary |
A Groovy expression with wiki markup as
"The issue *" + issue.key + "* has been raised with _" + issue.priority.name + "_ priority. Please look into asap." |
will be displayed as: The issue *TEST-1* has been raised with _Medium_ priority. Please look into asap.
If the field is configured to be Wiki rendered, the field value will be displayed as:
|
A Groovy expression that includes Groovy operators such as the String concatenate:
issue.get("summary") + textutils.noNull(issue.get("description")) |
will be displayed as:
Backend Testing# *API* testing # _DB_ testing |
If the field is configured to be Wiki rendered, the field value will be displayed as:
|
A Groovy expression that includes Groovy method calls, for example, to replace a specific String using the replace()
method
issue.get("description").replace('Cloud','Server') |
By default, the Calculated (scripted) Wiki Text custom type field has the "Default Text Renderer" that renders a field's content as plain text. For example, as shown above in examples 3 and 4, with the Default Text Renderer, the text is not converted to HTML content. To display wiki-style formatting you need to update the Active Renderer
field to Wiki Style Renderer
in the field configuration of the custom field.
With Wiki style rendered enabled the custom field value in
example 3, "The issue *TEST-1* has been raised with _Medium_priority. Please look into asap."
will be displayed as:
|
example 4, "Backend Testing# *API* testing # _DB_ testing"
will be displayed as:
|
You can define a velocity template that will return the Html representation, in addition to the wiki markup provided in the custom field value of the calculated custom field on the issue detail view. Leave it empty to use the default template.
To select a format for a Calculated (scripted) Wiki Text custom field type value;
Configure
Edit Velocity Template
.Save.
You can use the following Velocity variables in the template:
$value
: the raw field value a String$formattedValue
: a StringFor example:
<font color="red"> $value </font> |
You can define a velocity template that will return the Html representation, in addition to the wiki markup provided in the custom field value of the calculated custom field on the search list view. Leave it empty to use the default template.
To select a format for a Calculated (scripted) Wiki Text custom field type value;
Configure
Edit List View Velocity Template
.Save.
You can use the following Velocity variables in the template:
$value
: the raw field value a String$formattedValue
: a StringFor example:
<font color="red"> $value </font> |
The Never show on Transition and Edit screens
option controls whether the Calculated (scripted) Wiki Text custom field can appear on transition and edit screens. If you select this option, the field will not be visible on any Edit or Transition screen, even if it is added to the screen.
You can access this field using any of the following getters of the Issue interface get("Your custom field name") or get("customfield_xxxxx")
or
getAsString("Your custom field name")
or
getAsString("customfield_xxxxx")
that returns a String.