AdapTable Version:

Framework:

ipushpull Integration

Summary

The ipushpull integration connects AdapTable with ipushpull - a powerful collaborative software tool
Users are able to send Reports to ipushpull and from there to Symphony and other destinations
These can be either System Reports shipped by AdapTable or bespoke Custom Reports created by users

This plugin enables AdapTable's ipushpull partnership - used for integrating Adaptable with ipushpull.

It includes a dedicated ipushpull toolbar which allows data to be sent from AdapTable (either snapshot or live updates) to an ipushpull page, and other collaborative scenarios.

Note

This is a one-way transmission only; data is sent from AdapTable to ipushpull and not in the other direction

Fostering Collaboration

The ipushpull integration empowers collaboration.

It enables data in Adaptable and AG Grid easily to be shared by multiple users across various systems including Symphony and Bloomberg.

Caution

ipushpull is available as an Adaptable plugin meaning that by default it is not included in AdapTable

ipushpull Reports

Data is exported from AdapTable to ipushpull via ipushpull Reports.

An ipushpull Report contains 3 properties:

ReportName: the name of the Report being exported to ipushpull
Folder: the ipushpull folder containing the page where the exported data is shown
Page: the ipushpull page which will show the exported data

Installing ipusphull

Terminal

npm install @adaptabletools/adaptable-plugin-ipushpull

Caution

If using CommonJS, then install @adaptabletools/adaptable-plugin-ipushpull-cjs instead

Configuring ipushpull

Developer Guide

How to set up ipushpull

These are the steps required:

const adaptableOptions: AdaptableOptions = {
   plugins: [
      ipp({
        username: process.env.IPUSHPULL_USERNAME,
        password: process.env.IPUSHPULL_PASSWORD,
        throttleTime: 5000,
        includeSystemReports: true,
        ippConfig: {
         // see below
       },
     }),
   ],
};

Provide ipushpull credentials

Add the ipp section to the plugins property in Adaptable Options.

Add 2 important properties:

username - your ipushpull username
password - your ipushpull password

Optional properties are available regarding throttling and whether AdapTable's System Reports can be exported.

Find Out More

See ipushpull Plugin Options for full details of these properties

const adaptableOptions: AdaptableOptions = {
   plugins: [
      ipp({
        username: process.env.IPUSHPULL_USERNAME,
        password: process.env.IPUSHPULL_PASSWORD,
        throttleTime: 5000,
        includeSystemReports: true,
        ippConfig: {
           api_secret: process.env.IPUSHPULL_API_KEY,
           api_key: process.env.IPUSHPULL_API_KEY,
           api_url: 'https://www.ipushpull.com/api/1.0',
           ws_url: 'https://www.ipushpull.com',
           web_url: 'https://www.ipushpull.com',
           docs_url: 'https://docs.ipushpull.com',
           storage_prefix: 'ipp_local',
           transport: 'polling',
           hsts: false, // strict cors policy
       },
     }),
   ],
};

Supply the ippConfig property

The ippConfig property is an object which contains configuration details for ipushpull.

Most of these properties should be given the same values as in the example.

However 2 properties require bespoke values to be supplied by each user:

api_secret
api_key

Note

ipushpull should have provided these to you

  // use plugins api to retrieve the iPushPull Api 
  const ipushpullApi = adaptableApi.pluginsApi.getipushpullPluginApi()

Retrieve the ipushpull API object

The ipushpull API section of AdapTable contains many functions for run-time access to the ipushull integration.

It is retrieved via the pluginsAPI section of AdapTable Api.

ipushpull Config

There is no ipushpull Adaptable State that can be supplied by developers at design-time.

Caution

All ipushpull-related state is transient and per-session only and not persisted.

However ipushpull Plugin Options does provide optional configuration settings for running the ipushpull Plugin.

Using ipushpull

Run-time integration with ipushpull is done via a dedicated ipushpull Toolbar.

At start-up this toolbar simply displays a login button that, when clicked, opens a login screen asking for username and password.

Hint

There is a AutoLogin property option which will automatically log the user in to ipushpull (provided that the correct credentials have been provided in ipushpull Plugin Options).

Once the user is successfully logged in, the Toolbar will contain a number of elements, including:

Dropdowns

Reports Dropdown: shows all the Reports that have been created via the Export Module

Note
This dropdown will also include any System Reports that AdapTable ships by default (e.g. Selected Cells); however these can be removed by setting IncludeSystemReports to false
Folders Dropdown: lists all the folders (aka 'Domains') to which the user has access in ipushpull
Pages Dropdown: lists all the ipushpull pages in the currently selected Folder (in the Folders Dropdown)

Buttons

Send Snapshot - runs the current report and send the data to the currently selected ipushpull page. This is a one-off action.
Run Live Report - runs the current report sending the data to the currently selected ipushpull page; also sends live updates so ipushpull is updated in real time, inline with ticking grid data and report updates.

Note
The button displays a 'Play' icon, but when a Live Report is running this changes to a 'Pause' icon.
New ipushpull Page - alllows a new ipushpull page to be created in the folder of the user's choice.
Create Schedule - enables an ipushpull report to be sent at a schedule of the user's choice
Hint
- Adaptable Scheduling enables actions to be performed according to a fixed schedule
- This can be either a one off date and time, or to be repeated daily at a configured time
Logout - logs the User out of ipushpull (and displays the login button).

UI Entitlements

ipushpull is only available to runtime users if:

the AccessLevel for its Entitlement is set to Full
the plugin was injected into Adaptable Options

Note

The ReadOnly Accesslevel Entitlement behaviour is identical to Hidden.

FAQ

Do we need to be an existing ipushpull User to use this? Yes. We provide this functionality only for existing ipushpull users. You will need to provide your username and password in the Login Control.

How do I provide my ipushpull Credentials? As part of ipushpull Plugin Options.

Can I create a new ipushpull page in AdapTable? Yes, you can. This functionality was added in Version 6 (January, 2020).

AdapTable Resources

ipushpull Demo Application contains a live example of ipushpull and AdapTable working together (code here)

PreviousTechnical Reference NextTechnical Reference

Framework: