Notification configuration parameters

When a user is subscribed to a document, any change in the document will be notified by email. These email messages are created using some defined templates, and these default templates to create messages can be adapted to your style.

Field / Property	Type	Description
send.mail.from.user	Boolean	By default, the application sends mail notifications setting the from mail field value as the user mail address. When this parameter is disabled, it will use the default from mail address for all the emails sent by the application ( all emails sent by the application will have the same from mail address ). When the mail server have restricted from changing the default from the mail field ( for example, when it is not allowed to use the general@mail.com account to send a mail with from mail field value user@mail.com, usually this kind of mail server configuration is set to prevent spam), then this parameter must be designated as "false." true
notification. message.subject	Text	The subject of the message sent when a user has chosen to notify something other. OpenKM - NOTIFICATION
notification.message.body	HTML	Body of the message sent when a user has chosen to notify something other. ReplaceMessage: ${notificationMessage} User: ${userId} <#list documentList as doc>Document: ${doc.path} </#list>
subscription. message.subject	Text	Subject of the message sent automatically caused by some event. That happens because the user is subscribed to some node. OpenKM - ${eventType} - ${documentPath}
subscription.message.body	HTML	Body of the message sent automatically caused by some event. That happens because the user is subscribed to some node. Date: ${eventDate?string("yyyy-MM-dd HH:mm:ss")} Document: ${documentPath} User: ${userId} Event: ${eventType} Comment: ${subscriptionComment}
task.message.subject	Text	The message's subject is sent when there's some change in the task assigned to a user. OpenKM - Task Manager Notification: ${message}
task.message.body	HTML	Body of the message sent when there's some change on the task assigned to a user. Task: ${tasksubject} Start: ${taskstart!} End: ${taskend!} Project: ${taskproject!} Status: ${taskstatus!} Note: ${tasknote!}
notify. Twitter.status	Text	This is the text used in the notification Twitter message. OpenKM - ${documentUrl} - ${documentPath} - ${userId} - ${eventType} Edit Delete
notify.twitter.user	String	Twitter account username.
Notify.twitter.password	String	Twitter account password.
Download.message.body	HTML	Body of the message sent when a user shares some document with others for downloading. Your archive is ready. Please download from ${url}
download.message.subject	String	The message's subject is sent when a user shares some document with others for downloading. OpenKM - DOWNLOAD
download. token.validity	Integer	Range of days while the download url will be available. 7
template.message.body	String	Set the basic template for all notifications. <div style="margin: 0; padding: 0; width: 100%; min-height: 100%;"> <table style="height: 100%; width: 100%;" border="0" cellspacing="0" cellpadding="0"> <tbody> <tr> <td style="background: #e5e5e5;" valign="top"> <table style="margin: 20px auto 0 auto; width: 600px;" border="0" width="100%" cellspacing="0" cellpadding="0" align="center"> <tbody> <tr style="background: #e5e5e5;"> <td valign="top"> <div style="background: #fff;"> <table width="100%" cellspacing="0" cellpadding="0"> <tbody> <tr> <td> <table width="100%" cellspacing="0" cellpadding="0"> <tbody> <tr> <td bgcolor="#018ca9" width="100%" height="6px"> </td> </tr> </tbody> </table> </td> </tr> <tr> <td> <div style="border-top: solid 1px #88888b; min-height: 5px; max-height: 10px; width: 100%;"> </div> </td> </tr> <tr> <td style="padding: 0 10px 10px 10px;"> <div> <p>${body}</p> </div> </td> </tr> </tbody> </table> </div> </td> </tr> <tr> <td style="background: #88888b;"> <table style="width: 100%;" border="0" cellspacing="0" cellpadding="0"> <tbody> <tr> <td height="4"> </td> </tr> </tbody> </table> </td> </tr> <tr> <td style="background: #222222; padding: 10px 20px;"> <table style="width: 100%;" border="0" cellspacing="5" cellpadding="0"> <tbody> <tr> <td> <h3 style="color: #f6a81a; font: 18px verdana, arial, sans-serif; margin: 0; padding: 0;">OpenKM Knowledge Management</h3> </td> </tr> </tbody> </table> </td> </tr> </tbody> </table> </td> </tr> </tbody> </table> </div>
notification. url	String	The notification URL parameter is the template URL that OpenKM uses for building the direct access URL to the OpenKM nodes (documents, folders, emails, records ). Classic user interface: http://localhost:8080/openkm/index KCenter user interface: http://localhost:8080/openkm/kcenter/#

Substitutions

For notification.message.body property:

${documentUrl} shows the node URL.
${documentPath} shows the node path.
${documentName} shows the node name.
${userName} display the user name who caused the event.
${userId} shows the user id who caused the action.
${notificationMessage} show the notification message

For task. news.body property:

${tasksubject} shows the subject of the study.
${taskstart} shows when the job started.
${taskend} showed when the task ended.
${taskproject} the task project.
${taskstatus} indicate the status of the task.
${tasknote} show the notes.

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

More information at:

java.text.MessageFormat

Table of contents [ Hide Show ]

Substitutions

OpenKM 7.1

Notification configuration parameters

Substitutions