Skip to content
Other versions

Loading…

Notification configuration parameters

When a user is subscribed to a document, any change in the document will be notified to by email. These email messages are created using some defined templates. These default templates to create messages can be adapted to your own 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 mails sent by the application ( all mails sent by the application will have the same from mail address ).
When mail server have restricted to change the default from mail field ( for example when is not allowed to use 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 set as “false”.
true
notification.message.subject Text Subject of the message sent when a user has chosen notify something to other.
OpenKM - NOTIFICATION
notification.message.body HTML Body of the message sent when a user has chosen notify something to other.
Message: ${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 user is subscribed to some node.
Document: ${documentPath}

User: ${userId}
Event: ${eventType}

Comment: ${subscriptionComment}
proposed.subscription.message.subject Text Subject of the message sent when a user propose some node subscription to other.
OpenKM - PROPOSED SUBSCRIPTION
proposed.subscription.message.body HTML Body of the message sent when a user propose some node subscription to other.
Comment: ${proposedSubscriptionComment}

User: ${userId}

<#list documentList as doc>Document: ${doc.path}
</#list>
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.

Substitutions

Section titled “Substitutions”

For notification.message.body property:

  • ${documentUrl} or ${docUrl} shows the node URL..
  • ${documentPath} or ${docPath} shows the node path.
  • ${documentName} or ${docName} show the node name.
  • ${userId} show the user id who caused the action.
  • ${notificationMessage} show the notification message.

For subscription.message.body, proposed.subscription.message.body and notify.twitter.status properties:

  • ${documentUrl} or ${docUrl} show the node URL.
  • ${documentPath} or ${docPath} show the node path.
  • ${documentName} or ${docName} show the node name.
  • ${userId} show the user id who caused the event.
  • ${eventType} show the event type.
  • **${subscriptionComment}**show the subscription comment.