3.6 Customizing e-mail notifications

Abstract

ShowTable of Contents

HideTable of Contents

1 Modifying the default templates
2 Creating custom templates
3 Changing the text strings
4 Customizing the images
5 Related Links

Previous

IBM Connections provides the capability to send out daily and weekly email digests to highlight newly added content. You can customize these email digests by modifying the default templates.

The content of these digest email are formatted using templates based on the FreeMarker engine. IBM Connections 3.0.1 uses FreeMarker Version 2.3.15. For the detailed information about the FreeMarker template engine, see the following web page: http://freemarker.sourceforge.net/docs/index.html

The following is a sample daily newsletter template.

<#import "aggregated/style.ftl" as s>

<#import "aggregated/util.ftl" as u>

<#compress>

<@s.document "${u.resource('NEWSLETTER_TITLE_DAILY', '${emailDigestBean.end?date}')}">

    <@s.newsLetterDiv>

            <@s.digestHeader emailDigestBean "${'daily'}">

            </@s.digestHeader>

            <#-- Putting qresponses as the first item -->

            <#if (emailDigestBean.storiesStats["responses"]?? && emailDigestBean.storiesStats["responses"] > 0)>

                <@s.digestSection emailDigestBean.stories["responses"] "responses" emailDigestBean.storiesStats["responses"] >

                </@s.digestSection>

            </#if>

            <#-- Now everything else -->

            <#list emailDigestBean.stories?keys as storyCategory>

                <#if storyCategory != 'responses'>

                    <@s.digestSection emailDigestBean.stories[storyCategory] storyCategory emailDigestBean.storiesStats[storyCategory] >

                    </@s.digestSection>

                </#if>

            </#list>

            <@s.digestFooter>

            </@s.digestFooter>

    </@s.newsLetterDiv>

</@s.document>

</#compress>

Modifying the default templates

Use the following procedure to modify the default templates:

1. Use a text editor to modify the the dailyDigest.ftl and weeklyDigest.ftl template files from the following location:
\profiles\\config\cells\\LotusConnections-config\news\email
where is the WebSphere Application Server installation directory and is the Deployment Manager profile directory, typically dmgr01.
2. Save the file changes.
3. Synchronize all the nodes using the WebSphere Integrated Solutions Console.
4. Stop and restart the News application.

Creating custom templates

Use the following procedure to create custom templates:
1. Either create a new FreeMarker template file or copy and existing file into the following directory:
\profiles\\config/cells\\LotusConnections-config\news\email
2. Use the following steps to register the custom templates in the notification-config.xml file:

1.4 Publishing customizations with the wsadmin tool

<type name="dailyDigest" notificationType="FOLLOW">

  <channel name="email" enabled="true">

    <property name="sender">news_admin@emea.relay.example.com</property>

    <property name="ftl">{notification.source.url}/news/email/dailyDigest.ftl</property>

    <property name="bundlePath">{notification.source.url}/news/email/</property>

    <property name="bundleName">notification</property>

  </channel>

</type>

<type name="weeklyDigest" notificationType="FOLLOW">

  <channel enabled="true" name="email">

    <property name="sender">news-admin@emea.relay.example.com</property>

    <property name="ftl">{notification.source.url}/news/email/weeklyDigest.ftl</property>

    <property name="bundlePath">{notification.source.url}/news/email/</property>

    <property name="bundleName">notification</property>

  </channel>

</type>

Changing the text strings

To change the text strings used in the email digests, perform the following steps:
1. Using a text editor, modify the notification_.properties files in the following directory:
\profiles\\config\cells\\LotusConnections-config\news\email
Where: is the locale of the language. For example, notification_fr.properties.
2. Save your changes and then close the files.
3. Synchronize all the nodes using the WebSphere Integrated Solutions Console.
4. Stop and restart the News application.

Customizing the images

To customize the images used in the email digests, perform the following steps:
1. Locate the images in the following directory:
\profiles\\config\cells\\LotusConnections-config\news\email\images
2. Replace any image that you want to customize with your own version using the same file name.
Note that the images are sent as MIME attachments in each email digest, so ensure that the image size is small.
3. Synchronize all the nodes using the Integrated Solutions Console.
4. Stop and restart the News application.

Version ComparisonCompare version with version
	Version	Date	Changed by	Summary of changes
	This version (1)	Nov 21, 2011 11:14:02 AM	Amanda J Bauman

3.6 Customizing e-mail notifications

Modifying the default templates

Creating custom templates

Changing the text strings

Customizing the images

Related Links