OpenFin

License Configuration

Overview

OpenFin uses a set of information to determine OpenFin usage, including hardware (desktop/machine) and software (app config) data points. The following data is routed to OpenFin for license usage:

License Key: Unique identifier for your OpenFin license
Machine ID: Non-personal, anonymous unique ID for the machine and user account
App ID: URL of the application manifest file
App Events: Launch and close time of application (UTC)
Runtime Environment: Runtime, RVM, and OS versions
Public Facing IP: Public facing IP address of the network request as seen by OpenFin servers. This is used to estimate the company where the information has been sent from. It is the Public IP address attached to the request, or if an LRS is being used, the Public IP of the LRS. It is not the end-user desktop IP.

Unique User API

The objective of license reporting is to identify the number of unique end users of an application in a given month. If an application is regularly used by a single user from multiple machines, there is an extension to the OpenFin API to allow an application owner to map a set of machines to a single logical user. A properly configured LRS will expose the following method in the JavaScript API to allow your applications to map your unique user identifier to a machine ID:

const app = fin.desktop.Application.getCurrent()
   app.registerUser(userName, appName, function(){console.log("Success")}, function(err){console.log("Failure")})
  • userName(string) - username to be passed to the RVM.
  • appName(string) - app name to be passed to the RVM.
  • @param(Function) [callback] - called if the method succeeds.
  • @param {Function} [errorCallback] - called if the method fails. The reason for failure is passed as an argument(err).

This method requires:

  • Runtime 8.56.27.75 or greater
  • RVM 3.8.2.1 or greater

Reporting License Usage

On a monthly basis, OpenFin reviews automated license usage data for each application provider. We review designated application configuration URLs to identify desktops using their apps in a production environment. A desktop computer is counted in any given month if a machine used the OpenFin Runtime for at least one application of an application provider. If customers exceed their monthly license agreement, they are billed quarterly in arrears.

Updated 4 months ago


License Configuration


Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.