Table of Contents
Overview
This guide page illustrates what you can expect when the field synchronization has been configured on a mapping.
Notice that not all fields defined on your JIRA Jira instances are available for synchronization.
...
In particular, you can expect a different behavior with respect to the following groups of fields:
- Comment
- Attachment
- Summary , and Description and Custom fields
- Component, Affect Version and Fix Version
- Priority, Assignee and Reporter
- Custom Fields.
Consider that the synchronization is active on issue creation, editing and linking.
...
While on issue editing the sync type both is naturally provisioning, on issue creation and/or linking the add-on app behavior follows some established conventions that are going to be detailed for:
...
Anchor field-available field-available
Fields availability and Fields mapping around different field’s type
| field-available | |
| field-available |
Fields availability
All JIRA default fields are available for The set of Jira fields available for a syncing on a Fields mapping configuration .include:
- Affected version
- Assignee
- Attachments
- Comment
- Component
- Description
- Due Date
- Fix version
- Priority
- Reporter
- Summary
Custom fields available for a field syncing configuration are:
- Text Field (single
...
- and multi line)
- Number field
- third party custom fields (e.g. the Tempo "Customer Account" custom field) recognized to be text type
...
Fields mapping around different field’s type
...
From
...
To
...
Allowed
...
Text Field (multi line)
...
Text Field (single line)
...
...
Summary, Description, Custom fields
...
Affect/Fix Versions
...
...
Summary, Description, Custom fields
...
Priority
...
...
Summary, Description, Custom fields
...
Assignee
...
- Select List (single and multiple choice) - (for Local Partnership exclusively)
- Radio Buttons - (for Local Partnership exclusively)
- Checkboxes - (for Local Partnership exclusively)
- Select List (cascading) - (for Local Partnership exclusively)
- User and Group Picker.
- Data Picker
- Data Time Picker
Fields mapping around different field types
Exception made for the following fields, you are able to create a field mappings between the same JIRA field types.
| Summary | Description |
Priority | Summary, Description, |
Component
Text field |
| Affect Versions |
| Fix |
Assignee
Summary, Description, Custom fields
| Versions |
Component
Assignee
Reporter
Reporter
Assignee
Component
Summary, Description, Custom fields
Fix/Affect Versions
Summary, Description, Custom fields
Text Field (single line) | Text Field (multi line) |
Select List (single choice) | Radio Buttons |
Select List (multiple choices) | Check-boxes |
Custom fields (Text Field) | Priority |
Summary, Description | Text Field (single line),Text Field (multi line) |
Allowable fields for Sync on create
...
- populate the issue create screen opened on Herzum quick action button
- populate an issue created via the escalate issue post function.
The mentioned setting is available for mostly of the listed fields available for a field mapping, the only fields not still allowed to have this setting are .
This option is not available for Comments, Attachment Assignee and Reporter.
Anchor attachment attachment
Attachment’s Syncing behavior
| attachment | |
| attachment |
...
Notice that the comments added by the user, that are candidates to be synced, are managed by the add-onapp, so that they can be associated to the synced comment created by the system, by following the following convention:
- a comment added by the user includes the following header: Comment synced by HQL (id:<Issue id>)
- a comment added by the system includes the following header: Comment synced by HQL (<Partnership Id>: <Issue id>)
Notice that sync behavior is the same for Partnerships configured across the same or different source and destination Url/s.
...
On issue linking via the Quick actions buttons, all and only the comments added by the user on the linked issue are synced on the source issue.
Anchor Summary
| Summary |
...
Description Summary
| Description | |
| Summary |
...
Description
Summary, Description
| Description |
...
, Assignee, Reporter and Due Date
Sync behavior for the fields Summary, Description, Custom fields, Assignee, Reporter is Reporter and Due Date is the same for Partnerships configured across the same or different source and destination Url/s.
...
The major aspect differs those specific fields from the other type of synchronization is that sync can fail due to different Versions and Components settings across different projects and/or JIRA Jira instance.
When sync fails due to the mentioned scenario, Comments are logged to alert the user for syncing failure. See General troubleshooting guidelines for further information on this topic.
Notice that when sync fails as default the add-on app set to Null the value of the target field. An exception is made for field configured to be required where the existing value is retained.
...
- on issue creation and linking via the Quick actions buttons the issue create screen will not be populated by having the values of the source issue
- on issue creation via the Escalate issue post function the issue will not be populated by having the values of the source issue.
Anchor CustomFields CustomFields
Custom fields
| CustomFields | |
| CustomFields |
Sync behavior for Text Field (single and multi line), User and Group Picker, Number Field and Date Picker is the same case of Local Partnership (same source and destination Url) or Remote Partnership (different source and destination Url/s).
The Select list, Radio button and Checkboxes can be synced only toward a Local Partnership.
Depending by the configured sync versus you can expect the syncing behavior described below.
Sync versus is Both
On issue creation via the Quick actions buttons, data are synced from the created issues to the source and, if other synchronizations have been configured on the source issue, syncing is propagated again indefinitely.
On issue creation via the Escalate issue post function, data are synced from the source issue to the target when Sync on create is set to true, syncing is not active on issue creation if Sync on create is set to false.
On linking an existing issue, data are synced from the linked issues to the source and, if other synchronizations have been configured on the source issue, syncing is propagated again indefinitely.
Sync versus is source versus target
On issue creation via the Quick actions buttons, data are synced from the source issue to the created issue.
On issue creation via the Escalate issue post function, data are synced from the source issue to the target when Sync on create is set to true, syncing is not active on issue creation if Sync on create is set to false.
On linking an existing issue, data are synced from the source issue to the created issue and, if other synchronizations have been configured on the linked issue, syncing is propagated again indefinitely.
Sync versus is target versus source
On issue creation via the Quick actions buttons, data are synced from the created issue to the source issue.
On issue creation via the Escalate issue post function, data are not synced.
On linking an existing issue, data are synced from the linked issue to the source issue and, if other synchronizations have been configured on the source issue, syncing is propagated again indefinitely.
| Info |
|---|
In order to allow synchronization working as expected, the field configuration of the target project must include the custom field. Furthermore, the Select List, Radio Buttons and Check-boxes Options must be consistent across the synced source and target fields. If the selected options cannot be synced on the target issue, an alert is logged on the source and on the target issues comments.
|
Issue History updates due to synchronization
...