Reporting on metrics and historical trends across projects with Report Builder
By 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.Report on a single trend or several historical trends in your data. You can define conditions to focus only on the data you need. You can specify whether conditions can be changed when the report is run, so other organizations can reuse and tailor your report.
Before you begin
About this task
What to do next
- To see your report in the list of other reports, click All Reports or My Reports.
- To further edit your report, click a pencil in the My Choices pane at the right. Click Save to save your changes.
- You can export your report to a spreadsheet or to IBM® Engineering Lifecycle Optimization - Publishing (PUB) as a document-style report. You can also export a report graph to an image file. See the related topics.
Step 1. Choose data
Go to https://server_name:port/rs. On the Reports page, click Build report. If the page doesn't open, contact your application administrator.
Choose a report type.
- Click the pencil icon to select the data source. If only one data source is defined, it is selected by default. To decide what data source to choose, read this topic.
- Select Historical Trends (time series) to report on trends and metrics for projects.
Limit the scope.
Choose the projects to report on, and click Continue. If you don't select any projects, the report includes all projects that you can access.The list shows the projects that you can access in the data source that you selected. If your projects are not in the list, see the administrator who created the data sources for Report Builder.
- For Data warehouse, all projects are listed.
- For Lifecycle Query Engine, only projects that are not enabled for configurations are listed.
- For Lifecycle Query Engine scoped by configurations, only configuration-enabled projects are listed.
Some artifact trends are project-specific. Go to step 4 to select the trend, then return here, and select List only the projects that contain the artifact for your report.
Focus on artifact trends.
Select one or several artifact trends to report on, and, click Continue. The trends are organized under the artifacts in the lists, so you might have to expand some artifacts to choose a trend.
If you select an artifact trend that is project-specific, you can return to the Limit the scope section, and select List only the projects that contain the artifact for your report.Note: For LQE, if you report on the Work Item Totals trend, the report returns only the work items closed in the last year.
Set a time range.
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.
To further refine the content of your report, specify conditions. You can set conditions for any attribute of the artifact trend that you selected.Note: If you selected more than one trend in step 4, some of the conditions that you apply to one trend must also be applied to the others. For example, if you selected the Creation and Resolution trends for Work Item and you want to know about defects for a particular version, the Type and the Planned for attributes must be applied to both trends.
- Click Add condition.
- From the list, select an artifact type.
- Choose the attribute that you want to specify a condition for, and select the values to return the artifacts you want.
- To keep the window open for adding other conditions, click Add. Otherwise, click Add and Close.
- 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 icon beside it.
- To create logical groups of consecutive conditions, select them, and click Group.
- To create nested groups of conditions, use the grouping buttons or drag conditions to existing groups.
- To exclude data from a report by grouping conditions, use the Not all match (AND NOT) or None match (OR NOT) options.
- To reorder conditions, drag them into position.
- To remove conditions, select them, and click Remove.
After you create your conditions, click Continue.
Step 2. Format results
The trend report is formatted as a graph by default. Report Builder picks 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 might find that a bar chart (stacked or grouped) works better with your data.
Before you can preview a graph, you must select a value for the unit of measure. You can also select the dimension.
Click Refresh to see a sample layout of your report. To see all the data, you must run the report.
- Enter the chart title.
Select the category to show on the X-axis (horizontal), and enter a label name.
Typically, you select what you want to measure.
- Click Date scale, and choose what date range to show in the report: days, weeks, months, or years.
- To show data gaps, select the Fill in gaps with zero value check box.
Select the quantities or units to show on the Y-axis (vertical), and enter a label name.
- If your report is for a single trend, select a unit to count. To compare different aspects of the value that you're measuring, select a dimension.
- If you report on several trends and want to include each trend in the graph, select the
Add lines or bar segments for numeric measures option, and click
Measures. Choose a trend from the Attributes of list,
select your attributes, and click Add.
- To track a trend against a particular goal, click Goal line, and enter a start and end value. Choose a bar, a solid line, or a dashed line. Use an angled, curved, or an S-curve trajectory for the goal line. You can add several goal lines to your chart.
- Add date lines to mark specific milestones. Click Date line and specify the date. For each date line, select the graph type for your date line: the default, line, or dashed line.
Adjust the graph.
- Change the colors of the lines or bars on the graph to make the categories more visible, or to comply with conventions in your organization.
- Combine line and bar chart segments to show the dimensions in your report. For each segment specify the graph type: bar, line, or dashed line.
- To show values or totals on the chart, click Graph type, and select the appropriate check box.
- When you finish arranging your report, click Continue.
Step 3. Optimize the report
About this task
When you create a report, Report Builder generates the underlying query resource. If you are using Data Warehouse as the data source, an SQL query is generated. If you are using Lifecycle Query Engine, a SPARQL query is generated.If you want to manually edit the generated query, see this topic. You can also generate alternate queries and optimize your reports based on your requirements.
Generate alternate queries using the following options. To find what works best, try turning these options on and off. The options appear only when you select Lifecycle Query Engine or Lifecycle Query Engine scoped by a configuration as the data source.
- Select the Defer finding relationships with an alternative query checkbox to generate an alternate query that filters on source artifacts before finding relationships. Try this option if your data has one-to-many relationships in the Artifacts relationships section.
- Select the Defer scoping by projects with an alternative query checkbox to generate an alternate query that filters on artifacts first before scoping by projects. Try this option if your data has large number of projects in the 'Limit the scope section.
Step 4. Name and share the report
- Give your report a name and a description. The description helps other team members find your report if it is public.
- Tag your report to make it easy to find, or to group it with related reports. Each tag becomes a category on the All Reports and My Reports pages.
Specify how to publish the report:
- Public (publish to catalog): The report is in the Report Builder catalog. Team members can add the report as a widget to their Jazz dashboards.
- Private (publish to catalog and visible only to creator and owners): The report is in the Report Builder catalog. Only the report creator and owners can add the report to a dashboard and see it. Other users see the widget, but they cannot run the report.
- Private (visible only to me): The report is available only on the My Reports page.
- Specify whether the default visualization for your report is a table or a graph. For example, if you select Graph, but then run the report to generate a table, the next time you run the report, the results are shown again in a graph.
Click Add owner.
Your report can have multiple owners who can modify the report, and assign other owners.
- Click Save, and click Continue.
Step 5. Run the report
To see the complete report, click Run report. Provide values for all required parameters or filters.
About this task
If you choose an LQE-based data source in step 2 and Report Builder reports don’t show the artifacts that you expect, show artifacts more than once, or show a different number of artifacts than application views, ask an application administrator to validate the TRS feeds for the application. See Validating TRS feeds and the LQE index.