Difference between revisions of "Notification and subscription messages"

Revision as of 10:22, 14 February 2011

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.

In OpenKM 5.1 Velocity will be replaced by FreeMarker.

These are the default values:

And these are the substitution variables used:

Notification message subject & body

• ${documentUrl} - Document URL
• ${documentPath} - Document path
• ${documentName} - Document name
• ${userId} - User id
• ${notificationMessage} - Notification message

Subscription message subject & body & twitter

• ${documentUrl} - Document URL
• ${documentPath} - Document path
• ${documentName} - Document name
• ${userId} - User id
• ${eventType} - Event type
• ${subscriptionComment} - Subscription comment

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:

• http://java.sun.com/j2se/1.5.0/docs/api/java/text/MessageFormat.html
• http://www.w3schools.com/tags/ref_entities.asp

If you want to elaborate a more complex template, the limitations of Java Properties are a disadvantage. In this case you can set the subscription.message.subject property to a template filename (for example, ComplexSubcriptionSubject.ftl). The template file should have the .ftl extension and needs to be locate at $JBOSS_HOME directory.

FreeMarker does not allow you to render null values (will throw an exception). If you expect a value to be null you can also use the ! operator: ${content.title!}. This is the equivalent to ${content.title!}.

More info about FreeMarker templates at FreeMarker User Guide.

OpenKM 5.0.x

These are the default values:

And these are the substitution variables used:

Notification message subject & body

• $documentUrl - Document URL
• $documentPath - Document path
• $documentName - Document name
• $userId - User id
• $notificationMessage - Notification message

Subscription message subject & body & twitter

• $documentUrl - Document URL
• $documentPath - Document path
• $documentName - Document name
• $userId - User id
• $eventType - Event type
• $subscriptionComment - Subscription comment

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:

• http://java.sun.com/j2se/1.5.0/docs/api/java/text/MessageFormat.html
• http://www.w3schools.com/tags/ref_entities.asp

If you want to elaborate a more complex template, the limitations of Java Properties are a disadvantage. In this case you can set the subscription.message.subject property to a template filename (for example, ComplexSubcriptionSubject.vm). The template file should have the .vm extension and needs to be locate at $JBOSS_HOME directory.

More info about Velocity templates at Apache Velocity User Guide.

OpenKM 4.0 and older

These are the default values:

And these are the substitution variables used: