Field Options Sync

Choose Field Option Sync if you want to sync an external list of values with a native Jira custom field (select list or cascading). Note: You need a pre-existing custom target field (select or multicheckboxes) to successfully complete a Field Options Sync configuration.

Supported Jira custom fields:

• Select List (single choice)

• Select List (multiple choice)

• Select List (cascading)

• Radio Buttons

• Checkboxes

Setup

Data Source

After selecting a data source, the raw result of your data is being displayed below.

Example:

{
  "result": [
    {
      "id": 1,
      "name": "Mario Speedwagon",
      "role": "Owner",
      "alias": null
    },
    {
      "id": 2,
      "name": "Anna Sthesia",
      "role": "Developer",
      "alias": "Anna"
    }
  ]
}

Adding JSON Paths

Add the JSON paths referring to your data list. Make sure that your JSON path points to an actual list at Select List.

Your Unique ID is used to identify a selected value within your data set later on and must be a unique number or string (the same JSON path can be used in the value field and the search field).

Label is the value that is going to be displayed in the target Jira field later on. You can add multiple values here by putting them in curly brackets, like for example {$.role} - {$.alias}.

Warning: Activating Force Delete will unrecoverably delete missing values instead of just disabling them.

Result Type

Result Type will give you different options of how your data is being handled and mapped further on. The following options are available:

Note: When choosing list, any new data will be added without updating the list as a whole. If you want your list to be updated upon any changes, choose dictionary instead (recommended).

Dictionary vs List

The main difference between these two types is that list adds any new or changed value to the existing list, while dictionary can update existing values based on the mapping of the unique ID to its field option.

Sorting

You can choose whether your data will be sorted alphabetically (ascending/descending) or whether the data will be displayed in it’s original order.

Target Jira Field

Select the target custom field of your choice. Only pre-existing fields, which are supported for field options synchronization (as listed above), are visible in this step.

Target Context 

Select the context to sync to. Automatic will choose the default context if available or the first available. This only needs to be changed if you want to target different contexts of the same Jira field.

Update Interval

Define how often the field will be updated. Try to find a reasonable time frame depending on the amount of changes you expect within a certain timeframe. Need a lower interval? Please contact the support. We will check the options on a case-by-case basis.

Handling of missing values

The app enables and disables values autonomously for you. In case a value is missing, it will be disabled in Jira by the app (and re-enabled if the value reappears).

Warning! Activating Force Delete (see above) will unrecoverably delete missing values instead of just disabling them.

Duplicates

As Jira does not allow duplicate field options, the app is filtering them out when detected. In some cases, this can lead to unexpected edge cases. Please make sure to not allow duplicates on the data source level.

Sync Error Notifications

In the Settings section you can determine if you want to receive error notifications. If activated, you’ll receive an email right after an error happens – but only once a day to prevent spam.

API Token (legacy)

API Token is no longer necessary and has been removed.