Skip to content

Latest commit

 

History

History
149 lines (127 loc) · 10 KB

how-to-setup-example-home-integrations.md

File metadata and controls

149 lines (127 loc) · 10 KB

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

<- Back to Table Of Contents

How To Add Salesforce, ServiceNow or MS365 support to Home?

Workspace has built-in support for MS365 through our low code implementation and this can be configured in Workspace Platform Starter. OpenFin also offers npm packages that make it easy to integrate with other platforms and we have examples on how to use our Salesforce, ServiceNow, and MS365 npm packages. These examples are built and published on github.io and the following section shows how they can be added to a manifest (or through a settings service).

Salesforce

Our Salesforce example already exists in the main manifest.fin.json in the integrationProvider section. It is disabled and would need to be enabled and the details about your Salesforce Organization would need to be added.

 {
     "id": "salesforce",
     "icon": "https://built-on-openfin.github.io/workspace-starter/workspace/v17.0.0/integrate-with-salesforce/favicon.ico",
     "title": "Salesforce",
     "enabled": false,
     "url": "https://built-on-openfin.github.io/workspace-starter/workspace/v17.0.0/integrate-with-salesforce/js/modules/integrations/salesforce.bundle.js",
     "data": {
      "consumerKey": "",
      "orgUrl": "",
      "preload": "https://built-on-openfin.github.io/workspace-starter/workspace/v17.0.0/integrate-with-salesforce/js/preload.js",
      "enableLibLogging": true,
      "iconMap": {
       "salesforce": "https://built-on-openfin.github.io/workspace-starter/workspace/v17.0.0/integrate-with-salesforce/images/salesforce.svg",
       "contact": "https://built-on-openfin.github.io/workspace-starter/workspace/v17.0.0/integrate-with-salesforce/images/contact.svg",
       "account": "https://built-on-openfin.github.io/workspace-starter/workspace/v17.0.0/integrate-with-salesforce/images/account.svg",
       "chatter": "https://built-on-openfin.github.io/workspace-starter/workspace/v17.0.0/integrate-with-salesforce/images/chatter.svg",
       "note": "https://built-on-openfin.github.io/workspace-starter/workspace/v17.0.0/integrate-with-salesforce/images/note.svg",
       "task": "https://built-on-openfin.github.io/workspace-starter/workspace/v17.0.0/integrate-with-salesforce/images/task.svg",
       "dashboard": "https://built-on-openfin.github.io/workspace-starter/workspace/v17.0.0/integrate-with-salesforce/images/dashboard.svg",
       "phone": "https://built-on-openfin.github.io/workspace-starter/workspace/v17.0.0/integrate-with-salesforce/images/phone.svg",
       "chat": "https://built-on-openfin.github.io/workspace-starter/workspace/v17.0.0/integrate-with-salesforce/images/chat.svg",
       "email": "https://built-on-openfin.github.io/workspace-starter/workspace/v17.0.0/integrate-with-salesforce/images/email.svg"
      }
     }
    },

This examples supports a number of configuration settings (covered in the sample) so that you can adapt it to your needs. It can give you a UI similar to the following:

Salesforce

ServiceNow

Our ServiceNow example already exists in the main manifest.fin.json in the integrationProvider section. It is disabled and would need to be enabled and the details about your ServiceNow setup would need to be added.

{
  "id": "servicenow",
  "icon": "https://built-on-openfin.github.io/workspace-starter/workspace/v17.0.0/integrate-with-servicenow/favicon.ico",
  "title": "ServiceNow",
  "enabled": false,
  "url": "https://built-on-openfin.github.io/workspace-starter/workspace/v17.0.0/integrate-with-servicenow/js/integrations/servicenow.bundle.js",
  "data": {
    "instanceUrl": "",
    "clientId": "",
    "enableLibLogging": true,
    "images": {
      "servicenow": "https://built-on-openfin.github.io/workspace-starter/workspace/v17.0.0/integrate-with-servicenow/images/apps/servicenow.svg",
      "contact": "https://built-on-openfin.github.io/workspace-starter/workspace/v17.0.0/integrate-with-servicenow/images/types/contact.svg",
      "account": "https://built-on-openfin.github.io/workspace-starter/workspace/v17.0.0/integrate-with-servicenow/images/types/account.svg",
      "case": "https://built-on-openfin.github.io/workspace-starter/workspace/v17.0.0/integrate-with-servicenow/images/types/case.svg",
      "task": "https://built-on-openfin.github.io/workspace-starter/workspace/v17.0.0/integrate-with-servicenow/images/types/task.svg",
      "incident": "https://built-on-openfin.github.io/workspace-starter/workspace/v17.0.0/integrate-with-servicenow/images/types/incident.svg",
      "call": "https://built-on-openfin.github.io/workspace-starter/workspace/v17.0.0/integrate-with-servicenow/images/icons/call.svg",
      "email": "https://built-on-openfin.github.io/workspace-starter/workspace/v17.0.0/integrate-with-servicenow/images/icons/email.svg"
    }
  }
}

ServiceNow

MS365

Our MS365 Example is similar to the low code implementation. It shows you how you can query the graph API and return templated results into Home.

Our MS365 example already exists in the main manifest.fin.json in the integrationProvider section. It is disabled and would need to be enabled and the details about your MS365 setup would need to be added.

{
  "id": "ms365",
  "icon": "https://built-on-openfin.github.io/workspace-starter/workspace/v17.0.0/integrate-with-ms365/favicon.ico",
  "title": "Microsoft 365",
  "enabled": false,
  "url": "https://built-on-openfin.github.io/workspace-starter/workspace/v17.0.0/integrate-with-ms365/js/integrations/ms365.bundle.js",
  "data": {
    "clientId": "",
    "tenantId": "",
    "redirectUri": "http://localhost:8080/oauth_redirect.html",
    "permissions": [
      "User.Read",
      "Presence.Read",
      "Presence.Read.All",
      "Directory.Read.All",
      "Mail.ReadWrite",
      "Contacts.Read",
      "Tasks.Read",
      "Calendars.ReadWrite",
      "Chat.Read",
      "ChannelMessage.Read.All",
      "TeamMember.Read.All",
      "ChannelMember.Read.All",
      "Files.Read.All",
      "Sites.Read.All"
    ],
    "disableGraphExplorer": false,
    "enableLibLogging": true,
    "images": {
      "microsoft365": "https://built-on-openfin.github.io/workspace-starter/workspace/v17.0.0/integrate-with-ms365/images/apps/microsoft365.svg",
      "teams": "https://built-on-openfin.github.io/workspace-starter/workspace/v17.0.0/integrate-with-ms365/images/apps/teams.svg",
      "word": "https://built-on-openfin.github.io/workspace-starter/workspace/v17.0.0/integrate-with-ms365/images/apps/word.svg",
      "excel": "https://built-on-openfin.github.io/workspace-starter/workspace/v17.0.0/integrate-with-ms365/images/apps/excel.svg",
      "onenote": "https://built-on-openfin.github.io/workspace-starter/workspace/v17.0.0/integrate-with-ms365/images/apps/onenote.svg",
      "powerpoint": "https://built-on-openfin.github.io/workspace-starter/workspace/v17.0.0/integrate-with-ms365/images/apps/powerpoint.svg",
      "outlook": "https://built-on-openfin.github.io/workspace-starter/workspace/v17.0.0/integrate-with-ms365/images/apps/outlook-mail.svg",
      "email": "https://built-on-openfin.github.io/workspace-starter/workspace/v17.0.0/integrate-with-ms365/images/icons/email.svg",
      "calendar": "https://built-on-openfin.github.io/workspace-starter/workspace/v17.0.0/integrate-with-ms365/images/icons/calendar.svg",
      "share": "https://built-on-openfin.github.io/workspace-starter/workspace/v17.0.0/integrate-with-ms365/images/icons/share.svg",
      "chat": "https://built-on-openfin.github.io/workspace-starter/workspace/v17.0.0/integrate-with-ms365/images/icons/chat.svg",
      "call": "https://built-on-openfin.github.io/workspace-starter/workspace/v17.0.0/integrate-with-ms365/images/icons/call.svg",
      "contact": "https://built-on-openfin.github.io/workspace-starter/workspace/v17.0.0/integrate-with-ms365/images/icons/contact.svg",
      "team": "https://built-on-openfin.github.io/workspace-starter/workspace/v17.0.0/integrate-with-ms365/images/icons/team.svg",
      "file": "https://built-on-openfin.github.io/workspace-starter/workspace/v17.0.0/integrate-with-ms365/images/icons/file.svg",
      "folder": "https://built-on-openfin.github.io/workspace-starter/workspace/v17.0.0/integrate-with-ms365/images/icons/folder.svg",
      "channel": "https://built-on-openfin.github.io/workspace-starter/workspace/v17.0.0/integrate-with-ms365/images/icons/channel.svg",
      "clock": "https://built-on-openfin.github.io/workspace-starter/workspace/v17.0.0/integrate-with-ms365/images/icons/clock.svg",
      "check": "https://built-on-openfin.github.io/workspace-starter/workspace/v17.0.0/integrate-with-ms365/images/icons/check.svg",
      "cross": "https://built-on-openfin.github.io/workspace-starter/workspace/v17.0.0/integrate-with-ms365/images/icons/cross.svg"
    }
  }
}

MS365

Further Information

To know more about how custom integrations can be added to Home please see How to Add Integrations to Home.

To know more about our integrations please visit the content on the OpenFin website:

<- Back to Table Of Contents