Apps documentation
Dynamic Forms for Jira
Dynamic Forms for Jira
Version 7.x
Version 5.x and older
FAQ
Release notes
Last updated Nov 15, 2021

Synchronizing options

Learn how to synchronize options with a data source

Let’s test how objects of a JSON collection can be used as options in a select list. We’ll import a list of users from a JSON file. Then, we’ll display them in Jira in a Bundled Fields subfield of the Select list (single choice) type.

Info

In this chapter we use exemplary data provided by the JSON Placeholder page. We’ve chosen this example: https://jsonplaceholder.typicode.com/users

Adding the data source

Steps

  1. Go to Jira Administration > Manage apps.
  2. Select Data Sources from the Dynamic Forms app navigation.
  3. Click Add data source.
Dynamic Forms for Jira - Bundled Fields Data Sources: Get started
Dynamic Forms for Jira - Bundled Fields Data Sources: Get started
  1. Add a Data source name, in our case > External guests.
  2. Choose the Data source type > REST Service.
  3. Paste the REST API URL > https://jsonplaceholder.typicode.com/users
  4. Select the Authentication method > No Auth.
  5. Click Continue.
Dynamic Forms for Jira - Bundled Fields Data Sources: Configuration
Dynamic Forms for Jira - Bundled Fields Data Sources: Configuration
  1. Click Test connection.
  2. After receiving a confirmation, click Save connection.
Dynamic Forms for Jira - Bundled Fields Data Sources: Test connection with no additional parameters
Dynamic Forms for Jira - Bundled Fields Data Sources: Test connection with no additional parameters
  1. Select a JSON path to be mapped > root - COLLECTION.
  2. Provide an alias name for your JSON path > Users.
  3. Select the option ID (the attribute that identifies the object on the list) > id - NUMBER.
  4. Select the option > name - STRING.
  5. Click Add mapping.
  6. Click Continue.
Dynamic Forms for Jira - Bundled Fields Data Sources: Output mapping
Dynamic Forms for Jira - Bundled Fields Data Sources: Output mapping
  1. Click Save to confirm creating the data source.
Dynamic Forms for Jira - Bundled Fields Data Sources: Save configuration
Dynamic Forms for Jira - Bundled Fields Data Sources: Save configuration

Result

The data source is added to the Data Sources list.

Dynamic Forms for Jira - Bundled Fields Data Sources: Result
Dynamic Forms for Jira - Bundled Fields Data Sources: Result
Note

Options get automatically synchronized with the data source right after establishing the connection. Learn more about possible ways of further synchronization below.

Connecting the data source

Steps

  1. Select Bundled Fields from the Dynamic Forms app navigation.
  2. Create a new Bundled Fields custom field and name it, for example, Event information.
  3. Add a subfield that will contain your list of users > type: Select list (single choice), name: External guests.
  4. In the three dots menu, click Connect data source.
Dynamic Forms for Jira - Bundled Fields Data Sources: Connect the data source
Dynamic Forms for Jira - Bundled Fields Data Sources: Connect the data source
  1. Choose your data source > External guests.
  2. Choose a list from your data source > Users.
  3. Click Save.
  4. Save the changes to your Bundled Fields configuration.
Dynamic Forms for Jira - Bundled Fields Data Sources: Synchronization of options
Dynamic Forms for Jira - Bundled Fields Data Sources: Synchronization of options

Result

Your data source is connected to the subfield. Options in the select list synchronize with the JSON collection of users:

Dynamic Forms for Jira - Bundled Fields Data Sources: Connected subfield
Dynamic Forms for Jira - Bundled Fields Data Sources: Connected subfield
Note

The synchronization happens after saving changes to the entire Bundled Fields configuration.

Displaying the data source

Add the newly configured Bundled Field to your chosen screen and it will display the list of external users as a select list:

Dynamic Forms for Jira - Bundled Fields Data Sources: External data displayed in a Jira select list
Dynamic Forms for Jira - Bundled Fields Data Sources: External data displayed in a Jira select list

Synchronization

You can choose from three ways of synchronizing options in subfields connected to a data source:

  • No synchronization (default)
  • Manual synchronization
  • Automatic synchronization

No synchronization

By default, the options won’t be synchronized unless you take an action. This prevents overwriting the options unexpectedly and any other errors caused by changes in the external data source, while the data is already displayed in Jira issues.

Manual synchronization

Click Synchronize under the subfield type to update the subfield with the current state of your data source:

Dynamic Forms for Jira - Bundled Fields Data Sources: Manual synchronization of options
Dynamic Forms for Jira - Bundled Fields Data Sources: Manual synchronization of options
Note

This action will only synchronize the options once. To set up periodic updates, turn on the automatic synchronization.

Automatic synchronization

You can configure your subfield to be synchronized once a day.

In order to enable it, go to Bundled Fields > Settings and turn on the toggle next to Automatic synchronization:

Dynamic Forms for Jira - Bundled Fields Data Sources: Automatic synchronization of options
Dynamic Forms for Jira - Bundled Fields Data Sources: Automatic synchronization of options

Follow up

Need help?

If you can’t find the answer you need in our documentation, raise a support request.
Include as much information as possible to help our support team resolve your issue faster.