Entwicklungsumgebung konfigurieren

Instellen Sie die Entwicklungsumgebung in Eclipse IDE, um Ihre Plugins zu schreiben. Verwenden Sie alle Java EE IDE Ihrer Wahl und nehmen Sie die in diesem Abschnitt erwähnten erforderlichen Konfigurationen vor. Sie benötigen bestimmte Artefakte von <ASSET_PICKER_HOME> , um die Umgebungskonfiguration abzuschließen. In diesem Abschnitt werden Informationen zum Aufbau und zur Verpackung von Produkten mithilfe von Apache Maven bereitgestellt, um sicherzustellen, dass Apache Maven installiert ist.

Warum und wann dieser Vorgang ausgeführt wird

Gehen Sie wie folgt vor, um Ihre Entwicklungsumgebung zu konfigurieren:

Prozedur

  1. Kopieren Sie das asset-integration-starter-Projekt von der <ASSET_PICKER_HOME>/dev-kits/-Position aus und platzieren Sie es in Ihrem Entwicklungsarbeitsbereich.
  2. Öffnen Sie die Eclipse IDE.
  3. Wählen Sie Datei > Importierenaus.
    Das Dialogfeld Auswählen wird geöffnet.
  4. Wählen Sie Ihre WAR-Datei aus und klicken Sie auf Weiter.
    Das Dialogfeld War importieren wird angezeigt.
  5. Klicken Sie auf Durchsuchen, navigieren Sie zu <ASSET_PICKER_HOME>- und select asset-viewer.war-Datei.
  6. Klicken Sie auf Fertig stellen.
    Der War-Import: Das Dialogfeld Webbibliotheken wird angezeigt.
  7. Klicken Sie auf Fertig stellen.
  8. Wählen Sie Fenster > Ansicht anzeigen > Andere aus.
    Der Dialog Ansicht anzeigen wird angezeigt.
  9. Wählen Sie Server aus und klicken Sie auf Öffnen.
    Als Beispiel wird die Verwendung von Apache Tomcat 9,0 für die Ausführung von Content Integration veranschaulicht. Sie können alle unterstützten Anwendungsserver verwenden und die erforderlichen Konfigurationen vornehmen.
    1. Öffnen Sie die conf/server.xml-Datei aus Ihrem Apache Tomcat 9,0-Installationsverzeichnis und fügen Sie den folgenden Eintrag mit den entsprechenden Datenbankdetails innerhalb des <GlobalNamingResources>-Elements ein. Bitte ersetzen Sie, <DRIVER_CLASS_NAME>,<URL_TO_YOUR_PLATFORM_DATABASE>,<DATABASE_USERNAME> und <DATABASE_PASSWORD> mit Platform- Datenbankdetails:
      <Resource auth="Container" driverClassName="{DRIVER_CLASS_NAME}" 
                           maxActive="20" 
                           maxIdle="0" 
                           maxWait="10000" 
                           name="UnicaPlatformDS" 
                           password="{DATABASE_PASSWORD}" 
                           username="{DATABASE_USERNAME}"
                           type="javax.sql.DataSource" 
                           url="{URL_TO_YOUR_PLATFORM_DATABASE}"/>
    2. Öffnen Sie die conf/context.xml-Datei aus dem Installationsverzeichnis von Apache Tomcat 9,0 und fügen Sie den folgenden Eintrag in das <Context>-Element ein:
      <ResourceLink auth="Container" global="UnicaPlatformDS" name="UnicaPlatformDS" 
type="javax.sql.DataSource"/>
  10. Um Apache Tomcat 9,0 als neuen Server in Eclipse hinzuzufügen, führen Sie die folgenden Schritte aus:
    1. Klicken Sie auf der Registerkarte Server auf den Link, um einen neuen Server zu erstellen.
      Das Fenster Neuen Server definieren wird geöffnet.
    2. Wählen Sie den Tomcat Version 9.0-Server aus und geben Sie Werte für den Hostnamen und den Servernamen an.
    3. Klicken Sie auf Weiter.
      Der Server wurde erfolgreich hinzugefügt.
    4. Doppelklicken Sie auf der Registerkarte Server auf den Eintrag für den neu hinzugefügten Server.
      Der Dialog Übersicht wird angezeigt.
    5. Klicken Sie auf den Link Startkonfiguration öffnen.
      Das Dialogfenster Einstellungen für Startkonfiguration bearbeiten wird angezeigt.
    6. Bearbeiten Sie die Startkonfigurationen, um die folgenden JVM-Argumente hinzuzufügen 
      
-DASSET_PICKER_HOME=<Point this to <ASSET_PICKER_HOME> directory>
-Dspring.profiles.active=platform-disintegrated
    7. Klicken Sie auf OK.
  11. Um die importierte asset-viewer.war-Datei auf Apache Tomcat 9,0 auszuführen, klicken Sie mit der rechten Maustaste auf die asset-viewer.war-Datei und wählen Sie Ausführen als > auf dem Server ausführen aus.
    Der Dialog Auf Server ausführen wird geöffnet.
  12. Klicken Sie auf Fertig stellen.
    Die asset-viewer.war wird mit der Ausführung auf Apache Tomcat starten. Stoppen Sie nach der Überprüfung des Setups den Server und importieren Sie das Plugin-Entwicklungsstartprojekt.
  13. Führen Sie die folgenden Schritte aus, um Content Integration SDK zu installieren:
    1. Löschen Sie in den folgenden Verzeichnissen die bereits installierten SDKs:
      • <LOCAL_M2_REPOSITORY>\com\hcl\unica\integration-api\0.0.1-SNAPSHOT
      • <LOCAL_M2_REPOSITORY>\com\hcl\unica\standard-integrations \0.0.1-SNAPSHOT
      • <LOCAL_M2_REPOSITORY>\com\hcl\unica\asset-integration-api\0.0.1-SNAPSHOT
      • <LOCAL_M2_REPOSITORY>\com\hcl\unica\entity-mapper-api\0.0.1-SNAPSHOT

      Unter UNIX oder Mac OS X <LOCAL_M2_REPOSITORY> verweist auf das ~/.m2/repository-Verzeichnis.

      Unter Microsoft Windows <LOCAL_M2_REPOSITORY> verweist auf das C:\Users\{your-username}\.m2\repository-Verzeichnis.

    2. Verwenden Sie die folgenden Befehle, um Content Integration SDKs in Ihrem lokalen Maven-Repository zu installieren. Suchen Sie asset-integration-api.jar, integration-api.jar, standard-integrations.jar und entity-mapper-api.jar im <ASSET_PICKER_HOME>/dev-kits/sdk-Verzeichnis. 
      mvn install:install-file -Dfile=<ASSET_PICKER_HOME>/dev-kits/sdk/asset-integration-api.jar -DgroupId=com.hcl.unica -DartifactId=asset-integration-api -Dversion=0.0.1-SNAPSHOT -Dpackaging=jar

mvn install:install-file -Dfile=<ASSET_PICKER_HOME>/dev-kits/sdk/integration-api.jar -DgroupId=com.hcl.unica -DartifactId=integration-api -Dversion=0.0.1-SNAPSHOT -Dpackaging=jar

mvn install:install-file -Dfile=<ASSET_PICKER_HOME>/dev-kits/sdk/standard-integrations.jar -DgroupId=com.hcl.unica -DartifactId=standard-integrations -Dversion=0.0.1-SNAPSHOT -Dpackaging=jar

mvn install:install-file -Dfile=<ASSET_PICKER_HOME>/dev-kits/sdk/entity-mapper-api.jar -DgroupId=com.hcl.unica -DartifactId=entity-mapper-api -Dversion=0.0.1-SNAPSHOT -Dpackaging=jar
  14. Zum Importieren des Plugin-Entwicklungs-Starterprojekts wählen Sie Datei > Importierenaus.
    Das Dialogfeld Auswählen wird geöffnet.
  15. Wählen Sie Bestehende Maven-Projekte aus und klicken Sie auf Weiter.
    Das Dialogfeld Maven-Projekte wird geöffnet.
  16. Klicken SieDurchsuchen, um das Projekt auszuwählen und dann auf Fertigstellen.
  17. Um Maven-Abhängigkeiten des asset-integration-starter-Projekts zu aktualisieren, klicken Sie mit der rechten Maustaste auf das asset-integration-starter-Projekt und wählen Sie Maven > Update Projektaus.
  18. Stellen Sie sicher, dass das neu importierte Projekt Java 8 zum Kompilieren von Quellen verwendet. Öffnen Sie die Projekteigenschaften und führen Sie die folgenden Schritte zur Konfiguration des Compilers aus:
    1. Wählen Sie Java Compileraus.
    2. Wenn die Konformitätsstufe des Compilers nicht editierbar ist, wählen Sie Projektspezifische Einstellungen aktivierenaus.
    3. Ändern Sie die Konformitätsstufe des Compilers auf 1,8.
    4. Klicken Sie auf Übernehmen und Schließen.
  19. Um sicherzustellen, dass die richtige Java-Bibliothek im Buildpfad eingerichtet ist, führen Sie die folgenden Schritte aus:
    1. Wählen Sie Java-Buildpfads > Bibliothekenaus.
    2. Wählen Sie die JRE-Systembibliothek (J2SE 1,5)aus.
    3. Klicken Sie auf Entfernen.
    4. Klicken Sie auf Bibliothek hinzufügen.
      Das Dialogfeld Bibliothek hinzufügen wird geöffnet.
    5. Wählen Sie die JRE-Systembibliothek > Weiteraus.
      Die JRE-Systembibliothek wird angezeigt.
    6. Wählen Sie eine geeignete Bibliothek aus und klicken Sie auf Fertigstellen.
  20. Um die Verarbeitung von Annotationen zu ermöglichen, führen Sie die folgenden Schritte aus:
    1. Wählen Sie Java Compiler > Annotationsverarbeitungaus.
    2. Wählen Sie Projektspezifische Einstellungen aktivieren.
    3. Wählen Sie Übernehmen und Schließen.
  21. Führen Sie die folgenden Schritte aus, um Lombok zu installieren:
    1. Doppelklicken Sie auf die LOCAL_M2_REPOSITORY\org\projectlombok\lombok\1.18.16\lombok-1.18.16.jar.
      Das Installationsprogramm wird angezeigt.
    2. Klicken Sie auf Position angeben, um die Installationsposition Ihrer IDE anzugeben.
    3. Um die Installation abzuschließen, klicken Sie auf Installieren / Aktualisieren.
    4. Nach der Installation von Lombok müssen Sie die IDE erneut starten.
  22. Gehen Sie wie folgt vor, um den Projektnamen zu ändern:
    1. Öffnen Sie die Datei pom.xml und ändern Sie die Projekteigenschaften von Maven.
    2. Klicken Sie mit der rechten Maustaste auf das Projekt "Asset-Integration-Starter" und wählen Sie Refactor > Umbenennen .
  23. Deklarieren Sie in der <ASSET_PICKER_HOME>/conf/custom-plugin-services.yml-Datei die Plugin-Services. Sie können später auf diese Datei zugreifen, um bei der Einführung von Services für Ihre Plugins Deklarationen hinzuzufügen.
  24. Wenn Sie ein Plugin-Projekt zur Bereitstellungsbaugruppe des asset-viewer.war-Projekts hinzufügen möchten, führen Sie die folgenden Schritte aus:
    1. Klicken Sie mit der rechten Maustaste das asset-viewer.war-Projekt an und wählen Sie Eigenschaften aus.
      Das Dialogfeld Eigenschaften für den Asset-Viewer wird geöffnet.
    2. Wählen Sie Deployment Assembly aus.
    3. Wählen Sie Hinzufügen aus.
      Das Dialogfeld Richtlinientyp auswählen wird geöffnet.
    4. Wählen Sie Projekt aus und klicken Sie auf Weiter.
    5. Wählen Sie das in den vorherigen Schritten importierte asset-integration-starter-Plug-in-Projekt aus und klicken Sie auf Fertig stellen.
  25. Bereinigen Sie die Projekte bei Bedarf.
  26. Nehmen Sie die entsprechende Konfiguration für Ihr System in <ASSET_PICKER_HOME>/conf/systems.properties vor (siehe sample-systems.properties-Datei im <ASSET_PICKER_HOME>/dev-kits/asset-integration-starter-Projekt). Alle im Unica Content Integration-Administrationshandbuch erwähnten System-Onboarding-Konfigurationen werden in systems.properties unter Verwendung relevanter Eigenschaften unterstützt.
  27. Wenn Sie Ihr Plug-in entwickeln, aktivieren Sie es, indem Sie das asset-viewer.war-Projekt auf einem zuvor konfigurierten Anwendungsserver ausführen. Da das Projekt bereits der Deployment Assembly von asset-viewer.war hinzugefügt würde, werden Änderungen an Ihrem Plugin-Projekt implementiert, wenn Sie das asset-viewer.war-Projekt ausführen.
  28. Verwenden Sie beim Entwickeln Ihres Plugins durch Hinzufügen von Diensten ein Werkzeug Ihrer Wahl, um die folgenden REST-Endpunkte zu erreichen (ändern Sie den Kontextstamm entsprechend Ihres Setups), um die Richtigkeit Ihrer Implementierung zu überprüfen:
    1. Systemvoraussetzungen sicherstellen
      Endpunkt-URL http://localhost:8888/asset-viewer/api/AssetPicker/instances
      Anforderungsmethode GET
    2. Dienst Einfache Suche überprüfen.
      Endpunkt-URL http://localhost:8888/asset-viewer/api/AssetPicker/mysystem/assets?query=mountain&page=0&size=10&types=Phto
      Dabei gilt:
      • mysystem stellt die von der Plug-in-Implementierung ausgewählte System-ID dar.
      • query enthält das Suchschlüsselwort für die Suche nach Inhalten.
      • page & size enthält Paginierungsdetails, wobei Seite die Seriennummer der abzurufenden Seiten und Größe die Gesamtzahl der Suchelemente auf einer einzelnen Seite ist.
      • Bei types handelt es sich um eine der unterstützten Inhaltskategorien (Typen) zum Filtern der Suchpositionen.
      Anforderungsmethode GET

      Wenn Sie den URL treffen, stellen Sie sicher, dass die Antwort JSON das erwartete Ergebnis enthält. Für alle Suchelemente werden nur Präsentationsdetails eingeschlossen. Andere Inhaltseigenschaften werden aus Gründen der Sicherheit und der Leistung ausgeschlossen.

    3. Resource Loader-Dienst überprüfen
      Endpunkt-URL http://localhost:8888/asset-viewer/api/AssetPicker/mysystem/download?resource=

      http://repository_base_url/contents/sample_image.jpg%26resourceId=12345"

      Dabei gilt Folgendes
      • mysystem stellt die von der Plug-in-Implementierung ausgewählte System-ID dar.
      • resource enthält den absoluten URL-Inhalt, der heruntergeladen werden soll.
      • resourceId enthält die Kennung des herunterzuladenden Inhalts.

      (Plug-in kann entweder resource oder resourceId oder beides zum Laden des Inhalts verwenden.)
      Anforderungsmethode GET
    4. Listenordnerservice überprüfen
      Endpunkt-URL http://localhost:8888/asset-viewer/api/AssetPicker/mysystem/folders?parentFolderId=1234
      Dabei gilt Folgendes:
      • mysystem stellt die von der Plug-in-Implementierung ausgewählte System-ID dar.
      • parentFolderId enthält die Kennung des übergeordneten Ordners, dessen unmittelbare Unterordner als Antwort erwartet werden. Dieser Abfrageparameter ist optional und wird beim Auflisten der Ordner auf oberster/Stammebene nicht angegeben.
      Anforderungsmethode GET
    5. Listeninhaltsdienst überprüfen
      Endpunkt-URL http://localhost:8888/asset-viewer/api/AssetPicker/mysystem/folders/1234/contents
      Dabei gilt Folgendes:
      • mysystem stellt die von der Plug-in-Implementierung ausgewählte System-ID dar.
      • 1234 steht für die ID des Ordners, dessen direkter Inhalt als Antwort erwartet wird.
      Anforderungsmethode GET

      Für jeden vom list-contents-Dienst aufgelisteten Inhalt sind nur Präsentationsdetails enthalten. Andere Inhaltseigenschaften werden aus Gründen der Sicherheit und der Leistung ausgeschlossen.

    6. Dienst get-content-details überprüfen
      Endpunkt-URL http://localhost:8888/asset-viewer/api/AssetPicker/mysystem/assets/Images/1234
      Dabei gilt Folgendes:
      • mysystem stellt die von der Plug-in-Implementierung ausgewählte System-ID dar.
      • Images stellt die Kategorie-ID des Inhalts dar, dessen Details als Antwort erwartet werden.
      • 1234 stellt die ID des Inhalts dar, dessen Details als Antwort erwartet werden.
      Anforderungsmethode GET

      Die vom get-content-details-Dienst erzeugte JSON-Antwort enthält neben den Präsentationsdetails alle Inhaltseigenschaften.

    7. Dienst get-object-schema überprüfen
      Endpunkt-URL http://localhost:8888/asset-viewer/api/AssetPicker/object-mapping/application/mysystem/object/Images/1234/schema
      Dabei gilt Folgendes:
      • mysystem stellt die von der Plug-in-Implementierung ausgewählte System-ID dar.
      • Bilder stellen die Kategorie des Referenzinhalts dar, der für die Schemaerstellung verwendet wird.
      • 1234 steht für die ID des Referenzinhalts, der für die Schemagenerierung verwendet wird.

      Ab 12.1.0.4 sind Inhaltskennung und Kategorie nicht mehr relevant, da erwartet wird, dass das Schema Attribute für alle unterstützten Inhaltskategorien enthält.
      Anforderungsmethode GET

      Die JSON-Antwort muss die reduzierte Liste aller zuordnbaren Attribute und ihrer Metadaten enthalten.

    8. Listeninhaltskategorien-Dienst überprüfen
      Endpunkt-URL http://localhost:8888/asset-viewer/api/AssetPicker/mysystem/categories
      Dabei gilt Folgendes:
      • mysystem stellt die von der Plug-in-Implementierung ausgewählte System-ID dar.
      Anforderungsmethode GET
    9. Dienst get-des-analysis überprüfen
      Endpunkt-URL http://localhost:8888/asset-viewer/api/AssetPicker/actions/cognize?url=absolute_image_url
      Dabei gilt Folgendes:
      • url enthält die absolute URL des Bildes, für das die kognitive Analyse abgerufen werden soll
      Anforderungsmethode GET