Universal Search

Die Universal Search ist die beste Möglichkeit auf alle Inhalte eines Portals zuzugreifen. Binden Sie diese mit der Funktion oxomi.portalSearch ein. Die Standardansicht ist eine Markenübersicht. Mit Hilfe von Filtern (sowohl durch den Nutzer als auch durch die Integration festgelegt) lässt sich das Portal dann so durchsuchen, dass Dokumente, Einzelseiten, Videos, Exposés und Artikel gefunden werden können.

Artikelsuche

Standardmäßig werden die Artikel des Portalbetreibers 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.

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 einen jQuery-Selektor des jeweiligen Elements an. Die Elemente für target und input müssen beide auf der Seite vorhanden sein, damit die Suche funktionieren kann.

Parameter Beschreibung
target

Gibt das Ziel-Element an, in welches die Markenübersicht/Suchergebnisse eingefügt wird. Wird dieser Parameter nicht angegeben, so wird #oxomi-portalSearch als Standard-Wert verwendet. Falls das Ziel-Element sich innerhalb eines scrollbaren Containers befindet, muss dieser Container unter dem Parameter scrollContainer angegeben werden.

input

Gibt das Element an, in welches die Suchleiste eingefügt wird. Wird dieser Parameter nicht angegeben, so wird #oxomi-searchBar als Standard-Wert verwendet.

filterBox

Gibt das Element an, in welches die Filterliste eingefügt wird. Diese Filterliste ist optional.

scrollContainer

Falls sich das target-Element in einem scrollbaren Element befindet, muss der Selektor für diesen Scroll-Container hier angegeben werden, damit das Lazy-Loading der Bilder funktioniert.

Einstellungen

Parameter Beschreibung
topBrands

Belegen Sie diesen Parameter mit dem Wert true, damit Topmarken in der Markenübersicht abgegrenzt werden. Dann müssen 2 weitere Parameter mit angegeben werden:

Parameter Beschreibung
topBrandsLabel

Überschrift für Topmarken

brandsLabel

Überschrift für restliche Marken

showDetails

Belegen Sie diesen Parameter mit dem Wert true, damit der Name der Inhalte als Beschriftung mit angezeigt wird.

animate

Belegen Sie diesen Parameter mit dem Wert true, damit Ergebnisse nach unten verschoben werden, sobald die Suchvorschläge ausklappen. Dies ist für den Fall gedacht, dass Sie die Ergebnisse direkt unter der Suchzeile platziert haben.

highlight

Belegen Sie diesen Parameter mit dem Wert true, damit Suchbegriffe in den Suchvorschlägen hervorgehoben werden.

selection

Mithilfe dieses Parameters lassen sich für den ersten Aufruf bereits ausgewählte Filter in das Eingabefeld setzen. Der String, der hierfür angegeben werden muss, finden Sie indem Sie die gewünschten Filter in der OXOMI-Portaloberfläche oxomi.com/p/xxxxxx/search auswählen und sich den Parameter aus der automatisch geänderten URL rauskopieren.

typeDelay

Hier können Sie eine Verzögerung in Milisekunden zwischen der Eingabe des Nutzers und dem Ausklappen der Suchvorschläge einstellen. Standardwert ist 0. In sehr großen Portalen kann dieser Wert z.B. auf 200 gestellt werden, um die Performance zu verbessern.

brandLimit

Begrenzt die Anzahl der angezeigten Marken. Standard-Wert ist 1024 (max. 5000)

contentLimit

Begrenzt die Anzahl der angezeigten Inhalte. Standard-Wert ist 256 (max. 5000)

itemLimit

Begrenzt die Anzahl der angezeigten Artikel. Standard-Wert ist 64 (max. 5000)

infoplayOnArticleSelect

Belegen Sie diesen Parameter mit dem Wert true, damit beim Klick auf gefundene Artikel direkt Infoplay aufgerufen wird, statt dem Artikeldatenblatt.

Filter

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.

Parameter Beschreibung
supplierNumber

Eine Lieferantennummer auf die gefiltert werden soll.

brand

Gibt einen Markennamen an, der als Auswahlkriterium verwendet wird. Beachten Sie, dass Groß-Kleinschreibung hierbei berücksichtigt wird.

Hinweis: Falls Sie die ID der gewünschten Marke kennen, können Sie alternativ auch mit dem Parameter brandId arbeiten.

tag

Tag auf den gefiltert werden soll. Geben Sie mehrere Tags durch Kommas getrennt an.

type

Inhaltstyp auf den gefiltert werden soll. Eine Übersicht für die Codes finden sie hier: Inhaltstypen.

contentType

Wenn nicht alle Medientypen angezeigt werden sollen, geben Sie hier an welche sichtbar sein sollen:

Wert Beschreibung
catalogs

Kataloge

videos

Videos

galleries

Exposés

items

Artikel

Um Besipielweise nur Kataloge und Videos anzuzeigen geben Sie als Wert catalogs,videos mit. Wird dieser Paramter nicht mitgegeben, werden alle 4 Inhaltstypen angezeigt.

own

Wird dieser Parameter auf true gesetzt, so werden ausschließlich eigene Inhalte angezeigt. Bei false werden ausschließlich Inhalte von anderen Anbietern angezeigt. Um keine Filterung vorzunehmen, müssen Sie den Filter leer lassen.

Nachfolgende Parameter sind nur für PRO Portale verfügbar:
Parameter Beschreibung
lang

Gibt die Sprache (als 2-buchstabigen  ISO-Code) an, nach der gefiltert werden soll.

country

Gibt das Land (als 2-buchstabigen  ISO-Code) an, nach dem gefiltert werden soll.

Vorauswahl

Diese Parameter dienen als Filter aber können vom Nutzer wieder gelöscht werden. So kann die Universal Search zb. schon mit Suchbegriff geöffnet werden.

Parameter Beschreibung
query

Öffnet die Suche mit vorausgefüllter Suche.

includeOutdated

Falls true, werden archivierte Inhalte auch angezeigt. Dieser Filter kann vom Nutzer nur geändert werden, wenn die Filterbox angezeigt wird.

onlyOutdated

Falls true, werden nur archivierte Inhalte und Artikel in den Ergebnissen angezeigt. Dieser Parameter überschreibt den Parameter includeOutdated und kann vom Nutzer nicht geändert werden.