Apply checklist template to issue (on issue create, edit or transition)

To apply a checklist template to an issue through Automation, please use the Checklist Template custom field.

It is enough to set value for that field on an issue, and the Issue Checklist will apply the selected checklist automatically.

  1. Find IDs for the Checklist Template custom field and the value you want to select, as presented on the screenshot below:

     

If the Checklist Template field is not available on the “Create Issue” screen, you can add it to the screen temporarily.

Please note that if you update the list of templates, the IDs of the templates will change in the Checklist Template custom field. In that case, you need to update your Automation rule with the proper ID of the selected template.

 

2. Add action to your Automation rule, using the IDs from the point above:

Once the checklist template is added to the issue, Issue Checklist removes the value set in point #2 above from the issue.

It sends an “issue updated” event in Jira and might trigger your Automation rules to execute again. Please make sure the Automation rules have a proper condition and does not set Checklist Template back (to avoid circular update on an issue).

If the Automation with setting checklist does not work, please start with testing the Checklist Template field manually:

  • Add Checklist Template field to the issue Edit/View screen

  • Manually select/set value in the Checklist Template field on the issue page

  • Wait for a couple of seconds (so Jira has time to notify the Issue Checklist server that the template was set through the Checklist Template field)

  • Refresh the issue page and see if the checklist items (with clickable checkboxes) were added successfully (and the Checklist Template field has been cleared at the same time)

Manual selection of the Checklist Template field value succeeds

If the above works correctly and you can see the checklist items, it means that the process works fine overall, but there is something wrong with your Automation rule. Maybe you picked an incorrect ID for the checklist template option? You might inspect the issue History tab to see if Automation did work and set value for the Checklist Template field.

You can also inspect the Automation log if the rule failed and see what the reason was.

Manual selection of the Checklist Template field value fails

If the above bullet point procedure does not work, then please check if the list of checklist templates as you can see them on the templates page/dialog is exactly the same as in the Checklist Template dropdown field.

Checklist Template field is not synced with the list of templates

If the list is different, please do the following:

  • Find all issues with the non-empty Checklist Template field. Here is the JQL: "Checklist Template" is not empty”

  • Clear Checklist Template field for those issues (if there are many of them, use the “Bulk Update” option)

  • Find all issues with the non-empty Checklist Template field again and validate that the search result is empty

  • Add or edit any template to trigger re-sync between the list of templates and the Checklist Template field

  • Validate again that the Checklist Template field contains exactly the same list of templates as you can see on the templates page/dialog.

  • Try the first bullet point procedure again to see if picking value in Checklist Template dropdown adds checklist items/checkboxes to the issue

Checklist Template field is synced with the list of templates

In that case, if the manual selection of the value in Checklist Template dropdown still does not apply the template to the issue, please try the following:

  • Reload the page after a couple of minutes to validate if the template was loaded.
    Jira is sometimes late letting Issue Checklist know about changes in the issue. Also, the communication between Jira happens in the background (outside of the browser) so page reload is required to see the changes in the checklist related to issue update action. If it doesn’t help, please proceed below.

  • Uninstall and install again Issue Checklist app (all data stays safe during that time as we hold it for some time after uninstall as per our Privacy Policy).
    Reinstalling the app will store the proper Jira Checklist Template field ID in the database. Incorrect ID can be a cause of non-working integration between the Checklist Template field in Jira and Issue Checklist templates.