Versions Compared

Key

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

Automation for Jira is a popular tool to get your team automated by creating additional workflows, rules, and processes.

...

Info

You can Get Automation for Jira add-on on the Marketplace.

Use Cases

Table of Contents
2
minLevel1
maxLevel6
outlinefalse
styledisc
typelist
printabletrue

Set Checklist on Issue Creation

...

  1. Go to Automation for JiraAutomation Rules

  2. Click Create Rule

  3. Set When: New Trigger

    1. Choose Issue transitioned 

    2. Choose from status (e.g. Backlog) and to status (e.g. Selected for Development)

    3. Save

  4. Add component New Action

  5. Set New Action

    1. Choose Set entity property

    2. Choose Entity type: Issue

    3. Set Property Key

      • Code Block
        com.railsware.SmartChecklist.checklist

    4. Add checklist template items in Markdown formatting as the property value and add and add the following in the beginning: 

    Code Block
    {{issue
    .fields.Checklists}}
  6. Image Removed

Alternatively, it is also possible to do the same via Issue Properties:

  • Add checklist template in Markdown formatting as the property value and add the following in the beginning: 

...

  1. .properties."com.railsware.SmartChecklist.checklist"}}

    image-20241227-123646.pngImage Added

Panel
bgColor#FFEBE6

☝🏻NOTE: Using the “Checklists“ custom field ({{issue.fields.Checklists}})in Automation for Jira will be not supported soon. Please, use this syntax instead: {{issue.properties."com.railsware.SmartChecklist.checklist"}}

6. Save Action

7. Save and Turn Automation On

...

  1. Choose the trigger Issue created

  2. Choose the action Create sub-tasks

  3. List subtasks you need

  4. Click Add fields  - your subtask will be converted to a separate action step

  5. Choose Same Project to be sure the sub-task is not lost

  6. Add "Checklists" custom field from Choose fields to set

  7. Then add checklist items using checklist Markup formatting. Check the detailed guide.

  8. Save and publish the Automation Rule

  9. Now when you create a Jira issue new sub-tasks will be created automatically

  10. Click on the one that contains the checklist  - see it's rendered with Smart Checklist add-on

Add Checklist to Service Management tickets for certain Request types (not a JIRA issue type)

Panel
bgColor#DEEBFF

☝🏻NOTE: In Service Management

...

projects, issue types can have multiple request types. To be sure that you specify the right condition in the automation rule – check whether you want to add a Checklist to the Issue type or Request type.

Below, we’ll demonstrate how to add a checklist to the “Service Request” issue type with the “Get IT help” request type.

  1. You would need to check what issue type you have for "Get IT help" requests

  2. and And then create an Automation rule for this specific issue type. 

  3. E.g. If you have a Request Type called "Get IT help" and it has "Service Request" issue type: 

  4. In Automation, you would need to create a rule that would add a checklist to all the new Get IT helprequests of "Service Request" issue type

    1. Set Trigger. When: Issue Created

    2. Image Removed
    3. Set Condition. If: Issue matches JQL 

      Code Block
      issuetype = 
      '
      "Service Request
      " AND "Customer Request Type" = "Get IT help"

      image-20241210-104935.pngImage Added

    4. Set Action. Then: Set Issue Property

      Code Block
      com.railsware.SmartChecklist.checklist
      • And set the value of the checklist you need

...

  1. Go to Automation for Jira → Automation Rules

  2. Click Create Rule

  3. Set When: Field value changed Change

    1. Choose Checklists → Save

  4. Add component New Action

    1. Choose Set entity property

    2. Choose Entity Type: Issue

    3. Set Set Property Key

      • Code Block
        
        com.railsware.SmartChecklist.checklist

    4. Add the following to the Property value

      •  

    Code Block
    {{issue
    .Checklists
    .properties."com.railsware.SmartChecklist.checklist"}}
    image-20241227-123646.pngImage AddedImage Removed
Panel
bgColor

...

#FFEBE6

...

☝🏻NOTE: Using the “Checklists“ custom field ({{issue.fields.Checklists}})in Automation for Jira will be not supported soon. Please, use this syntax instead: {{issue.properties."com.railsware.SmartChecklist.checklist"}}

  1. Save the rule and Turn Automation On

  2. Proceed with the bulk update.

  3. Once the bulk update is completed, turn the rule off.

Note

Make sure this rule is only enabled when you need it for the bulk update operation. Otherwise, it will constantly run the synchronization, and you don't need that as a normal checklist operation would suffer.

...

  1. Go to Settings → System  Automation for Jira  Automation rules.

  2. Click Create rule.

  3. Choose the trigger Field value changed, and choose Smart Checklist Progress as a field to monitor for changes. Save.

  4. Set New condition → Advanced compare condition.

  5. Fill First value → {{fieldChange.fromString}}, Condition → does not equal. Save.
    Here’s how it looks:

  6. Set New condition → Advanced compare condition.

  7. Fill First value → {{fieldChange.fromString.remove(“ - Done”).substringBefore(“/”)}}, Condition → less than, Second value → {{fieldChange.toString.remove(“ - Done”).substringBefore(“/”)}}. Save.
    Here’s how it looks:

  8. Add Action → Create issue, Project → Same project, Issue type → Sub-task (or any other), Parent issue → Current issue, fill Summary and Description.

  9. Save the rule and Turn Automation On.

Add Checklist Tab on Issue transition

With the Multiple Checklists feature, you can configure an Automation rule to add an existing checklist tab to the checklist when specific conditions are met. For example, when issue is transitioned from

Status
titleto do
to
Status
colourBlue
titlein progress
a relevant checklist tab (e.g., "Definition of Done") is added to the issue.

  1. Go to Project SettingsAutomation → click Create rule

    image-20241220-145711.pngImage Added
  2. Create a trigger

2.1. Choose Issue transitioned

...

2.2. Choose From status (e.g.

Status
titleto do
) and To status (e.g.
Status
colourBlue
titlein progress
)

...

2.3. Save

  1. Add a Checklist Tab to a checklist

    1. Add component: Add an action

      image-20241230-100821.pngImage Added
    2. Choose Set entity property

      image-20241230-101003.pngImage Added
    3. Fill in the fields with the following values:

Entity type

Code Block
Issue

Property Key

Code Block
com.railsware.SmartChecklist.tab.<tabID>

<tabId> - should be replaced with Id of the tab

Panel
bgColor#DEEBFF

💡HINT: To get the right Id of the tab:

  1. Navigate to Manage apps > SC Settings > Checklist Tab

  2. Open Network tab in dev tool

  3. Look for /rest/railsware/1.internal/tabs request

  4. Open Preview tab

  5. Find the tab - there will be the specified id

    image-20241230-101637.pngImage Added

The Tab Id will be displayed in the UI for convenience in upcoming versions. Stay tuned!

Property Value

Status
colourPurple
titleif needed

 

You can also add Checklist items in Markdown formatting 👉🏻

Code Block
- Confirm client requirements are documented
- Schedule a feedback session with the client
- Collect and analyse client feedback
- Update the issue with client feedback outcomes

...

  1. Save and turn the Automation Rule On.

  2. All done! 🎉

Now, whenever an issue meets the defined criteria (e.g., moving from one status to another), the automation rule automatically adds the Definition of Done checklist tab. This ensures that required tasks are always visible ✅

...

Append Checklist Items to the Checklist Tab on Issue Transition

With the Multiple Checklists feature, you can configure an Automation rule to to append checklist items to the specific tab available on the Issue view. For example, when issue is transitioned from

Status
titleto do
to
Status
colourBlue
titlein progress
a relevant checklist items are added to the "Definition of Done" checklist tab.

  1. Go to Project Settings → Automation → click Create rule

    image-20241230-104119.pngImage Added
  2. Create a trigger

    1. Choose Issue transitioned 

      image-20241220-143342.pngImage Added
    2. Choose From status (e.g.

      Status
      titleto do
      ) and To status (e.g.
      Status
      colourBlue
      titleIn progress
      )

      image-20241230-104210.pngImage Added
    3. Save

  3. Define the Issue Type

    1. Add component: Add a condition

      image-20241220-143611.pngImage Added
    2. Add a condition: JQL Condition

      Status
      colourPurple
      titleif needed

      image-20241220-143645.pngImage Added
    3. Add a JQL query for defining the Issue Type

      Status
      colourPurple
      titleif needed

      Code Block
      issuetype in (Bug, Story, Task)

      image-20241220-143725.pngImage Added

    4. Save Condition

  4. Add a Checklist

    1. Add component: Add an action

      image-20241220-143820.pngImage Added
    2. Add an action: Set entity property

      image-20241220-143859.pngImage Added
    3. Fill in the fields with the following values:

Entity type

Code Block
Issue

Property Key

Code Block
com.railsware.SmartChecklist.tab.<tabID>

<tabId> - should be replaced with Id of the tab

Panel
bgColor#DEEBFF

💡HINT: To get the right Id of the tab:

  1. Navigate to Manage apps > SC Settings > Checklist Tab

  2. Open Network tab in dev tool

  3. Look for /rest/railsware/1.internal/tabs request

  4. Open Preview tab

  5. Find the tab - there will be the specified id

    image-20241230-101637.pngImage Added

The Tab Id will be displayed in the UI for convenience in upcoming versions. Stay tuned!

Property Value

 

If you want to append Checklist Items - add the following at the beginning and Checklist items in Markdown formatting 👉🏻

Code Block
{{issue.properties."com.railsware.SmartChecklist.tab.{tabID}"}}
Code Block
## Definition of Done 
- **Code complete.** All code has been written and reviewed, and all necessary functionality has been implemented.
- **Code coverage.** All code has been tested and meets the required code coverage threshold.
- **Code quality.** Code has been written using the required standards, conventions, and best practices.
- **Integration.** Code has been integrated into the main branch and all integration issues have been resolved.
- **Security:** The software has been tested for security vulnerabilities and all issues have been resolved.
- **Performance:** The software has been tested for performance and scalability, and all issues have been resolved.
- **Peer review.** Code is reviewed by the peers.
- **System testing.** The software has been tested end-to-end, and all system tests have passed.
- **Regression testing.** All previously implemented functionality has been tested, and regression tests have been passed.
- **Documentation.** All necessary documentation has been written, reviewed, and approved, including user manuals, API documentation, and system documentation.
- **Acceptance testing.** The functionality has been demonstrated to the product owner or customer and has been approved.
- **Deployment:** The software has been successfully deployed to the production environment, and all deployment issues have been resolved.

If you want to replace the Smart Checklist - just add Checklist items in Markdown formatting 👉🏻

Code Block
## Definition of Done 
- **Code complete.** All code has been written and reviewed, and all necessary functionality has been implemented.
- **Code coverage.** All code has been tested and meets the required code coverage threshold.
- **Code quality.** Code has been written using the required standards, conventions, and best practices.
- **Integration.** Code has been integrated into the main branch and all integration issues have been resolved.
- **Security:** The software has been tested for security vulnerabilities and all issues have been resolved.
- **Performance:** The software has been tested for performance and scalability, and all issues have been resolved.
- **Peer review.** Code is reviewed by the peers.
- **System testing.** The software has been tested end-to-end, and all system tests have passed.
- **Regression testing.** All previously implemented functionality has been tested, and regression tests have been passed.
- **Documentation.** All necessary documentation has been written, reviewed, and approved, including user manuals, API documentation, and system documentation.
- **Acceptance testing.** The functionality has been demonstrated to the product owner or customer and has been approved.
- **Deployment:** The software has been successfully deployed to the production environment, and all deployment issues have been resolved.

...

  1. Save and turn the Automation Rule On.

  2. You're done! 🎉

Now, whenever an issue meets the defined criteria (e.g., moving from one status to another), the automation rule automatically appends checklist items to the Definition of Done checklist tab, ensuring your team always has clear to-do items aligned with consistent standards ✅

...

Insert excerpt
Get Started
Get Started
namesupport-email (checklist-server)
nopaneltrue

...