Deklarierte Einstellungen

Die deklarierten Einstellungen werden durch das Element <declare /> dargestellt. Das Element kann mit folgenden Attributen verwendet werden:

In der aktuellen Version werden die Attribute required und hidden nicht in der Benutzeroberfläche des Discovery-Produkts angewendet.

Beispiele für deklarierte Einstellungen

Um einen enum-Typ zu deklarieren, verwenden Sie einen Code, der dem folgenden Snippet ähnelt:

<declare type="enum" name="type" enum-values="PROXY|BASIC|NTLM" initial-value="BASIC"/>

Um eine versteckte string mit einem Anfangswert zu deklarieren, verwenden Sie einen Code, der dem folgenden Snippet ähnelt:

<declare type="string" name="custom_config_class" hidden="true" initial-value="com.example.ExampleCrawlerConfig" />

Um eine erforderliche long zu deklarieren, verwenden Sie einen Code, der dem folgenden Ausschnitt ähnelt:

<declare type="long" name="port" required="required" initial-value="22"/>

Bedingte Einstellungen

Bedingte Einstellungen werden durch das Element <condition /> dargestellt. Eine bedingte Einstellung wird nur angezeigt, wenn die Bedingung erfüllt ist. Das Element kann mit folgenden Attributen verwendet werden:

Im aktuellen Release werden bedingte Einstellungen nicht in der Benutzerschnittstelle des Produkts Discovery angewendet.

Beispiele für bedingte Einstellungen

Um einen Abschnitt mithilfe einer boolean-Bedingung zu aktivieren, verwenden Sie einen Code, der dem folgenden Snippet ähnelt:

<declare type="boolean" name="use_key" initial-value="true" />

<condition name="use_key" enabled="true">
  <declare type="string" name="key" hidden="false" />
</condition>

Um einen Abschnitt mithilfe einer enum-Bedingung zu aktivieren, verwenden Sie einen Code, der dem folgenden Snippet ähnelt:

<declare type="enum" name="type" enum-values="PROXY|BASIC|NTLM" initial-value="BASIC"/>

<condition name="type" in="BASIC|NTLM|PROXY">
</condition>

<condition name="type" in="PROXY">

Abschnitt general_settings

Der XPath-Ausdruck lautet /function/prototype/proto-section[@section="general_settings"]. Es enthält allgemeine Einstellungen für alle Crawler, einschließlich der folgenden Einstellungen:

<declare type="string" name="crawler_name" />
<declare type="string" name="description" />
<declare type="long" name="fetch_interval" initial-value="0" />
<declare type="long" name="number_of_max_threads" initial-value="10" />
<declare type="long" name="number_of_max_documents" initial-value="2000000000" />
<declare type="long" name="max_page_length" initial-value="32768" />

Der angepasste Crawler wird mit den folgenden Einstellungen im Abschnitt general_settings initialisiert. Informationen zu den Schnittstellen finden Sie in Code für angepassten Connector entwickeln.

Verwenden Sie zur Angabe der Schnittstellen einen Code, der dem folgenden Snippet ähnelt:

  <declare type="string" name="custom_config_class" hidden="true" initial-value="com.ibm.es.ama.custom.crwler.sample.sftp.SftpCrawler" />

  <declare type="string" name="custom_crawler_class" hidden="true" initial-value="com.ibm.es.ama.custom.crwler.sample.sftp.SftpCrawler" />

  <declare type="string" name="custom_security_class" hidden="true" initial-value="com.ibm.es.ama.custom.crwler.sample.sftp.SftpCrawler" />

  <declare type="boolean" name="document_level_security_supported" initial-value="true" hidden="true"/>

Wenn Sie einen angepassten Connector mit einem SDK-Paket erstellt haben, das mit Version 2.2.1 oder früher gebündelt wurde, muss document_level_security_supported inaktiviert sein (auf false gesetzt). Sicherheit auf Dokumentebene wird in 2.2.1 und früheren Releases nicht unterstützt. Die Option Sicherheit auf Dokumentebene aktivieren wird jedoch in Discovery angezeigt, auch wenn die Sicherheit auf Dokumentebene nicht unterstützt wird. Wählen Sie diese Option nicht aus, wenn Sie eine neue Objektgruppe erstellen.

Führen Sie die folgenden Schritte aus, um die Option Sicherheit auf Dokumentebene aktivieren in Discovery auszublenden, wenn der angepasste Connector mit einem SDK-Paket erstellt wurde, das mit Version 2.2.1 oder früher gebündelt wurde:

1. Ändern Sie den Parameter document_level_security_supported in der Datei config/template.xml wie folgt:

   <declare type="boolean" name="document_level_security_supported" hidden="true" initial-value="false"/>
   

2. Erstellen Sie das Connectorpaket erneut und laden Sie es anschließend erneut hoch.

Abschnitt datasource_settings

Der XPath-Ausdruck lautet /function/prototype/proto-section[@section="datasource_settings"]. Er enthält spezifische Einstellungen für die Datenquelle.

  <proto-section section="datasource_settings">

      <declare type="string" name="host" required="required" initial-value="localhost"/>
      <declare type="long" name="port" required="required" initial-value="22"/>
      <declare type="string" name="user" required="required" />

      <declare type="boolean" name="use_key" initial-value="true" />

      <condition name="use_key" enabled="true">
        <declare type="string" name="key" hidden="false" />
        <declare type="password" name="passphrase" hidden="false" />
      </condition>

      <condition name="use_key" enabled="false">
        <declare type="password" name="secret_key" hidden="false" />
      </condition>
  </proto-section>

Abschnitt crawlspace_settings

Der XPath-Ausdruck lautet /function/prototype/proto-section[@section="crawlspace_settings"]. Der Abschnitt enthält nur ein <declare />-Element, um den Pfad anzugeben. Der Pfadwert wird vom Connector-Code angegeben.

  <proto-section section="crawlspace_settings" cardinality="multiple">
    <declare type="string" name="path" hidden="true" />
  </proto-section>

Voraussetzungen

Um einen benutzerdefinierten Connector zu erstellen, müssen Sie die folgenden Elemente auf Ihrem lokalen System haben. Details finden Sie in Beispiel für einen angepassten Connector.

• Java SDK 1.8 oder höher

• Gradle

• Datei custom-crawler-docs.zip aus einer installierten Instanz von Discovery

• JSch-Paket

• Folgende Dateien für den angepassten Beispielconnector:

  • Java-Quellcode (SftpCrawler.java und SftpSecurityHandler.java)
  • XML-Definitionsdatei (template.xml)
  • Eigenschaftendatei (messages.properties)

  Ändern Sie nicht die Namen oder Pfade der angepassten Beispielconnectordateien. Dies kann zu Problemen führen, einschließlich Fehlern bei der Erstellung.

Quellcode kompilieren und packen

1. Stellen Sie sicher, dass Sie sich im Verzeichnis für die benutzerdefinierte Konnektorentwicklung auf Ihrem lokalen System befinden:

   cd {local_directory}
   

2. Verwenden Sie Gradle, um Ihren Java-Quellcode zusammenzustellen und eine komprimierte Datei zu erstellen, die alle erforderlichen Komponenten für den benutzerdefinierten Connector enthält:

   gradle build packageCustomCrawler
   

Gradle erstellt eine Datei in {local_directory}/build/distributions/{built_connector_zip_file}, wobei der Name der {built_connector_zip_file} auf dem rootProject.name-Wert settings.gradle basiert. Wenn die Zeile beispielsweise wie folgt lautet, generiert Gradle eine Datei mit dem Namen {local_directory}/build/distributions/my-sftp-connector.zip.

rootProject.name = 'my-sftp-connector'

Nächster Schritt

Fahren Sie mit dem Abschnitt Angepassten Connector installieren und deinstallieren fort, um den angepassten Connector in Ihrer Instanz von Discovery zu installieren.