You are here

Home » API reference » Search API Saved Searches 7

README.txt in Search API Saved Searches 7

Same filename and directory in other branches
  1. 8 README.txt
Search API Saved Searches
-------------------------

This module offers users the ability to save searches executed with the
Search API module and be notified of new results. Notifications are done
via mails with token-replacement, their frequency can be configured both by
admins and/or users and saved searches can also be created without first
executing the search.

Facet, Views or other filters set for the search will also be included in a
saved search, thus reflecting exactly the same search results as displayed.

Bug reports, feature suggestions and latest developments:
  https://www.drupal.org/project/issues/search_api_saved_searches

Installation
------------

* Install the module as usual.
  See http://drupal.org/documentation/install/modules-themes/modules-7
  for further information.
* Set the module's permissions (Administer saved searches, Use saved searches).
* You can now configure saved searches for each index by going to its
  "Saved searches" tab.
* For being able to actually save searches, you have to enable the
  "[Index Name]: Save search" block. This block will only appear on pages which
  contain a Search API search and allow users to save the executed search.

Hidden variables
----------------

* search_api_saved_search_queue_item_time (default: 10)
  By default, queue item time is set to 10 seconds. This setting lets you modify
  the queue item time by providing your own value in seconds.
* search_api_saved_searches_debug_messages (default: TRUE)
  Set to FALSE to disable the watchdog messages that are by default logged for
  every notification mail that gets sent.

File

README.txt
View source 
  1. Search API Saved Searches

  2. -------------------------

  3. 

  4. This module offers users the ability to save searches executed with the

  5. Search API module and be notified of new results. Notifications are done

  6. via mails with token-replacement, their frequency can be configured both by

  7. admins and/or users and saved searches can also be created without first

  8. executing the search.

  9. 

  10. Facet, Views or other filters set for the search will also be included in a

  11. saved search, thus reflecting exactly the same search results as displayed.

  12. 

  13. Bug reports, feature suggestions and latest developments:

  14.   https://www.drupal.org/project/issues/search_api_saved_searches

  15. 

  16. Installation

  17. ------------

  18. 

  19. * Install the module as usual.

  20.   See http://drupal.org/documentation/install/modules-themes/modules-7

  21.   for further information.

  22. * Set the module's permissions (Administer saved searches, Use saved searches).

  23. * You can now configure saved searches for each index by going to its

  24.   "Saved searches" tab.

  25. * For being able to actually save searches, you have to enable the

  26.   "[Index Name]: Save search" block. This block will only appear on pages which

  27.   contain a Search API search and allow users to save the executed search.

  28. 

  29. Hidden variables

  30. ----------------

  31. 

  32. * search_api_saved_search_queue_item_time (default: 10)

  33.   By default, queue item time is set to 10 seconds. This setting lets you modify

  34.   the queue item time by providing your own value in seconds.

  35. * search_api_saved_searches_debug_messages (default: TRUE)

  36.   Set to FALSE to disable the watchdog messages that are by default logged for

  37.   every notification mail that gets sent.