Predefined widgets in the local catalog

You can add predefined widgets to dashboards from the Change and Configuration Management (CCM), Quality Management (QM), and Requirements Management (RM) catalogs. These widgets display information about builds, feeds, general work, help, plans, projects, teams, quality management, requirements, reports, source control, and work items.

For more information about adding and configuring widgets, see the related links.

Widgets are organized by type and are grouped in the following categories:

Build

Important: For build widgets to display data, you must ensure that the build status and results are communicated to the Jazz™ Team Server. You can use with the post-build options or the Ant tasks to publish data to the build. For more information, see Creating build definitions and Publishing build results and contributions.
Table 1. Build widgets
Widget name Description Local catalog
Builds Displays all of the build results for a selected build definition. Change and Configuration Management
Build Duration Displays the duration of a build definition over time. A line indicates the average build time. Change and Configuration Management, Quality Management
Build Health Displays the health of a build definition by plotting intervals of successful (green) and unsuccessful (red) builds over time. A line indicates the cumulative percentage of all of the successful builds. Change and Configuration Management, Quality Management
Build Queue Displays the current build queue. Change and Configuration Management
Build Status Displays the last known status of selected build definitions. Change and Configuration Management
Compiler Warnings Displays the number of compilation failures over time for a codebase. Change and Configuration Management, Quality Management
Frequent Test Failures Displays the 10 unit tests that fail the greatest number of times. Change and Configuration Management, Quality Management
Frequent Test Regressions Displays the 10 unit tests that most often succeeded in one build but then failed in a subsequent build. Change and Configuration Management, Quality Management
Number of Tests Displays the total number of tests that run against a codebase over time. Change and Configuration Management, Quality Management
Test Failures Displays the number of unit test failures over time for a codebase. Change and Configuration Management, Quality Management

Feeds

Table 2. Feeds widgets
Widget name Description Local catalog
My Work Item Changes Displays a feed of changes to work items that the logged-in user is the creator, owner, modifier, or a subscriber of. Change and Configuration Management, Quality Management
News Feed Displays a general-purpose news feed widget. You must provide the URL of the feed to follow. Change and Configuration Management, Quality Management, Requirements Management
Project and Team Events Displays a feed of project or team-related events, such as project, team, or artifact modification and other change events. Change and Configuration Management, Quality Management, Requirements Management

General

Table 3. General widgets
Widget name Description Local catalog
About Me Displays information about a contributor. Change and Configuration Management, Quality Management, Requirements Management
Bookmarks Displays a customizable list of bookmarks. Change and Configuration Management, Quality Management, Requirements Management
External Content Securely hosts content from the intranet. Change and Configuration Management, Quality Management, Requirements Management
Headlines Displays one or more pages that consist of a title, message, and optional image that you can edit. Highlights the current content of the dashboard. Change and Configuration Management, Quality Management, Requirements Management
HTML Displays a snippet of HTML markup that you can edit. Snippets are restricted to static text. Scripts are not allowed. Change and Configuration Management, Quality Management, Requirements Management
Performance Health Check Runs tests to measure the performance of various systems in a IBM® Engineering Lifecycle Management (ELM) deployment, including the client, application server, and database server.
Important: This widget is for informational purposes only. Do not rely on this widget instead of relying on tests for the system that might already be in place.
Change and Configuration Management, Quality Management
Recently Viewed Displays a list of recently viewed documents that are sorted in inverse chronological order. The documents are scoped to the application that contributes the widget. Change and Configuration Management, Quality Management
Server Status Displays a quick summary of the overall repository server status. You can navigate in this widget to find more details. Change and Configuration Management, Quality Management, Requirements Management
Social Network Displays information and status updates from your social network. You can use this widget to search your social network and send status updates. Change and Configuration Management

Help

Table 4. Help widgets
Widget name Description Local catalog
Customize Your Dashboard Displays a set of tips to customize the dashboard. Change and Configuration Management, Quality Management, Requirements Management
Welcome Describes information about what the product does and how you can get started using it. Change and Configuration Management, Quality Management

Plans

Table 5. Plans widgets
Widget name Description Local catalog
Plans Displays the overall progress of one or more development plans for a team in a specified iteration. Change and Configuration Management
Plan Statistics Displays data about the plan that is sorted by configurable criteria. In contrast to trend reports, this report displays live data from the plan. Change and Configuration Management
Plan View Displays a non-editable view of a specific plan. Change and Configuration Management

Project and team

Table 6. Project and team widgets
Widget name Description Local catalog
Description Displays the description of a project or team area. Change and Configuration Management, Quality Management, Requirements Management
My Projects Displays all of the projects that you are a member of. Change and Configuration Management, Quality Management, Requirements Management
Process Description Displays the content of the process description that belongs to a team or project area. Change and Configuration Management, Quality Management
Teams Displays the team hierarchy of a selected project or parent team. Alternatively, this widget can show one level of the team hierarchy. To show only one level of the hierarchy, in the widget settings, clear the Include Sub-Teams check box. Change and Configuration Management, Quality Management
Team Members Displays a list of contributors that belong to a team or a project area, and the contributors’ roles. Change and Configuration Management, Quality Management, Requirements Management
Timelines Displays the timeline and iterations associated with the current iteration of a specific project or team area. Change and Configuration Management, Quality Management, Requirements Management

Quality Management

Table 7. Quality Management widgets
Widget name Description Local catalog
AppScan Enterprise Training Overview Gives an overview of the Web Application Security and AppScan Tester Edition web-based training available on IBM Learner Portal. Quality Management
Defect Arrival Resolution Displays a live view of open and resolved defects. Quality Management
Defect list Displays defects. Quality Management
Execution and defects by owner Displays execution status and defects by owner. Quality Management
Execution by Test Schedule (Live) Displays the Test Execution Records according to the given Test Schedules. Quality Management
Execution Record(s) Displays the result of executing a single execution records query. Lists individual execution records that meet the query criteria. Quality Management
Execution Records Queries Displays the summary of multiple execution record queries. Used for quick summarization and linkage to a list of execution record queries. Quality Management
Execution Status by Milestone using TCER Count (Live) Displays execution status counts by milestone of test plan. Quality Management
Execution Status by Milestone using Weight (Live) Displays execution status weights by milestone of test plan. Quality Management
Execution Status by Points Displays execution status of test case execution records and test suite execution records by points. Quality Management
Execution Status by Owner using TCER Count (Live) Displays execution status counts by owner. Quality Management
Execution Status by Owner using Weight (Live) Displays execution status weights by owner. Quality Management
Execution Status by Test Case Category using TCER Count (Live) Displays Test Execution Records according to the given Test Case Category. Quality Management
Execution Status by Test Case Category using Weight (Live) Displays Test Execution Records according to the given Test Case Category. Quality Management
Execution Status by Test Suite using TSER Count (Live) Displays the execution status by test suites, measured against the TSER count. Quality Management
Execution Status by Test Suite using Weight (Live) Displays the execution status by test suites, measured against weight. Quality Management
Execution Status using TCER Count (Live) Displays execution status by test execution record count. Quality Management
Execution Status using Weight (Live) Displays execution status counts by weight. Quality Management
Execution Trend Report Displays the trend of the execution over time. Quality Management
My Reviews Displays the review tasks for the logged in user. Quality Management
My Tasks Displays the quality task work items for the logged in user. Quality Management
Plan Requirements Coverage by Test Case Displays counts of requirements and whether they are covered by test cases. Quality Management
Plan Requirements Coverage Detail Displays requirements and the test cases associated with them. Quality Management
Plan Requirements Defect Impact Displays requirements and associated defects. Quality Management
Plan Requirements Execution using TCER Count Displays execution result counts by requirement. Quality Management
Plan Requirements Execution using Weight Displays execution result weights by requirement. Quality Management
Plan Requirements Not Covered Detail Displays requirements that are not covered by test cases. Quality Management
Plan Test Cases Not Covering Requirements Displays test cases that are not covering requirements. Quality Management
Quality Manager Event Log Displays changes in the repository such as builds, change sets, news, process, work item changes, etc. Quality Management
Requirements Traceability Displays the links between requirements and test plans or test cases. Quality Management
Scheduled Execution Jobs Displays the scheduled execution jobs for the project area. Quality Management
Scorecard Report Displays a live view of testing information, such as test case status, test execution counts, test result points, and defect counts. Quality Management
TCER Listing (Live) Displays a listing of Test Execution Records. Quality Management
TCER Status Counts (Live) Displays a listing of Test Execution Records along with result counts. Quality Management
Team Execution Status for TestSuites Displays the test suite execution status for the selected users or team area. Quality Management
Team Execution Status for Test Cases Displays the test case execution status for the selected users or team area. Quality Management
Tester Report using TCER Count Displays a live view of Test Execution Records by user. Quality Management
Tester Report using Weight Displays a live view of Test Execution Records by user and weight. Quality Management
Test cases (Live) Displays test cases. Quality Management
Test cases by Development State (Live) Displays test cases by their current state. Quality Management
Test cases by Team (Live) Displays test cases and their association with test teams. Quality Management
Test cases by Test Environment (Live) Displays test cases and their association with test environments. Quality Management
Test Cases Impacted by Defects Displays test cases and test suites and their association with defects. Quality Management
Test Cases Traceability Links Displays traceability links for selected test cases. Quality Management
Test Case Coverage by TCER (Live) Displays the TCER details of select test cases. Quality Management
Test Case Coverage by Test Script (Live) Displays the test script details of select test cases. Quality Management
Test Case Results Details of Test Suite Results (Live) Displays the details for test case results, which are associated with the given TSER result, measured against test case results count. Quality Management
Test case Review Displays test cases and associated work items. Quality Management
Test Matrix Display the test artifact matrix by query Quality Management
Test Plans Execution Status Displays execution status summary for selected test plans Quality Management
Test Plans Traceability Links Displays traceability links for selected test plans Quality Management
Test scripts by Development State (Live) Displays test scripts by their current state. Quality Management
Test Statistics Display the test artifacts statistics by query Quality Management
Test suites by Development State (Live) Displays test suites by their current state. Quality Management
Test Suites Execution Status Displays execution status summary for selected test suites. Quality Management
TSER Listing (Live) Displays a listing of Test Suite Execution Records. Quality Management
TSER Status by Owner using TSER Count (Live) Displays TSER execution status counts by owner. Quality Management
TSER Status by Owner using Weight (Live) Displays the execution status of test suite execution records by its owner, measured against weight. Quality Management
TSER Status using Test Case Count (Live) Displays the TSER status using the test case count. Quality Management
TSER Status using Weight (Live) Displays the execution status by test suite execution records, measured against weight. Quality Management
Unblocked Test Execution Records Displays recently unblocked TERs based on the build availability with associated resolved work items. Quality Management
Unfinished Work Item Count Displays a live view of unfinished work items by owner. Quality Management

Rational Test Lab Manager

Table 8. Rational Test Lab Manager widgets
Widget name Description Local catalog
Automation Status Displays the status of jobs that have been run or are running. Quality Management
My Lab Resource Groups Displays machines that are members of a particular group. To determine what machines belong to a group, the group in question can be selected from a dropdown. Quality Management
Requests Displays information about the states of different requests in the system. Quality Management
Reservations Displays information about the state of reservations in the system. Quality Management
Unavailable Machines Displays which machines are not available for use. Quality Management

Reports

Table 9. Reports widgets
Widget name Description Local catalog
Advanced Release Burndown Displays how much work is done in a completed iteration, as measured when you use the defined complexity attribute. This widget also estimates how much work remains in future iterations. That estimation is based on the specified release scope and the previous velocity. Teams can use this widget to determine whether they are on track to deliver the release on time. Change and Configuration Management, Quality Management
Blocking Work Items Displays a plot of open blocking work items over time. Change and Configuration Management, Quality Management
Build Duration Displays the duration of a build definition over time. A line indicates the average build time. Change and Configuration Management, Quality Management
Build Health Displays the condition of a build definition by plotting intervals of successful (green) and unsuccessful (red) builds over time. A line indicates the cumulative percentage of all of the successful builds. Change and Configuration Management, Quality Management
Burndown Displays the number of estimated hours that are required to complete work items that are either open or in progress over daily intervals. Change and Configuration Management, Quality Management
Burnup Displays the number of hours of completed work over daily intervals. Change and Configuration Management, Quality Management
Change Set Activity Displays the number of change set additions, deletions, and modifications over time. Change and Configuration Management, Quality Management
Closed Work Items by Priority Displays an area plot of closed work items over time by priority. Change and Configuration Management, Quality Management
Closed Work Items Daily Displays the number of work items closed per day by severity. Change and Configuration Management, Quality Management
Compiler Warnings Displays the number of compilation failures over time for a codebase. Change and Configuration Management, Quality Management
Cumulative Value Flow Displays an area plot of open, in progress, and closed work items over time. Change and Configuration Management, Quality Management
Custom Report Displays a custom report from Rational® Reporting Server. Change and Configuration Management, Quality Management
Deferred Work Items Displays the number of work items that are deferred from the specified iteration over time. Change and Configuration Management, Quality Management
Estimated vs Actual Work Displays the total estimated time that is specified for all closed work items and divides that time by the total actual time that is spent on all closed work items. Change and Configuration Management, Quality Management
File Change Activity Displays the number of file additions, deletions, and modifications over time. Change and Configuration Management, Quality Management
Frequent Test Failures Displays the 10 unit tests that fail the greatest number of times. Change and Configuration Management, Quality Management
Frequent Test Regressions Displays the 10 unit tests that most often succeeded in one build but then failed in a subsequent build. Change and Configuration Management, Quality Management
New Work Items by Severity Displays a stacked bar chart of incoming work items by day and by severity. Change and Configuration Management, Quality Management
Number of Tests Displays the total number of tests that run against a codebase over time. Change and Configuration Management, Quality Management
Open vs Closed Story Points by Iteration Displays all of the story points grouped by their targeted iteration and sorted by open, in progress, and closed story work items. Change and Configuration Management, Quality Management
Open vs Closed Work Items Displays an area plot of open work items compared to closed work items over time. Change and Configuration Management, Quality Management
Open Work Items Displays an area plot of open work items over time. Change and Configuration Management, Quality Management
Open Work Items by Priority Displays an area plot of open work items by priority over time. Change and Configuration Management, Quality Management
Open Work Items by Type Displays an area plot of open work items by their type over time. Change and Configuration Management, Quality Management
Release Burndown Displays the amount of outstanding work for the release by iteration. Change and Configuration Management, Quality Management
Report 1 Displays results for any selected report resource on the server. Change and Configuration Management, Quality Management
Story Points Displays the magnitude over time of story points that are achieved, or closed story work items, compared to the magnitude of story points that are remaining, or open or in progress story work items. Change and Configuration Management, Quality Management
Story Points By Iteration Displays all of the story points grouped by the iteration that they are targeted for. This widget shows information for closed, open or in progress story work items. Change and Configuration Management, Quality Management
Story Points Progress Displays the progress of story points by team. A progress bar for each selected team area shows the remaining and achieved work. Change and Configuration Management, Quality Management
Story Points Remaining Displays the number of story points that are remaining, or open or in progress story work items, over time. Change and Configuration Management, Quality Management
Team Velocity Displays all of the story points that were achieved, or closed story work items, grouped by the iteration they are targeted for. Change and Configuration Management, Quality Management
Test Failures Displays the number of unit test failures over time for a codebase. Change and Configuration Management, Quality Management
Work Item Comparison Displays all of the open work items for one or more teams over time. Change and Configuration Management, Quality Management

Requirements

Table 10. Requirements widgets
Widget name Description Local catalog
Comments Displays recent comments in all projects for which you have membership and displays the artifacts or requirements that are related. Click on an artifact or requirement in this widget to access the corresponding artifact or requirement page, respectively, or click on a commentator's name to send them a message via email. Requirements Management
Getting Started Get started with the Requirements Management (RM) application to define and manage requirements. Learn how to manage and trace requirements in a lifecycle project in ELM. Requirements Management
My Requirements Projects Displays requirement projects for which you have membership. Click on a project link to access a list of all artifacts in the project. Requirements Management
Project Members Displays project members for a selected project. Requirements Management
Recent Changes Displays recently modified requirements in all projects for which you have membership. Click on an artifact or resource link to access the corresponding requirement page. Requirements Management
Requirements Tracing Displays all requirements that have corresponding work items in IBM Engineering Workflow Management (EWM) and/or test cases in IBM Engineering Test Management (ETM). The work items and test cases are displayed as children items of the requirement to which they correspond.
Note: This widget only displays results when you establish cross-server communication between your IBM Engineering Requirements Management DOORS® Next (DOORS Next) server and your EWM and ETM servers.
Requirements Management
Requirements View Displays a result of a single view, which you choose from a list relative to a particular requirements management project. Requirements Management
Reviews Displays reviews in all projects for which you have membership. Click the review link to access the corresponding review page. Requirements Management
Tip of the week Displays tips for working in the Requirements Management (RM) application. Requirements Management

Source control

Important: To ensure that source control widgets display data, a user with the appropriate privileges can administer the SCM snapshot:
  1. From the web client, click Reports > Shared Reports.
  2. Expand Source Control, and click the Project Activity report.
  3. In the About this report section, click Administer SCM Snapshot.
  4. Select the stream, and click Save Changes.
  5. Wait for the designated time for the snapshots to run or run it manually.
Table 11. Source control widgets
Widget name Description Local catalog
Change Set Activity Displays the number of change set additions, deletions, and modifications over time. Change and Configuration Management, Quality Management
File Change Activity Displays the number of file additions, deletions, and modifications over time. Change and Configuration Management, Quality Management

Work items

Table 12. Work items widgets
Widget name Description Local catalog
Advanced Release Burndown Displays how much work is done in each completed iteration, as measured by the defined complexity attribute. This widget also estimates how much work remains in future iterations based on the specified release scope and the previous velocity. Teams can use this information to determine whether they are on track to deliver the release on time. Change and Configuration Management, Quality Management
Average Cycle Time Plots the trend of the average time work items stay in the inactive state.
Tip: Watch for an increase in the average time to activate work items, which is an indication of poor planning.
Change and Configuration Management
Average Lead Time Plots the trend for the average time that work items stay in the unresolved state.
Tip: Watch for an increase in the average time to resolve work items, which is an indication of poor planning.
Change and Configuration Management
Average Time in State Plots the average time work items spend in a particular state.
Tip: Watch for the states that work items spend the most time.
Change and Configuration Management
Blocking Work Items Displays a plot of open blocking work items over time. Change and Configuration Management, Quality Management
Burndown Displays the number of estimated hours that are required to complete work items that are either open or in progress over daily intervals. Change and Configuration Management, Quality Management
Burndown by Story Points Displays the remaining story points. The gray line indicates planned work (the sum of the remaining work and the completed work). The "Ideal" line indicates what an ideal iteration looks like with a steady burndown from the beginning to the end of the iteration. The ideal line uses the last data point for planned work as its starting point. The "Expected Complete" line is a forward-looking plot from the current state of the burndown line to the end of the sprint, indicating the required rate of work if the iteration is to complete successfully. Change and Configuration Management
Burnup Displays the number of hours of completed work over daily intervals. Change and Configuration Management, Quality Management
Burnup by Story Points Displays the completed story points. The gray line indicates planned work (the sum of the remaining work and the completed work). Change and Configuration Management
Closed Work Items by Priority Displays an area plot of closed work items by priority over time. Change and Configuration Management, Quality Management
Closed Work Items Daily Displays the number of work items closed per day by severity. Change and Configuration Management, Quality Management
Cumulative Value Flow Displays an area plot of open, in progress, and closed work items over time. Change and Configuration Management, Quality Management
Cycle Time as Percentage of Lead Time Plots the trend of the active time as a percentage of the unresolved time for work items.
Tip: Watch for a low percentage of the active time, which indicates that work items are waiting for a long time before they become active.
Change and Configuration Management
Deferred Work Items Displays the number of work items that are deferred from the specified iteration over time. Change and Configuration Management, Quality Management
Estimated vs Actual Work Displays the total estimated time that is specified for all closed work items and divides that time by the total actual time that is spent on all closed work items. Change and Configuration Management, Quality Management
New Work Items by Severity Displays a stacked bar chart of incoming work items by day and by severity. Change and Configuration Management, Quality Management
Open vs Closed Story Points by Iteration Displays all of the story points grouped by the iteration that they are targeted for and sorts them by open, in progress, and closed story work items. Change and Configuration Management, Quality Management
Open vs Closed Work Items Displays an area plot of open work items compared to closed work items over time. Change and Configuration Management, Quality Management
Open Work Items Displays an area plot of open work items over time. Change and Configuration Management, Quality Management
Open Work Items by Priority Displays an area plot of open work items by priority over time. Change and Configuration Management, Quality Management
Open Work Items by Type Displays an area plot of open work items by their type over time. Change and Configuration Management, Quality Management
Process Control Plots the time work items are in the unresolved state.
Tip: Watch for work items that remain in the unresolved state for a long period of time.
Change and Configuration Management
Release Burndown Displays the amount of outstanding work for the release by iteration. Change and Configuration Management, Quality Management
Story Points Displays the magnitude over time of story points that are achieved, or closed story work items, compared to the magnitude of story points that are remaining, or open or in progress story work items. Change and Configuration Management, Quality Management
Story Points By Iteration Displays all of the story points grouped by the iteration they are targeted for. This widget shows story points for closed, open, or in progress story work items. Change and Configuration Management, Quality Management
Story Points Progress Displays the progress of story points by team. A progress bar for each selected team area shows the remaining and achieved work. Change and Configuration Management, Quality Management
Story Points Remaining Displays the number of story points that are remaining, or open or in progress story work items, over time. Change and Configuration Management, Quality Management
Tag Cloud Displays a tag cloud of work item query results. Change and Configuration Management, Quality Management
Team Velocity Displays all of the story points that were achieved, or closed story work items, grouped by the iteration that they are targeted for. Change and Configuration Management, Quality Management
Work Items Displays the results of running one work item query. You can select a query that is appropriate for the current scope. Change and Configuration Management, Quality Management
Work Item Activities Displays changes to one or more projects as an activity stream. You can configure the widget to show activities based on your level of interest (Contributor or Follower). You can also group the activities by priority, time, or with no grouping. Change and Configuration Management
Work Item Comparison Displays all of the open work items for one or more teams over time. Change and Configuration Management, Quality Management
Work Item Queries Displays several queries. You can add queries that are within the current scope of the widget. Change and Configuration Management, Quality Management
Work Item Statistics Displays data about work item queries that is sorted by user-defined custom groups. In contrast to trend reports, this widget shows live data from the repository.
When you configure the Work Item Statistics widget, you can define custom groups. A custom group is associated with the value that you select in the Parameter field in the widget settings.
Important: When you define a custom group, do not select other for the Parameter value because it is a reserved word and causes the chart or table to display incorrectly.
In the Custom Groups dialog box, fill in the fields.
  • In the Group Label field, define a group label.
  • In the Values Included field, define the values to include in the custom group.
    • You can define values by using plain text or a regular expression.
    • The following syntax rules apply.
      • Alphabetic characters are matched literally.
      • Matches are case insensitive. For example, TASK and task both match any parameter value with task in it.
      • Matches can occur anywhere in the parameter value. For example, Task matches Review task list.
      • Partial words are matched. For example, Task matches taskbar.
      • These characters have special meanings: $ ( ) * + . ? [ ] \ ^ | { }
        • The ^ and $ characters are needed as anchors to match a pattern that is at the beginning or end of the Parameter value. For example:
          • The pattern bar groups Foobar and Barstool together.
          • The pattern ^bar groups only Barstool.
          • The pattern bar$ groups only Foobar.
        • The dot character (.) is a wildcard that matches any single character. For example, a.e matches water and games, but not farmer.
      • To prevent special characters from using their meanings, escape them with the backslash character (\). For example, \$100\.00 matches the exact value $100.00.

    Examples

    • The pattern task matches Task and Complete the remaining tasks..
    • The pattern task|defect|enhancement matches Task and Defect and Enhancement.
    • The pattern 1\.0 matches Release 1.0.

    For more information about regular expressions, consult a guide to regular expression syntax.

After you configure the widget settings, the results are displayed.
  • Any work items with a value that matches the pattern are grouped in a folder with the Group Label name.
  • Values are placed in the first matching group.
  • All values that are not matched by a custom group are grouped by the Parameter value.
Change and Configuration Management, Quality Management
Note: For information about report fields and descriptions, see Change and configuration artifacts.
1 The Report widget gives you access to additional reports that are not found in the widget catalog. For a current list, see the "Micro" reports in Change and configuration management predefined report descriptions.

video icon Video

Jazz.net channel
Software Education channel

learn icon Courses

IoT Academy
Skills Gateway

ask icon Community

Jazz.net
Jazz.net forums
Jazz.net library

support icon Support

IBM Support Community
Deployment wiki