Announcing the Plugin Development Kit

 

March 12, 2021  |  By Ludwig Tirazona

rpdk logo

Reekoh is constantly finding ways to bring value as quickly as possible to our customers. One area we see this is enabling approved developers to write integration plugins for the Reekoh Accelerate platform.

 

To that end, we have developed a new Plugin Development Kit (PDK) that enables you to rapidly create and test plugins for Reekoh Accelerate on your local machine, with zero reliance on the platform itself. These are what we call “private plugins”, and once verified and approved, are only visible within the Plugin Library for the developer’s platform tenant (not in the public Integrations Library).

The Plugin Development Kit is packaged as a node.js module, and uploaded to npm for easy installation to any machine.

It acts as a runtime environment for node.js plugin code written for Accelerate, and emulates all of the interfaces and services that would be available to a plugin if it were running on the platform.

Here’s a short demonstration of how the PDK works to speed up the plugin development process follows.

 

1. Install the PDK

In the command line, run sudo npm install -g @reekoh/reekoh-plugin-dev-kit‘ to install the PDK to your system.

 

 

2. Create plugin scaffolding

Execute “rpdk setup, and answer the configuration options that appear.

A subdirectory will be created, containing plugin scaffolding according to the given configuration.

For example, the index.js file already contains the functions needed by the type of plugin specified during the setup – just fill in the functions with the required plugin logic.

 

 

3. Verify the plugin files and initialization configuration

After working on the plugin code, verify that all needed plugin files exist and that the plugin can initialize by executing “rpdk verify“.

 

 

4. Test plugin functionality

Input test incoming data for the PDK in config/data.json, and test how the plugin handles it by executing “rpdk process“.

After development, the plugin is then submitted to Reekoh for review.

 

For more information on the Reekoh Plugin Development Kit, see the RPDK End User Documentation in our Support Site.