Heartbeat parameters

You can add these parameters to the MSS applet and/or the links list applet to modify the default heartbeat behavior. Use the basic syntax:<mss:param name="name" value="value"/>.

  • enableHeartbeat – Enables the heartbeat. The default for Session Manager is true. The default for the links list is false.

  • adminHeartbeatOnly – Enables the heartbeat only for a user logged in as the administrator. Applies only to the links list and only when “enableHeartbeat” is true. The default is false (links list heartbeat will apply to both users and administrators).

  • heartbeatInterval - Specifies the interval between heartbeats, in minutes. The default is 3 minutes, the minimum is 1 minute, and the maximum is 720 minutes (12 hours).

  • heartbeatMax – Specifies the maximum lifetime of the heartbeat, in minutes. The default is 0, which lets the heartbeat run indefinitely. The maximum is 720 minutes (12 hours).

  • heartbeatRetry – Specifies the maximum number of consecutive failed heartbeats before the heartbeat is stopped permanently. The default is 5, the minimum is 1, and the maximum is 100.

  • heartbeatCrumbMode – Indicates whether to use “servlet request mode” or “crumb mode” for heartbeat operations. The default is false, and the heartbeat operates in “servlet request mode”. If set to true, an additional parameter, “heartbeatCrumbFilename”, can be set to specify the name of the “crumb” file if the default filename of “crumb.txt” is not desired. See Using Crumb Mode.