Home
Home
German Version
Support
Impressum
23.6 Release ►

    Main Navigation

    • Preparation
      • Connectors
      • Create an InSpire VM on Hyper-V
      • Initial Startup for G7 appliances
      • Setup InSpire G7 primary and Standby Appliances
    • Datasources
      • Configuration - Atlassian Confluence Connector
      • Configuration - Best Bets Connector
      • Configuration - Box Connector
      • Configuration - COYO Connector
      • Configuration - Data Integration Connector
      • Configuration - Documentum Connector
      • Configuration - Dropbox Connector
      • Configuration - Egnyte Connector
      • Configuration - GitHub Connector
      • Configuration - Google Drive Connector
      • Configuration - GSA Adapter Service
      • Configuration - HL7 Connector
      • Configuration - IBM Connections Connector
      • Configuration - IBM Lotus Connector
      • Configuration - Jira Connector
      • Configuration - JiveSoftware Jive Connector
      • Configuration - JVM Launcher Service
      • Configuration - LDAP Connector
      • Configuration - Microsoft Azure Principal Resolution Service
      • Configuration - Microsoft Dynamics CRM Connector
      • Configuration - Microsoft Exchange Connector
      • Configuration - Microsoft File Connector (Legacy)
      • Configuration - Microsoft File Connector
      • Configuration - Microsoft Graph Connector
      • Configuration - Microsoft Project Connector
      • Configuration - Microsoft SharePoint Connector
      • Configuration - Microsoft SharePoint Online Connector
      • Configuration - Microsoft Stream Connector
      • Configuration - Microsoft Teams Connector
      • Configuration - Salesforce Connector
      • Configuration - SemanticWeb Connector
      • Configuration - ServiceNow Connector
      • Configuration - Web Connector
      • Configuration - Yammer Connector
      • Data Integration Guide with SQL Database by Example
      • Indexing user-specific properties (Documentum)
      • Installation & Configuration - Atlassian Confluence Sitemap Generator Add-On
      • Installation & Configuration - Caching Principal Resolution Service
      • Installation & Configuration - Jive Sitemap Generator
      • Installation & Configuration - Mindbreeze InSpire Insight Apps in Microsoft SharePoint On-Prem
      • Mindbreeze InSpire Insight Apps in Microsoft SharePoint Online
      • Mindbreeze Web Parts for Microsoft SharePoint
      • User Defined Properties (SharePoint 2013 Connector)
      • Whitepaper - Mindbreeze InSpire Insight Apps in Salesforce
      • Whitepaper - Web Connector - Setting Up Advanced Javascript Usecases
    • Configuration
      • CAS_Authentication
      • Configuration - Alternative Search Suggestions and Automatic Search Expansion
      • Configuration - Back-End Credentials
      • Configuration - Chinese Tokenization Plugin (Jieba)
      • Configuration - CJK Tokenizer Plugin
      • Configuration - Collected Results
      • Configuration - CSV Metadata Mapping Item Transformation Service
      • Configuration - Entity Recognition
      • Configuration - Exporting Results
      • Configuration - External Query Service
      • Configuration - Filter Plugins
      • Configuration - GSA Late Binding Authentication
      • Configuration - Identity Conversion Service - Replacement Conversion
      • Configuration - InceptionImageFilter
      • Configuration - Index-Servlets
      • Configuration - Item Property Generator
      • Configuration - Japanese Language Tokenizer
      • Configuration - Kerberos Authentication
      • Configuration - Management Center Menu
      • Configuration - Metadata Enrichment
      • Configuration - Metadata Reference Builder Plugin
      • Configuration - Mindbreeze Proxy Environment (Remote Connector)
      • Configuration - Notifications
      • Configuration - Personalized Relevance
      • Configuration - Plugin Installation
      • Configuration - Principal Validation Plugin
      • Configuration - Profile
      • Configuration - Reporting Query Logs
      • Configuration - Reporting Query Performance Tests
      • Configuration - Request Header Session Authentication
      • Configuration - Shared Configuration (Windows)
      • Configuration - Vocabularies for Synonyms and Suggest
      • Configuration of Thumbnail Images
      • Cookie-Authentication
      • Documentation - Mindbreeze InSpire
      • I18n Item Transformation
      • Installation & Configuration - Outlook Add-In
      • Installation - GSA Base Configuration Package
      • JWT Authentication
      • Language detection - LanguageDetector Plugin
      • Mindbreeze Personalization
      • Mindbreeze Property Expression Language
      • Mindbreeze Query Expression Transformation
      • SAML-based Authentication
      • Trusted Peer Authentication for Mindbreeze InSpire
      • Using the InSpire Snapshot for Development in a CI_CD Scenario
      • Whitepaper - MMC_ Services
      • Whitepaper - Natural Language Question Answering (NLQA)
      • Whitepaper - SSO with Microsoft AAD or AD FS
      • Whitepaper - Text Classification Insight Services
    • Operations
      • app.telemetry Statistics Regarding Search Queries
      • Configuration - app.telemetry dashboards for usage analysis
      • Configuration Usage Analysis
      • Deletion of Hard Disks
      • Handbook - Backup & Restore
      • Handbook - Command Line Tools
      • Handbook - Distributed Operation (G7)
      • Handbook - Filemanager
      • Handbook - Indexing and Search Logs
      • Handbook - Updates and Downgrades
      • Index Operating Concepts
      • Inspire Diagnostics and Resource Monitoring
      • Mindbreeze InSpire SFX Update
      • Provision of app.telemetry Information on G7 Appliances via SNMPv3
      • Restoring to As-Delivered Condition
    • User Manual
      • Browser Extension
      • Cheat Sheet
      • iOS App
      • Keyboard Operation
    • SDK
      • api.v2.alertstrigger Interface Description
      • api.v2.export Interface Description
      • api.v2.personalization Interface Description
      • api.v2.search Interface Description
      • api.v2.suggest Interface Description
      • api.v3.admin.SnapshotService Interface Description
      • Debugging (Eclipse)
      • Developing an API V2 search request response transformer
      • Developing Item Transformation and Post Filter Plugins with the Mindbreeze SDK
      • Development of a Query Expression Transformer
      • Development of Insight Apps
      • Embedding the Insight App Designer
      • Java API Interface Description
    • Release Notes
      • Release Notes 20.1 Release - Mindbreeze InSpire
      • Release Notes 20.2 Release - Mindbreeze InSpire
      • Release Notes 20.3 Release - Mindbreeze InSpire
      • Release Notes 20.4 Release - Mindbreeze InSpire
      • Release Notes 20.5 Release - Mindbreeze InSpire
      • Release Notes 21.1 Release - Mindbreeze InSpire
      • Release Notes 21.2 Release - Mindbreeze InSpire
      • Release Notes 21.3 Release - Mindbreeze InSpire
      • Release Notes 22.1 Release - Mindbreeze InSpire
      • Release Notes 22.2 Release - Mindbreeze InSpire
      • Release Notes 22.3 Release - Mindbreeze InSpire
      • Release Notes 23.1 Release - Mindbreeze InSpire
      • Release Notes 23.2 Release - Mindbreeze InSpire
      • Release Notes 23.3 Release - Mindbreeze InSpire
      • Release Notes 23.4 Release - Mindbreeze InSpire
      • Release Notes 23.5 Release - Mindbreeze InSpire
      • Release Notes 23.6 Release - Mindbreeze InSpire
    • Security
      • Known Vulnerablities
    • Product Information
      • Product Information - Mindbreeze InSpire - Standby
      • Product Information - Mindbreeze InSpire
    Home

    Path

    Sure, you can handle it. But should you?
    Let our experts manage the tech maintenance while you focus on your business.
    See Consulting Packages

    Notifications

    Installation and Configuration

    Copyright ©

    Mindbreeze GmbH, A-4020 Linz, 2023.

    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.

    IntroductionPermanent link for this heading

    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.

    PreparationPermanent link for this heading

    Create a database for notificationsPermanent link for this heading

    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;

    ConfigurationPermanent link for this heading

    In the "Client Services" tab, configure the "Alerting Service Settings" and the "Resource Persistence Settings".

    Notification service settingsPermanent link for this heading

    Enable

    Enables alerts –default: true

    Allow Email subscriptions

    Unavailable in the default Insight 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

    Notification Schedule

    A extended cron expression that specifies when to run this task.

    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 * ? *

    Documentation and another examples of cron expressions can be found here.

    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 alert emails

    Specifies the e-mail address from which the e-mails will be sent.

    Dedicated Alerting Principal Resolution ServicePermanent link for this heading

    By default, the notification service uses the search and therefore also the configured Caching Principal Resolution Services of the data sources.

    For extended use cases, additional Caching Principal Resolution Services can be configured in the client service. This is configured in the section "Alerting Principal Resolution Plugins". Additionally a Custom Plugin Property "MES_SERVICE_CONTEXT" with value "mindbreeze.service.NotificationService" must be added (Advanced Settings). These services are called first before the search is performed on the individual data sources.

    The following options are also available in "Alert Service Settings":

    Principal Resolution Timeout

    Defines how long (in seconds) to wait for the response from a Caching Principal Resolution Services. If a timeout or other error occurs, no notification is sent out

    Disable Alerts for Principal Pattern

    With this option, notifications can be dynamically disabled for certain users. This is done depending on the user's current principals (which are determined by the Alerting Principal Resolution plugins). With this option, a regular expression (Java, case-insensitive) can be defined. If a principal matches the regular expression, the alerting for the user is disabled.

    Use Principal Email Address

    When active, the receiver e-mail address for the notification is selected using the configured Caching Principal Resolution Services. Which principal is selected as the e-mail address can be determined using the “Principal Email Address Prefix” option.

    Principal Email Address Prefix

    The principal that starts with the prefix configured here is used as the email address if the "Use Principal Email Address" option is enabled. Example: The user max.mustermann additionally has the Principal "email=max.mustermann@example.com" via a Principal Resolution Service. So, if "email=" is configured as prefix here, "max.mustermann@example.com" will be selected as receiver email address when sending the notification.

    Automatic setting of the email address based on the identityPermanent link for this heading

    When a user sets up a notification for the first time, the user can specify an e-mail address to which the notifications will be sent.

    Under certain conditions, the e-mail address can be set or corrected automatically. In the client service, a user login via Trusted Peer must be used. The e-mail address must be available as user attribute. (See Trusted Peer Authentication documentation)

    Options:

    Use Email Address from Identity

    If active, when creating the user, the user's e-mail address is used from the user attribute provided by the trusted peer login (default value: not active)

    Email Address Identity Property

    Name of the user attribute used for the e-mail address. (default value: mail)

    Resource Persistence SettingsPermanent link for this heading

    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 Permanent link for this heading

    User AdministrationPermanent link for this heading

    If the notifications are enabled and set correctly, a new entry "Users" is displayed under "Insight 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 AdministrationPermanent link for this heading

    If the notifications are enabled and set correctly, a new entry "Alerts" is displayed under "Insight 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 ClientPermanent link for this heading

    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”.

    Download PDF

    • Configuration - Notifications

    Content

    • Introduction
    • Preparation
    • Configuration
    • User interface

    Download PDF

    • Configuration - Notifications