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

• Multilevel Select Picker

• Colored Labels

• Currency

• Unit

• Moscow

• Traffic Lights

• T-Shirt Size

• Issue Rating

• Progress Bar

• Abbreviate Numbers

Issue Picker

Step 1: Configure Issue Picker 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 Picker:

1. Prepare the JSON:

   • Modify the JSON object to reflect your desired Issue Picker configuration.

     Basic JSON for a single issue link:

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

   • customfield_id: Replace this with the ID of the custom Issue Picker field.

   • "label": Replace this with the issue key that you want to appear as the label.

   • "value": Replace this with the issue key that you want to populate the Issue Picker field.

JSON for multiple issue links:

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

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, use the Edit Issue action.

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

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

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

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:

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":"10567","fieldContextId":"10568","configuration":{"unit":[{"id":"second","label":"second","active":true,"description":"The second (s) is the unit of time.","abbreviation":"s"},{"id":"meter","label":"meter","active":true,"description":"The metre (m) is the unit of length.","abbreviation":"m"},{"id":"kilogram","label":"kilogram","active":true,"description":"The kilogram (kg) is the unit of mass.","abbreviation":"kg"},{"id":"liter","label":"liter","active":true,"description":"The liter (L) is the unit of volume.","abbreviation":"L"},{"id":"kelvin","label":"kelvin","active":true,"description":"The kelvin (K) is the unit of thermodynamic temperature.","abbreviation":"K"},{"id":"amper","label":"amper","active":true,"description":"The ampere (A) is the unit of electric current.","abbreviation":"A"},{"id":"mole","label":"mole","active":true,"description":"The mole (mol) is the unit of amount of substance.","abbreviation":"mol"}]}}]}

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:

1. Prepare the JSON:

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

     {
       "fields": {
         "customfield_10429": {
           "id": "kilogram",
           "value": 100,
           "abbreviation": "kg",
           "description": "The kilogram (kg) is the unit of mass."
         }
       }
     }

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

1. Prepare the JSON:

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

     {
       "fields": {
         "customfield_10429": "Must"
       }
     }

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

1. Prepare the JSON:

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

     {
       "fields": {
         "customfield_10429": "red"
       }
     }

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

1. Prepare the JSON:

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

     {
       "fields": {
         "customfield_10429": "XXS"
       }
     }

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

1. Prepare the JSON:

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

     {
       "fields": {
         "customfield_10429": "1-star"
       }
     }

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

1. Prepare the JSON:

   • Modify the JSON object to reflect your desired Progress Bar configuration. Replace the value with number between 0 - 100. For example:

     {
       "fields": {
         "customfield_10429": "50"
       }
     }

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

1. Prepare the JSON:

   • Modify the JSON object to reflect your desired Abbreviate Numbers configuration. Replace the value with number. For example:

     {
       "fields": {
         "customfield_10429": 1200000
       }
     }

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

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:

1. Prepare the JSON:

   • Modify the JSON object to reflect your desired Decimal configuration. Replace the value with number. For example:

     {
       "fields": {
         "customfield_10429": 12345
       }
     }

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