Skip to content

Latest commit

 

History

History
83 lines (49 loc) · 4.08 KB

README.md

File metadata and controls

83 lines (49 loc) · 4.08 KB
Raw

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. OpenFin Workspace is currently only supported on Windows although you can run the sample on a Mac for development purposes.

Integrate With ServiceNow

OpenFin Workspace empowers you to browse and search your ServiceNow data using OpenFin Home, via our ServiceNow integration API. OpenFin Home provides you with a fast and intuitive interface for discovering your ServiceNow data.

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

Configure ServiceNow

Before you can integrate your ServiceNow with OpenFin Home, you must following the required configuration steps for our ServiceNow integration.

When configuring CORS, the URL that you need to add is: http://localhost:8080, corresponding to the hostname and port number that this sample uses.

Once you have completed the configuration steps, update the customSettings section in the sample app's manifest file as follows:

  • instanceUrl the url of your ServiceNow instance
  • clientId the client id of your application

With ServiceNow configured and the sample custom settings updated, you can continue to run the sample.

Run The Sample

  1. Install dependencies. Note that these samples assume you are in the sub-directory for the sample.
npm install

  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. At this point you will be prompted to log in to your ServiceNow instance), and to authorize your App's request for permissions.

  2. Assuming login and authorization was successful, OpenFin Home will appear. Start typing in Home and your ServiceNow case, tasks and incidents will be searched.

  3. Build the project if you have modified the code.

npm run build

What does it look like?

When performing a search you should see results similar to the following.

ServiceNow Integration

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