App SDK
SDK 2.0 Preview
App SDK 2.0 DocumentationSDK v1.30
Apps allow you to extend and customize your Rally subscription or integrate to 3rd party systems. Apps are written in JavaScript and deployed within your Rally subscription as a custom page. Since the app content is stored within your Rally subscription, you gain the deployment benefits of Software-as-a-Service.
The App SDK includes a set of data aware user interface components that allow for quicker and easier creation of custom Apps. UI components include iteration, release, and program dropdowns, pie chart, table, attribute dropdown, object dropdown, and standard reports. A RallyDataSource component allows an intuitive interface to the data in your Rally subscription.
This document provides a basic overview of how to use v1.30 of the App SDK to build apps as well as a reference for the commands, parameters, and return values of the App SDK.
For a basic introduction to app development and Rally recommended tips and tricks see App Development: Getting Started
Data Components
| Rally Data Source | Provides an intuitive interface to the data in your Rally subscription. |
UI Components
| Attribute Dropdown | Object Dropdown | Table |
|
Show the drop-down values for any Rally object. For example, priorities on a defect |
Show a drop-down filled with Rally objects. For example, a list of completed stories. | Arrange Rally Data (or other data) in a tabular format |
 |
 |
 |
| Iteration Dropdown | Release Dropdown | Program Dropdown |
| Display the Rally Iterations in a Project with the default chosen automatically | Display the Rally Releases in a Project with the default chosen automatically | Display the Rally Programs in a Workspace |
 |
 |
 |
| Standard Report | Pie Chart | App Header |
| Show a Rally report. | Show the count of Rally objects in each of the values for a dropdown field. For example, the number of defects in each severity. | Provides a consistently styled banner for apps and exposes common utilities like page tools and help. |
 |
 |
   |
| Card Board | Chooser | Add New |
| Visualize data as cards on a board. | A dialog that displays artifacts to select. | Create new items (stories, defects, etc.) |
 |
 |
 |
Basic Components
| Button | CheckBox | Dropdown |
| A simple clickable action button. | A stateful checkbox and label. | Display data in a stateful drop-down list. |
 |
 |
 |
| Link | Tooltip | Wait |
| Link to the detail page of an item. | Display tooltips in an app. | Give feedback that a long running operation is occurring. |
 |
 |
 |
| Edit Link | TextBox | Dialog |
| Popup the edit page of an item. | A stateful textbox and label. | Display a modal dialog. |
 |
 |
 |
| RadioButton | RadioButtonGroup | |
| A stateful radio button. | A stateful group of radio buttons. | |
 |
|
Utilities
| AppInfo | Contains meta information about the current App. |
| Context | Provides information about the current runtime environment |
| DateTime | Provides methods for manipulating and formatting dates. |
| Navigation | Provides methods for navigating within the Rally product. |
| Query | Simplifies the building of complex queries for the RallyDataSource component |
| Ref | Provides utility methods for handling Rally references |
| ServerInfo | Facilitates communication with a Rally server |
App SDK Versions
This document represents the current version of the App SDK: v1.30.
- Versions updated to stay in sync with Web Services API versions 1.27-1.30
- No changes to code or features
What's New in v1.26:
-
Updated Components:
-
Card Board
- Added config property cardOptions
- Added method resize
-
Card Board
Documentation for past versions is available here:
Other Resources
Rally App Catalog - Examples of Apps developed by Rally, customers, or partners.
Apps - What they are and how to use and create them
Web Services API Documentation - The Web Services API documentation is critical to understand Rally's object model
App Development: Getting Started - A basic introduction to app development and Rally recommended tips and tricks
Contact Rally Support
From Rally, click on the 'Contact Support' link from the footer of Rally to submit a support case or file the support case online.