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. Mithilfe 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. Hinweis: Wenn sie diesen Parameter `responsiveFilterBox` nennen, wird die Filterliste auf mobilen Geräten als Dropdown-Liste angezeigt.
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.

showJumpToTopButton

Gibt an, ob der Button zum Springen an den Anfang der Seite angezeigt werden soll. Wird dieser Parameter nicht angegeben, so wird false als Standard-Wert verwendet und somit kein Button angezeigt.

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 den Parameter aus der automatisch geänderten URL kopieren.

filterBoxGroups

Wenn nicht alle Filtergruppen in der Filterliste angezeigt werden sollen, geben Sie hier an welche sichtbar sein sollen:

Wert	Beschreibung
brands	Marken
categories	Kategorien
types	Inhaltstypen
tags	Tags
langs	Sprachen

Um beispielsweise nur Marken und Tags anzuzeigen geben Sie als Wert brands,tags mit. Wird dieser Parameter nicht mitgegeben, werden alle Filtergruppen angezeigt.

typeDelay

Hier können Sie eine Verzögerung in Millisekunden 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.

withDownload

Belegen Sie diesen Parameter mit dem Wert true, damit Download und (wenn Bestellfunktion über Parameter order angegeben) Bestell Buttons für Dokumente analog zur Integration Dokumente mit Download-Button angezeigt werden.

order

Belegen Sie diesen Parameter mit einer Javascript Funktion in Verbindung mit dem Parameter withDownload um den Button "Bestellen" bei Dokumenten anzeigen zu lassen. Auf diese Weise können Sie eine eigene Bestellmöglichkeit implementieren. Weitere Informationen zum Aufbau des Bestell-Callbacks finden Sie im Hilfetext zur Integration Dokumente mit Download-Button .

showAnchorLinks

Zeigt Ankerlinks über den Suchergebnissen an mit denen zu einzelnen Abschnitten des Suchergebnisses gesprungen werden kann. Außerdem wir ein Pfeil in der rechten unteren Ecke des Browsers angezeigt mit dem wieder nach oben gesprungen werden kann.

Sie können die Position, an die bei Klick auf den Pfeil nach oben gesprungen wird verändern, um z.B. noch die Suchleiste einzublenden. Dazu geben Sie der CSS-Klasse oxomi-offsetted-anchor-top ein top Attribut, z.B. top: -150px; um 150 Pixel weiter nach oben zu springen.
Analog dazu können Sie, falls Sie z.B. eine fixierte Navigationsleiste haben, für die Klasse oxomi-offsetted-anchor ein top Attribut setzten, um jeden Anchor um die Höhe der Navigationsleiste zu verschieben.

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 beispielsweise nur Kataloge und Videos anzuzeigen geben Sie als Wert catalogs,videos mit. Wird dieser Parameter 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 z.B. 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.

UniversalSearch URL überschreiben

In der UniversalSearch Integration kann die im Browser angezeigte URL genauso überschrieben werden, wie im Portal selbst. Dazu muss beim Aufruf der Integration die folgende Parameter-Kombination angegeben werden:

oxomi.portalSearch({
    ...
    "selection": oxomi.parseQueryString().selection || "",
    "updatePortalUrl": true
});

Der Parameter selection setzt so die aktuelle Auswahl auf den selection Parameter der URL. Der Parameter updatePortalUrl mit dem Wert true sorgt dafür, dass sich bei der Navigation im Portal automatisch die URL im Browser ändert, sodass der Parameter selection angehängt wird.

Fehlerbehebung: "on is not a function"

TypeError: ms.combobox.on is not a function

Dies liegt ziemlich sicher am Einsatz einer deutlich veralteten jQuery Version. Die Funktion on ist erst seit jQuery 1.7 (Erscheinungsdatum 2011) Bestandteil der Bibliothek, bei allen älteren jQuery Versionen kommt es unter anderem beim Laden der UniversalSearch zu oben genanntem Fehler. Wir empfehlen mindestens Version 1.10.2 einzusetzen. Ein Upgrade auf jQuery 3 ist natürlich sinnvoll, wenn der Mehraufwand gerechtfertigt ist. Über folgende Eingabe in der Browserkonsole kann herausgefunden werden welche jQuery Version auf einer Seite aktuell eingebunden ist:

jQuery.fn.jquery

Zurück zur Übersicht