Basic steps to create a Heartbeat Event Rule in Spectrum
Article ID: 29081
Updated On:
Products
Issue/Introduction
There are 4 events involved when creating a Heartbeat Event Rule in Spectrum:
1 - The Trigger event. This is the event that triggers Spectrum to listen for the heartbeat event.
2 - The Heartbeat event. This is the event Spectrum is listening for when the trigger event is generated.
3 - The Missed Heartbeat event. This is the event that is generated when Spectrum does not hear the Heartbeat event generated within the time specified.
4 - The Heartbeat Stop event. This is the event that tells Spectrum to stop listening for the Heartbeat event.
NOTE: The Trigger and Heartbeat events CAN NOT be the same event id. Event event used in the Heartbeat event MUST be separate event id's.
When Spectrum sees the Trigger event generated, it starts listening for the Heartbeat event to be generated within a specified time. If the Heartbeat event is not heard within the specified time, the Missed Heartbeat event is generated. Spectrum continues to listen for the Heartbeat event until the Heartbeat Stop event is generated. When the Heartbeat Stop events is generated, Spectrum stops listening for the Heartbeat event until the next Trigger event is generated.
Environment
Release: Any
Component: Spectrum Events/Alarms
Resolution
The following are the basic steps to creating a Heartbeat Event Rule.
1. Log into OneClick as a user that has privileges to create new events
2. Select Tools -> Utilities -> Event Configuration from the top level menu to launch the Event Configuration tool
3. Create your Trigger, Heartbeat, Missed Heartbeat and Heartbeat Stop events
In this example, I am using the following event for the Heartbeat Event Rule:
Trigger event - 0xfff00000
Heartbeat event - 0xfff00001
Missed Heartbeat event - 0xfff00002
Heartbeat Stop event - 0xfff00003
4. Select the Trigger event (In this example, it is the 0xfff00000 event)
a. Click on the Event Rules tab in the Details panel
b. Click on the New Event Rule icon and select Heartbeat from the list
5. In the Heartbeat Event dialog, enter the following information:
- In the "Heartbeat Event <H>" section, click on the "Browse" button and select the Heartbeat event. (In this example, it is the 0xfff00001 event)
- In the "Heartbeat Period <P>" section, choose the time period for Spectrum to listen for the Heartbeat. (In this example, I set this to 1 minute)
- In the "Generate Event on Missing Heartbeat <Z>" section, click on the Browse button and select the Missed Heartbeat event. (In this example, it is the 0xfff00002 event)
- In the "Optional: Heartbeat Rule Stop Event <S>" section, click the Browse button and select the Heartbeat Stop event. (In this example, it is the 0xfff00003 event)
- Click on the OK button
The following is a screen shot of the completed Heartbeat Event dialog:
6. Click on the Save icon to save the change
7. Update the SpectroSERVER Event Configuration
a. Find and select the VNM model
b. Click on the Information tab in the Component Detail panel
c. Find and expand the SpectroSERVER Control subview
d. Click on the Update Event Configuration button
NOTE: If you are running a DSS, you will need to update the Event Configuration for all VNM models in the DSS.
The following is a screen show showing the events showing the events that are created for the Heartbeat event example:
Please reference the "Working with Event Rules" section of the documentation for more information.
Additional Information
The following is another example where a Heartbeat Event Rule is automatically started on specific models when the SpectroSERVER is started. The 0x00010301 event is generated on a model during the Model Activation process when the SpectroSERVER is started. You create your Heartbeat Event Rule as discussed above.
To have Spectrum automatically start a Heartbeat Event Rule on specific models, create an Event Condition rule on the 0x00010301 event to check the model handle of the model where the 0x00010301 event was generated and if it is a specific model, generate your Trigger event
The following is a screen shot of an Event Condition rule configured on the 0x00010301 event that looks at the value of the Model_Handle attribute id 0x129fa. If the value is equal to 0x2000072 (which is the model handle of a model in the Spectrum database), than generate event 0xfff00000 which is the Trigger event for my Heartbeat Event Rule.
You can use a logic "OR" in the Event Condition Rule if you would like to specify multiple Model_Handle values. The following is an example:
Feedback
