Skip to content

Latest commit

 

History

History

integrate-with-rss

OpenFin Workspace Example Application -- Adding your application to OpenFin Workspace (Home, Browser & Store)

ℹ️ 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.

Integrate With RSS Feeds

OpenFin Workspace can integrate with many data sources, this starter demonstrates monitoring an RSS feed for data, showing notifications when new entries are added or change, and letting you launch entries in Browser windows. You can also search through home for feed entries which match the input query.

Running the Sample

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.

Getting Started

  1. Install dependencies and do the initial build. Note that these examples assume you are in the sub-directory for the example.
npm run setup
  1. 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
  1. Start the test server in a new window.
npm run start
  1. Start Your Workspace Platform (this starts Workspace if it isn't already running).
npm run client
  1. Type any character into the search box which will search for matching entries in the RSS feed. Any matching entries can be viewed. A background process will also monitor the RSS feed for any changes or additions.

  2. If you modify the project and wish to rebuild you can run setup again or the build command below:

npm run build

Note About This Example

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!


Read more about working with Workspace