@adaptabletools/adaptable-plugin-ipushpull 18.0.7 → 18.0.9
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +8 -62
- package/package.json +2 -2
package/README.md
CHANGED
|
@@ -4,68 +4,6 @@ The ipushpull plugin connects AdapTable with [ipushpull](https://www.ipushpull.c
|
|
|
4
4
|
|
|
5
5
|
It allows user to send Reports - either System Reports shipped by AdapTable or those created via the AdapTable Export function - to ipushpull and from their to Symphony and other destinations.
|
|
6
6
|
|
|
7
|
-
## Version 7
|
|
8
|
-
Version 7 of AdapTable made significant changes to how ipushpull is set up, primarily by using this dedicated plugin.
|
|
9
|
-
|
|
10
|
-
As a consequence, the ipushpull section from Predefined Config was removed and no ipushpull information is provided by users that way.
|
|
11
|
-
|
|
12
|
-
Similarly all ipushpull state is now transient and **not persisted** when the application ends.
|
|
13
|
-
|
|
14
|
-
Instead we now use the `ipushpullPluginOptions` object in a similar way to other plugins.
|
|
15
|
-
|
|
16
|
-
The actual ipushpull functionality is unchanged, and the information required to be supplied by the user is identical but it now done through Options and not Predefined Config - isolating it in this way enables us to add more ipushpull-related functionality in a much quicker and safer way, isolated from the rest of the application.
|
|
17
|
-
|
|
18
|
-
## ipushpull Options
|
|
19
|
-
|
|
20
|
-
The ipushpull plugin contains an `ipushpullPluginOptions` object which allows users to set up their instance.
|
|
21
|
-
|
|
22
|
-
It contains credential details, useful properties (e.g. `throttleTime`, `autoLogin` etc.) and the ipupshpull config object.
|
|
23
|
-
|
|
24
|
-
## ipushpull Api
|
|
25
|
-
|
|
26
|
-
The `ipushpullApi` is available for full runtime programmatic access to ipushpull objects and methods.
|
|
27
|
-
|
|
28
|
-
> Note: because ipushpull is a plugin, you can get hold of this object through the `getPluginApi` method of pluginsApi.
|
|
29
|
-
|
|
30
|
-
## ipushpull Setup Example
|
|
31
|
-
|
|
32
|
-
```ts
|
|
33
|
-
|
|
34
|
-
// set up AdaptableOptions
|
|
35
|
-
const adaptableOptions: AdaptableOptions = {
|
|
36
|
-
******
|
|
37
|
-
plugins: [
|
|
38
|
-
ipp({
|
|
39
|
-
username: process.env.IPUSHPULL_USERNAME,
|
|
40
|
-
password: process.env.IPUSHPULL_PASSWORD,
|
|
41
|
-
throttleTime: 5000,
|
|
42
|
-
includeSystemReports: true,
|
|
43
|
-
ippConfig: {
|
|
44
|
-
api_secret: process.env.IPUSHPULL_API_KEY,
|
|
45
|
-
api_key: process.env.IPUSHPULL_API_KEY,
|
|
46
|
-
api_url: 'https://www.ipushpull.com/api/1.0',
|
|
47
|
-
ws_url: 'https://www.ipushpull.com',
|
|
48
|
-
web_url: 'https://www.ipushpull.com',
|
|
49
|
-
docs_url: 'https://docs.ipushpull.com',
|
|
50
|
-
storage_prefix: 'ipp_local',
|
|
51
|
-
transport: 'polling',
|
|
52
|
-
hsts: false, // strict cors policy
|
|
53
|
-
},
|
|
54
|
-
}),
|
|
55
|
-
],
|
|
56
|
-
******
|
|
57
|
-
};
|
|
58
|
-
|
|
59
|
-
// Instantitate AdapTable and get the main Api object
|
|
60
|
-
adaptableApi = await Adaptable.init(adaptableOptions);
|
|
61
|
-
|
|
62
|
-
// use the plugins api to get the IPushPullApi object
|
|
63
|
-
const ipushpullApi: IPushPullApi = adaptableApi.pluginsApi.getPluginApi(
|
|
64
|
-
'ipushpull'
|
|
65
|
-
);
|
|
66
|
-
|
|
67
|
-
```
|
|
68
|
-
|
|
69
7
|
## ipushpull Toolbar
|
|
70
8
|
|
|
71
9
|
The ipushpull plugin includes a dedicated ipushpull Toolbar - the main way to interact with ipushpull inside AdapTable.
|
|
@@ -99,6 +37,10 @@ Once the user is successfully logged in, the Toolbar will contain a number of el
|
|
|
99
37
|
|
|
100
38
|
5. **Logout Button** - logs the User out of ipushpull (and displays the login button).
|
|
101
39
|
|
|
40
|
+
## Documentation & Demos
|
|
41
|
+
|
|
42
|
+
Full details of how to install and use the ipushpull plugin, together with many demos, can be found at [AdapTable ipushpull Documentation][(https://docs.adaptabletools.com/guide/handbook-master-detail](https://docs.adaptabletools.com/guide/integrations-ipushpull))
|
|
43
|
+
|
|
102
44
|
|
|
103
45
|
## Help
|
|
104
46
|
|
|
@@ -111,3 +53,7 @@ General information about Adaptable Tools is available at our [Website](http://w
|
|
|
111
53
|
## Support
|
|
112
54
|
|
|
113
55
|
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).
|
|
56
|
+
|
|
57
|
+
## Licences
|
|
58
|
+
|
|
59
|
+
Information on AdapTable Licences can be found at [Licensing AdapTable for AG Grid](https://docs.adaptabletools.com/guide/licensing).
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@adaptabletools/adaptable-plugin-ipushpull",
|
|
3
|
-
"version": "18.0.
|
|
3
|
+
"version": "18.0.9",
|
|
4
4
|
"description": "",
|
|
5
5
|
"homepage": "http://www.adaptabletools.com/",
|
|
6
6
|
"author": {
|
|
@@ -19,7 +19,7 @@
|
|
|
19
19
|
"styled-components": "^4.4.1",
|
|
20
20
|
"tinycolor2": "^1.4.2",
|
|
21
21
|
"tslib": "^2.3.0",
|
|
22
|
-
"@adaptabletools/adaptable": "18.0.
|
|
22
|
+
"@adaptabletools/adaptable": "18.0.9"
|
|
23
23
|
},
|
|
24
24
|
"type": "module",
|
|
25
25
|
"module": "src/index.js"
|