Summary
Usage
Configuration Properties
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.
| 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 |
| 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 |
| JQL Query | String | Any valid JQL Query. | 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","John-Project 2"],
"jiraJql":"project in ("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”
