Add Jira as a request provider

This topic describes how to add, modify, and remove Atlassian Jira Software as an request provider for Dimensions CM.

Add Jira external request providers

You can add multiple instances of Jira Software Cloud or Server (on-premises installation) as request providers.

To add Jira request providers:

  1. Log in to the Dimensions CM administration console.
  2. In the Database Management section, click External request providers. The External Request Provider page opens.
  3. In the toolbar, click New. The New Request Provider dialog box opens.
  4. In the General tab, provide the following details:

    Type From the Type list, select Jira.
    ID Enter the ID of the Jira instance, for example, JIRA_CLOUD.
    Name Enter the name of the instance, for example, jira_cloud.
  5. If you are switching from Dimensions CM requests to Jira issues, select Dimensions CM requests history support to view the details of Dimensions CM requests.

  6. Select the Attributes tab and provide the following details:

    Jira URL Enter the URL where the instance of Jira is hosted.
    Jira hosting type Select the Jira hosting type: Cloud or Server.
    Authentication

    Select one or both authentication types:

    • Basic. Username and password (Jira Server); email and API token (Jira Cloud).

    • OAuth. Log in via a web browser.

    Selecting both authentication types enables users to choose which one to use with Dimensions CM clients.

    Consumer key

    Enter the consumer key.

    If you select OAuth, you must set up the authentication between Jira and Dimensions CM.

    A consumer key is a unique mapping identifier between Dimensions CM and Jira instances. Enter the same consumer key as in the Jira Application Link settings. For details, see Use OAuth to authenticate to Jira.

  7. Click OK.

Back to top

Set the default request provider

After defining request providers, you can set a default provider instead of Dimensions CM. If you have multiple providers, for example, different Jira repositories, set the provider used by the majority of your products.

Note:

  • If you change the default request provider, favorite request lists and project default requests are cleared.
  • When changing the default request provider, check that no clients are connected to the Dimensions CM server.

To set the default request provider:

  1. Log in to the Dimensions CM administration console.
  2. In the Database Management section, click External request providers. The External Request Provider page opens.
  3. In the toolbar, click Default. The Set Default Request Provider dialog box opens.

  4. Select a request provider:

    • DIMENSIONS CM: use Dimensions CM requests.

    • NONE: requests are not used.

    • Select an external request provider such as Jira.

  5. Click OK.

Back to top

Assign and remove products from Jira request providers

To use Jira issues in Dimensions CM, you assign products to a Jira request provider.

Note:

  • Only one external request provider type can be used in each CM database. You cannot map different request provider types to different CM products in the same database. For example, if you set Jira as the provider, SBM and ALM Octane product mappings are ignored.
  • You can map a request provider that is not set as the default provider.
  • Products that are not mapped to a request provider use the default provider.

To assign and remove products from Jira request providers:

  1. Log in to the Dimensions CM administration console.
  2. In the Database Management section, click External request providers. The External Request Provider page opens.
  3. In the navigation pane on the sidebar, expand the Jira tree and select a Jira request provider.

  4. In the content pane, in the Mapped Products section, click the Edit button. The Change Product Mapping dialog box opens.
  5. To assign products, select one or more products in the Other products list and click Assign >>. The products are added to the Assigned products list. 

    To remove products, select one or more products in the Assigned products list and click << Remove. The products are added to the Other products list.

  6. Click OK.

Back to top

Map to specific Jira projects

After defining a Jira request provider, you can narrow down the list of projects from which to use Jira issues. By default, Dimensions CM uses issues from all projects in a configured Jira instance.

To map to specific Jira projects:

  1. Log in to the Dimensions CM administration console.
  2. In the Database Management section, click External request providers. The External Request Provider page opens.
  3. In the navigation pane on the sidebar, expand the Jira tree and select a Jira request provider.

  4. In the content pane, in the Jira Projects section, click the Change mapped projects button. The Change Jira Projects Mapping dialog box opens.

  5. One by one, move projects from the Available Projects list to Selected Projects.

    Dimensions CM will pick up Jira issues only from the selected projects.

  6. Click OK.

Back to top

Modify existing Jira request providers

You can modify the settings for existing Jira request providers.

To modify Jira request providers:

  1. Log in to the Dimensions CM administration console.
  2. In the Database Management section, click External request providers. The External Request Provider page opens.
  3. In the navigation pane on the sidebar, expand the Jira tree and select a Jira request provider.

  4. In the content pane, in the General section, click the Edit button. The Edit Request Provider dialog box opens.
  5. Make the changes and click OK.

Back to top

Remove Jira request providers

You can remove existing Jira request providers.

Caution: After you remove a Jira provider, Jira issues in CM clients do not display details of earlier used requests, for example, Title and Owner.

To remove Jira request providers:

  1. Log in to the Dimensions CM administration console.
  2. In the Database Management section, click External request providers. The External Request Provider page opens.
  3. In the navigation pane on the sidebar, select the Jira node.

  4. In the content pane, in the External Requests Providers section, select one or more Jira providers to remove.

  5. Click the Delete request provider button and confirm.

Back to top

See also: