AlarmPoint for BMC Impact Manager

Copyright xMatters, inc. 1994-2010 Confidential & Proprietary

Validation Date December 3, 2010 Version 2.1.1

Contents
1. Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1
SUMMARY . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1 Benefits of the AlarmPoint BMC Impact Manager Integration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1 Architecture . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1 Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2 KEY FEATURES . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2 INTEGRATION COMPONENTS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3 User Synchronization Module . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3 AlarmPoint Notification command files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3 AlarmPoint Action Script Set for BMC IM . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5 AlarmPoint Voice Recordings for BMC IM . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5 AlarmPoint Java Client Integration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5 SYSTEM REQUIREMENTS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5 Preliminary Requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5 Component Requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6 Operating System Requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6 Planning . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6 CONVENTIONS & TERMINOLOGY . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6 Conventions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6 Terminology . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7

2. Installation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8
ALARMPOINT SYSTEM . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8 Installing the AlarmPoint Java Client . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8 Installing AlarmPoint . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8 Installing the AlarmPoint Developer IDE . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8 BMC IMPACT MANAGER . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8 INTEGRATION FILES . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8 BAROC and Rule Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9

3. Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10
CONFIGURING ALARMPOINT . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10 Importing the AlarmPoint script package . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10 Modify the default callout scripts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10 Installing Voice Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11 Defining an Event Domain . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12 Setting up a two-way Device . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12 Installing the Subscription File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13 Configuring the Subscription Panel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13 CONFIGURING ALARMPOINT JAVA CLIENT . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18 Deploy AlarmPoint Java Client Integration Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19 Configure the APAgent.xml . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19 Set the BMC IM Environment Variables for the APAgent in Unix . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20 CONFIGURING BMC IMPACT MANAGER . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20 Deploying AlarmPoint Integration files in BMC IM . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20 Configuring Notifications in BMC Impact Manager . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25

4. Software Component Integration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27
INTEGRATION FEATURES . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27 Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27 Automatic Notifications . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27 Manual Notifications . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30 Stop Notifications . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36 Pager Notification . . . . . . 50 Fail-safe Configuration Variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47 ALTERING THE DURATION OF EVENTS . . . . . . . . . Testing the Integration . . . . . . . . . . . . . . . . 54 IF AN EVENT IS NOT PROPAGATED TO ALARMPOINT . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 56 10. . . . . . . Configuration Variable Reference . . . . . . . . . . . . . . . . 33 TYPES OF NOTIFICATIONS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50 LOCAL CONFIGURATION VARIABLES . . . . . 51 8. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46 ADDING DATA ELEMENTS . . . . . . . . . . . . . . . . . . . . . . . . . . . 45 TESTING THE SUBSCRIPTION . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49 7. . 46 ADDING ANNOTATION MESSAGES . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Optimizing and Extending the Integration. . . . . . . Troubleshooting. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 54 IF A WEB SERVICE AXIS FAULT OCCURS DURING USER SYNCHRONIZATION . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48 KNOWN ISSUES . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .Contents Standard Actions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37 Phone Notification . . . . . . . . . . . . . . . . . Contact Us . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48 Generating FYI notifications for Subscriptions . . . . . . . . . . . . . . . . . . . . . . . 39 RESPONDING TO A NOTIFICATION . . . . . . 50 FYI and Subscription Notification Variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45 6. . . . . . . . . . . . 36 Email notification (includes HTML email and BES) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32 History . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39 CREATE A NOTIFICATION . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51 GLOBAL CONFIGURATION VARIABLES . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 54 IF THERE ARE ERRORS DURING INSTALLATION . . . . . . . . . . . . . . . . . . . . . . . . 48 CONSTRUCTING BES AND HTML EMAIL NOTIFICATIONS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47 FYI NOTIFICATIONS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31 Responses for FYI Notifications on Voice-capable Devices . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50 Alert Configuration Variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 54 9. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 57 | ii . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42 VERIFYING THE RESPONSE . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49 UNINSTALLING . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37 Text Phone Notification . . . . . . . . . . . . . . Copyright . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32 AlarmPoint Data & the User Synchonization Module . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46 CHANGING RESPONSE CHOICES . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46 FILTERING AND SUPPRESSION OF EVENT DATA . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38 5. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

depends on the number of messages to be processed. AlarmPoint will interact with Impact Manager to execute that action for them in real-time. by using the integration to BMC IM. every notification. and sends them to the AlarmPoint Java Client. 1. the user can also add additional notes to the event by typing freeform text in the email response. the appropriate technician can be notified directly via voice.AlarmPoint for BMC Impact Manager 1. AlarmPoint can automatically update an incident ticket throughout the process. assigning. With the AlarmPoint integration.2 Architecture The following diagram provides a high-level overview of the major components for this integration: Summary | 1 . The AlarmPoint Java Client forwards the events to AlarmPoint.1 Benefits of the AlarmPoint BMC Impact Manager Integration Event Management and Service Impact Management has typically been handled by Operation staff monitoring the Impact Explorer console or receiving basic email notifications. In addition. In addition. The AlarmPoint product features a self-service web user interface to allow accurate assignment of responsible personnel for each job. During the process. 1. When the user responds to the notification using a two-way device. If an email device is being used. AlarmPoint Java Client processes the response and sends it to BMC IM. the ability to take simple actions on the event from any device gives the event resolver a quick way to deal with many issues and communicate to other team members the current status of the event. closing the event. and action is logged in AlarmPoint. 1.1 Summary With persistent buffering. you can send events from BMC IM to AlarmPoint and receive notification status from AlarmPoint to BMC IM without losing any information in the transfer process. BMC IM processes the events it receives. pager. The benefit is that this process is immediate – significantly faster than the time required for Operations staff to notice the failures or malfunctions. or other device. running remote diagnostics and retrieving event details. configuration. Once an action is selected on their remote device. running select applications. response. determine who is on call. which updates the status of the event based on the user response. Information about the failure will be presented to the event resolver and decisions can be made in real-time such as acknowledging. These integration notes are intended for administrators and other technical readers. and manually notify the right person. email.1. The time taken to process messages in the buffer. which notifies the user on the specified notification device. installation.1. Introduction This document defines software requirements. and integration demonstrations for using BMC® Impact Manager with the AlarmPoint® software suite.

AlarmPoint routes notifications to the appropriate users on any device. If more than one cell has to be integrated with AlarmPoint. 1. You can use AlarmPoint for BMC IM to synchronize events and notification status between BMC IM and AlarmPoint. AlarmPoint for BMC IM assumes that there is only one cell to be integrated with AlarmPoint. AlarmPoint for BMC IM provides the ability to notify AlarmPoint users on any device if an event in BMC IM meets the notification criteria.1. BMC IM provides the core functionality for event management and service impact management. only one cell is used for integration with AlarmPoint.AlarmPoint for BMC Impact Manager Figure 1-1. Even if there is more than one cell running on a machine.3 Overview AlarmPoint Adapter for BMC Impact Manager (AlarmPoint for BMC IM) integrates BMC Impact Manager (BMC IM) and AlarmPoint and enables bi-directional flow of information between them.2 Key Features The following list identifies the key features of AlarmPoint for BMC IM: • Sending automatic notifications to AlarmPoint Users or Groups based on the notification criteria. If you need to notify AlarmPoint about the events in cell_b and cell_c. then the events from cell_b and cell_c should be propagated through cell_a. Example: Assume that a machine has the following cells: • • • cell_a cell_b cell_c Propogation Rule Integration is installed only for cell_a. AlarmPoint for BMC IM Architecture 1. then the other cells must propagate events through the integrated cell. On a single machine. AlarmPoint for BMC IM also enables AlarmPoint users to interact remotely with BMC IM through twoway devices to update an event status or fix problems. Key Features | 2 . Note: Events can be sent to AlarmPoint only from the cell where AlarmPoint for BMC IM is installed.

1.bat AlarmPoint_FYI. the module does not add or delete a corresponding User or Group in BMC IM.3 Integration Components Each of the executable and tar files for AlarmPoint for BMC IM contains the following components: • • • • • • BAROC and Rule files (kb files) AlarmPoint Notification command files AlarmPoint Action Script set for BMC IM AlarmPoint Voice Recordings for BMC IM AlarmPoint Java Client components (executable and configuration files) and XML integration files User Synchronization Module 1. It also uses a set of log files for the synchronization of BMC IM and AlarmPoint. the module adds or deletes the corresponding User or Group in AlarmPoint. pagers.bat The syntax for AlarmPoint. if a User or Group is added to or deleted from BMC IM.bat file for those cells running the Windows operating system.AlarmPoint for BMC Impact Manager • • • • • • Defining notification criteria independent of the notification method.3. These calls supply the parameters required to inject events into the AlarmPoint Java Client Agent and AlarmPoint. Ignore and Annotate on two-way devices. and email. email. For example. and BlackBerry® devices. or to stop notifications. 1. mobile phones. SMS devices.bin. Providing standard actions such as Acknowledge.sh file for cells running the UNIX operating system and the UserSync.txt %1 Integration Components | 3 .3.1 User Synchronization Module The User Synchronization module synchronizes and updates the number of Users or Groups in BMC IM and AlarmPoint.bat StopNotification.2. Close. 1.2 AlarmPoint Notification command files AlarmPoint for BMC IM includes three command files which contain the command line interface that calls bmc_apclient. Notifying AlarmPoint to stop the notification process when certain user-defined events occur in BMC IM. the following files should be copied into the \kb\bin\w4 directory of the integrated cell: • • • AlarmPoint. which includes wired phones. Assign.bat is: C:\APAgent\bmc_apclient.bin and APClient. Buffering event messages sent to AlarmPoint Java Client and BMC IM to prevent data loss in case of a temporary loss of connectivity. The twoway devices comprise phone. Note that this functionality is one-way: if a User or Group is added to or deleted from AlarmPoint. Custom actions in Impact Explorer for manual notifications or stopping existing notifications. two-way pager.bin --submit-mapping-file C:\APAgent\BMCxAP.3. This module uses the UserSync. Custom Collectors for displaying events that generated AlarmPoint notifications.1 Windows command line interface files For Windows systems.

The syntax for StopNotification is: /opt/alarmpointsystems/APAgent/APClient.txt) contain the parameter list used for creating tokens for the AlarmPoint events.txt %1 StopNotification.2.txt and BMCxAP_FYI. the following files should be copied into the /kb/bin/A directory of the integrated cell: • • • AlarmPoint AlarmPoint_FYI StopNotification The syntax for the AlarmPoint file is: /opt/alarmpointsystems/APAgent/bmc_apclient.txt $1 AlarmPoint_FYI has a similar syntax but takes another file as an argument (opt/alarmpointsystems/APAgent/ BMCxAP_FYI.3.bin --map-data del ${event_handle} 1.txt has the following content: apagent_method="Add" apagent_subclass="Event" agent_client_id="bmcimxap" domain="bmcimxap" person_or_group_id=#3# severity=%severity% incident_id=%event_handle% sim_cell=%CELL_NAME% host_address=%mc_host_address% client_address=%mc_client_address% mc_host=%mc_host% mc_object=%mc_object% mc_object_class=%mc_object_class% mc_parameter=%mc_parameter% mc_tool=%mc_tool% mc_tool_class=%mc_tool_class% Integration Components | 4 .AlarmPoint for BMC Impact Manager AlarmPoint_FYI.2.bat contains the command required to delete previously created events and stop all associated notifications.bin --submit-mapping-file /opt/ alarmpointsystems/APAgent/BMCxAP.bin --map-data del %event_handle% 1. which is used to generate one-way notifications.bat is: C:\APAgent\APClient.3 Text files The text files used as arguments (BMCxAP. which is used to generate one-way notifications.bin --submit-mapping-file opt/ alarmpointsystems/APAgent/BMCxAP_FYI. Use the notification service set up with this command if you want to implement a “one-way” only integration with AlarmPoint: C:\APAgent\bmc_apclient.3. Use the notification service set up with this command if you want to implement a “one-way” only integration with AlarmPoint: /opt/alarmpointsystems/APAgent/bmc_apclient.txt $1 StopNotification contains the command required to delete previously created events and stop all associated notifications.txt).txt). BMCxAP. The syntax for StopNotification.2 Unix/Linux command line interface files On Unix/Linux systems.bat has a similar syntax but takes another file as an argument (C:\APAgent\BMCxAP_FYI.bin --submit-mapping-file C:\APAgent\BMCxAP_FYI. For example.

which is the integration configuration for the AlarmPoint Java Client.bin. 1. 1.exe. this section includes a set of questions that you can use to help plan the installation at your site. AlarmPoint Java Client. For more information about working with scripts in AlarmPoint. The list can be extended. the scripts perform a corresponding action such as Acknowledge. 1.txt. This directory contains the voice prompts used by the AlarmPoint Integration for BMC IM. Ignore.3.3.txt file is parameter #3 The parameters within % characters represent event slots in Impact Manager. refer to the AlarmPoint Developer’s Guide & Scripting Reference. in which case the AlarmPoint scripts for the BMC Impact Manager integration need to be modified as well. When users respond to the notification.xml file. pager. you must copy the content of the \vox directory to the appropriate location on the AlarmPoint Node. 1.txt and BMCxAP_FYI. 1.0. When an AlarmPoint User responds to a notification.3. Note that the first parameter after the . instant messaging. The AlarmPoint Primary or AlarmPoint Failover can be on a different machine. the response action script contained in BMC-Impact-Manager. and AlarmPoint for BMC IM must be installed on the same machine.5 AlarmPoint Java Client Integration AlarmPoint Java Client Integration contains an executable.4.xml executes the response and updates the corresponding event in BMC IM.1 Preliminary Requirements BMC IM.4 System Requirements This section provides information about the requirements and computing environment conditions that you should consider as you plan to install AlarmPoint for BMC IM.AlarmPoint for BMC Impact Manager causes=%mc_smc_causes% effects=%mc_smc_effects% message=%msg% priority=%mc_priority% status=%status% event_class=%class% There are three types of parameters: • • • strings: value contained within double quotes: “value” environment variables: variable name contained within % characters: %variable_name% command line parameters: parameter position contained within # characters: #n# (for the nth parameter). System Requirements | 5 . Assign. and two configuration files. which is the Action Script package that has to be imported into AlarmPoint. This file includes a set of scripts for managing the notification process and creating notifications to devices such as e-mail. BMCxAP.aps file. In addition to the detailed information. and phone. For custom modifications of the scripts. Note or Close. Importing the script set into AlarmPoint requires the AlarmPoint Developer IDE. AlarmPoint for BMC IM also includes the BMC-Impact-Manager. refer to the AlarmPoint Developer’s Guide & Scripting Reference or contact AlarmPoint Professional Services.4 AlarmPoint Voice Recordings for BMC IM If you are planning to use the integration for notifying voice phones.3 AlarmPoint Action Script Set for BMC IM AlarmPoint for BMC IM comprises the BMC-Impact-Manager-2. bmc_apclient. BMC Impact Web Services Server.

0 or later 1. directory and file names. or 7. AlarmPoint Java Client must be installed as a service and not as an executable.2 or later AlarmPoint Java Client version 4.4. for example.x BMC Impact Web Services Server 2. with a valid Extended Web Services license Perl version 5.11 (PA_RISC) Solaris 10 AIX 5.AlarmPoint for BMC Impact Manager In Windows.5 Conventions & Terminology This section describes how styles are used in the document.0 or later AlarmPoint version 4. 5. 1.0 or later. Conventions & Terminology | 6 .4. and provides a list of definitions.2 Component Requirements The following components must be installed prior to installing the integration: • • • • • BMC Impact Manager version 4. Words in monospace font represent the following: • • text that must be typed into the computer.1 Conventions Some instructions appear in the following format: MENU > OPTION.5.4 Planning Use the questions in this section to record information that you will need to provide during the installation and configuration process.8.3 Linux 1.x.x.4. 1.3 Operating System Requirements The following platforms are supported: • • • • • • Windows 2003 Server Standard Edition Windows 2000 Server Service Pack 3 HP-UX 11. and then click the Open menu option. Words in bold typically reference text that appears on the screen. File > Open means click the File menu. • • • • • What is the name of the BMC IM Cell that will be used for AlarmPoint for BMC IM? What is the path of the AlarmPoint Java Client installation? What is the IP address or host name of the primary AlarmPoint server? What is the IP address or host name of the failover AlarmPoint server? Which AlarmPoint recipients (Users or Groups) should AlarmPoint for BMC IM notify? 1.

5. etc.).). The Management System uses this to communicate with the AlarmPoint Agent. the following definitions apply: Term AlarmPoint Admin AlarmPoint Agent AlarmPoint Client AlarmPoint Application Server Node AlarmPoint Java Client AlarmPoint Notification Server Node AlarmPoint System AlarmPoint Web User Interface Management System Alert Device Meaning Administrative tool to control AlarmPoint Agent. Windows users must substitute the given paths with the Windows equivalents.g. Communication layer between third-party applications (e. and the AlarmPoint Client (both Java and native versions) Delivers notifications to a person in a variety of ways (pager. Conventions & Terminology | 7 . Umbrella term for all AlarmPoint software components. phone. A generic term for BMC IM.. AlarmPoint Bridge.AlarmPoint for BMC Impact Manager Note: Except where explicitly stated. AlarmPoint Agent.2 Terminology With respect to the AlarmPoint System. On Windows systems. BMC Patrol Enterprise Manager) and AlarmPoint. phone. pager. consisting of various components that process events and perform notifications. Umbrella term for the AlarmPoint Admin. on Unix systems. 1. Browser-accessible interface for controlling AlarmPoint components and information. e-mail. For example. etc. The core AlarmPoint application. it is typically installed in the default directory. Item of interest that typically generates a notification for a User or Group. the AlarmPoint Java Client is typically installed in /opt/alarmpointsystems/APAgent. Medium through which a User is contacted (e-mail. C:\APAgent. the directory paths in this document are listed in Unix format.

To install the integration files: Extract the AP-BMC-IM archive to access the integration files. 2.1 Installing the AlarmPoint Java Client The AlarmPoint Java Client is the communications bridge between the BMC IM applications and the rest of the AlarmPoint System.1.aps | | |-.AlarmPoint for BMC Impact Manager 2. It allows BMC IM to inform the AlarmPoint System when a problem occurs.3 Installing the AlarmPoint Developer IDE For installation instructions. For installation instructions. 2.components | |-. It must be installed on the BMC IM machine and on each BMC IM computer.scripts | | | ‘-. The significant files and directories of the archive are as follows: . Installation This chapter provides information about the installation and uninstallation of AlarmPoint for BMC IM on cells running the Windows or UNIX operating systems.1.AP-BMC-IM. 2.1. refer to the AlarmPoint Installation and Administration Guide.1 AlarmPoint System This integration requires the following AlarmPoint applications to be installed: • • • AlarmPoint Java Client AlarmPoint AlarmPoint Developer IDE 2. refer to the AlarmPoint Developer's Guide & Scripting Reference. see “System Requirements” on page 5.jsp | | '-.vox AlarmPoint System | 8 . 2.alarmpoint | | |-.2 Installing AlarmPoint For installation instructions. ensure that the cell on which you want to install AlarmPoint for BMC IM and the AlarmPoint Java Client is started. For information about operating system requirements and software that needs to be installed before installing AlarmPoint for BMC IM. 2. |-.3 Integration Files Before you begin the installation. refer to the AlarmPoint Java Client Guide.2 BMC Impact Manager Consult the appropriate BMC Impact Manager guides for instructions on how to install and configure.sub_panel | | | ‘--BMCIMSubscriptionForm.

3.release-notes.txt | | ‘-.windows | | |-.BMCxAP.txt | |-.xml | | |-.BMC-Impact-Manager.AP-BMC-IM.AP Command Files | | |-.AlarmPoint for BMC Impact Manager | | ‘-. All files with a .mrl: a rule file for stopping notifications in AlarmPoint.baroc: defines the notification policy templates to be used as a starting point for AlarmPoint notification policies.alarmpoint-java-client | | |-. ap_notification_policy. It associates an existing event in BMC IM and sends information to AlarmPoint for deleting the action record. ap_actions. and then reinstall the upgraded version.Linux | | |-. ap_collector.BMCxAP_FYI.pdf ‘-.baroc: contains the AP_EVENT event class and the slot definitions that are used in adapting event information obtained from AlarmPoint into the format that a cell can understand and process. When an AlarmPoint user responds to a notification. you must first remove all the components of the existing installation. ap. These files also reside in the Knowledge Base.baroc: defines ALARMPOINT_USERS and ALARMPOINT_GROUPS data classes (required for user synchronization).APII | | ‘-.txt Note: If you want to upgrade an existing version of AlarmPoint for BMC IM.baroc: defines the data tables containing notification services for AlarmPoint. ap_associate. ap_notification_service.1 BAROC and Rule Files AlarmPoint for BMC IM contains seven files to be deployed in the BMC IM Knowledge Base: • • • • • • • • ap_classes.AIX | | |-.baroc extension contain event class and slot definitions for each class. ap_data.mrl: creates menu commands in the Remote Actions submenu in BMC Impact Explorer for sending manual notifications and manual stop notifications to AlarmPoint.SUN-SOLARIS | | |-.bmc-impact-manager | | |-.mrl: a rule file for updating the status of BMC IM events that are sent to AlarmPoint. It is required for displaying the BMC IM events that are sent to AlarmPoint.HP-UX-RISC | | |-. this file updates the status of the corresponding event in BMC IM.english | |-. 2.documentation | ‘-.mrl: a rule file for creating the AlarmPoint collector. Note: Integration Files | 9 .kb |-.

Configure AlarmPoint 2. click OK. 3. complete the following steps: 1. Configure AlarmPoint Java Client 3. 3. Select the AP-BMC-IM. After you have installed AlarmPoint for BMC IM. and configure the database connection (refer to the AlarmPoint Developer IDE Help or the AlarmPoint Developer’s Guide & Scripting Reference for details). 3. In the Validation dialog box.aps file extracted from the integration zip file into the following folder: • AP-BMC-IM\components\alarmpoint\scripts\ 4. Right-click the BMC Impact Manager (Business) folder.AlarmPoint for BMC Impact Manager 3. Install the voice files. Set up a User with a two-way Device. Configuring AlarmPoint | 10 . 6. 5. and then click OK again. 9. Import the AlarmPoint script package. 2. and then click Close. In the Check In dialog box. and then click Check In. Define an Event Domain.1.2 Modify the default callout scripts The default callout scripts are not configured to annotate the ticket. Close the IDE. Configuration This chapter explains how to configure AlarmPoint for BMC IM. In the Script Package dialog box.1 Configuring AlarmPoint To configure AlarmPoint. and must be updated to for BMC IM. click Create. Configure BMC Impact Manager 4. 10. Launch the Developer IDE. In the File dialog box. select Validate.1. 7. refer to the AlarmPoint Developer’s Guide & Scripting Reference. 2. Configure Notifications in BMC IM Ensure that you have completed all of the tasks before you start using AlarmPoint for BMC IM. Right-click the BMC Impact Manager (Business) folder. click Close. 3. 8.1 Importing the AlarmPoint script package This step requires the AlarmPoint Developer IDE. Click Workspace > Import. To import the AlarmPoint Script Package: 1. you must complete the following tasks in the order listed: 1. For installation instructions. 3. 4.

Add the following lines of at the end of both scripts: SendAnnotationMessage: IF( $initiatingEvent.message GOSUB SendAnnotationMessage 3. 5. Open the AlarmPoint Developer IDE.agent_client_id == "bmcimxap" ) @session::respondToNotification( $notId. For more information.message = "Callout to " & $targetName & " successful (" & $result & "). Add the following lines after the message is added to the ServiceMessage object. "callout_annotate " & $message_note ) ENDIF RETURN Note: If the SendAnnotationMessage is already in the callout scripts due to another integration. 4. Locate the code section that sends an ExternalServiceMessage. refer to the AlarmPoint Installation and Administration Guide. Repeat the previous two steps for each section that sends an ExternalServiceMessage. Configuring AlarmPoint | 11 . Open the callout CONTACT script and the authenticate INTERACTION script.message GOSUB SendAnnotationMessage 7. Copy all of the files in the AP-BMC-IM\components\alarmpoint\vox\english folder from the extracted integration zip file to the following node installs folder: AlarmPoint\node\phone-engine\Datastore\domains\common\recordings\english\phrases Note: This integration provides only English voice files. and after the send method is executed on the object: $message_note = $connectionEventMessage. 2. Check out the Production Callout Script Package." @connectionEventMessage::send() $message_note = $connectionEventMessage. Example: The following is an example of an enhanced segment of code: $connectionEventMessage. 3. Note: There should be a total of 10 code segments that require updatin: eight in the callout script.1.3 Installing Voice Files These files must be installed into an AlarmPoint deployment running a Voice Device Engine. To install the voice files: 1. update it with logic to handle when the agent_client_id equals “bmcimxap”. and two in the authenticate script. 6.AlarmPoint for BMC Impact Manager To annotate a BMC IM incident from the Callout scripts: 1.

Log out of AlarmPoint. click User Devices. Log in to AlarmPoint as a Company Administrator. 7. 5. 3. 4.1. click S. create a User with a User ID of “bsmith” and add a Virtual Text Phone Device for the User. 5. this integration is configured to use a default demonstration User named “Bob Smith” as a target for notifications from AlarmPoint for BMC IM. To define an Event Domain: 1.5 Setting up a two-way Device By default. the Event Domain name must match the Client ID of the AlarmPoint Java Client. Note: If this User is missing. On the Event Domains page. 3. click Add New. refer to the AlarmPoint User Guide. For the integration to be successful. To set up a two-way Device: 1. and click the Developer tab. 3. click Smith. Verify that a virtual text phone Device exists. Configuring AlarmPoint | 12 . in the Common Tasks pane. On the Details for Bob Smith page.AlarmPoint for BMC Impact Manager 3. Click Save. the AlarmPoint webserver must be running. On the Find Users page. Click Reorder. and click the Users tab. 8. The Event Domain name is case sensitive and must be lower case. 6. and set the virtual phone to be the first Device in the list. Click Save.1. 2. Follow the steps below to ensure that this User exists and has a two-way Virtual Text Phone Device: Note: To perform this portion of the integration. 2. Log out of AlarmPoint. Note: It is strongly recommended that you use the Event Domain Name specified above. In the list of returned Users. For more information and instructions on how to perform these tasks.4 Defining an Event Domain The AlarmPoint Webserver must be running to perform this portion of the integration. Enter the following information into the form: • • • Name: bmcimxap Description: BMC Impact Manager Integration Script Package: BMC Impact Manager 4. Log in to AlarmPoint as a Company Administrator. Bob.

Configuring the Subscription Panel requires the following steps: • • • • Note: Define the Event Domain predicates Define a Subscription Domain Create a Subscription Create a fail-safe Group Before you can configure the custom Subscription Panel. you must configure the Subscription panel. On the AlarmPoint server.2 or newer must be running on the same machine as the integrated cell (for installation details. Note: For the Subscription Panel to dynamically load Event Domain predicates. Create a subfolder named bmc\impactManager. Copy BMCIMSubscriptionForm. 4.1. the BMCIMSubscriptionForm.jsp file must be installed as described in “Installing the Subscription File” on page 13. 3.7. BMC Impact Integration Web Services Server version 2. refer to the BMC® Impact Integration Developer’s Kit Web Services Server Developer Guide). Restart the AlarmPoint Webserver. you must copy the JSP file into the AlarmPoint installation folder.7 Configuring the Subscription Panel To allow Users to subscribe to specific criteria on injected Events.1. To install the JSP file: 1.1.jsp from /components/alarmpoint/sub_panel in the extracted integration archive into the new bmc\impactManager directory. repeat the following steps for each one.AlarmPoint for BMC Impact Manager 3. 3.6 Installing the Subscription File To use the custom Subscription Panel. If you have installed more than one web server.1 Defining Event Domain predicates For the Default custom Subscription Panel provided with the integration. locate the web server installation folder: \webserver\webapps\cocoon\alarmpoint\jsp\subscription 2. the following Event Domain predicates must be defined (case sensitive): • • • • • • • • • event_class Severity Priority Status mc_object mc_object_class mc_parameter message mc_host Configuring AlarmPoint | 13 . 3.

Information. On the Event Domain Details page. Acknowledged. To define the Event Domain predicates: 1. Text predicate that corresponds to the parameter passed in with this event. On the Event Domains page. Exclude any severities that will not be submitted for notification. 3. Text predicate that corresponds to the object being monitored and the source of this event. List predicate containing some or all of the following values: Critical. Major. The items listed for Priority should be specifically chosen to match the severity of the Events forwarded from BMC IM. Exclude any statuses that will not be submitted for notification. Text predicate that corresponds to the class name of the source object for this event. click Add New. Lowest. List predicate containing some or all of the following values: High. Blackout. Open. click bmcimxap. Low. Warning.AlarmPoint for BMC Impact Manager • Note: mc_host_address You can also use the following steps to add other predicates that you consider important and which you plan to add to the integration as explained in “Adding data elements” on page 46. Highest. Severity List Yes Priority List Yes Manually entered Status List Yes Manually entered mc_object mc_object_class mc_parameter mc_host mc_host_address Text Text Text Text Text Yes Yes Yes Yes Yes Manually entered Manually entered Manually entered Manually entered Manually entered Configuring AlarmPoint | 14 . Exclude any priorities that will not be submitted for notification. List predicate containing some or all of the following values: Closed. 4. Moderate. In AlarmPoint. click the Developer tab. This list is loaded from the BMC Impact Manager by a web service call. Add the following predicates to the Event Domain Predicate event_class Type List Important Yes Values Dynamically loaded Manually entered Description List predicate containing the event classes defined for the cell that is the point of integration. Unknown. Text predicate that corresponds to the IP address of the host cell that generated this event. Text predicate that corresponds to the host name of the cell that generated this event. The items listed for Status should be specifically chosen to match the status of the Events forwarded from BMC IM. The items listed for Severity should be specifically chosen to match the severity of the Events forwarded from BMC IM. Minor. Assign. 2.

Within the Subscription JSP.1. 3. If you want to populate the predicate values lists from BMC Impact Manager through web service calls rather than using the pre-defined predicate list values. 3. 4. the scripts support two response choices: "Acknowledge" and "Ignore". type BMC IM. final String WS_PORT = "6070".7. 3.2 Defining a Subscription Domain The Subscription Domain is the reference point to the custom panel and provides a means to control certain aspects of the panel. 2. informational notifications. For more information about working with Event and Subscription Domains. you must configure the connection properties within the JSP file. 8. Click Continue. To enable two-way communications for Subscriptions. click Add Subscription Domain. To configure the Subscription JSP to automatically populate predicate lists: 1. On the Subscription Domain details page. and then click Continue. in the Name field. find the following section: final String MC_HOST_NAME = "localhost". You must create a Subscription Domain before you can create subscriptions with the new panel. select bmcimxap. If you require only one-way. add all of the predicates to the Applied Predicates list. 2. final String MC_CELL_NAME = "mcell". in the Developer menu.jsp 5. On the Select Appropriate Response Choices page.1. On the Developer tab. Note: By default. Open the BMCIMSubscriptionForm. and then click Continue. and then click Continue. 6. define both response choices on the Select Appropriate Response Choices page. In the Custom Page URL field. Configuring AlarmPoint | 15 . do not specify any response choices. specify the Roles you want to be able to create Subscriptions on the Domain. This feature allows Administrators to change the source of the content supplied for these lists from web service calls to pre-defined predicate value lists. On the Select Roles page.AlarmPoint for BMC Impact Manager Predicate message Type Text Important Yes Values Manually entered Description Text predicate that describes the event being injected.7. 7. enter the following path: jsp/subscription/bmc/impactManager/BMCIMSubscriptionForm. To create a Subscription Domain: 1. On the Select Appropriate Predicates page. and then click Save. In the Event Domain drop-down list.3 Configuring the Subscription JSP The Subscription panel reads Event Class values from BMC Impact Manager through web services.jsp found in /webservers/webapps/cocoon/alarmpoint/jsp/ subscription/bmc/impactManager folder in the AlarmPoint Webserver installation. specify the available responses for this Subscription. see the AlarmPoint Installation and Administration Guide.

in the Subscription type drop-down list. Click the Alerts tab. 7. Save and close the BMCIMSubscriptionForm. The event_class. The BMC IM web services server port number. Replace the value within quotes for each parameter as described in the following table: Parameter MC_HOST_NAME MC_CELL_NAME WS_PORT 4. Priority and Status in the Predicates list. 4. In AlarmPoint. 3. Save and close the JSP. To configure the Subscription panel in a demo mode. On the Event Domain Details page. and then click My Subscribed Alerts. On the Subscription Details page. or that match any other criteria. 6. For more information about working with Event and Subscription Domains. you must modify the Subscription JSP.AlarmPoint for BMC Impact Manager 3. Priority. and Status lists on the Subscription will now be populated with the predefined list values instead of the web service call results. 2. 2. The cell name of interest on the MC_HOST_NAME server. and set the value to false. click bmcimxap. 4.7. On the Select a Subscription Domain page. using pre-defined predicate list values. Click the Add New link above the Self-made Subscriptions table. • The Event Details tab (Ctrl-click to select more than one value): Configuring AlarmPoint | 16 .4 Creating a Subscription You can now use the Custom Subscription Panel to subscribe to BMC IM Events of specific Severity. select BMCIM. To create a Subscription: 1. click the Developer tab. Repeat steps 6 and 7 for Severity.jsp file. click event_class in the Predicates list. Add to the predicate list values. 8. specify the Subscription criteria using the Event Details and Preferences tabs. Open the SCSubscriptionForm. To manually populate the predicate lists: 1. 5. 3. see the AlarmPoint Installation and Administration Guide.jsp found in the /webservers/webapps/cocoon/alarmpoint/jsp /subscription/bmc/impactManager folder on the AlarmPoint Webserver install. On the Event Domains page. Locate the QUERY_PREDICATE_VALUES variable. 3.1. Changing Subscriptions by adding or removing Event Domain predicates may cause existing Subscriptions to fail. Note: Value The hostname or IP address for the BMC IM web services server. Severity. and then click Continue.

click Save to create the Subscription.AlarmPoint for BMC Impact Manager Figure 3-1. Subscription Details – Preferences tab 5. • You can review the Subscription details at any time on the Summary tab: Configuring AlarmPoint | 17 . When you are satisfied with the criteria. Subscription Details – Event Information tab • The Preferences tab (defines the Timeframe and Overrides applied to events for Subscription notifications): Figure 3-2.

In AlarmPoint.7. but can be configured as a User. To create a fail-safe Group: 1.1. You can also eliminate notifying any failsafe group by setting $fail_safe to disabled. The fail-safe recipient is typically a Group. 2. with at least one User as a Team member to receive notifications. and if it matches the necessary circumstances. AlarmPoint sends the notification to the fail-safe recipient. you can remove it from the action scripts by setting the $enable_subs variable to false in the configuration block of the initial script. Note: If you want to use a pre-existing group or a different group name. 3. several steps must be taken to configure it for the integration: • • • Deploying the AlarmPoint Java Client Integration Files Configure APAgent.6 Excluding Subscriptions If you do not want to use the Subscription functionality. see the AlarmPoint User Guide. 3.5 Creating a Fail-Safe Group If a notification is submitted to AlarmPoint when the fail-safe functionality is enabled.AlarmPoint for BMC Impact Manager Figure 3-3.7. Subscription Details – Summary tab 3.1. Create a new Group named BMCIM Failsafe. modify the value for the $fail_safe_group variable defined in the initial process script in the AlarmPoint Action Scripts. For more information about creating Groups and Teams.xml Set the BMC IM Environment Variables for the APAgent in Unix Configuring AlarmPoint Java Client | 18 .2 Configuring AlarmPoint Java Client Once the AlarmPoint Java Client is installed. click the Groups tab.

bin.2.append("#1"). it is strongly recommended that you create a backup copy of the APAgent.1 Deploy AlarmPoint Java Client Integration Files To deploy the AlarmPoint Java Client files: 1. Do one of the following: • • Windows: Copy bmc_apclient. Restart the AlarmPoint Java Client.xml for High Availability For integrations with High Availability BMC Impact Manager servers. where <OS> is the operating system on which BMC IM is installed. //Secondary HA server value Note: There are three instances of the code to be uncommented and modified. Restart the Java Client Service.2 Configure the APAgent. Unix: Copy bmc_apclient. 4.xml file to append the appropriate server value to the MCELL path: /*For HA servers uncomment and modify the following to append the corresponding values (#1 and #2) of your BMC IM servers. 2. locate.bin from AP-BMC-IM/components/alarmpoint-java-client/<OS> subfolder to /APAgent. Configuring AlarmPoint Java Client | 19 . and modify the “HA server value” buffer.2.txt. Note: Before making any changes.xml. uncomment. Copy the BMC-Impact-Manager.xml file located in \APAgent\etc.xml The BMC IM domain mapping must be added to the APAgent configurations file. Copy the BMCxAP. To add the domain mapping: 1.2. Add the following line to the mapping section: <alarmpoint-agent-client id="bmcimxap" filename="integrations/BMC-ImpactManager.xml" /> 3.2. Open the APAgent.xml file from AP-BMC-IM\components\alarmpoint-java-client in the extracted integration archive to \APAgent\etc\integrations.txt files from the AP-BMC-IM\components\alarmpoint-javaclient\ folder in the extracted integration archive to \APAgent. //Primary HA server value //buffer.. 2. 3.AlarmPoint for BMC Impact Manager 3. and BMCxAP_FYI.xml file and store it in a safe location. APAgent.append("#2"). 3.1 Configuring the APAgent.exe from AP-BMC-IM\components\alarmpoint-javaclient\windows to \APAgent.*/ //buffer. 3.append lines in the \APAgent\etc\integrations\BMC-Impact-Manager.

$AP_CMD refers to AP-BMC-IM\components\bmc-impact-manager\AP Command Files $AP_KB refers to AP-BMC-IM\components\bmc-impact-manager\kb $KB refers to the following folder depending on your configuration of BMC Impact Manager: Windows: • • Unix: • • Version 7.01. set the MCELL_HOME variable to the actual path.0.01: /opt/mcell/etc/$CELL/kb/ Version 7. Restart the AlarmPoint Java Client. For the BMC IM integration./APAgent or . 2.00: /opt/bmc/Impact/server/etc/$CELL/kb Version 7. Save the APAgent file and restart the Client: . Add the following lines after the declaration of the "JAVAEXEC" variable (where the <value> of MCELL_HOME is /opt/mcell for version 7. Open the file APAgent in the APAgent/ directory for editing.1. Note: If BMC IM is installed into a directory other than /opt/mcell.00: C:\Program Files\BMC Software\Impact\server\etc\$CELL\kb\ Configuring BMC Impact Manager | 20 .01: C:\Program Files\BMC Software\MasterCell\server\etc\$CELL\kb\ Version 7.3./alarmpoint-java-client restart 4.1 Deploying AlarmPoint Integration files in BMC IM The following variables refer to specific paths used within this section’s examples: • • • • $CELL refers to the integrated cell name.1.0.1. two environment variables. MCELL_HOME and PATH. and /opt/bmc/Impact/server for version 7. are required to execute certain cell actions. such as msend.3 Set the BMC IM Environment Variables for the APAgent in Unix Note: The following instructions apply only to Unix installations. 3.AlarmPoint for BMC Impact Manager 3. To set the environment variables in APAgent: 1.3 Configuring BMC Impact Manager 3.00): MCELL_HOME = <value> export MCELL_HOME PATH=${PATH}:${MCELL_HOME}\bin export PATH 3.2.0.

the default path is /opt/alarmpointsystems/APAgent/ Copy all three files to the $KB\bin\$OS folder containing the command files on the integrated cell. where $OS is specific to the platform. 2.1.AlarmPoint for BMC Impact Manager Note: For Unix installations.01: /opt/mcell Version 7. Open each file in a text editor and ensure the path of the AlarmPoint Java Client is correct.0.00: C:\Program Files\BMC Software\Impact\server\ Unix: • • Version 7. locate the command files for your operating system: • • Windows: AlarmPoint. they are located in the $AP_CMD directory. $MCELL_HOME equals the indicated folder: • Windows: • • • Version 7. In the extracted integration archive folder. Copy the components\bmc-impact-manager\APII folder from the extracted integration archive folder to $MCELL_HOME. 2.3.bat. and StopNotification By default. • • • For Windows. unless this path has been added to the $PATH variable.00: /opt/bmc/Impact/server To deploy the User Synchronization Module: 1. as identified in the following table: Directory w4 A 12 p4 s5 h1 Operating System Windows Unix Linux AIX Solaris HP-UX Note: The account under which the cell is running must have permission to execute the command files.3.0. Do one of the following: Configuring BMC Impact Manager | 21 . and StopNotification. 3.1. 3.1.2 Deploying the User Synchronization Module For the following steps.1 Deploying Command files 1. AlarmPoint_FYI.bat Unix: AlarmPoint. AlarmPoint_FYI. the default path is C:\APAgent\ For Unix.1.01: C:\Program Files\BMC Software\MasterCell\server\ Version 7.bat. commands should be executed in the /opt/mcell/bin directory.

3. Supervisor assigned to the Users being synchronized with AlarmPoint. remove the $MCELL_HOME/APII/Windows directory. Click Save. 4. 8888 Standard User superadmin SMTP Email Phone Engine US/Pacific Default Site Default Value wsUser wsPassword Note: If you are using AlarmPoint Express. remove the $MCELL_HOME\APII\Unix directory. Configuring BMC Impact Manager | 22 . 4. To set up a Web Service User: 1. The following table describes the configuration parameters defined in the default_values. If installing on Unix.5 is installed. 5. Note: Before continuing. ensure that Java 1. Email Service Provider used for the synchronized User’s Email Device. User Role used when synchronizing Users with AlarmPoint.AlarmPoint for BMC Impact Manager • • If installing on Windows. Move the three files from $MCELL_HOME\APII\log into the new folder. 3. Default web service port (typically 8888).properties file found in APII/assets/config/: Parameter webServiceUserLogon webServiceUserPassword webServiceIP webservicePort userRole supervisor emailUserServiceProvider voiceUserServiceProvider timezone site Description Web service User’s name. Create a new folder: $MCELL_HOME\APII\log\$CELL. Type a Password and then Verify Password. click the Users tab. Web service User’s password IPaddress of the AlarmPoint Webserver. In AlarmPoint. Click Add Web Service User. you must change the default value for userRole to either “Support User” or “No Access User”. Voice Service Provider used for the synchronized User’s Voice Device. The Site to which the synchronized User should be assigned. 2. Type a User ID. The synchronized User’s time zone.

ap. mposter -n $CELL -d $KB\data\ap_notification_service.load file located in $KB\bin. Copy this file to $KB\bin. their file properties must be changed before you can edit them. Add a line containing “ap_classes” and a line containing “ap_data” to the . Load the following files into their appropriate directories on the integrated cell. Add a line containing “ap_collector” to the . 2.3 Deploying Baroc and Rule files The next step is to deploy the . 2. one containing “ap” and one containing “ap_associate” to the .load file located in $KB\collectors. ap_classes. Note: The .mrl (located in $AP_KB\rules) 1.baroc (located in $AP_KB\data) 1. ap_collector. Re-compile the files added to the $KB directory of the integrated cell in the command prompt by executing the following command: mccomp -n $CELL If the command executed properly. 2. the last line should state: “Compilation ended successfully” ap_notification_policy.baroc and ap_data.mrl integration files into the $KB directory of the integrated cell.load file located in $KB\rules.mrl (located in $AP_KB\bin) 1. Copy this file to $KB\collectors. Copy these files to $KB\classes. execute the following commands: mposter -n $CELL -d $KB\data\ap_notification_policy. Add a line containing “ap_actions” to the . Copy these files to $KB\rules.AlarmPoint for BMC Impact Manager 3.mrl and ap_associate.baroc (located in the $AP_KB\classes) 1.load file located in $KB\classes. Copy these files to $KB\data.baroc and .3.mrl (located in $AP_KB\collectors) 1. 2. To load the contents of these files into the BMC IM database.baroc This command creates inactive Notification Policies which can be used as templates for new Notification Policies. ap_actions. Add two lines. 2.baroc Configuring BMC Impact Manager | 23 .load files to be modified are read-only.baroc and ap_notification_service.1.

Successful execution of these commands should result in the following output: Figure 3-4. Login to BMC Impact Explorer. Dynamic Data Editor – Extended Details • The integration should have loaded the AlarmPoint and AlarmPoint_FYI Notification Services. After you run the command line utilities. Under the Administration tab on the Event Management Policies menu. The default user for BMC Impact Explorer is “user”. display the Notification Services found under $CELL > Data > Cell Data > Notification Service on your production server. Under the Administration tab on the Dynamic Data Editor menu. with a password of “user”. 3. restart the cell service or daemon named mcell_$CELL. 2.baroc on Windows. as illustrated in the following figure: Figure 3-5. To review the Notification Services and Policies: 1.baroc and ap_notification_service.AlarmPoint for BMC Impact Manager This command creates Notifications Services that will be used by your new Notification Policies. Successful execution of ap_notification_policy. display the Notification Policies found under $CELL > By Policy Type > Notification Policy > AlarmPoint on your production server: Configuring BMC Impact Manager | 24 .

Selector_AlarmPoint_Template and AlarmPoint. Event Management Policies • The integration should have loaded two Selector Templates in the AlarmPoint folder: AlarmPoint. Save and close the file. 3. In the BMC installation folder. locate and open the mcell.3.Selector_AlarmPoint_FYI_Template.dir file. 2.1.2 Configuring Notifications in BMC Impact Manager After deploying the AlarmPoint for BMC IM integration files. To update the BMC Portal Web Service: 1. The Subscription Panel will now be able to populate the event_class predicate list with values from BMC Impact Manager. You can use the event selector and event policy mechanism available in BMC IM to configure Configuring BMC Impact Manager | 25 .3.4 Updating BMC Portal Web Service to support the CELL AlarmPoint must be granted permission to retrieve information for automatically populating the event_class predicate in the Subscription Panel using BMC Web Services.AlarmPoint for BMC Impact Manager Figure 3-6. you must create your own Notification Policies for AlarmPoint in BMC IM. 3. Add the following line to the end of the file: cell $CELL mc <addressOfBMCMcellServer>:1828 3. and then restart the web service or daemon named iiws_$CELL .

Note: For more information on the Event Management Policies Editor. Using the Event Management Policies Editor in BMC IM. BMC® Impact Web Console User Guide. create a Notification Policy based on your Notification Criteria. Configuring BMC Impact Manager | 26 . see BMC® Impact Explorer User Guide. Based on the default Notification Policies deployed by the integration. Selectors act as a mechanism to select the event. you can define how an event should be processed by the cell after it is received. notification method. or BMC® Event Management Administrator Guide. while policies specify the selector.AlarmPoint for BMC Impact Manager AlarmPoint notifications. and users to be notified.

1. Software Component Integration 4.2 Automatic Notifications AlarmPoint for BMC IM enables you to send Automatic Notifications from BMC IM to AlarmPoint. In AlarmPoint for BMC IM.0.1 Integration Features 4. To enable Automatic Notifications and FYI Notifications. Selectors. Selectors.AlarmPoint for BMC Impact Manager 4.0. you must have the following: • • • Notification Services Selectors Notification Policies AlarmPoint for BMC IM provides templates for Notification Services. and Notification Policies by referring to these templates. You can create your own Notification Services. you can also send FYI Notifications. The event selection criteria determine which events cause notifications to be sent to AlarmPoint. The following figure illustrates the creation of a Notification Policy using a template in BMC Impact Explorer version 7.1. and Notification Policies.1 Overview The following are the important features of AlarmPoint for BMC IM: • • • • • • Automatic Notifications Manual Notifications Stop Notifications Standard Actions History User Synchronization Module 4.1: Integration Features | 27 .

4.1.2 Selectors The selection criteria determine which events cause a notification to be sent to AlarmPoint.1. Using a Notification Template to Create a Notification Policy 4. as illustrated in the following figure: Integration Features | 28 . Selectors are used to set the selection criteria.1 Notification Services Loading the ap_notification_service. then only CRITICAL events will cause a notification to be sent to AlarmPoint.2. if the selection criteria specify CRITICAL events.baroc file creates the AlarmPoint and AlarmPoint_FYI notification services.2.AlarmPoint for BMC Impact Manager Figure 4-1. For example.

Selector Details The integration also deploys event collectors. which display the events that triggered AlarmPoint notifications (two-way or FYI).AlarmPoint for BMC Impact Manager Figure 4-2. The following figure illustrates the Collector displaying the events to which AlarmPoint has replied: Integration Features | 29 . and the events replied from AlarmPoint.

Selectors are used by the Notification Policy to select events. Collector History 4.AlarmPoint for BMC Impact Manager Figure 4-3. For more information on Notification Policies.3 Manual Notifications AlarmPoint for BMC IM enables you to send manual notifications from BMC IM to AlarmPoint. 3. On the Events tab. Integration Features | 30 . 2.1. Events cause notifications to be sent to AlarmPoint depending on the Notification Policy. 4. use the AlarmPoint and AlarmPoint_FYI services which are automatically created. • For FYI notifications select Actions > Remote Actions > FYI Notification via AlarmPoint.1.2. highlight the Event for which you want to send a manual notification. The Notification Policy determines which users will receive notifications. To send a manual notification: 1. refer to the BMC Event Management Administrator Guide. Note: While creating the Notification Policy. Log in to Impact Explorer. Right-click the Event and select Actions > Remote Actions > Notify via AlarmPoint.3 Notification Policy In AlarmPoint for BMC IM. and uses the Notification Service to send them.

To stop notifications: 1. AlarmPoint for BMC IM updates the status of the event in BMC IM to “ACK”. The Stop Notification command will send a del event to externally terminate the corresponding AlarmPoint event. you can send a standard action to AlarmPoint for BMC IM. 3. and then click Execute: Figure 4-4. enter the ID of the AlarmPoint recipient you want to notify. 4. Execute Remote Action dialog box 4.1 Acknowledge When you use a Device to reply to a notification with “Acknowledge”. which will result in all notifications being stopped.5 Standard Actions When you receive a notification on a Device.1. 2. On the Events tab.1.5.4 Stop Notifications AlarmPoint for BMC IM enables you to manually stop notifications previously sent from BMC IM to AlarmPoint. Right-click the event and select Actions > Remote Actions > Stop Notification in AlarmPoint. AlarmPoint for BMC IM updates the status in BMC IM.1. Integration Features | 31 . There are five types of standard actions in AlarmPoint for BMC IM: • • • • • Acknowledge Close Assign Ignore Annotate 4.AlarmPoint for BMC Impact Manager 4. logs an entry in the Operations log for the event. highlight the event for which you want to stop AlarmPoint notifications. depending on the type of standard action you send. and stops all other Device notifications to the User who acknowledged the event. In the Execute Remote Action dialog box. Log in to Impact Explorer.

and delinks the User who ignored the event in AlarmPoint.AlarmPoint for BMC Impact Manager 4.1. and an entry is logged in the Operations Log. Users may select this option to delay listening to the notification when it is delivered. AlarmPoint for BMC IM changes the ownership of the event in BMC IM.1.1. followed by additional text on the same line. AlarmPoint for BMC IM also logs an entry in the Operations Log for the event. AlarmPoint for BMC IM leaves the status of the event unchanged. Voice FYI notifications offer the following response choices so that Users can navigate between multiple notifications. and delinks all Users associated with the event in AlarmPoint. all notifications are stopped for the responder. except for those sent to voice-capable Devices. and access the details via the AlarmPoint Web User Interface at a later time. as illustrated in the following figure: Integration Features | 32 . You are updated as the owner of the event.5. the note is added to the Notes section of the Event Details. 4. 4. This option is most likely to be selected.5.5. AlarmPoint for BMC IM updates the status of the event in BMC IM to “CLOSE”. and delinks all Users associated with the event in AlarmPoint.1.5 Annotate The Annotate reply is available only for email Devices.6 Responses for FYI Notifications on Voice-capable Devices FYI notifications do not have any response choices available.1.2 Close When you use a Device to reply to a notification with “Close”. • 4.) • • Delete Removes the notification from the User’s list.5. Save: Saves the notification and stops attempting to deliver it to the User’s other Devices.7 History In BMC IM. logs an entry in the Operations Log for the event. Repeat: Repeats the notification.4 Ignore When you reply with Ignore to a notification using a Device. the status of the notification is updated in the event's Notification Log section. when a User is notified about a problem through AlarmPoint. 4. logs an entry in the Operations Log for the event.3 Assign When you use a Device to reply to a notification with “Assign”. (This navigation is not required on other Devices. and the status of the event is updated to “Assigned”. When replying with “Note”. 4.1.

see “User Synchronization Module” on page 3). navigate to the cell where BMC II for AlarmPoint is installed. and while set to false to use AlarmPoint. It is suggested. Click Start > Programs > BMC Impact > BMC Impact Explorer. 3. To add an AlarmPoint Group in BMC IM: 1.1. you must create AlarmPoint Groups and Users in BMC IM. 2. Enter the group members as a comma-delimited list of User IDs. If you need to modify the data.8. • For example. Consult the AlarmPointII. Click OK.log for information about any failures.AlarmPoint for BMC Impact Manager 4. 7. You cannot edit the data for existing Groups and Users. 6. 4.1 Adding Groups If the provided User IDs are not valid IDs . you must delete the relevant Group or User and then recreate them. they will not be added to the Group.8 AlarmPoint Data & the User Synchonization Module The following sections describe how to add AlarmPoint user data (Users and Groups) in BMC IM. They also describe how to work with the User Synchronization module to synchronizes and update the number of Users or Groups in BMC IM and AlarmPoint (for a general overview. while set to true to manage the group's users through BMCIM. Groups and Users must be synchronized in AlarmPoint on a regular basis. Enter a Name for the group. and then select ALARMPOINT_GROUPS. MyGroup > Cell > DATA > ALARMPOINT > ALARMPOINT_GROUPS. 4. 5. Enter the login details. After installing BMC II for AlarmPoint. Click the Administration tab. • The field update members determines if the list of members will be overwritten in AlarmPoint or not.1. Integration Features | 33 . and then click the Dynamic Data Editor tab. In the tree structure.

2 Adding Users If email or phone number fields are not entered as valid values then they will not be added to the user during this synchronization. Enter the login details. navigate to the cell where BMC II for AlarmPoint is installed and select ALARMPOINT_USERS. MyGroup > Cell > DATA > ALARMPOINT > ALARMPOINT_USERS. To add an AlarmPoint User in BMC IM: 1. In the tree structure. 6. • For example.log for information about any failures.properties. All devices defined here are configured with a default Service Provider defined in APII/assets/config/ default_values.8. For more information. Note: Integration Features | 34 . Click Start > Programs > BMC Impact > BMC Impact Explorer. 4. Additional devices may be added later in AlarmPoint. To add a new data instance. click the Add data instance button. Click the Administration tab. Enter the User ID and click. 3. 5. Consult the AlarmPointII. 2.1. and then click the Dynamic Data Editor tab. The User ID is used to identify users in BMC II for AlarmPoint • Here you may specify an email address and/or phone number as a user's device. see “Deploying the User Synchronization Module” on page 21.AlarmPoint for BMC Impact Manager 4.

AlarmPoint for BMC Impact Manager

4.1.8.3 Running User Synchronization
The UserSync.bat and UserSync.sh files execute the APII.java application on Windows and Unix respectively, and synchronize AlarmPoint Users defined in BMC IM with AlarmPoint through web service calls. To run the User Synchronization on Windows: At the command prompt, navigate to /APII/Windows, and run the following command:
UserSync.bat <cellName>

To run the User Synchronization on UNIX: At the command prompt, navigate to /APII/Unix, and run the following command:
UserSync.sh <cellName>

APII calculates the number of users or groups to be added or deleted by comparing the following files with the results from a query to BMC IM.
available_targets_ALARMPOINT_USERS_lastrun available_targets_ALARMPOINT_GROUPS_lastrun

APII then updates those files with the new list of users and groups and creates an im_notification_service_data.baroc file. APII then uses mposter and the newly created im_notification_service_data.baroc to update the following services with the list of available AlarmPoint users:
ALARMPOINT ALARMPOINT_FYI

Note:

Information regarding the User Synchronization module's last run is stored in these files. These files are used in the current run also. These files are very important and should NOT be deleted.

4.1.8.4 Scheduling User Synchronization
To schedule User Synchronization in Windows: 1. Click Start > Settings > Control Panel. 2. Double-click Scheduled Tasks. 3. In the Scheduled Tasks window, double-click Add Scheduled Task. 4. In the Welcome dialog box, click Next. 5. Click Browse. 6. Select the UserSync.bat file and click Open. 7. Select when you want to perform the task and click Next. 8. Set the Start Time. 9. Select the frequency of performing the task. 10. Set the Start Date and click Next. 11. Enter the user name. 12. Enter the password.

Integration Features | 35

AlarmPoint for BMC Impact Manager

13. Confirm the password and click Next. 14. To complete the procedure and schedule the task, click Finish. To schedule User Synchronization in UNIX: 1. Add a cron job using the following command:
crontab -e

2. Add the details for scheduling User Synchronization. 3. Save the crontab file and exit using the following command:
:wq

4.2 Types of notifications
Notifications are sent to the Users depending on the Notification Policy in BMC IM. There are four different types of notifications: • • • •
Note:

Email (includes HTML email and BES) Pager Text Phone Phone The responses listed in the sections below do not apply to FYI notifications.

4.2.1 Email notification (includes HTML email and BES)
The email notification includes a description of the event that caused the notification and a list of the following BMC IM Event Slots: • • • • • • • • • Message (Situation) MC Host Event Type Event Time Object Object Class Tool Tool Class Parameter

Before you send a reply to an email notification, you must add one of the following responses after the word RESPONSE in the subject line or in the first line of the email message: • • • • ACKNOWLEDGE CLOSE ASSIGN IGNORE

Types of notifications | 36

AlarmPoint for BMC Impact Manager


Note:

ANNOTATE There should not be a space between the last word of the existing subject line and the word “RESPONSE”, but there should be a space between the word “RESPONSE” and the next word.

The text of the original email should be included in the reply and should not be changed. The following is an example of an email notification sent for a CRITICAL event. Example:
BMC Impact Manager Incident Situation sent a start control. on MC Host Event Type Event Time Object Object Class Tool Tool Class Parameter : 2962 : The AlarmPoint Java Client service was successfully : : : : : : : : matterhorn INFO Monday, April 9, 2007 5:29:18 PM PDT adapter UNDEFINED System EventLog UNDEFINED

If you would like to reply to this e-mail, simply reply with the word "RESPONSE" followed by your choice in the subject line. Your response choices are "Acknowledge", "Close", "Assign", "Ignore", "Note" Please make sure to include the original message in your reply. The following is used by the server to identify the email 200452.

4.2.2 Pager Notification
The pager notification includes a description of the event that has caused the notification and a list of the following BMC IM Event Slots on the first screen: • • • Sev Host Msg

The next screen of the pager gives you the option to Reply or Delete. If you choose to reply, then you must send one of the following responses: • • • •
Note:

Ack Clo Ass Ign The reply should not include any text other than these responses.

4.2.3 Text Phone Notification
The text phone notification includes a description of the event that has caused the notification and a list of the following BMC IM Event Slots on the first screen:

Types of notifications | 37

For example. only two-way notifications are delivered to Voice Phone Devices. 4. FALSE) Types of notifications | 38 . you are given menu options for the following responses: • • • • • ACKNOWLEDGE CLOSE ASSIGN IGNORE EVENT DETAILS You can choose a specific response by pressing a specific digit button on your phone. Note: By default. press “1” to respond with ACKNOWLEDGE.2. press “2” to respond with CLOSE. If you want to enable FYI notifications for voice phones. remove or comment out the following line from the Initial script of the integration: @alert::setDeviceFilter("VOICE". etc. then you must send one of the following responses: • • • • Note: Ack Clo Ass Ign The reply should include the notification key that uniquely identifies the message.4 Phone Notification The phone notification includes a description of the event that has caused the notification and a list of the following BMC IM Event Slots: • • • • • • • • • • Message (Situation) MC Host Sim Cell Event Type Event Time Object Object Class Tool Tool Class Parameter Once this information is related.AlarmPoint for BMC Impact Manager • • • Sev Host Msg If you choose to reply.

Modify the selector criteria so the event severity is smaller than or equal to CRITICAL. as illustrated by the following figure: Figure 5-1. Selector Criteria Create a Notification | 39 .1 Create a Notification The first step in testing the integration is to create a Notification to send to the sample User. 2. Testing the Integration This section explains how you can test the AlarmPoint for BMC IM integration once you have completed the steps outlined in the Configuration and Integration chapters. 5. Log in to Impact Explorer. In AlarmPoint. 4. To test the integration: 1. 3.AlarmPoint for BMC Impact Manager 5. Select Administration > Notification Policy > AlarmPoint > Selector_AlarmPoint_Template. confirm that you have a sample User with a User ID of “bsmith” and an active virtual text phone Device.

Type bsmith.AlarmPoint for BMC Impact Manager 5. and then click Modify again: Figure 5-2. open the Notified Events > AlarmPoint collector and locate the event you just re-opened. Select any existing event not in “Open” state and change its status to Open: • • • Note: Click on the Events tab for the integrated cell. Double-click the event to open the Event Details. 7. 8. Create a Notification | 40 . and select Event Operations > Reopen Event. AlarmPoint Notification Policy 6. and then click the History tab. To create a Notification Policy using the AlarmPoint Service that notifies bsmith on all Open events. click Yes. Ensure that there is an entry in the Operations Log stating that a NOTIFICATION_REQUEST was submitted to AlarmPoint. 9. In the Events tab. select the default user and then click Modify. In the Reopen Event Confirmation dialog box. Right-click an event not in “Open” state. You can also generate a new event instead of re-opening a prior event.

ensure that there is an entry in the Notification Log confirming SUCCESSFUL_DELIVERY to AlarmPoint. Operations Log 10. as illustrated in the following figure: Create a Notification | 41 . In Impact Explorer.AlarmPoint for BMC Impact Manager Figure 5-3.

the virtual phone appears and indicates the number of calls that have been received: Responding to a Notification | 42 . When a call arrives for the default User.2 Responding to a Notification 1.AlarmPoint for BMC Impact Manager Figure 5-4. Notes tab – Notification Log 5.

AlarmPoint for BMC Impact Manager 2. Scroll down using the arrow buttons to view the call details and the list of possible replies: Responding to a Notification | 43 . To see the first call. click Select: 3.

AlarmPoint for BMC Impact Manager 4. Click Reply. Click Send. and then type RES Acknowledge: 5. Responding to a Notification | 44 . and AlarmPoint will send the acknowledgement to BMC IM.

Verifying the response | 45 .AlarmPoint for BMC Impact Manager 5. On the Event Details screen in Impact Explorer. To verify the response” 1. 2. create an event in BMC Impact Manager that matches the criteria that you defined. you can verify that the response was received by BMC IM. and use the manual notification described in “Manual Notifications” on page 30. Operations Log – Message Acknowledged 5. Click the History tab and ensure the Operation Log includes a new entry containing “Message Acknowledged”: Figure 5-5.4 Testing the Subscription To test your subscription. click the Summary tab and ensure that the event status has changed to “Acknowledged”.3 Verifying the response After responding to the Notification using the virtual text phone.

6.message = $content. 6.AlarmPoint for BMC Impact Manager 6.message & "Custom Field : " & $event.txt and BMCxap_FYI. Any new behavior will also need to be reflected in the Response Action Script (BMC-Impact-Manager. To add an extra annotation. as described in .2 Adding Annotation Messages Two-way email Device notifications (not FYI) can add extra annotations which will be added to the BMC IM Event as a correlated Event message. and <Message> can be any content you want to add as the annotation. Note: If you add parameters to the end of the list.custom_parameter 6. A possible use for the variable would be to incorporate it in the notification content of a Device by adding the $custom_parameter to the presentation script within the Device's content creation block: $content. the FYI parameter is no longer optional and must always be specified as “yes” or “no”. Any changes to the parameters passed with the execution of the Command for Automatic Action must be considered in the AlarmPoint Java Client parameter mapping and the Alarmpoint Action Scripts.xml) to accommodate the communication with BMCIM. Optimizing and Extending the Integration This section describes some of the available methods you can use to optimize or extend the AlarmPoint for BMC Impact Manager Integration. Any other response functionality for the integration must be configured within the Response Action Script with BMCIMprovided applications and APIs. As an example. Actions available through the Msend program include acknowledging an alert and correlating one alert with another. add a new line to the BMCxAP.3 Changing response choices Changes to the response choices and behavior can be changed in the response business script in the Action Script set.choices::add( "be there in ten minutes" ) Adding data elements | 46 . For each new parameter to be passed from BMCIM to AlarmPoint. the following code illustrates adding a response choice of "Be there in 10 minutes" to the integration: AlarmPoint Action Scripts: • Presentation script: $content.txt mapping files similar to the following: custom_parameter = %custom_parameter% The new parameter may then be used within the AlarmPoint Action Scripts.1 Adding data elements Additional data elements can be forwarded to AlarmPoint by adding them to the command line for a particular alert. respond to an email notification with the following format in the subject line: RESPONSE <Choice> <Message> <Choice> can be either of the response choices listed in the table above.

} } Note: For more information about working with the Response Action Script.message_note = "Will be on-site in 10 minutes" call sendMessage Note: This is only a brief overview of the required components.5 Altering the duration of Events You can modify the amount of time AlarmPoint will send out notifications for a particular event before it times out by changing the $main. you can construct a rule similar to the following: “Suppress all messages from Sources that match *DEV* for a period from 17:00 to 08:00 M-F and 24h on Sat & Sun. For more information about AlarmPoint responses andscripting. This variable stores the number of seconds the notifications will be allowed to continue before timing out.xml script.reply $reply::toLowerCase() $ten_minutes= $reply::startsWith( "be there in ten minutes" ) … IF ( $ten_minutes ) # Perform any changes to the AlarmPoint event and notifications here @event::delinkAll() # Consider the incident handled $main.timeout variable in the initial script. 6.AlarmPoint for BMC Impact Manager • Response script: # Handle responses $reply = $response. APDT_message_text).request_text = "APBMCIMTenMinutes" $response. The default value is 86400. refer to the AlarmPoint Java Client Guide.timeout = 7200 Filtering and suppression of Event data | 47 .” For more information about filtering and suppression. The ExternalServiceMessage injects the tenMinutesRequest to the Response Action Script of the BMC-ImpactManager. see the AlarmPoint Java Client Guide. You can change the delay to a 2 hour timeout by changing the line to: $main. refer to the AlarmPoint Action Scripts and the AlarmPoint Developer's Guide & Scripting Reference. which is the number of seconds in a 24-hour period. 6. "AP_NOTE".equalsIgnoreCase( "APBMCIMTenMinutes" ) ) { IF ( APDT_message_text != void ) { result = constructSendCommand(result.4 Filtering and suppression of Event data If a subset of Event Data from the BMCIM policies needs to be filtered or suppressed.continue = true … # Indicate the person will be on site in ten minutes on the BMC IM incident $response. The following defines how the AlarmPoint Java Client reacts to that service message: // Deal with a response of "be there in ten minutes" IF ( APDT_request_text.

4. you can also do any of the following • • Change $main. To enable BES and HTML email. Setting the $force_fyi flag to “on” makes all normal and Subscription notifications one-way. In the initial script. do the following: • • • Change the $main.7 Constructing BES and HTML email notifications You can configure AlarmPoint to create BES and HTML email notifications. Optionally. Check out the BMC Impact Manager (Business) Production script package. Note: For more information about the variables in this section. If the script package has not been checked in already. you may want to remove responses from notifications generated for subscriptions. FYI notifications | 48 . refer to the AlarmPoint Developer's Guide & Scripting Reference. Note: Some email clients. the BMC Impact Manager (Business) script package set must be checked into the Developer IDE Database. In the Initial Process script in the AlarmPoint Action Scripts. Set $main. By default.logo to a URL that holds the image you want to display at the top of HTML emails. meaning that the user is not offered any response choices. ensure that the configuration block of the initial script has: $subscription_fyi = true The $enable_subs variable must also be set to true. such as Microsoft Outlook 2007.HTML_form_url to point to a JSP page that you want to process any responses from the HTML email. 3. This feature requires the AlarmPoint Developer IDE. See the section on configuration variables in the initial script for details. Launch the Developer IDE.6 FYI notifications You can make all notifications informational only.) Change $main.use_logo to true or false depending on whether you want your HTML email to show a logo. may not display HTML elements correctly.6. 6.enable_HTML_Email variable to true. Set $AlarmPointURL to the base URL of your AlarmPoint web server. For installation instructions. To accomplish this. (The default setting should work out-of-the-box. see “Configuration Variable Reference” on page 50. It is recommended that you test the HTML compatibility of your email client before implementing the HTML email feature. see the instructions in “Importing the AlarmPoint script package” on page 10.AlarmPoint for BMC Impact Manager 6. it points to the AlarmPoint logo.1 Generating FYI notifications for Subscriptions When using subscriptions to inform Users about service outages. 2. To enable BES and/or HTML email: 1. locate the following line: $force_fyi = disable Change the line to: $force_fyi = on 6.

• 5. If you are using BES and have access to a BES server. 6.logo_alt_text to the text you wish to display when the logo can not be fetched. update the version number.9 Uninstalling For instructions on removing an AlarmPoint deployment. but not closed. Subsequent responses using BES or HTML Email on Events previously responded to. or it could be displayed because the email client cannot access the AlarmPoint web server directly and thus cannot respond by using the links in the HTML. see “Configuration Variable Reference” on page 50.AlarmPoint for BMC Impact Manager • Set $main. Save and validate the script.8 Known Issues AlarmPoint Systems plans to resolve the following known issues in a future release: • • Acknowledgement from within Network Node Manager i-series does not prevent further notification deliveries. and check in the script package. refer to the AlarmPoint Installation and Administration Guide. Note: For more information about these and other configuration variables. you can set the URL to the BES server in the $main. cause a stack trace (this issue is addressed in AlarmPoint 3. This can be displayed if the email client is configured not to show images. 6. Known Issues | 49 .bes_pushurl variable.2.1 patch 001).

2 Fail-safe Configuration Variables The following variables configure the fail-safe functionality. consult the AlarmPoint Developer's Guide & Scripting Reference 7. and specify when notifications will be sent to the fail-safe recipient. no subscribed Users will be notified even if they match the criteria of the event. Setting these flags to false prevents that Device type from being notified with FYI messages. The value assigned to each variable is the default value within the script Note: For more information on the behavior associated with informational-only notifications. see "Creating a Fail-Safe Group" on page 13.1 FYI and Subscription Notification Variables The following variables configure the behavior of informational-only. Local Configuration Variables | 50 . If set to true. see . Variable $force_fyi = “disable” Description Forces notifications to be informational only rather than requiring responses. on: notifications are forced to be FYI. If set to false. notifications. Possible values are: • • • disable: nothing is forced. off: notifications are forced not to be FYI. Enables Subscription functionality. 7.AlarmPoint for BMC Impact Manager 7. or FYI.1 Local Configuration Variables These variables are available only in this script. Configuration Variable Reference This section outlines and describes the configuration variables available in the initial Action Script.1. 7. and control how the script runs. $use_email_for_fyi = true $use_phone_for_fyi = false $use_im_for_fyi = true $use_text_phone_for_fyi = true $use_text_pager_for_fyi = true $use_numeric_pager_for_fyi = true $use_bes_for_fyi = true $use_generic_for_fyi = true $enable_subs = true Configure Device filters for informational-only (FYI) notifications. Note: For instructions on how to set up a fail-safe recipient. Users subscribed to criteria matching the event will be notified.1. The value assigned to each variable is its default value within the script. For more information about the initial process script.

“save”. which is typically a Group. and are parameters of the "main" object. which replays the notification. Forces the use of emergency Devices as part of the Device resolution processing. Amount of time (in seconds) the event is allowed to run before timing out. recipients of a Subscription notification will not be able to respond to the event. As this can limit Node performance. a User can respond with “delete”. you can set this value to false if the custom behavior for successful delivery events is unnecessary. and under which circumstances. If both the $force_fyi flag and the $subscription_fyi flag are set to false. disabled: disable the fail-safe functionality. The value assigned to each variable is its default value within the script.3 Alert Configuration Variables The following variables configure Alert behavior.1. Variable $subscription_fyi = true Description Forces Subscription notifications to be informational only. for-recipients: notify if there are no notifiable recipients. or “repeat”.AlarmPoint for BMC Impact Manager 7. The $force_fyi flag also forces subscriptions to be informational only. Overrides any Device Timeframes that have been configured for a User for this notification.) $main. (86400 seconds = 24 hours. Possible values are: • • • • $fail_safe_group = "BMCIM FailSafe" $override_timeframes = false $use_emergency_devices = false enabled: notify the fail-safe Group if no Subscriptions match and there are no notifiable recipients. AlarmPoint will use the FYI flag submitted with the event from the Management System. 7. Variable $track_delivery = true Description Configures the notification to run a response script when the delivery of a notification is successful. for-subscriptions: notify if the Subscription functionality is enabled and no Subscriptions match. If the $use_phone_for_fyi flag is set to true.timeout = 86400 Global Configuration Variables | 51 . which moves to the next notification without deleting. but may be a User. which removes the notification from the phone queue. Identifies the fail-safe recipient.2 Global Configuration Variables These variables are available throughout the script package. no notifications will be sent to the fail-safe recipient. The value assigned to each variable is its default value within the script. but you will lose any information about whether a delivery was successful. $fail_safe = "enabled" Controls whether the fail-safe recipient is notified.

the links will not work for responding and you should respond by replying to this email as described below.use_logo = true $main. If the specified URL cannot be reached. but specifically for Subscription information.annotate. but will make debugging difficult as some information may not be annotated to the originating event./logs/ BMC_IM_Script. (As with $main. Enables submission of Subscription information back to the Management System.HTML_form_url = $AlarmPoint_URL & “/jsp/ ProcessNotificationResponse.debug = false Description Indicates whether to log informational messages for debugging purposes.enable_HTML_Email = true $AlarmPoint_URL = “http://localhost:8888” $main. Specifies the URL of the AlarmPoint Web Server's Process Notification Response JSP form. If a recipient sends an invalid response and this number has not been exceeded. these logged messages will be annotated to the originating Event. The alternate text to display if the HTML email logo is unavailable. Note: If the logo does not display. this variable can be enabled.use_logfile is set to true). Specifies the path to the graphic displayed on HTML (email and BES) notifications. prefixed with a message indicating that their response was invalid.) Most Subscriptions are informational only.gif” $main. and the response links will not work. $main. for debugging and informational purposes but may reduce performance.annotate = true $main.AlarmPoint for BMC Impact Manager Variable $main.log” $main.logo = $AlarmPoint_URL & “/static/ images/logos/alarmpoint/ UNKNOWN. they will be renotified with the same content. used by HTML email and BES to inject responses through the system. Identifies the AlarmPoint URL used for the HTML response form and AlarmPoint logo.subscription_annotate = false $main.. This variable is ignored unless $main.debug is also set to true. Enables submission of information back to the Management System. Specifies whether HMTL email notifications will display the AlarmPoint (or custom) logo.use_logFile = false $main. but will provide less information. Defines the file used to log debugging information (only if $main. Enables HTML Email functionality for email clients able to support HTML emails. Disabling this variable may improve performance.]” Global Configuration Variables | 52 . If the latter.logo_alt_text = “[If the logo does not appear you may be blocking images or you may be outside a firewall. it is unlikely that the HTML_form_url will work. If a client cannot support HTML than the plain text version will be passed. Specifies whether to use an alternate log file for debugging messages.logFile = “.jsp” $main. if this variable is set to true. Information is logged throughout the script progress. Specifies the maximum number of invalid responses allowed before the notification will no longer be requeued.maxInvalidResponses = 3 $main. Setting this variable to false may improve performance. the logo will not appear.

enable_diagnostics = false Global Configuration Variables | 53 .bes_pushurl = "http://localhost:8888/static" $main. "TraceRoute MCHostAddress" for email notifications. Specifies the URL of the BES server. "Ping MCHostAddress".numeric_pager_number = "555-1212" Description The phone number to display for calling in to retrieve event information. This variable has a non-existent number as a default value. or a message indicating that an AlarmPoint event notification has occurred. $main. and also enables the Voice Phone diagnostic menu with the same responses.AlarmPoint for BMC Impact Manager Variable $main. (Optional. "TraceRoute EventOrigin".) Enables diagnostic response choices "Ping EventOrigin". a real call-in number must be supplied.

The account under which the cell is running must have permission to execute the command files. The AlarmPoint Failover Server will not get activated if this file is not configured properly. Check the Java version. Ensure that: • • • • • • • • Note: There are notification policies in BMC IM for escalation to AlarmPoint.1 If there are Errors during Installation • • • • • • Ensure there is sufficient disk space available for installation. Troubleshooting This section provides troubleshooting information regarding issues that you might encounter while installing. AlarmPoint for BMC IM supports version 1. configuring.2 If an Event is not propagated to AlarmPoint • • Check the APAgent.bin. AlarmPoint for BMC IM supports version 4. Note that the location for the command files on Unix is different than on Windows. The notification Devices for all Users are configured in AlarmPoint. 8.AlarmPoint for BMC Impact Manager 8.x. AlarmPoint for BMC IM supports version 4.3 If a Web Service Axis Fault occurs during user synchronization • • • Ensure there is network connectivity with the AlarmPoint Webserver. 8. The AlarmPoint Notification Services are present in the Cell Data section of the Dynamic Data Editor. All Users and Groups are enabled in AlarmPoint. 5.x. Check the AlarmPoint Java Client version.0. Ensure that the path environment variable is set correctly. The AlarmPoint action scripts have been imported into AlarmPoint and are in Production mode. Check the AlarmPoint version. • Consult $MCELL_HOME\APII\log\AlarmPointII. Ensure the web server is running and that web services have been properly deployed. the notification policy and the stop notification policy. Remove any incomplete Users or Groups from AlarmPoint.5. AlarmPoint for BMC IM supports version 4.xml file for the correct configuration of the AlarmPoint Primary Server and the AlarmPoint Failover server. If there are Errors during Installation | 54 .bat files (or AlarmPoint and AlarmPoint_FYI on Unix) is correct.exe in the AlarmPoint.0 or later. The AlarmPoint Java Client is running. An Event Domain was created in AlarmPoint for the Impact Manager integration. Check the BMC IM version.x.0 or later. For example. The path for the bmc_apclient.log to determine whether Groups or Users were synchronizing whe the Axis Fault occurred. and using AlarmPoint for BMC IM. or 7. 8.bat and AlarmPoint_FYI.

AlarmPoint for BMC Impact Manager • • • Determine which Users or Groups were successfully and unsuccessfully synchronized with AlarmPoint. If a Web Service Axis Fault occurs during user synchronization | 55 . When you are certain that web services are running run the synchronization module again. Log in to AlarmPoint as Company Administrator and remove those Users or Groups so that it will be synchronized on the next synchronization.

Contact Us You can access the AlarmPoint Systems Web Site at http://www. and other tools provided by AlarmPoint Systems. release notes. CA 94588 Phone: 925-226-0300 Fax: 925-226-0310 E-mail: support@alarmpoint. 1030 West Maude Avenue Sunnyvale. Suite 220 Pleasanton.alarmpoint. From this site you can obtain information about the Company. the Products.alarmpoint. Inc. Inc. Support and other helpful information. You may also access the Customer Support Site from the main web page.com Website: http://www.com BMC Software. AlarmPoint Systems.AlarmPoint for BMC Impact Manager 9. Inc.com. patches. CA 94085-2810 Phone: 408-571-7000 Fax: 408-571-7001 | 56 . In this protected site you will find current product releases. 4457 Willow Road. helpful hints.

All other trademarks are the property of their respective owners. United Kingdom and other jurisdictions. Inc. of AlarmPoint Systems. produced this integration document to assist customers with joint BMC /AlarmPoint Systems implementations. but do not guarantee any accuracy now or in the future. Inc. respectively. ©AlarmPoint Systems 2009.AlarmPoint for BMC Impact Manager 10. BMC and AlarmPoint Systems have made every effort to ensure that the information contained in this document is accurate. AlarmPoint Systems™ and AlarmPoint® are a trademark and registered trademark. Copyright AlarmPoint Systems. | 57 . Rights to reproduce this document only by written permission of AlarmPoint Systems. in the United States.

Sign up to vote on this title
UsefulNot useful