@adaptabletools/adaptable-plugin-openfin 18.0.8 → 18.0.9

package/README.md

@@ -1,32 +1,21 @@
-# AdapTable Openfin Plugin Read Me
+# AdapTable OpenFin Plugin
 
-In order to use this plugin, you have to install `@adaptabletools/adaptable-plugin-openfin` and specify it in your `adaptableOptions` configuration object, as shown below:
+The OpenFin Plugin is intended for use when AdapTable is instantiated inside the [OpenFin](https://www.openfin.co/) container.
 
-```ts
-const adaptableOptions: AdaptableOptions = {
-    adaptableId: 'openfindemo1',
-    plugins: [
-      openfin()
-    ]
-    // ... other options
-}
-```
+This plugin allows users to take advantage of some additional functionality courtesy of OpenFin:
 
-## OpenFin configuration
+- AdapTable’s Alerts can appear as OpenFin Notifications (together with actionable buttons)
+- ‘Live Excel’ - data exported to Excel updates in the spreadsheet in real time as source data in AdapTable ticks
 
-To use the AdapTable-Excel integration with your openfin setup, in your app.json, you need to specify
+ 
+## Documentation & Demos
+
+Full details of how to install, configure and use the OpenFin plugin can be found at [AdapTable OpenFin Documentation](https://docs.adaptabletools.com/guide/integrations-openfin)
 
-```json
-"services": [
-    { "name": "excel",
-        "manifestUrl": "http://openfin.github.io/excel-api-example/provider/app.json"
-    }
-]
-```
 
 ## Help
 
-Developers can learn how to access AdapTable programmatically at [AdapTable Documentation](https://docs.adaptabletools.com) which contains information on using the [OpenFin Plugin](https://docs.adaptabletools.com/guide/integrations-openfin)
+Developers can learn how to access AdapTable programmatically at [AdapTable Documentation](https://docs.adaptabletools.com).
 
 ## Other AdapTable Resources
 
@@ -35,3 +24,7 @@ General information about Adaptable Tools is available at our [Website](http://w
 ## Support
 
 For all support enquiries please email [`support@adaptabletools.com`](mailto:support@adaptabletools.com) or [raise a Support Ticket](https://adaptabletools.zendesk.com/hc/en-us/requests/new).
+
+## Licences
+
+Information on AdapTable Licences can be found at [Licensing AdapTable for AG Grid](https://docs.adaptabletools.com/guide/licensing).

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@adaptabletools/adaptable-plugin-openfin",
-  "version": "18.0.8",
+  "version": "18.0.9",
   "description": "",
   "homepage": "http://www.adaptabletools.com/",
   "author": {
@@ -18,7 +18,7 @@
     "redux": "4.0.5",
     "styled-components": "^4.4.1",
     "tslib": "^2.3.0",
-    "@adaptabletools/adaptable": "18.0.8"
+    "@adaptabletools/adaptable": "18.0.9"
   },
   "type": "module",
   "module": "src/index.js"

package/src/Utilities/Services/OpenFinService.js

@@ -2,7 +2,9 @@ import Emitter from '@adaptabletools/adaptable/src/Utilities/Emitter';
 import { setup } from './setup';
 import { isRunningInOpenfin } from '../isRunningInOpenfin';
 if (isRunningInOpenfin()) {
-    require('../../excel-service/index.js');
+    // Commenting this out as its causing build issues
+    // Need to decide what to do about Excel - old implementation is deprecated and replaced with this:  https://developers.openfin.co/of-docs/docs/excel-integration
+    //  require('../../excel-service/index.js');
 }
 export function isExcelOpenfinLoaded() {
     return isRunningInOpenfin() && 'Excel' in fin.desktop;