Configuring JIRA Integration
ProductPlan’s JIRA integration gives you a way to connect a ProductPlan Bar or Container with a JIRA Epic/Issue.
You can link existing Epics/Issues or you can push a new Epic/Issue directly into JIRA from within ProductPlan. You can also configure ProductPlan to pull completion progress directly from JIRA, saving you time.
The integration works with both the Atlassian OnDemand version as well as the installed on-premise version. If you have an on-premise solution, the JIRA server needs to be accessible from outside the firewall (e.g from home). You can find those listed here, or contact email@example.com for more assitance.
Setup Instructions for ProductPlan User
To set up the integration, go to your Integrations page and follow the instructions. If someone in your organization has previously configured the integration, your setup will be quick (you’ll just need to enter your JIRA URL).
If this is the first time anyone in your organization has configured the JIRA integration, you will need to contact your JIRA administrator as information needs to be added to JIRA. You may need to copy and paste the JIRA setup information to send to your JIRA administrator. This includes the Consumer Key and Public Key provided by ProductPlan.
Setup Instructions for JIRA Administrator
To complete the JIRA integration process, a ProductPlan user will need to provide you with custom values (copied from https://app.productplan.com/integration). The integration has been tested with JIRA version 5.0 and higher. The exact steps will depend on your specific version of JIRA.
- Go to your JIRA application settings (the cog next to your profile photo)
- Click “Applications.” For earlier versions click “Add-ons.”
- Click “Application Links” in the left-hand navigation menu
- Enter this as the URL: https://app.productplan.com
- Click “Create new link”
- If you get a warning saying “No response was received from the URL you entered”, click “Continue”
- Under Application Name, enter “ProductPlan”
- For Application Type, select “Generic Application”
- Click “Continue”
- Click the “Edit” link to the right of your newly created ProductPlan application
- Click “Incoming Authentication”
- Enter the following values:
- Consumer Key: (provided by ProductPlan)
- Consumer Name: ProductPlan
- Public Key: (provided by ProductPlan – copy everything, including the begin and end certificate lines)
- Consumer Callback URL: https://app.productplan.com/auth/jira/callback
13. Click “Save”
JIRA will present a page requesting access. Click Allow. The JIRA integration is now complete.
How to Link ProductPlan Bars to JIRA
Once the configuration is complete, you can now open a ProductPlan bar and connect to an existing JIRA Epic/Issue. Click the Select a JIRA Epic/Issue box and begin searching by the exact ID or Summary text (note that you cannot search by Epic Name).
You can also generate a new Epic/Issue and push it directly into JIRA. Click Add to JIRA to begin.
Once linked, you and your viewers can click from ProductPlan to the JIRA issue. If enabled, the Percent Completion will also update automatically once per day based on completion in JIRA.
Synchronizing Percent Complete
You can set ProductPlan to automatically update the Percent Complete on a Bar or Container based on completion within JIRA. You can set ProductPlan to update the Percent Complete based on:
- The number of stories completed in an Epic
- Story points of all stories in an Epic or Issue
To set up ProductPlan to synchronize Percent Complete, click the Synchronize “Percent Complete”… checkbox on the Integrations page. Once set up, the roadmap will synchronize daily at 5:00 a.m. UTC. You can synchronize at any time by clicking the Sync Now button.
Note that in some cases if we are not able to calculate story points or story count, ProductPlan will calculate Percent Complete based on JIRA’s time tracking feature.
Configuring Bars to Synchronize
Once the synchronization is set up, any new ProductPlan Bars or Containers that you link to JIRA will automatically be synchronized. You will need to manually set the synchronization for any Bars or Containers that you previously linked to JIRA.
- You can disable the synchronization by clicking the link icon on the Details screen. You can then set the Percent Complete manually.
- You can enable the synchronization by clicking the link icon. The Percent Complete will update at the next daily synchronization or when you click the Sync Now button from the Integrations page.
We use JIRA’s OAUTH for identity management, so at no point are user passwords entered into or stored on our system. Revocable tokens are stored on a per-user basis, ensuring that each user’s access in the system matches their access in JIRA. ProductPlan’s connection to JIRA APIs is via an SSL-encrypted transaction.
- If you are working in a JIRA Kanban board, JIRA Epics will be marked as complete only if the issue is in the green “Done” column (or whatever you have renamed the last column).