Skip to content
Other versions

Loading…

Notification configuration parameters

When a user is subscribed to a document, any change to the document will be notified by email. These email messages are created using defined templates, and these default templates 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 to the user’s email address. When this parameter is disabled, it will use the default from mail address for all emails sent by the application (all emails sent by the application will have the same from mail address).
When the mail server restricts 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 a from mail field value of 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 about something else.
OpenKM - NOTIFICATION
notification.message.body HTML Body of the message sent when a user has chosen to notify about something else.
ReplaceMessage: ${notificationMessage}
User: ${userId}
<#list documentList as doc>Document: ${doc.path}
</#list>
subscription. message.subject Text Subject of the message sent automatically as a result of some event. This happens because the user is subscribed to a node.
OpenKM - ${eventType} - ${documentPath}
subscription.message.body HTML Body of the message sent automatically as a result of some event. This happens because the user is subscribed to a 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 in 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 Twitter notification 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 a document with others for download.
Your archive is ready. Please download it from ${url}
download.message.subject String The message’s subject is sent when a user shares a document with others for download.
OpenKM - DOWNLOAD
download. token.validity Integer Number of days during which the download URL will be available.
7
template.message.body String Set the basic template for all notifications.
<br><div style="margin: 0; padding: 0; width: 100%; min-height: 100%;"><br><table style="height: 100%; width: 100%;" border="0" cellspacing="0" cellpadding="0"><br><tbody><br><tr><br><td style="background: #e5e5e5;" valign="top"><br><table style="margin: 20px auto 0 auto; width: 600px;" border="0" width="100%" cellspacing="0" cellpadding="0" align="center"><br><tbody><br><tr style="background: #e5e5e5;"><br><td valign="top"><br><div style="background: #fff;"><br><table width="100%" cellspacing="0" cellpadding="0"><br><tbody><br><tr><br><td><br><table width="100%" cellspacing="0" cellpadding="0"><br><tbody><br><tr><br><td bgcolor="#018ca9" width="100%" height="6px">&nbsp;</td><br></tr><br></tbody><br></table><br></td><br></tr><br><tr><br><td><br><div style="border-top: solid 1px #88888b; min-height: 5px; max-height: 10px; width: 100%;">&nbsp;</div><br></td><br></tr><br><tr><br><td style="padding: 0 10px 10px 10px;"><br><div><br><p>${body}</p><br></div><br></td><br></tr><br></tbody><br></table><br></div><br></td><br></tr><br><tr><br><td style="background: #88888b;"><br><table style="width: 100%;" border="0" cellspacing="0" cellpadding="0"><br><tbody><br><tr><br><td height="4">&nbsp;</td><br></tr><br></tbody><br></table><br></td><br></tr><br><tr><br><td style="background: #222222; padding: 10px 20px;"><br><table style="width: 100%;" border="0" cellspacing="5" cellpadding="0"><br><tbody><br><tr><br><td><br><h3 style="color: #f6a81a; font: 18px verdana, arial, sans-serif; margin: 0; padding: 0;">OpenKM Knowledge Management</h3><br></td><br></tr><br></tbody><br></table><br></td><br></tr><br></tbody><br></table><br></td><br></tr><br></tbody><br></table><br></div><br>
notification. url String The notification URL parameter is the template URL that OpenKM uses to build the direct access URL to OpenKM nodes (documents, folders, emails, records).
Classic user interface:
http://localhost:8080/openkm/index
KCenter user interface:
http://localhost:8080/openkm/kcenter/#

Substitutions

Section titled “Substitutions”

For notification.message.body property:

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

For task. news.body property:

  • ${tasksubject} shows the subject of the task.
  • ${taskstart} shows when the task started.
  • ${taskend} shows when the task ended.
  • ${taskproject} shows the task project.
  • ${taskstatus} indicates the status of the task.
  • ${tasknote} shows the notes.