Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Note

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:

Image RemovedImage Added
On this page:
Table of Contents
maxLevel2

The following page will appear:

Image RemovedImage Added

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).

Note

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).

Info

For more information, see Making mandatory items optional.

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.

Local ItemsPriorities

Status

Image Removed

Users can add local items, which are items that only apply to a single issue.

Info

For more information, see Creating local items.

Image Removed

Users cannot add local items.

Convert to Issue

Image Removed

Users can convert checklist items to Jira issues.

Info

For more information, see Converting checklist items to issues or subtasks.

Image Removed

Users cannot convert checklist items to Jira issues.

titleavailable since 6.1.0

Default Mandatory State

Image Added

Created items will be mandatory by default.

Image Added

Created items will be optional by default.

Statuses

Users can assign priorities statuses to checklist items. The priorities that are available come from the priority scheme currently in use for the project.

Image Removed

default statuses are N/AIn Progress, and Blocked; you can also create custom statuses.

Image Added
Info

For more information, see Setting priorities for items Assigning statuses to items and https://okapya.atlassian.net/wiki/spaces/CHKDOC5/pages/1966080093.

Users cannot assign priorities statuses to checklist items.

Advanced MarkdownLocal Items

Users can format their checklists using the full Markdown suite (CommonMark specification), with the exception of HTML blocks.

Info

For more information, see Using special formatting.

Image Removed

Users can only format their checklists using basic Markdown (italics, bold, and hyperlinks).

Section Headings

Image RemovedUsers can create headers togroup 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.

    Image Removed
  • Collapsible: When enabled, a caret will appear that allows users to expand and collapse sections.

    Image Removed
  • Collapsed by default: When enabled, all section headings will automatically be collapsed when a checklist is viewed

    add local items, which are items that only apply to a single issue.

    Info

    For more information, see Creating and manipulating headers.

    Image Removed

    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.

    Statuses

    Image Removed

    Users can assign statuses to checklist items. The default statuses are N/AIn Progress, and Blocked; you can also create custom statuses.

    Image Removed
    Info

    For more information, see Assigning statuses to items and Editing statuseshttps://okapya.atlassian.net/wiki/spaces/CHKDOC5/pages/1951563886.

    Users cannot assign statuses to checklist add local items.

    Lock on Resolution

    Global items that are added or updated will not be reflected in Jira issues that have already been resolved.

    Expand
    titleWHY DO MY CLOSED ISSUES NO LONGER SHOW GLOBAL ITEMS?

    In some cases, turning this parameter on may cause currently closed issues or issues closed without touching the checklist to not show global items anymore. By default, checklist data will only persist when the default values are added, modified, or deleted. To prevent this, users mustmodify and save checklists before closing the issue.

    You can achieve this automatically with a post function (see Setting up a Modify Checklists post function https://okapya.atlassian.net/wiki/spaces/CHKDOC5/pages/1951563799) 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.

    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

    Image Added

    Users can convert checklist items to Jira issues.

    Status
    titleavailable since 6.1.0

    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.

    Image Added
    Info

    For more information, see https://okapya.atlassian.net/wiki/spaces/CHKDOC5/pages/1951563971.

    Image Added

    Users cannot convert checklist items to Jira issues.

    Due Dates

    Users can assign due dates to checklist items.

    Info

    For more information, see Adding due dates to items. https://okapya.atlassian.net/wiki/spaces/CHKDOC5/pages/1965752432.

    Image Added

    Users cannot assign due dates to checklist items.

    Priorities

    Image Added

    Users can assign priorities to checklist items. The priorities that are available come from the priority scheme currently in use for the project.

    Image Added
    Info

    For more information, see https://okapya.atlassian.net/wiki/spaces/CHKDOC5/pages/1965785391.

    Users cannot assign due dates priorities to checklist items.

    User Assignment

    Users can assign checklist items to themselves or other users.

    Info

    For more information, see Assigning users to items https://okapya.atlassian.net/wiki/spaces/CHKDOC5/pages/1965719702.

    Users cannot assign checklist items to anyone.

    Advanced Markdown

    Image Added

    Users can format their checklists using the full Markdown suite (CommonMark specification), with the exception of HTML blocks.

    Info

    For more information, see https://okapya.atlassian.net/wiki/spaces/CHKDOC5/pages/1951662210.

    Image Added

    Users can only format their checklists using basic Markdown (italics, bold, and hyperlinks).

    External Images

    Users can embed external images using Markdown syntax.

    Info

    For more information, see Using special formatting https://okapya.atlassian.net/wiki/spaces/CHKDOC5/pages/1951662210.

    Users cannot embed external images.

    Section Headings

    Image Added

    Users can create headers togroup 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.

      Image Added
    • Collapsible: When enabled, a caret will appear that allows users to expand and collapse sections.

      Image Added
    • Collapsed by default: When enabled, all section headings will automatically be collapsed when a checklist is viewed.

    Info

    For more information, see https://okapya.atlassian.net/wiki/spaces/CHKDOC5/pages/1965752439.

    Image Added

    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.

    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.

    All checklist items are always displayed.

    Show Checklist With No Items

    If Display Mode is set to Custom field, the checklist will still appear in the issue detail view if it contains no items.

    The checklist will not appear in the issue detail view if it contains no items.

    Show Checklist With Items Unchecked

    If Display Mode is set to Custom field, the checklist will still appear in the issue detail view if none of its items are checked.

    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).

      Image RemovedImage Added
    • 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.

    Note

    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.

    Status
    titleavailable since 5.2.2

    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.

    Status
    titleavailable since 5.1.1

    Show Contact Support

    Image Added

    A Contact Support link is available in the checklist header’s menu, linking to the Checklist Support portal.

    Image Added
    Image Added

    No Contact Support link is shown in the checklist header’s menu.

    Status
    titleavailable since 6.1.0

    Compact View

    Image Added

    The checklist’s view will be more compact, saving vertical scrolling for longer checklists.

    Image Added
    Info

    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.

    Image Added

    The checklist will have the default look and feel.

    Status
    titleAvailable since 6.1.0

    Show Only Checked Items

    Image Added

    The checklist behaves like a standard Checkboxes custom field, where only checked items are displayed in the preview.

    Note

    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.

    Image Added

    All items are rendered in the read-only view.

    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.

    No header is displayed at the very top of the checklist.

    Summaries' Source

    N/A

    Indicates what the header’s banner and progress bar base their progression on.

    • All items: The summaries will show progress based on all of the checklist’s items, regardless of whether the items are optional or mandatory.

    • Mandatory items: The summaries will show progress based only on the checklist’s mandatory items.

    Info

    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

    The color scheme of the banners:

    • Subtle: Displays the banners in muted colors.

    • Normal: Displays the banners in 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.

    Access Control

    These parameters control which users are able to modify the checklist.

    Parameter

    Toggle

    Description

    Edit Roles

    Only users who belong to the project roles selected from the drop-down can edit the checklist.

    All users can edit the checklist, as long as they have the Edit Issue permission in Jira.

    Reporter Can Edit

    Image Added

    The issue reporter can edit the checklist items, even if they do not belong to a project role selected in Edit Roles.

    Image Added

    The issue reporter cannot edit the checklist items if they do not belong to a project role selected in Edit Roles.

    All Can Work On Items

    All users can complete items and assign statuses, due dates or users to items (but won’t be able to edit or add items).

    Only the users who belong to the project roles selected in Edit Roles can edit the checklist.

    Reporter Can Edit

    Status
    titleavailable since 5.1.0

    Import Templates in Checklists

    The issue reporter can edit the checklist items, even if they do not belong to a project role selected in Edit RolesUsers can import templates into checklists in issues using either the Import template menu or the Quick import section of the template drop-down.

    The issue reporter cannot edit the checklist items if they do not belong to a project role selected in Edit Roles Import template menu and the Quick import section are not shown.

    Status
    titleavailable since 56.1.0

    Create / Edit Templates from Checklists

    Only users who belong to the project roles selected from the drop-down can create templates from existing checklists (see Creating and importing templates).

    If no project roles are selected, any user that can edit a checklist can create a template from it.

    Users cannot create templates from checklists in issues.

    Advanced

    These parameters control complex features of the checklist.

    Parameter

    Toggle

    Description

    Global Item Validation

    When a user attempts to delete a global item, a window appears that displays the number of issues that contain that global item and prompts the user to either continue or cancel.

    No window is displayed when a user deletes a global item. Turning this feature off can speed up deletion (querying your database using Jira’s process can take some time).

    Confluence Renderer

    The default XML renderer is replaced by a Confluence renderer, which allows checklists to display properly in Confluence.

    Note

    When this feature is enabled, XML exports will no longer work properly.

    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.

    Clever Changelog

    In the issue history, the before and after sections will only show items that were added, modified or removed when the custom field was modified.

    The issue history will list all items before and after the custom field was modified, letting you compare the changes manually.


    Status
    titleSERVER documentation
    (On Cloud? Go here.)
    Have questions? Contact our Service Desk for help anytime.