Workspace settings for 3.0 and earlier

OpenFin Workspace allows you to redefine the behavior of many of the features via Desktop Owner Settings.

An example Desktop Owner Settings file with Workspace options looks like this:

{ 
  "desktopSettings": { 
    "systemApps": { 
      "workspace": { 
        "version": "3.0",    
        "customConfig": { 
          "shareUrl": "https://yourserver/api/share",
          "appDirectoryUrl": "https://yourserver/api/apps",
          "workspacesUrl": "https://yourserver/api/workspaces",
          "style": {
            "iconUrl": "https://yourserver/favicon-16x16.png"
          },
          "browserWindowTitle": "MyCompany Browser", 
          "hotkeys" : {
            "toggleHomeVisibility": "CommandOrControl+Space"
          },
          "disableBrowserNewPageButton": true,
          "errorReporting" : {
            "sentryEnabled" : false
          },
          "flags" : {
            "WorkspaceDockEnabled" : true,
            "WorkspaceStorefrontEnabled" : true,
            "WorkspaceHomeEnabled" : true
          }
        } 
      } 
    } 
  } 
}

📘

Note

Between RVM versions 6.1.0.1 and 6.4.1.1, the name of the main setting for system applications was openfinSystemApplications. The minimum required RVM version to use Workspace options is 6.1.0.1.

The version setting enables you to specify the version of Workspace that is available to end-users.

The following table describes the available attributes on the customConfig object:

Name

Type

appDirectoryUrl

string

The content discovery service endpoint for Home to request apps from.

browserWindowTitle

string

The name of the OpenFin Browser window.

disableBrowserNewPageButton

boolean

Whether to hide the "+" button for creating a new Page in the Browser tab bar.

errorReporting.sentryEnabled

boolean (default is true)

Whether all client-side errors are reported to OpenFin. If you are self-hosting, set this option to false.

flags.WorkspaceStorefrontEnabled

boolean

Whether the OpenFin Storefront is available to end-users. Default is false. Workspace 3.0 and later

flags.WorkspaceDockEnabled

boolean

Whether the floating dock feature of Workspace is enabled. Workspace 1.4 and greater

flags.WorkspaceHomeEnabled

boolean

Whether the Home interface is enabled. Workspace 2.0 and greater

hotkeys.toggleHomeVisibility

string

Hotkey to toggle the visibility of Home. The default is CommandOrControl+Space, which is also used when an invalid key string is specified. For a list of acceptable characters and sequences, refer to the Electron accelerators documentation.

shareUrl

string

The content discovery service endpoint for Home to POST share requests to.

style.iconUrl

string

The URL to use when displaying the logo in Home or Browser and for their tray icon. This URL must be CORS enabled.

workspacesUrl

string

The content discovery service endpoint for Home to request workspaces from.


Did this page help you?