Report users have the ability to save their own personal favorite settings in the Optional Filter area* in the StoryTeller report. In projects with many Optional Filters the users will save a lot of time by saving selections that are being made frequently. (*Optional Filters = Filters, Time periods, Interval, Moving average, Variable subsets and Hierarchical Filters).
The feature for saving favorite settings is optional and turned off in the reports by default. The setting is made on a report level and placed in the Filter & Settings tab as shown in the image below. To activate the feature click the button and select the option On.
The image below shows the setup
The image below shows the “favorite” icons appearing in the Report User view when the feature is activated.
To save a favorite click the second icon and enter a name of the favorite in the popup window. To load a favorite click the first icon and a list of all saved favorites are shown, to load the favorite click on it. The favorites are listed alphabetically. The image below shows a list of favorites.
To delete or rename a favorite use the Delete and Edit options in the list of favorites appearing when clicking the second star icon.
NOTE: If a Favorite is saved with an Optional Filter which is not present in the Report any longer this particular filter is being ignored (it will not filter the data). Only Filters/Settings that are active in the report are applied.
By default, the Optional filter favorites behaves like before which means that these are StoryTeller specific but the Administrator can turn on the use of cross report Favorites.
When applying cross report Favorites, to a project, the administrator can define whether users can use favorites with only filters that can be exactly selected in the report or be able to load a favorite containing filter options that are not available in the report, in this scenario the filters that cannot be applied are simply ignored, only the filters that can be set are applied when the Favorite is loaded.
Example of scenarios where an Optional Filter Favorite contains filter items that cannot be set in the current report:
- The Favorite contains an Optional filter* that is not available in the current report
- The Favorite has multiple filter options selected in a filter variable not supporting multiple selections in the current report
- The Favorite has the “Compare” option selected in a Filter variable not supporting Compare in the current report
- The Favorite has the “Filter” option selected in a Filter variable not supporting Filtering (only supporting Compare) in the current report
*Optional Filter option= all items that can be included in the Optional filter area = Hierarchical filter, regular Filters, Variable subsets, Time period, interval and Moving average.
If the users are allowed to select Favorites with filter items that cannot be set in the current report these Favorites are highlighted, with a warning icon, in the list of Favorites. When hovering over the warning icon an information message appears with details about the filters that will not be applied to the current report.
Here we see the list of Favorites. The Favorites containing filter items that cannot be set in the current report are highlighted with a warning icon.
Here we see the info message appearing when hovering over the warning icon.
How to apply the new logic
To apply the new cross report favorite logic to a project, enter the Project settings page, in the “Optional filter” panel you find two new settings as shown in the image below.
If you turn on cross report favorites you can then select if the list of favorites will contain favorites with filter options that can be applied in the current report only by ticking the “Allow usage of Favorites with complete filter match only” or if the users also will be able to use Favorites containing filter options that cannot be applied by not ticking the check box.
Here we see the new controls, in Project selection page, for defining Optional Filter Favorites behavior.