Integrating InVision V7 Spec documents with Jira Server and Data Center
  • 06 Jan 2023
  • 5 Minutes to read
  • Dark
    Light

Integrating InVision V7 Spec documents with Jira Server and Data Center

  • Dark
    Light

Article Summary

The content below provides answers for specs in InVision V7. If you’re on InVision V6, this information doesn't apply. Not sure which version you're using? Find out now.

The InVision V7 Specs integration for Jira Server and Data Center helps further streamline the design to development collaboration flow by connecting spec files directly to their corresponding Jira issues.

invision-v7-spec-jira-server-data-center-integration.png

Managing admin tasks in Jira Server and Data Center

To manage these tasks in Jira, you must have Jira admin privileges.


Admins will manage certain tasks related to the integration in Jira rather than in InVision V7:

  • Installing the app
  • Configuring the app

Install the app in Jira

InVision supports the Specs integration for Jira Server and Data Center versions 7.2.0 to 9.x.x.

To add the InVision Specs integration in your instance of Jira:

  1. At the top-right corner of Jira, click the settings icon (jira-server-data-center-settings-icon.png) and select Applications.
  2. Just below the Integrations heading in the left-hand navigation, click Application links.
  3. In the Enter the URL of the application you want to link field, enter https://integration.invisionapp.com, and then click Create new link.
    jira-step-3.png
  4. At the bottom of the Configure Application URL modal, click Continue.
    Note: You'll need to select the Use this URL checkbox before clicking Continue if you see this error message: The supplied Application URL has redirected once.
    You can ignore this warning message in the modal: No response was received from the URL you entered.
    jira-step-4.png
  5. On the first screen of the Link applications modal, use the following values to complete the form, and then select the Create incoming link checkbox and click Continue:
    • Application Name: InVision
    • Application Type: Generic Application
    • Service Provider Name: InVision
    • Consumer key: See step 3, sub-step d in the Setup Instructions of the Add a site module in InVision to copy the unique value generated for your V7 Enterprise team.
    • Shared secret: Copy the auto-generated password for the shared secret in InVision and paste it here.
      This corresponds with step 5 of the Enable and test the integration in InVision V7instructions below.
    • Request Token URL: https://[team-subdomain].invisionapp.com/in/request-token
    • Access token URL: https://[team-subdomain].invisionapp.com/in/access-token
    • Authorize URL: https://[team-subdomain].invisionapp.com/in/auth
      jira-step-5.png
  6. On the second screen of the Link applications modal, use the following values to complete the form, and then click Continue:
    • Consumer Key: See step 3, sub-step d in the Setup Instructions of the Add a site module in InVision to copy the unique value generated for your V7 Enterprise team.
    • Consumer Name: InVision
    • Public Key: Copy the auto-generated public key in InVision and paste it here.

      This corresponds with step 5 of the Enable and test the integration in InVision V7 instructions below.

      jira-step-6.png

Configure the app in Jira

To complete the integration connection, you'll need to allow inbound and outbound traffic from your Jira instance by adding the following IP addresses and domain to your allowlisting configuration:

  1. Allow inbound traffic:Add these InVision IP addresses to your proxies and firewalls:
  2. Allow outbound traffic: Add this InVision domain to your allowlist: *.invisionapp.com

Managing admin tasks in InVision V7

To manage these tasks in InVision, you must have InVision admin privileges.

Once you've added and configured the integration in Jira Server and Data Center, you're ready to enable the connection in InVision by adding Jira site URLs.

Enable and test the integration in InVision V7

To enable the integration in InVision:

  1. In the lower-left corner, click the expandable team tray, and then click Integrations.
  2. On the Integrations page, click Jira Server and Data Center.
  3. In the upper-right corner, click Add Jira site.
  4. In the Add your server URL or Data center URL field, enter the URL of the Jira site you want to add.
  5. Copy the auto-generated Shared secret password, and add it to the Shared secretfield in your Jira settings.
    Note: This corresponds with step 5 of the Install the app in Jirainstructions above.
  6. Copy the addresses in the Allowed IP addressesfield, and add them to your allowlisting configuration for Jira Server and Data Center.
    Note: This corresponds with step 1 of the Configure the app in Jirainstructions above.
  7. Click Test connection and, once you see the Connection active confirmation message, click Save.
    invision-v7-specs-enable-test-jira-server-data-center.gif

Configure and test existing Jira sites in InVision V7

To configure and test Jira sites you've previously added in InVision:

  1. In the lower-left corner, click the expandable team tray, and then click Integrations.
  2. On the Integrations page, click Jira Server and Data Center.
  3. In the list of Jira sites, click the site you need to configure.
  4. In the Add your server URL or Data center URL, verify that the URL is correct—or replace it.
    Note: Check to ensure that the URL begins with the secure protocol HTTPS, as InVision cannot validate URLs for sites that do not communicate over HTTPS. Learn more about our HTTPS requirement.
  5. Verify that the auto-generated Shared secret password in InVision matches the Shared secretfield in your Jira settings.
    Note: This corresponds with step 5 of the Install the app in Jirainstructions above.
  6. Ensure that an admin has added all the addresses from the Allowed IP addressesfield in InVision to your Jira allowlisting configuration.
    This corresponds with step 1 of the Configure the app in Jirainstructions above.
  7. Click Test connection and, once you see the Connection active confirmation message, click Save.

Collaborating in InVision V7

Once someone links a spec to Jira, your team will collaborate as usual in the spec file on InVision, yet your developers will have immediate access to the latest updates for the spec within Jira Server and Data Center.

Linking a spec to Jira Server and Data Center

To link a spec to Jira:

  1. Open the spec in InVision V7.
  2. Just above the Overview heading on the left, click Link to Jira.
  3. In the Jira Server and Data Center box of the Integrations modal, click Link issue.
  4. In the Link to Jira Server and Data Center modal, click the Choose a Jira Site dropdown, and then enter and/or select the appropriate Jira URL.
  5. Select your Jira project and your Jira epic or issue.
  6. If wanted, add a comment, and then click Link to Issue. invision-v7-spec-connect-to-jira-server-data-center.gif

Requesting configuration from admin

If you cannot link your spec to Jira after your admin has already configured your Jira Server and Data Center instance for use with InVision, you'll need to request access:

  1. Open the spec in InVision V7.
  2. Just above the Overview heading on the left, click Link to Jira.
  3. In the Jira Server and Data Center box of the Integrations modal, click Link issue.
  4. In the Link to Jira Server and Data Center modal, click the Choose a Jira Site dropdown, and then enter the appropriate Jira URL.
  5. At the bottom of the modal, click Authorize. invision-v7-specs-request-jira-access.gif

Your Jira admin will receive your authorization request via email, and we recommend following up with the admin to ensure that they authorize you to connect.


Was this article helpful?