Details of Jira fields that are synchronized to Jira Align
Summary
When the Jira Connector is used to link Jira to Jira Align, Jira Stories and Epics are synchronized to Jira Align as Stories and Features.
This article discusses which Jira fields are involved in the synchronization and covers:
- Fields that must sync
- Fields that can optionally sync
- Fields that can be set to Required in the Jira Field Configuration and then not affect sync
Environment
Jira Align
Solution
There are 3 areas of Jira fields that are involved with the sync from Jira to Jira Align. The following sections provide the details for each area.
The details are correct at the time of writing, however future enhancements to the Jira Connector may result in changes to the provided information
Section 1 - Default Fields
The fields in this table are always involved in synchronization between Jira and Jira Align and must be available in the Jira Screens
| Jira Field | Jira Screens | Can be Required in Jira | Comments |
|---|---|---|---|
| Summary | Stories and Epics | Yes |
|
| Description | Stories and Epics | No |
|
| Assignee | Stories and Epics | No |
|
| Reporter | Stories and Epics | Yes |
|
| Status | Stories and Epics | No | |
| Labels | Stories and Epics | No |
|
| Story Points | Stories | No |
|
| Epic Points | Epics | No | |
| Parent | Stories and Epics | No | |
| Fix Version | Stories and Epics | No |
|
| resolutiondate or a Custom Field providing the same function | Stories and Epics | No |
|
| Jira Key | n/a | n/a |
|
| Jira numeric ID | n/a | n/a |
|
Section 2 - Custom fields as configured in Jira Align > Settings > Jira Settings > Jira Setup
The fields in this table are those configured in the connector settings in Jira Align itself, some of the fields mentioned are also default fields, so included in Section 1 but are mentioned here because they are configured in this screen
Optional fields must be configured in the Jira screens if the sync is configured in these settings
| Jira Align setting for Jira Field | Jira field | Jira Screens | Default field (so also in Section 1) | Required in Jira Align Settings | Can be Required in Jira | Comments |
|---|---|---|---|---|---|---|
| Feature custom field on stories | Custom Field or Parent | Stories | Yes | Yes | No |
|
Story points custom Field | Story Points | Stories | Yes | Yes | No | |
Sprint custom Field | Sprint | Stories | Yes | No |
| |
Resolution date custom field | resolutiondate (background field) or a Custom Field | Stories and Epics | Yes | Yes | No |
|
Team custom field | Custom Field | Stories | Optional | Yes |
| |
Story and Feature Backlog Rank | Custom Field | Stories and Epics | Optional | No | ||
Parent work item custom field on features | Custom field | Epics | Optional | No | ||
Program Increment custom field | Custom field | Epics | Optional | No | ||
Capability parent custom field | Custom field | Epics | Optional | No | ||
T-Shirt custom field | Custom field | Epics | Optional | No | ||
Business owner | Business Owner | Stories and Epics | Optional | No | ||
Acceptance criteria custom field | Custom field | Stories and Epics | Optional | No | ||
Create web links on Jira issues to Jira Align work items | remotelink (Web links) | Stories and Epics | n/a | n/a |
|
Section 3 - Custom fields configured in Jira Align > Settings > Jira Settings > Field Management
Any Jira custom fields added to this section must be added to the Jira Epic Screens and also cannot be set to required in the Jira Field Configuration. As the list of fields configured in Field Management is customizable, to see a list of required Jira Fields, review the list in Jira Align itself and when adding new entries make sure they already exist in the Jira Epic Screens of all integrated projects
This section does not currently apply to Stories.
Notes:
The information in this article is important as any specific field involved in synchronization must exist in the Jira screens for Stories and Epics. As field sync configuration is connector wide, such fields must exist in the screens for all Jira projects that are integrated to Jira Align using the same connector.
Failure to configure the synchronizing fields in the screens of a project will result in sync failures from Jira Align to Jira which are usually recorded in the audit logs as: "Field 'customfield_nnnnn' cannot be set. It is not on the appropriate screen, or unknown."
If there are any fields in Jira that are set to Required in the field configuration but these fields are are not involved directly with sync, then problems will still be seen when creating new Stories and Features in Jira Align and expecting them to be created in Jira
If not using bidirectional sync or not creating stories and features in Jira Align for sync to Jira than it may be possible to set more fields to be Required in the Jira field configuration. The details in this article assume that bidirectional sync is needed.
It may be possible to configure just the Create and Update screens in Jira to include the synchronizing fields and then not include some fields in View only/Read only screens