Last known heartbeat transfer error report

XML identifiers: hrtbt_last_err_report and #var:HBLastErrReprt#, per default placed within the value strings of HBL17 (key) and HBV17 (value replacement), respectively. 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 last heartbeat transfer fail before successful heartbeat transfer to logging server is reported using this keu/value replacement pair. This value can be viewed by users (and local admins) via the device settings login popup (see illustration). The lat known transfer error report (shown as Last known transf. error: Error during netw. request in illustration below) can be used for debugging on suspicion of faults either in app, on iPad, network or logging server. Note: This message is obviously transferred to logging server, once a successful transfer can be performed. This particular error will only be transferred once, and will not repeat for this error occurence.

Revamped device settings & device information popup. Note addition of Last known transfer error.

Status: Currently in use.

Category: Heartbeat keys (labels and value).

Usage: Activated per default, using key/value pair HBL17 for label string, and HVL17 for replacement parameter string as defined in apps internal default setup. HBL17/HVL17 can be overridden, for other purposes. Label string and replacement parameters string can (optionally) be moved to another label/value-pair (HBL/HBV01-25). If so, please use the last pairs, since these are least likely to be given defaults later. See usage example, and heartbeat capture example (below).

Default:

Defaults to the pair of HBK16 with the label string hrtbt_fail_snc_succ, and a replacement parameter string HBV16 of #var:HBFailSinceSucc#. The replacement parameter string #var:HBFailSinceSucc# is replaced in app with the actual number of failures since success. The maximum size of hrtbt_succ_snc_fail count before resetting this to 0 is 2.147.483.647. This will sufficient for roughly 245.000 years of use, assuming that all heartbeat transfers (with default frequency of one each 5 minutes) will fail, before eventually being transferred.

Development status: Released in 1.1.0. Standard feature, as defined in app config.

Example: Choosing to use the WAL HeartBeat ConFiguration Key 10, and Value 10 to give heartbeats informing about the number of failed heartbeat transfers to server since last successful transfer:

<key>HBL25</key>

<string>hrtbt_last_err_report</string>

<key>HBV25</key>

<string>#var:HBLastErrReprt#</string>


Please refer to the release notes of version 1.1.1 for examples of transferred data.

Document Revision: Nov. 2024. Rev. 1.0