Automation Rules
Jira Automation empowers teams to automate repetitive tasks, saving time and reducing errors. With Fields custom fields, you can extend the power of automation by incorporating specific data points tailored to your unique workflows.
While custom fields offer tremendous flexibility, integrating them into Jira Automation requires a slightly different approach. This guide will help you navigate these nuances and make the most of your custom fields within automation, enabling you to build smarter, more efficient processes.
Need Help? If you're facing challenges with integrating custom fields into Jira Automation, we’re here to assist. Book a demo call with us, and mention your specific issue so we can provide tailored support.
Table of Contents
Issue Picker
Once you have the necessary JSON structure, you can incorporate it into your Jira automation rules. Follow these steps to set up Issue Picker:
Step 1: Prepare the JSON
Modify the JSON object to reflect your desired Issue Picker configuration. Basic JSON for a single and multiple issue links:
{
"fields": {
"customfield_id": {
"issues": [
{
"label": "issueKey",
"value": "issueKey"
}
]
}
}
}
{
"fields": {
"customfield_id": {
"issues": [
{
"label": "issueKey1",
"value": "issueKey1"
},
{
"label": "issueKey2",
"value": "issueKey2"
}
]
}
}
}
Replace the customfield_id this with the ID of the custom Issue Picker field.
Replace the "label" with the issue key that you want to appear as the label.
Replace the "value" with the issue key that you want to populate in the Issue Picker field.
Step 2: Integrate the JSON into Automation
Go to your Jira instance and navigate to Project Settings > Automation.
Create a new rule or edit an existing one where you want to apply the Issue Picker.
In the rule editor, select the Edit Issue action.
Choose the custom field where the Issue Picker should appear.
Paste the modified JSON into the appropriate field to set the label after a transition, during issue creation, or any other workflow action.
Multilevel Select Picker
Modify the JSON object to reflect your desired Multilevel Select Picker configuration. Basic JSON for a single and multiple select pickers:
Value: This is the ID of the option inside of the configuration. You can copy this ID by clicking on “Copy id” from the picker configuration.
Label: This is the “name” or label of the option
{
"fields":{
"customfield_10089":{
"choice":[
{
"label":"Parent 1",
"value":1676970224591,
"children":[
{
"label":"Child 1",
"value":1676970238919,
"children":[
{
"label":"Child 1.1",
"value":1676970381270,
"children":[]
}
]
}
]
}
],
"isMultiple":false
}
}
}
How to copy value from one multilevel field and add it to a summary
For all possibilites and Jira smart values visit the following link:
https://confluence.atlassian.com/automation/jira-smart-values-lists-993924868.html
These also work on Cloud
In order to copy a value from the multilevel field you will need to go through a couple of steps. Start by using the following link to get a list of all of the custom fields on an issue and their values.
<your-instance-URL>/rest/api/3/issue/<issuekey>
You can download a Chrome extension called JSON formatter which will make the overview of this much much nicer. After you’ve done that locate the multilevel field and its' options like so:
For an example, if you were to use the “Melee ADC” option as a summary for an issue you would use the following line of code in the automation rule:
{{issue.fields.customfield_<fieldID>.choice.get(<number of option>).label}}
This will then take the 4th option from the field value and add it as a summary(in this example case). To copy the current value from the field and add it to summary or another field thies query can be used:
{{issue.fields.customfield_ID.choice.label}}
ID → custom field ID
Colored Labels
Step 1: Retrieve the field configuration
To begin, you need to obtain the field configuration for the custom field where you intend to apply colored labels. You can do this by using the Jira REST API. Follow the steps below:
Start with your Jira base URL.
Append the following endpoint to the URL:
Replace
{fieldIdOrKey}
with the actual field ID. For example, if the field ID iscustomfield_10189
, the complete URL would look like this:
Copy the base instance URL and paste the REST API call above following the base URL.
Replace the
{fieldIdOrKey}
with the actual field ID, e.gcustomfield_10189
The following page should open and look like this:
Step 2: Configure Colored Labels in Automation rules
Once you have the necessary JSON structure, you can incorporate it into your Jira automation rules. Follow these steps to set up colored labels:
Modify the JSON object to reflect your desired label configuration. Replace the values for
color
,label
, andvalue
with your specific requirements. For example:
Go to your Jira instance and navigate to Project Settings > Automation.
Create a new rule or edit an existing one where you want to apply the colored labels.
In the rule editor, use the Edit Issue action.
Select the custom field where the colored labels should appear.
Paste the modified JSON into the appropriate field to set the label after a transition, during issue creation, or any other workflow action.
Currency
Step 1: Retrieve the field configuration
To begin, you need to obtain the field configuration for the custom field where you intend to apply currency. You can do this by using the Jira REST API. Follow the steps below:
Start with your Jira base URL.
Append the following endpoint to the URL:
Replace
{fieldIdOrKey}
with the actual field ID. For example, if the field ID iscustomfield_10189
, the complete URL would look like this:
Copy the base instance URL and paste the REST API call above following the base URL.
Replace the
{fieldIdOrKey}
with the actual field ID, e.gcustomfield_10189
The following page should open and look like this:
Step 2: Configure Currency in Automation rules
Once you have the necessary JSON structure, you can incorporate it into your Jira automation rules. Follow these steps to set up currency:
Modify the JSON object to reflect your desired label configuration. Replace the values for
symbol
,isoCode
, anddescription = currency
with your specific requirements. For example:
Go to your Jira instance and navigate to Project Settings > Automation.
Create a new rule or edit an existing one where you want to apply the currency.
In the rule editor, use the Edit Issue action.
Select the custom field where the currency should appear.
Paste the modified JSON into the appropriate field to set the label after a transition, during issue creation, or any other workflow action.
Unit
Step 1: Retrieve the Field Configuration
To begin, you need to obtain the field configuration for the custom field where you intend to apply unit. You can do this by using the Jira REST API. Follow the steps below:
Start with your Jira base URL.
Append the following endpoint to the URL:
Replace
{fieldIdOrKey}
with the actual field ID. For example, if the field ID iscustomfield_10189
, the complete URL would look like this:
Copy the base instance URL and paste the REST API call above following the base URL.
Replace the
{fieldIdOrKey}
with the actual field ID, e.gcustomfield_10189
The following page should open and look like this:
Step 2: Configure Unit in Automation rules
Once you have the necessary JSON structure, you can incorporate it into your Jira automation rules. Follow these steps to set up unit:
Modify the JSON object to reflect your desired label configuration. Replace the values for
id
,value
,abbreviation
, anddescription
with your specific requirements. For example:
Go to your Jira instance and navigate to Project Settings > Automation.
Create a new rule or edit an existing one where you want to apply the unit.
In the rule editor, use the Edit Issue action.
Select the custom field where the unit should appear.
Paste the modified JSON into the appropriate field to set the label after a transition, during issue creation, or any other workflow action.
MoSCoW
Step 1: Configure MoSCoW in Automation rules
Once you have the necessary JSON structure, you can incorporate it into your Jira automation rules. Follow these steps to set up Moscow:
Modify the JSON object to reflect your desired Moscow configuration. Replace the values with one of the four options
"Must", "Should", "Could", "Won't"
. For example:
Go to your Jira instance and navigate to Project Settings > Automation.
Create a new rule or edit an existing one where you want to apply the Moscow.
In the rule editor, use the Edit Issue action.
Select the custom field where the Moscow should appear.
Paste the modified JSON into the appropriate field to set the label after a transition, during issue creation, or any other workflow action.
Traffic Lights
Step 1: Configure Traffic Lights in Automation rules
Once you have the necessary JSON structure, you can incorporate it into your Jira automation rules. Follow these steps to set up Traffic Lights:
Modify the JSON object to reflect your desired Traffic Lights configuration. Replace the values with one of the three options
"red", "yellow", "green"
. For example:Go to your Jira instance and navigate to Project Settings > Automation.
Create a new rule or edit an existing one where you want to apply the Traffic Lights.
In the rule editor, use the Edit Issue action.
Select the custom field where the Traffic Lights should appear.
Paste the modified JSON into the appropriate field to set the label after a transition, during issue creation, or any other workflow action.
T-Shirt Size
Step 1: Configure T-Shirt Size in Automation rules
Once you have the necessary JSON structure, you can incorporate it into your Jira automation rules. Follow these steps to set up T-Shirt Size:
Modify the JSON object to reflect your desired T-Shirt Size configuration. Replace the values with one of the active options you have in configuration →
"XXS", "XS", "S", "M", "L", "XL", "XXL"
. For example:
Go to your Jira instance and navigate to Project Settings > Automation.
Create a new rule or edit an existing one where you want to apply the T-Shirt Size.
In the rule editor, use the Edit Issue action.
Select the custom field where the T-Shirt Size should appear.
Paste the modified JSON into the appropriate field to set the label after a transition, during issue creation, or any other workflow action.
Issue Rating
Step 1: Configure Issue Rating in Automation rules
Once you have the necessary JSON structure, you can incorporate it into your Jira automation rules. Follow these steps to set up Issue Rating:
Modify the JSON object to reflect your desired Issue Rating configuration. Replace the values with one of five options
"1-star", "2-star", "3-star", "4-star", "5-star"
. For example:
Go to your Jira instance and navigate to Project Settings > Automation.
Create a new rule or edit an existing one where you want to apply the Issue Rating.
In the rule editor, use the Edit Issue action.
Select the custom field where the Issue Rating should appear.
Paste the modified JSON into the appropriate field to set the label after a transition, during issue creation, or any other workflow action.
Progress Bar
Step 1: Configure Progress Bar in Automation rules
Once you have the necessary JSON structure, you can incorporate it into your Jira automation rules. Follow these steps to set up Progress Bar:
Modify the JSON object to reflect your desired Progress Bar configuration. Replace the value with number between 0 - 100. For example:
Go to your Jira instance and navigate to Project Settings > Automation.
Create a new rule or edit an existing one where you want to apply the Progress Bar.
In the rule editor, use the Edit Issue action.
Select the custom field where the Progress Bar should appear.
Paste the modified JSON into the appropriate field to set the label after a transition, during issue creation, or any other workflow action.
Abbreviate Numbers
Step 1: Configure Abbreviate Numbers in Automation rules
Once you have the necessary JSON structure, you can incorporate it into your Jira automation rules. Follow these steps to set up Abbreviate Numbers:
Modify the JSON object to reflect your desired Abbreviate Numbers configuration. Replace the value with number. For example:
Go to your Jira instance and navigate to Project Settings > Automation.
Create a new rule or edit an existing one where you want to apply the Abbreviate Numbers.
In the rule editor, use the Edit Issue action.
Select the custom field where the Abbreviate Numbers should appear.
Paste the modified JSON into the appropriate field to set the label after a transition, during issue creation, or any other workflow action.
Decimal Numbers
Step 1: Configure Decimal in Automation rules
Once you have the necessary JSON structure, you can incorporate it into your Jira automation rules. Follow these steps to set up Decimal:
Modify the JSON object to reflect your desired Decimal configuration. Replace the value with number. For example:
Go to your Jira instance and navigate to Project Settings > Automation.
Create a new rule or edit an existing one where you want to apply the Decimal.
In the rule editor, use the Edit Issue action.
Select the custom field where the Decimal should appear.
Paste the modified JSON into the appropriate field to set the label after a transition, during issue creation, or any other workflow action.