Quick Start

Follow the steps below to quickly set-up the SprintPlanner so you can focus on actual planning work.

1. Go to the settings view
   1. Set the JIRA instance URL in the Server Address field
      In the example below I inserted the URL of a free JIRA Cloud instance
   2. OPTIONAL: Set the Story points field
      For the JIRA Cloud instance I used for testing the Story points field is 'customfield_10024'

You can find the Story points field by using the JIRA API to send a REST request for an issue and then check the returned JSON.
For example: I know that issue SSD-3 has 8 story points, so I send a request for https://pro-jira.atlassian.net/rest/api/2/issue/SSD-3, then search for the value 8 in the returned JSON. You can try with several issues to be sure.

2. Go to the Login view and enter your credentials
   Use your password for a JIRA Server instance
   Use an API token for a JIRA Cloud instance
   

Use this guide to create an API token

3. Go to the Planning view and click on the 'Read boards' action
   1. The Board drop-down will be populated.
   2. Select a board from the drop-down. You can type to filter the boards.
   3. Once the board is selected, the sprints drop-down is populated automatically
   4. Select a sprint from the drop-down
4. Go to the 'Team capacity' view
   1. Set the number of sprint days
   2. Set the target availability for each team member, from 0 to 100%
   3. Click the 'Refresh' button (or hit F5)
      This will populate the grid with team members that have tasks assigned in the selected sprint (in the Planning view)
   4. To remove a team member from the grid, select their corresponding line and hit 'Delete' on the keyboard
   5. Set the Hours per day and days off for each team member
   6. Full availability and target availability will be auto-calculated for each team member

Full availability is calculated using the following formula:
FullAvailability = (DaysInSprint - DaysOff) * HoursPerDay

Target availability in hours is calculated using the following formula:
TargetAvailabilityHours = FullAvailability * TargetAvailabilityPercent / 100

5. Go to the Planning view
   1. Click the 'Get team data' action Planning details:

• For issues with subtasks, only the subtasks are listed
• An issue without subtasks will be listed with 'Task ID' and 'Task summary' as empty values
• To quickly assign an issue to a different team member, right-click the issue to open the 'Assign' context menu. The change will be reflected in JIRA.
  

You can use this report to get an idea if the team is over committed, well balanced, or can take more work into the sprint.

Happy sprint planning!