The Rally plugin enables you to create, read, update, delete and query Rally objects. This plugin also links to a new report that contains information from the Rally server about what was linked, updated, or created.
The plugin interacts with Rally API using PERL and JSON to perform the following tasks:
-
Create configuration to hold connection information.
-
Query object information.
-
Create, read, delete, and update objects.
For more information, refer to the Rally software website.
Plugin Version 2.0.0 Revised on February 15, 2024
Integrated version
This plugin was developed and tested against version Rally Community Edition - Build 2012.03.24-3
Plugin procedures
| For all parameter descriptions below, required parameters are shown in bold italics. |
Plugin configuration
Plugin configurations are sets of parameters that apply across some or all of the plugin’s procedures. They are intended to reduce repetition of common values, create predefined sets of parameters for end users, and to securely store credentials where needed. Each configuration is given a unique name that is entered in designated parameters on procedures that use them.
Navigate to , find EC-Rally, and select Configure.
| Parameter | Description |
|---|---|
Configuration Name |
Provide a unique name for the configuration, keeping in mind that you may need to create additional configurations over time. (Required) |
Description |
Provide a simple description for this configuration. |
Rally Url |
Provide the host name or IP address of the Rally server. (Required) |
Configuration Credential Parameters |
Rally account username/password or API key name/API key. This credential must have enough privileges to perform API functions. |
Debug Level |
Level for output: 0=errors only, 1=normal headers and responses, 2+=debugging information included. (Required) |
API version |
API version to use. (Required) |
CreateObject
This procedure allows you to create a new Object on Rally server.
| Parameter | Description |
|---|---|
Configuration |
The name of the configuration which holds all the connection information for Rally. This must reference a valid existing configuration. (Required) |
Object Type |
Provide the object type to perform the create operation. (Required) |
JSON |
Provide the JSON structure of the object to create. (Required) |
ReadObject
This procedure allows you to read an Object on Rally server, and return the json.
| Parameter | Description |
|---|---|
Configuration |
The name of the configuration which holds all the connection information for Rally. This must reference a valid existing configuration. (Required) |
Object Type |
Provide the object type to perform the read operation. (Required) |
Use FormattedID?: |
If selected, specify the FormattedID in the next field, if not selected, use ObjectID. |
ID |
Provide the ID of the object (e.g. DE1057 or 205918369687). (Required) |
UpdateObject
This procedure allows you to update an existing Object on Rally server.
| Parameter | Description |
|---|---|
Configuration |
The name of the configuration which holds all the connection information for Rally. This must reference a valid existing configuration. (Required) |
Object Type |
Provide the object type to perform the update operation. (Required) |
Use FormattedID?: |
If selected, specify the FormattedID in the next field, if not selected, use ObjectID. |
ID |
Provide the ID of the object (e.g. DE1057 or 205918369687). (Required) |
JSON |
Provide the JSON structure with the attributes of the object to update. (Required) |
DeleteObject
This procedure allows you to delete an existing Object on Rally server.
| Parameter | Description |
|---|---|
Configuration |
The name of the configuration which holds all the connection information for Rally. This must reference a valid existing configuration. (Required) |
Object Type |
Provide the object type to perform the delete operation. (Required) |
Use FormattedID?: |
If selected, specify the FormattedID in the next field, if not selected, use ObjectID. |
ID |
Provide the ID of the object (e.g. DE1057 or 205918369687). (Required) |
QueryObject
This procedure allows you to Query for objects on Rally server.
| Parameter | Description | ||
|---|---|---|---|
Configuration |
The name of the configuration which holds all the connection information for Rally. This must reference a valid existing configuration. (Required) |
||
Fetch Full Object? |
Fetch the complete json structure of the object. |
||
Object Type |
Provide the object type to query the create operation. (Required) |
||
Order by |
Provide the Attribute to order the results. (e.g. Priority desc,Severity) |
||
Page Size |
Page size for results. Must be greater than 0 and not more than 100, default is 20. |
||
Query |
A query string (e.g. Name contains "foo") and (TargetBuild = "12345", (Description contains "baz")) |
||
Start Index |
Start index (1-based) for queries. The default is 1. |
||
Workspace URL |
If not set, the query runs in your default workspace. To use a different workspace, provide the workspace REST URL. If a Project URL is provided, you may omit the Workspace URL parameter, because the workspace is inherited from the project. Example Workspace URL:
|
||
Project URL |
If not set, or specified as Example Project URL:
|
||
Project Scope Up: |
In addition to the specified project, include projects above the specified one. (Default is true) |
||
Project Scope Down: |
In addition to the specified project, include child projects below the current one. (Default is true) |
Examples and use cases
Create a task
Create a new CreateObject procedure, fill in the requested parameters with real values from your Rally server:
CreateObject job:
CreateObject output:
Release notes
EC-Rally 2.0.0
-
Upgraded from Perl 5.8 to Perl 5.32. The plugin is not backward compatible with CloudBees CD/RO versions prior to 10.3. Starting from this release, a new agent is required to run EC-Rally plugin procedures.
-
Added TestConfiguration procedure.