Quick Info
Description
Rally is an Agile project management tool for planning, scheduling, and tracking iterations and releases. The Rally plug-in provides for integration with a Rally server. It imports Rally artifacts into the HCL DevOps Velocity server.Quick Info
No record found please add past version link
Summary
Usage
Configuration PropertiesSummary
The Rally plugin provides for integration with a Rally server. This plugin imports work items from a Rally server and saves them as HCL DevOps Velocity issues. The plugin uses the Rally REST API to import data from a Rally server. Data between the Rally server and the HCL DevOps Velocity server is synchronized every five minutes.
History
The following table describes the changes made in each plugin version.
| Version | Description |
|---|---|
| 1.0.41 | Clarifying delimitation problem for properties used. ( Example: Comma separated list ) |
| 1.0.34 | User access key related changes. |
| 1.0.17 | Added HTTP proxy support |
| 1.0.16 | Improve history data |
Usage
To use the Rally 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 Rally plugin supports scheduled events integration. There is only one scheduled event which is described in the following table.
| Name | Description |
|---|---|
| syncRallyDataEvent | Queries the Rally server for stories and defects to import into HCL DevOps Velocity issues. If the Rally data already exists as an issue, the issue is updated. |
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
- 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 Rally Configuration Properties table describes the configuration properties that define the connection and communications with the Rally server. When using the JSON method to integrate the plugin these properties are coded within the
propertiesconfiguration property.
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 latest version is used. | No | image |
| Integration Name | An assigned name to the value stream. | Yes | name</td |
| 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 configuration properties used to connect and communicate with the Rally 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 Rally plugin is ucv-ext-rally |
Yes | type |
| Name | Type | Description | Required | Property Name |
|---|---|---|---|---|
| API Token | Secure | The API token used to authenticate with the Rally server. You must specify a value for either this property or username and password properties. | No | apiKey |
| Projects | Array | Comma seperated list of Rally project names to import data. | No | projects |
| Password | Secure | The password used to authenticate with the Rally server. Specify either the username and password properties or the apiKey property. | No | password |
| URL | String | The URL of the Rally server. The default is https://rally1.rallydev.com. | Yes | baseUrl |
| User Name | String | The user name used to authenticate with the Rally server. Specify either the username and password properties or the apiKey property. | No | username |
| ucvAccessKey | Secure | The user access key used to authenticate with the HCL DevOps Velocity server. | Yes | ucvAccessKey |
| Workspace | String | The name of the Rally workspace to use on request. This property is required if you are not using a default workspace. | No | workspace |
| 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 |
| Proxy Password | String | The password used to authenticate with the proxy server. | No | proxyPassword |
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-rally",
"name": "my-rally",
"tenant_id": "5ade13625558f2c6688d15ce",
"logginglevel": "log_level_value",
"properties": {
"baseUrl": "https://rally1.rallydev.com",
"username": "my_username",
"password": "my_password",
"workspace": "Workspace1",
"projects": [
"Sample Project"
],
"logLevel": "info",
"proxyServer": "proxy_server_url_with_port",
"proxyUsername": "proxy_server_user_name",
"proxyPassword": "proxy_server_password"
}
}
]
Data Virtualization , Issue Tracking 
