Please start here...
Why, is it important to review this Help Article in detail, and complete the attached spreadsheet/template?
Answer: Completing this template will speed up the quality of our onboarding activities as the spreadsheet template is designed to assist all of us with complete the discovery and learning about your Jira Software instance asynchronously. It's like preparing for any meeting. IF, the spreadsheet is not completed we may need to plan additional time in meetings to explore or troubleshoot unknown issues that arise related to people, process or technology with the piplanning.io and Jira integration.
Discovery Spreadsheet Template to Consume and Complete
Please complete the Sheets (Steps 1 to 4) in the attached spreadsheet template. The information we are seeking is the following:
Team structure or organisational nodes (Solution Train, ARTs, Teams)
Work Item Hierarchy
Associated Owners (Teams) and Timeboxes for Work Items
Mapping piplanning.io Teams to their Jira Project / Scrum Boards
Graphical Step-by-Step Guide: Team + ART Mapping for Jira-ALM Connection
Authentication + WebHooks
Set up a Service User account in Jira Software, and login to Jira with this account when performing the authentication Connect and WebHook steps in the ALM Connection set up.
Ensure you set the appropriate permissions for this Service User; for more information please review the article here
This is an important step because this will result in the Jira Issue History Log displaying the Service User account for all operations preformed by the integration.
Decide to use either OAuth or Basic Authentication
If, you need to consider the use of Private Certificates on the Jira Server, then go here.
Team Mapping Prerequisites
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.
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 for any Required fields. Note: This is ONLY for the Jira Issue Types that will synchronize with Work Item type Sticky Note in piplanning.io.
Best Practices for Required fields
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.
Story Points + Sprint fields must be 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.
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.
Team 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.)