Plug-in Documentation

Rally

Overview

The Rally plug-in for IBM UrbanCode Release imports entities from Rally as changes in IBM UrbanCode Release. The plug-in also includes steps that test the connection to the Rally server, and test the authentication key that you provide.

Compatibility

  • The IBM UrbanCode Release plug-in for Rally supports the Rally Web API Version 2.0.
  • This plug-in requires version 6.1.1.2 or later of IBM UrbanCode Release.

Installation

No special steps are required for installation. See Installing plug-ins in the IBM UrbanCode Release help.

History

Version 2

This is the initial public release of the plug-in.

Usage

Configuring integration with Rally

You can use the Rally plug-in for IBM UrbanCode Release to create an integration provider and import items from Rally into IBM UrbanCode Release change items.

  1. In IBM UrbanCode Release, click Integrations > Add New. The New Integration Provider window opens.
  2. Type a name for the integration provider in the Name field. For example, type Rally Test Cases.
  3. In the Integration Type list, select Rally Plugin.
  4. In the Frequency list, select a frequency. The frequency determines how often Rally is polled for changes to import. Also, you can manually update changes any time.
  5. In the Rally server URL field, type the root URL of the Rally server. For example, enter http://rally_server.example.com.
  6. In the API Key field, enter an API key. You create API keys on the Rally server. To learn more about creating API keys, see the Rally Help.
  7. Click Ping the Rally Server and Check Authentication to test the connection to the Rally server.
  8. In the Rally WSAPI Type list, select a type to import. You can import only one Rally type for each integration provider that you create. Repeat all of these steps to create an integration provider for each Rally type to import.
  9. Optionally, click Sample JSON to view the JSON output from Rally for the first result that matches the specified Rally WSAPI type. You can use the sample output to assist in determining what fields to use to map the Rally items to initiatives, releases, and applications in IBM UrbanCode Release.
  10. In the Change Type list, map the Rally type to a change type in IBM UrbanCode Release. For example, if you select defect from the Rally WSAPI Type list, select bug from the Change Type list. Each item that is retrieved from Rational Team Concert is associated with a release and an application or an initiative in IBM UrbanCode Release based on the mappings.
    1. Optionally, in the Field for Initiative Association list, select the name of a key from the Rally JSON output. The imported change is associated with the initiative in IBM UrbanCode Release that has the same name as the key value. Alternately, to create initiatives in IBM UrbanCode Release from the key value, select Create Initiative if Necessary.
    2. Optionally, in the Field for Release Association list, select the name of a key from the Rally JSON output. If a release with the same name as the key value exists in IBM UrbanCode Release, then the imported change is associated with that release.
    3. Optionally, in the Field for Application Association list, select the name of a key from the Rally JSON output. If an application with the same name as the key value exists in IBM UrbanCode Release, then the imported change is associated with that application.
  11. Under Statuses Mapping, for each status type in Rally to map to a status type in IBM UrbanCode Release, select the Rally status type from the Rally Statuses Statuses created in Rally list and then select a corresponding IBM UrbanCode Release status type from the
    UCR Statuses Statuses available in UCR list.
  12. Under Severities Mapping, for each severity type in Rally to map to a severity type in IBM UrbanCode Release, select the Rally severity type from the Rally Severities Severities created in Rally list and then select a corresponding IBM UrbanCode Release severity type from the UCR Severities UrbanCode Release Severities list.
  13. Click Save.

The Rally integration runs at the frequency that you specified in step 4. To run the integration manually, select the integration on the Integrations page, click the Edit icon, and then click Run Integration.

Settings

The following integration settings are available when you install the Rally plug-in.

Integration properties
Name Type Description Required
API Key Password Login into the App Manager and generate an API Key for your Rally Instance No
Change Type The change type that will be applied to the changes that are imported from Rally No
Check Authentication Button to verify the API Key and Rally Authentication No
Configuring an integration provider for Rally Entities This Rally Plugin can import a number of Rally objects including defects, test cases,
tasks, and more. Select the Rally object type you want to import, select the resulting
UCR change type, and then select the Rally fields used to associate Releases, Applications,
and Initiatives.
No
Create Initiative if Necessary Boolean Check this box if the initiative does not yet exist. Initiative will be imported. No
Field for Application Association This will associate an application to the imported change if that applications name
is the same as the value for this key in the Rally JSON
No
Field for Initiative Association This will associate an initiative to the imported change if that initiatives name
is the same as the value for this key in the Rally JSON
No
Field for Release Association This will associate a release to the imported change if that releases name is the
same as the value for this key in the Rally JSON
No
Ping the Rally Server Button to check if the connection can be established with the Rally Server No
Rally WSAPI Type Enumeration This is the Rally entity for which the plugin will query, for example: testcase or defect. Specify one of these values: TestCase, Milestone, Defect, DefectSuite, Blocker, Change, Task, or HierarchicalRequirement.

No
Rally server URL String The Rally server URL No
Reset Button to delete all items retrieved from that integration No
Sample JSON Button to get sample JSON from the first result of the specified WSAPI type No