"Smart Checklist" Custom Field setup instructions
- Oleksandr Haiun
The Smart Checklist custom field enhances your workflow by enabling advanced JQL search capabilities and displaying checklist data in Confluence or Jira Dashboards.
☝🏼NOTE: This page is primarily relevant for Smart Checklist add-on versions earlier than v.5.0.0.
For v.5.0.0 and above, Smart Checklist automatically sets up all custom fields during installation. However, you may still find useful information here about manual field configuration.
👤 JIRA PERMISSION REQUIRED: Make sure you have JIRA Administrators global permission to Configure Custom Fields.
Purpose 🎯
Used to perform advanced searches with JQL → JQL Search Checklists
Enables checklist data to be displayed in Confluence or Jira Dashboards → Show checklists in Confluence or Jira Dashboard
Setup Guide
Go to Issues → Custom Fields in your Jira Administration settings.
Click the Add custom field button.
Choose Advanced → Smart Checklist Custom Field → click the Next button.
☝🏼NOTE: The Smart Checklist custom field is read-only, even though checkboxes are displayed. However, it always reflects the current state of the checklist in the related Jira issues.
Set the name to “Smart Checklist” 👉🏼 Be sure to use the exact capitalization and wording.
Configure Context of the field:
a. Select Apply to Issues in selected projects if you only need the field to be available in specific projects.
b. Select Apply to all issues on your instance if you want JQL search to work well for all issues in the Jira instance.
☝🏼NOTE: We recommend selecting the Apply to all issues on your instance option when setting up the Smart Checklist custom field. This ensures that the field is universally available across all issues, which can be particularly beneficial if you plan to use JQL Search or show Checklist data on Confluence pages or Jira Dashboard.
Associate the Smart Checklist custom field with screens where you want the checklist data to be properly formatted, mirroring the formatting seen in the Smart Checklist window.
You are all set! 🚀