Tool Mentor: Define Change and Review Notifications

Purpose

This tool mentor tells how to set up ClearQuest to notify users or user groups when a change request status has changed.

Related Rational Unified Process step:  Define Change Review Notification Protocols

Overview

This Tool Mentor is applicable when running Windows NT 4.0.

Configuration managers can configure ClearQuest to notify selected users about new and modified change requests. As administrator, you are responsible for designating the actions that cause an e-mail notification to be sent. For each action, configuration managers must write a notification hook that creates the e-mail message.

Within the ClearQuest client application, users must configure their own e-mail settings to enable ClearQuest’s e-mail notification feature.

Tool Steps for creating e-mail actions with the ClearQuest Designer

Sending e-mail messages from ClearQuest is accomplished through the use of hooks. To send an e-mail message when an action is completed, you can modify the notification hook of the desired action. In your hook code, you use the ClearQuest API to create the message and send it.

• To create an e-mail notification hook for an action, do the following: THESE STEPS WILL CHANGE.

1. In the ClearQuest Designer Workspace, expand Record Types or Record Types -Stateless section until you see the appropriate Actions table.
2. Double-click the Actions table to view the actions.
3. Select the action you want to modify and choose Edit > Properties. ClearQuest Designer displays the properties dialog for that action.
4. In the Hooks tab, select ACTION_NOTIFICATION and click Script. ClearQuest Designer displays the script for the action’s notification hook.
5. Add your hook code. Click Compile Script to compile your code and verify that there are no syntax errors. Click OK to exit the script editor and save your changes.

Tool Steps for setting up e-mail notification within ClearQuest

(Workers) can set up e-mail options to take advantage of any automatic e-mail notification that the configuration manager has set up. This e-mail notifies users when the database has changed. For example, within ClearQuest’s default application, users receive e-mail each time a record is assigned to them.

1. Choose File > E-mail Options. This opens the E-mail Setup dialog.
2. Mark Enable E-mail Notification.
3. Enter the SMTP host address of your mail server.
4. Enter your e-mail address.
5. Choose OK.