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

Adding a data source

Learn how to configure a data source

To better understand how Data Sources work, let’s use data from Jira itself - an example everyone is most familiar with. In the following configuration we’ll retrieve the issue summary, status, and assignee using Jira REST API. Then, we’ll display the values in Bundled Fields' subfields.

Get started

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

Result

The Data Sources Configuration wizard opens.

Configuration

On this screen you’ll define the basic details of your data source.

Steps

  1. Add a Data source name. It will be displayed:

    • in the Data Sources list
    • while connecting this data source in the Bundled Fields Configuration
  2. Choose the Data source type according to the format of your data source.

    • Currently we support only REST Services.
  3. Paste the REST API URL of your data source.

    Note

    If you’d like to configure your Rest API URL to use changing parameters, put the parameters in curly quotes. Examples:

    Path parameter
    https://jsonplaceholder.typicode.com/users/{param}

    Query parameter
    http://universities.hipolabs.com/search?name={param1}&country={param2}

  4. Select the Authentication method:

    • No Auth
    • Basic (authorization with a username and password)
  5. If you selected Basic, provide your login credentials.

  6. Click Continue.

Dynamic Forms for Jira - Bundled Fields Data Sources: Configuration
Dynamic Forms for Jira - Bundled Fields Data Sources: Configuration

Result

The Connection configuration screen opens.

Test connection

Now it’s time to test the connection to your external data. Depending on whether your REST API URL includes additional parameters, you have two options for testing the connection:

  • No additional parameters
  • Additional parameters in the URL

No additional parameters

Steps

  1. Click Test connection.
  2. After receiving a confirmation that the connection has been established, 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

Additional parameters in the URL

If you provided a URL with additional parameters, the app will display a list of them to verify their values.

Example

If you’d like to display chosen values of specific Jira issues, you may use the issueKey parameter in your URL. At this point you will be asked to provide a valid issue key as a value. This will cover two necessary steps:

  • testing if the URL path you provided is correct
  • fetching the data that will be used later for mapping parameters of your data source to Bundled Fields' subfields

Steps

  1. Provide values for the parameters.
  2. Click Test connection.
  3. After receiving a confirmation that the connection has been established, click Save connection.
Dynamic Forms for Jira - Bundled Fields Data Sources: Test connection with additional parameters
Dynamic Forms for Jira - Bundled Fields Data Sources: Test connection with additional parameters

Result

You progress to the next configuration step - the Output mapping.

Output mapping

On this screen you’ll see a preview of your data source. The names you provide for JSON paths and objects will be used later for connecting them to Bundled Fields' subfields. Scroll down to read the descriptions.

Dynamic Forms for Jira - Bundled Fields Data Sources: Output mapping
Dynamic Forms for Jira - Bundled Fields Data Sources: Output mapping

Steps

  1. Select a JSON path to be mapped.
  2. Provide an alias name for your JSON path. If the JSON path you’ve selected is a list, additional fields for mapping the options will appear:
    • option ID (the attribute that identifies the object on the list)
    • option label (attribute that is the object’s label)
  3. Click Add mapping. It will appear in the list below.
  4. When all mappings are ready, click Continue.

Result

You progress to the final configuration screen - Summary.

Summary

The last screen is a summary of you configuration. It allows you to check all the details before the final confirmation.

Steps

  1. Review the following details (if anything isn’t right, click Back to make a correction):
    • REST API URL of your data source
    • Parameteres detected in your URL (if you added any)
    • JSON path mappings created for the JSON paths of your source data
  2. Click Save to confirm creating the data source.
Dynamic Forms for Jira - Bundled Fields Data Sources: Summary
Dynamic Forms for Jira - Bundled Fields Data Sources: Summary

Result

The data source is added to the Data Sources list.

Dynamic Forms for Jira - Bundled Fields Data Sources: Configuration result
Dynamic Forms for Jira - Bundled Fields Data Sources: Configuration result
Note

The data source is active, but you still need to connect it to a Bundled Fields' subfield to make it work.

Next steps

Need help?

If you can’t find the answer you need in our documentation, raise a support request.