- \n
- The extension requires Platform 4.1.x. I\u2019ve already tested it on Platform 4.1-M1 and 4.1-M2.<\/li>\n
- This tutorial involves developing your own extension, so it is good if you understand eXo Platform Extensions<\/a>.<\/li>\n<\/ul>\n
Creating your extension project<\/h3>\n
Creating your extension called custom-notification-extension<\/span> requires two packages:<\/p>\n
![\"01-package-details\"](\"\/blog\/wp-content\/uploads\/2014\/07\/01-package-details.png\")
<\/a><\/p>\ncustom-notification-config.jar<\/span> is where you declare the extension webapp as a dependency of the portal container. This means that under custom-notification-extension.jar<\/span> you need to create \/conf\/configuration.xml<\/span> with the following content:<\/p>\n
<object-param>\n\t<name>addDependencies<\/name>\n\t<object type=\"org.exoplatform.container.definition.PortalContainerDefinitionChange$AddDependencies\">\n <!-- The name of the portal container -->\n\t\t<field name=\"dependencies\">\n\t\t\t<collection type=\"java.util.ArrayList\">\n\t\t\t\t<value>\n\t\t\t\t\t<string>custom-notification-extension<\/string>\n\t\t\t\t<\/value>\n\t\t\t<\/collection>\n\t\t<\/field>\n\t<\/object>\n<\/object-param><\/pre>\n
custom-notification-extension.war<\/span> contains resources and configurations. The webapps are loaded in the order defined in the list of dependencies in the PortalContainerDefinition<\/span>.<\/p>\n
In \/conf\/configuration.xml<\/span> you need to register two external component plugins<\/i>:<\/p>\n
<external-component-plugins>\n\t<target-component>org.exoplatform.social.core.manager.ActivityManager<\/target-component>\n\t<component-plugin>\n\t\t<name>ActivityNotificationImpl<\/name>\n\t\t<set-method>addActivityEventListener<\/set-method>\n\t\t<type>org.exoplatform.custom.notification.impl.ActivityNotificationImpl<\/type>\n\t<\/component-plugin>\n<\/external-component-plugins><\/pre>\n
* When an activity is created (this event is addActivityEventListener<\/span>) then org.exoplatform.custom.notification.impl.ActivityNotificationImpl<\/span> will be triggered. In this class, we will implement sending an email notification (see the details in the next section):<\/p>\n
<external-component-plugins>\n\t<target-component>org.exoplatform.commons.api.notification.service.setting.PluginContainer<\/target-component>\n\t<component-plugin>\n\t\t<name>notification.plugins<\/name>\n\t\t<set-method>add<\/set-method>\n\t\t<type>org.exoplatform.custom.notification.plugin.ActivityConnectionPlugin<\/type>\n\t\t<description>Initial information for plugin.<\/description>\n\t\t<init-params>\n\t\t\t<object-param>\n\t\t\t\t<name>template.ActivityConnectionPlugin<\/name>\n\t\t\t\t<description>The template of ActivityConnectionPlugin<\/description>\n\t\t\t\t<object type=\"org.exoplatform.commons.api.notification.plugin.config.PluginConfig\">\n\t\t\t\t\t<field name=\"pluginId\">\n\t\t\t\t\t\t<string>ActivityConnectionPlugin<\/string>\n\t\t\t\t\t<\/field>\n\t\t\t\t\t<field name=\"resourceBundleKey\">\n\t\t\t\t\t\t<string>UINotification.label.ActivityConnectionPlugin<\/string>\n\t\t\t\t\t<\/field>\n\t\t\t\t\t<field name=\"order\">\n\t\t\t\t\t\t<string>5<\/string>\n\t\t\t\t\t<\/field>\n\t\t\t\t\t<field name=\"defaultConfig\">\n\t\t\t\t\t\t<collection type=\"java.util.ArrayList\">\n\t\t\t\t\t\t\t<value><string>Instantly<\/string><\/value>\n\t\t\t\t\t\t\t<!--value><string>Daily<\/string><\/value\u2192\n\t\t\t\t\t\t\t<!--value><string>Weekly<\/string><\/value-->\n\t\t\t\t\t\t<\/collection>\n\t\t\t\t\t<\/field>\n\t\t\t\t\t<field name=\"groupId\">\n\t\t\t\t\t\t<string>connections<\/string>\n\t\t\t\t\t<\/field>\n\t\t\t\t\t<field name=\"templateConfig\">\n\t\t\t\t\t\t<object type=\"org.exoplatform.commons.api.notification.plugin.config.TemplateConfig\">\n\t\t\t\t\t\t\t<field name=\"bundlePath\">\n\t\t\t\t\t\t\t\t<string>locale.notification.template.Notification<\/string>\n\t\t\t\t\t\t\t<\/field>\n\t\t\t\t\t\t\t<field name=\"templatePath\">\n\t\t\t\t\t\t\t\t<string>war:\/notification\/templates\/ActivityConnectionPlugin.gtmpl<\/string>\n\t\t\t\t\t\t\t<\/field>\n\t\t\t\t\t\t<\/object>\n \t\t\t<\/field>\n\t\t\t\t<\/object>\n\t\t\t<\/object-param>\n\t\t<\/init-params>\n\t<\/component-plugin>\n<\/external-component-plugins><\/pre>\n
* This configuration will register a plugin called ActivityConnectionPlugin<\/span> with some important parameters:<\/p>\n
- \n
- defaultConfig: Instantly<\/i> \u2013 sends email notifications right away; daily <\/i>and weekly <\/i>are used for digest emails.<\/li>\n
- groupId: general, connections, spaces, activity<\/i> \u2013 This is the group for your custom notification in Notification Settings (you could also create a new group).<\/li>\n
- templateConfig: bundlePath<\/i> \u2013 points to the resource bundle file and templatePath <\/i>is the template for the email notification\u2019s content.<\/li>\n<\/ul>\n
Implementing your own eXo social notification plugin<\/h3>\n
ActivityNotificationImpl.java<\/span> is extended from ActivityListenerPlugin.java<\/span>. In this class we override the saveActivity<\/i> method:<\/p>\n
public void saveActivity(ActivityLifeCycleEvent event) {\n\tExoSocialActivity activity = event.getSource(); \n\tNotificationContext ctx = NotificationContextImpl.cloneInstance().append(ACTIVITY, activity);\n\n\tctx.getNotificationExecutor().with(ctx.makeCommand(NotificationKey.key(ActivityConnectionPlugin.ID)))\n .execute(ctx);\n}<\/pre>\nThe main class you need to implement is ActivityConnectionPlugin<\/span>. This is extended from AbstractNotificationPlugin<\/i><\/a> <\/i>with some important methods:<\/p>\n
- \n
- 1. <\/i>makeNotification<\/i> creates a NotificationInfo<\/i> object, which is used to build a message for sending a notification instantly and store it in the database for building a digest message.<\/li>\n
- 2. <\/i>makeMessage<\/i> makes the MessageInfo<\/i> from the given NotificationInfo<\/i> that is kept inside NotificationContext<\/i>, which is sent immediately when a user is active.<\/li>\n
- 3. <\/i>makeDigest<\/i> makes the digest message from the given NotificationInfo<\/i> that is kept inside NotificationContext.<\/li>\n
- 4. <\/i>isValid<\/i> validates the conditions for sending an email notification. If it returns false<\/i> then a message is not sent.
\nFor this example, we make sure that if a poster posts on their activity stream then an email is sent. If they post on somebody else\u2019s activity stream or in a space, then an email is not sent.<\/li>\n<\/ul>\n* Edit email content<\/b><\/p>\n
custom-notification-extension\/webapp\/WEB-INF\/notification\/template\/ActivityConnectionPlugin.gtmpl<\/span><\/p>\n
* Edit resource bundle<\/b><\/p>\n
custom-notification-extension\/resources\/locale\/notification\/template\/Notification_en.properties<\/span><\/p>\n
If you want to add more languages, simply clone this file and change _en to a required language, then create a translation for it.<\/p>\n
You can download the source code here<\/a>.<\/p>\n
Deployment<\/p>\n
* Build a project using: mvn clean install<\/span><\/p>\n
* Copy the custom-notification-extension.war<\/span> file to the ${PLF_TOMCAT}\/webapps<\/span> directory.<\/p>\n
* Copy the custom-notification-config-xxx.jar<\/span> file to the ${PLF_TOMCAT}\/lib directory<\/span>.<\/p>\n
* Start your tomcat using: .\/start_eXo.sh<\/span><\/p>\n
Now in your Notification Settings you should see the new notification \u2018One of my connections has posted a message\u2019 under Connections.<\/p>\n
![\"02-notifications-settings\"](\"\/blog\/wp-content\/uploads\/2014\/07\/02-notifications-settings.png\")
<\/a><\/p>\nTest it to see whether you receive an email notification when one of your connections posts an activity on their activity stream. You should receive an email like this:<\/p>\n
![\"03-notification\"](\"\/blog\/wp-content\/uploads\/2014\/07\/03-notification.png\")
<\/a><\/p>\nCongratulations on your first simple customized social email notification! Now you can implement any customizations you might need.<\/p>\n
Going further<\/h2>\n
Of course, customizations can do more than this sample customized social notification. You can register any event to send email notifications, like user login, logout, posting to the wiki, uploading or creating documents, calendar events, tasks\u2026<\/p>\n
Just do it. If you have any questions, don\u2019t hesitate to post them on the Support Forums<\/a>.<\/p>\n
References<\/h2>\n
+ Email Notification Specification: https:\/\/community.exoplatform.com\/portal\/intranet\/wiki\/<\/a><\/p>\n
+ Managing Email Notifications: https:\/\/docs.exoplatform.org<\/a><\/p>\n
+ Creating your Extension Project: https:\/\/docs-old.exoplatform.org\/public\/index.jsp?topic=%2FPLF40%2FPLFDevGuide.eXoPlatformExtensions.CreatingExtensionProject.html<\/a><\/p>\n
- 2. <\/i>makeMessage<\/i> makes the MessageInfo<\/i> from the given NotificationInfo<\/i> that is kept inside NotificationContext<\/i>, which is sent immediately when a user is active.<\/li>\n
- groupId: general, connections, spaces, activity<\/i> \u2013 This is the group for your custom notification in Notification Settings (you could also create a new group).<\/li>\n
- defaultConfig: Instantly<\/i> \u2013 sends email notifications right away; daily <\/i>and weekly <\/i>are used for digest emails.<\/li>\n
![\"make-the-most-out-of-eXo-platform4\"](\"https:\/\/www.exoplatform.com\/blog\/wp-content\/uploads\/2014\/02\/how-to-make-the-most-of-eXo-platform41.png\")