Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Info

Valid for Datafari from v6.0

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.

Connected Search

...

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.

...

user: managing your alerts                                  

In order to create an alert, you need to be connected with a connected search user role.

In the search results page, click on the Search Tools menu on the upper right of the screen and in the Manage Alerts item.

...

You can see and manage the alerts you have already created.

...

You can either Modify an alert or delete it. When editing, you will have access to the following modifications:

...

If you want to create a new alert, first, launch a search query of interest, the one you want to use as an alert, facets included. Then in the same Search Tools menu, click on the Save Query as Alert entry.

...

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:

  • Alert Nameis the identifier of this alert.

  • Keep facets will also take the facets into account when launching automatically the query (if the box is checked)

  • Email address is the recipient's email address,

  • Frequency is the frequency for triggering your search query and sending the corresponding emails.

...

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.

...

Expand
titleValid for Datafari up to v5.5
Info

Valid for Datafari up to v5.5

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.

 Image Added

Each document is composed of three pieces of information : the document title, where to find it, and when it has been created or modified.

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.

 

Image Removed 

...

In the search results page, click on the Parameters link on the upper right of the screen.

Image Added

Once in the paramets page, click on the Alerts link on the left.

Image Added


You can then see the management page for alerts. On the left, you see a table listing the existing alerts. You can either Modify the Send frequency or simply Delete an alert directly from the table.

Image Added

If you want to create a new alert, click on the Create alert button.

Image Added

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:

  • Keywordis the word that will be used by the

...

  • Solr request,

  • Subjectis the subject of the

...

  • email,

...

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.

  • Mail is the recipient's email address,

  • Frequency is the frequency for triggering your search query and sending the corresponding emails.

 

...

Image Added

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.

Info

Alerts on plain text (eg .

...

txt) files

(warning) If you are using the local filesystem connector (which is NOT recommended in production environment for security reasons), the alerts cannot be used on plain text files, as Tika cannot extract any metadata like the modification date from them.