Jira Server integration

Jira Server integration lets you link Jira Server projects to associated products so you can have visibility into all tickets and related data. This integration lets you prioritize more efficiently and track all work related to those projects.

Subtasks from Jira issues are not used in calculations for screens that use Jira data, like Investment area, Activity, and Cycle time.

Jira Server integration includes support for Jira Data Center. Jira Data Center provides a cluster environment that allows you to horizontally scale out your infrastructure so you can support more users. Refer to Atlassian Data Center for more information. Jira Server and Jira Data Center 7.13.0 and above are supported.

Integration with Jira Server is provided through a CloudBees Software Delivery Management plugin available on the Atlassian Marketplace.

After you install the plugin, you can establish a connection between the Jira Server and your CloudBees Engineering Efficiency user profile. The CloudBees Software Delivery Management plugin can be configured to allow a connection between the plugin and a proxy server. This allows the Jira Server to connect to your CloudBees Engineering Efficiency user profile using a proxy.

When you upload and install the CloudBees Engineering Efficiency plugin in the Jira Data Center, it automatically runs on all nodes of the cluster.

Refer to Jira Server data integration for details about data stored and used from Jira Server.

Optional proxy server

Customers have the option to install an NGINX proxy in their environment. This allows the plugin to run on an on-premise Jira instance in a customer’s environment. The customer may not want multiple services calling out to CloudBees Engineering Efficiency injectors.

The NGINX proxy server is optional. The plugin will function so long as it can connect to CloudBees Engineering Efficiency on port 443.

Currently, this proxy can be configured to receive data from multiple sources such as Jira Server, GitHub Enterprise, and Jenkins and pass it to CloudBees Engineering Efficiency. You only need to authorize outbound traffic from the proxy. To accommodate this, all data is pushed from the plugin to the CloudBees Engineering Efficiency service.

The CloudBees Engineering Efficiency service does not send requests back to the plugin for data; communication is one-way.

Once the plugin is installed onto a server, the user can associate this server with their CloudBees user profile in CloudBees Engineering Efficiency using the Jira Server app.

Installing the CloudBees Software Delivery Management plugin on the Jira Server

You must have Jira Server administrative privileges to upload and install the CloudBees Engineering Efficiency plugin.

You must install the CloudBees Software Delivery Management plugin to establish a connection between the Jira Server and your CloudBees Engineering Efficiency user profile. To install the plugin:

  1. Sign in to your Jira Server instance as an admin.

  2. On the top right, select the Settings icon.

  3. Select Manage apps on the drop-down menu.

  4. Enter your Jira Server administrative credentials.

  5. On the sidebar menu on the left, select Manage apps.

  6. Search for CloudBees Software Delivery Management.

  7. Select Jira Server from the drop-down menu.

  8. Select Get it now.

  9. Select a Jira Server site to install the app.

  10. Select Install app.

  11. Follow the on-screen instructions.

Connecting your CloudBees Engineering Efficiency user profile and the Jira Server

Use the following sections to connect the Jira Server to your CloudBees Engineering Efficiency user profile.

The steps are different depending on whether your Jira Server instance is available on the public internet or if it is behind a firewall and not reachable by CloudBees Engineering Efficiency.

This is a four-step process:

  1. First, obtain a Refresh Token from CloudBees Engineering Efficiency.

  2. Use that token to configure the CloudBees Software Delivery Management plugin in your Jira Server instance.

  3. While you’re in Jira, copy some information about your Jira Server instance:

    1. If your Jira Server is on the public internet, copy the URL of the server.

    2. If your Jira Server is behind a firewall, copy the Server ID from the plugin config page.

  4. Return to CloudBees Engineering Efficiency to add a connection back to Jira.

The steps are explained below.

This procedure requires CloudBees Engineering Efficiency administrator rights.

Obtaining a Refresh Token from the Jira Server app

Sign into CloudBees Engineering Efficiency with administrative privileges to connect to the Jira Server with the base URL:

  1. In the top right, select your organization to open the User profile menu and then select your name.

  2. In the left navigation, select Engineering Efficiency  Apps.

  3. Select Jira Server.

  4. Select the Security Tokens tab.

    Refresh token
    Figure 1. Refresh token tab
  5. Select Create refresh token and enter a memorable Token name.

  6. Copy the resulting Refresh Token that is created.

    You won’t see the token value again. However, you can delete it and add new ones.

Setting up the Jira Plugin in your Jira Server instance

Now that you have a Refresh Token, you can set up the Jira Server plugin.

The CloudBees Software Delivery Management plugin must be installed before connecting your CloudBees Engineering Efficiency user profile.

Sign into your Jira Server instance with administrative privileges to connect to a proxy:

  1. Sign into your Jira Server instance as an admin.

  2. On the top right, select the Settings icon.

  3. Select Manage apps on the drop-down menu.

  4. Enter your Jira Server administrative privileges.

  5. On the menu on the left side, select CloudBees Software Delivery Management Plugin.

  6. Enter the Refresh Token that you obtained in the previous section.

  7. If your Jira Server is behind a firewall then copy the Server ID using the button next to the text field.

  8. (Optional) If you want to use a proxy, then select Use proxy.

    1. Enter the URL of a proxy server.

    2. Select Test connectivity to confirm the connection.

    3. Select Save.

If no proxy URL is provided, you can establish a direct connection between your CloudBees Engineering Efficiency user profile and the Jira Server.

Creating a Jira Server Connection in CloudBees Engineering Efficiency

Sign into CloudBees Engineering Efficiency with administrative privileges to connect to the Jira Server with the base URL:

  1. In the top right, select your organization to open the User profile menu and then select your name.

  2. In the left navigation, select Engineering Efficiency  Apps.

  3. Select Jira Server.

  4. Select the Configuration tab.

  5. If you are configuring your first connection, select Configure. Otherwise, select Add connection.

  6. If your Jira Server is available on the public internet, the enter your base Jira Server URL.

    1. If you are not logged into the Jira Server, the login window appears. Enter your credentials.

  7. If your Jira Server is behind a firewall, then click the Manual entry link.

    1. Enter the Server ID that you copied from the Jira Server plugin management page in Jira.

  8. Select Continue.

  9. If successful, the Successful connection box appears. Select Close.

Now that your CloudBees Engineering Efficiency user profile and the Jira Server are connected, you can link your Jira Server projects to products within CloudBees Engineering Efficiency which allows you to have visibility into all tickets and related data.

Removing the connection to a Jira Server

If you no longer wish to use a Jira Server connection, you can remove it. Sign into CloudBees Engineering Efficiency with administrative privileges to remove the connection to a Jira Server:

  1. In the top right, select your organization to open the User profile menu and then select your name.

  2. In the left navigation, select Engineering Efficiency  Apps.

  3. Select Jira Server.

  4. Select the Configuration tab.

  5. Choose the connection that you want to remove and select the vertical three dots on the right side.

  6. Select Remove. The Remove connection window opens.

  7. Select Remove. A window appears with a message that the Jira Server was successfully removed.

Requesting data removal

Once data is imported into the System of Record, data will stay synchronized as part of normal operations as data changes. You can request to have data removed from your organization by contacting CloudBees support.