Description

Jira is an issue tracking product, developed by Atlassian. The Jira plugin provides an integration with Jira to import and work with Jira work items.

Quick Info

Product
HCL Accelerate
Type
plugin
Compatibility
HCL Accelerate version 2.0 or later
Created by
HCL Software
Website
Version Name Action

1.0.39

ucv-ext-jira:1.0.39.tar

1.0.49

ucv-ext-jira:1.0.49.tar

1.0.50

ucv-ext-jira:1.0.50.tar

1.0.51

ucv-ext-jira:1.0.51.tar

1.0.52

ucv-ext-jira:1.0.52.tar

1.0.64

ucv-ext-jira:1.0.64.tar

1.0.65

ucv-ext-jira:1.0.65.tar

1.0.74

ucv-ext-jira:1.0.74.tar

ucv-ext-jira:1.0.39.tar

1.0.39


ucv-ext-jira:1.0.49.tar

1.0.49


ucv-ext-jira:1.0.50.tar

1.0.50


ucv-ext-jira:1.0.51.tar

1.0.51


ucv-ext-jira:1.0.52.tar

1.0.52


ucv-ext-jira:1.0.64.tar

1.0.64


ucv-ext-jira:1.0.65.tar

1.0.65


ucv-ext-jira:1.0.74.tar

1.0.74


Summary

The Jira plugin provides for integration with a Jira server. This plugin imports Jira issues and saves them as HCL Accelerate issues. Data between the Jira server and the HCL Accelerate server is synchronized every five minutes.

Compatibility

This plugin requires HCL Accelerate version 2.0 or later.

Upgrade notes

Beginning with HCL Accelerate version 2.4.0 users must enter a user access key is required to connect with the HCL Accelerate server. If you are upgrading from a previous version, you must obtain and add the key to the HCL Accelerate User Access Key configuration property. If the user access key is not added, the integration fails.

History

The following table describes the changes made in each plugin version.

Plugin history details
Version Description
1.0.74 Enhanced support for epics/ features.
1.0.64 ReSync support added (support starts with HCL Accelerate version 2.4.4 or later).
Auto-generated User Access Key support added (support starts with HCL Accelerate version 2.4.0 or later).
1.0.51 Minor enhancements.
1.0.50 Jira rate limit issue fix.
1.0.49 Minor bug fix.
1.0.39

Usage

To use the Jira plugin, the plugin must be loaded and an instance created before you can configure the plugin integration. You define configuration properties in the user interface or in a JSON file.

Integration type

The Jira plugin supports scheduled events integration which are listed in the following table.

Scheduled events
Name Description
SyncJiraDataEvent Synchronize data from a Jira server.

Integration

There are two methods to integrate the plugin:

  • Using the user interface
  • Using a JSON file

The tables in the Configuration properties topic describe the properties used to define the integration.

Using the user interface

  1. From the Plugins page, click Settings > Integrations > Plugins.
  2. Under the Action column for the plugin, click Add Integration.
  3. On the Add Integration page enter values for the fields used to configure the integration and define communication.
  4. Click Save.

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.

  1. From a value stream page, download the value stream map. The value stream map is a JSON file used to define integrations.
  2. Edit the JSON file to include the plugin configuration properties.
  3. Save and upload the JSON file. This replaces the current JSON file with the new content.
  4. View the new integration on the Integrations page.

Minimum permission to integrate with Jira

The Jira Account used to generate the access token must have access to the project which is being integrated with HCL Accelerate.

Configuration Properties

The following tables describe 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.

  • The General Configuration Properties table describes configuration properties used by all plugin integrations.
  • The Jira Configuration Properties table describes the configuration properties that define the connection and communications with the Jira server.

Some properties might not be displayed in the user interface, to see all properties enable the Show Hidden Properties field.

General Configuration properties
Name Description Required Property Name
NA The version of the plugin that you want to use. To view available versions, click the Version History tab. If a value is not specified, the version named latest is used. No image
Integration Name An assigned name to the value stream. Yes name
Logging Level The level of Log4j messages to display in the log file. Valid values are: all, debug, info, warn, error, fatal, off, and trace. No loggingLevel
NA List of plugin configuration properties used to connect and communicate with the Jira server. Enclose the properties within braces. Yes properties
The name of the tenant. Yes tenant_id
NA Unique identifier assigned to the plugin. The value for the Jira plugin is ucv-ext-jira. Yes type
HCL Accelerate User Access Key An auto-generated user access key provides credentials for communicating with the HCL Accelerate server. Yes NA

Jira Configuration Properties
Name Type Description Required
Access Token String The access token for oauth authentication with the Jira server. No
Access Token Secret String The access token secret for oauth authentication with the Jira server. No
Consumer Key String The consumer key for oauth authentication with the Jira server. No
Consumer Secret String The consumer secret for oauth authentication with the Jira server. No
Projects Array A list of Jira project to import data from. No
Proxy Server String The URL of the proxy server including the port number. No
Proxy User Name String The user name used to authenticate with the proxy server. No
Proxy Password String The password used to authenticate with the proxy server. No
URL String The base URL of the Jira server. Yes
User Name String The user name used to authenticate with the Jira server. No
Custom Field Mapping Multiline Map Jira fields to the fields expected by this server as a Name Value pair, eg: “Epic Link”: “Epic field in Jira”, “Sprint”: “Sprint field in Jira”, “Story Points”: “Story field in Jira. Yes

JSON code sample

The following sample code can be used as a template to define the integration within the JSON file for a value stream. Copy and paste the template into the JSON file Integration section and make the appropriate changes.


 "integrations": [
    {
      "type": "ucv-ext-jira",
      "tenant_id": "tenantid",
      "name": "Jira_Plugin ",
      "properties": {
        "baseUrl": "jira_server_url",
        "username": "jira_server_user_name",
        "password": "jira_server_password",
        "consumer_key": null,
        "consumer_secret": null,
        "access_token": null,
        "access_token_secret": null,
        "jiraProjects": [
          "John-Project"
        ],
        "proxyServer": "proxy_server_url",
        "proxyUsername": "proxy_server_user_name",
        "proxyPassword": "proxy_server_password"
      }
    }  ]

Custom Field Mapping

The plugin assumes that the Jira server uses the fields names for Epics, Sprint and Story Points as  ‘Epic Link’, ‘Sprint’ and Story Points’. If the Jira server uses different field names than these, then the ‘Custom Field Mapping’ plugin property can be used to map the Jira field names to the above default field names assumed by the plugin. The field names can be mapped as name value pairs.

Example of a custom field mapping:

“Epic Link”: “Epic field name in Jira server”, “Sprint”: “Sprint field name in Jira server”, “Story Points”: “Story field name in Jira server”