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.
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:
|
input | string |
Gibt das Ziel-Element an, in welches die Suchleiste eingefügt wird. Hinweis:
|
mobileFilterButton | string |
Gibt das Ziel-Element an, in welches die Schaltfläche zum Öffnen der Filter-Seitenleiste auf Mobilgeräten eingefügt wird. Hinweis:
|
showFilterBox | boolean |
Gibt an, ob die Filterbox angezeigt werden soll. Die Filterbox bietet verschiedene Filtermöglichkeiten für die Nutzer an. Hinweis:
|
showFilterBar | boolean |
Gibt an, ob alternativ zur Filterbox eine horizontale Filterleiste zwischen Suchfeld und Suchergebnis angezeigt werden soll. Hinweis:
|
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:
|
||||||||||||||
topBrandsLabel | string |
Gibt die Überschrift an, welche über den Topmarken stehen soll. Hinweis:
|
||||||||||||||
brandsLabel | string |
Gibt die Überschrift an, welche über den restlichen Marken stehen soll. Hinweis:
|
||||||||||||||
initialFocus | boolean |
Gibt an, ob das Suchfeld beim Laden der Seite den Fokus erhalten soll. Hinweis:
|
||||||||||||||
showJumpToTopButton | boolean |
Gibt an, ob der Button zum Springen an den Anfang der Seite angezeigt werden soll. Hinweis:
|
||||||||||||||
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:
Hinweis:
|
||||||||||||||
query | string |
Öffnet die Suche mit vorausgefüllter Suchanfrage. |
||||||||||||||
includeOutdated | boolean |
Gibt an, ob auch archivierte Inhalte in den Ergebnissen angezeigt werden sollen. Hinweis:
|
||||||||||||||
limit | integer |
Gibt die maximale Anzahl an Inhalten an, welche initial pro Inhaltstyp angezeigt werden sollen. Hinweis:
|
||||||||||||||
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:
Hinweis:
|
||||||||||||||
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:
Hinweis:
|
||||||||||||||
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:
|
||||||||||||||
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:
|
||||||||||||||
sortBy | string |
Gibt die Sortierung der Ergebnisse vor. Die nachfolgenden Werte stehen hier zur Verfügung:
Hinweis:
|
||||||||||||||
invokeInfoplayOnProductClick | boolean |
Gibt an, ob bei einem Klick auf ein Produkt Infoplay ausgelöst werden soll, satt das Datenblatt zu öffnen. Hinweis:
|
||||||||||||||
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:
|
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 |
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:
|
||||||||||
displayedResults | string |
Gibt an, welche Inhalte durchsucht werden sollen. Die verfügbaren Werte können hier eingesehen werden:
Hinweis:
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:
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:
|
||||||||||
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:
|
||||||||||
own | boolean |
Gibt an, ob nur eigene Inhalte oder nur Inhalte von anderen Anbietern angezeigt werden sollen. Hinweis:
|
||||||||||
onlyOutdated | boolean |
Gibt an, ob ausschließlich archivierte Inhalte in den Ergebnissen angezeigt werden sollen. Hinweis:
|
||||||||||
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 |