Description is Enterprise level planning and tracking platform to build agile practices that scale across the enterprise. The Agility plug-in provides an integration with the Agility server to import Agility work items.

Quick Info

HCL Accelerate
HCL Accelerate version 2.0 or later
Created by
HCL Software
Updated Date
August 10, 2021
Version Name Modified date Action


ucv-ext-agility:1.0.11.tar 10-Aug-2021 04:36


ucv-ext-agility:1.0.4.tar 08-Feb-2021 07:31


ucv-ext-agility:1.0.9.tar 05-May-2021 05:11








The Agility plugin provides the integration with Agility server. The plugin imports work items from a Agility server and provides a single view consisting of all the work items in Urban Code Velocity value stream map.


This plugin requires the following:

  • HCL Accelerate version 2.0 or later
  • Agility Server Version 21.0 or later


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

Plugin history details
Version Description
1.0.11 Auto-generated User Access Key support added (support starts with HCL Accelerate version 2.4.0 or later)
1.0.4 Minor enhancements


To use the Agility 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 Agility plugin supports scheduled events integration which are listed in the following table.

Scheduled events
Name Description
SyncV1WorkItems Queries the Agility server for new or updated work items.


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 integrations.

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.

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 Agility Configuration Properties table describes the Agility configuration properties that define the connection and communications with the Agility server. When using the JSON method to integrate the plugin these properties are coded within the properties configuration property.

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 Agility 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 Agility plugin is ucv-ext-agility Yes type Agility Configuration Properties
Name Type Description Required Property Name
AccessToken Secure The access token to authenticate with the Agility server. Either the Password or AccessToken property must contain a value. Do not specify a value for both at the same time. No accessToken
Password Secure The password used to authenticate with the Agility server. Either the Password or AccessToken property must contain a value. Do not specify a value for both at the same time. No password
Projects Array A list of Agility projects from which work items are imported. Yes projects
Proxy Password Secure The password used to authenticate with the proxy server. No proxyPassword
Proxy Server String The URL of the proxy server including the port number. The URL protocol can be http or https. No proxyServer
Proxy User Name String The user name used to authenticate with the proxy server. No proxyUsername
User Access Key Secure The user access key generated from HCL Accelerate used to authenticate with the HCL Accelerate server. Yes ucvAccessKey
URL String The URL of the Agility server. Yes serverUrl
User ID String The user name used to authenticate with the Agility server. Yes userId

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.

    "type": "ucv-ext-agility",
  "tenant_id": "tenant_ID", 
  "name": "", 
  "projects" : ["Sample: Call Center Product"],
  "userId" : "admin",
  "accessToken" : "access_token",
  "proxyServer": "https://123.456.1.4:1128",