The different field types
Table of contents
Live or Snapshot field?
Elements Connect fields are grouped in two categories: Snapshot and Live. This sections explains the difference between them and help you decide which one you should use, according to your needs.
The main difference between a Snapshot and a Live field is when they fetch data from their datasources.
Snapshot
NEW IN V6
Snapshot fields get data from their datasource only when they are edited. When they are displayed, the data is read from Jira database.
Unlike Live fields, they store their display value in Jira database and their display is the same in all views.
You can update the value of a Snapshot field:
- by editing the issue
- with an Elements Connect post function
- using Elements Connect action in Automation for Jira
A field value which no longer exists in the datasource is not lost when editing.
Live
Live fields get data from their datasource when they are edited and displayed.
Example
Let's say we want to store an exchange rate in a Connect field.
Every day, this exchange rate changes, this table shows the value displayed according to the field category:
| Time | Official exchange rate | Snapshot | Live |
|---|---|---|---|
| Issue creation | 1.10 | 1.10 | 1.10 |
| +1 day | 1.12 | 1.10 | 1.12 |
| +2 days | 1.17 | 1.10 | 1.17 |
Main differences
| Snapshot | Live | |
|---|---|---|
| Always display up to date information | NO | YES |
| Ease of configuration | EASY Because of their simplicity, snapshot fields require less configuration work than live fields | From EASY to COMPLEX Depending on your needs and the datasource you're using |
| Impact on performances | LOW Datasource is called only when the field is edited | MEDIUM Datasource is called every time a Live field is edited or displayed. Depending on how fast the datasource is, it can have impact on the performances. See Improve performances. |
| Single value | YES | YES |
| Multi values | NO | YES |
| Different edit and display rendering | NO | YES |
| No data loss on edit when a value no longer exists | YES | NO |
| Can be used as dependency | DEPENDS Because Snapshot fields do not store a key, when they are used as a dependency in another query, they are evaluated to their display value | YES |
| Compatible with third party app | YES | PARTIAL Because of the storage format of the Live fields, not all apps are compatible with Elements Connect Live fields. To be compatible, they should use the Java API. |
Field names in v5
With Elements Connect v6, fields have been renamed, the following table lists the changes:
| v5 name | v6 name |
|---|---|
| Standard | Live Text |
| User | Live User |
| Deprecated | Live Text (legacy) |
| Date | Snapshot Date |
| Datetime | Snapshot Datetime |
The Snapshot Text field is a new feature of Elements Connect 6.
The different field types
See storage format page for more information about how fields are stored in database.
| Name | Description |
|---|---|
Live text | These fields are visible in the Detail section of the issue view. They are used to store text. It's the most common field type that suits most use cases. They always display a "live" template - their snapshot equivalent is the Snapshot text field. If you want to manipulate the value stored in a Live text field in a Script, you must use the Java API. If you want to learn more about storage format in the dedicated storage format page. |
Live user | These fields are displayed in the User section of the issue view. They behave exactly like a regular Jira User field - they can be used:
They always display a "live" template - they don't have a Snapshot equivalent. Only active Jira users can be selected in an Elements Connect Live User field Related troubleshooting articles: |
Live text (legacy) | This field type was the standard field type before Elements Connect 5.9 where the compatibility with Jira Service Management has been added. It will never be removed but we discourage the usage of this field type for new configurations. If you have "Live text (legacy)" fields configured, you can keep using them. NOT COMPATIBLE WITH JSM |
Snapshot text |
Field value which no longer exists in the datasource is not lost when editing. You can manipulate the value of these fields in a scripts the same way you'd do it with a regular text field |
Snapshot date |
Field value which no longer exists in the datasource is not lost when editing. |
Snapshot datetime |
Field value which no longer exists in the datasource is not lost when editing. |