Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.


Excerpt

A Transition Count custom field represents the number of times a specified workflow transition(s) was executed and is displayed as a number in Double format.

Adding a Transition Count custom field type

To add a Transition Count custom field type to your instance:

  1. Log in to JIRA as an administrator.
  2. Go to the Administration icon  and click on it.
  3. Click on Issues - > Custom fields.
  4. Click on Add custom field.
  5. Click on Advanced in the left panel.
  6. Locate Transition Count Field and select it.
  7. Click on Next.
  8. Provide a name for the custom field.
  9. You can optionally provide a description for the custom field.
  10. Click on Create.
  11. Associate the custom field to the appropriate screens.
  12. Locate the custom field in the Custom fields administration page and click on the cog wheel.
  13. Click on Configure and specify the transition(s) to look for (explained below).
  14. You can create multiple contexts if you need to associate different transitions to look for with particular projects or issue types.
  15. Perform a re-index as prompted by JIRA.


Panel
titleOn this page

Table of Contents


Panel
titleRelated links



Note

If you have upgraded from JMCF 1.x to 2.x please refer to the upgrade guide.

Search template

When creating a Transition Count Custom field type, you can configure the Search template as 

  • Number range searcher Allow searching for a number that is in a given range
  • Number range searcher (Statistics-compatible) - Allow searching for a number that is in a given range. Supports Statistics Gadgets.

Using these searchers you will be able to search issues within a number rangeThe default search template is Number range 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

Number range searcher (Statistics-compatible) is a custom statistics compatible searcher provided by JMCF that allows Number type custom fields of Jira and JMCF to be used in the statistics gadgetsSee here for more information. 

Specifying the transition(s) to look for

To specify the transition(s) to look for:

  1. Locate the custom field on the Custom Fields administration page.
  2. Click on the cog wheel and click on Configure
  3. Click on Edit Transition(s) to look for.
  4. Configure Transitions
    1. Specify transition names or IDsYou can either manually provide the name or id of the transition or use the 141892577, and optionally specifying the workflow name.

      Info

      By specifying the workflow name you can use the same calculated field to capture the number of times different transitions with the same meaning across different workflows are executed. For example: Imagine you have two workflows A and B, with transitions 21 and 51 respectively that lead to the Rejected status and you want to calculate the number of times each issue has been rejected. You can add the two transitions of two different workflows to the configuration as shown below.


      Note

      This is the preferred mode, as it allows differentiating between multiple transitions between the same two Statuses, and it also supports "auto-transitions" (that do not change the issue Status). However, it will not work reliably for "old" transitions that took place before major workflow changes or switching the issue to a new workflow entirely.


    2. Specify from and to Statuses: You can specify the transitions by their From and To statuses.

      Note

      While this option doesn't allow differentiating between multiple transitions that move the issue between the same from and to statuses, and it doesn't work for "auto-transitions" (that do not change the issue Status), it will work reliably even for issues that changed workflows since the transition took place. 


  5. Click on Add.
  6. Click on Save.

To remove the transition(s) to look for:

  1. Locate the custom field on the Custom Fields administration page.
  2. Click on the cog wheel and click on Configure
  3. Click on Edit Transition(s) to look for.
  4. Click on Remove for the transition you wish to remove.
  5. Click on Save.

Transition picker

To pick a transition using the Transition picker:

  • Click on Transition picker in the Configure Transitions screen.
  • Choose a workflow from Workflow name
  • Select a transition from the list of transitions displayed
  • Finally, click on either
    • Use Transition Name - recommended if you want the post-function to search for the transition to trigger by name, which is useful when targeting multiple workflows.
    • Use Transition ID - if you want to differentiate between transitions that bear the same name.

Customizing the display of the of the Transition Count custom field value on the issue detail view

You can define a velocity template that will return the Html representation of the calculated custom field on the issue detail view. Leave it empty to use the default template. 

To select a format for a Transition Count custom field type value:

  1. Locate the custom field on the Custom Fields administration page.
  2. Click on the cog wheel and click on Configure
  3. Click on Edit Velocity Template.
  4. Input the template.
  5. Click on Save.

You can use the following Velocity variables in the template:

  • $value: the raw field value, a number in Double format
  • $formattedValuea String representing a number in Double format
  • and other variables described on this page

For example:

Code Block
<div style="border: dashed">
  $formattedValue
</div>

displays the value in a dashed box

Customizing the display of the of the Transition Count custom field value on the search list view

You can define a velocity template that will return the Html representation of the calculated custom field on the search list view. Leave it empty to use the default template. 

To select a format for a Transition Count custom field type value:

  1. Locate the custom field on the Custom Fields administration page.
  2. Click on the cog wheel and click on Configure
  3. Click on Edit List View Velocity Template.
  4. Input the template.
  5. Click on Save.

You can use the following Velocity variables in the template:

  • $value: the raw field value, a number in Double format
  • $formattedValuea String representing a number in Double format
  • and other variables described on this page

For example:

Code Block
<div style="border: dashed">
  $formattedValue
</div>

displays the value in a dashed box


Displaying the Transition count custom field type on Transition and Edit screen

The Never show on Transition and Edit screens option controls whether the calculated Transition count 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.

Accessing the Transition count custom field type from other Groovy scripts

You can access this field using any of the following getters of the Issue interface: