Skip to main content
Skip table of contents

Editing statuses

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 Statuses to configure the statuses that can be assigned to checklist items:

image-20240517-125644.png

The following page will appear:

image-20240517-125755.png

Statuses are added to checklist items for information purposes, as they are an easy way to track the progress of tasks within a project.

Enabling statuses

By toggling the Statuses feature, users can assign statuses to checklist items. The default statuses are N/AIn Progress, and Blocked; you can also create custom statuses.

For more information on status assignment, see Assigning statuses to items.

Making statuses mandatory

Statuses can be made mandatory on checklist items by enabling the Mandatory Statuses feature. Once done, you will be required to provide a default status, which will automatically be set to all checklist items without a status.

Once enabled, users will lose the ability to remove statuses from items.

For more information on status assignment, see Assigning statuses to items.

To make checklists controlled by statuses, see Configure a checklist to be controlled through statuses.

Creating statuses

The default N/AIn Progress, and Blocked statuses will already be displayed in the status editor, but you can also add your own custom statuses to the editor. To do so:

  1. Click Add Status.

    image-20240517-130412.png

  2. Referring to the table below, fill out each field and drop-down. The Preview column will automatically update with your changes.

    image-20240517-130517.png

  3. Click Save.

Parameter

Description

Name

The name that will be displayed on the status tag.

ID

Any unique ID (cannot contain spaces or be set to none). The ID ensures that future changes to the statuses are applied to the correct checklist items. If the ID is changed, any items that had that status will show as having no status in the checklist.

Style

The appearance of the status. Styles are applied as per Jira's UI library, and the colors may change in the future if Jira updates them.

Existing styles: DEFAULT, SUCCESS, ERROR, CURRENT, COMPLETE, MOVED

On status set

The behavior of an item’s checkbox when a status is set for that checklist item.

  • Do nothing: The checkbox remains as is.

  • Check the item: The checkbox is marked as complete.

  • Uncheck the item: The checkbox is marked as incomplete.

On checked changed

The behavior of the status when an item’s checkbox is checked or unchecked.

  • Do nothing: The status is still displayed.

  • Remove status when checked: The status is removed when the item is checked.

    • The completion behavior must be set to Incomplete (if not, an error will occur).

  • Remove status when unchecked: When a status is assigned to a checklist item, its checkbox is checked; if that item’s checkbox is later unchecked, the status is removed.

    • The completion behavior must be set to Complete (if not, an error will occur, as the Complete behavior is what ensures that the checkbox gets checked).

  • Set status when checked: The status is updated to this value when the item is checked.

    • Only one status can have this behavior, and the completion behavior must be set to Complete (if not, an error will occur).

Example 1

The Set status when checked behavior could be used so that once the item is checked, its status is set to “Done”.

Example 2

The Remove status when unchecked behavior could be used so that once the “Done” status is assigned to an item, its checkbox is automatically checked. If that box is later unchecked, the “Done” status is automatically removed.

Reordering statuses

Statuses can be reordered, which changes the order in which they appear in the status drop-down.

To move the statuses into a new order:

  • Click on the handle next to a status and drag and drop it into a new location.

Deleting statuses

When you delete a status, any checklist items that previously had that status will appear to have no status when the issue is next opened.

To delete a status:

  • Click the trash icon to the right of the status.

    image-20240517-130831.png

Resetting statuses to default

If you’ve made changes to the statuses and want to roll back to factory defaults, you can click the Reset to default button.

image-20240517-131259.png

Editing statuses in CSV format

If desired, you can edit your statuses in the CSV editor instead. This makes it easy to export and import any status information that is being kept in a separate CSV file.

Each status must be on one line and have five parameters, each delimited by a comma, in the following order:
ID, Name, Style, Completion Behavior, Status Behavior

image-20240517-131039.png

To edit statuses in the CSV editor:

  1. Click Edit as CSV.

    image-20240517-131134.png

  2. Add, edit or remove statuses as needed.

  3. Click Save.

JavaScript errors detected

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

If this problem persists, please contact our support.