XML identifiers: Defines heartbeats not logged on server, since start of app. Is active per default, using heartbeats_failed, per default placed in config file label HBL13 as tag (key) with corresponding value replacement identifier #var:HeartBeatsFailed# in HBV13. Can be removed by redefining this key/value pair, and may be moved to any of the other HBL/HBV01-25 pairs (see example).
Purpose: The failed heartbeat count (since start of app) counts the total number of failed heartbeat submits to logging server. This value can also be seen by users (and local admins) via the device settings login popup (see illustration). The failed heartbeat count (shown as Failed: 1 in illustration below) can be used for statistics, and for debugging on suspicion of faults either on app, on iPad, network or logging server.
Status: Currently in use.
Category: Heartbeat keys (labels and value).
Usage: Activated per default, using key/value pair HBL13 for label string, and HVL13 for replacement parameter string as defined in apps internal default stup. HBL13/HVL can be overridden, for other purposes. Label string and replacement parameters string can (optionally) be moved to another label/value-pair (HBL/HBV01-25). See usage example, and heartbeat capture example (below).
Default:
Defaults to the pair of HBK13 with the label string heartbeats_failed, and a replacement parameter string HBV13 of #var:HeartBeatsFailed#. The replacement parameter string #var:HeartBeatsFailed# is replaced in app. The maximum size of heartbeat count before resetting this to 0 is 2.147.483.647. This will with a heartbeat rate of one per 5 minutes (which is default from version 1.1.1 onwards) equate to roughly 245.000 years of use. Note! This does NOT restrict the total number of heartbeats that can be transferred, JUST the total number failed that is reported to the user, and to the logging server.
Development status: Released in 1.1.0. Standard feature, as defined in app config.
Example: Choosing to use the WAL HeartBeat ConFiguration Key 07, and Value 07 to give heartbeats informing about the number of packets lost since start of app:
…
<key>HBL07</key>
<string>heartbeats_failed</string>
…
<key>HBV07</key>
<string>#var:HeartBeatsFailed#</string>
Illustration: Capure of heartbeat on logging server, as illustrated with a screen capture form a server session running on the open service requestinspector.com (highly recommended, incidentally, for development and simple testing of heartbeats). In this example, the value of heartbeats_failed is 1.
Document Revision: Nov. 2024. Rev. 1.0