community.egroupware.org: Community wiki

  
Community wiki
Notifications

Notifications


This document is intended to provide you information about the following topics:
  • What is notifications?
  • How to get notifications up and running in an existing eGW installation
  • How to get the winpopup/sms backends up and running
  • How to receive notifications on incoming mails

What is notifications ?

History
Notifications (or notifications-app) has nothing to do with the old notification-window. A long-term goal of notifications is to replace the notification-window. Notifications was originally introduced by Cornelius Weiss in eGW 1.4. Cornelius provided a new system, the notification-popup to notify the user about events directly with a builtin popup window. Cornelius also provided a well-concepted backend for notifications which was already able to have plugins for different styles of notifications.

For eGW 1.6. jaytraxx (that's me :-) extended this app to have so-called notification-chains which should notifications make able to 'chase' the user (in a good way) via the different backends. So the user can be notified on different channels depending on its state. I also introduced some more backends (e-mail, winpoup) and made notifications able to have prefs for users as well as for the admins. In that time, Aleksander Adamowski provided an additional sms backend.

Plans
At the moment I'm extending notifications again to have notifications on incoming e-mails. This feature is sponsored by a german company.


How to get notifications up and running in an existing eGW installation

First of all you have to check some prerequisites:
  • run eGWs setup
    • Header Admin Login
    • set 'Sessions Handler' to 'PHP session handler enabled in php.ini'
  • check your php.ini to have 'session.save_handler' to 'files' then
  • check your php installation to not have any php 'hardeners' (that will encrypt your session files) enabled, eGW cannot manage encrypted session files this time

Then install the notifications application:
  • run eGWs setup
    • Setup/Admin Login
    • Manage applications
    • check notifications for installation
    • Save

These are the minimum requirements for notifications. Without further configuration all your users will be notified via the default e-mail backend. If you want more sophisticated notifications, go ahead with the following configuration.

Grant your users access to the app:
  • Login into eGW as admin
    • Choose the "admin" app
    • Choose "User accounts" or "User groups" to grant access to notifications

Configure the admin prefs:
  • Login into eGW as admin
    • Choose the "admin" app
    • Go to notifications -> Site configuration
    • Enable the backends that the users should be able to choose in their own prefs and disable the not used backends (by default just the eGroupWare-Popup backend is enabled). Remember that the following backends (for security issues) have to be manually configured in the backend code before being used (this should be changed some time)
      • Windows-Popup backend
      • SMS backend

Configure user default prefs (or let them choose their own preferences)
  • Login into eGW as admin
    • Go to Preferences -> Notifications -> Preferences and create some default or forced preferences

Now you're done installing/configuring notifications for eGroupWare.


How to get the winpopup/sms backends up and running
... will be provided as soon as possible ...


How to receive notifications on incoming mails
A new feature is the receiving of notify messages on fresh arrived mails. This feature is currently only available in /trunk from revision 26548 on. It simply can be enabled by a user preference in FMail:
  • Login to eGroupWare as user
    • Go to FMail
    • Choose Preferences in side menu
    • Check/uncheck the Folders in 'Notify when new mails arrive on these folders'

You are here