Lesson 1: Integrating with Jira

You can learn about integrating the Jira plug-in in HCL DevOps Velocity (Velocity).

Before you begin

  • Created a project in kanban project in Jira with the following work statuses:
    • To Do
    • In Progress
    • In Review
    • Done
    Note: The work statuses helps in tracking and managing work efficiently from initiation to completion. The minimum work statuses that are necessary to track the issues in Jira are To Do, In progress, In Review, and Done.

Procedure

  1. On the Home page, click Settings > Integrations > Available tab.
  2. Select Jira from the list, and then click Install.
    The Add Jira Integration dialog is displayed.

  3. In the Integration name field, type a name for the integration. For example, TUTORIAL_JIRA.
  4. In the URL field, type the URL for the Jira project. For example, https://my_project.atlassian.net
  5. Perform any of the authentication method listed in the following table:
    Authentication Action
    For Jira server
    Perform any of the following actions:
    • Type the personal access token in the Personal Access Token filed, and then continue with 6.
    • Type the username in the Username filed, type the password in the Password filed, and then continue with 6.
    For Jira cloud version
    Perform the following steps to authenticate using Jira login credentials:
    1. Type the username in the Username filed.
    2. Type the personal access token in the Password filed, and then continue with 6.
    For OAuth authentication
    Perform the following steps to authenticate using OAuth:
    1. Type the consumer key in the Consumer Key filed.
    2. Type the consumer secret in the Consumer Secret filed.
    3. Type the access token in the Access Token filed.
    4. Type the access token in the Access Token Secret filed, and then continue with 6.
    For proxy server
    Perform the following steps to authenticate with proxy server:
    1. Select the Show hidden properties checkbox.
    2. Type the URL of the proxy server and the port number in the Proxy Server field.
    3. Type the username for the proxy server in the Proxy Username filed.
    4. Type the password for the proxy server in the Proxy Password filed.
    5. Type the access token in the Access Token Secret filed, and then continue with step 6.
  6. If necessary, add the additional parameters listed in the following table or continue with step 7:
    Parameter Action
    DevOps Velocity user access key Optional: Accept the default value or type the user access key that the containerized plugin will use to interact with Velocity in the DevOps Velocity user access key filed.
    JQL Query Optional: Accept the default value or type the JQL query.
    Note: JQL Query has higher priority than Project Keys . If JQL Query is added, then Project Keys will not work .
    Request Timeout Optional: Accept the default value or type the timeout in seconds to apply to each request to the Jira server.

    Range is 10 to 150 seconds
    Custom Field Mapping Optional: Accept the default value or type the value expected by the server as a Name Value pair. For example, "Epic Link": "Epic field in Jira", "Sprint": "Sprint field in Jira", "Story Points": "Story field in Jira
  7. Use defaults for the remaining fields in the integration, and the click Add.
    The integration is listed on the Integrations page and Status field displays that the integration is Online.

    If the integration is not successful, the Status field displays that integration is Failed. You must use the View log option to troubleshoot the integration.

  8. Synchronization of plug-in is set to 5 minutes by default. You can disable synchronization by using toggle icon in the Disable/Enable section on the Configured tab.
    Note: Synchronization of plug-in ensures that the changes or updates are consistently reflected across all the integrated applications.
    In this lesson, you have learned to integrate Jira plug-in in Velocity.

What to do next

You can learn about integrating GitHub plug-in in Velocity. See Lesson 2: Integrating with GitHub.