Creating a master-listener relation

Master-listener relation is a widget level interaction to display related details. You first set a source widget and then add a target widget to it.

Before you begin

  • Ensure that the dashboard contains all the widgets that you want to link as master and listener.
  • Ensure that the widgets are complete. For example, all the widget-level and page-level filters are mapped, and all the widget and chart properties are set.
  • Ensure that the widgets display proper data when previewed. You must preview the widgets before you set master-listener relation.
  • Ensure that the widgets that you plan to pair as master and listener widgets have a common metric value.
  • For widgets that contain manual data definition, ensure that the parameter name and the common metric value that you specify for the master widget are already specified in the manual data definition of the listener widget.

    If you plan to use Map and Treemap charts as listener widgets, then you must use the column names that you entered in the ID and Parent fields as the common metric values. Ensure that these values are already specified in the manual data definition and in the Set Properties window.

    Example of the manual data definition, SELECT * FROM <table_name> WHERE <ID_column_name> LIKE '<attribute>' OR <Parent_column_name> LIKE '<attribute>'

    Where,
    • <table_name> is the name of the database table.
    • <ID_column_name> is the column name that you specified in the ID field in the Set Properties window.
    • <Parent_column_name> is the column name that is specified in the Parent field in the Set Properties window.
    • <attribute> is any attribute value to be mapped.
  • Map chart must either be used as a master widget or a listener widget but not as both. If you set a master-listener relation between two supported Map chart locations, then both the charts display similar map locations.
  • To use a transformation widget as a listener widget, while creating the transformation widget, you must set Filter by Master Parameter operation and specify the master parameter. If you plan to specify multiple master parameters, then ensure that all of those parameter names are already specified in the listener transformation widget.

    For more information, see Creating transformation widgets.

About this task

  • You can define master-listener relations is the following ways:
    • A single source widget can be connected to a single target widget.

      For example, a single source widget can be connected to a single widget with an embedded website or web application.

    • A single source widget can be connected to multiple target widgets.
    • A single source widget can be connected to multiple target widgets that are in turn connected to one or more target widgets.
    • An all instances custom widget must always be set as a master widget only.
  • If a dashboard contains a multi-chart widget, then all the widgets in that multi-chart widget function as any other dashboard widgets. You can set a master-listener relation between any of the dashboard widgets, irrespective of whether they belong to a multi-chart widget or not.
  • If a dashboard contains transformation widgets, then the transformation widgets function as any other dashboard widget. You can set a master-listener relation between any of the dashboard widgets, irrespective of whether they are transformation widgets or whether they belong to a multi-chart widget or not.
  • You can also set a master-listener relation between a transformation widget and a virtual data set or a normal widget and a virtual data set. You can set the virtual data set as a listener widget only.
Note: For setting master-listener relations that involve multiple widgets, you cannot reuse any widget.

Procedure

Complete the following steps to set a master-listener relation:

  1. In the navigation pane of Dashboard Designer, click Dashboards.

    Open a dashboard where you want to set relations. You can open a dashboard, either from the Most Recently Created Dashboard list or from Manage Dashboards list.

    Note: The dashboard must display multiple widgets. The widgets for which you want to set master-listener relation must contain common metrics.
  2. Click the Set Relation Set Relation icon.

    The Set Relation window opens. The window displays a Widgets/Data Sets tab and a Dashboards tab. The Widgets/Data Sets tab shows all the widgets that are available in the current dashboard. If the dashboard contains multi-chart widgets or transformation widgets, then those widgets are also displayed in the Widgets pane. The Data Sets pane in the Widgets/Data Sets tab displays all the virtual data sets.

    The Dashboard tab lists all the dashboards that are available in the user group.

  3. From the Widgets/Data Sets tab, either select a widget or locate it by entering its name in the Search field. Drag the widget to the widget area to set it as a source widget.
    Note:
    • If you are using an all instances custom widget, then you must set it as a source widget only.
    • You can also drag a transformation widget as a master widget.
  4. Right-click the source widget and complete any of the following steps:
    • Click Add a Listener Widget to add a target widget. From the Widgets/Data Sets tab, select and drag a widget that you want to set as a target widget for communications.
      Note: If you drag a transformation widget as a listener widget, then ensure that the master parameter name is already mapped in the transformation widget.
    • Click Add a Listener Data Set to add a virtual data set. From the Data Sets pane, select and drag a virtual data set that you want to set as a target widget for communications.
  5. Optional: If you want to add another master-listener relation, then right-click either the source widget or a target widget, and click Add Another Relation.
    You can specify a source and target widget as mentioned in the earlier steps. Similarly, you can set master-listener relation for all the widgets within a dashboard or for a few widgets within a dashboard.
    Note: You cannot add additional relations to a virtual data set.
  6. After all the master-listener relations are set, you must set parameters that must be passed from the source to the target widgets for communication. You can also use a regular expression to filter the data that is passed from the source widget to the target widget, and prefix and suffix static characters to the expression. For more information, see Mapping metrics data.
  7. Optional: You can complete any of the following steps to modify or delete the mapping or the relations:
    • To delete a master-listener relation, you must first delete the mapping in its target widget. For more information, see Mapping metrics data.
    • To delete an existing master-listener relation, right-click the target widget, and click Delete.
    • To delete an existing master-listener virtual data set relation, right-click the virtual data set, and click Delete Data Set.
    • To replace a widget in an existing master-listener relation, right-click either a source widget or a target widget, and click Delete Chart. You can then drag another chart to that widget area.
  8. Click Save to save the relation.

What to do next

You can also add a drill-down relation to a target widget, and then map metrics data. For more information, see Creating a drill-down relation and Mapping metrics data.