Prerequisites
To connect piplanning.io to Jira Software Cloud or Jira Data Center via the ALM Connection, the following prerequisites need to be met:
Allow incoming connections from piplanning.io Jira Software on port 80/443 (HTTP/S REST API requests from piplanning.io to Jira Software)
Authentication to the Jira instance using either OAuth (Jira Cloud) or Basic Authentication (Basic Auth for Jira Data Center only).
It is strongly recommend to create and use a dedicated service user (Systems Accout) in Jira for the ALM Connection.
piplanning.io only support Company-Managed Jira Project Types. Note: Team-Managed Jira Project Types are not support.
IMPORTANT: for performance reasons your Jira instance should respond to API requests relatively fast, ideally under 3 seconds (approx. ~ < 3 seconds)
If you are concerned about the impact piplanning.io can have on your instance of Jira then this article will help remediate any issues proactively. Suggested reading: Impact on Jira when connected to the piplanning.io.
What the app will pull from your instance of Jira
Issue Types, Issue-link Types configured in the Jira Projects that are configured
Projects and [Scrum] Board metadata
Issues or Epic objects from the Projects you configured
What the app will push to your instance of Jira
CRUDoperations on Jira Issues/Epics in the Projects that are configuredCreate or remove Jira Issue-links in the Projects that are configured
Create new Sprints (if you request that from the app, which we recommend if you want to reduce the manual effort and maintenance of doing this separately in Jira).
How can we further limit the access of piplaning.io to our Jira instance?
Ensure the Jira User account - with which we setup the Connection to Jira - only has the necessary permissions.
Remove the DELETE_ISSUES permission from that Jira User account if you do not wish to grant piplanning.io the ability to delete items in Jira. Note: There is also a configuration setting in the SAFe PI sessions that can be set to 'Forbid users from deleting Sticky Notes that are synchronized with Jira'.
Set a JQL filter in the Jira Webhook: This will then only post updates from Jira to the piplanning.io which are matching that filter.
What size of traffic do we need to expect?
Whenever an update to a Sticky Note is completed (and there is actually a change made concerning the fields synchronized with the ALM tools), piplanning.io will issue a REST API request.
When a user / admin re-syncs a board or a session, we will query the ALM tool for issue-types, statuses, boards, sprints and issues.
Dependent on any filtering restrictions on Webhooks, there will be more or less the same types of REST API requests for the activity mentioned above occurring in the reverse direction, from the Jira instance back to piplanning.io.
The information we will store on our server which is coming from your Jira
Also check out the mapping between piplanning.io attributes and Jira fields
Metadata
Jira Project, Sprint and Board IDs
Issue-Key of Issues synced to piplanning.io
Issues Types
Linked Issues (the Issue-Link between Jira Issues)
Issue-Links
Epic-Links
Parent/Child-Links
Issue Status (based on the specific workflow)
Jira User Data
For Jira Issues synced to piplanning.io (i.e. the are visible on the Boards in piplanning.io):
Summary
Story Points value
WSJF chosen numeric field value
Team (in case the a team field is synchronised)
Personally Identifiable Information (PII)
Email Address
Username