Skip Navigation
  1. BlackBerry Docs
  2. BlackBerry AtHoc
  3. BlackBerry AtHoc Integrations
  4. SiRcom Installation and Configuration Guide
  5. Configure IIM IP connectivity
  6. Check IIM connectivity to SiRcom using heartbeats

Check IIM connectivity to 
SiRcom
 using heartbeats

IIM
 sends a communication check (heartbeat) to 
SiRcom
 at a regular interval to verify connectivity. When 
SiRcom
 receives the communication from the 
IIM
, it responds by sending a CAP XML payload file. The sent and received heartbeat files are saved in the capnode folder on your local computer. Once a day, these files are put into a .zip file and stored in the capnode/archiveGenericSerialCAPMessage folder.
The rate of the communication check can be configured by setting 
SirenCentralDeiverGenericSerial.HBFrequency
 parameter in the 
system_private.config
 file.
The 
SirenCentralEncoder.RemoteComPort.BaudRate
 parameter in the 
system_private.config
 file must be set to to 9600 for the heartbeat communication check to function.
To check the current connectivity between 
BlackBerry AtHoc
 to 
SiRcom
, view the current heartbeats:
  1. Go to the 
    capnode/CAPSentToGenericSerial
     folder on your local computer.
  2. Double click to open the 
    CAPSentToGenericSerial
     file for the heartbeat XML file you want to view. Each file name includes the date of the heartbeat.
  3. Go to 
    capnode/CapAlertsReceivedFromGenericSerial
     folder on your local computer.
  4. Double click to open the 
    CapAlertsReceivedFromGenericSerial
     file for the heartbeat XML file you want to view. Each file name includes the date of the heartbeat.
To check the past connectivity between 
BlackBerry AtHoc
 to 
SiRcom
, view past heartbeats:
  1. Go to the 
    capnode/archieveGenericSerialCAPMessage
     folder on your local computer.
  2. Double click to open the 
    CAPSentToGenericSerial
     .zip file for the heartbeat XML file you want to view. Each .zip file name includes the date of the heartbeat.
  3. Go to 
    capnode/archieveGenericSerialCAPMessage
     folder on your local computer.
  4. Double click to open the .zip 
    CapAlertsReceivedFromGenericSerial
     file for the heartbeat XML file you want to view. Each .zip file name includes the date of the heartbeat.
The following is a sample heartbeat sent from 
IIM
 to 
SiRcom
: 
<?xml version="1.0" endcoding="UTF-8"?>
<alert xmlns="urn:oasis:names:tc:emercency:cap:1.2">
  <identifier>HB</identifier> !--A unique identifier generated by 
BlackBerry AtHoc
.
  <sender>ATHOC</sender> !--Sender identity, from 
BlackBerry AtHoc
.
  <sent>2019-06-28T09:39:07</sent> !--Date and time of message origination.
  <status>System</status>
  <msgType>Alert</msgType>
  <scope>Private</scope>
</alert>
If the 
SiRcom
 giant voice system is active and fully operational, it responds with the following payload:
<?xml version="1.0" endcoding="UTF-8"?>
<alert xmlns="urn:oasis:names:tc:emercency:cap:1.2">
   <identifier>SIRCOM_GV_|
unique-id
</identifier> !--A unique identifier generated by 
SiRcom
.
   <sender>SIRCOM</sender> !--Sender identity, from 
SiRcom
. 
   <sent>2019-06-28T09:40:07</sent> !--Date and time of message origination. 
   <status>System</status>
   <msgType>Ack</msgType>
   <scope>Private</scope>
   <references>ATHOC,HB,2019-06-28T09:39:07</references> !--Information about the original message; sender, identifier and time sent.
</alert>
If the 
SiRcom
 giant voice system is active but not fully operational (in a failed or error condition), it responds with the following payload:
<?xml version="1.0" endcoding="UTF-8"?>
<alert xmlns="urn:oasis:names:tc:emercency:cap:1.2">
   <identifier>SIRCOM_GV_|
unique-id
</identifier> !--A unique identifier generated by 
SiRcom
.
   <sender>SIRCOM</sender> !--Sender identity, from 
SiRcom
. 
   <sent>2019-06-28T09:40:07</sent> !--Date and time of message origination. 
   <status>System</status>
   <msgType>Error</msgType>
   <scope>Private</scope>
   <note>
Text describing the error
.</note>   
<references>ATHOC,HB,2019-06-28T09:39:07</references>
</alert>
The <note> node describes the error conditions of the 
SiRcom
 giant voice system:
  • NOT-ACTIVE: The 
    SiRcom
     giant voice system is not active.
  • NOT-OPERATIONAL, <
    details
    >: The 
    SiRcom
     giant voice system is not operational due to an error.
  • DEGRADED, <
    details
    >: The 
    SiRcom
     giant voice system is operational, but its functionality is degraded.
If the <msgType> node indicates an error, contact 
BlackBerry AtHoc
 customer support.