Issue Checklist for Jira is now Checklist for Jira. New name, same great app. Please go here to see our new documentation site.

Checklist Text & Checklist Text (view-only)

Owned by Jennifer Choban
Last updated: Jul 23, 2024
4 min read

 

 

  • These fields only work if the Save local checklist items to Jira custom fields global setting is enabled.

  • These fields may not sync correctly if they are not included, or hidden on a screen.

  • These fields are not linked to Global Checklists. If you are using the Enterprise app, and have Global Checklists enabled, these fields will only reflect items the local checklist(s).

  • After enabling the Save local checklist items to Jira custom fields global setting, the sync may take a couple of hours up to a full day depending on the size of your instance. Please allow adequate time before using the contents of the Checklist Text field in automation rules, workflow behaviors, etc.

  • If the Save local checklist items to Jira custom fields setting is enabled and the Checklist Text field is included on Jira screens, then the checklist content will be visible to users regardless of whether or not they have View checklist permission.

 

Checklist Text

Multi-line text field that stores the content of the checklist(s) and can be used to read or modify the checklist(s). The value of the field is automatically kept in sync with the checklist(s) if the Save local checklist items to Jira custom fields option is enabled. The field can be modified by Jira users.

 

 

Checklist Text (view-only)

A view-only copy of the Checklist Text field without user mentions or item descriptions.

The value of this field is automatically kept in sync with the checklist(s) if the Save local checklist items to Jira custom fields option is enabled.

Uses

  • Can be used to Import/export checklists from Trello, CSV or another Jira instance.

  • Can be used with advanced JQL to search for specific contents of a checklist.

  • Can be used when bulk editing to add a checklist to multiple issues.

  • Allows access to the checklist via the Jira API.

  • Can be used to modify a checklist when an issue is edited or transitioned.

  • Records changes to the checklist in the Jira History tab.

  • Can be used with automation or scripting apps to access and/or modify the checklist.

  • The view-only field can be used to display a more concise view of the checklist content (for example, in JQL search results).

  • To set a default checklist to be automatically added when issues are created, include the Checklist Text field as a hidden field on the Create issue screen.  Hiding the field will not impact its functionality.

More Details

  • Save local checklist items to Jira custom fields must be enabled (see below).

  • Field size is limited to 32,767 characters. Larger checklists may not fit into the Checklist Text field and syncing may not work as expected. 

  • Modification to the Checklist Text field must follow these formatting rules in order for the checklist to render correctly.

  • Not available in Team-managed (Next gen) projects.

  • These fields are not compatible with Global Checklists. If you are using the Enterprise app, and have Global Checklists enabled, these fields will not work.

Save local checklist items to Jira custom fields Global Setting

Enabling the Save local checklist items to Jira custom fields global setting will mean that the Checklist Text custom field will be automatically synced with the checklist(s) on the issue.  The other custom fields hold metadata and will remain in sync regardless of whether the setting is enabled.

How to Find the Custom Field ID

When using custom fields with automation, scripts, etc. you will need the ID number of the custom field.

To find the ID of the custom field:

  1. Log in as a Jira Administrator.

  2. Go to Jira Settings > Issues > Custom fields.

  3. Search for the indicated custom field.

  4. Click the More menu (…) and select Edit Details.

  5. Copy the URL of the page. The URL will end with the ID number of the custom field.




Custom fields can be duplicated by some errors or rare scenarios. If you are experiencing issues with accessing custom fields, make sure you are referencing the custom field that is currently used by Issue Checklist.

Â