Summary
The Digital.io Agility plugin provides the integration with Digital.io Agility server. The plugin imports work items from a Digital.io Agility server and provides a single view consisting of all the work items in Urban Code Velocity value stream map.
Compatibility
This plugin requires the following:
- HCL Accelerate version 2.0 or later
- Digital.io Agility Server Version 21.0 or later
History
The following table describes the changes made in each plugin version.
Plugin history details
Version |
Description |
1.0.26 |
Clarifying delimitation problem for properties used. ( Example: Comma separated list ) |
1.0.20 |
User access key related changes. |
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 |
Usage
To use the Digital.io 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 Digital.io Agility plugin supports scheduled events integration which are listed in the following table.
Scheduled events
Name |
Description |
SyncV1WorkItems |
Queries the Digital.io Agility server for new or updated work items. |
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 integrations.
Using the user interface
- From the Plugins page, click Settings > Integrations > Plugins.
- Under the Action column for the plugin, click Add Integration.
- On the Add Integration page enter values for the fields used to configure the integration and define communication.
- 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.
- From a value stream page, download the value stream map. The value stream map is a JSON file used to define integrations.
- Edit the JSON file to include the plugin configuration properties.
- Save and upload the JSON file. This replaces the current JSON file with the new content.
- 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 Digital.ai Agility Configuration Properties table describes the Digital.ai Agility configuration properties that define the connection and communications with the Digital.ai 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 Digital.ai 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 Digital.ai Agility plugin is ucv-ext-agility |
Yes |
type |
Digital.ai Agility Configuration Properties
Name |
Type |
Description |
Required |
Property Name |
AccessToken |
Secure |
The access token to authenticate with the Digital.io 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 Digital.io 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 |
Comma seperated list of Digital.io 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 Digital.io Agility server. |
Yes |
serverUrl |
User ID |
String |
The user name used to authenticate with the Digital.io 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": "Digital.ai",
"properties":{
"serverUrl":"https://www53.v1host.com/XYZ",
"projects" : ["Sample: Call Center Product"],
"userId" : "admin",
"accessToken" : "access_token",
"ucvAccessKey":"ucv-access-key",
"proxyServer": "https://123.456.1.4:1128",
"proxyUsername":"admin",
"proxyPassword":"12345"
}
}