Writing and testing your own plugins

Content Intelligence Administration Guide

Version
3.0.x
File Size
465 KB
Audience
anonymous
Part Number
MK-HCI000-19

You use the plugin software development kit (SDK) to write your own stage and data connection plugins. The SDK is contained in this file:

HCI-Plugin-SDK-<version>.tgz

For information on obtaining this file, see your sales representative or administrator.

Tip: You can use also use the JavaScript pipeline stage to add your own custom document transformations to a pipeline. In some cases, this might be preferable to developing a stage plugin and uploading it to Hitachi Content Intelligence.

About the plugin SDK

The plugin SDK is in the form of a Java API. To build plugins, you need the Java Development Kit (JDK) version 17 or higher. You can download the JDK from http://www.oracle.com/.

Plugin requirements

The plugins you write need to be grouped into plugin bundles. A plugin bundle can contain one or more plugins. The SDK includes instructions on grouping your plugins as plugin bundles.

Testing your plugins

Hitachi Content Intelligence includes a plugin test harness for debugging your plugins and ensuring that they meet system requirements. The plugin test harness does not need a running system.

You can find the test harness and its documentation under the plugin-test folder in the plugin SDK package.