Skip to main content

Jira Software ALM Connection: Discovery + Setup Preparation

A template that helps us to learn about your Jira setup in advance. Includes prerequisite checklist for a Jira - ALM Connection.

Updated yesterday

​

Jira ALM Connection: Setup Template

Please complete Steps 1 to 4 in the attached template spreadsheet file. The information we are seeking is the following:

  1. Organizational Hierarchy + Team-based structure: Solution Train, ARTs, Teams

  2. Work Item Hierarchy

  3. Timeboxes for Work Items

  4. Mapping piplanning.io Teams to their Jira Project / Scrum Boards


Graphical Step-by-Step Guide: Team + ART Mapping for Jira-ALM Connection


Jira ALM Connection: Authenticate via Service Account

We highly recommend setting up a Jira Service User account to use for authenticating the ALM Connection. Additional information to know:

  • Ensure you set the appropriate permissions for this Jira Service User; for more information please review the article here

  • With Jira Cloud you must use the OAuth method to authenticate the Jira User account used for the ALM Connection. With Jira Data Center you have a choice to use either the OAuth or Basic Authentication methods.

  • If, you need to consider the use of Private Certificates on the Jira Server, then go here for more advanced settings.


Prerequisites: Jira Projects

#1. Company-managed Jira Projects

  • Only Company-managed Jira Project types are supported. Learn more from Atlassian here.

  • Ensure the Jira Projects that will map to the Teams - RTE Cockpit > Organization > Teams and ALM Connection > Team Mapping - are all Company-managed Jira Projects.

    • Note: Team-managed Jira Project types are currently not supported.

#2. Required fields on Jira Issue Types

  • Get a list of all the custom Required fields on a your Jira Issues. We will need to set Default Field Values (on the ALM Connection > Team Mapping tab) for any Required fields for the Team-level Work Item Sticky Notes.

Best Practices for Required fields

Note: This applies only to custom Required fields. All standard required fields are synchronized automatically as part of the integration.

  • Keep additional required fields to a minimum and the best practice is to have zero additional required fields and use Working Agreements or data integrity reports for data integrity in any workflow. If you have any questions about this advice please just ask us and we will demonstrate.

#3. Story Points + Sprint fields on the Jira Create-Issue Screen

  • Verify that the Story Points and Sprint fields are on the Jira Create-Issue Screen.

    • IMPORTANT: The Story Points and Sprint fields need to be on the Jira Create-Issue Screen.

#4. Jira Scrum Boards

  • Verify the Jira Project has a Scrum Board.

    • IF, the Jira Project has a Kanban Board THEN pls follow these steps here.


piplanning.io Team + Jira Project Mapping Scenarios

Mapping the SAFe Organization nodes (Team, ART, Solution Train) to Jira Projects may not be straight forward if the Jira Projects do not represent Team entities.

The configuration properties on the ALM Connection > Team Mapping page provide the options necessary for the Team to Jira Project mapping. The common scenarios we cover are:

  • Scenario A: 1:1 | 1x piplanning.io Team = 1x Jira Project

  • Scenario B: Nx:1 | multiple Nx piplanning.io Teams = 1x Jira Project

  • Scenario C: 1:Nx | 1x piplaning.io Team = multiple Nx Jira Projects

Ready to tackle the Team Mapping set up?

First, identify Scenario A, B or C above, that represents the Team Mapping to Jira Software Project configuration that we need to implement.

Second, go here for our Decision Tree and step-by-step instructions + prerequisites for integration with Jira (REST API, authentication, Jira Projects etc.)

Did this answer your question?