Skip to main content
Skip table of contents

Add Checklist Based on a Custom Field Value

This rule add a checklist depending on the value of a custom field.

Limitations

If you are using Checklists for Jira ENTERPRISE , note that this rule cannot add/modify a Global Checklist. Global Checklists are added to work items via their context.

Notes

If you are using this rule to add checklist in a team-managed project, you first need to add the Checklist Text custom field to the project. To add a field to a project:

  1. Navigate to Project settings > Fields.

  2. Click Add field.

  3. Select the Checklist Text.

  4. Click Add 1 field.

Modifications

  • These examples show how to add a checklist when the work item is created. You can modify the automation rule to work on another trigger, such as Work item transitioned. Do not use the generic Work item updated trigger because when the checklist template is added to the work item, a “Work item updated” event is sent by Jira which may make the automation rule run repeatedly.

  • You can use an if/else clause to add different checklists associated with different custom field values.

Add a Checklist Based on a Custom Field Value

  1. Ensure the Sync checklists to Custom Fields global setting is enabled..

  2. Navigate to Project Settings > Automation (or Jira Settings > System > Automation rules).

  3. Click Create rule.

  4. Select the Work item created trigger and click Next.

  5. Click New component and select New condition.

  6. Select Work item fields condition.

  7. Select the desired field and the value required to add checklist. Click Next.

    condition2.png

  8. Click New component and select New action

  9. Select Edit work item.

  10. Select Checklist Text custom field in the dropdown. Type or paste in your formatted checklist. Click Save.

    Checklist.png

  11. Name the rule and click Turn it on.

Apply Checklist Template Based on Custom Field Value

  1. Ensure the Apply checklist templates via labels global setting is enabled.

  2. Navigate to Project Settings > Automation (or Jira Settings > System > Automation rules).

  3. Click Create rule.

  4. Select the Work item created trigger and click Next.

  5. Click New component and select New condition.

  6. Select Work item fields condition.

  7. Select the desired field and the value required to add the template. Click Next.

    Condition.png

  8. Click New component and select New action

  9. Select Edit work item.

  10. Select Labels as the field to be edited, and enter the name of the template. Click Next.

    Label.png
  11. Name the rule and click Turn it on.

Apply Checklist Template Based on Custom Field Value – If/Else Example

  1. Ensure that the Apply checklist templates via labels global setting is enabled.

  2. Navigate to Project Settings > Automation (or Jira Settings > System > Automation rules).

  3. Click Create rule.

  4. Select the Work item created trigger.

  5. Click New condition and select If / else block.

  6. Click Add conditions and select Work item fields condition.

  7. Select the desired field and the value required to add the template. Click Next.

  8. Click New Action and select Edit work item.

  9. Select Checklist Text as the field and leave the content empty. This will clear any previous local checklists from the work item. Click Next.

  10. Click New Action and select Edit work item.

  11. Select Labels as the field to be edited, and select or add the label that corresponds to the appropriate template. Click Next.

  12. Click on the first step in the if block to duplicate it.

    CopyIfBlock.png

  13. Update the new block with the correct value and the appropriate template.

  14. Repeat steps 12 and 13 for for each option.

  15. Name the rule and click Turn it on.

JavaScript errors detected

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

If this problem persists, please contact our support.