onLicenseEvent

onLicenseEvent

This option was added in version 7.14.0.

Description

This option runs a custom JavaScript function when a product licensing event occurs. It is typically used to notify IT staff when there is a product licensing issue, before it affects users.

Event Object

The specified function is called with one argument, an object with the following properties:

  • type (string) - The type of event. Possible values are:

    • floating_license - A floating license event.

  • name (string) - The name of the event. Possible values are:

    • activation_failure - The instance was unable to activate a floating license seat at start up time. This can happen for a variety of reasons, such as a configuration or authorization issue, a lack of available seats, or a communication error. Details are recorded in the floating license log;

    • heartbeat_failure - The instance failed to check in with the floating license server due to an authorization or communication error. Details are recorded in the floating license log.

  • seat_expires - Present for heartbeat_failure events. A Date object indicating when the seat expires.

Example

onLicenseEvent: function(event) { myNotifyFn(event); // Send email or text message, etc. }

See also Floating Licenses and Communication with Profound Logic Licensing Server.

For information on how to modify this setting, see Configuration File.