Using Report
Builder, you can
create reports to identify trends in project or team progress and quality throughout a release, a
sprint or a specific time range. You can define conditions to return only the data you need in your
report, and, you can specify whether conditions can be changed when report is run, which enables
other organizations to reuse your report but tailor it to their needs.
About this task
As you build your report:, your choices are shown in the
My Choices
pane on the right side of the page.
To change your choices:
- Click the heading near the top of the page and go to the section to change.
- In the My Choices pane, click the pencil beside the section to change.
Procedure
- Open Report
Builder, and click
Build:
https://server_name:port/rs
If you do not see the Report
Builder page,
contact your application administrator for the URL.
- To create metrics and trends reports for projects, in the Choose report
type section, click Historical Trends (Time Series).
Note: To report on artifacts in and across projects, click
Current Data (Table or
Graph). For more information, see
this related
topic.
- In the Limit scope section, specify the scope of your report by choosing
the projects to report on, and click Continue.
The list shows the projects that you can access in the data source that you selected.
Note: Some
trends are project specific. After you select the artifact trend to report on in step
4, to see only the projects that the
trend applies to, return to the
Limit scope section and select
Show applicable projects for selected artifact types.
If the projects that you want are not in the list, see the administrator who created the data
sources for Report
Builder.
- Expand the artifact to report on to see the trends you can choose. and click
Continue. You might have to expand some trends to make a specific choice; if
you do not expand a trend, all of its types are included in the results.
- In the Set a time range section, set the period of time to report
on. The time range that you select is added as a condition in the Set
conditions section.
Note: To report on specific quarters, months, or days, go to the
Set conditions section and add a condition for the Date [Type:Date] type;
then, select the day, month, period, or quarter to report on.
- Set conditions to further refine the content of your report. You can specify conditions for any
attribute of the trend that you selected.
- Click Add condition.
- From the list, select an artifact metric.
- Choose the attribute that you want to specify a condition for, and select the values to return
the artifacts you want; then, click Save.
- Optional: Change the lock to control whether people can or must supply a value for the condition when they run the
report.
To edit a condition, click the pencil beside it.
To create logical groups of conditions, they must be beside each other. Select their check boxes
and click Group.
To remove conditions, select their check boxes and click Remove.
After you create your conditions, click Continue.
- In the Format section, select the format for your report: graph or
table. To preview what your report looks like, click Refresh. Only a subset
of data is shown in this section. To see all the results, you must run the report.
- Table
Your report already has some columns, including columns for the attributes you
created conditions for. If you want your report to link directly to the artifacts in the lifecycle
products, you must include the Name and URL attributes
for the artifact in your report.
For each artifact type, you can add columns to show the
attributes that you want to see. Select the artifact from the list of attributes, select the
attributes, and then click Add attribute columns.
- To change the column name, type in the Column Label field.
- To arrange or remove columns, use the controls in the Actions
column.
- To sort columns, select the sort method from the Sort Type list for that
column. You can sort more than one column. To change the sort order, manually edit the numeric
values in that field.
- To add columns that show calculations such as averages, sums, counts, and so on, click
Add calculated values.
- Graph
Report Builder selects the graph type based on your selections so far. Experiment to
find the best graph type. Typically, line graphs convey trend information effectively, but you can
also use a bar chart (stacked or grouped).
Note: Before you can preview a graph, you must select a
value for the unit of measure, and optionally, the dimension.
- Select the category to show on the horizontal axis of the graph. Above the graph, experiment
with the scale to find the best one for your report.
- Select the quantities or units to show on the vertical axis of the graph. Typically, you select
what you want to measure.
- Optional: Select a dimension to separate the value being measured by all the values
of the dimension.
- Optional: To track a trend to a particular goal, click Add goal
line and enter a value. Your value displays as a horizontal dotted line in your graph.
You can change the goal line color and add additional goal lines.
- Optional: Change the colors of the lines or bars on the graph. Do this to make the
categories easier to see or to comply with conventions in your organization.
- To add more data to the graph, click Add attribute data items.
- To add information such as averages, sums, counts, and so on, click Add calculated
value data items. Then, select the calculation to show and the attribute it applies to.
When you finish formatting the report, click Continue or Name
and share.
- Specify the details of your report.
- Give your report a name and a description. The description is important to help other team
members find your report if it is public.
- Optional: Tag your report to make it easier to find or to group it with related reports. Each tag becomes
a category in which you can see your report on the Use and My
Stuff pages.
- Specify if your report is public or private. Public reports show up in the Report
Builder
catalog.
- If you make the report public, team members can add the report from the catalog as a widget to
their Jazz™ dashboards.
- If you tag the report, the tag becomes a category in the report catalog to make your report
easier to find or to group it with related reports.
- Click Save, and click Continue.
What to do next
- To see your report in the list of other reports, click Use or
My Stuff.
- To view a full-page version of your report in a new window, click Open in a new
window.
- To further edit your report, click a pencil in the My Choices pane at the
right. Click Save near the top to save your changes.
- You can export your report to a spreadsheet or to Rational Publishing Engine as a document-style
report. You can also export a report graph to an image file. See the related topics.