Difference between revisions of "Notification and subscription messages"

From OpenKM Documentation
Jump to: navigation, search
Line 25: Line 25:
 
! NOTIFY MESSAGE SUBJECT ! NOTIFY MESSAGE BODY
 
! NOTIFY MESSAGE SUBJECT ! NOTIFY MESSAGE BODY
 
|-
 
|-
−
|{0} - document path                       |     {0} - document URL
+
|{0} - document path || {0} - document URL
 
|-
 
|-
−
|{1} - document name                       |     {1} - document path
+
|{1} - document name || {1} - document path
 
|-
 
|-
−
                                          |     {2} - document name
+
                    || {2} - document name
 
|-
 
|-
−
                                          |     {3} - user id
+
                    || {3} - user id
 
|-
 
|-
−
                                          |     {4} - message
+
                    || {4} - message
 
|}
 
|}
  
Line 39: Line 39:
 
! SUBSCRIPTION MESSAGE SUBJECT ! SUBSCRIPTION MESSAGE BODY
 
! SUBSCRIPTION MESSAGE SUBJECT ! SUBSCRIPTION MESSAGE BODY
 
|-
 
|-
−
|{0} - event type                         |   {0} - document URL
+
|{0} - event type     || {0} - document URL
 
|-
 
|-
−
|{1} - document path                       |   {1} - document path
+
|{1} - document path || {1} - document path
 
|-
 
|-
−
|{2} - document name                       |   {2} - document name
+
|{2} - document name || {2} - document name
 
|-
 
|-
−
                                          |   {3} - user id
+
                      || {3} - user id
 
|-
 
|-
−
                                          |   {4} - event type
+
                      || {4} - event type
 
|}
 
|}
  

Revision as of 19:57, 25 January 2010

When you are subscribed to a document, any change in the document will be notified by email. These email messages are created using some defined templates. You can modify these default templates to create messages adapted to your company style. This modification is done editing the file OpenKM.cfg.


Nota clasica.png Be careful to set the property application.url or this OpenKM feature won't work.

These are the default values:

OpenKM - NOTIFICATION - {0}
Document: <a href="{0}">{1}</a> 
                      
User: {3}
Message:
                      {4}
OpenKM - {0} - {1}
Document: <a href="{0}">{1}</a> 
                            
User: {3}
Event:
                            {4}
Comment: {5}

And these are the substitution variables used:

NOTIFY MESSAGE SUBJECT ! NOTIFY MESSAGE BODY
{0} - document path {0} - document URL
{1} - document name {1} - document path
{2} - document name
{3} - user id
{4} - message
SUBSCRIPTION MESSAGE SUBJECT ! SUBSCRIPTION MESSAGE BODY
{0} - event type {0} - document URL
{1} - document path {1} - document path
{2} - document name {2} - document name
{3} - user id
{4} - event type

Take care of the OpenKM.cfg format: this is a Java properties file and has some limitations, for example, this file have to be coded in ISO-8859-1 format. Also single quotes (') should be protected with another single quote ().

More info on this can be found at:

Retrieved from "https://www.openkm.com/wiki/index.php?title=Notification_and_subscription_messages&oldid=765"