Designing and Managing Behavior Models - Alarm Actions - Notes -
Microsoft Mail      Paging

Notes

Whenever you create an alarm, you can -- and should -- create notes that document the alarm. Generally, this documentation should accomplish the following goals:

• Explain the purpose of the alarm
• Briefly describe the alarm's states and transitions
• List the polls, masks, and alarms that fire triggers that can affect the alarm
• Describe the actions that take place during alarm transitions, especially Fire Trigger and Perl Subroutine actions
• Document any programs or scripts that are called via a Command action
• Name any reports that are run against data logged by the alarm
• Explain any customization required to work with the alarm

Using the Notes alarm action you can cause an alarm's notes to be displayed by a behavior model. The notes are displayed in the Alarm Definition Notes window when the transition with which the Notes action is associated occurs. For example, adding a Notes action to the first transition in the predefined alarm IfDataLogger would cause the notes in Notes for IfData_LogToFile Alarm to be displayed whenever that transition occurred:

Notes for IfData_LogToFile Alarm

 
  To add the Notes alarm action to a transition:

1. From the Transition Definition window, select the New Action button.

   A pop-up menu listing all alarm actions is displayed.

2. Select Notes from the pop-up menu.

   The Notes action is added to the list of actions in the Transition Definition window.

3. Select the OK button in the Transition Definition window.
4. Select the Save button in the Alarm Definition window.