Custom Fields Setup

In order to use extended features of Smart Checklist - you need to set up additional custom fields.

Custom Field name

Purpose

“Checklists”

Type: Text Field (multi-line)

Stores checklists data in RAW text format. Example:

# header
- todo
+ done
~ in progress
x skip

Used mostly for Automation purposes. Setting/Reading checklists via REST API requests and 3rd party tools. Importing/Exporting checklist data. Required for Data Center → Cloud Jira migration.

Limited to 32,767 characters.

“Smart Checklist Progress”

Type: Text Field (single line)

Stores value of checklists progress. Example: “5/7”

Used for showing checklist progress in Agile boards and validating checklist completion in transition. Optional for Data Center → Cloud Jira migration

“Smart Checklist”

Type: Smart Checklist Custom Field

Used for advanced JQL Search Functions and for display checklist in Confluence or Jira Dashboard.

☝🏼NOTE: All custom fields are automatically added to the Jira instance upon Smart Checklist add-on installation - starting from version 5.0.0.

If you’re on a lower version - custom fields must be set up manually.

Follow "Checklists" Custom Field setup instructions.

Follow "Smart Checklist Progress" Custom Field setup instructions.

Follow "Smart Checklist" Custom Field setup instructions.

Features enabled with Custom fields

Feature	Custom field used
Validate before transition	`“Smart Checklist Progress”`
Progress on Agile Board	`“Smart Checklist Progress”`
JQL Search Checklists	`“Smart Checklist”` `“Checklists”`
Track checklist changes	`“Checklists”`
Import/Export/Share	`“Checklists”`
Automations & Integrations	`“Checklists”`
Show checklists in Confluence or Jira Dashboard	`“Smart Checklist”`

📫 Don’t hesitate to get in touch with us for any questions or feature requests!