Jira Projects and Scrum Boards
With any ALM Connection, but specifically for Jira in regards to this Help Article, it's essential to configure how we map the Team Boards in piplanning.io will map to the corresponding Jira Projects/Boards that are used by the Team. This is all done in the RTE Cockpit > ALM Connections > Team Mapping tab. The following steps can be completed by any User with the piplanning.io Admin Role.
Navigate to RTE Cockpit > ALM Connections > Edit > Team Mapping tab
Find the Team, and click Edit
Click +Add Project
In the Jira project dropdown field click Select project. Scroll and select the right Jira Project that maps to this Teams backlog.
In the Jira board dropdown field, click Select board. Find and select the corresponding Jira Board that this is used for the Teams Jira Sprints.
Optional: If the Team uses multiple Jira Projects to manage their Backlog Items then you can add additional mappings using the +Add Project button.
The Jira Project determines where to synchronise the sticky notes for that Team.
The Jira Scrum Board determines the Jira Sprints to schedule the sticky notes into.
Note: By default only Jira Scrum boards appear in the Jira board dropdown field.
piplanning.io needs to map to Jira Sprints for the scheduling of Sticky Notes (Work Items) into Iterations. This necessitates the need for Jira Scrum Boards because Sprints in Jira only exist on Jira Scrum Boards.
If you have Kanban Teams, that is no problem, after all not all teams involved in a PI Planning Event are Scrum teams. Please read the article on Kanban Teams, and how to use a shadow Scrum Board, to complete this set up for Kanban Teams.
Advanced Settings
Mapping a Team Field
Scenario
several piplanning.io Teams using a single shared Jira Project. In this scenario it is likely that you will need to map to a Team field to differentiate what Team owns what backlog item (User Story etc.) in this single Jira Project.
We can accommodate this scenario using the Team field (optional) mapping on the Team Mapping tab.
What needs to be done now is configuration of the Team field (optional) field in the RTE Cockpit > ALM Connections > Team Mapping tab. Check the Show advance settings checkbox.
Identify the field in Jira used to identify the Team. Supported Jira field data schema types include:
Single-Select Custom Fields
Jira Team field NEW
Jira Labels field
Jira Component field
Under "Team fields", click "Add another field"
Use the dropdown to select the field you want to use
Enter the value that will identify the team (usually it is the team name in Jira)
Mapping Default Field Values (*Required fields)
Scenario
If you have additional required* fields on a Jira Issue that must be mapped in order to make the integration work you must add default field values
Identify which field(s) in Jira are required for this Team's issues|
Under "Default field values", scroll to the field you want to add and click the "+" (green suggestions)
Alternatively, you can enter any field into the JSON-formatted input
Enter the desired default value in Jira's field-specific JSON format (see below for examples)
Example JSON syntax for the supported Jira Field Types
Example JSON syntax for the supported Jira Field Types
Jira Single-Select Custom Field:
{"value": "<team/select value>"}Jira Labels Field:
["<label>"]Jira Multi-Select Custom Field:
[{"value": "<value>"}]Jira Checkbox Custom Field:
[{"value": "<value>"}]Jira Team Field:
"31d4610a-10ec-4457-a437-1eac5c50adb2"
TIP
To find the exact value to enter into the JSON syntax try either of the following:
Copy the field value/s to insert into the JSON from the Jira Issue Export XML or REST API response.
Contact us via the Messenger to set up a session and we will happily guide you through the configuration.
IMPORTANT
Replace the syntax in italics between the double quotes " " only. All other syntax is necessary JSON formatting.
Please check twice that the all values entered match the values in Jira, when editing that field.
Please check again, that the values entered into the JSON syntax match the values available for that field in Jira. We are making this friendly reminder to avoid having to spend time troubleshooting any typo issues which cause a false-positive mismatch during validation.
Epic Link
Epic Link
If your Jira is setup in a way that it requires for any team-level issue (Story, Bug...) to be linked to an epic, you need to specify this by a specific syntax:
{"EPICLINK":"<issue key of a random existing epic>"}
{"EPICLINK":"ART-2"}If this is set for a team, it will not create an issue in Jira as long as the corresponding sticky note is not linked to any Backlog work item in the app (i.e. a Feature) which is synced to Jira (as an Epic).
The issue key you supply as the value of EPICLINK will ONLY be used when you click on 'create test issue'. In normal operation, the value will be ignored.
Create Test Issue
When configuring the ALM connection the first time or changing a team mapping, creating a test issue is a fast and easy to use way to test if the configuration allows you to create an issue in Jira.