Adding Custom Actions in Amazon QuickSight Visuals - Amazon QuickSight

Adding Custom Actions in Amazon QuickSight Visuals

In Amazon QuickSight, you can add to the basic functionality for visuals by creating your own custom actions. The fields used in the custom action must be in the visual for the action to work.

Currently, you can create the following custom actions:

  • Filter actions – Add the ability to filter one or more visuals when you choose a data point or a menu item. For example, you might choose a country in one visual, and that action filters data according to its settings. Then you can view that country's top customers, revenue, or other key metrics in the filtered visuals. Filter actions work across multiple datasets by using automatically generated field mappings. You can use the "quick create" option to make a preconfigured filter that works for all visuals on the same sheet. Cascading filters are enabled by default, so you don't have to take any additional steps to configure it. However, you can adjust the fields involved in filtering, and which target visuals get filtered.

  • URL actions – You can use URL schemes to perform an action, based on a URL, from within your dashboard. In some cases, you might want to create a link to another URL from your visual, or you might want to create an email directly from a visual. Users viewing the dashboard can use a URL action to send data points to other URLs (dashboards, analyses, and websites) by selecting a data point (left-click), or selecting the action from the data point context (right-click) menu.

    If you remove a parameterized field or any other targeted field from the source visual, the action that uses it breaks. The action for the missing field either doesn't work when you select a data point, or it's hidden from the context menu.

Custom actions have the following attributes and options:

  • Action name – This is a descriptive name that you choose for the action. By default, actions are named Action 1, Action 2, and so on. If your custom action is activated from a context menu, this name displays in the menu when you right-click on a data point.

    You can also parameterize the action name to include dynamic values. To select a field or a parameter from the current visual, choose the + near the URL text box to display a list of available variables. Parameter names are enclosed in angle brackets << >> and prefixed with a $ and , for example <<$parameterName>>. Field names are enclosed in angle brackets, but not prefixed with a $.

  • Activation – Available options are Select or Menu option. To use an action, you can either select the data point (left-click) or navigate to the menu option in the context menu (right-click). You can find URL actions listed in the middle of the context menu, just above Color options. Actions that are activated by menu options are also available from the legend on a visual.

  • Action type – The type of action that you want. To create an action that filters data, choose Filter action. To create an action that uses a URL, choose URL action. This attribute changes the options that display for the remaining settings.

  • For filter actions, the following settings appear:

    • Filter scope – Choose to filter on all fields or to filter on only the selected fields. To filter on all fields, choose All fields. To select the fields that you want to filter on, choose Selected fields.

    • Target visuals – Choose to target all visuals or to target only the selected visuals. To apply the filter to all visuals, choose All visuals. To select the visuals that you want to apply the filter to, choose Select visuals.

  • For URL actions, the following settings appear:

    • URL – The URL that you want to open when the custom action is activated. URL actions can be deep links into another application, but only if each can be accessed by a valid URL in the URL scheme https, http, or mailto.

      You can also parameterize the URL to include dynamic values. The parameters on both the sending and the receiving end must match in name and data type. To choose a field or a parameter from the current visual, choose the + near the URL box to display a list of available variables. Enclose parameter names in angle brackets << >> and prefix them with a $, for example <<$parameterName>>. Field names are enclosed in angle brackets, but not prefixed with a $. If you later remove a parameterized field or any other targeted field from the source visual, the action that uses it breaks.

    • Open in – Where to open the URL. You can choose New browser tab, Same browser tab, or New browser window.

If the analysis uses more than one dataset, you can view the automatically generated field mappings for fields that exist in multiple datasets. You can choose View field mapping at the end of the action settings, if you're editing an action. If you are viewing a list of actions, you can choose View field mapping from the ( ) menu for each action. The field mappings appear in a new screen that shows the mapping between the initial dataset and all the other datasets in the visual. If no fields are automatically mapped, a message displays with a link to Mapping and Joining Fields.