# Substation ES HeartBeat Events

HeartBeat is a message or an event that is sent to a destination, informing the recipients that Substation ES is running. Additionally, the Substation ES instance issues the specified internal operational commands. The contents of the commands are then sent to a destination defined in a trigger service.

The default Substation ES installation includes the basic configuration for HeartBeat events. To implement HeartBeat, activate the service in the administration interface member `SXSIADM` by defining the parameters and keywords shown in the following table.

HeartBeat Parameters
Parameter | Description
--- | ---
ESB-INTF-ID =intf-id | Determines the interface that sends the HeartBeat message. intf-id is the ID name of the ESB interface that sends the message.
HEARTBEAT-SERVICE =T-Name | Specifies the trigger service name that Substation ES uses to publish HeartBeat messages.
HEARTBEAT-INTERVAL =seconds | The interval, in seconds, between heartbeats. For example: HEARTBEAT-INTERVAL =5 To deactivate the HeartBeat feature, specify an interval of 0.
HEARTBEAT-COMMAND =command | Specifies a Substation ES operational command that is issued during each HeartBeat event. You can specify maximum of five commands. For example: `HEARTBEAT-COMMAND` =SHOW,`INTF,CONN` `HEARTBEAT-COMMAND` =SHOW,`COUNTERS` `HEARTBEAT-COMMAND` =SHOW,`ACT,RID`

Note: By default, these parameters are commented out.

When the HeartBeat feature is enabled, Substation ES issues internal commands, and then Substation ES collects the output and passes it to the `HEARTBEAT` trigger service for delivery to the destination specified in the trigger service definition. The trigger service is determined by the HEARTBEAT-SERVICE parameter.

Copyright © TIBCO Software Inc. All rights reserved.