Standardservices

Die folgende Tabelle enthält eine Einführung in die Standarddienste von Unica Content Integration. Daher sollte keiner der hier aufgeführten Dienstnamen für eine benutzerdefinierte Dienstimplementierung verwendet werden. Inhaltsintegration SDK bietet Standardschnittstellen und -typen zur Implementierung dieser Standarddienste. Diese Schnittstellen und Typen werden in den nachfolgenden Abschnitten näher beschrieben.

Tabelle 1. Standardservices und deren Beschreibung
Name des Standardservice Beschreibung
simple-search
Der Service „Einfache Suche" antwortet auf die Suchanfragen nach Inhalten, die von Content Integration Framework empfangen werden. Dieser Service akzeptiert die Zeichenfolge der Suchanfrage zusammen mit den erforderlichen Angaben zur Paginierung der Ergebnisse. Basierend auf dem Erfolg des Suchvorgangs liefert es das Suchergebnis für die gegebene Suchanfrage und entsprechend der gewünschten Paginierung. Für das Plug-in handelt es sich hierbei um einen obligatorischen Service.
list-folders Dies ist ein optionaler Dienst. Ordner ist ein allgemeiner Begriff zur Darstellung eines Containerobjekts, das im Zielsystem zur hierarchischen Organisation der Inhalte verwendet wird. Dieser Dienst wird aufgerufen, um die Liste der Ordner und Unterordner zu rendern und die Navigation durch solche hierarchisch organisierten Inhalte zu erleichtern.
Anmerkung: list-folders und list-contents sind korrelierte Dienste. Die Implementierung für beide Dienste muss vorhanden sein, damit die Inhaltsnavigation ordnungsgemäß funktioniert.
list-contents Dies ist ein optionaler Dienst. Dieser Dienst wird aufgerufen, um die Inhalte auflisten zu können, die zu einem bestimmten Ordner gehören.
Anmerkung: list-folders und list-contents sind korrelierte Dienste. Die Implementierung für beide Dienste muss vorhanden sein, damit die Inhaltsnavigation ordnungsgemäß funktioniert.
get-content-details Die Implementierung dieses Dienstes ist beim Abrufen der Details eines einzelnen Inhalts hilfreich. Auf Inhalte, die mit simple-search und list-contents services eingeholt wurden, wird in anderen Unica-Produkten weiter verwiesen. Benutzer möchten zu einem späteren Zeitpunkt möglicherweise die Details zu bereits referenzierten Inhalten anzeigen. Daher empfehlen wir die Implementierung dieses Dienstes, damit Benutzer die Inhaltsdetails nach Bedarf sehen können.
get-object-schema Dies ist ein optionaler Dienst. Die Implementierung dieses Dienstes ist nützlich, damit Benutzer des Centralized Offer Management Inhaltsattribute Angebotsattributen zuordnen können. Und anschließend Werte für zugeordnete Angebotsattribute aus den entsprechenden Inhaltsattributen abzuleiten, indem der gewünschte Inhalt aus der Inhaltsauswahl ausgewählt wird. Wenn dieser Dienst implementiert ist, erleichtert er die Verwendung anderer Inhaltsattribute zusätzlich zur Inhalts-URL für die Angebotserstellung.
resource-loader Dieser Dienst ist nützlich, wenn ein direkter Download des Inhalts vom Zielsystem nicht möglich ist. Dieser Service ist nicht obligatorisch und sollte nur implementiert werden, wenn folgende Hindernisse auftreten:
  • Falls kein direkter Web-Link vorhanden ist, um den Inhalt herunterzuladen

    Von den simple-search- und list-contents-Diensten zurückgegebene Inhalte müssen eine absolute URL zum jeweiligen Inhalt enthalten, damit der Content Integration-Client ihn direkt über das Web herunterladen kann. Wenn kein solcher direkter Weblink zum Inhalt vorhanden ist, muss der resource-loader-Dienst implementiert werden, indem die vom Content Integration Framework bereitgestellte Standardimplementierung überschrieben wird, damit der Content Integration-Client ihn direkt über das Web herunterladen kann. Wenn der Inhalt beispielsweise in einer Datenbanktabelle verwaltet wird, rufen die simple-search- und list-contents-Dienste Datensätze aus der Datenbank ab. Da die Elemente aus der Datenbank geladen werden, gibt es möglicherweise keine URL, die direkt auf jeden Datensatz verweist. In diesem Fall kann der resource-loader-Dienst die Inhaltskennung verwenden, um die entsprechenden Daten zu finden und bereitzustellen, wenn der Download von Inhalten angefordert wird. Alle Anforderungen zum Herunterladen von Inhalten werden über das Content Integration Framework ausgeführt, das die Download-Aufgabe an den resource-loader-Dienst delegiert, indem es ihm die Inhalts-URL und seine Kennung bereitstellt.

  • Wenn Web-Links zu den Inhalten geschützt sind

    Bestimmte Systeme bieten möglicherweise keinen anonymen Zugriff auf die Inhalte, obwohl direkte Weblinks verfügbar sind. In solchen Fällen wird der Zugriff in der Regel erst nach der Bereitstellung der erforderlichen Authentifizierung bereitgestellt. Standardmäßig registriert Content Integration Framework eine standardmäßige Implementierung des resource-loader-Dienstes für jedes Plug-in. Diese Standardimplementierung verwendet die URL für den tatsächlichen Inhalt, um den Inhalt vom Remote-System herunterzuladen, indem entsprechende Authentifizierungsdetails bereitgestellt werden, die den Konfigurationen in Unica Platform unterliegen. (Weitere Informationen zu System-Onboarding-Konfigurationen finden Sie im Unica Content Integration-Administratorhandbuch).

    Alternativ können Plugins die Standardimplementierung des Ressourcenladers überschreiben, um das Verhalten beim Herunterladen von Inhalten zu ändern (mithilfe der Inhalts-URL oder der Inhalts-ID). Wenn der resource-loader-Dienst mithilfe des RESTful-Ansatzes überschrieben wird, kümmert sich Content Integration Framework weiterhin um die Bereitstellung von Authentifizierungsdetails basierend auf der Plattformkonfiguration.

    Anmerkung: Inhalte müssen anonym zugänglich gemacht werden, wenn erwartet wird, dass sie von einem externen Publikum gesehen/abgerufen werden. In diesem Fall wird die Verwendung des Ressourcenladerdienstes in Produktionssystemen nicht empfohlen. Die Verwendung des resource-loader-Dienstes kann jederzeit deaktiviert werden, indem die Eigenschaft Anonymer Inhalt in der Plattformkonfiguration auf Ja gesetzt wird. Ebenso kann es aktiviert werden, indem dieselbe Eigenschaft auf Nein gesetzt wird.
list-content-categories Inhalte können durch ihre natürliche Klassifizierung logisch kategorisiert werden. Beispielsweise können digitale Inhalte in Bilder, Dokumente, Multimedia (Audios und Videos), Archive usw. eingeteilt werden. In ähnlicher Weise können E-Commerce-Produkte in mehrere große Kategorien eingeteilt werden, wie z. B. Elektronik, Gesundheitswesen, Bücher, Möbel usw. Content Integration Framework ermöglicht die folgenden Möglichkeiten zur Übertragung einer solchen Inhaltskategorisierung, um die Suche von Inhalten innerhalb bestimmter Kategorien zu erleichtern.
  • supportedContentTypes Dienstparameter

    Ein Standardparameter für Service-Level, kann verwendet werden, um statisch ein Wörterverzeichnis der unterstützten Inhaltstypen supportedContentTypes unter Servicedeklaration simple-search zu liefern.

  • getSupportedContentTypes()Methode in der Implementierung des Suchdienstes

    Die getSupportedContentTypes()-Methode kann überschrieben werden, um dynamisch eine Karte der unterstützten Inhaltstypen zu generieren, wobei der Schlüssel als Kategoriekennung und der Wert für die auf der Benutzeroberfläche angezeigte Bezeichnung dient. Diese Methode wird während des Anwendungsstarts ausgeführt. Daher kann mit den Funktionen von Content Integration Framework kein Remote-API-Aufruf durchgeführt werden, da sich die Anwendung beim Aufrufen dieser Methode möglicherweise in einem teilweise initialisierten Zustand befindet.

  • list-content-categories Service

    Optional kann ein Dienst list-content-categories implementiert werden, um die Einschränkung der getSupportedContentTypes()-Methode zu beheben. Es ermöglicht Remote-API-Aufrufe, um die Inhaltskategorien noch dynamischer abzurufen. Wenn implementiert, überschreibt dieser Dienst die zuvor genannten Ansätze. Content Integration Framework ruft diesen Dienst immer dann auf, wenn ein Popup für die Inhaltssuche gerendert wird.

get-cognitive-analysis Dies ist ein optionaler Dienst. Wenn implementiert, wird es verwendet, um kognitive Details abzurufen, die dem angegebenen Bild zugeordnet sind, vorbehaltlich der Konfiguration "Bevorzugter kognitiver Dienstanbieter" in Unica Platform.