Standard Reports

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 component(s) and/or code on this page is not supported. To develop custom apps within our current environments, please see App SDK 2.0 documentation.

Use the Standard Report Component to display a CA Agile Central Standard Report in an app, a html page, or a wiki.

report

Create a standard report

First include the App SDK javascript:

<script type="text/javascript" src="/apps/[version]/sdk.js"></script>

Instantiate a new StandardReport:

var report = new rally.sdk.ui.StandardReport(config);

The parameters for rally.sdk.ui.StandardReport include:

Parameter Description Example
config* A standard report configuration object { report:
rally.sdk.ui.StandardReport.IterationBurndown,
title: "My Burndown Report" }

  * = required parameter

The standard report configuration object supports the following properties:

Parameter Description Example
report* The report to be displayed. Supported values include: supported values

More information about the reports can be found here.

rally.sdk.ui.StandardReport.IterationBurndown
title A title to be displayed on the report. "My Title"
subtitle A subtitle to be displayed on the report. "My Subtitle"
width The width of the report in pixels. 800
height The height of the report in pixels. 600
workspace The object ID for the workspace in the report. This can be used (especially when running in a wiki or a portal) to specify the workspace from which to pull data. 876678 or "/workspace/81197657"
projects+ An array of object IDs referring to projects.

Note: To collect data from a hierarchy of projects, enter the OID of each project.
[784378,483290] or ["/project/81197657","/project/81197957"]
releases+ An array of object IDs referring to releases.

Note: To collect data from a hierarchy of projects, enter the OID of the release from each project.
[784378,483290] or ["/release/784378","/release/483290"]
iterations+ An array of object IDs pointing to iterations.

Note: To collect data from a hierarchy of projects, enter the OID of the iteration from each project.
[784378,483290]or ["/iteration/784378","/iteration/483290"]
story+* The object ID for the story in the report. This field is required for all story specific reports such as Story Burnup report. 987897 or "/hierarchicalrequirement/8124564"
tag+* The tag name. This field is required for the Tagged Story Burndown report. "My Tag Name"
tags+ An array of object IDs referring to tags. This field allows you to specify a list of tags that will be used to select work items for the Cycle/Lead Time or Throughput reports. The list is ORd so a work item will be included if it has ANY of the provided tags. [784378,483290]
start_date+ The start date for the report. Format is dd-mmm-yyyy. This parameter is used by a subset of reports such as the Tagged Story Burndown report. "27-Feb-2011"
build_definition + The object ID of the build definition.  If not specified, it renders a report for all build definitions. 345629
scmrepository + The object ID of the SCM repository.  If not specified, it renders a report for all SCM repositories. 232629
from_state + The Schedule State field value to calculate the cycle time start time. Defaults to In-Progress. "Defined"
to_state + The Schedule State field value to calculate the cycle time end time.  Defaults to Accepted. "Released"
interval + The time period to use for grouping aggregations for the x-axis of the chart.  Defaults to Weeks. Other possible values include Months and Quarters. Days is also a valid value for the defect reports that accept an interval parameter. "Months"
intervals_back + The number of time intervals back from now to include. Defaults to 13. 12
priorities + Include defects using this list of priorities. These are the moment-in-time values, not the present values. If not specified, then all priorities are included. ["Resolve Immediately", "High Attention"]
severities + Include defects using this list of severities. These are the moment-in-time values, not the present values. If not specified, then all severities are included. ["Crash", "Major problem"]
states + Include this list of states. These are the moment-in-time values, not the present values. If not specified, then all states except Closed are included. ["Open", "Submitted"]
terminal_states + Consider these states as terminal (meaning that they are no longer active). This allows you to control what defects contribute to the Cumulative Activated versus Cumulative Terminated series. If not specified, then only the Closed state is included in the Cumulative Terminated series. All remaining states are included in the Cumulative Activated series as well as the Total Active series. ["Closed", "Could not duplicate", "Deferred"]
subchart + Show or hide the sub-report that shows the summary metrics for various reports. Defaults to show. "hide"

  * = required parameter
  + = report specific parameter

Report-specific parameters

The report-specific parameters documented in the configuration object above apply to the following reports:

Report Supported Parameters
Iteration Burndown iterations
Iteration Burnup iterations
Velocity Chart projects
Iteration Cumulative Flow Diagram iterations
Iteration Defects by Priority iterations
Iteration Defects by State iterations, projects
Release Burnup releases
Release Cumulative Flow Diagram releases
Story Burnup story, projects
Story Burndown story, projects
Story Cumulative Flow Diagram story
Tagged Story Burndown projects, tag
Release Defect Trend * releases, projects
Defects by Priority projects, interval, intervals_back, states, priorities, severities
Defects by State projects, interval, intervals_back, states, priorities, severities
Defect Trend projects, interval, intervals_back, terminal_states, priorities, severities
Build Health build_definition
Build Health by Iteration build_definition
Top Files by Changes scmrepository
Top Files by Defects scmrepository
Cycle/Lead Time from_state, to_state, tags, interval, intervals_back
Throughput tags, interval, intervals_back

* Note: The Release Defect Trend report does not necessarily pull defects that are related to a release but that are created during the time extent of the release.

Display a standard report

Once created, use the display method to query CA Agile Central for the specified data and then show the report:

report.display(domElement);

Parameter Description Example
domElement* The element in which to display the chart. This may be either an element or an element ID. "reportDiv", document.getElementById("reportDiv")

  * = required parameter

Example

Copy and paste the following into a CA Agile Central Custom app page.

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html>
<head>
   <meta name="Name" content="Component Example: Standard Report">
   <script type="text/javascript" src="/apps/1.26/sdk.js"></script>
   <script type="text/javascript">
     function initPage() {
       var config = {
           report: rally.sdk.ui.StandardReport.IterationBurndown,
           width : 800,
           height: 400
         };
       var report = new rally.sdk.ui.StandardReport(config);
       report.display("aDiv");
     }

     rally.addOnLoad(initPage);
   </script>
</head>
<body>
   <div id="aDiv"></div>
</body>
</html>

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.