Skip Headers
Oracle® Fusion Middleware Administrator's Guide for Oracle WebCenter Portal
11g Release 1 (11.1.1.7.0)

Part Number E12405-19
Go to Documentation Home
Home
Go to Book List
Book List
Go to Table of Contents
Contents
Go to Index
Index
Go to Master Index
Master Index
Go to Feedback page
Contact Us

Go to previous page
Previous
Go to next page
Next
PDF · Mobi · ePub

19 Managing Subscriptions and Notifications

In the Spaces application, subscriptions and notifications provide users with a means of subscribing to the types of services and application objects in which they have a particular interest. Consequently, users receive timely notice of the changes that affect their subscribed services and objects from their selected messaging channels.

See Also:

For more information, see the section, "What You Should Know About Subscriptions and Notifications," in the Oracle Fusion Middleware User's Guide for Oracle WebCenter Portal: Spaces.

Notifications administration provides a means of creating and, potentially, enforcing application-wide defaults for application-level subscriptions and specifying a connection type that identifies the server that will handle notification delivery.

This chapter steps through the process of performing these administrative tasks and provides information about how to set and get Notifications messaging configuration details using WLST commands.

Always use the Fusion Middleware Control or WLST command-line tool to review and configure back-end services for WebCenter Portal applications. Any changes you make to WebCenter Portal applications, post deployment, are stored in MDS metadata store as customizations. See Section 1.3.5, "WebCenter Portal Configuration Considerations."

Note:

Most changes you make to WebCenter Portal services configuration through Fusion Middleware Control or using WLST are not dynamic. For your changes to take effect, you must restart the managed server to which the WebCenter Portal application is deployed. See Section 8.2, "Starting and Stopping Managed Servers for WebCenter Portal Application Deployments."

This chapter includes the following sections:

19.1 Setting Up Default Subscription Preferences

Spaces users set their personal Subscriptions preferences through the Spaces application's Preferences dialog. Before this happens, the WebCenter Portal administrator can set default values that determine the application-level subscription options that are available to all users and whether those defaults can be changed.

This section provides an overview of Subscription defaults and steps you through the process of setting default values.

This section includes the following subsections:

19.1.1 What You Should Know About Subscription Defaults

Administrator-level Subscription preferences are set in a custom XML file that you create and then use to supersede the file that is provided for this purpose out of the box (notification-service-settings.xml). The settings in the custom XML file are analogous to the application-level subscriptions settings available to users through Subscription Preferences in the Spaces application (for more information, see the section, "Setting Application-Level Subscriptions," in the Oracle Fusion Middleware User's Guide for Oracle WebCenter Portal: Spaces.)

Each setting provides three attributes:

  • id—for specifying the service ID:

    • oracle.webcenter.peopleconnections.connections, the Connections feature of the People Connections service

    • oracle.webcenter.peopleconnections.wall, the Message Board feature of the People Connections service

    • oracle.webcenter.peopleconnections.kudos, the Feedback feature of the People Connections service

    • oracle.connections. community, space membership management

  • subscription-enabled—For specifying the default value for the preference option: true or false

    Tip:

    Rather than enabling or disabling the entire subscription capability, the subscription-enabled attribute merely sets the initial state of the preference option. For example, if subscription-enabled="true", then the associated subscription option is checked by default in the Spaces application's Preferences dialog. If subscription-enabled="false", then the associated subscription option is not checked by default in the dialog.

  • end-user-configurable—For enabling users to change the established default or preventing users from doing so: true or false

These attributes work together to determine the initial state of the General Subscriptions tab on the Subscriptions panel in the Spaces application's Preferences dialog (Figure 19-1).

Figure 19-1 General Subscriptions Tab on the Subscriptions Panel

General Subscriptions tab in Preferences
Description of "Figure 19-1 General Subscriptions Tab on the Subscriptions Panel"

Table 19-1 illustrates the effect of custom administrator-level subscriptions settings on the appearance of the General Subscriptions tab.

Table 19-1 Effect of Administrator Defaults on Subscriptions Preferences

subscription-enabledFoot 1  end-user-configurable Option in Preferences

True

True

Displayed normally, check box is checked

True

False

Grayed out, check box is checked

False

True

Displayed normally, check box is deselected

False

False

Hidden, check box is hidden


Footnote 1 Rather than enabling or disabling the entire subscription capability, the subscription-enabled attribute merely sets the initial state of the preference option. For example, if subscription-enabled="true", then the associated subscription option is checked by default in the Spaces application's Preferences dialog. If subscription-enabled="false", then the associated subscription option is not checked by default in the dialog.

Tip:

In Table 19-1, the most typical scenario for most notifications is depicted in row three.

Table 19-2 lists the types of actions that can trigger an application-level notification and associates them with their related service ID.

Table 19-2 Application-Level Activities that Can Trigger Notifications

Activity Related Service ID

A user sends you an invitation to connect

oracle.webcenter.peopleconnections.connections

Your space role changes, for example, from participant to moderator

oracle.webcenter.community

You are added as a member of a space

oracle.webcenter.community

Your space membership is removed

oracle.webcenter.community

A user posts a message to your Message Board

oracle.webcenter.peopleconnections.wall

A user likes your post on another user's Message Board

oracle.webcenter.peopleconnections.wall

A user comments on your post on another user's Message Board

oracle.webcenter.peopleconnections.wall

A user posts feedback for you

oracle.webcenter.peopleconnections.kudos


19.1.2 Setting Subscription Defaults

To set defaults for application-level Subscription preferences:

  1. Navigate to a directory with a path that contains /oracle/webcenter/notification, and create the folder custom.

    Tip:

    The directory structure can start or end with any directory or directories, as long as it has /oracle/webcenter/notification/custom in the path.

  2. In the custom folder, or in any subdirectory under /oracle/webcenter/notification/custom/, create the file notification-service-settings.xml.

  3. In the XML file, enter values for all application-level subscription options.

    Example 19-1 provides sample content for an application-wide subscription preferences setting file and an example of each required option.

    Example 19-1 Sample Subscriptions Settings XML File

    <notification-service_settings xmlns="http://xmlns.oracle.com/webcenter/notification">
     <subscription-settings>
      <service id="oracle.webcenter.peopleconnections.connections" subscription-enabled="true"
       end-user-configurable="false"/>
      <service id="oracle.webcenter.peopleconnections.wall" subscription-enabled="false"
       end-user-configurable="true"/>
      <service id="oracle.webcenter.peopleconnections.kudos" subscription-enabled="false"
       end-user-configurable="true"/>
      <service id="oracle.webcenter.community" subscription-enabled="true"
       end-user-configurable="true"/>
     </subscription-settings>
    </notification-service_settings>
    

    Note:

    If an option is not provided, the default values false/false are assigned for the service.

  4. Run the WLST command importMetadata(), and import the directory content into your metadata store.

    See Also:

    For information about running WLST commands, see Section 1.13.3.1, "Running Oracle WebLogic Scripting Tool (WLST) Commands." For information about the importMetadata() command (and other WLST commands), see the section, "importMetadata," in Oracle Fusion Middleware WebLogic Scripting Tool Command Reference.

    For example:

    wls: /wc_domain/serverConfig> importMetadata(application='webcenter',
     server='serverName', fromLocation='directoryPath', docs='/**')
    

    Where:

    • application is the name that identifies your Spaces application

    • serverName is the name of the server on which the Spaces application is running

    • directoryPath is the directory path under which oracle/webcenter/notification/custom/<any_sub_dir_after_this>/notification-service-settings.xml is located.

      For example, if the directory path to notification-service-settings.xml is /scratch/mydir/oracle/webcenter/notification/custom, enter /scratch/mydir for directoryPath.

    • docs identifies the content to be imported, in this example, the path and files that fall under directoryPath.

Table 19-3 describes the effect of various combinations of settings for the service ID oracle.webcenter.peopleconnections.connections.

Table 19-3 Effects of Subscription Configurations for Connections

subscription-enabled end-user-configurable Effect

true

true

  • The subscribing user receives a notification message when another user sends the user an invitation to connect.

  • The user can change this default.

true

false

  • The subscribing user receives a notification message when another user sends the user an invitation to connect.

  • The user cannot change this default.Foot 1 

false

true

  • The subscribing user does not receive a notification message when another user sends the user an invitation to connect.

  • The user can change this default.

false

false

  • The subscribing user does not receive a notification message when another user sends the user an invitation to connect.

  • The option for changing this default is hidden.


Footnote 1 This is the out-of-the-box default

Table 19-4 describes the effect of various combinations of settings for the service ID oracle.webcenter.peopleconnections.wall.

Table 19-4 Effects of Subscription Configurations for Message Board

subscription-enabled end-user-configurable Effect

true

true

  • The subscribing user receives a notification message when another user posts a message on the user's Message Board, likes the user's Message Board post, or comments on the user's Message Board post.

  • The user can change this default.

true

false

  • The subscribing user receives a notification message when another user posts a message on the user's Message Board, likes the user's Message Board post, or comments on the user's Message Board post.

  • The user cannot change this default.

false

true

  • The subscribing user does not receive a notification message when another user posts a message on the user's Message Board, likes the user's Message Board post, or comments on the user's Message Board post.

  • The user can change this default.

false

false

  • The subscribing user does not receive a notification message when another user posts a message on the user's Message Board, likes the user's Message Board post, or comments on the user's Message Board post.

  • The option for changing this default is hidden.


Table 19-5 describes the effect of various combinations of settings for the service ID oracle.webcenter.peopleconnections.kudos.

Table 19-5 Effect of Subscription Configurations for Feedback

subscription-enabled end-user-configurable Effect

true

true

  • The subscribing user receives a notification message when another user leaves feedback for the user.

  • The user can change this default.

true

false

  • The subscribing user receives a notification message when another user leaves feedback for the user.

  • The user cannot change this default.

false

true

  • The subscribing user does not receive a notification message when another user leaves feedback for the user.

  • The user can change this default.

false

false

  • The subscribing user does not receive a notification message when another user leaves feedback for the user.

  • The option for changing this default is hidden.


Table 19-6 describes the effect of various combinations of settings for the service ID oracle.webcenter.community.

Table 19-6 Effect of Subscription Configurations for Spaces Management

subscription-enabled end-user-configurable Effect

true

true

  • The subscribing user receives a notification message when the user's space membership role changes, the user is added as a member of a space, or the user is removed as a member of a space.

  • The user can change this default.

true

false

  • The subscribing user receives a notification message when the user's space membership role changes, the user is added as a member of a space, or the user is removed as a member of a space.

  • The user cannot change this default.

false

true

  • The subscribing user does not receive a notification message when the user's space membership role changes, the user is added as a member of a space, or the user is removed as a member of a space.

  • The user can change this default.

false

false

  • The subscribing user does not receive a notification message when the user's space membership role changes, the user is added as a member of a space, or the user is removed as a member of a space.

  • The option for changing this default is hidden.


19.1.3 Setting Subscriptions Preferences in Spaces

Individual users set their own subscription preferences in the Spaces application's Preferences dialog. Two Preferences panels are provided for this purpose:

  • Subscriptions, where users subscribe to be notified about actions occurring with their space memberships and the People Connections service (Connections, Message Board, and Feedback) and view and remove their space- and object-level subscriptions

  • Messaging, where users access controls for configuring their preferred messaging channels and filters (BPEL connection types only)

19.2 Setting Up Notifications

This section provides an overview of messaging connection types, describes prerequisites that must be in place before you can define a notification channel, and steps you through the process of setting up a notification channel for Notifications. It includes the following subsections:

19.2.1 What You Should Know About Connection Channels

The Notifications connection type determines the messaging channels that are available to users when they configure their own messaging preferences for Notifications in Spaces.

Use one of two possible connection types:

  • BPEL Server provides three messaging channel options to users: mail, texting (SMS), and worklist

  • Mail Server delivers notification messages exclusively through a mail server that is configured for the Spaces application

BPEL Server

Selection of a BPEL server presupposes that you have established a connection with a BPEL server in which the User Messaging Service (UMS) is available. For information about connecting to a BPEL server, see Chapter 23, "Managing the Worklist Service."

When the Spaces application has setSpacesWorkFlowConnectionName set up, the Manage Configuration button becomes available on the Messaging panel in the Spaces application's Preferences dialog.

Tip:

It is expected that the same connection you use for setSpacesWorkFlowConnectionName is used for Notifications, provided you use the BPEL Server for notifications.

Mail Server

Selection of a mail server presupposes that you have established a connection with a mail server. Additionally, the external application associated with the mail server connection must contain shared credentials. For information about connecting to a mail server, see Chapter 17, "Managing the Mail Service."

When Mail Server is the selected connection type, the Manage Configuration button on the Messaging panel in the Spaces application's Preferences dialog may or may not be grayed-out. This depends on whether you have set up spacesWorkFlowConnection. But, regardless, when Mail Server is the selected connection type, if clicking the Manage Configuration button for Messaging preferences opens User Messaging Preferences, any changes you make are ignored.

19.2.2 Notification Prerequisites

Before you can define a connection type for Notifications, you must take the steps and consider the information provided in the following subsections:

19.2.2.1 Installation

Installation requirements associated with Notifications change according to the type of connection you plan to select for Notifications messaging.

If you plan to use the User Messaging Service (UMS) through your BPEL connection for Notifications messaging, you should know that only the mail driver is installed by default. To make use of SMS and Worklist messaging channels, you must install drivers for these as well. For information about installing SMS and Worklist drivers for UMS, see the chapter "Configuring Oracle User Messaging Service," in the Oracle Fusion Middleware Administrator's Guide for Oracle SOA Suite and Oracle Business Process Management Suite.

If you plan to use the Mail service for Notifications messaging, no Notifications-specific installation is required, but the Mail service must be configured as described in Chapter 17, "Managing the Mail Service."

19.2.2.2 Configuration

Configuration prerequisites for Notifications also depend on the connection type you plan to select for Notifications messaging.

BPEL Server

If you plan for users to have messaging channel options—mail, texting (SMS), and Worklist—a connection to a BPEL server must be in place. Notifications uses the SOA installation for supporting multichannel notifications through the User Messaging Service (UMS). UMS is installed as a part of the SOA domain. Out of the box, only the email driver is configured. The SMS driver is available, but must be deployed. For the Worklist channel, the SOA domain must be extended through the Worklist driver extension template.

For more information see Chapter 23, "Managing the Worklist Service," and the chapter "Configuring Oracle User Messaging Service," in the Oracle Fusion Middleware Administrator's Guide for Oracle SOA Suite and Oracle Business Process Management Suite.

Mail Server

If you plan that users will always and only be notified through their mail, a connection to a mail server must be in place. Additionally, the external application associated with the mail server connection must contain shared credentials. For more information, see Chapter 17, "Managing the Mail Service."

Mail notifications are sent in the preferred language specified for each user's profile. If the preferred language is not specified for a user, the server locale setting is used for mail notifications. For example, if the server is running on the Korean locale and the preferred language is not set for a user, the notification mail is in Korean.

For information about setting the preferred language, see "Choosing Your Preferred Display Language" in Oracle Fusion Middleware Administrator's Guide for Oracle WebCenter Portal.

19.2.2.3 Security

There are no security considerations specifically associated with Notifications.

19.2.2.4 Limitations

UMS supports multiple messaging channels, including voice and instant messaging, that are not also supported by Notifications. From UMS, Notifications consumes only mail, SMS, and Worklist.

19.2.3 Configuration Roadmap for Notifications

Figure 19-2 and Table 19-7 provide an overview of the prerequisites and tasks required to get the Notifications service working in WebCenter Portal applications.

Figure 19-2 Configuring the Notifications Service

Description of Figure 19-2 follows BPEL server Mail server Create an external application connection for the mail server Configure shared credentials for the mail server external application Configure a connection to the BPEL server Configure a connection to the mail server Use Fusion Middleware Control USE WLST Restart the managed server to which your application is deployed Set up default subscription preferences for all users Configure and test Notifications in your application
Description of "Figure 19-2 Configuring the Notifications Service "

Table 19-7 Configuring Notifications

Actor Task Sub-task Notes

Administrator

1. Set up the back-end component for Notifications

   

Administrator

2. (For mail server only) Configure an external application

 

Administrator

3. Create or modify a connection between your WebCenter Portal application and your chosen back-end component:

   

Administrator

4. Select the type of connection to use for Notifications, either BPEL or Mail, by using one of the following tools:

   

Administrator

5. Restart the managed server to which your application is deployed.

 

For the Spaces application, restart WC_Spaces. For a Framework application, restart the custom managed server where the application is deployed.

Administrator

6. Set up default subscription preferences for all users

   

Developer/End User

7. Configure and test Notifications in your applications:

   

19.2.4 Specifying the Notifications Channel Using Fusion Middleware Control

To specify a Notifications message connection type with Fusion Middleware Control:

  1. Log in to Oracle Fusion Middleware Control and navigate to the home page for Spaces.

    For more information, see Section 6.2, "Navigating to the Home Page for the Spaces Application."

  2. From the WebCenter Portal menu, select Settings > Application Configuration.

  3. On the Application Configuration page, scroll down to Notifications (at the bottom of the page), and select a connection type to use for outbound notifications: either BPEL Server or Mail Server.

  4. The next step depends on the selected connection type:

    If you select BPEL Server:

    1. From the Connection Name list, select the name you provided for the BPEL server when you set up that connection.

    2. In the Sender Mail Address field, enter a mail address from which all Notifications messages are sent. The sender mail address must match at least one driver that is configured to send messages from a corresponding domain.

    3. In the Sender SMS Address field, enter the four- to six-digit number that is used by the User Messaging Server (UMS) as the driver from which all Notifications messages are sent. The sender SMS address must match at least one driver that is configured to send messages from a corresponding domain.

    If you select Mail Server, select a mail connection from the Connection Name list.

  5. Save your changes.

  6. Restart the managed server on which the portal application is deployed to make your configuration changes take effect.

19.2.5 Specifying the Notifications Channel Using WLST

Use the WLST command setNotificationsConfig to configure the connection type used for notifications. For command syntax and examples, see the section, "setNoticationsConfig," in the Oracle Fusion Middleware WebLogic Scripting Tool Command Reference. See also, "getNotificationConfig," in the same guide.

See Also:

For information about how to run WLST commands, see Section 1.13.3.1, "Running Oracle WebLogic Scripting Tool (WLST) Commands."

Note:

Updates to this configuration are stored in the MDS repository. For configuration changes to take effect, you must restart the managed server on which the application is deployed. For more information, see the section, "Starting and Stopping WebLogic Managed Servers Using the Command Line" in the Oracle Fusion Middleware Administrator's Guide.

19.2.6 Example - Setting Up Mail Notifications for the Spaces Application Using WLST

This section provides an example of using WLST to set up Mail Notifications for the Spaces application.

In this example, we will create an external application connection, and configure shared credentials for the external application. Further, we will create a Mail connection and set Mail as the notification channel for Spaces. We will then set the subscription preferences in the Spaces application.

  1. At the WLST command prompt, connect to the Administration Server for Oracle WebCenter Portal.

    connect('admin_user','mypassword','<servername>:7001')
    
  2. Create an external application connection:

    createExtAppConnection(appName='webcenter', name='NotificationSharedApp', displayName= 'NotificationSharedApp')
    

    This command creates the connection named NotificationSharedApp.

  3. Configure shared credentials for the external application, NotificationSharedApp:

    addExtAppCredential(appName='webcenter', name='NotificationSharedApp', 
    type='SHARED', username='john.doe@example.com', password='sharedpassword')
    

    Where username refers to the email account from which email notifications will be sent. This must be in the format <user>@<domain of the mail server>.

    Optionally, you may add the following fields that will be used while sending out the mail notification.

    addExtAppField(appName='webcenter',name='NotificationSharedApp',fieldName='Email Address',fieldValue='sender's_email_address',displayToUser=false)
    addExtAppField(appName='webcenter',name='NotificationSharedApp',fieldName='Your Name',fieldValue='sender's_display_name',displayToUser=false)
    
  4. Create a Mail connection:

    createMailConnection(appName='webcenter',name='NotificationSharedConn',
             imapHost='<mailserver>',imapPort=143,
             smtpHost='<mailserver>',smtpPort=25,
             imapSecured=false,smtpSecured=false,
             appId='NotificationSharedApp',default=1)
    

    This creates a mail connection named NotificationSharedConn.

  5. Set Mail as the notifications channel:

    setNotificationsConfig(appName='webcenter', type='MAIL',
                              name='NotificationSharedConn')
    

    This sets NotificationSharedConn as the mail connection to use for sending notifications.

  6. For the changes to take effect, restart WC_Spaces, the managed server on which the Spaces application is deployed by default.

  7. Log in to Spaces as a user, navigate to the About tab of the Profile page, and verify that your e-mail address is set in the Email field. This is to ensure that notifications are sent to the required e-mail address.

    If the e-mail address is not set, click Edit, then in the Email field, specify your e-mail address, and click Save.

  8. Subscribe to the activities for which to receive notifications. For example, navigate to the Preferences dialog, click Subscriptions, and then select Space Management to get notified about any membership or role changes.

  9. Test your configuration by performing a subscribed activity. For example, change your role from Moderator to Participant to trigger a notification.

19.3 Creating and Applying Custom Notification Templates

The notification messages that users receive through Worklist or Mail have a default format for content and content presentation. As the application administrator, you can instead create and apply custom templates to provide your own formats for notification messages.

This section provides information about creating a custom template for notifications messages. It includes the following subsections:

19.3.1 What You Should Know About Overwriting Default Notification Templates

You can go through MDS using WLST commands to customize the layout and content of subscription-based notification messages by overwriting the files defaultTemplate.xml and defaultTemplate_rtl.xml—when right-to-left language support is required.

See Also:

For information about running WLST commands, see Section 1.13.3.1, "Running Oracle WebLogic Scripting Tool (WLST) Commands."

You can create your own version of these xml files, editing the CSS styles for tables (label, value, background) and footers (note). You can move such tags as <payload> and <group-space-footer> to change the layout. To modify the content of these tags, you can edit the CDATA section within <html-format>.

Note that the tag <text-format/> should always be present and empty. You can use the tag <custom> to add additional content, where the enclosed <html-format> with CDATA contains the new HTML content and <text-format/> remains empty.

Example 19-2 and Example 19-3 illustrate the default content of notification message template files. You can use these to formulate your custom files.

Note:

The default content of these files is very similar. The differences appear under the <style> tag, where alignment—either right or left—is specified.

Example 19-2 Default File defaultTemplate.xml

<?xml version="1.0"?>
<notification-template xmlns="http://xmlns.oracle.com/webcenter/notification">
   <!-- The CSS Style of the Notification -->
      <style>
         <text-format/>
         <html-format>
            <![CDATA[
               <style type="text/css">
                  .title  {font-size:1.2em; font-weight:bold;
                     white-space:nowrap;}
                  .label  {text-align:right; margin-left:30px;
                     padding-right:10px; white-space:nowrap;}
                  .value  {text-align:left; margin-right:20px;
                     padding-left:10px; white-space:nowrap;
                     width:100%;}
                  .note   {font-size:0.8em; color:#999999}
                  .background {background-color:#fcfcfc}
               </style>
            ]]>
         </html-format>
      </style>


   <!-- The Subject line of the Notification -->
   <subject>
      <message-key>NOTIFICATION_SUBJECT</message-key>
   </subject>
   <group-space-subject>
      <message-key>GROUP_SPACE_SUBJECT_SUFFIX</message-key>
   </group-space-subject>
   <!-- Actual srvc-specific data. Provided/Overridden by srvc template -->
   <payload>
      <text-format/>
      <html-format/>
   </payload>


   <!-- Any generic/common footer to appear after service-specific payload -->
   <!-- Group Space footer - if applicable -->
   <group-space-footer>
      <text-format/>
      <html-format>
         <![CDATA[
            <p>
               <a href="<token>groupSpaceUrl</token>" target="_blank">
                  <message-key>GO_TO_SPACE</message-key>&nbsp;<token>
                     groupSpaceName</token>
               </a>
            </p>
         ]]>
      </html-format>
   </group-space-footer>


   <!-- Unsubscribe footers -->
   <unsubscribe-footer>
      <text-format/>
      <html-format>
         <![CDATA[
            <hr/>
            <p class="note">
               <token>unsubscribeMessage</token>
            </p>
         ]]>
      </html-format>
   </unsubscribe-footer>
</notification-template>

Example 19-3 Default File defaultTemplate_rtl.xml

<?xml version="1.0"?>
<notification-template xmlns="http://xmlns.oracle.com/webcenter/notification">
   <!-- The CSS Style of the Notification -->
      <style>
         <text-format/>
         <html-format>
            <![CDATA[
               <style type="text/css">
                  .title  {font-size:1.2em; font-weight:bold;
                     white-space:nowrap;}
                  .label  {text-align:left; margin-right:30px;
                     padding-left:10px; white-space:nowrap;}
                  .value  {text-align:right; margin-left:20px;
                     padding-right:10px; white-space:nowrap;
                     width:100%;}
                  .note   {font-size:0.8em; color:#999999}
                  .background {background-color:#fcfcfc}
               </style>
            ]]>
         </html-format>
      </style>


   <!-- The Subject line of the Notification -->
   <subject>
      <message-key>NOTIFICATION_SUBJECT</message-key>
   </subject>
   <group-space-subject>
      <message-key>GROUP_SPACE_SUBJECT_SUFFIX</message-key>
   </group-space-subject>
   <!-- Actual srvc-specific data. Provided/Overridden by srvc template -->
   <payload>
      <text-format/>
      <html-format/>
   </payload>


   <!-- Any generic/common footer to appear after service-specific payload -->
   <!-- Group Space footer - if applicable -->
   <group-space-footer>
      <text-format/>
      <html-format>
         <![CDATA[
            <p>
               <a href="<token>groupSpaceUrl</token>" target="_blank">
                  <message-key>GO_TO_SPACE</message-key>&nbsp;<token>
                     groupSpaceName</token>
               </a>
            </p>
         ]]>
      </html-format>
   </group-space-footer>


   <!-- Unsubscribe footers -->
   <unsubscribe-footer>
      <text-format/>
      <html-format>
         <![CDATA[
            <hr/>
            <p class="note">
               <token>unsubscribeMessage</token>
            </p>
         ]]>
      </html-format>
   </unsubscribe-footer>
</notification-template>

19.3.2 Overwriting a Default Notifications Template

To overwrite an existing xml file to customize notification message formats:

  1. Create a custom XML file with the name defaultTemplate.xml (or defaultTemplate_rtl.xml, for right-to-left language template).

  2. Populate the custom file with your revised version of one of these default files.

    See Also:

    Example 19-2 and Example 19-3 show default file content.

  3. Overwrite the original file, placing the custom file where the absolute path to the file contains the namespace oracle/webcenter/notification/custom.

    For example:

    /tmp/repository/oracle/webcenter/notification/custom/template/defaultTemplate.xml
    
  4. Upload the custom file into the WebCenter Portal's MDS repository by running the importMetadata() WLST command.

    For example:

    importMetadata(application='webcenter', server='WC_Spaces',
       fromLocation='template-file-location',
       docs='/oracle/webcenter/notification/custom/template/defaultTemplate.xml')
    

    The template-file-location points to the directory under which the fully qualified custom file is located. The fully qualified custom file is typically placed under the directory structure equivalent to its namespace. For example, consider a file that is created under the following namespace:

    /tmp/repository/oracle/webcenter/notification/custom/template/defaultTemplate.xml
    

    In such a case, the fromLocation is /tmp/repository because the remaining sub-directory consists of the namespace for the XML file. The namespace must have at least the path /oracle/webcenter/notification/custom.

    See Also:

    For information about the importMetadata() command (and other WLST commands), see the section, "importMetadata," in Oracle Fusion Middleware WebLogic Scripting Tool Command Reference.

  5. Restart the portal application.

19.4 Testing the Notifications Connection

In general, Notifications depends on the underlying Mail or BPEL connection to be valid when the administrator sets it. If these connections prove to be valid, then, by extension, the Notifications connections requirements are met.

Tip:

For information about testing Mail connections, see Section 17.9, "Testing Mail Server Connections."

19.5 Troubleshooting Issues with Notifications

Problem

No notifications are received.

Solution

Problem

Notifications is configured (BPEL or MAIL) correctly, but still no notifications.

Solution

Notifications relies on a valid BPEL or MAIL connection. Run the respective connection validations and troubleshooting scenarios as described in Chapter 17, "Managing the Mail Service," or Chapter 23, "Managing the Worklist Service."

Problem

MAIL or BPEL connections are set up appropriately, but still do not receive notifications.

Solution

Notifications are generated based on user subscriptions. Apart from notification for invitations to connect, which is configured out of the box, other notifications are generated only when a user has specifically subscribed. Ensure that the user has created subscriptions through his or her personal Preferences or through space- or object-level subscriptions. For more information, refer to the section, "Subscribing at the Application, space, and Object Level," in Oracle Fusion Middleware User's Guide for Oracle WebCenter Portal: Spaces.

Problem

Users have set up their subscriptions, but still receive no notifications.

Solution

Problem

For UMS configurations, users receive notifications on some channels but not on others.

Solution

This is most likely due to the way the user's messaging channels and filters are configured. For more information, see the section, "Establishing and Managing Your Messaging Channels and Filters," in Oracle Fusion Middleware User's Guide for Oracle WebCenter Portal: Spaces.

Problem

For UMS configurations, only mail-channel notifications are delivered, the Worklist channel does not work.

Solution

Ensure that the SOA domain is extended with the Worklist driver template as described in the chapter "Configuring Oracle User Messaging Service," in the Oracle Fusion Middleware Administrator's Guide for Oracle SOA Suite and Oracle Business Process Management Suite.