Glue42 Plugin

The Glue42 Plugin is designed for when AdapTable will be used on a desktop also running Glue42.

This plugin leverages many of the powerful features of Glue42 to offer users additional options such as fully audited and validated 2 way export between AdapTable and Excel.

Setup

To set up the plugin and access the Glue42 Api object, follow these steps:

  1. Import the plugin:

    import glue42 from '@adaptabletools/adaptable-plugin-glue42';
  2. Import the Glue42 Api and and Glue42PluginOptions (typically from the 'types' folder), and import the Glue42 desktop and office objects:

    import { Glue42PluginOptions, Glue42Api } from '@adaptabletools/adaptable/types';
    import glue42Desktop from '@glue42/desktop';
    import glue42office from '@glue42/office';
  1. Create the Glue42PluginOptions as appropriate:

    const glue42PluginOptions: Glue42PluginOptions = {
    glue: glue42Desktop, // this is the glue object
    glue42Office: glue42office, // this is the Glue4Office object
    username: 'myGlue42Username',
    password: 'mygGlue42Passowrd', // ususally put in .env file
    }
  2. Specify the Plugin in Adaptable Options passing in the Options set up in the previous step:

    const adaptableOptions: AdaptableOptions = {
    adaptableId: 'glue42demo',
    plugins: [glue42(glue42PluginOptions)],
    // ... other options
    }
  3. Access the Glue42 Api via the main Adaptable Api object and use as needed:

    const glue42Api: Glue42Api = adaptableApi.pluginsApi.getPluginApi(
    'glue42'
    );

Glue42 Toolbar

The Glue42 Plugin makes a dedicated Dashboard Toolbar called 'Glue42' available.

important

This makes it possible to run Live Reports in Excel

The Toolbar can be referenced in Dashboard Predefined Config as follows:

const demoConfig: PredefinedConfig = {
Dashboard: {
Tabs: [
{
Name: 'Dashboard Toolbars',
Toolbars: ['Layout', 'Glue42', 'Export'],
},
],
},
};

Live Reports

One feature available when AdapTable is running in the Glue42 Plugin is Live Export via Excel.

This enables grid data to be sent from AdapTable to Excel with 2 way updates:

note

Any Reports created in the Export function will appear in the Toolbar

  • Excel will automatically update in line with cell edits and ticking data changes in AdapTable
  • Any date edits made directly in Excel will be automatically reflected in AdapTable
tip

Live Reports can, like all Reports, be set to run on a Schedule.

Cell Validation

Any data that is edited in Excel when running Live Reports will be subject to any Cell Validation rules that have been created in AdapTable.

When a Cell Validation Rule is broken Excel will show an error to indicate which cell has failed and why.

This ensures that data in Excel are not only validated but (thanks to Audit Log) also fully audited.

Further Information