Jira integration data collection

Ensure you have completed all steps in Jira integration prerequisites before proceeding.
Note: You can download an Excel spreadsheet of all of the tables in this article here.

Jira projects and boards

1. Create a list of Jira Project Keys and Jira Project Names that you plan to synchronize to Jira Align. Determine to which Program/Release Train each Jira project maps.  Please note each Jira Project can only be mapped to one Jira Align Program due to the Jira Align data model which associates Jira Projects to Jira Align Programs.

To find a Jira Project Key:
When logged into Jira, select your project, and then look at the URL. In the URL, you can find the Project Key: https://your_jira_name.net/projects/PROJECTKEY/

2. For each project above, create a list of Jira Agile Board IDs, which are in the URL for the board, that you plan to synchronize to Jira Align (for example, RapidView=38). Determine to which Program in Jira Align each Jira board will map and specify a friendly name for the Team to create.

To find a Jira RapidView ID:
When logged into Jira, select your project, and then go to Board/Backlog/Sprints (or select your board from the board list). Next, look at the URL to find the RapidView ID:

3. If you use a filter to determine what issues appear on the Backlog portion of the Jira Agile Board, record the field name that does the board assignment (a custom drop-down menu or a label in Jira). This might be different for each Jira project being mapped.

4. Run JET (available in the Atlassian Marketplace) for the boards you wish to integrate. Your Jira Align Solutions Architect will assist. JET will help determine how your boards and sprints should be configured and optimized for the integration, as well as provide some useful metrics about the cleanliness of your data in Jira.

5. Determine the start date (how far back in time) from which you want to import data. This will determine how many historical Program Increments you need to set up in Jira Align.

Jira custom field IDs and issue type names

1. Record the Issue Type Names for company-managed projects in the table below. This is a word, not a number, see the example screenshot.

2. Record the Issue Type IDs for your company-managed projects in the table below. To find the Issue Type IDs, follow the instructions outlined here: https://confluence.atlassian.com/jirakb/finding-the-id-for-issue-types-646186508.html

3. Record the Custom Field names and ID numbers in the tables below. The quickest way to collect the Custom Field IDs is to open the Advanced Issue Search in Jira and start typing the field name. This will show you the Custom Field number as shown in the screenshot below.

a. If you plan to sync team information with your Jira instance’s built-in teams field, create a list of Jira and Jira Align team information you’ll use later to set up the team mapping with the API 2.0. You may need the assistance of your organization’s Jira API user to collect this information and set up team mappings later.

• For Jira Cloud, the individual team ID can be found at the end of the URL when viewing the team’s Atlas page. You may need to add Atlas to your Jira Cloud instance if it’s not added already.
  
  Alternatively, use the Jira API to send a POST gateway/api/v4/teams/search call to return a list of all teams, including their IDs. Replace the organization ID and site ID with your own instance’s organization ID and site ID:

{
"organizationId": "9390b32a-83f9-4f04-95fd-1dd0899b5183",
"query": "",
"siteId": "71f9dfd8-8fe7-4b2d-aeaa-d5e88b461f54",
"sortBy": null
}

• For Jira Data Center, the Jira team IDs can be found under Plans > Manage Shared Teams:
  1. Right-click the table of shared teams and select Inspect to open the developer console.
  2. Select the Network tab.
  3. Refresh the page and select find on the left of the developer console. The list of shared team information will display on the right, with the id parameter listing a team’s ID.
     

4. Create a list of custom issue types (anything that is not an epic, story, or bug) that you want to synchronize with Jira Align stories in your company-managed projects. These issue types will synchronize to Jira Align as stories with a specific type.

5. Create a list of custom issue types (anything that is not an epic, story, or bug) that you want to synchronize with Jira Align features in your company-managed projects. These issue types will synchronize to Jira Align as features with a specific type.

6. Create lists for team-managed projects of the issue type names and IDs in the tables below. The IDs for each issue type are specific to each individual project, so create a separate list for each team-managed project.

You can locate individual issue type IDs for team-managed projects on the project's Project Settings > Issue Types page by hovering over the issue type name on the left-hand sidebar. The ID is the five-digit number at the end of the URL on the lower-left of the page.

7. Create a list of Link Actions. Link Actions may be imported from Jira and converted into dependencies in Jira Align.

8. Determine if the following fields are required on work items.