Remote Management Server Heartbeats Settings

Kiosk Pro can check in with the Remote Management Server on a regular basis by sending heartbeats. The server can monitoring heartbeats and alert you that there is a problem at the kiosk that is preventing outbound communication (for example, the app has crashed or the device has lost internet access). 

It's possible to automatically update the status of a kiosk in the RMS based on information passed through the heartbeat, as well as view detailed reporting including heartbeats generated during specific timeframes, information about individual heartbeats, and missed heartbeats.

In this article

Heartbeat Interval

Supported in:

Kiosk Pro Plus and Enterprise

The Heartbeat Interval determines how frequently Kiosk Pro checks in with the Remote Management Server and provides a device health report.

Default Value:
  • 30 min
Other Possible Values:
  • Disabled
  • 5 min
  • 10 min
  • 1 hour
  • 2 hours

Values for Remote Settings Control & Managed App Configuration

Key KWC_HeartbeatInterval
Key Type string
Default Value 30
Possible Values
  • 0 = Disabled
  • 5 = 5 min
  • 10 = 10 min
  • 30 = 30 min
  • 1 = 1 hour
  • 2 = 2 hours

Battery

Supported in:

Kiosk Pro Plus and Enterprise

Heartbeat details will include battery percentage and whether the device is charging or discharging. These details are based on the Trigger Percentage and Offline Status settings.

Default Value: On

Values for Remote Settings Control & Managed App Configuration

Key kwc_heartbeatMonitoringOfBattery
Key Type boolean
Default Value true

Trigger Percentage for Battery

Supported in:

Kiosk Pro Plus and Enterprise

Determine when the battery status should be identified as "Offline" based on the percentage. For example, if set to 50%, when the battery drops below 50%, the heartbeat detail will say the device is "Offline".

Note: This setting only applies if the Battery setting is turned On.

Default Value:
  • 50
Other Possible Values:
  • 10
  • 20
  • 30
  • 40
  • 60
  • 70
  • 80
  • 90
  • 100

Values for Remote Settings Control & Managed App Configuration

Key kwc_heartbeatMonitoringOfBatteryTriggerPercentage
Key Type integer
Default Value 50
Possible Values
  • 10 = 10%
  • 20 = 20%
  • 30 = 30%
  • 40 = 40%
  • 50 = 50%
  • 60 = 60%
  • 70 = 70%
  • 80 = 80%
  • 90 = 90%
  • 100 = 100%

Offline Status for Battery

Supported in:

Kiosk Pro Plus and Enterprise

Determines when the battery status should be identified as "Offline".

Note: This setting only applies if the Battery setting is turned On.

Default Value:
  • When Not Charging & Below Trigger Percentage
Other Possible Values:
  • When Below Trigger Percentage

When Not Charging & Below Trigger Percentage

This option will trigger an "offline" status when the device is not charging and when the current battery level is below the set Trigger Percentage.

For example, if the Trigger Percentage is set to 50% but the device is charging, the battery status will be "Online" while it's below 50%.

When Below Trigger Percentage

This option will trigger an "offline" status when the device is below the set Trigger Percentage regardless of the charging state.

Values for Remote Settings Control & Managed App Configuration

Key kwc_heartbeatMonitoringOfBatteryOfflineStatusDetectMethod
Key Type integer
Default Value 0
Possible Values
  • 0 = When Not Charging & Below Trigger Percentage
  • 1 = When Below Trigger Percentage

External Screen

Supported in:

Kiosk Pro Enterprise

Determine when the external screen status should be identified as "Offline" based on whether Kiosk Pro is connected via the JavaScript API.

Default Value: Off

Values for Remote Settings Control & Managed App Configuration

Key kwc_heartbeatMonitoringOfExternalScreen
Key Type boolean
Default Value false

Air Printer

Supported in:

Kiosk Pro Enterprise

Determine when the AirPrint printer status should be identified as "Offline" based on whether Kiosk Pro is connected via the JavaScript API.

Default Value: Off

Values for Remote Settings Control & Managed App Configuration

Key kwc_heartbeatMonitoringOfAirPrinter
Key Type boolean
Default Value false

Star Micronics Printer

Supported in:

Kiosk Pro Enterprise

Determine when the Star Micronics Printer status should be identified as "Offline" based on whether Kiosk Pro is connected via the JavaScript API.

Default Value: Off

Values for Remote Settings Control & Managed App Configuration

Key kwc_heartbeatMonitoringOfStarPrinter
Key Type boolean
Default Value false

Brother QL Series Label Printer

Supported in:

Kiosk Pro Enterprise

Determine when the Brother QL Series Label Printer status should be identified as "Offline" based on whether Kiosk Pro is connected via the JavaScript API.

Default Value: Off

Values for Remote Settings Control & Managed App Configuration

Key kwc_heartbeatMonitoringOfBrotherPrinter
Key Type boolean
Default Value false

Bixolon Printer

Supported in:

Kiosk Pro Enterprise

Determine when the Bixolon Printer status should be identified as "Offline" based on whether Kiosk Pro is connected via the JavaScript API.

Default Value: Off

Values for Remote Settings Control & Managed App Configuration

Key kwc_heartbeatMonitoringOfBixolonPrinter
Key Type boolean
Default Value false

IDTech iMag Pro or iMag Pro II Card Reader

Supported in:

Kiosk Pro Enterprise

Determine when the IDTech iMag Pro or iMag Pro II Card Reader status should be identified as "Offline" based on whether Kiosk Pro is connected via the JavaScript API.

Default Value: Off

Values for Remote Settings Control & Managed App Configuration

Key kwc_heartbeatMonitoringOfiMagCardReader
Key Type boolean
Default Value false

IDTech UniMag II or Shuttle Card Reader

Supported in:

Kiosk Pro Enterprise

Determine when the IDTech UniMag II or Shuttle Card Reader status should be identified as "Offline" based on whether Kiosk Pro is connected via the JavaScript API.

Default Value: Off

Values for Remote Settings Control & Managed App Configuration

Key kwc_heartbeatMonitoringOfIDTechCardReader
Key Type boolean
Default Value false

MagTek iDynamo Card Reader

Supported in:

Kiosk Pro Enterprise

Determine when the MagTek iDynamo Card Reader status should be identified as "Offline" based on whether Kiosk Pro is connected via the JavaScript API.

Default Value: Off

Values for Remote Settings Control & Managed App Configuration

Key kwc_heartbeatMonitoringOfiDynamoCardReader
Key Type boolean
Default Value false

Socket Mobile Scanner

Supported in:

Kiosk Pro Enterprise

Determine when the Socket Mobile Scanner status should be identified as "Offline" based on whether Kiosk Pro is connected via the JavaScript API.

Default Value: Off

Values for Remote Settings Control & Managed App Configuration

Key kwc_heartbeatMonitoringOfSocketScanner
Key Type boolean
Default Value false

Battery Trigger Percentage for Socket Mobile Scanner

Supported in:

Kiosk Pro Enterprise

Determine when the battery status of the Socket Mobile Scanner should be identified as "Offline" based on the percentage. For example, if set to 50%, when the battery drops below 50%, the heartbeat detail will say the device is "Offline".

Default Value:
  • 50
Other Possible Values:
  • 10
  • 20
  • 30
  • 40
  • 60
  • 70
  • 80
  • 90
  • 100

Values for Remote Settings Control & Managed App Configuration

Key kwc_heartbeatMonitoringOfSocketScannerBatteryTriggerPercentage
Key Type integer
Default Value 50
Possible Values
  • 10 = 10%
  • 20 = 20%
  • 30 = 30%
  • 40 = 40%
  • 50 = 50%
  • 60 = 60%
  • 70 = 70%
  • 80 = 80%
  • 90 = 90%
  • 100 = 100%

Offline Status for Socket Mobile Scanner

Supported in:

Kiosk Pro Enterprise

Determines when the battery status should be identified as "Offline" based on charging status.

Default Value:
  • When Disconnected or Below Battery Trigger Percentage
Other Possible Values:
  • When Disconnected Only

When Disconnected & Below Trigger Percentage

This option will trigger an "offline" status when the device is disconnected or when the current battery level is below the set Trigger Percentage.

When Disconnected Only

This option will trigger an "offline" status when the device is disconnected.

Values for Remote Settings Control & Managed App Configuration

Key kwc_heartbeatMonitoringOfSocketScannerOfflineStatusDetectMethod
Key Type integer
Default Value 0
Possible Values
  • 0 = When Disconnected or Below Battery Trigger Percentage
  • 1 = When Disconnected Only

Change Log

Included in the initial release of Enterprise. Added to Plus in version 6.2. Added iOS app version details to heartbeats in version 7.1. Added heartbeat tracking in version 9.1. Added support for Socket Mobile Scanner in version 9.5.4.

Related Articles

Still stuck? How can we help? How can we help?