Rather than actively searching for documents using queries, alerts allow you to receive information about documents via email. Once you define a query and a frequency, you regularly receive information about new and modified documents that refer to your query. For instance, the screenshot below illustrates an email alert on the keyword Nice.
Each document is composed of three pieces of information : the document title, where to find it, and when it has been created or modified.
Search admin: managing the alerts mechanism
Using the search admin role, you first need to configure the alert mechanism so that it uses the smtp server to send emails.
The Alerts Administration UI allows to graphically edit the config file mail.txt which is stored in InstallationDirectoryDatafari/bin/common
It needs the following information:
smtpHost = the name of the host
from = the address (exemple@exemple.com)
username = the username (usually it will be the address)
password = the password of the mail address
For Instance :
smtpHost = smtp.gmail.com;
from = datafari.test@gmail.com;
username = datafari.test@gmail.com;
password = ********;
Once this is configured and saved, you need to restart the alerts using the dedicated button.
The search admin has more access rights than a connected search user (see below for the description). He gets the same type of information, except that he sees it for everyone. The only thing he cannot do is to create alers on behalf of other users.
Connected Search user: managing your alerts
In order to create an alert, you need to be connected with a connected search user role.
We expose a web interface. First, go to the administration menu, click on Search Engine Users and select Create Alerts in the dropdown list.
You then have access to the UI that allows you to create Alerts by filling the fields, and choosing a frequency.
The form asks for the following information:
- Keyword is the word that will be used by the solr request,
- Subject is the subject of the mail,
- Core is the solr core in which the request will be made.
- Frequency is the frequency for triggering your search query and sending the corresponding emails.
If you want to know which alerts you have already created, use the search bar on top of the page, and type in what you want to search for (it searches in the queries keywords). If you want to see all your searches, leave the search bar empty and click on the search icon.
The identified results are then displayed in the results table. You can edit an existing alert by clicking on the keyword, or delete one by clicking on the red button.
Note that the alert results are related to the currently connected user. Only the search admin role and the search expert role can see all the existing alerts for all the users.