Allgemeines

Die Universal Search ist die beste Möglichkeit, auf alle Inhalte eines Portals zuzugreifen. Binden Sie diese mit der Funktion oxomi.universalSearch ein. Die Universal Search ermöglicht es Ihnen, Inhalte und Produkte zu durchsuchen. Die Standardansicht ist eine Markenübersicht. Mithilfe von Filtern – sowohl durch den Nutzer als auch durch die Integration festlegbar – lässt sich das Portal dann so durchsuchen, dass Dokumente, Einzelseiten, Videos, Exposés und Produkte gefunden werden können.

Standardmäßig werden die Produkte herstellerübergreifend durchsucht. Sobald der Nutzer sich in einer Marke mit einer Lieferantennummer befindet, werden die Artikel des Herstellers dieser Marke durchsucht. Damit dies funktioniert, müssen in den Partnerschaften Lieferantennummern gepflegt werden.

Neben der klassischen direkten Integration steht Ihnen noch die Funktion oxomi.openUniversalSearch zur Verfügung, welche die UniversalSearch in einem Overlay öffnet. Die nachfolgend beschriebenen Parameter sind bei beiden Varianten identisch.

Hauptparameter

Diese Parameter geben an, in welchen Elementen, also wo auf der Seite, die einzelnen Komponenten der Suche platziert werden sollen. Geben Sie hierfür die DOM-ID des jeweiligen Elements an.

Die nachfolgende Tabelle enthält eine Übersicht über die verfügbaren Parameter. Fett gedruckte Parameter sind Pflichtparameter. Die Beschreibung der Parameter enthält Informationen über den Typ des Parameters, die möglichen Werte und die Bedeutung sowie weitere Verwendungshinweise.

Parameter Parametertyp Beschreibung
target string

Gibt das Ziel-Element an, in welches die Markenübersicht/Suchergebnisse und die zugehörige Filterbox eingefügt wird.

Hinweis:

  • Wird der Parameter nicht angegeben, so wird #oxomi-universal-search als Default-Wert verwendet.
input string

Gibt das Ziel-Element an, in welches die Suchleiste eingefügt wird.

Hinweis:

  • Wird dieser Parameter nicht angegeben, so wird die Suchleiste in das Ziel-Element, welches mit dem Parameter target angegeben wurde, eingefügt.
mobileFilterButton string

Gibt das Ziel-Element an, in welches die Schaltfläche zum Öffnen der Filter-Seitenleiste auf Mobilgeräten eingefügt wird.

Hinweis:

  • Verwendung des Parameters wird empfohlen, wenn über den Parameter input das Suchfeld in ein anderes Element eingefügt wird.
  • Wird dieser Parameter nicht angegeben, so wird die Schaltfläche in das Ziel-Element, welches mit dem Parameter target angegeben wurde, eingefügt.
showFilterBox boolean

Gibt an, ob die Filterbox angezeigt werden soll. Die Filterbox bietet verschiedene Filtermöglichkeiten für die Nutzer an.

Hinweis:

  • Wird der Parameter nicht angegeben, so wird true als Default-Wert verwendet.
  • Die angezeigten Filteroptionen können über den Parameter filterBoxGroups gesteuert werden.
showFilterBar boolean

Gibt an, ob alternativ zur Filterbox eine horizontale Filterleiste zwischen Suchfeld und Suchergebnis angezeigt werden soll.

Hinweis:

  • Wird der Parameter nicht angegeben, so wird false als Default-Wert verwendet.
  • Die angezeigten Filteroptionen können über den Parameter filterBoxGroups gesteuert werden.
Einstellungsparameter

Diese Parameter geben an, welche Einstellungen für die Suche vorgenommen werden sollen.

Die nachfolgende Tabelle enthält eine Übersicht über die verfügbaren Parameter. Fett gedruckte Parameter sind Pflichtparameter. Die Beschreibung der Parameter enthält Informationen über den Typ des Parameters, die möglichen Werte und die Bedeutung sowie weitere Verwendungshinweise.

Parameter Parametertyp Beschreibung
topBrands boolean

Gibt an, ob die Topmarken in der Markenübersicht abgegrenzt werden sollen.

Hinweis:

  • Wird dieser Parameter auf true gesetzt, dann müssen die Parameter topBrandsLabel und brandsLabel gesetzt sein. Andernfalls hat dieser Parameter keinen Effekt.
topBrandsLabel string

Gibt die Überschrift an, welche über den Topmarken stehen soll.

Hinweis:

  • Dieser Parameter wird nur angewendet, wenn der Parameter topBrands auf true gesetzt ist.
brandsLabel string

Gibt die Überschrift an, welche über den restlichen Marken stehen soll.

Hinweis:

  • Dieser Parameter wird nur angewendet, wenn der Parameter topBrands auf true gesetzt ist.
showJumpToTopButton boolean

Gibt an, ob der Button zum Springen an den Anfang der Seite angezeigt werden soll.

Hinweis:

  • Wird der Parameter nicht angegeben, so wird false als Default-Wert verwendet.
filterBoxGroups string

Wenn nicht alle Filtergruppen in der Filterbox angezeigt werden sollen, geben Sie hier an, welche sichtbar sein sollen. Die nachfolgenden Werte stehen hier zur Verfügung:

Wert Beschreibung
brand Marken
series Serien
category Kategorien
contentType Inhaltstypen
tag Tags
contentLanguage Sprachen

Hinweis:

  • Wird dieser Parameter nicht mitgegeben, werden alle Filtergruppen angezeigt.
  • Die Angabe von mehreren Werten erfolgt durch die Verwendung von , (Komma) oder | (Pipe) als Trennzeichen. Es dürfen keine Leerzeichen enthalten sein.
query string

Öffnet die Suche mit vorausgefüllter Suchanfrage.

Interactive Code Example

includeOutdated boolean

Gibt an, ob auch archivierte Inhalte in den Ergebnissen angezeigt werden sollen.

Hinweis:

  • Wird dieser Parameter auf true gesetzt, so werden auch archivierte Inhalte angezeigt.
  • Wird dieser Parameter auf false gesetzt, so werden ausschließlich aktuelle Inhalte angezeigt.
  • Wird der Parameter nicht angegeben, so wird false als Default-Wert verwendet.
  • Dieser Parameter wird nur angewendet, wenn in den Portaleinstellungen im Abschnitt „Standard“ die Option „Archiv aktivieren“ mit einem Wert größer 0 eingestellt ist.
limit integer

Gibt die maximale Anzahl an Inhalten an, welche initial pro Inhaltstyp angezeigt werden sollen.

Hinweis:

  • Der maximal zulässige Wert für den Parameter beträgt 50.
  • Sind mehr Inhalte vorhanden, so ist es über eine entsprechend angezeigte Kachel möglich, weitere Inhalte nachzuladen.
  • Wird dieser Parameter nicht angegeben, so werden pro Inhaltstyp maximal 15 Inhalte angezeigt.
showActions boolean

Gibt an, ob zusätzliche Aktionen für gefundene Dokumente angezeigt werden sollen. Die zusätzlichen Aktionen werden als Schaltflächen unterhalb des Dokumentnamens angezeigt. Wird dieser Parameter auf true gesetzt, so werden die zusätzlichen Aktionen angezeigt. Die folgenden zusätzlichen Aktionen stehen zur Verfügung:

Aktion Beschreibung
Anschauen Öffnet den WebViewer so, als wäre das Cover-Bild des Dokuments angeklickt worden.
Downloaden Startet den Download des Dokuments. Voraussetzung für die Anzeige Download-Button ist, dass in Ihrer Portalkonfiguration unter „Sicherheit“ die Option „PDF-Download zulassen“ aktiv gesetzt ist
Bestellen Löst die Bestellaktion für das Dokument aus, sofern eine JavaScript-Funktion mit dem Parameter orderHandler hinterlegt wurde.

Hinweis:

  • Wird der Parameter nicht angegeben, so wird false als Default-Wert verwendet.
orderHandler function

Ermöglicht es, durch Hinterlegen einer JavaScript-Funktion, einen weiteren Button „Bestellen“ bei den zusätzlichen Aktionen eines Dokuments anzuzeigen. Damit der Button bei einem Dokument erscheint, muss zusätzlich die Einstellung „Druckversion verfügbar“ in der Verwaltungsoberfläche am Dokument auf „Ja“ gesetzt sein.

Als Parameter erhält die Funktion ein JavaScript-Objekt mit den folgenden Informationen:

Name Beschreibung
id Die technische OXOMI-ID des Dokuments.
code Der optional am Dokument hinterlegte Inhalts-Code.
name Der Name des Dokuments.
state Der aktuelle Status des Dokuments. Kann den Wert OK (aktuell gültig) oder ARCHIVED (archiviert) annehmen.
language Die Sprache des Dokuments als 2-buchstabiger ISO-Code .

Hinweis:

  • Dieser Parameter wird nur berücksichtigt, wenn der Parameter showActions auf true gesetzt wurde.
Interactive Code Example
showAdditionalLanguages boolean

Gibt an, ob eine Aktion welche die Sprachversionen eines Dokuments anzeigt, unterhalb des Dokumentnamens und der anderen Aktionen angezeigt werden soll. Wird dieser Parameter auf true gesetzt so wird ein Button mit dem Label „Weitere Sprachversionen“ angezeigt.

Hinweis:

  • Wird der Parameter nicht angegeben, so wird false als Default-Wert verwendet.
  • Kann zusammen mit dem Parameter additionalLanguages verwendet werden um die Sprachen und die Anzeigereihenfolge der Versionen zu beeinflussen.
additionalLanguages string

Gibt an, welche Sprachversionen eines Dokuments angezeigt werden sollen, wenn die Aktion „Weitere Sprachversionen“ ausgeführt wird. Die Sprachen werden als 2-buchstabige ISO-Codes angegeben. Die verfügbaren Werte können hier eingesehen werden: ISO-Sprachcodes

Hinweis:

  • Dieser Parameter beeinflusst außerdem die Anzeige-Reihenfolge der Sprachversionen. Die Sprachversionen werden in der Reihenfolge angezeigt, wie sie in diesem Parameter angegeben werden.
  • Dieser Parameter wird nur berücksichtigt, wenn der Parameter showAdditionalLanguages auf true gesetzt wurde.
  • Die Angabe von mehreren Werten erfolgt durch die Verwendung von , (Komma) oder | (Pipe) als Trennzeichen. Es dürfen keine Leerzeichen enthalten sein.
sortBy string

Gibt die Sortierung der Ergebnisse vor. Die nachfolgenden Werte stehen hier zur Verfügung:

Wert Beschreibung
priority Sortierung nach Marken-Priorität & Marken-Namen. Bei gleicher Marke werden die Dokumente alphanumerisch nach dem Dokumentnamen sortiert. Dies ist der verwendete Standard-Wert.
name Sortiert alphanumerisch nach dem Namen. Keine Markensortierung.
date Sortierung nach Datum, neuste Objekte werden zuerst gezeigt.
random Das Ergebnis ist zufällig gemischt.

Hinweis:

  • Wird der Parameter nicht angegeben, so wird priority als Default-Wert verwendet.
invokeInfoplayOnProductClick boolean

Gibt an, ob bei einem Klick auf ein Produkt Infoplay ausgelöst werden soll, satt das Datenblatt zu öffnen.

Hinweis:

  • Wird der Parameter nicht angegeben, so wird false als Default-Wert verwendet.
hideStories boolean

Für den Fall, dass Stories (Navlets und Searchlets) nicht gewünscht sind, kann dieser Parameter mit dem Wert true belegt werden. Dieser Parameter ist nur für die direkte Integration verfügbar.

Hinweis:

  • Wird der Parameter nicht angegeben, so wird false als Default-Wert verwendet.
Filterparameter

Mit diesen Parametern können Sie die Inhalte, die in der Universal Search verfügbar sind, schon von vornherein filtern. So können sie beispielsweise eine Universal Search für eine einzelne Marke oder für alle Anleitungen realisieren.

Die so gesetzten Filter können vom Nutzer nachträglich auch wieder entfernt werden. Verwenden Sie eine der “Versteckten Filterparameter”, falls dies nicht möglich sein soll.

Die nachfolgende Tabelle enthält eine Übersicht über die verfügbaren Parameter. Fett gedruckte Parameter sind Pflichtparameter. Die Beschreibung der Parameter enthält Informationen über den Typ des Parameters, die möglichen Werte und die Bedeutung sowie weitere Verwendungshinweise.

Parameter Parametertyp Beschreibung
brand string

Gibt die ID einer Marke an, auf welche gefiltert werden soll.

series string

Gibt die ID einer Serie an, auf welche gefiltert werden soll.

category string

Gibt die ID einer Kategorie an, auf welche gefiltert werden soll.

tag string

Gibt ein Tag an, auf welches gefiltert werden soll.

contentType string

Gibt den Inhaltstyp an, auf den gefiltert werden soll. Die verfügbaren Werte können hier eingesehen werden: Inhaltstypen

contentLanguage string

Gibt die Sprache als 2-buchstabigen ISO-Code an, auf welche gefiltert werden soll. Die verfügbaren Werte können hier eingesehen werden: ISO-Sprachcodes

Versteckte Filterparameter

Neben den vorher beschriebenen Filtermöglichkeiten existieren auch versteckte Filter. Diese können vom Nutzer weder eingesehen noch verändert werden. Damit kann die Suche etwa auf spezifische Marken, Inhaltstypen oder Kategorien eingeschränkt werden.

Die nachfolgende Tabelle enthält eine Übersicht über die verfügbaren Parameter. Fett gedruckte Parameter sind Pflichtparameter. Die Beschreibung der Parameter enthält Informationen über den Typ des Parameters, die möglichen Werte und die Bedeutung sowie weitere Verwendungshinweise.

Parameter Parametertyp Beschreibung
supplierNumbers string

Gibt die Lieferantennummern der Partner an, auf welche die Ergebnisse eingeschränkt werden sollen.

Hinweis:

  • Sie können Ihre eigenen Lieferantennummern verwenden, wenn Sie diese in der Partnerschaft zum Lieferanten gepflegt haben (siehe: Lieferantennummern).
  • Die Angabe von mehreren Werten erfolgt durch die Verwendung von , (Komma) oder | (Pipe) als Trennzeichen. Es dürfen keine Leerzeichen enthalten sein.
displayedResults string

Gibt an, welche Inhalte durchsucht werden sollen. Die verfügbaren Werte können hier eingesehen werden:

Wert Beschreibung
documents Kataloge
videos Videos
galleries Exposés
products Produkte

Hinweis:

  • Eine Filterung nur auf Produkte ist aktuell nicht möglich.
  • Wird dieser Parameter nicht angegeben, findet keine Filterung statt.
  • Die Angabe von mehreren Werten erfolgt durch die Verwendung von , (Komma) oder | (Pipe) als Trennzeichen. Es dürfen keine Leerzeichen enthalten sein.

Beispiel:

Für den Fall das nur Dokumente und Videos angezeigt werden sollen, muss der Parameter wie folgt gesetzt werden:

diplayedResults: "documents,videos"

displayedContentTypes string

Gibt an, welche spezifischen Inhaltstypen angezeigt werden sollen. Die verfügbaren Werte können hier eingesehen werden: Inhaltstypen

Hinweis:

  • Wird dieser Parameter nicht angegeben, findet keine Filterung statt.
  • Die Angabe von mehreren Werten erfolgt durch die Verwendung von , (Komma) oder | (Pipe) als Trennzeichen. Es dürfen keine Leerzeichen enthalten sein.

Beispiel:

Für den Fall das nur Dokumente vom Typ „Aktion“ und Exposés vom Typ „Aktion“ angezeigt werden sollen, muss der Parameter wie folgt gesetzt werden:

displayedContentTypes: "promotion,campaign"

filterLanguages string

Gibt die Sprachen als 2-buchstabige ISO-Codes an, auf welche die Ergebnisse eingeschränkt werden sollen. Die verfügbaren Werte können hier eingesehen werden: ISO-Sprachcodes

Hinweis:

  • Dieser Parameter steht nur für PRO Portale zur Verfügung. To the prices & ordering options
  • Die Angabe von mehreren Werten erfolgt durch die Verwendung von , (Komma) oder | (Pipe) als Trennzeichen. Es dürfen keine Leerzeichen enthalten sein.
filterCountries string

Gibt die Länder als 2-buchstabige ISO-Codes an, auf welche die Ergebnisse eingeschränkt werden sollen. Die verfügbaren Werte können hier eingesehen werden: ISO-Ländercodes

Hinweis:

  • Dieser Parameter steht nur für PRO Portale zur Verfügung. To the prices & ordering options
  • Die Angabe von mehreren Werten erfolgt durch die Verwendung von , (Komma) oder | (Pipe) als Trennzeichen. Es dürfen keine Leerzeichen enthalten sein.
own boolean

Gibt an, ob nur eigene Inhalte oder nur Inhalte von anderen Anbietern angezeigt werden sollen.

Hinweis:

  • Dieser Parameter bezieht sich dabei ausschließlich auf die eigene Standardmarke.
  • Wird dieser Parameter auf true gesetzt, so werden ausschließlich eigene Inhalte angezeigt.
  • Wird dieser Parameter auf false gesetzt, so werden ausschließlich Inhalte von anderen Anbietern angezeigt.
  • Wird dieser Parameter nicht angegeben, so werden sowohl eigene als auch Inhalte von anderen Anbietern angezeigt, sofern diese über eine Partnerschaft verfügbar sind.
onlyOutdated boolean

Gibt an, ob ausschließlich archivierte Inhalte in den Ergebnissen angezeigt werden sollen.

Hinweis:

  • Wird dieser Parameter auf true gesetzt, so werden ausschließlich archivierte Inhalte in den Ergebnissen angezeigt.
  • Sollte der Parameter auf true gesetzt sein, hat er Vorrang vor dem Parameter includeOutdated. Bei Einstellung auf false verhält sich der Parameter so, als wäre er nicht angegeben worden.
  • Wird der Parameter nicht angegeben, so wird false als Default-Wert verwendet.
  • Dieser Parameter wird nur angewendet, wenn in den Portaleinstellungen im Abschnitt „Standard“ die Option „Archiv aktivieren“ mit einem Wert größer 0 eingestellt ist.
hiddenBrand string

Gibt die ID einer Marke an, auf welche die Suche eingeschränkt werden soll.

hiddenSeries string

Gibt die ID einer Serie an, auf welche die Suche eingeschränkt werden soll.

hiddenCategory string

Gibt die ID einer Kategorie an, auf welche die Suche eingeschränkt werden soll.

hiddenTag string

Gibt ein Tag an, auf welche die Suche eingeschränkt werden soll.

hiddenContentType string

Gibt den Inhaltstyp an, auf welche die Suche eingeschränkt werden soll. Die verfügbaren Werte können hier eingesehen werden: Inhaltstypen

hiddenContentLanguage string

Gibt die Sprache als 2-buchstabigen ISO-Code an, auf welche die Suche eingeschränkt werden soll. Die verfügbaren Werte können hier eingesehen werden: ISO-Sprachcodes

Showcase

Allgemeine Parameter

Bitte geben Sie hier den Portal-Code beziehungsweise die Portal-ID an. Hier finden Sie weitere Informationen.
Für die externe Authentifizierung kann ein im integrierenden System generierter Access-Token eingesetzt werden. Benutzen Sie den Access-Token Rechner, um Ihren individuellen Access-Token zu berechnen. Diese Eingabe wird zum Pflichtfeld, falls das entsprechende Portal Login-geschützt ist. Hier finden Sie weitere Informationen.
Bitte geben Sie hier den Benutzernamen eines Portalbenutzers ein. Diese Eingabe wird zum Pflichtfeld, falls das entsprechende Portal Login-geschützt ist. Hier finden Sie weitere Informationen.
Bitte geben Sie hier wahlweise die Portallrollen an, um den Zugriff auf die Inhalte zu steuern. Hier finden Sie weitere Informationen.

Aufruf Parameter

Gibt an, ob die Filterbox angezeigt werden soll. Die Filterbox bietet verschiedene Filtermöglichkeiten für die Nutzer an.
Gibt an, ob die Filterleiste angezeigt werden soll. Die Filterleiste bietet verschiedene Filtermöglichkeiten für die Nutzer an und wird zwischen Suchfeld und Suchergebnis angezeigt.
Einstellungsparameter
Gibt an, ob die Topmarken in der Markenübersicht abgegrenzt werden sollen.
Gibt die Überschrift an, welche über den Topmarken stehen soll.
Gibt die Überschrift an, welche über den restlichen Marken stehen soll.
Gibt an, ob der Button zum Springen an den Anfang der Seite angezeigt werden soll.
Wenn nicht alle Filtergruppen in der Filterbox angezeigt werden sollen, geben Sie hier an, welche sichtbar sein sollen.
Öffnet die Suche mit vorausgefüllter Suchanfrage.
Gibt an, ob auch archivierte Inhalte in den Ergebnissen angezeigt werden sollen. Dieser Parameter wird nur angewandt, wenn der Parameter Nur archivierte Inhalte anzeigen mit einem anderen Wert als Ja (true) angegeben wurde.
Gibt an, ob zusätzliche Aktionen für gefundene Dokumente angezeigt werden sollen. Die zusätzlichen Aktionen werden als Schaltflächen unterhalb des Dokumentnamens angezeigt. Wird dieser Parameter auf Ja (true) gesetzt, so werden die zusätzlichen Aktionen angezeigt.
Gibt an, ob eine Aktion welche die Sprachversionen eines Dokuments anzeigt, unterhalb des Dokumentnamens und der anderen Aktionen angezeigt werden soll. Wird dieser Parameter auf Ja (true) gesetzt so wird ein Button mit dem Label „Weitere Sprachversionen“ angezeigt.
Gibt an, welche Sprachversionen eines Dokuments angezeigt werden sollen, wenn die Aktion „Weitere Sprachversionen“ ausgeführt wird. Die Sprachen werden als 2-buchstabige ISO-Codes angegeben. Die verfügbaren Werte können hier eingesehen werden: ISO-Sprachcodes
Filterparameter
Gibt die ID einer Marke an, auf welche gefiltert werden soll.
Gibt die ID einer Serie an, auf welche gefiltert werden soll.
Gibt die ID einer Kategorie an, auf welche gefiltert werden soll.
Gibt ein Tag an, auf welche gefiltert werden soll.
Gibt den Inhaltstyp an, auf den gefiltert werden soll. Die verfügbaren Werte können hier eingesehen werden: Inhaltstypen
Gibt die Sprache als 2-buchstabigen ISO-Code an, auf welche gefiltert werden soll. Die verfügbaren Werte können hier eingesehen werden: ISO-Sprachcodes
Versteckte Filterparameter
Gibt die Lieferantennummer des Partners an, auf welche gefiltert werden soll.
Gibt an, welche Inhalte durchsucht werden sollen.
Gibt an, welche spezifischen Inhaltstypen angezeigt werden sollen. Die verfügbaren Werte können hier eingesehen werden: Inhaltstypen
Gibt an, ob nur eigene Inhalte oder nur Inhalte von anderen Anbietern angezeigt werden sollen.
Gibt an, ob ausschließlich archivierte Inhalte in den Ergebnissen angezeigt werden sollen. Wenn dieser Parameter auf Ja (true) gesetzt wird, werden nur archivierte Inhalte in den Ergebnissen angezeigt. Außerdem hat der Parameter dann Vorrang vor dem Parameter Archivierte Inhalte anzeigen.
Gibt die Sprachen als 2-buchstabige ISO-Codes an, auf welche die Ergebnisse eingeschränkt werden sollen. Die verfügbaren Werte können hier eingesehen werden: ISO-Sprachcodes
Gibt die Länder als 2-buchstabige ISO-Codes an, auf welche die Ergebnisse eingeschränkt werden sollen. Die verfügbaren Werte können hier eingesehen werden: ISO-Ländercodes
Gibt die ID einer Marke an, auf welche die Suche eingeschränkt werden soll.
Gibt die ID einer Serie an, auf welche die Suche eingeschränkt werden soll.
Gibt die ID einer Kategorie an, auf welche die Suche eingeschränkt werden soll.
Gibt ein Tag an, auf welche die Suche eingeschränkt werden soll.
Gibt den Inhaltstyp an, auf welche die Suche eingeschränkt werden soll. Die verfügbaren Werte können hier eingesehen werden: Inhaltstypen
Gibt die Sprache als 2-buchstabigen ISO-Code an, auf welche die Suche eingeschränkt werden soll. Die verfügbaren Werte können hier eingesehen werden: ISO-Sprachcodes

Ausgabebereich

See also
Enthält die Grundlagen zum Thema Javascript Integration.