Mindbreeze InSpire SDK Plugins
Item Transformation Launched Service

Vorbereitung

Zum Erstellen und Bereitstellen der in diesem Dokument beschriebenen Beispiele ist folgende Drittanbieter-Software erforderlich:

• Java SE Development Kit – Version 8 oder 11
• Eclipse IDE für Java-Entwickler (oder IDEs kompatibel mit Eclipse Projects)
• Apache Ant – Version 1.10.12 oder neuer (optional)

Installation des Mindbreeze Software Development Toolkit

Entpacken Sie die Datei „mes-devel-<Version>.zip“ in einen Ordner Ihrer Wahl und fügen Sie den Ordner „SDK/bin“ aus dem Archiv zu Ihrer Pfadvariable hinzu.

Generierung eines Mindbreeze Plugin Project

Das Mindbreeze Software Development Toolkit enthält ein Tool zum Erstellen von Mindbreeze-Plugin-Projekten:

• mesjavaplugin.bat für Microsoft Windows Installationen
• mesjavaplugin.sh für Unix-basierte Systeme

Das Tool kann zur Generierung der folgenden Mindbreeze-Erweiterungstypen verwendet werden:

Das Tool mesjavaplugin zeigt seine Verwendung anhand von Beispielen an, wenn es ohne Parameter aufgerufen wird:

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

Der Parameter <name> ist der Name des Plugins. Das Projekt wird in einem Ordner mit dem Namen dieses Parameters in Kleinbuchstaben im aktuellen Pfad erstellt.

Der Parameter <base package> ist das Java-Paket, in dem die Quelldateien erstellt werden.

Item Transformation Launched Service Plugin

Bitte befolgen Sie die beschriebenen Schritte, um ein Item Transformer Plugin zum Bearbeiten oder Hinzufügen benutzerdefinierter Metadaten zu erstellen:

1. Erstellen Sie das Plugin-Projekt: mesjavaplugin.sh itemtransformer-launchedservice MetadataProcessor com.myorganization
2. Navigieren Sie zum Ordner metadataprocessor in Ihrem aktuellen Pfad.
3. Importieren Sie das neu erstellte Projekt in Ihre Eclipse IDE (wie im vorherigen Beispiel).
4. Nach dem erfolgreichen Import des Projekts finden Sie eine Stub-Implementierung des Protocol Buffer Service ItemTransformationService in der Datei MetadataProcessorItemTransformerService.java und eine Implementierung von LaunchedService in der Datei MetadataProcessorMain.java.
5. Erweitern Sie den Code entsprechend Ihrer Anforderungen. In diesem Beispiel wird erneut ein Metadatum mit dem Namen „meta” und dem Wert „value” hinzugefügt:

    private void processItem(Item.Builder itemBuilder) {

    itemBuilder.addProperty(

    NamedValue.newBuilder()

    .setName("meta")

    .addValue(ValueHelper.newBuilder(metaPropertyValue))

    );

    }

1. Erweitern Sie den Code in MetadataProcessorMain, wenn zusätzliche Konfigurationseigenschaften an den Service übergeben werden sollen:

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

1. Erstellen Sie das Plugin-Archiv, indem Sie das Skript build.bat unter Windows oder build.sh unter Unix im Projektverzeichnis ausführen. Wenn der Vorgang erfolgreich war, sollte ein Archiv mit dem Namen <name>-itemtransformer-launchedservice.zip erstellt worden sein. Auch hier ist <name> der zuvor festgelegte Parameter für den Namen des Plugins.
2. Das Plugin kann nun im Management Center im Tab „Plugins” installiert werden:

Konfiguration des Launched Service Plugin

Sobald das Plugin hochgeladen ist, fahren Sie mit der Konfiguration fort, indem Sie im Tab „Indices“ zum Abschnitt „Services“ gehen. Klicken Sie auf „Add Service“ und wählen Sie MetadataProcessor aus der Liste der ItemTransformationServicePlugins aus.

Nachdem der Service hinzugefügt wurde, konfigurieren Sie die folgenden Einstellungen im Abschnitt „Service Settings“:

• Webservice Port
• Meta Property Value

Der Service wird im Abschnitt „Item Transformation Services“ der Index-Services verfügbar sein.

Plugin Descriptor Konfigurationsabschnitt

Der Plugin Descriptor plugins.xml beschreibt die im Archiv verfügbaren Plugins. Der Hauptüberblick sieht wie folgt aus:

version

plugins

Plugin

id

kind

extension

code

wenn die Art “CODE” ist

properties  

für vordefinierte Eigenschaften, die an das Plugin übergeben werden

config_options

• Das Element config_options selbst ist eine Sprache zur Beschreibung von Elementen der Konfigurations-Benutzeroberfläche und ermöglicht es dem Plugin-Entwickler somit, die Mindbreeze InSpire-Konfigurationsoberfläche zu erweitern. Als Beispiel erweitert die folgende Konfiguration die Konfigurationsbenutzeroberfläche um die Eigenschaft „meta“.  Zum Zeitpunkt der Erstellung dieses Dokuments unterstützt die Konfigurationsoberfläche nur englische Übersetzungen.
• Unterstützte Eingabetypen sind TEXT, NUMBER, BOOLEAN, TEXTAREA, SELECT, PASSWORD und CREDENTIAL.
• Standardwerte können über default_string oder default_numeric hinzugefügt werden. Auswahloptionen können mit dem Element select_option definiert werden.

      <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> Der Wert, der als Meta-Eigenschaft hinzugefügt wird.</hint>

              <label>

                <LangString>

                  <lang>en</lang>

                  <value>Wert der Meta-Eigenschaft</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>