• Email Configuration from scratch.

  • OpenKM has many interesting features, but requires some configuration process to show its full potential.
OpenKM has many interesting features, but requires some configuration process to show its full potential.
Forum rules: Please, before asking something see the documentation wiki or use the search feature of the forum. And remember we don't have a crystal ball or mental readers, so if you post about an issue tell us which OpenKM are you using and also the browser and operating system version. For more info read How to Report Bugs Effectively.
 #3563  by virii
 
Hi,

Can any one help me out in configuring email notification from scratch?
I want to receive an email when any file is added/deleted/modified etc. Currently I just want to do it on test basis, so I just want to receive a notification email at my email when some some action is performed on OpemKM.

Please help out with this basic configuration. Where can i find proper manual of using OpenKM?

Cooperation will be appreciated.

Virii
 #3567  by jllort
 
Refer to faq section on this web, there's the way to configure it.
 #3574  by virii
 
Dear Jllort,

I could not find help regarding this in forum, even a guy posted : " Mail Notification configuration / reporting ", but no one replied to him.
I need GUI based way to configure email notifications. Can you please help me out here, i will be very thankful for this.

Waiting for Urgent response.
 #3576  by jllort
 
There's no GUI based way to configure it, I'll attach the FAQ refence for it:
Code: Select all
By default, mail notification is not enabled on OpenKM. It must be configured with parameters:

For versions older than OpenKM 3.0 you must create some properties file:

In $JBOSS_HOME/server/default/conf, there must be a file called emails.properties with user mail information like this:

user1=user1@mail.com
....
 
Setting the mail server on JBoss:

$JBOSS_HOME/server/default/deploy must have a file called mail-service.xml ( your SMTP mail server configuration goes here ). (Note: you have to change this sample values to meet your server settings.)

<!-- OpenKM -->
<mbean code="org.jboss.mail.MailService" name="jboss:service=mail/OpenKM">
<attribute name="JNDIName">java:/mail/OpenKM</attribute>
<attribute name="User">user</attribute>
<attribute name="Password">password</attribute>
<attribute name="Configuration">
<configuration>
<property name="mail.transport.protocol" value="smtp"/>
<property name="mail.smtp.host" value="host.com"/>
<property name="mail.smtp.auth" value="true"/>
<property name="mail.from" value="noreply@host.com"/>
<property name="mail.debug" value="false"/>
</configuration>
<depends>jboss:service=Naming</depends>
</attribute>
</mbean>

Enabling mailing service:

Your server URL must be inserted at OpenKM.cfg

application.url=http://your_host:8080/OpenKM/es.git.openkm.frontend.Main/index.jsp

YOU MUST RESTART THE OPENKM SERVICE AFTER CHANGING OPENKM.CFG
And this one to set notification configuration
Code: Select all
you can configure these text using two properties in the OpenKM.cfg file. Default values are shown below:

subscription.message.subject=OpenKM - {0} - {1};
subscription.message.body=<b>Document: </b><a href=\"{0}\">{1}</a><br/><b>User: </b>{3}<br/><b>Event: </b>{4}<br/>

And these are the substitution variables used:

SUBSCRIPTION SUBJECT
{0} - event type
{1} - document path
{2} - document name

SUBSCRIPTION BODY
{0} - document url
{1} - document path
{2} - document name
{3} - user id
{4} - event type
{5} - comment

notify.message.subject=OpenKM - NOTIFICATION - {0}
notify.message.body=<b>Document: </b><a href=\"{0}\">{1}</a><br/><b>User: </b>{3}<br/><b>Message: </b>{4}<br/>

And these are the substitution variables used:

NOTIFY SUBJECT
{0} - document path
{2} - document name
NOTIFY BODY
{0} - document url
{1} - document path
{2} - document name
{3} - user id
{4} - message
There's nothing else, with it you might configure and customize OpenKM mail service.
 #3586  by virii
 
Hi Jllort,

I have OpenKM 4.0 and did not find email.properties file in it..????? Is there any other method for doing this? (Email Configuration and Notifications)

Regards,
 #3594  by jllort
 
Email and users are in embeded database - the default openkm configuration - autheticate as okmAdmin and go to administration tools to add users and set there the user mail.

Any user in menu -> Tools / Preferences / User configuration can change their own values ( mail )
 #3625  by virii
 
This method is configure email address, but how to configure Notification when some File is added/deleted/modified etc...
 #3626  by jllort
 
OK, you're talking about subscription, you can subscribe to document or folder, you've got a button in tool bar for it. When you're subcribed to a folder any change in any document into folder or subfolders it'll be notified to you by mail. Is that ?
 #3632  by jllort
 
Something is wrong in your mail configuration. Set debug mode on to see what happens, sometimes mail could be detected as spam by your server depending how you've configured mail service in mail-service.xml

Remember to un comment in OpenKM:cfg the line
Code: Select all
 # application.url=your host url
and restart jboss server to take it effects.

About Us

OpenKM is part of the management software. A management software is a program that facilitates the accomplishment of administrative tasks. OpenKM is a document management system that allows you to manage business content and workflow in a more efficient way. Document managers guarantee data protection by establishing information security for business content.