Skip to main content
Skip table of contents

Configure Checklist Global Settings

Sync checklists to Custom Fields

Enabling this setting syncs local checklist items to the Checklist Text custom field. This custom field can be used to read or modify local checklist(s) for functions such as automation, bulk actions and search.

If you disable, then re-enable this setting, a one-time re-save of all the local checklist items will be performed to update content of the custom fields. The update may take several hours.

Sync.jpg

Allow multiple checklists per work item

Enabling this setting makes it possible to have multiple, local checklists on a single issue/work item. 

  • You can disable this setting if you you do not want to allow multiple local checklists on an issue/work item. The "+" (add checklist) button will be removed from the Checklists UI.

  • If you decide to re-enable this setting, and the Sync checklist to Custom Fields setting is enabled, the system will re-sync the Checklist Text field, triggering an issue updated event for all issues/work items that have checklists.

Multiple.jpg

 

Show empty checklist panel in work items

Enabling this setting means the Checklist UI is always visible, even if there are no checklist items.

If you disable this setting, the Checklist UI will not be shown if there no checklist items and you will need to click on the Apps button in the upper left corner of the issue/work item to add a checklist.

Empty.png

Apply checklist templates via labels

If this option is enabled, when you create or edit an issue/work item, checklist templates matching any of the labels added to the work item will automatically be applied.

The label must exactly match the template name and the template name cannot include spaces.

Removing a label from an issue won't cause a checklist to be removed.

Labels.jpg

Send email notifications for user mentions

If you are using Checklists for Jira PRO or ENTERPRISE, enable this option to send email notifications to users when they are mentioned in a checklist item. Emails are sent when new items are added, when items are edited or when a template is applied to the issue.

Note that currently there is now way for an individual user to unsubscribe from checklist notifications.

To modify the email subject line, click into the text box and type the desired text. Click the checkmark to save your changes.

Email.png

When enabled, Checklists for Jira will read user's display name, but will not store it.

Notification emails are not sent when:

  • A user mentions themself

  • A user is mentioned while editing the checklist in the checklist editor

  • A user is mentioned while editing the checklist through the Checklist Text custom field.

Checklist panel title

In Checklists for Jira PRO and ENTERPRISE you can select the main title for the Checklists panel The default title is Checklist. The other options are Acceptance criteria, Definition of done, Success criteria and Testing notes.

Title.jpg

Strikethrough completed items text

Enable this option to display text as crossed out once the checklist item has been completed.

Strike.png

Show checklists in Jira mobile

Enable this option to show checklist in Jira mobile.

When enabled, the Checklists UI will be displayed in the right side (Context) panel on the desktop. If the user sets their preferences to show Checklists in the main panel, then the Checklists UI will be displayed in both places.

Mobile.png

 

JavaScript errors detected

Please note, these errors can depend on your browser setup.

If this problem persists, please contact our support.