2.2.3.16. Watch Document

The WatchDocumentService component allows users to watch/unwatch a document. If they are watching the document, they will receive a notification mail when there are any changes on the document. The configuration of this component is found in /core/core-configuration/src/main/webapp/WEB-INF/conf/wcm-core/core-services-configuration.xml.


<external-component-plugins>
    <target-component>org.exoplatform.services.cms.watch.WatchDocumentService</target-component>
    <component-plugin>
      <name>watching document notification email contents setting</name>
      <set-method>initializeMessageConfig</set-method>
      <type>org.exoplatform.services.cms.watch.impl.MessageConfigPlugin</type>
      <description>Initialize the settings for watching document notification email contents</description>
      <init-params>
        <object-param>
          <name>messageConfig</name>
          <description>Message Configuration</description>
          <object type="org.exoplatform.services.cms.watch.impl.MessageConfig">
            <field name="sender"><string>${gatein.ecms.watchdocument.sender:support@exoplatform.com}</string></field>
            <field name="subject"><string>${gatein.ecms.watchdocument.subject:Your watching document is changed}</string></field>
            <field name="mimeType"><string>${gatein.ecms.watchdocument.mimetype:text/html}</string></field>
            <field name="content">
              <string>${gatein.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 /></string>
            </field>
          </object>
        </object-param>
      </init-params>
    </component-plugin>
  </external-component-plugins>

Details:

Field Type Value Description
sender string ${gatein.ecms.watchdocument.sender:support@exoplatform.com} The sender who sends the notification mail.
subject string ${gatein.ecms.watchdocument.subject:Your watching document is changed}. The subject of the notification mail.
mimeType string ${gatein.ecms.watchdocument.mimetype:text/html}. The format of the notification mail.
content string ${gatein.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 />. The content of the notification mail.
Copyright ©. All rights reserved. eXo Platform SAS
blog comments powered byDisqus