Plug-in Compatibility Matrix

This section provides information about the compatibility requirements for the HCL DevOps Velocity and the Jira plug-in .

Prerequisites

This section provides information about the tasks that you must have completed to ensure a smooth setup and integration process. You must make sure to follow all the requirements before proceeding with the installation of the plug-in..

Before you begin:

• Created a kanban project in Jira with the following work statuses:
  • To Do
  • In Progress
  • In Review
  • Done
• Generated a personal access token for your Jira account.
• You must have sufficient permissions to create value streams and configure plugin integrations. For more information, refer to Roles and permissions.

   

Integration Procedure

This section provides information about integrating the Jira plug-in in HCLDevOps Velocity..

There are two methods to integrate the Jira plug-in:

1. Using the user interface.

2. Using a JSON file

Method 1: Integrating using the user interface.

Perform the following steps to integrate the Jira plug-in by using the user interface.

1. 1. On the Home page, click Settings > Integrations > Available tab.
2. 2. Select Jira from the list, and then click Install.
   The Add Jira Integration dialog is displayed.
3. 3. In the Integration name field, type a name for the integration. 
4. 4. In the URL field, type the URL for the Jira project. For example, https://my_project.atlassian.net
5. 5. Perform any of the authentication methods listed in the following table:

Jira server:

1. a. Type the personal access token in the Personal Access Token field.
2. b. Type the username in the Username field, type the password in the Password field.

Jira cloud version

1. a. Type the username in the Username field.
2. b. Type the personal access token in the Password field.

OAuth authentication

1. a. Type the consumer key in the Consumer Key field.
2. b. Type the consumer secret in the Consumer Secret field.
3. c. Type the access token in the Access Token field.
4. d. Type the access token in the Access Token Secret field.

Proxy server

1. a. Select the Show hidden properties checkbox.
2. b. Type the URL of the proxy server and the port number in the Proxy Server field.
3. c. Type the username for the proxy server in the Proxy Username field.
4. d. Type the password for the proxy server in the Proxy Password field.
5. e. Type the access token in the Access Token Secret field.

6. 6. If necessary, add the additional parameters listed in the following table: 

1. 7. Use defaults for the remaining fields in the integration, and then 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.

Method 2: Integrating using a JSOn file.

The JSON file contains the information for creating a value stream. Within the JSON file is a section for integrations. It is in this section that plugin properties can be defined. Refer to the JSON sample code in the Integration Properties section

Perform the following steps to integrate the Jira plug-in by using the user interface.

1. 1. On the Home page, click Settings > Integrations > Available tab.
2. 2. Select Jira from the list, and then click Install.
3. 3. Navigate to the value stream page, and then click the necessary value stream.
4. 4. Click the wrench icon, and then Select Edit value stream to modify the JSON file in the code or tree view editors.
   Alternatively, you can also click the Download JSON option to download the JSON file, and then select the Import JSON option to upload the revised JSON file.
5. 5. Edit the integration information in the JSON file to add the plug-in configuration properties. Refer to JSON sample code in the Integration Properties section for more details.
6. 6. Click Save.

Integration Properties

This section provides information about the properties used to configure the integration. Each table contains the field name when using the user interface and the property name when using a JSON file.

Usage

This section provides information on using  the plug-in after integration. It provides the basic usage and performs the tasks. Step-by-step instructions are provided to help with tasks such as configuring settings, running key functions, and verifying that the plug-in is working correctly. This ensures that users can quickly get started and use the plug-in effectively

A Jira integration, for example, provides Jira project data to the value stream. After integrating the Jira plug-in, now you can begin with creating a valuestream and configure the integration based on the project requirement. If you have already created a value stream, you can edit it. Otherwise follow the below steps to create a new valuestream and configure Jira data source into the value stream .

1. 1. On the Valuestreams page, click Create to create a Value stream. 
2. 2. Perform the following steps in Step 1 dialog.

1. 3. Select the Application Lifecycle Management Integration from the list in Step 2 Integrations dialog, and then click Next.
2. 4. Select the phases for Planning, Development, and Completed in Step 3 Stages/Phases dialog.

1. 5. Click Save. The Jira project is integrated into the value stream. 

All the work items are imported to HCL DevOps Velocity and  you can access project data and manage Jira issues. Each dot in the value stream page represents a card. Select the dot to display a card with information about the dot, including its history.

What to do next

You can perform the following tasks:

• Managing the value streams. See Value Stream Management.
• Modify the value stream. See Customizing the value stream.
• Get started with integrating Jira, GitHub, and Jenkins in HCL DevOps Velocity (Velocity). See Integrating Jira, GitHub, and Jenkins in DevOps Velocity.

FAQs

This section includes information about most frequently asked questions about the plug-in, integration, and usage. If you need further assistance, you can contact HCL Customer Support.

1. 1. How to troubleshoot the failed integration.

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.