Jira Cloud Integration Setup

Product Availability

 

This article will walk through how to set up the Jira Cloud Integration for UserVoice. Before getting started, be sure to check out this article for an overview of the integration and its functionality. 

 

 

 

1. Within your Admin Console, navigate to your settings menu and select "Integrations".
   
   
2. Select "Jira" from the list of integration options. 
   
   
3. Click "Link Account"
   
   
   
4. Enter the URL of Jira cloud instance that you would like to configure (https://acme.atlassian.net). If you don't know the URL of your Jira instance, contact your Jira Administrator. It's important to include the URL scheme, https://
   
5. Select "Jira Cloud" and then "Submit".
   
   
6. Under "Authorized Jira Instances" you will see the Jira instance URL you entered in Step 6 with a "Not Connected" status, an access token, and a link directly to the area in your Jira instance where a Jira Admin can complete the setup process. 
   
7. A Jira Administrator will need the access token and the instructions listed below to complete the configuration process. Once a Jira Administrator completes the steps below, the "Not Connected" status will change to "Connected." This will indicate that the integration is successfully installed and ready to be used.

Jira Configuration

1. Using the top navigational menu in Jira, select "Apps" → "Find new apps".
   
2. Search "UserVoice"
   
3. Locate the UserVoice app (if using EU, select "UserVoice EU for Jira") and click "Install" → Click "Get app" to accept the permissions
   
   
4. You'll see a toast window that indicates the app is installing, and a toast window when installation finishes.
   
   
5. Click "Configure". 
   
   
6. On the subsequent page, enter the access token (provided to you by your UserVoice Admin who initiated this configuration in UserVoice) and click "Verify Token."
   
   
7. You'll be taken to a success screen indicating additional configuration is needed for the integration.
   
   However, if you exit this page before making the needed changes, you can re-navigate to these areas by going to Jira Settings → Apps → ManageApps → UserVoice → Configure
   
   
8. Add the "UserVoice Links" custom field to the appropriate screens for your projects in Jira.
   During the Add-on configuration process, we automatically created a custom field in your Jira instance called "UserVoice Links." This custom field will allow you to see the linked UserVoice items when viewing an item in Jira.
   
   Choose "Enable Screens for UserVoice Custom Field" → a new tab will open → check the box next to the appropriate screens → click "Update"
   
   
9. Change "UserVoice Links" renderer to "Wiki" style". This will allow your Jira items to display direct links to their corresponding UserVoice items. In your UserVoice for Jira configurationClick the link titled "Change UserVoice Links renderer to Wiki style" → a new tab will open → Select 'Wiki Style Renderer' for the Active Renderer and click "Update"
   
   
10. You will know your token has been successfully redeemed when the Jira Integration page in your UserVoice admin settings says "Connected".
    
    You may need to refresh the page. At this point, your Jira instance is ready to be used with your UserVoice subdomain!

Common Questions 

A. The instructions in this article are only relevant for Jira Cloud. If you are using Jira Server please see this article. 

 

Q. Does updating the status of a Jira issue update the status of the linked Ideas or Feature in UserVoice?
A. No. The status of linked Jira issues is visible in UserVoice, and the status of linked UserVoice features/ideas is visible in Jira, but they do not automatically update the status of the other. This means that when a developer moves an issue in Jira to DONE, it does not automatically notify all the related voters and contributors in UserVoice. This is because an issue being “DONE” in Jira doesn’t necessarily mean it’s ready for customers.

 

A. Make sure you followed 'step 9' in the "Jira Configuration" section above to add the "UserVoice links" custom field to your Jira Projects. If you linked UserVoice items to Jira items before completing 'step 9', you will need to complete step 9, then unlink the items from within UserVoice and then re-link them. 

 

A. The UserVoice items will remain connected to the original Jira issue but they will not be connected to the new issue you created in Jira. 

 

Q. What happens to the linked items if I delete the config in UserVoice?
A. The link will remain in Jira, but all links will be deleted from UserVoice and cannot be recovered.

Q. Is there a way to display Jira issue statuses to end-users?
A. No. Information about linked Jira issues, including status, is only visible to UserVoice admins in the admin console.

Q. Can Jira issues be created automatically from UserVoice Ideas or Features?
A. Due to the potential for required fields in Jira, we do not have a way to do this automatically. However, when manually creating a Jira issue from within UserVoice, the issue’s summary and description will be pre-populated and a link back to UserVoice will be added by default.

 

Q. Is the integration compatible with Jira Next-Gen Projects?
A. The Jira Integration is not compatible with Next-Gen projects. Due to a Next-Gen limitation where NG cards cannot be configured to display custom fields, the usefulness of the integration is degraded; therefore, until Jira changes the functionality, we have no plans to support Next-Gen projects.

 

A. Update the permissions of the end user in Jira that created the integration link. UserVoice has the same permissions as the user that authorized the integration. Read this article to learn more about integration logs.