Welcome to OpenFin Docs

Explore our guides, resources and references for building with OpenFin

Get Started

Quick start: OpenFin Workspace

OpenFin Workspace is a unified space for work, powered by an extensive set of tools designed to help your firm increase productivity and deliver exceptional employee experiences. Key components of Workspace include a keyboard-driven digital assistant for app discovery and search; a browser for displaying content with complex layouts and shared context; and a rich, actionable notification center, experiences that accelerate time to market, and easy-to-use APIs for hyper-customization.

Key concepts

Before you get started with development, here are some key concepts to know.

  • Built by OpenFin: Workspace components are built and managed by OpenFin. We enable customization through configuration.
  • Component hosting: Workspace components are hosted securely on OpenFin’s CDN.
  • Desktop Owner Settings: Workspace can be configured using the OpenFin Desktop Owner Settings file. For example, this allows you to point Workspace at your own Content Store.
  • Content Discovery Service: By default, Workspace components are configured to point at OpenFin’s Content Discovery Service, which powers the OpenFin Content Store. You can point Workspace at your own Content Discovery Service hosted on your own infrastructure.
  • Versioning: Each release of Workspace is versioned. You can lock the version of Workspace that you run via Desktop Owner Settings.

Set up your environment for Workspace

Prerequisites

The following instructions assume you have already set up your dev environment for working with OpenFin.

To get started in just a few minutes, clone the Workspace Quick Start repository:
git clone https://github.com/openfin/workspace-starter.git

Then follow the setup instructions in the README.

Important

A script in the example repo overwrites any existing contents of Desktop Owner Settings on your system. Be sure to back it up before running the script.

The Content Discovery Service in the example repo provides a local Express server to serve three static JSON files over HTTP GET. Each of these files has a different purpose:

  • dos.json: A sample Desktop Owner Settings file configured to tell Workspace where to find your Content Discovery Service and Workspace Service. Refer to Desktop Owner Settings for complete explanation of everything Desktop Owner Settings are used for (beyond Workspace).
  • apps.json: A sample file that acts as a Content Discovery Service, providing a list of apps that are made available in Workspace. Refer to About Content Discovery Services more detailed explanation of how to use create a Content Discovery Service.
  • workspaces.json: A sample file that acts as a Workspace Service, providing a list of workspaces that are made available in Workspace.

When Workspace starts up, it first looks at the Desktop Owner Settings file (configured in step 3 of the Quick Start project) for:

  • appDirectoryUrl: the location of the Content Discovery Service
  • workspacesUrl: location of the Workspace Service

If Workspace finds these configuration settings, it requests data from the URLs configured instead of from its default endpoints.

Updated 6 days ago


Quick start: OpenFin Workspace


Suggested Edits are limited on API Reference Pages

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