1. On the server that hosts Ektron, go to Control Panel > Add/Remove programs > Add/Remove Windows Components.

   NOTE: This procedure uses Microsoft Window 2008 R2. In some Windows versions, go to Control Panel > Programs and Features > Turn Windows features on or off then select Microsoft Message Queue (MSMQ) Server.

2. If it is not checked, check Message Queuing Services.
   —Image—
   

   Windows 2008 R2

   

3. If Message Queuing Services was checked when you viewed it, go to step 5. If it was not checked, click Next. A wizard creates the component.

   The rest of this procedure employs a wizard that saves several manual steps. If you have a problem using the wizard, or prefer to install Web Alerts manually so you can track the files being installed to your server, see Manually Setting Up the Message Queue and Asynchronous Processor.

4. From the Windows Start Menu, click All Programs > Ektron > CMS400vxx > Utilities > Web Alert Setup. The Web Alert Wizard setup screen appears.
5. Click Next. The wizard begins installing the Web Alerts feature.

   The following screen appears.

   —Image—

   

6. At Message Queue Name, enter the name of the message queue that will manage the Web Alert email.
7. At SMTP Port, enter the port number that sends Web Alert email.
8. At SMTP Server, enter the name of the server that hosts your Ektron website.
9. Enter the username and password that will be used to send and receive email.
10. If you want a very detailed log file, click Logfile Verbose.
11. If your Asynchronous Processor service is not running, the following message appears. If you see this message, click OK then click Finish.
    —Image—

    

12. Go to Control Panel > Administrative Tools > Computer Management > Services and Applications > Services.
13. Start the Ektron Async Processor service.
14. When specifying the SMTP port in Step 7, if you entered a port number other than 25
    1. Open C:\Program Files (x86)\Ektron\CMS400vxx\EktronAsyncProcessor_Service\Ektron.Services.EktronAsyncProcessor.exe.config.
    2. Change the value of ek_SMTP_EnableSsL to False.

Manually Setting Up the Message Queue and Asynchronous Processor

Use this procedure if you had a problem using the wizard, or if you want to know which files are being installed on your server.

1. Go to Control Panel > Administrative Tools > Computer Management > Services and Applications > Message Queuing.

   NOTE: In some Windows versions, you access this screen by clicking Start > Computer > Manage.

2. Right click the Services and Applications > Message Queuing > Private Queues folder and select New > Private Queue.
   —Image—

   

3. Create a private queue named msmq_web.
4. Right click msmq_web and select Properties.
5. Go to the Security tab. You can give the Everyone group Full Control if you are in a testing environment. If you are on a production server or want better security, delete the following permissions for the local system account (the account under which the EktronAsyncProcessor Service runs):
   • Receive Message
   • Peek Message
   • Send Message
6. Give the ASP.NET account (the account under which the Web services interface runs) Send Message permission.
7. Click OK.
8. Open the following file: C:\Program Files\Ektron\CMS400vxx\EktronAsyncProcessor_Service\RegEktron.Services.EktronAsyncProcessor.bat
9. Review and update as necessary the paths to the .NET directory and Ektron.Services.EktronAsyncProcessor.exe file.
10. Update the paths to the .NET Directory and the .exe file if necessary.
11. Execute the .bat file. Or, from a command line or Start Menu > Run, enter: C:\Windows\Microsoft.NET\Framework\v2.0.50727\installutil “C:\program Files\Ektron\CMS400vxx\EktronAsyncProcessor_Service\Ektron.Services.EktronAsyncProcessor.exe”
12. Open the following file and enter your SMTP connection settings: C:\Program Files\Ektron\CMS400vxx\EktronAsyncProcessor_Service\Ektron.Services.EktronAsyncProcessor.exe.config.
13. Go to Control Panel > Administrative Tools > Computer Management > Services and Applications > Services. Start the Ektron Async Processor Service.
    —Image—

    

Verifying Connections

• To verify the Web service-to-queue connection:
  • Leave the Ektron asynchronous processor service off, submitting content with notifications, and verifying that a message arrived in the queue
  • Turn on journaling for the queue. Submit a message in the queue. The Ektron asynchronous processor service picks it up and places it in the journaled messages.
  • Turn on logging for the Ektron asynchronous processor service
• To verify the Ektron-to-Web service connection:
  • Open the asynchronous processor location inside a Web browser and test the Web services.
• To verify the writing of files:
  • Ensure that Ektron has write access to the [sitepath]subscriptions directory and submit content that will trigger notifications. This action places a file inside that directory.
• To verify that the Ektron asynchronous processor service can download a file:
  • Open a Web browser on the asynchronous machine and connect to the location of the notification command files. Attempt to download one.

NOTE: If you reached this screen while creating an eCommerce message, see Configuring eCommerce.

NOTE: To set or modify this information, you must have permission to edit the folder.

• From address (required)—See Creating the “From” Addresses
• Recipient (required)—Users who signed up for subscriptions that are enabled for the folder. See Also: Setting Up a Subscription.
• Subject line—The Subject field on the Web Alerts tab of the Folder Properties screen.
  See Assigning a Web Alert to a Folder or Content
• Default message—See Creating the Default Message Text.
• Opt out message (required)—See Creating the Opt Out Message Text
• Content summary—The Summary of the content whose creation or change generates the email. See Also: Writing a Summary for Content.

  NOTE: The Summary can include variables that retrieve information about the content. See Including Variables in the Message.

• Content link—Link to content whose creation or change generates the email.
• Any CMS content item—You may include Ektron content in the email.
• Unsubscribe message (required)—See Creating the Unsubscribe Message Text.

Including Variables in the Message

The message can include variables that retrieve content information into the message text. The variables are surrounded by at signs (@). For example

The following content was recently updated: @AppContentLink@

The email text might read:

The following content was recently updated: The Effect of Coumadin on Cardiac Patients

Use the following variables in a Web Alert message.

• @appContentTitle@—The title of the content block.
• @appCRLF@—A carriage return. Moves text down one line.
• @appContentLink@—The link to the content block on the website.

  NOTE: You must be logged in to see the changes.

• @appContentURL@—The URL of the content, from the quicklink and domain.
• @appSubscriptionNames@—Comma separated list of subscriptions that a user selected.
• @appComment@—The comments for the content block.
• @appSubmitterFirstName@—The first name of the user who submitted the content block.
• @appSubmitterLastName@—The last name of the user who submitted the content block.

Creating the “From” Addresses

Web Alert emails must have a “from” address.

1. Go to Settings > Configuration > Web Alerts > Email From List.
2. Click New > Email From.
3. Enter an email address to be used in the "From" field of Web Alert messages.
4. Click Save.

Creating the Default Message Text

1. From the Workarea, choose Settings > Configuration > Web Alerts > Messages.
2. Click Add Email Message.
3. Enter a Title that describes the message.
4. At the Type field, select DefaultMessage.
5. In the editor, enter the message text.
6. Click Save.

Creating the Opt Out Message Text

An Opt-Out message appears as the first line of every email. It directs the reader to the Unsubscribe message at the bottom. Here is an example:

You have subscribed to receive alerts from the Ektron email alert system. 
  See below for removal instructions.

You can add variables to the Opt Out text. See Also: Including Variables in the Message

1. Go to Settings > Configuration > Web Alerts > Messages.
2. Click Add Email Message.
3. Enter a Title that describes the Opt-Out message.
4. At the Type field, select OptOut.
5. In the editor, enter the message text.
6. Click Save.

Creating the Unsubscribe Message Text

An Unsubscribe message lets an email recipient remove himself or herself from the subscription list. You can add variables to the Unsubscribe text. See Also: Including Variables in the Message

1. Go to Settings > Configuration > Web Alerts > Messages.
2. Click Add Email Message
3. Enter a title that describes the Unsubscribe message.
4. At the Type field, select OptOut.
5. In the editor, enter the message text.
6. Click Save.

Changing the Subscriptions Label

By default, the label Subscriptions appears on the screen. To change it to something more helpful, such as Select Areas of Interest:

1. In the Workarea, go to Settings > Configuration > Custom Properties.
2. In the Object Type field, select User.
3. Click Subscriptions.
4. Edit the Label field.

Editing a Subscription for a Multi-language System

When you create a subscription, a version is created for every enabled language. You can edit the subscription name and Enabled value for any language, but cannot change the ID number.

1. Choose Settings > Configuration > Web Alerts > Subscriptions.
2. From the View Languages drop-down list, select the language into which you want to translate the subscription.
3. Click the subscription that you want to translate.
4. Click Edit.
5. In the Name field, enter the translation for the subscription name. If desired, you can check or uncheck the Enabled checkbox. Only enabled subscriptions appear.
6. Click Update.

Assigning a Web Alert to a Folder

To modify folder-level Web Alert information:

1. Go to the folder whose Web Alert information you want to edit and click View > Properties.
2. Click the Web Alerts tab. The Web Alert options appear.
   —Image—

   

   • Inherit parent configuration—To inherit Web Alert settings (described below) from this folder’s parent folder, leave this box (Break Inheritance) checked.
   • To assign custom Web Alert settings for this folder, uncheck this box and use the fields below.
   • Restore Web Alert inheritance to the content in this folder—Check this box if Web Alert inheritance has been broken for some content in the folder, and you want to restore inheritance. If you do, all folder content uses the Web Alert properties applied to this folder.
   • Options—Check when Web Alert emails are sent as content in this folder is published.
     • Notify Always—send email whether content is being published for the first time or updated
     • Notify Only on Initial Publication—send email only the first time content is published. After that, email is not sent.
     • Notify Never—email is never sent for content in this folder.
   • Web Alert Subject—Enter the email's subject line.
   • Web Alert email From Address—Select the address from which email for this folder is sent. See Creating the “From” Addresses.
   • Web Alert Contents—Check the following components to determine the email text.
     • OptOut Message—see Creating the Opt Out Message Text.
     • Use Default message—see Creating the Default Message Text.
     • Use Summary—include the content summary in the email
     • Use Content—You may include Ektron content in the email.

       NOTE: If the content item is an Office document or a managed file, a link to that item appears within the email, not the item itself.

       • To select existing content, click Select next to the Use Content checkbox. Then, navigate to the content item.
       • To select the content whose creation or change triggers the Web Alert, click Use Current.
       • To create new content to be inserted into the Web Alert message for this folder, click Select next to the Use Content checkbox. When the folder navigation window appears, click Add Content. Then, see Creating New Content.
   • Unsubscribe message—See Creating the Unsubscribe Message Text. The components appears within the email in the order listed above.
   • Available Web Alerts—All enabled subscriptions set up in the Subscriptions screen appear. Check those to be notified when content in this folder is added or updated. See Also: Creating a Subscription

     IMPORTANT: If you uncheck all subscriptions, you disable the Web Alert feature for this folder and all of its content, even if unique subscription information is assigned to content within the folder.

Assigning a Web Alert to Content

To set a Web Alert for a content item, break the inheritance from its folder. From then on, the content’s Web Alert settings are independent of the folder’s settings.

IMPORTANT: If all subscriptions are unchecked for a folder, the Web Alert feature is disabled for all content in the folder. This applies even if unique Web Alert information is assigned to content.

1. Go to the folder that contains the content.
2. Click the content. The View Content screen appears.
3. Click Edit.
4. Click the Web Alerts tab. The Web Alert settings for the content appear.

   NOTE: The Web Alerts tab only appears if required messages, “from” email addresses, and at least one subscription are assigned to the content’s folder.

   —Image—

   

   • Options—Check when Web Alert emails are sent as this content is published.
     • Notify Always—send email whether content is being published for the first time or updated
     • Suspend Next Notification (override)—check this box to suspend the next email to be sent for this content. You might use this feature if you noticed a small error in the content and don’t want to notify subscribers that the page was updated.

       NOTE: - This setting only applies until the next time this content is published. When that happens, this box is automatically unchecked.

     • Notify only on Initial Publication—send email the first time content is published. After that, email is not sent.
     • Send Next Notification (override)—send email to all subscribers the next time this content is published. Use this checkbox to send a one-time mailing to all subscribers about content that was already published.

       NOTE: - This setting only applies until the next time this content is published. When that happens, this box is automatically unchecked.

     • Notify Never—email is never sent when this content is published.
   • Subject—Same as for a content folder.
   • email From—Same as for a content folder.
   • Contents—Same as for a content folder.
   • Available Alerts—Only Web Alerts assigned to the folder appear. Check ones that you want to assign to this content item.

Restoring Folder-level Web Alert Settings to Content

If you customize Web Alert settings for content and later decide to standardize the settings for all content in a folder, use the Restore Web Alert Inheritance checkbox on the folder properties Web Alerts tab. This action copies the folder's Web Alert settings to every content item in the folder, replacing any content-level settings.

Previewing the Email Message

To preview the email message, click Preview () on the Web Alerts tab.

Verifying a New Subscriber

A person that signs up for a subscription but has not yet been verified appears on the View Not Verified Users screen at Workarea > Settings > Community Management > Memberships > Users not Verified. You can activate accounts by selecting users then clicking ActivateUsers. Alternatively, you can delete members by selecting and clicking Delete ().

NOTE: The ek_PageSize setting in the web.config file determines the maximum number of users that can appear on a page before adding another page with the following navigational links: 
Page 1 of 2 [First Page] [Previous Page] [Next Page] [Last Page]

To select all members, click the check box next to Username.

You can also change the way membership users are sorted, or use the Search button to find users that match your criteria (for example, users whose username includes example.com.)

Customizing the Verification Message

By default, Ektron supplies a generic message that asks the subscriber to confirm the password and directs the person to your website's activateuser.aspx page. To customize that message:

1. Go to Workarea > Settings > Community Management > Messages.
2. Click Add Email Message.
3. Assign a title to the message, such as Verification Message.
4. In the Type drop-down, select Verification.
5. Click the check mark in the Default box.
6. In the Subject field, enter a subject line for the message.
7. Enter the message. You must insert the @appQueryLink@ variable in the message to create a link to the confirmation page. For example:

   Welcome to example.com. You registered to be notified of updates
   to our site. Before we can do this, you need to activate your 
   account. To do so, please visit @appQueryLink@.

   The @appQueryLink@ variable gets resolved as follows (one line):

   http://sitepath/workarea
     /activateuser.aspx?uid=[username]&acc=[accountID]

   For example (one line):

   http://www.example.com/Workarea
     /activateuser.aspx?uid=john.edit@example.com&acc=ce5w84o936477

   You can insert the following membership variables into the confirmation message.

   • @appEmail@—email address
   • @appActivateId@—Account ID
   • @appUserName@—UserName
   • @appFirstName@—First name
   • @appLastName@—Last name
   • @appDisplayName@—Display name
   • @appAvatar@ —Avatar
   • @appSignature@—Signature

Setting Up Other Subscriber Actions

You can set up other Web pages that let subscribers perform these actions:

• Activate their account
• Reset their password
• Unsubscribe

To create these pages, place a Membership server controla server control uses API language to interact with the CMS and Framework UI to display the output. A server control can be dragged and dropped onto a Web form and then modified. on the page. Then use its DisplayMode property to determine the kind of screen you want to place. For example, to create a screen that lets the user reset a password, set the control’s DisplayMode property to ResetPassword. See Also: Membership server control

Subscribing a CMS User

CMS users can subscribe to any subscription list. This is particularly useful on an intranet where, for example, employees are notified when job-related information is updated.

Another example is your internet site. The Marketing manager can sign up to be notified whenever Marketing content is added or updated. To do so, go to Settings > Users > Edit User > Custom tab.