Plug-in Documentation

Jira

 

Overview


The Jira plug-in provides for integration with a Jira server. This plug-in imports Jira issues and saves them as UrbanCode Velocity issues. Data between the Jira server and the UrbanCode Velocity server is synchronized every five minutes.

Compatibility

Must be running UrbanCode Velocity version 1.2.1 and later to use the plug-in.

Versions

There is no install process for this plug-in. The Jira plug-in is identified to UrbanCode Velocity as a value stream integration. UrbanCode Velocity plug-in images are located in DockerHub and the UrbanCode Velolcity code accesses the version that you select. To view available versions, see the UrbanCode DockerHub.

History

Version 1.0.38

  • Minor bug fix.

Version 1.0.36

  • Added HTTP proxy support.

Version 1.0.27

  • Update plugin version from 0.x.x to 1.x.x format.

Version 0.0.17

  • Initial release

Usage

To use the Jira plug-in you must define the integration, create a value stream, and upload the integration.

The value stream map contains the properties, you will use to define the plug-in integration. Basically, the plug-in integration is defined with a value stream within the UrbanCode Velocity user interface. Defining the integration includes defining configuration properties that connect the UrbanCode Velocity server to the Jira server.

The basic flow to use the plug-in includes:

  1. 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 plug-in 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 Integration user interface page.

The above steps are completed using the UrbanCode Velocity user interface. You have the option to edit the JSON file directly or define the integration using the add integration user interface. Click Settings > Integrations > Plugins. Click Add Integration next to the plug-in.

Integration type

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

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

Integration

From the user interface Value Steam page, click Upload to upload the value stream map which is a JSON file.

The JSON file contains the information for creating a value stream and integrating with the Jira server. The following table describes the information for the creating a UrbanCode Velocity value stream map.

Value stream map information
Name Description Required
image The version of the plug-in that you want to use. To view available versions, see the UrbanCode DockerHub. If a value is not specified, the latest version is used. No
name An assigned name to the value stream. Yes
loggingLevel The level of Log4j messages to log. Valid values are: all, debug, info, warn, error, fatal, off, and trace. The default is info. No
properties List of configuration properties used to connect and communicate with the Jira server. Enclose the properties within braces. Yes
tenant_id The name of the tenant. Yes
type Unique identifier assigned to the plug-in. The value for the Jira plug-in is ucv-ext-jira Yes

Configuration Properties

The configuration properties which are included in the properties field are unique to the Jira plug-in
and define the connection and communication to the Jira server.

If editing the JSON file, use the name in the Property Name column.

Configuration properties
Name Type Description Required Property Name
Access Token String The access token for oauth authentication with the Jira server. No access_token
Access Token Secret String The access token secret for oauth authentication with the Jira server. No access_token_secret
Consumer Key String The consumer key for oauth authentication with the Jira server. No consumer_key
Consumer Secret String The consumer secret for oauth authentication with the Jira server. No consumer_key_secret
Projects Array A list of Jira project to import data from. No jiraProjects
Proxy Password String The password used to authenticate with the proxy server. No proxyPassword
Proxy Server String The URL of the proxy server including the port number. No proxyServer
Proxy User Name String The user name used to authenticate with the proxy server. No proxyUsername
URL String The base URL of the Jira server. Yes baseUrl
User Name String The user name used to authenticate with the Jira server. No username

Example

The following example can be used as a template to include the Jira plug-in integration into the JSON file.
Copy and paste the template into the JSON file 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"
      }
    }  ]