Mindbreeze InSpire SDK Plugins
Item Transformation Launched Service

Preparation

To build and deploy the examples described in this document, the following third-party software is needed:

• Java SE Development Kit - Version 8 or 11
• Eclipse IDE for Java Developers (or IDEs compatible with Eclipse Projects)
• Apache Ant - Version 1.10.12 or newer (Optional)

Installation of the Mindbreeze Software Development Toolkit

Extract the mes-devel-<version>.zip to a folder of your choice and add the SDK/bin folder from the archive to your path variable.

Generating a Mindbreeze Plugin Project

The Mindbreeze Software Development Toolkit contains a tool for generating Mindbreeze Plugin Projects:

• mesjavaplugin.bat for Microsoft Windows installations
• mesjavaplugin.sh for Unix-based systems

The tool can be used for generating the following Mindbreeze extension types:

The mesjavaplugin tool displays its usage with examples when its called without parameter:

Usage: mesjavaplugin.sh <plugin-type> <name> <base package>

Available plugin-types:

  datasource: crawler, contextualization and authorization

  filter: a ContentFilterPlugin. filter has an additional parameter containing the extensions the filter will be used for.

  postfilter: a post filter transformation plugin.

  itemtransformer: an item transformation service plugin.

  itemtransformer-launchedservice: an item transformation launched service plugin.

  searchtransformer: an API V2 search request response transformation plugin.

  queryexpressiontransformer: a query transformation plugin.

Example:

  mesjavaplugin.sh datasource WordPress com.mycompany

  mesjavaplugin.sh filter Text com.mycompany "txt;csv"

  mesjavaplugin.sh postfilter CustomMetadata com.mycompany

  mesjavaplugin.sh itemtransformer CustomMetadata com.mycompany

  mesjavaplugin.sh itemtransformer-launchedservice CustomMetadata com.mycompany

  mesjavaplugin.sh searchtransformer CustomSearchInterface com.mycompany

  mesjavaplugin.sh queryexpressiontransformer CustomName com.mycompany

The parameter <name> is the name of the plugin. The project will be generated in a folder with the name of this parameter lowercased in the current path.

The parameter <base package> is the java package where the source files will be generated.

Item Transformation Launched Service Plugin

Please follow the described steps to generate an item transformer launched service plugin for editing or adding custom metadata:

1. Create the plugin project: mesjavaplugin.sh itemtransformer-launchedservice MetadataProcessor com.myorganization
2. Navigate to the folder metadataprocessor in your current path.
3. Import the newly created project into your Eclipse IDE (as in the previous example).
4. After the import of the project was successful, you will find a stub implementation of the protocol buffer service ItemTransformationService in the file MetadataProcessorItemTransformerService.java and an implementation of LaunchedService in the file MetadataProcessorMain.java.
5. Extend the code according to your needs. This example again adds a metadata named “meta” with the value “value”:

    private void processItem(Item.Builder itemBuilder) {

    itemBuilder.addProperty(

    NamedValue.newBuilder()

    .setName("meta")

    .addValue(ValueHelper.newBuilder(metaPropertyValue))

    );

    }

1. Extend the code in MetadataProcessorMain if there are additional configuration properties that should be passed to the service:

String metaPropertyValue = configuration.getProperty("meta", null);

1. Build the plugin archive by executing the script build.bat on Windows Systems or build.sh on Unix in the project directory. If the process was successful, an archive with the name <name>-itemtransformer-launchedservice.zip should have been produced. Again, <name> is the plugin name parameter that was previously specified.
2. The plugin is ready to be installed in the tab “Plugins” in the Management Center:

Configuration of the Launched Service Plugin

Once the plugin is uploaded, proceed to the tab “Indices” in the section “Services” to continue configuration. Click “Add Service” and select MetadataProcessor from the list of ItemTransformationServicePlugins.

After the service was added, configure the following settings in the section “Service Settings”:

• Webservice Port
• Meta Property Value

The service will be available in the section “Item Transformation Services” of the Index Services.

Plugin Descriptor Configuration Section

The Plugin Descriptor plugins.xml describes the plugins available in the archive. The main outline is as follows:

version

plugins

Plugin

id

kind

extension

code

if kind is “CODE”

properties  

for predefined properties that are passed to the Plugin

config_options

• The element config_options itself is a language for describing configuration user interface elements and therefore allows the plugin developer to extend the Mindbreeze InSpire configuration interface. As an example, the following configuration extends the configuration user interface with the “meta” property.  As of this writing the configuration interface supports English translations only.
• Supported input types are TEXT, NUMBER, BOOLEAN, TEXTAREA, SELECT, PASSWORD, CREDENTIAL.
• Default values can be added via default_string or default_numeric. Select options can be defined using the select_option element.

      <config_option>

        <Group>

          <label>

            <LangString>

              <lang>en</lang>

              <value>Base Configuration</value>

            </LangString>

          </label>

          <level>DEFAULT_LEVEL</level>

          <option>

            <Option>

              <name>meta</name>

              <input>TEXT</input>

              <hint>The value that is added as the meta property.</hint>

              <label>

                <LangString>

                  <lang>en</lang>

                  <value>Meta Property Value</value>

                </LangString>

              </label>

              <option />

            </Option>

            <Option>

              <level>DEFAULT_LEVEL</level>

              <name>BindPort</name>

              <input>NUMERIC</input>

              <hint/>

              <label>

                <LangString>

                  <lang>en</lang>

                  <value>Webservice Port</value>

                </LangString>

              </label>

              <option/>

              <default_numeric>23920</default_numeric>

            </Option>          

          </option>

        </Group>

      </config_option>