Skip to main content link. Accesskey S
  • Anonymous
  • Log on
  • Help
  • IBM logo
  • IBM Connections wiki
  • All Wikis
  • Home
  • Community Articles
  • Product Documentation
  • Learning Center


Search

Advanced Search

Categories

Tag Cloud

  • 1.0
  • 1.0.x
  • 2.0
  • 2.0.1
  • 2.0.1.1
  • 2.0_media
  • 2.5
  • 2.5_deployment
  • 2.5_media
  • 2.5_performance
  • 3
  • 3.0
  • 3.0.1
  • 3.0.1_media
  • 3.0_media
  • 3_deployment
  • 8.1.1
  • 8.2
  • activities
  • administrators
  • api
  • best_practices
  • blogs
  • bookmarks
  • business_card
  • cluster
  • communities
  • community
  • community_manager
  • connections
  • connections_3
  • connections_301
  • customization
  • customize
  • customizing
  • demos
  • deploying
  • deployment
  • deployments
  • developers
  • dogear
  • Domino
  • Edge server
  • education
  • error messages
  • files
  • forums
  • getting_started
  • Help
  • home
  • home_page
  • homepage
  • how-to
  • HTTP server
  • ibm
  • index
  • installation
  • integration
  • iOS
  • ipad
  • iWidget
  • J2EE
  • javadoc
  • lc3.0
  • learning
  • lotus-connections
  • mml
  • mobile
  • Notes
  • performance
  • person_card
  • Portal
  • portlet
  • portlet_factory
  • profiles
  • proxy server
  • quickr
  • Redbooks
  • rest
  • reverse proxy server
  • Sametime
  • scenarios
  • search
  • security
  • self-paced
  • SSO
  • tags
  • test_infrastructure
  • troubleshooting
  • tuning
  • video
  • VideoFest
  • videos
  • WAI
  • WAS
  • web_seminar
  • WebAppIntegrator
  • WebSphere
  • widgets
  • wikis
InformationInformation
You are currently viewing machine translated content. IBM translation might be available. Click IBM Translated Product Documentation to see what is available.X


Home > IBM Redbooks: Customizing IBM Connections 3.0.1 > 3.6 Customizing e-mail notifications
Rate this article 1 starRate this article 2 starsRate this article 3 starsRate this article 4 starsRate this article 5 stars

3.6 Customizing e-mail notifications 

expanded Abstract
collapsed Abstract
No abstract provided.
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:
    a. Setup the command line environment for using the IBM Connections master configuration file using 1.4 Publishing customizations with the wsadmin tool
    b. Use the LCConfigService.checkOutNotificationConfig("<temp_dir>","<cell_name>") command to checkout the notification configuration file.
    c. Modify the notification-config.xml file using a text editor from the temporary directory.
    d. Find the section of code specific to the template to be changed. Then replace the value of the ftl property for each digest type with the file name of the new template:


    <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>

    e. Save and close the notification-config.xml file.
    f. Check the configuration files back in using the following command: LCConfigService.checkInNotificationConfig("<temp_dir>","<cell-name>")
    g. Synchronize all the nodes using the WebSphere Integrated Solutions Console.
    h. Stop and restart all the IBM Connections application servers.
     

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.

            

Related Links


  IBM Connections Email Digest Specification: http://www-10.lotus.com/ldd/lcwiki.nsf/dx/IBM_Connections_3.0.1_Email_Digest
  FreeMarker Manual: http://freemarker.sourceforge.net/docs/index.html

Parent topic: 3.0 Customizing the Home page

expanded Article information
collapsed Article information
Category:
IBM Redbooks: Customizing IBM Connections 3.0.1
Tags:
Redbooks

This Version: Version 1 November 21, 2011 11:14:02 AM by Amanda J Bauman  IBMer

expanded Attachments (0)
collapsed Attachments (0)

 


expanded Versions (1)
collapsed Versions (1)
Version Comparison     
Version Date Changed by               Summary of changes
This version (1) Nov 21, 2011 11:14:02 AM Amanda J Bauman  
expanded Comments (0)
collapsed Comments (0)
Copy and paste this wiki markup to link to this article from another article in this wiki.
Go ElsewhereStay ConnectedSubscribe to RSSHelpAbout
  • All Lotus and WebSphere Portal wikis
  • IBM developerWorks
  • IBM Software support
  • IBM Social Business User Experience Blog
  • IBMSocialBizUX on Twitter
  • IBMSocialBizUX on Facebook
  • Lotus product forums
  • IBM Social Business UX blog
  • IBM Collaboration Solutions
  • Recently added feedRecently added
  • Recently edited feedRecently edited
  • Recently added comments feedRecently Added Comments
  • Wiki Help
  • Forgot user name/password
  • Wiki design feedback
  • Content feedback
  • About the wiki
  • About IBM
  • Privacy
  • Contact IBM
  • IBM Terms of use
  • Wiki terms of use