Filtering Collection Widgets

Document created by Chris Sommerstad Employee on Jul 22, 2017
Version 1Show Document
  • View in full screen mode

Widgets that display collections also display collection-based filters in the dashboard or widget Edit Panel. Collection filters include Collection Rate, Collection Type, and Collection Name.

Like other widgets, the Fundamentals widget provides widget-specific filters. Since Collections are shown in this widget it can be filtered by collection. For example, the Collections Rate filter of the Fundamentals widget provides the ability to create on-the-fly Collections Completed per Minute, or Collections Started per Minute, Collections Completed per Hour or Collections Started per Hour sections in the existing Fundamentals widget. Once inserted, the filter(s) are placed in the leftmost column of the Fundamentals widget, shifting the pre-existing field to the right.

Setting the Collections Rate Filter

  1. To use a Fundamentals widget filter such as the Collections Rate filter, place the Fundamentals widget into a dashboard.
  1. Select the Fundamentals widget (as shown above), and then click Toggle Dashboard Edit Mode to open up the bottom panel.  
  2. With Fundamentals selected in the Edit Panel, check Collections Rate.

The Collections Rate filter form appears.

The Collections Rate filter form uses an expression to allow the user to create a filter for a selected collection(s) for a given state and rate. One or more filters can be applied.

  1. To create a filter, click the (Choose…) drop down in the first column and select the collection(s) to filter on. When you do so, a drop-down selection box appears.

  1. Select the type of collection to filter on. For example, Pages.

The available collections for the selected collection type appear in the list below.

  1. Select one or more collections in this test on which to filter (as shown below). Collection items can also be selected one at a time and then added via the Add button.

  1. Click Apply when done selecting.
  2. Choose whether to filter collections by the state, Started or Completed. Note that “Started” collections will only display during composition play, while “Completed” ones will only display after the given item has completed play.

  1. Next, choose whether to filter by the rate per Minute or per Hour.

  1. Next, determine the Surface Title for this filter, which can be based on all or part of the expression, or which can have a custom name.
    • To display only the collection names and the integer (for either completed or started), check Display in the first column.
    • To display only Started or Completed, check Display in the second column.
    • To display only the rate, check Display in the third column.
    • Alternately, check the Custom radio button and enter a custom surface title.
  1. Next, determine whether to make one or more columns in this expression editable on the widget surface.
  • Check editable for the first column if you’d like to select and then edit the collections on the widget surface at a later time.
  • Check editable for the second column if you’d like to select and then switch between Started or Completed on the widget surface at a later time.
  • Check editable for the third column if you’d like to select and then switch between the rate on the widget surface at a later time.

For example, if both Display and Editable are checked in the first column—then the collection selection box appears on the widget title bar.

In this screenshot, all three columns were set to editable and the second column’s hypertext has been clicked.

Optionally, add one or more additional filters by clicking the green Plus icon.

When you do so, a second Collection Rate filter form appears.

Setting the Collection Type and/or Collection Name Filter

CloudTest also provides the ability to filter results at either the dashboard, and in some cases at the widget level, by a given Collection Name. This feature is in addition to being able to filter by any Collection Type.

  1. Open the dashboard to filter by Collection Name, or select a specific collection widget to filter. Collection Name appears as a filter attribute in many widgets (including Result Details, Collection Analysis, and all of the collection widgets).
  2. Invoke the Dashboard Edit Panel by clicking Dashboard Toggle Edit Mode button.
  3. Leave the Dashboard node selected in the edit panel selected if the filter will apply to the entire dashboard. Otherwise, select the widget node in the list on the left of the panel.

  1. With either the Dashboard or Widget node selected in the Edit Panel list on the left, click the Filter tab.
  2. Click the Attribute drop-down and select Collection Name. If Collection Name doesn’t appear the current selection cannot be filtered by that attribute.

  1. In the Operator field, choose from either In or Not In.
    • Use “In” to filter only those results in the specified container(s).
    • Use “Not In” to exclude the specified container(s).
    • To filter by more than one Collection Name, click the green Plus icon to add a new row then repeat the steps above for that row.

  1. Click the Value field. An additional drop-down appears with the available collection types in display. Choose the collection type, and the available collection names are then populated. For example, selecting Transactions displays a list of the transactions in this result by name.

TIP: Use the OS-specific method for selecting a range of names or for selecting names out of order. Long lists can be filtered by entering a string in the Search field above collection type.

  1. Click the Apply button (in the Collection Name drop-down) to confirm the selection. The filter value is added.

If multiple names were selected, they are shown alphabetically and comma-separated in the Value field. For example, the filter below lists selected by name using the method above.

  1. Click the Apply button on the far-right of the Edit Panel to complete the filter.