3.11. Subscribing to notifications of document changes

Warning

You are looking at documentation for an older release. Not what you want? See the current release documentation.

The function Watch document in Sites Explorer allows users to receive notification by email when a document is updated. The email address of receivers is the email they declare in their profile. Administrators can customize the sender, subject, mimetype and content of the notification.

Note

To get the email notification feature work, you first need to configure Outgoing mail service first.

To customize the email notification, simply add the following properties in exo.properties file.

Email content for WatchDocumentService

exo.ecms.watchdocument.subject=Your watching document is changed
exo.ecms.watchdocument.mimetype=text/html
exo.ecms.watchdocument.content=Dear $user_name,<br><br>The document $doc_name ($doc_title) has changed.<br><br>Please go to <a href="$doc_url">$doc_title</a> to see this change.<br><br>

In which:

PropertyDefault valueDescription
exo.ecms.watchdocument.subjectYour watching document is changedThe subject of the email notification.
exo.ecms.watchdocument.mimetypetext/htmlThe format of the email content. There are two types: text/html and text/plain.
exo.ecms.watchdocument.contentDear $user_name,<br><br>The document $doc_name ($doc_title) has changed.<br><br>Please go to <a href="$doc_url">$doc_title</a> to see this change.<br><br>The content of the email notification.

You can use four parameters below in the exo.ecms.watchdocument.content property:

See also

Copyright ©. All rights reserved. eXo Platform SAS
blog comments powered byDisqus