Skip to main content

Jama Connect Interchange User Guide

Link to your Jama Connect instance (Jira)

This section guides you in setting up a Jama Connect connector. In this process, you identify the user account that Interchange uses to authenticate with Jama Connect.

After the integration is set up and information is flowing between Jama Connect and Jira, any updates made to items in Jama Connect by the integration service appear to come from this account.

Note

If you plan to configure multiple integrations using the same Jama Connect instance, you only need to create one connector for that instance. You can then use the same connector with multiple integrations.

Requirements
  • A running Jama Connect instance.

  • A Jama Connect user account to be used by the integration service. The integration service uses this account to authenticate with Jama Connect.

    • You can use an existing Jama Connect user’s account, or you can create a dedicated service account. Your subscription to Jama Connect Interchange includes one free named license for this service account.

    • A Jama Connect admin can create a new account in Jama Connect by going to Admin > Users > Add.

    • The user account must have administrative privileges, a Creator license type, and the ability to read and write to the set of items you are integrating with.

To link your Jama Connect instance:

  1. In the Jama Connect Interchange header bar, click Connectors.

  2. On the Connectors page that opens, click Add Connector.

  3. On the Add New Connector page, complete these fields:

    • Application — Select Jama Connect.

    • Name — Type a descriptive name for the connector.

    • URL — Enter your Jama Connect URL.

    • Verify SSL — Leave this option selected unless Jama Software Support instructed you to deselect it.

    • Authentication Type — Select Basic or oAuth, whichever your environment uses. If your Jama Connect instance uses SAML authentication, select oAuth.

      Basic authentication:

      • Username — Enter the username for the Jama Connect user.

      • Password — Enter the password for the Jama Connect user.

      oAuth authentication:

      • Client ID —Enter the Client ID associated with this user account. To generate the Client ID, see Set API credentials.

      • Client Secret —Enter the Client Secret associated with this user account. To generate the Client Secret, see Set API credentials.

  4. Click Submit.