July 17, 2014

Create Your First TestTrack Home Page Widget

Helix ALM
Note: This blog post refers to TestTrack 2015 and early. The home page was replaced with dashboards in TestTrack 2015.1. I've been hearing a ton of excitement from customers as they start to use the new Home page in TestTrack 2014.1. If you haven't had time to check out the home page and widget, here's a quick introduction and walk-through of how to create your first widget for the Home page. Widgets are the tiles you see across the top of the Home page, and each one can provide important information related to the status or health of your projects. Each widget gets its information from a user-defined filter, and then you can use color-coding logic to quickly illuminate important metrics. The classic example would be a "stoplight" widget where green means all is OK and red means there's an issue that needs to be addressed. That's what I'm going to create in this example, to show how many "must fix" defects there are in the current release cycle. You can also click on a widget to go directly to a list window with the associated filter already applied. So, if your "Must Fix" widget is red and shows there are 5 critical issues,  click the widget to see the issues. Creating a widget is typically a two-step process. First you create the filter, then you create a widget to use the filter.

Create the Filter

If you're not familiar with TestTrack filters, check out this short video on Using Filters in TestTrack. Here's the filter I've created, note that I've made the filter public by sharing it with everyone. You need to match up the permissions on the filter and widget, or you'll run into issues where someone can see the widget but when they click on it they'll get an error that they don't have permissions to view the details. WidgetFilter You can check your filter by using it in the Issues list window to make sure the expected results are returned.

Create the Widget

Now go to Tools > Administration > Home Widgets and click the orange + button to create a widget. WidgetStart First, you need to configure the basic options for the widget:
  1. Give your new widget a name. I'm going to use "Must Fix Issues"
  2. Type is the item type you're focused on, which is Issues in this example
  3. Select the filter you just created
  4. If you want, you can limit access to this widget to one or more security groups
Remember to match up permissions between the widget and filter. You don't want anyone to have access to the widget but not the filter, that will cause frustration when they try to click through the widget. The last step is to set up color mappings so you'll immediately know how things are going when you see the widget. For this example, I'm going to assume the product team wants maximum flexibility on when they release and they've decided to address critical issues right when they're found. This means there shouldn't be many "must fix" issues because they should be getting closed out fairly quickly. You can see the completed widget below; I've set it up so it's green if there are 0, orange if there are 1-4, and red if there are 5 or more open critical issues. WidgetFinish

Add the Widget to the Home page

To use the widget, any user can go to their Home page and select it from the Widgets drop-down in the top-right corner. Here's the widget in use: WidgetUse To review the 5 "must fix" issues, click on the widget to go to the Issues list window with the filter already applied. From there it's easy to see details about each issue, such as who it is assigned to, when it was found, etc.