Skip to content

Commit 1080734

Browse files
committed
[IMP] essentials: extra detail plus updates to favorited searches
task-5005364 X-original-commit: 38f2fcc
1 parent c575c26 commit 1080734

File tree

2 files changed

+37
-10
lines changed

2 files changed

+37
-10
lines changed

content/applications/essentials/search.rst

Lines changed: 37 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -197,8 +197,8 @@ Previous Period` and :guilabel:`(Time Filter): Previous Year`.
197197

198198
.. important::
199199
For some reports, the :guilabel:`Comparison` section **only** appears in the search bar drop-down
200-
menu if one (or more) time periods have been selected in the :guilabel:`Filters` column. This is
201-
because there is nothing to compare if no time period is specified.
200+
menu if one (or more) time periods have been selected in the :guilabel:`Filters` column. This is
201+
because there is nothing to compare if no time period is specified.
202202

203203
Additionally, some reports only allow use of the :guilabel:`Comparison` feature when the
204204
:icon:`fa-pie-chart` :guilabel:`(Pie Chart)` graph type or the :icon:`oi-view-pivot`
@@ -260,19 +260,46 @@ following options:
260260

261261
- :guilabel:`Filter name`: Name of the favorited search.
262262
- :guilabel:`Default filter`: Sets the favorited search as the default filter for the view.
263-
- :guilabel:`Shared`: Makes the favorited search available to all users. Otherwise, by default, the
264-
favorited search is only available to the user who created it.
265263

266264
Once the options are set, click :guilabel:`Save` to save the favorited search.
267265

268266
.. image:: search/favorites.png
269267
:alt: Saving a favorite search on the Sales Analysis report.
268+
:scale: 80%
270269

271-
Saved favorites can be accessed by clicking the :icon:`fa-trash` :guilabel:`(delete)` icon in the
272-
search bar, then selecting the saved filter in the :guilabel:`Favorites` drop-down menu. To remove a
273-
saved favorite, click the :icon:`fa-trash` :guilabel:`(delete)` icon next to the favorited search.
270+
Favorited searches are accessed by clicking the :icon:`fa-caret-down` :guilabel:`(dropdown)` icon
271+
in the search bar, and are shown under :icon:`fa-star` :guilabel:`Favorites`. Searches that are only
272+
visible to the current user, i.e., that are not shared, are shown first, while any :ref:`shared
273+
favorites <search/favorites-share>`, whether created by the current user or another user, are shown
274+
in a second section.
275+
276+
To edit, archive, or delete a favorited search, hover over the search name in the list of favorites
277+
and click :icon:`fa-pencil` :guilabel:`(Edit favorite)`. The following fields can be modified:
278+
:guilabel:`Filter Name`, :ref:`Shared with <search/favorites-share>`, :guilabel:`Default Filter`,
279+
:guilabel:`Domain`. To archive or delete the favorite, click :icon:`fa-cog` :guilabel:`(Actions)`
280+
then :icon:`oi-archive` :guilabel:`Archive` or :icon:`fa-trash` :guilabel:`Delete`, as appropriate.
274281

275282
.. tip::
276-
To view *all* favorited searches, first activate :ref:`developer-mode`, and navigate to
277-
:menuselection:`Settings app --> Technical --> User Interface: User-defined Filters`. From here,
278-
all favorited searches can be viewed, edited, archived, or deleted.
283+
- When a favorited search is in use, additional filters or groups can be used to further refine
284+
the view. The conditions applied by the favorited search can also be modified by hovering over
285+
the :icon:`fa-star` :guilabel:`(star)` beside the search name then clicking the :icon:`fa-cog`
286+
:guilabel:`(cog)` icon. These changes only affect the current search.
287+
- To view *all* favorited searches, with :ref:`developer mode <developer-mode>` activated,
288+
navigate to :menuselection:`Settings app --> Technical --> User-defined Filters`. From here,
289+
all favorited searches can be viewed, edited, archived, or deleted. Activating developer mode
290+
before editing a favorited search via the list of favorites also allows the grouping and
291+
sorting of a favorited search to be modified.
292+
293+
.. _search/favorites-share:
294+
295+
Share a favorited search
296+
------------------------
297+
298+
By default, a favorited search is only available to the user who created it. To share a favorited
299+
search with other users, click :guilabel:`Edit` when creating the favorite, or, for an existing
300+
favorite, click :icon:`fa-pencil` :guilabel:`(Edit favorite)` after hovering over the search name in
301+
the list of favorites.
302+
303+
In the :guilabel:`Shared with` field, select the relevant users from the drop-down menu, then click
304+
:icon:`fa-cloud-upload` :guilabel:`(Save manually)`. The favorite is now visible for all selected
305+
users under :icon:`fa-star` :guilabel:`Favorites`.
38.2 KB
Loading

0 commit comments

Comments
 (0)