Customize Wikis notification templates 

You can customize Wikis notifications.


Before you begin

To edit configuration files, use the IBM WAS wsadmin client. See Starting the wsadmin client for information about how to start the wsadmin command-line tool.


About this task

Notification templates are programmed in FreeMarker template language and make use of variables, such as {notification.media.url}, that are populated by the server, as well as property files for inserting internationalized strings. A core style template allows the generation of both text/plain and text/html notifications and can be customized (along with individual templates) to change the style of the notification.


Procedure

  1. Start the wsadmin client.

  2. Access the Wikis configuration files using the following command:

      execfile("wikisAdmin.py")

      If you are asked to select a server, you can select any server.

  3. Check out the Wikis configuration files using the following command:

      WikisConfigService.checkOutConfig("<working_directory>", "<cell_name>", includeEmailTemplates = "true") where:

      • <working_directory> is the temporary working directory to which the configuration files are copied. The files are kept in this working directory while you make changes to them.

      • <cell_name> is the name of the WAS cell hosting the IBM Connections application. To obtain the cell name:

          print AdminControl.getCell()

      • includeEmailTemplates must be set to "true" to check out the notification templates along with the configuration files. This is set to "false" by default.

      For example:

      WikisConfigService.checkOutConfig("/opt/my_temp_dir", "CommServerNode01Cell", includeEmailTemplates = "true")

  4. Edit any of the following templates:
    Template Description
    commentAdded.ftl Notification sent to users when a comment is created on a wiki page they are following, or on any page in a wiki they are following.

    Users can follow wiki pages or wikis by opening a page and clicking Follow, and then Follow this Page or Follow this Wiki.

    mediaUpdated.ftl Notification sent to users when an event occurs in a wiki page or wiki they are following. Events include title or description edits, new tags, and new or deleted pages, edits or comments.

    Users can follow wiki pages or wikis by opening a page and clicking Follow, and then Follow this Page or Follow this Wiki.

    libraryMemberUpdated.ftl Notification sent to users when they are made a member of a wiki, or when their wiki access level is changed. This applies to individual users, not groups.
    style.ftl Style template that controls the output of all notification templates. Edit to customize the style of all notification templates.
    util.ftl Helper script methods to be used in templates.


  5. Edit a notification_<locale>.properties file to edit notification strings in a particular language.

  6. You must check the configuration files back in after making changes, and they must be checked in during the same wsadmin session in which they were checked out for the changes to take effect. See the topic Apply Wikis property changes for details.


Parent topic

Administer Wikis


Related tasks


Starting the wsadmin client
Apply Wikis property changes


   

 

});