ℹ️ OpenFin Workspace: OpenFin Workspace is a commercial product and this repo is for evaluation purposes (See LICENSE.MD). Use of the OpenFin Container and OpenFin Workspace components is only granted pursuant to a license from OpenFin (see manifest). Please contact us if you would like to request a developer evaluation key or to discuss a production license.
This example demonstrates handling Excel from a background provider which acts as a bridge to communicate the data to other components.
This application you are about to install is a simple example of plugging in your own content or app. This example assumes you have already set up your development environment
To run this sample you can:
- Clone this repo and follow the instructions below. This will let you customize the sample to learn more about our APIs.
- Launch the Github hosted version of this sample to interact with it by going to the following link: Github Workspace Starter Integrate with Excel
- Install dependencies and build the project. Note that these examples assume you are in the sub-directory for the example.
npm run setup-
Optional (if you wish to pin the version of OpenFin Workspace to version 20.0.0 and you are on Windows) - Set Windows registry key for Desktop Owner Settings. This example runs a utility dos.mjs that adds the Windows registry key for you, pointing to a local desktop owner settings file so you can test these settings. If you already have a desktop owner settings file, this script prompts to overwrite the location. Be sure to capture the existing location so you can update the key when you are done using this example.
(WARNING: This script kills all open OpenFin processes. This is not something you should do in production to close apps as force killing processes could kill an application while it's trying to save state/perform an action).
npm run dos- Start the test server in a new window.
npm run start- Start Your Workspace Platform (this starts Workspace if it isn't already running).
npm run client-
You can use the custom command in the search box
/excelwhich will provide a list of workbooks that can be opened. Follow the instructions in the workbooks to see their functionality in action. -
If you change the code and wish to build the project.
npm run buildThis is a headless application. If you wish to debug it then you can update the manifest file and set platform.autoShow to true.
This example uses context to communicate the data from the Excel workbooks to any other components listening for the FDC3 messages.
The list of apps in home will show the excel worksheets that are configured in manifest.fin.json.
This is an example of how to use our APIs to configure OpenFin Workspace. It's purpose is to provide an example and provide suggestions. This is not a production application and shouldn't be treated as such. Please use this as a guide and provide feedback. Thanks!