Automation for Jira
Automation for Jira is a popular tool to get your team automated by creating additional workflows, rules, and processes.
Smart Checklist can be tightly integrated with Automation and changed by its workflow.
You can Get Automation for Jira add-on on the Marketplace.
Use Cases
- 1 Set Checklist on Issue Creation
- 2 Append Checklist Items on Issue Transition
- 3 Transition an issue to the next state when all the checklist items are completed
- 4 Add Checklists to Subtasks during New Issue creation
- 5 Add Checklist to Service Management tickets for certain Request types (not a JIRA issue type)
- 6 Set checklist depending on a custom field value after issue creation
- 7 Bulk update checklists
- 8 “Adding comment/creating Jira issue” when the checklist item is completed
- 9 Create a new Jira issue when all checklist items in a “source” Jira issue are completed
- 10 Create a Sub-task when a checklist item is set to done/completed
Set Checklist on Issue Creation
This flow can also be achieved by the built-in Templates functionality of Smart Checklist. Visit this page for guidance.
Go to Automation for Jira → Automation Rules
Click Create Rule
Set When: New Trigger
Choose Issue created → Save
Add component New Condition
Set New Condition
Choose JQL condition
Add filter per Issue Type
issuetype = Bug
Save Condition
Add component New Action
Set New Action
Choose Set entity property
Choose Entity type: Issue
Set Property Key
com.railsware.SmartChecklist.checklist
Add checklist template in Markdown formatting as the property value
Save Action
Save and Turn Automation On
You're done! Now every time a "Bug" issue created - a proper Template will be added as a checklist.
Append Checklist Items on Issue Transition
This flow can also be achieved by means of the built-in functionality of Smart Checklist. Visit this page for guidance.
Go to Automation for Jira → Automation Rules
Click Create Rule
Set When: New Trigger
Choose Issue transitioned
Choose from status (e.g. Backlog) and to status (e.g. Selected for Development)
Save
Add component New Action
Set New Action
Choose Set entity property
Choose Entity type: Issue
Set Property Key
com.railsware.SmartChecklist.checklist
Add checklist template in Markdown formatting as the property value and add the following in the beginning:
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:
6. Save Action
7. Save and Turn Automation On
You're done! Now every time an issue is transitioned from Backlog to Selected for Development, the proper checklist template will be appended to your issue.
Transition an issue to the next state when all the checklist items are completed
Add trigger "When" Field Value is changed.
Add "Smart Checklist Progress" field and "Edit Issue" as For operator
Then Add "Compare Condition" automation block
Set First Value: {{issue.Smart Checklist Progress}}
Set Condition: "Exactly match regular Expression"
Set Regular expression: (^$|.*Done)
Then Add "Transition Issue" automation block
Set "Destination status", e.g. "Done"
Save the Automation Rule
Check the quick demo:
Add Checklists to Subtasks during New Issue creation
If you want to add checklists to automatically created subtasks - follow these steps.
Choose the trigger Issue created
Choose the action Create sub-tasks
List subtasks you need
Click Add fields - your subtask will be converted to a separate action step
Choose Same Project to be sure the sub-task is not lost
Add "Checklists" custom field from Choose fields to set
Then add checklist items using checklist Markup formatting. Check the detailed guide.
Save and publish the Automation Rule
Now when you create a Jira issue new sub-tasks will be created automatically
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)
Service Management Request types are Jira issue types, but specific for Service Management.
You would need to check what issue type you have for "New User Account" requests
and then create an Automation rule for this specific issue type.
E.g. If you have a Request Type called "Get IT help" and it has "Service Request" issue type:
In Automation, you would need to create a rule that would add a checklist to all the new requests of "Service Request" type
Set Trigger. When: Issue Created
Set Condition. If: Issue matches JQL
Set Action. Then: Set Issue Property
And set the value of the checklist you need
Set checklist depending on a custom field value after issue creation
Go to Automation for Jira → Automation Rules
Click Create Rule
Set When: New Trigger
Choose Issue created → Save
Add component New Condition
Set New Condition
Choose Issue fields condition
Select your needed custom field
Choose the condition equals
Add the value of your custom field
Save Condition
Add component New Action
Set New Action
Choose Set entity property
Choose Entity type: Issue
Set Property Key
Add checklist template in Markdown formatting as the property value
Save Action
Save and turn the Automation Rule On
You're done! Now every time an issue with a defined custom field value is created - a proper Template will be added as a checklist.
Bulk update checklists
Implementation instruction
Go to Automation for Jira → Automation Rules
Click Create Rule
Set When: Field value changed Change
Choose Checklists → Save
Add component New Action
Choose Set entity property
Choose Entity Type: Issue
Set Property Key
Add the following to the Property value
Save
Save the rule and Turn Automation On
Proceed with the bulk update.
Once the bulk update is completed, turn the rule off.
“Adding comment/creating Jira issue” when the checklist item is completed
You can set Automation to create a request in a Jira Service Management project based on the status of a single item in a checklist.
Create Rule.
Set Trigger → Field value changed, choose Smart Checklist Progress as a field to monitor for changes. Save.
Set New condition → Issue field condition.
Fill Field → Checklists, Condition → contains, set the needed Value/Field. And Save.
Here’s how it looks:
Create a new Jira issue when all checklist items in a “source” Jira issue are completed
You can set the Automation rule to create a new Jira issue if all the checklist items at the "source" issue are marked as completed.
Create Rule.
Set Trigger → Field value changed, choose Smart Checklist Progress as a field to monitor for changes. Save.
Set New condition → Advanced compare condition.
Fill First value → {{issue.Smart Checklist Progress}}, Condition → exactly matches regular expression, Regular Expression → (^$|.*Done). Save
Here’s how it looks:
5. Add Action → Create issue
6. Save the rule and Turn Automation On
Create a Sub-task when a checklist item is set to done/completed
You can set the Automation rule to create a sub-task (or any other issue type that is required) when a checklist item is marked as done/completed.
Go to Settings → System → Automation for Jira → Automation rules.
Click Create rule.
Choose the trigger Field value changed, and choose Smart Checklist Progress as a field to monitor for changes. Save.
Set New condition → Advanced compare condition.
Fill First value → {{fieldChange.fromString}}, Condition → does not equal. Save.
Here’s how it looks:Set New condition → Advanced compare condition.
Fill First value → {{fieldChange.fromString.remove(“ - Done”).substringBefore(“/”)}}, Condition → less than, Second value → {{fieldChange.toString.remove(“ - Done”).substringBefore(“/”)}}. Save.
Here’s how it looks:Add Action → Create issue, Project → Same project, Issue type → Sub-task (or any other), Parent issue → Current issue, fill Summary and Description.
Save the rule and Turn Automation On.