Welcome to OpenFin Docs

Explore our guides, resources and references for building with OpenFin

Get Started

About Content Discovery Service

For use with OpenFin Home, a Content Discovery Service is one that implements the GET methods of the FDC3 App Directory specification, with some additional optional properties for defining the content items. A content discovery service can provide apps or workspaces.

The OpenFin RVM locates the Content Discovery Service through configuration settings, described in Use your own content discovery service.

📘

Note

If the endpoint of the content discovery service requires the user to log in, that authentication must occur before launching OpenFin Home.

To create and use a Content Discovery Service, follow these steps:

  1. The Content Discovery Service endpoint needs to return a JSON file that contains an array of content entry objects. The structure of app definition is shown in the following JSON.
{
  "appId": "string",
  "name": "string",
  "manifest": "string",
  "manifestType": "string",
  "version": "string",
  "title": "string",
  "description": "string",
  "images": [
    {
      "url": "string"
    }
  ],
  "contactEmail": "string",
  "supportEmail": "string",
  "intents": [
    {
      "name": "string",
      "displayName": "string",
      "contexts": [
        "string"
      ]
    }
  ]
}

For use with Workspace, only the appId, name, manifest, manifestType, and title fields are mandatory.

  1. Host this object on a web endpoint. This object must be on a server.

  2. Each app entry must point to a “content manifest” using the manifest property in the Content Discovery Service object. If one does not already exist, create and host a content manifest for each entry in the directory. You can use localhost for development purposes. There are three types of content manifests. The definition of a content manifest varies based on the type, but the properties common to all manifest types are listed in our API docs. Below are the three manifest types with links to their additional properties:

  • view: A view represents a single web URL. The manifest attribute of this entry points to a view manifest as defined in View manifest options. This URL is launched into OpenFin Browser.
  • snapshot: A snapshot represents one or more windows that each can have one or more web applications. The manifest attribute of this entry points to a snapshot manifest as defined here. The snapshot will be launched into OpenFin Browser. To learn more about snapshots please see the OpenFin Platform API.
  • manifest: The manifest attribute of this entry points to an OpenFin app manifest. This app is launched as a standalone OpenFin application.

Updated 3 months ago


About Content Discovery Service


Suggested Edits are limited on API Reference Pages

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