16 Managing Subscriptions and Notifications

This chapter describes how to administer subscriptions and notifications. As an administrator, you can create and, potentially, enforce application-wide defaults for application-level subscriptions; specify a connection type that identifies the server that will handle notification delivery; and set and get Notifications messaging configuration details using WLST commands.

This chapter includes the following topics:

Permissions

To perform the tasks in this chapter, you must be granted the WebLogic Server Admin role through the Oracle WebLogic Server Administration Console and the Administrator role in the deployed application. In WebCenter Portal, the Administrator role is granted through WebCenter Portal Administration.

For more information about roles and permissions, see Understanding Administrative Operations, Roles, and Tools.

16.1 About Subscriptions and Notifications

In WebCenter Portal, subscriptions and notifications provide users with a way to subscribe to the types of services and application objects that interest them. Consequently, users receive timely notice over their selected messaging channels of changes that affect their subscribed services and objects.

See Also:

For information about adding notifications functionality to a portal, see Adding Notifications to a Portal in Building Portals with Oracle WebCenter Portal.

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

Note:

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

16.2 Setting Up Default Subscription Preferences

WebCenter Portal users set their personal Subscriptions preferences through the WebCenter Portal 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:

16.2.1 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 WebCenter Portal (for more information, see Subscribing to the Application, to Portals, and to Objects in Using Oracle WebCenter Portal.)

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, portal membership management

  • subscription-enabled—for specifying the initial state of the preference option: true (enabled) or false(not enabled)

    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 selected by default in the WebCenter Portal's Preferences dialog. If subscription-enabled="false", then the associated subscription option is deselected 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 page in Preferences (Figure 16-1 ).

Figure 16-1 Preferences - Subscriptions: General Subscriptions Page

Description of Figure 16-1 follows
Description of "Figure 16-1 Preferences - Subscriptions: General Subscriptions Page"

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

Table 16-1 Effect of Administrator Defaults on Subscriptions Preferences

subscription-enabled(1) end-user-configurable Option in Preferences

True

True

Rendered normally, check box is selected

True

False

Grayed out, check box is selected

False

True

Rendered normally, check box is deselected

False

False

Hidden, check box is hidden

Tip:

In Table 16-1 , the most typical scenario for most notifications is false/true (row 3).

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

Table 16-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 portal role changes, for example, from Portal Manager to another custom role

oracle.webcenter.community

You are added as a member of a portal

oracle.webcenter.community

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

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

    The following example provides sample content for an application-wide subscription preferences setting file and an example of each required option.

    <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 Running Oracle WebLogic Scripting Tool (WLST) Commands.

    For example:

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

    Where:

    • application is the name that identifies your WebCenter Portal deployment

    • serverName is the name of the server where WebCenter Portal 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.

    For information about the importMetadata WLST command, see importMetadata in WLST Command Reference for Infrastructure Components.

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

Table 16-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.2

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.

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

Table 16-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 16-5 describes the effect of various combinations of settings for the service ID oracle.webcenter.peopleconnections.kudos.

Table 16-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 16-6 describes the effect of various combinations of settings for the service ID oracle.webcenter.community.

Table 16-6 Effect of Subscription Configurations for Portal Management

subscription-enabled end-user-configurable Effect

true

true

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

  • The user can change this default.

true

false

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

  • The user cannot change this default.

false

true

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

  • The user can change this default.

false

false

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

  • The option for changing this default is hidden.

16.2.3 Setting Subscriptions Preferences in WebCenter Portal

Individual users set their own subscription preferences in WebCenter Portal's Preferences. Two Preferences pages are provided for this purpose:

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

    For more information, see Subscribing to the Application, to Portals, and to Objects in Using Oracle WebCenter Portal.

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

    For more information, see Establishing and Managing Your Messaging Channels and Filters in Using Oracle WebCenter Portal.

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

16.3.1 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 WebCenter Portal.

Use one of two possible connection types:

  • BPEL Server provides two messaging channel options to users: mail and texting (SMS).

  • Mail Server delivers notification messages exclusively through a mail server that is configured for WebCenter Portal.

BPEL Server Connection Type

Selection of a BPEL server presupposes that you have established a connection to a BPEL server with the User Messaging Service (UMS) is available. For information about connecting to a BPEL server, see Managing the SOA Connection for WebCenter Portal Membership Workflows.

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

Tip:

You should use the same connection for Notifications that you use for setSpacesWorkFlowConnectionName, provided you use the BPEL Server for notifications.

Mail Server Connection Type

Selection of a mail server presupposes that you have established a connection to 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 Managing Mail.

When Mail Server is the selected connection type, the Manage Configuration button on the Messaging panel in WebCenter Portal's Preferences might or might not be grayed-out. This depends on whether you have set up spacesWorkFlowConnection. Regardless, when Mail Server is the selected connection type, and you click the Manage Configuration button for Messaging preferences to open User Messaging Preferences, any changes you make are ignored.

See Also:

Establishing and Managing Your Messaging Channels and Filters in Using Oracle WebCenter Portal

16.3.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:

16.3.2.1 Installation

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

If you will 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 messaging channels, you must install drivers for these as well.

If you will use the Mail service for Notifications messaging, no Notifications-specific installation is required, but the Mail service must be configured as described in Managing Mail.

16.3.2.2 Configuration

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

BPEL Server Configuration

If you want users to have messaging channel options—mail and texting (SMS)—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 mail driver is configured. The SMS driver is available, but must be deployed.

For more information see Managing the SOA Connection for WebCenter Portal Membership Workflows in Administering Oracle SOA Suite and Oracle Business Process Management Suite.

Mail Server Configuration

If you want users to 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 Managing Mail.

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 Using Oracle WebCenter Portal.

16.3.2.3 Security

There are no security considerations specifically associated with Notifications.

16.3.2.4 Limitations

Some activities create Notification tasks to be sent in the future. For example, if a user creates an announcement with an active date in the future, a notification task is created on the WebCenter Portal application server, so that a notification will be sent when the announcement becomes active. However, if the Mail service is used for Notifications, future Notification tasks are deleted if the WebCenter Portal application server is restarted.

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

In WebCenter Portal Release 12.2.1.0.0, a new Documents service task flow has been introduced. Integration between the new task flow and subscriptions and notifications is not in place in this release; consequently, no document-related activities trigger notifications. Integration between the new Documents task flow and subscriptions and notifications will be reintroduced in a subsequent release.

16.3.3 Configuration Roadmap for Notifications

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

Figure 16-2 Configuring the Notifications Service

Description of Figure 16-2 follows
Description of "Figure 16-2 Configuring the Notifications Service "

Table 16-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. Choose the type of connection to use for Notifications, either BPEL or Mail, using one of the following tools:

Administrator

5. Restart the managed server where your application is deployed.

For WebCenter Portal, restart WC_Portal.

Administrator

6. Set up default subscription preferences for all users

Application Specialist/End User

7. Configure and test Notifications in your applications


16.3.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 WebCenter Portal.

    For more information, see Navigating to the Home Page for WebCenter Portal.

  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. To make your changes take effect, restart the managed server where WebCenter Portal is deployed.

16.3.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 setNotificationsConfig in WebCenter WLST Command Reference. See also getNotificationsConfig in the same guide.

See Also:

For information about how to run WLST commands, see 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 where the application is deployed. For more information, see Starting and Stopping Managed Servers Using WLST in Administering Oracle Fusion Middleware.

16.3.6 Example - Setting Up Mail Notifications for WebCenter Portal Using WLST

This section provides an example of using WLST to set up Mail Notifications for WebCenter Portal using WLST commands.

First, the example shows you how to create an external application that is configured with shared credentials, and create a mail server connection that uses the external application. Next, the example shows you how to configure WebCenter Portal to send notifications on that mail connection, and finally how to set subscription options through user preferences.

  1. At the WLST command prompt, connect to the Administration Server for 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.

    For more information, see createExtAppConnection in WebCenter WLST Command Reference.

  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 mail account from which mail notifications will be sent. This must be in the format <user>@<domain of the mail server>.

    Optionally, you may add the following fields to use 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)
    

    For more information, see addExtAppField in WebCenter WLST Command Reference.

  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.

    For more information, see createMailConnection in WebCenter WLST Command Reference.

  5. Set Mail as the notifications channel:
       setNotificationsConfig(appName='webcenter', type='MAIL',
                              name='NotificationSharedConn')
    

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

    For more information, see setNotificationsConfig in WebCenter WLST Command Reference.

  6. For the changes to take effect, restart the managed server where WebCenter Portal is deployed (WC_Portal by default).
  7. Log in to WebCenter Portal, 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 page, click Subscriptions, and then select Portal 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 Portal Manager to another custom role to trigger a notification.

16.4 Creating and Applying Custom Notification Templates

The notification messages that users receive through 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:

16.4.1 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 (or defaultTemplate_rtl.xml—when right-to-left language support is required).

See Also:

For information about running WLST commands, see 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.

The following example illustrates the default content of notification message template files. You can use this to formulate your custom files.

Note:

Differences may appear between custom files particularly under the <style> tag, where alignment—either right or left—is specified.

Example

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

16.4.2 Overwriting a Default Notifications Template

To overwrite a default notifications template (an xml file) to customize notification message formats:

  1. Create a directory in the format of: /tmp/repository/oracle/webcenter/notification/custom/template

    This will later be used to import the files into the MDS and override the original application file.

  2. Inside the directory you created, create a custom XML file with the name defaultTemplate.xml (or defaultTemplate_rtl.xml, for a right-to-left language template).
  3. Populate the custom file with your revised version of one of these default files.
  4. Upload the custom file into WebCenter Portal's MDS repository using the importMetadata() WLST command. Overwrite the original file, placing the custom file where the absolute path to the file contains the namespace oracle/webcenter/notification/custom.

    For example:

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

    Note:

    For information about the importMetada WLST command, see importMetadata in WLST Command Reference for Infrastructure Components.

    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, inside the MDS repository. For example, for a file created under the following namespace:

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

    For example:

    importMetadata(application='webcenter', server='WC_Portal',
       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, for a file that is created under the following namespace:

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

    The fromLocation is /tmp/repository since the remaining sub-directory consists of the namespace for the XML file. The namespace must have at least the path /oracle/webcenter/notification/custom.

  6. Restart WebCenter Portal.

16.5 Testing the Notifications Connection

In general, Notifications is dependent on the underlying Mail or BPEL connection being 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 Testing Mail Server Connections.

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 selected by default in WebCenter Portal's Preferences. If subscription-enabled="false", then the associated subscription option is deselected by default.
2

This is the out-of-the-box default