Configuring Subscription in EPiServer CMS 5

Product version:

EPiServer CMS 5 SP2

Document version:

1.1

Document last saved:

14-01-2010

Introduction

In EPiServer CMS 5 you can configure the look and content of subscription e-mails sent out by EPiServer CMS.

Table of Contents

Setting up Subscription

The three basic parts of subscription in EPiServer CMS are:

  • At least one page where the EPSUBSCRIBE property is set to true
  • A page exposing the SubscriptionList Web control that handles loading and saving of subscription information
  • The Subscription scheduled job

Each page where EPSUBSCRIBE is set to true will act as a root page for a subscription branch. Information about changes made to this page and its substructure may be sent out via subscription e-mail when the "Mark page as changed" check box has been selected. If you don't want a page in the subscription branch to be included in subscription e-mail, you can set the EPSUBSCRIBE-EXCLUDE property to true for this page.

The SubscriptionList Web control allows users to apply for and configure their subscription. This control will list all pages where EPSUBSCRIBE is set to true in a check box list allowing the user to subscribe to one or several subscription branches.

The language in which the subscription page is displayed determines which language the user will be subscribing to. For example, if the user applies for a subscription on the English version of the subscription page, he/she will receive subscription information about all English pages that have been modified in the selected subscription branches. Please see the SubscriptionPage template in our basic template package for an example on how the SubscriptionList control can be used.

The subscription job is responsible for determining which pages have been updated and formatting/sending subscription mail. Make sure that this scheduled job is active and running by looking at the job's configuration in Admin mode.

Note: Subscription e-mails are sent on a subscription root and language basis. This means that a user subscribing to two subscription roots in two languages will receive one e-mail per language.

Also Note: It is necessary to define EPSUBSCRIBE-ROOT ('Root page for Subscription' in Edit mode) as a Page type in the subscription page and select the node/page below which all of the subscription pages can be found. If you miss this then no subscriptions items appear on the page.

Modifying the Content of Subscription E-mails

By default, the from-address, subject, introduction and link titles used in the subscription e-mail will all use hard-coded values or values fetched from the language files. The subscription job allows the default values to be overridden and determines if that is the case by looking for specifically named properties on the subscription root pages. It does not matter if the properties are dynamic or placed on the subscription root's PageType. The following table specifies the properties that can be overridden, their default values and the name of the override property that the subscription job looks for. 

PropertyDefault valueName of override property
From-address subscription@[host] SubscriptionMailFrom
Subject language specific SubscriptionMailSubject
Introduction empty SubscriptionMailBody
Link title language specific SubscriptionMailReadMore