要約

This documentation aims to answer commonly asked questions about Data Connection in Forms (formerly known as ProForma).

このページの内容

• What is Data Connection?
• Is there a limit on the number of results that can be populated in Jira? Would it cause performance issues?
• What are the other factors that could affect performance?
• Is there a better option to have several options and not affect Jira's performance?
• What is the functionality of Cache Results? How does it work?
• What are the statuses in Data Connection?
• How to confirm if the Data Connection is functional?

What is Data Connection?

Data Connection integrates with Forms, allowing you to retrieve JSON data from REST APIs and use it to populate choice lists on Forms.

• Create, edit, test, or delete data connections for forms
  
  
• Add or unlink a data connection from a form

Is there a limit on the number of results that can be populated in Jira? Would it cause performance issues?

There is no limit to the number of options available; however, using too many may result in performance issues.

Jira itself has a limit of 10k options for a select list custom field. Using data connection, it’s possible to have more than 10k options, but be aware that Forms data connections will retrieve all the data from the provided external REST service at once, and it then processes all the data and sends all the choices to the browser at once. It doesn’t make any attempt to paginate that data or break it up into smaller groups, and so when there are many choices it is a lot of data to load at once.

What are the other factors that could affect performance?

1. The service that Jira is getting the choices from.

2. The cache setting (based on how frequently the data needs to be updated).

3. The browser and system resources.

Is there a better option to have several options and not affect Jira’s performance?

When there are a large number of choices, the best option is to use Assets (available in Jira Premium and Enterprise plans).

これには、次のような理由があります。

When querying Assets only a subset of the choices are retrieved at once and then as you search and browse in the dropdown it loads further choices as needed. That means the Assets fields don’t slow down as the number of choices gets bigger, and so once there is a very large number of choices Assets will perform much faster than Forms data connections.

What is the functionality of Cache Results? How does it work?

The Cache Results setting is used so the data can be cached in Jira so it prevents multiple requests from being made on the Data Connection endpoint. The caching is only intended to make the Data Connection choices more performant.

Example: Configuring a new Data Connection with a cache value of 5 minutes, and the service goes down. After 5 minutes (of the choices being available from the cache), loading the Form Builder, Portal, Issue View, and Issue Forms (with a form with a field linked to the Data Connection) would have no choices available.

What are the statuses in Data Connection?

There are three statuses (Ok, Failing, and Deleted), but only two will show up on the Data Connection: OK and DELETED.

When the data connection is successfully created, edited, or updated, the status is OK.

The DELETED status is self-explanatory.

The data connection FAILING status only appears when getting choices from the Form Builder.

The Form data connections list only loads the list from storage. It doesn’t update the statuses (e.g. it does not check that the Data Connection is currently OK or FAILING). When loading the data connection choices (in the Form Builder, or on a Form) the choices wouldn’t be available.

How to confirm if the Data Connection is functional?

As mentioned above, the FAILING status doesn’t appear on the Data Connection configuration page, so to confirm if the status is indeed OK, the best option is to access the Data Connections ( > Issues > Data Connections) and go to the Test step. If there are any problems with the connection, an error will appear. Example:

Feature requests:

• JRACLOUD-78621 - Forms Data Connector to Support Pagination

• JSDCLOUD-13032 - Ability to stop data connections from loading that aren't linked to Form fields

• JSDCLOUD-10894 - Forms: Support linking Data connection field to a Jira field

• JSDCLOUD-10700 - Form Data Connection: Support more authentication options

• JSDCLOUD-10852 - Form Data Connections: Support to Google Sheets data or excel/CSV data

Documentation:

• Use forms in Jira Service Management
• JSM Form load time is slow