XML identifiers: Defines heartbeats that (as seen from the viewpoint of the app) is successfully logged on server (as signaled by server as code 200) since start of app. Is active per default, using HBL14 as tag (key) and HBV14 (value replacement). 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 successful heartbeat count (since start of app) counts the total number of actual heartbeats transferred to logging server. This value can also be seen by users (and local admins) via the device settings login popup (see illustration). The successful heartbeat count (shown as Success: 297 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 HBL14 for label string, and HVL14 for replacement parameter string as defined in apps internal default stup. HBL14/HVL14 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 HBK14 with the label string heartbeat_success, and a replacement parameter string HBV13 of var:HeartBeatSuccess. The replacement parameter string #var:HeartBeatsSuccess# is replaced in app with the actual number of successes. 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 08, and Value 08 to give heartbeats informing about the number of successfult heartbeat transfers to server since app start:
…
<key>HBL08</key>
<string>heartbeats_failed</string>
…
<key>HBV08</key>
<string>#var:HeartBeatSuccess#</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_success is 361.
Document Revision: Nov. 2024. Rev. 1.0
XML identifiers: Requires two keys to transfer data of successful heartbeats since last failed, or since startup of app: One key HBL01-20 (default: HBL14) for label, and the matching HBV01-10 (default: HVL14) with string #var:HeatBeatsFailed#. See example for illustration.
Purpose: Informing the user (via control panel login popup) and via logging server about the failed number of successful heartbeat transfers since app startup, or since the last failed heartbeat transfer. For statistics, and for debugging on suspicion of faulty iPad, network, logging server or app.
Status: Currently in use.
Category: Heartbeat keys (labels and value).
Usage: Either use default (don’t overwrite/use HBL14 / HVL14 for other purposes), or provide both HBL01-20 and HBV01-20 with label and replacement parameter providing the actual value, see usage example.
Default:
Defaults to the pair of HBK14 = heartbeat_success, and HBV14 = #var:HeartBeatSuccess#. The replacement identifier #var:HeartBeatSuccess# is replaced during actual operation with the number of heartbeat messages transferred to log server since app startup, or since last transfer failure.
Development status: Being developed, release in 1.1 or later. Standard feature in default config, please rely on this to save space in EMM XML configuration files unless you want these data removed from heartbeat.
Example: Choosing to use the WAL HeartBeat ConFiguration Key 07, and Value 07 to give heartbeats informing about the number of packets lost since last heartbeat:
…
<key>HBL07</key>
<string>heartbeats_failed</string>
…
<key>HBV07</key>
<string>#var:HeartBeatsFailed#</string>
Document Revision: Dec. 2024. Rev. 0.1