Editing parameters

You need administrator rights in Jira to perform the tasks on this page.

Once you have gone to the Custom fields page (see Configuring the Checklist custom field), click Edit Parameters to customize the various checklist settings:

The following page will appear:

Behavior

These parameters control the functionalities of the checklist.

Parameter	Toggle	Description
Mandatory Items		The following effects occur: New checklist items will appear with an asterisk in the top right corner. A button will appear in the editor to allow users to toggle individual checklist items to be either “mandatory” or “optional”. The summary in the header will turn orange when all mandatory items are checked. The `allMandatoryItemsChecked` JQL function will also be enabled (it will return false otherwise). Mandatory checklist items do not actually require users to check them. However, this effect can be achieved with a validator (see Setting up a Checklist Workflow Validator). For more information, see Making mandatory items optional.
Mandatory Items		The existence of this feature is ignored completely, and new checklist items are not considered to be either mandatory or optional, and will appear as a standard checkbox without an asterisk. If this feature is enabled at a later date, any checklist items that were created while the feature was off will be considered mandatory by default.
Default Mandatory State		Created items will be mandatory by default.
Default Mandatory State		Created items will be optional by default.
Lock on Resolution		Global items that are added or updated will not be reflected in Jira issues that have already been resolved. WHY ARE MY CLOSED ISSUES MISSING GLOBAL ITEMS? In some cases, this parameter may cause closed issues to not show some or all global items. This happens when those issues were created before the global items were added, or before the custom field was created. To prevent this, users must modify and save checklists before closing the issue. You can achieve this automatically with a post function (see Setting up a Modify Checklists post function) that appends no items to the checklist on transitions resolving/closing the issue. This will force the checklist to persist its data to the database and produce the expected behavior.
Lock on Resolution		Global items that are added, updated or removed will be reflected in all Jira issues, even if they have already been resolved. Reindexing is required to see those changes in searches.
Convert to Issue		Users can convert checklist items to Jira issues. You can also select an issue link type, which will be used to automatically create an issue link between the created issue and the original issue. In the Convert items to issues dialog, the selected issue link type will be pre-selected. For more information, see Converting checklist items to issues or subtasks.
Convert to Issue		Users cannot convert checklist items to Jira issues.
Bulk Editor		Users can bulk edit checklist items in issues.
Bulk Editor		Users cannot bulk edit checklist items in issues.
Bulk Complete		Users can bulk complete checklist items in issues.
Bulk Complete		Users cannot bulk complete checklist items in issues.
Due Dates		Users can assign due dates to checklist items. For more information, see Adding due dates to items.
Due Dates		Users cannot assign due dates to checklist items.
Priorities		Users can assign priorities to checklist items. The priorities that are available come from the priority scheme currently in use for the project. For more information, see Setting priorities for items.
Priorities		Users cannot assign priorities to checklist items.
User Assignment		Users can assign checklist items to themselves or other users. For more information, see Assigning users to items.
User Assignment		Users cannot assign checklist items to anyone.
Advanced Markdown		Users can format their checklists using the full Markdown suite (CommonMark specification), with the exception of HTML blocks. For more information, see Using special formatting.
Advanced Markdown		Users can only format their checklists using basic Markdown (italics, bold, and hyperlinks).
External Images		Users can embed external images using Markdown syntax. For more information, see Using special formatting.
External Images		Users cannot embed external images.
Section Headings		Users can create headers to group together checklist items. Summary: When enabled, a count will appear next to each header that tallies how many checklist items are checked out of the total number of checklist items in that section. Collapsible: When enabled, a caret will appear that allows users to expand and collapse sections. Default Collapsed State: Dictates whether headers collapse when first loaded. (This option is greyed out when Collapsible is disabled.) Expanded: Headings are not collapsed. Collapsed: All headings are collapsed. Collapse Completed Sections: Headings whose items are all complete are collapsed. Headings with at least one uncompleted item are not collapsed. For more information, see Creating and manipulating headers.
Section Headings		Users cannot create headers. If this feature was enabled and then is later disabled, existing headers are not converted to regular items; instead, it simply removes the ability to create new headers and convert items to headers.

Look & Feel

These parameters control the visual appearance of the checklist.

General

These parameters apply to the checklist in general.

Parameter	Toggle	Description
Strike Through		When the checklist is in read-only view, a strike through effect will be applied to checklist items when they are checked. This is disabled in edit views, such as the panel display modes and Agile boards.
Strike Through		No strikethrough effect will be applied to checklist items when they are checked.
Show More Count		On the issue details page, only a certain number of checklist items will be listed before a show more link is displayed. The checklist must be in read-only view for this feature to work, which means that Display Mode must be set to Custom field.
Show More Count		All checklist items are always displayed.
Show Checklist With No Items		SINCE 7.1.0 This feature also applies to panel Display Modes and the Agile board. The checklist will still appear in the issue detail view if it contains no items.
Show Checklist With No Items		The checklist will not appear in the issue detail view if it contains no items.
Show Checklist With Items Unchecked		SINCE 7.1.0 This feature also applies to panel Display Modes and the Agile board. The checklist will still appear in the issue detail view if none of its items are checked.
Show Checklist With Items Unchecked		The checklist will not appear in the issue detail view if none of its items are checked.
Display Mode	N/A	Applies the selected display mode to the checklist in the issue details view: Custom field: The checklist is displayed as a pop-out panel that must be clicked before it can be edited (it is placed within a screen tab). Independent panel: The checklist is displayed as an independent panel that can be directly edited. Checklists are shown one after another within the panel. Sidebar panel: The checklist is displayed as a panel in the right-hand sidebar that can be directly edited. Checklists are shown one after another within the panel. With the Independent panel and Sidebar panel display modes, the operations bar in the issue views will not update when a workflow condition is in effect. For more information, see Panel display modes limitation.
Assignee Display	N/A	Indicates how the assignee is displayed on a checklist item. Avatar (default): Only show the user’s avatar. Name: Only show the user’s full name. Initials: Only show the user’s initials. Avatar and initials: Show the user’s avatar and initials. Avatar and name: Show the user’s avatar and name.
Description Display	N/A	Indicates how the description is displayed on a checklist item. Expandable link (default): Shows an expandable link under the item name. Tooltip: Shows an exclamation mark icon next to the item name that opens a tooltip on hover.
Compact View		The checklist’s view will be more compact, saving vertical scrolling for longer checklists. This feature flag is does not affect certain views, such as the Confluence and HTML exports or default checklist renders in the Search Issue page.
Compact View		The checklist will have the default look and feel.
Show Only Checked Items		The checklist behaves like a standard Checkboxes custom field, where only checked items are displayed in the preview. Since the Independent panel and Sidebar panel display modes do not have a read-only view, this feature only applies to the Custom Field display mode.
Show Only Checked Items		All items are rendered in the read-only view.
Limit Width		The checklist will limit it’s maximum width to 1024 pixels.
Limit Width		The checklist will expand its width without limit. Useful if you want to make use of all the available space.

Header

These parameters apply to the checklist’s header specifically.

Parameter	Toggle	Description
Checklist Header		A header is displayed at the very top of the checklist that shows completion progress and checklist operations. Read-Only View: When enabled, the header is displayed in read-only view. Edit View: When enabled, the header is displayed in edit view.
Checklist Header		No header is displayed at the very top of the checklist.
Summaries' Source	N/A	Choose how the header’s banner and progress bar should calculate progression: All items: The summaries will show progress of all the checklist’s items, no matter if the items are optional or mandatory. Mandatory items: The summaries will show progress of only the checklist’s mandatory items. Changing this parameter changes how the checklist progression is calculated. It also changes how the checklist determines what Custom Banner Labels to display.
Banner Appearance	N/A	Choose a color scheme for the banner: Subtle: Muted colors. Normal: Bold colors.
Banner Type	N/A	The type of banner that will be displayed: Progression: Displays a progress summary. Custom Labels: Enables the Custom Banner Labels section at the bottom of the page for creating custom checklist statuses.

Custom Banner Labels

This section is only enabled when Custom Labels is selected for Banner Type in the section above. It allows you to specify custom banners to display when the checklist reaches different levels of completion.

Each label can be dynamically filled with custom variables (see Using variables in custom text fields) and supports basic Markdown (see Using special formatting).

Parameter	Description
Completed	Displays the entered custom status when the entire checklist is complete.
Incomplete	Displays the entered custom status when the checklist is partially complete.
All mandatory	Displays the entered custom status when all mandatory items in the checklist are complete.
Empty	Displays the entered custom status when the checklist contains no items.

Advanced

These parameters control complex features of the checklist.

Parameter	Toggle	Description
Confluence Renderer		The default XML renderer is replaced by a Confluence renderer, which allows checklists to display properly in Confluence. When this feature is enabled, XML exports will no longer work properly.
Confluence Renderer		The default XML renderer is used, which is better suited to exporting in XML. If you need to export in XML and need to disable this parameter, set up a Checklist Read-Only Proxy custom field instead to display your checklist in Confluence.