Automation

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.

Issue Picker

For using Issue Picker field or populating the field in Automation rules the following format is used:

{
   "fields":{
      "customfield_id":{
         "issues":[
            {
               "label":"issueKey",
               "value":"issueKey"
            }
         ]
      }
   }
}

Customfield_id - ID of the custom field that is being used in the rule

label - Insert the issuekey of an issue that should populate the AIL field
value - Insert the issuekey of an issue that should populate the AIL field

Repeat the process for adding multiple issues in the field

{
   "fields":{
      "customfield_id":{
         "issues":[
            {
               "label":"issueKey",
               "value":"issueKey"
            },
            {
               "label":"issueKey",
               "value":"issueKey"
            }
         ]
      }
   }
}

🆕 Multilevel Select Picker

Single select

JSON format for the single select option:

Value - This is the ID of the option inside of the configuration. You can copy this ID by clicking on “Copy id” as seen on the screenshot below

Label - This is the “name” or label of the option

Multi select

JSON format for the multi select option:

Value - This is the ID of the option inside of the configuration. You can copy this ID by clicking on “Copy id” as seen on the screenshot below

Label - This is the “name” or label of the option

Multilevel Select Picker

Multilevel select picker can have only one parent therefore the JSON is a bit different.

Each option consists of two parts:

1. Value

2. Label

Value - This is the ID of the option inside of the configuration. You can copy this ID by clicking on “Copy id” as seen on the screenshot below

Label - This is the “name” or label of the option

Multilevel Select Picker (Multiple)

The correct JSON format for using the multilevel select picker field in Jira automation is the following:

On the left side is the JSON format for a multilevel select field and on the right side is the configuration of the field.

First section of the JSON is always the same except the field ID that is being utilized in the Automation rule.

Each multilevel select picker option has 4 parts to it:

1. Value

2. Label

3. Level

4. parentKey

Value - This is the ID of the option inside of the configuration. You can copy this ID by clicking on “Copy id” as seen on the screenshot below

Label - This is the “name” or label of the option

Level - This is the level of the field. Each option in the configuration has it’s level. For a parent this would be level 1, for it’s first child it would be level 2, child of level 2 would level 3, and so on…

parentKey - This is the key of the childs parent. This is the same as the Value mention above. One differnce here is it needs to be linked correctly to the childs parent. So in the case below for “Child 1.1” parentKey would be the ID(value) of the option “Parent 1”

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:

1. Construct the API URL:

   • Start with your Jira base URL.

   • Append the following endpoint to the URL:

/rest/api/3/app/field/{fieldIdOrKey}/context/configuration

• Replace {fieldIdOrKey} with the actual field ID. For example, if the field ID is customfield_10189, the complete URL would look like this:

https://your-jira-instance.com/rest/api/3/app/field/customfield_10189/context/configuration

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.g customfield_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:

1. Prepare the JSON:

   • Modify the JSON object to reflect your desired label configuration. Replace the values for color, label, and value with your specific requirements. For example:

     {
       "fields": {
         "customfield_10189": {
           "labels": [
             { "color": "#FF8F73", "label": "Auto", "value": 1712747747488 },
             { "color": "#57D9A3", "label": "Label", "value": 1712747742574 }
           ]
         }
       }
     }

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 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:

1. Construct the API URL:

   • Start with your Jira base URL.

   • Append the following endpoint to the URL:

/rest/api/3/app/field/{fieldIdOrKey}/context/configuration

• Replace {fieldIdOrKey} with the actual field ID. For example, if the field ID is customfield_10189, the complete URL would look like this:

https://your-jira-instance.com/rest/api/3/app/field/customfield_10189/context/configuration

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.g customfield_10189

The following page should open and look like this:

{"maxResults":100,"startAt":0,"total":1,"isLast":true,"values":[{"id":"10547","fieldContextId":"10548","configuration":{"currency":[{"id":"AMD","active":true,"symbol":"֏","isoCode":"AMD","currency":"Armenian dram"},{"id":"AUD","active":true,"symbol":"$","isoCode":"AUD","currency":"Australian dollar"},{"id":"BAM","active":true,"symbol":"KM","isoCode":"BAM","currency":"Bosnia and Herzegovina convertible mark"},{"id":"GBP","active":true,"symbol":"£","isoCode":"GBP","currency":"British pound"},{"id":"BND","active":true,"symbol":"$","isoCode":"BND","currency":"Brunei dollar"},{"id":"BRL","active":true,"symbol":"R$","isoCode":"BRL","currency":"Brazilian real"},{"id":"CAD","active":true,"symbol":"C$","isoCode":"CAD","currency":"Canadian dollar"},{"id":"XAF","active":true,"symbol":"FCFA","isoCode":"XAF","currency":"Central African CFA franc"},{"id":"XPF","active":true,"symbol":"₣","isoCode":"XPF","currency":"CFP franc"},{"id":"RMB","active":true,"symbol":"¥","isoCode":"RMB","currency":"Chinese Yuan"},{"id":"HRK","active":true,"symbol":"kn","isoCode":"HRK","currency":"Croatian kuna"},{"id":"COP","active":true,"symbol":"Col$","isoCode":"COP","currency":"Colombian Peso"},{"id":"CZK","active":true,"symbol":"Kč","isoCode":"CZK","currency":"Czech koruna"},{"id":"DKK","active":true,"symbol":"kr","isoCode":"DKK","currency":"Danish krone"},{"id":"XCD","active":true,"symbol":"$","isoCode":"XCD","currency":"Eastern Caribbean dollar"},{"id":"EUR","active":true,"symbol":"€","isoCode":"EUR","currency":"Euro"},{"id":"GGP","active":true,"symbol":"£","isoCode":"GGP","currency":"Guernsey pound"},{"id":"HKD","active":true,"symbol":"$","isoCode":"HKD","currency":"Hong Kong dollar"},{"id":"HUF","active":true,"symbol":"Ft","isoCode":"HUF","currency":"Hungarian forint"},{"id":"INR","active":true,"symbol":"₹","isoCode":"INR","currency":"Indian rupee"},{"id":"ILS","active":true,"symbol":"₪","isoCode":"ILS","currency":"Israeli new shekel"},{"id":"JPY","active":true,"symbol":"¥","isoCode":"JPY","currency":"Japanese yen"},{"id":"JOD","active":true,"symbol":"د.ا","isoCode":"JOD","currency":"Jordanian dinar"},{"id":"MRU","active":true,"symbol":"UM","isoCode":"MRU","currency":"Mauritanian ouguiya"},{"id":"MAD","active":true,"symbol":"د.م.","isoCode":"MAD","currency":"Moroccan dirham"},{"id":"ANG","active":true,"symbol":"ƒ","isoCode":"ANG","currency":"Netherlands Antillean guilder"},{"id":"NZD","active":true,"symbol":"$","isoCode":"NZD","currency":"New Zealand dollar"},{"id":"TWD","active":true,"symbol":"元","isoCode":"TWD","currency":"New Taiwan Dollar"},{"id":"PLN","active":true,"symbol":"zł","isoCode":"PLN","currency":"Polish złoty"},{"id":"RUB","active":true,"symbol":"₽","isoCode":"RUB","currency":"Russian ruble"},{"id":"SHP","active":true,"symbol":"£","isoCode":"SHP","currency":"Saint Helena pound"},{"id":"SGD","active":true,"symbol":"$","isoCode":"SGD","currency":"Singapore dollar"},{"id":"ZAR","active":true,"symbol":"R","isoCode":"ZAR","currency":"South African rand"},{"id":"KRW","active":true,"symbol":"₩","isoCode":"KRW","currency":"South Korean Won"},{"id":"RSD","active":true,"symbol":"дин.","isoCode":"RSD","currency":"Serbian dinar"},{"id":"SEK","active":true,"symbol":"kr","isoCode":"SEK","currency":"Swedish krona"},{"id":"CHF","active":true,"symbol":"Fr.","isoCode":"CHF","currency":"Swiss franc"},{"id":"THB","active":true,"symbol":"฿","isoCode":"THB","currency":"Thailand Baht"},{"id":"TRY","active":true,"symbol":"₺","isoCode":"TRY","currency":"Turkish lira"},{"id":"USD","active":true,"symbol":"US$","isoCode":"USD","currency":"United States dollar"},{"id":"XOF","active":true,"symbol":"CFA","isoCode":"XOF","currency":"West African CFA franc"}],"viewOptions":"left"}}]}

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:

1. Prepare the JSON:

   • Modify the JSON object to reflect your desired label configuration. Replace the values for symbol, isoCode, and description = currency with your specific requirements. For example:

     {
       "fields": {
         "customfield_10429": {
           "symbol": "US$",
           "value": 100,
           "description": "United States dollar",
           "isoCode": "USD"
         }
       }
     }

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 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

Moscow