App SDK 1.x

Deprecation Warning! The content below is only applicable for use within deprecated 1.x versions of CA Agile Central's App SDK. Use of the components and code on this page is not supported. To develop custom apps within our current environments, please see App SDK 2.0 documentation.

SDK v1.32

Apps allow you to extend and customize your CA Agile Central subscription or integrate to third party systems. Apps are written in JavaScript and deployed within your CA Agile Central subscription as a custom page. Since the app content is stored within your CA Agile Central 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. User interface (UI) components include drop-downs for iteration, release, and programs, pie chart, table, attribute drop-down, object drop-down, and standard reports. A Rally Data Source component allows an intuitive interface to the data in your CA Agile Central subscription.

This document provides a basic overview of how to use v1.32 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 CA Agile Central recommended tips and tricks see App Development: Getting Started.

Data components

Rally Data Source Provides an intuitive interface to the data in your CA Agile Central subscription.

UI components

Attribute drop-down Object drop-down Table
Show the drop-down values for any CA Agile Central
object. For example, priorities on a defect.
Show a drop-down filled with CA Agile Central objects. For example, a list of completed stories. Arrange CA Agile Central data (or other data) in a tabular format.
Attribute Dropdown Object Dropdown Table
Iteration drop-down Release drop-down Program drop-down
Display the CA Agile Central iterations in a project with the default chosen automatically. Display the CA Agile Central releases in a project with the default chosen automatically. Display the CA Agile Central programs in a workspace (this feature is being deprecated).
Iteration Dropdown Release Dropdown Program Dropdown
Standard report Pie chart App header
Show a CA Agile Central report. Show the count of CA Agile Central objects in each of the values for a drop-down field. For example, the number of defects in each severity. Display a consistently styled banner for apps and exposes common utilities like page tools and help.
Standard Report Pie Chart App Header
Page Tools
Help Icon
Card board Chooser Add new
Visualize data as cards on a board. A dialog that displays artifacts to select. Create new items such as stories and defects.
Cardboard Chooser Add New

Basic components

Button Checkbox Drop-down
A simple, clickable action button. A stateful checkbox and label. Display data in a stateful drop-down list.
Add Button Checkbox Dropdown
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.
Link Tooltip Spinner Icon
Edit link TextBox Dialog
Pop-up the edit page of an item. A stateful textbox and label. Display a modal dialog.
Edit Link Text Box Config Dialog
RadioButton RadioButtonGroup  
A stateful radio button. A stateful group of radio buttons.  
Radio Button Group Radio Button Group

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 CA Agile Central product.
Query Simplifies the building of complex queries for the Rally Data Source component.
Ref Provides utility methods for handling CA Agile Central references.
ServerInfo Facilitates communication with a CA Agile Central server.

App SDK versions

This document represents the current version of the App SDK: v1.32.

What's new in v1.32:

  • Improved detection of workspaces with a manual ranking setting

What's new in v1.27-v1.31:

  • Versions updated to stay in sync with Web Services API versions 1.27-1.31
  • No changes to code or features

What's new in v1.26:

  • Updated components:
    • Card Board
      • Added configuration property cardOptions
      • Added method resize

Other resources

Contact CA Agile Central Support

From CA Agile Central, click the Contact Support link from the footer of CA Agile Central to submit a support case or file the support case online.

Feedback

Need more help? The CA Agile Central Community is your one-stop shop for self-service and support. To submit feedback or cases to CA Agile Central Support, find answers, and collaborate with others, please join us in the CA Agile Central Community.