"Checklists" Custom Field set up

Why do I need the "Checklists" custom field? You may benefit from the additional functionality of the Smart Checklist add-on. Read more.

How to add "Checklists" custom field

You should have administrator rights.

Make sure you are aware of the general principles of Custom Fields and verified JIRA guide

General Flow. Configure your Jira instance

  1. Log in as a user with the JIRA Administrators global permission.

  2. Choose the cog icon  at the top right of the screen, then choose Issues. Select Fields > Custom Fields to open the 'Custom Fields' page.
    Keyboard shortcutg + g + start typing custom fields

  3. Click the Add Custom Field button to open the Create Custom Field: Choose the field type (Step 1 of 2) page.

  4. Select the Paragraph (supports rich text) type (previously Text, Multi-Line type)

  5. Set name to "Checklists". Make sure the name starts with the capital "C" and ends with the lowercase "s"

  6. Click the Next button to open the Create Custom Field - Details (Step 2 of 2) page.

  7. You will receive an "Associate field Checklist to screens" dialog

    1. if you happen to skip this step or want to get back to Jira Screens set up a bit later


  8. Associate all the right screens you want to see the default Jira Checklist multi-line text editor 

    1. if you are new to the Jira Screens setup and just want to start using Checklist >> just select all to be sure

    2. if you have just one Jira Screens for all your actions >> just select that one screen

    3. if you have an advanced Jira Screens setup

  9. Click "Update"

  10. Enjoy your Smart Checklist!

You must select all your EDIT Jira Screens for all the projects you want Checklist to work

Setting up Checklist Jira Screens later (after adding the field)

  1. Go to Custom Fields. See steps (1) and (2) above

  2. Find the "Checklists" field and go to "Screens" under the field settings menu (under the gear icon)

  3. Proceed with steps (6) and (7)






Before adding the "Checklists" custom field, make sure that no such field has already been created on your instance. Duplication of the "Checklists" field will lead to unpredictable add-on behavior. Smart Checklist will not recognize which field to use as a data storage. 

In case 2 or more fields are added, users will see the following message:

Solution: remove all "Checklists" duplicates. Leave only 1 field.

How to setup "Checklists" custom field video

Note: Text, Multi-Line type is now changed to Paragraph (supports rich text) type

How to hide "Checklists" field from the View Screen video

Remove "Checklists" field wisely. Do it ONLY when you don't need any data that's stored there. You would need this data if you plan exporting issues with checklists.

Data between Issue Properties and Custom Field is synchronized only when Smart Checklist is initialized by opening a Jira issue. This means, if you remove the field and re-add it later on,  there's a risk not to have checklists from OLD Jira issues synced.