|
How to add a Review step to your JIRA workflow. This document will show you how to create/edit a workflow that will contain a extra step for review and notify the appropriate parties via e-mail. The ability to edit workflows is only available in the JIRA Professional and Enterprise versions. Tutorial Assumptions
1. The Custom FieldWe need to create a Review Due Date custom field for our review process to let our QA team know when we need the review to be completed. Administration -> Issue Fields -> Custom Fields Click Add. The Review Screen should now appear under the list of possible screens. Click the Add Custom Field link. On the next screen, under Field Type, select the Date Picker radio button. Click Next. On the next screen enter the following information:
Click Finish. You will now be prompted to select a screen for this custom field. For now, simply click Update. We will associate this field with a screen in a few moments. 2. The ScreenDuring this process, we want the user to enter a due date for the review. In order to do this, we're going to create a new screen. Administration -> Issue Fields -> Screens Under the Add Screen section, enter the following information:
Click Add. The Review Screen should now appear in the list of available screens. For the Review Screen entry, click the Configure link in the Operations column. In the Add Field section, select the Review Due Date custom field and click Add. 3. The StatusWe'll also need to create a new issue status for our review process. This is useful in case we want to do a search on all issues that are currently waiting to be reviewed. Administration -> Issue Settings -> Statuses Under the Add New Status portion of the screen, enter the following:
Extra credit: If the generic status icon is not setting the right status mood, click the select image link next to the Icon URL: text box. Choose /images/icons/status_needinfo.gif from the list of possible gifs. Ready? Click the Add button. The new status should now appear in the list of available statuses. 4. The WorkflowNext, we need to create a new workflow to add our new Review step. Administration -> Global Settings -> Workflows Since we cannot edit an Active workflow we must either create a new workflow (by entering information under Add New Workflow and clicking Add) or make a copy of the active workflow (by clicking Copy under the Operations column). Have a new Inactive workflow? Click the Steps link. We're ready to add our Review Step. Under Add New Step, enter the following:
Click Add. Review should now be listed as new workflow step. 5. The TransitionsTransitions allow a user to get from one step to the next. In this example, we're going to add two transitions:
You can add transitions to other steps where appropriate. Under the Open step's Operations column, click the Add Transition link. Enter the following information:
Click Add. The Request Review transition should now appear under the Open step's transitions. If a review has been requested and performed by the QA team, we would now like the option for QA to resolve the issue. Let's do it! Under the Review step's Operations column, click the Add Transition link. Enter the following information:
Click Add. The Resolved transition should now appear under the Review step's transitions. Extra credit:
6. The Notification SchemeLet's suppose the QA team would like to know when an issue is ready for review. One of the best ways to achieve this is by e-mail notification. 7. The Workflow SchemeDid it work? For more information on workflows please visit the following JIRA documentation: |
