Configuring Runtime Arguments

Overview

Runtime Arguments are used to Activate/Deactivate specific features or change the default behavior of the OpenFin runtime.

Supported Arguments are (Please note this is not an exclusive list):

`--v=1`

`--diagnostics`

Using shortcut target

Runtime Arguments added to an application shortcut by:

1. right-clicking a shortcut
2. Opening the properties page
3.  Update the target to include: --runtime-arguments=" --<argument>"

This method enables arguments to be applied to individual applications on a desktop.  Please note if the application allows OpenFin to manage the shortcuts the additional parameter will need to be added before each application launch.

Using the system registry (Windows)

Runtime Arguments can be applied at a system level using the system registry.  Any runtime argument configured in the system registry will be applied to all OpenFin applications launched after the argument has been applied.

1.  Open the Windows Registry Editor by running 'regedit':
   1. From the window search bar, type 'regedit'
   2. Select 'Registry Editor' from the search results
   3. Allow the registry editor to make changes to the local system by clicking 'Yes'
   4. Accept the prompt to allow RegEdit to make changes to your device
2. Navigate to HKEY_CURRENT_USER\Software\OpenFin\RVM (Create any missing keys, see below)
   1. For example: if 'openfin' is not listed under 'Software':
   2. Right-click on 'Software'
   3. Select 'New' -> 'Key'
   4. Type the name of the new key (Example 'openfin')
   5. Repeat these steps for other missing keys (Example 'openfin')
3. Right Click on the 'RVM' key
4. Select 'New' -> 'Sting Value'
5.  Name the new entry 'runtimeArgs' (Case sensitive)
6. Right Click on the 'runtimeArgs' entry -> 'Modify'
7. In the 'Value Data' box, add the desired argument
8. Click OK

Using to the Application Configuration

Runtime Arguments can be applied to all users of an application by configuring the argument in the Application Configuration file, for example:

"runtime": {
        "version": "x.x.x.x",
        "arguments" : "--<argument>" 
},