OpenFin installer

Depending on whether the system you are installing to has OpenFin previously installed, you can use one of two options to install an OpenFin application:

OpenFin Installer Generator

The OpenFin Installer Generator streamlines the process of installing and updating the OpenFin Runtime on a user's desktop, providing auto-update behavior in response to Runtime version changes in an application's manifest file.

The installer is pre-baked with the application’s manifest URL and is delivered as a zip file containing an installer executable, which can be hosted on any web server. A user opens the .zip file and then double-clicks the .exe to start the installation.

The OpenFin installer performs the following actions:

  • Auto-updates the RVM if necessary.
  • Automatically downloads the required Runtime version if it’s not present.
  • If an application manifest is specified:
    • Retrieves the application manifest file.
    • Installs the desktop and Start menu shortcuts.
    • If Only Self Install is not enabled, launches the app.

Be aware of the following factors when deploying a .zip installer or URL:

  • Administrator rights are not required for installation.
  • The installation file is signed by OpenFin.
  • The installer copies the relevant application resources into %localappdata%/OpenFin.
  • The installer creates application shortcuts on the desktop and (on Windows) in the Start Menu (linked to the application manifest file).

Comparison to RVM

Because the installer invokes the RVM, the two programs are functionally similar. The installer provides a simpler operation by "baking in" some options, so you don't need to specify them manually. Users can run the installer with a double-click, rather than typing a complex command. The following table summarizes the similar functions of the installer and the RVM executable:

FunctionOpenFinRVM.exeopenfin-installer.exe
Auto-updates OpenFin.exeYesYes
Gets the app manifestOptional, via command line argumentBaked into installer, unless omitted
Updates RuntimeYesYes
Creates shortcutsNoFrom app manifest, unless omitted
Launches the appUnless --dnl=trueUnless Do Not Launch is selected

Installation scenarios

There are several ways to use an OpenFin installer, depending on your needs.

Install and launch an application

Use the App Config field in the OpenFin Installer Generator to specify a manifest file for an application to install. The generated installer does the following:

  1. Install or update the RVM.
  2. Install or update the Runtime.
  3. Load and read the manifest file.
  4. Create desktop and (on Windows) Start menu shortcuts based on options in the manifest.
  5. Launch the application.

Install an application without launching it

In addition to the App Config field, enable the Do Not Launch toggle in the Installer Generator. The generated installer does all the previous steps except for #5; it does not launch the application.

Install the RVM without an application

In the OpenFin Installer Generator, omit a value for the App Config field, and enable the toggle for Only Self Install. The generated installer does only the following steps:

  1. Installs or updates the RVM.
  2. Installs or updates the Runtime.

Install silently

Whether you install an application or not, you might want to run the installer from a script without generating any output in the target system's user interface. In the Installer Generator, enable the No UI toggle to suppress visible output from the generated installer.

Folder structure

The OpenFin installer creates a base folder structure with full read-write permissions and places the Runtime Version Manager (RVM) and the OpenFin Runtimes within it.

The following files and folders are contained within the base folder:

  • apps\: Cached copies of the manifest, icon, app logs, and app assets
  • cache\: Runtime cache, runtime logs (debug.log), and login tokens
  • cache.dat: Cached data of OpenFin apps, including system permissions, start and end times, Runtime versions, application ID, etc.
  • data\: The hashed value of all the apps that have run
  • logs\: RVM logs
  • OpenFinRVM.exe: Openfin Runtime Version Manager, responsible for updating itself and downloading/installing new runtime versions
  • registry_dos_local.json: Cached desktop owner settings, generated automatically
  • runtime\: All the Runtime versions that are needed by OpenFin apps. Older versions of the Runtime are not overwritten when adding a new version. However, unused versions of the runtime are removed automatically.
  • rvm_cache\: Cached permissions.

Shortcuts

The OpenFin installer creates application shortcuts that link the server-hosted manifest file with a desktop shortcut or (on Windows) Start Menu item. These shortcuts have a target that takes the following form:

Windows

%localappdata%\OpenFin\OpenFinRVM.exe  --config="https://APP_SERVER.com/PATH_TO_APP/APP_MANIFEST.json"

For more information on customized shortcuts, contact [email protected].

Protocol handler (fin:// fins://)

For systems that already have OpenFin installed, you have the option to use a custom protocol handler to launch OpenFin from within the browser or an email. No downloading of a file is necessary when using this method. You can also detect from a script in a web browser whether the local system has OpenFin installed.

📘

Note

The OpenFin RVM must be installed and registered on the system in order for the fin:// or fins:// protocol handler to be used.

The fin and fins protocol handlers are registered in the system:

Windows
The following registry class roots are used: HKEY_CLASSES_ROOT\fin and HKEY_CLASSES_ROOT\fins

For systems that do not have OpenFin installed, you can push the RVM to the system and run it one time to register the protocol handler. Use the following command for registering the fin/fins protocol handler:

Windows

C:\%username%\AppData\Local\OpenFin>OpenFinRVM --config=none --only-self-install

For more information about the installation process, refer to Deep linking or contact [email protected].