Roles and permissions
Only administrators can configure Jira Server for their organization
After configuring Jira Server, it’s highly recommended that you link a Hyperproof task to a new or existing Jira issue to ensure that the bidirectional sync and user permissions work as expected.
Note: Hyperproof only supports certain types of Jira custom fields. See Supported Jira custom fields.
Note: If your Jira deployment changes from Jira Server or Jira Data Center to Jira Cloud, the integration stops working, and all of your integrated tasks will need to be set up again, manually.
If you haven't reviewed the minimum required permissions yet, refer to Jira Server permissions.
Jira Server and rate limiting
If rate limiting is enabled in your Jira Server environment, a best practice is to configure it for at least 600 calls per hour or 10 calls per minute to prevent any rate-limiting errors that the nightly task integration sync with Hyperproof might trigger. Hyperproof syncs tasks continuously but uses the nightly task integration sync to ensure no data is missed. This sync may involve a large number of records, depending on the volume of tasks created or edited throughout the day.
If your Jira environment supports high burst limits or exceptions during the nightly Hyperproof sync window, the rate could be set much lower. Note that large enterprises may need to double or triple the rate limit to avoid disruptions.
Using an admin account versus a user account
Use admin account credentials when setting up the Jira integration. These credentials are saved in Hyperproof and used to set up the integration and to populate certain fields in the task window.
The Hyperproof user who's logged in and initially configures the admin user account for the integration is the sole owner of the credential settings. Other Hyperproof users cannot update the admin credentials. They can, however, click the Trash icon to delete and reset the saved admin credentials. It's highly recommended not to do this, as all existing task integrations will be deleted!
Any Hyperproof user who wants to use the task integration must go to the task window and set up a task to integrate with Jira. The first time they do this, they'll be prompted to log in to Jira. This is where they should use their own Jira login credentials, not the admin credentials.
User login credentials are saved in the back-end with the logged-in Hyperproof user. The recommended workflow is for each Hyperproof user who will integrate tasks with Jira to enter their credentials in the task window, as described above.
If a Hyperproof user needs to update their Jira credentials, they should go to Hyperproof Settings > Connected accounts. They should then locate the Jira task integration credentials card and disconnect. After they've disconnected, they can return to the task window, initiate a Jira interaction, and re-enter their credentials.
Connecting Hyperproof to Jira Server
Note that only administrators can configure the Hypersync for Jira Server.
From the left menu, select Settings.
Select Integrations.
Below Enabled, select Jira Server.
The Jira window opens.
Click Settings.
Enter your organization's Jira URL, then click Submit.
Tip: Be sure to include the scheme, e.g.,
https://.The Create connection window opens.
Enter your Jira username and password, and then click Submit. Note that if a user fails to log in after 5 attempts, they’ll need to solve a CAPTCHA.
The Jira settings window opens.
Click Configure settings.
The Jira settings window opens.
Select the checkbox next to the Jira project or projects you want to connect, then click Next. Note that if you select more than one Jira project, you’ll need to map statuses for each project.
From the drop-down menu, select a default issue type for each project, then click Next. Note that you can change the issue type when creating a new ticket.
For each project, map a Jira status (e.g., To Do) to a Hyperproof status (e.g., Not Started) by dragging the Jira status to the Hyperproof status. Refer to the screenshot below for the recommended workflow.
Click Next.
Click Save to finish the configuration process. Jira is now configured. Should you need to change any settings, such as default story type or mapping status, refer to Editing Jira settings.
Important tips to consider when mapping
Tips for the Jira to Hyperproof sync
If a Jira user changes the Jira issue status from In progress or To Do to one of the Completed statuses, the Hyperproof task status changes to Submitted.
Note: Tasks can only be closed in Hyperproof. The Completed “bucket” of statuses ensures that Jira users are not able to close a task in Hyperproof. This action causes proof to land in the target object (e.g., a control).
If a Jira user changes the issue status to a status in the same bucket—e.g., from In progress to In testing, or from Not started to Needs triage—the Hyperproof status remains unchanged.
Tips for the Hyperproof to Jira sync
If a Hyperproof user changes the task status from Submitted to Closed, or from Submitted to Canceled, the Jira issue status remains unchanged because all of those statuses fall into the Completed “bucket”. If the task status is changed to Closed, the sync between Jira and Hyperproof will stop working until the task is reopened in Hyperproof.
If a Hyperproof user changes the task status from Submitted to In progress, or from Submitted to To Do, the Jira issue status changes to the first Jira status listed in the status map.
Note: At this time, Hyperproof does not support complete Jira state transitions. For more information about status mapping, refer to Jira status mapping.
Note: If you selected more than one Jira project, you’ll need to map statuses for each project.