Extending Mindbreeze InSpire with the SDK

As developers, we can extend the functionality of Mindbreeze InSpire using the Mindbreeze SDK by leveraging the corresponding extension points.

Available Extension Points

With the SDK, we can implement:

• Data Sources
• Filter Services
• Post Filter Transformation Services
• Item Transformation Services
• Query Transformation Services

Downloading the SDK

To get started, navigate to https://downloads.mindbreeze.com and fill out the form. Once submitted, you can access the Mindbreeze Downloads section.

Download the SDK by selecting “Additional Downloads” and choosing the Mindbreeze SDK.

System Requirements

Before installing the Mindbreeze SDK, ensure you have the following dependencies:

• OpenJDK
• Latest supported version of Eclipse
• ANT
• Mindbreeze SDK

The Mindbreeze SDK is compatible with Windows, Red Hat Linux, Mac, and other systems supporting OpenJDK and Eclipse.

Installing the SDK

If using the generic SDK binaries, locate the extracted SDK (typically in your home directory). Use the corresponding executable:

• messjavaplugin.sh (Unix/Linux/Mac)
• messjavaplugin.bat (Windows)

Inside this file, update the paths according to your setup. Running the script without parameters will display available options.

Generating a Plugin

To extend Mindbreeze InSpire, execute the script with the following parameters:

• The extensionpoint to implement
• The name of your plugin
• The base package name for the template

Example: Generating a postfilter template named mypostfilter with mindbreeze as the base package.

./mesjavaplugin.sh postfilter mypostfilter mindbreeze

Building and Installing the Plugin

Executing the script generates an Eclipse project that can be imported directly into Eclipse.

To build the plugin, navigate to the plugins folder and run:

• build.sh (Unix/Linux/Mac)
• build.bat (Windows)

Installing the Plugin in Mindbreeze InSpire

Follow these steps to install your plugin:

1. Navigate to the Mindbreeze InSpire Management Center.
2. Go to Configuration → Plugins.
3. Select the path to your plugin.
4. Click Upload to install it.

Once installed, the plugin appears under the Plugins section. Scroll to the Extension Point Plugins section to see your custom plugin listed.

Next Steps

The implementation details depend on the specific extension point. Additional tutorials cover in-depth guides for different types of plugins.