Notifications
Installation and Configuration
Copyright ©
Mindbreeze GmbH, A-4020 Linz, 2020.
All rights reserved. All hardware and software names are brand names and/or trademarks of their respective manufacturers.
These documents are strictly confidential. The submission and presentation of these documents does not confer any rights to our software, our services and service outcomes, or other protected rights.
The dissemination, publication, or reproduction hereof is prohibited.
For ease of readability, gender differentiation has been waived. Corresponding terms and definitions apply within the meaning and intent of the equal treatment principle for both sexes.
Introduction
The notification service makes it possible for users to be notified of changes to hits.
For example, a user searches for a particular search word, for instance "Mindbreeze Folder", and calls up all PDF documents for display. He gets 50 search hits
Now he would like to be notified by e-mail (for example, every Monday at 8 a.m.), if the number of hits has changed.
Preparation
Create a database for notifications
In order to use notifications, you need a corresponding database.
Tip: Create a database as follows:
create database notifications;
CREATE USER user WITH PASSWORD 'password';
grant all privileges on database "notifications" to user;
Configuration
You can find two relevant settings in the configurator under "Client Services".
Notification service settings – Collections for notifications
Settings:
Enable: Enables notifications –default: true
Allow Email subscriptions: Unavailable in the default search client, so it should not be activated.
Collection Name: Name of the collection – is needed for display on Client.
Collection Path: Path to the collection. Format: emailalert/clear_name – example: emailalert/daily
Crontab Expression: Specification of the execution time – examples:
Every Monday at 8:00 a.m.: 0 0 8 ? * MON *
Every day at 6:00 pm: 0 0 18 1/1 * ? *
Path to Query Templates: Path for the "Query Script" and "Output Format Script" templates.
Query Script: File name of the query script.
Output Format Script: The file name of the script for formatting the output.
Mailserver: Specifies the mail server from which the e-mails are sent.
Sender of notification emails: Specifies the e-mail address from which the e-mails will be sent.
Resource persistence settings
Settings:
Enable: Enables persisted resources - default: false.
User Administrator Users: Specifies the user administrators.
User administrators can manage all users (delete, edit [e.g., edit e-mail address], add). Each user is entered into a separate line.
JDBC URL: Specifies the database URL.
Max Number of Database Connections: Maximum number of database connections. Default value: 10, minimum value: 2.
User: Specifies the user for the database.
Password: Specifies the password for the database.
Database Table Prefix: Specifies the table prefix in the database.
User interface
User Administration
If the notifications are enabled and set correctly, a new entry "Users" is displayed under "Search Apps" in the Management Center, which lists all existing users.
All user administrators that were previously configured are now authorized to create new users ("Add user" button), to edit all existing users ("Edit"), or to delete them.
To delete an existing user, click on the user name, navigate to the overview of the user, and then click "Delete user".
Alert Administration
If the notifications are enabled and set correctly, a new entry "Alerts" is displayed under "Search Apps" in the Management Center, which lists all existing alerts.
The Administrator has permissons to view details and edit the description of all alerts.
To delete an existing alert only a click on the delete button next to the altert in the overview is needed.
Change Alerts on the Client
To edit an existing alert simply click on the desired alert. A preview opens with the corresponding search. You can change the search query, all the filters and so on. To save the changes just click “Save changes”.
