Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Info
titleGetting help

Please visit our Support Page for more information.

Overview

The JIRA Misc Custom Fields plugin's objective is to provide several new types of custom fields for use in custom JIRA workflows as well as useful JQL functions.

Included custom fields:

...



Info
titleGetting help

Please visit our Support Page for more information.

Overview

The JIRA Misc Custom Fields plugin's objective is to provide several new types of custom fields for use in custom JIRA workflows as well as useful JQL functions.

Included custom fields:

  • Calculated Number Field : a calculated custom field returning a Stringnumber (integer or float). It is a read-only field that returns the result of the evaluation of a formula, such as the concatenation addition of two other fields.
  • Exact Text Searcher (Statistics-compatible)Calculated Text Field (new in 1.5.65): a custom searcher that allows calculated calculated custom field returning a String. It is a read-only field that returns the result of the evaluation of a formula, such as the concatenation of two other fields.
    • Exact Text Searcher (Statistics-compatible) (new in 1.5.6): a custom searcher that allows calculated text fields to be used in statistics gadgets
  • Calculated Date/Time Field (new in 1.5.5): a calculated custom field returning a java.util.Date (which represents a date+time). It is a read-only field that returns the result of the evaluation of a formula.
  • Transition Date/Time Field (new in 1.2): a calculated custom field returning the date and time of the last execution of a specified workflow transition.
  • Transition Caller Field (new in 1.2): a calculated custom field returning the caller of the last execution of a specified workflow transition.
  • Transition Count Field (new in 1.5.11): a calculated custom field returning the number of times a specified workflow transition was executed.
  • Last Field Value Change Date/Time Field (new in 1.6): a calculated custom field returning the date and time a field was last modified.
  • Last Field Value Change Author Field (new in 1.6.5/1.7.2): a calculated custom field returning the author of the last modification made to a field.
  • Parent Status Field (new in 1.2.2): a calculated custom field returning the Status of the issue's parent issue.

...

Code Block
numberTool.format(value)

Example

To display an icon to the left of the field value depending on the field value:

Code Block
<!-- @@Format:
if (value > 21)
  return "<img src='/images/icons/priority_trivial.gif'> "+numberTool.format(value);
else if (value >= 10)
  return "<img src='/images/icons/priority_major.gif'> "+numberTool.format(value);
else
  return "<img src='/images/icons/priority_blocker.gif'> "+numberTool.format(value);
 -->

...

/icons/priority_major.gif'> "+numberTool.format(value);
else
  return "<img src='/images/icons/priority_blocker.gif'> "+numberTool.format(value);
 -->

Anchor
calculatedtextfield
calculatedtextfield
Calculated Text Field (new in 1.5.5)

  1. Create a new custom field, choosing "Calculated Text Field" for its type.
  2. During step 2, in the Description field, include the calculation formula using the syntax described below.
  3. Re-index your data, as JIRA will kindly suggest you to.
Formula syntax

The formula is written using the BeanShell language, and should be included in the field description inside an html comment (so that it remains invisible when showing the field description), preceded by the following keyword: @@Formula: (note the colon at the end). See Calculated Number Field above for details.

Note that you must make sure the formula returns a String, or null.

Exact Text Searcher (Statistics-compatible) (new in 1.5.

...

6)

...

When creating a Calculated Text Field

...

Formula syntax

The formula is written using the BeanShell language, and should be included in the field description inside an html comment (so that it remains invisible when showing the field description), preceded by the following keyword: @@Formula: (note the colon at the end). See Calculated Number Field above for details.

Note that you must make sure the formula returns a String, or null.

...

, you can choose between the standard Free Text Searcher and the new Exact Text Searcher (Statistics-compatible). The latter should be used if you need either of the following:

  • Be able to search issues based on the exact value of the custom field (i.e. use the "=" operator instead of the "~" operator)
  • Be able to use the field in one of the statistics reports or dashboard gadgets


Anchor
calculateddatefield
calculateddatefield
Calculated Date/Time Field (new in 1.5.

...

5)

When creating a Calculated Text Field, you can choose between the standard Free Text Searcher and the new Exact Text Searcher (Statistics-compatible). The latter should be used if you need either of the following:

  • Be able to search issues based on the exact value of the custom field (i.e. use the "=" operator instead of the "~" operator)
  • Be able to use the field in one of the statistics reports or dashboard gadgets

...

  1. Create a new custom field, choosing "Calculated Date/Time Field" for its type.
  2. During step 2, in the Description field, include the calculation formula using the syntax described below.
  3. Re-index your data, as JIRA will kindly suggest you to.
Formula syntax

The formula is written using the BeanShell language, and should be included in the field description inside an html comment (so that it remains invisible when showing the field description), preceded by the following keyword: @@Formula: (note the colon at the end). See Calculated Number Field above for details.

Note that you must make sure the formula returns a java.util.Date, or null.

Custom formatting

You can also specify a date/time format for the value of the Calculated Date/Time field. In the Description field, add the name of the date/time format using the following syntax:

Code Block
<!-- @@Format: <format_name> -->

where <format_name> is one of the constants found here: https://developer.atlassian.com/static/javadoc/jira/reference/com/atlassian/jira/datetime/DateTimeStyle.html

...

Transition Date/Time Field

...

  1. Create a new custom field, choosing "Calculated Date/Time Field" for its type.
  2. During step 2, in the Description field, include the calculation formula using the syntax described below.
  3. Re-index your data, as JIRA will kindly suggest you to.
Formula syntax

The formula is written using the BeanShell language, and should be included in the field description inside an html comment (so that it remains invisible when showing the field description), preceded by the following keyword: @@Formula: (note the colon at the end). See Calculated Number Field above for details.

Note that you must make sure the formula returns a java.util.Date, or null.

Custom formatting

You can also specify a date/time format for the value of the Calculated Date/Time field. In the Description field, add the name of the date/time format using the following syntax:

Code Block
<!-- @@Format: <format_name> -->

where <format_name> is one of the constants found here: https://developer.atlassian.com/static/javadoc/jira/reference/com/atlassian/jira/datetime/DateTimeStyle.html

To customize the formatting of the value in the List View of search results, use the @@ColFormat marker instead:

Code Block
<!-- @@ColFormat: <format_name> -->

Anchor
transitiondatefield
transitiondatefield

Transition Date/Time Field

  1. Create a new custom field, choosing "Transition Date/Time Field" for its type.
  2. During step 2, in the Description field, include the transition ID(s) (recommended) or name as described below.
  3. Optionally, specify whether you want the first or last execution of the transition(s) (new in 1.2.5 and 1.5.2)
  4. Re-index your data, as JIRA will kindly suggest you to.
Indicating the transition

The transition(s) should be indicated in the field description inside an html comment (so that it remains invisible when showing the field description), preceded by the following keyword: @TransitionId: or @TransitionName: (note the colon at the end). For example:

Code Block
<!-- @TransitionId: transition ID -->

or

Code Block
<!-- @TransitionName: transition name -->

If you use @TransitionId, you can specify a list of transition IDs, separated by commas (new in 1.2.5 and 1.5.2)

...

Indicating the transition

The transition(s) should be indicated in the field description inside an html comment (so that it remains invisible when showing the field description), preceded by the following keyword: @TransitionId: or @TransitionName: (note the colon at the end). For example:

...

:

Code Block
<!-- @TransitionId: transition_ID_1,transition_ID_2 -->

You can naturally include the real description of the custom field as well. For example:

Code Block
This field represents the date and time of the Resolution of this issue.
<!-- @TransitionId: transition ID -->

...

 5 -->
<!-- @Execution: last -->
Specifying whether to capture the first or last transition execution

You can also specify whether to capture the first or last transition execution, using the @Execution: keyword followed by first or last. For example:

Code Block
<!-- @TransitionName@Execution: transition namefirst -->

If you use @TransitionId, you can specify a list of transition IDs, separated by commas (new in 1.2.5 and 1.5.2):

Code Block
<!-- @TransitionId: transition_ID_1,transition_ID_2 -->

You can naturally include the real description of the custom field as well. For example:

Code Block
This field represents the date and time of the Resolution of this issue.
<!-- @TransitionId: 5 -->
<!-- @Execution: last -->
Specifying whether to capture the first or last transition execution

You can also specify whether to capture the first or last transition execution, using the @Execution: keyword followed by first or last. For exampledon't specify anything, the last execution will be captured.

Custom formatting

You can also specify a date/time format for the value of the Calculated Date/Time field. In the Description field, add the name of the date/time format using the following syntax:

Code Block
<!-- @@Format: <format_name> -->

where <format_name> is one of the constants found here: https://developer.atlassian.com/static/javadoc/jira/reference/com/atlassian/jira/datetime/DateTimeStyle.html

To customize the formatting of the value in the List View of search results, use the @@ColFormat marker instead:

Code Block
<!-- @Execution@@ColFormat: first<format_name> -->

If you don't specify anything, the last execution will be captured.


Anchor
transitioncallerfield
transitioncallerfield

...

Custom formatting

You can also specify a date/time format for the value of the Calculated Date/Time field. In the Description field, add the name of the date/time format using the following syntax:

Code Block
<!-- @@Format: <format_name> -->

where <format_name> is one of the constants found here: https://developer.atlassian.com/static/javadoc/jira/reference/com/atlassian/jira/datetime/DateTimeStyle.html

To customize the formatting of the value in the List View of search results, use the @@ColFormat marker instead:

Code Block
<!-- @@ColFormat: <format_name> -->


Anchor
fieldmodifiedby
fieldmodifiedby

...