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 via REST APIs and other web protocols)
It is strongly recommend to use a dedicated Jira Service User account (Systems Account) for the ALM Connection authentication.
OAuth (Jira Cloud) or Basic Authentication (Basic Auth for Jira Data Center only).
piplanning.io only supports Company-Managed Jira Project Types. Note: Team-Managed Jira Project Types are not support.
IMPORTANT: for performance reasons the 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: Impact on Jira when connected to the piplanning.io.
What types of data piplanning.io gets from Jira
Issue Types, Issue-link Types configured in the Jira Project/s that are mapped
Jira Project/s and [Scrum] Board/s metadata
Issues or Epic objects from the Project/s that are mapped
What types of data piplanning.io pushes to Jira
CRUDoperations on Issues/Epics in the Project/s that are configuredCreate or remove Issue-links in the Project/s 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 setting up PI Session Sprints in Jira).
How to limit piplanning.io's access to Jira?
Ensure the Jira [Service] User account - used to authenticate - only has the necessary permissions. Recommended
Remove the DELETE_ISSUES permission from that Jira [Service] User account if you do not wish to grant piplanning.io the ability to delete work 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. Recommended.
What type of data traffic to expect with the sync?
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 executes a manual synchronization on a board or at the PI Session level, we will send REST API requests to query and fetch from the ALM tool the issue-types, statuses, boards, sprints and issues related to the PI Session.
Dependent on any filtering restrictions on Jira 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.
Information stored on our servers from your Jira instance
Please, also review this article about piplanning.io attributes and Jira fields
Jira Project / Issue 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
Assignee (see Jira Account-ID/User-Key below)
Reporter (see Jira Account-ID/User-Key below)
User-ID/Key
Team (in case the a team field is synchronised)
Personally Identifiable Information (PII)
Email Address
Username
Jira Account-ID/User-Key (In case user map their piplanning.io user account to their Jira account, we do map the two user ID's. The actual email address, username or other user data is not pulled from Jira into piplanning.io)