Dieser Migration Guide soll Ihnen bei der Umstellung Ihrer Integrationen von Frontend 1.0 auf Frontend 2.0 helfen. Hierbei werden die Breaking-Changes der einzelnen Integrationen aufgezeigt und erklärt. Weitere Informationen zu den einzelnen Integrationen finden Sie in den jeweiligen Knowledgebase Artikeln. Diese enthalten neben einer vollständigen Parameterbeschreibung einen interaktiven Showcase oder ein interaktives Codebeispiel. Daher geht dieser Guide nicht auf die neuen Funktionen der einzelnen Integrationen ein, sondern zeigt wie die bestehende Funktionalität auf die neue Version migriert werden kann. Außerdem wird in diesem Guide nur auf Integrationen eingegangen, bei denen Breaking-Changes aufgetreten sind. Das heißt, wenn die von Ihnen verwendeten Integrationen nicht in diesem Guide aufgeführt sind besteht kein Handlungsbedarf.
Bevor in den folgenden Abschnitten auf die einzelnen Integrationen eingegangen wird, folgt in diesem Abschnitt eine Beschreibung der allgemeinen Änderungen, die für alle Integrationen gelten.
Plural-Parameter
Parameternamen, welche im Plural sind, verhalten sich auch so. Das bedeutet, dass Sie hier mehrere Werte angeben können, die entweder durch ein Komma (,) oder Pipe (|) getrennt sind. Die Angabe der Werte erfolgt ohne Leerzeichen.
Promise-Handling
Integrationen, die einen completionHandler und emptyResultHandler angeboten haben, geben nun ein Promise zurück. Dieses wird erfolgreich aufgelöst in den Fällen, in denen zuvor der completionHandler aufgerufen wurde und es wird in den Fällen als fehlerhaft markiert, in denen früher der emptyResultHandler aufgerufen wurde.
Das nachfolgende Beispiel zeigt die Verwendung des neuen Promise-Handlings:
FE 1.0 - completionHandler & emptyResultHandler
FE 2.0 - Promise
oxomi.resolveGTIN({ gtin: 'ZU-SUCHENDE-GTIN', completionHandler: function (json) { console.log("Artikel gefunden"); }, emptyResultHandler: function (json) { console.log("Keinen Artikel gefunden."); } });
oxomi.resolveGTIN({ gtin: 'ZU-SUCHENDE-GTIN' }).then((json) => { console.log("Artikel gefunden"); }).catch((json) => { console.log("Keinen Artikel gefunden."); });
Browser-History / Deeplink-Funktion
Das neue History-Handling (oxDeeplink) kann innerhalb der oxomi.initmit dem Parameter disableOverlayHistory deaktiviert werden. Dazu muss der Parameter auf true gesetzt werden.
Die Integration oxomi.portalSearch wurde umbenannt in oxomi.universalSearch.
Die nachfolgende Tabelle beschreibt die in der FE 2.0 oxomi.universalSearch Integration entfallenen Parameter und erklärt, wie diese ersetzt werden können, sofern nötig.
Name | Erklärung |
---|---|
filterBox |
Die Filterbox wird nun immer neben dem Ergebnis angezeigt und kann mittels showFilterBox: false deaktiviert werden. Alternativ kann mittels showFilterBar: true eine horizontale Filterleiste zwischen Suchfeld und Suchergebnis angezeigt werden. |
scrollContainer |
Wird nicht mehr benötigt, da die UniversalSearch nun automatisch das scrollende Element erkennt. |
showDetails |
Früher wurde hiermit unter anderem die Anzeige der Inhaltsnamen ein- bzw. ausgeschaltet. Der Name der Inhalte wird nun standardmäßig angezeigt und kann mithilfe der CSS Klasse oxomi-content-name-cust ausgeblendet werden. |
animate |
Wird nicht mehr benötigt. |
highlight |
Wird nicht mehr benötigt. |
selection |
Kann über detaillierte Filterparameter gesteuert werden. Siehe KBA. |
typeDelay |
Wird nicht mehr benötigt. |
brandLimit |
Wird nicht mehr benötigt, da Marken nun automatisch beim Scrollen unbegrenzt nachgeladen werden. |
contentLimit |
Wird nicht mehr benötigt, da sich weitere Inhalte über eine entsprechende Schaltfläche unbegrenzt nachladen lassen. |
itemLimit |
Wird nicht mehr benötigt. Der Standardwert wurde erhöht und eine Schaltfläche zum Sprung in den Navigator Pro wird angeboten. |
showAnchorLinks |
Wird aktuell nicht mehr angeboten, da einzelne Abschnitte nun initial deutlich kompakter dargestellt werden. (Weitere Inhalte lassen sich nachladen.) |
brand |
Filterung per Markenname ist nicht mehr vorgesehen, da dieser nicht zwingend eindeutig ist. Hier muss zukünftig die Marken-ID angegeben werden. |
tag |
Filterung auf mehrere Tags gleichzeitig wird nicht mehr unterstützt. Alternativ kann über hiddenTag auf einen einzelnen Tag gefiltert werden. |
Die nachfolgende Tabelle beschreibt die in der FE 2.0 oxomi.universalSearch Integrationumbenannten Parameter.
Name | Ersatz |
---|---|
infoplayOnArticleSelect | invokeInfoplayOnProductClick |
supplierNumber | supplierNumbers |
contentType | displayedResults |
type | displayedContentTypes |
lang | filterLanguages |
country | filterCountries |
brandId | hiddenBrand |
withDownload | showActions |
order | orderHandler |
Die Integration oxomi.openPortalSearch wurde umbenannt in oxomi.openUniversalSearch.
Die nachfolgende Tabelle beschreibt die in der FE 2.0 oxomi.openPortal Integration entfallenen Parameter und erklärt, wie diese ersetzt werden können, sofern nötig.
Name | Erklärung |
---|---|
portalStyle | Wird nicht mehr benötigt. Die Portalseite wird jetzt immer in der gleichen Optik wie im Portal angezeigt und das nötige CSS geladen. |
Die nachfolgende Tabelle beschreibt die in der FE 2.0 oxomi.openPage Integration entfallenen Parameter und erklärt, wie diese ersetzt werden können, sofern nötig.
Name | Erklärung |
---|---|
portalStyle | Wird nicht mehr benötigt. Die Portalseite wird jetzt immer in der gleichen Optik wie im Portal angezeigt und das nötige CSS geladen. |
Die nachfolgende Tabelle beschreibt die in der FE 2.0 oxomi.news Integration entfallenen Parameter und erklärt, wie diese ersetzt werden können, sofern nötig.
Name | Erklärung |
---|---|
compact | Wird nicht mehr benötigt. Die Integration wird jetzt in einer einheitlich optimierten und kompakten Variante dargestellt. |
Die Integration oxomi.catalogBrands wurde vollständig durch die neue oxomi.universalSearch Integration ersetzt. Hierfür muss der Parameter displayedResults: documents verwendet werden, um die Universal Search auf die Anzeige von Dokumenten einzuschränken.
Die Integration oxomi.catalogs wurde umbenannt in oxomi.documents.
Die nachfolgende Tabelle beschreibt die in der FE 2.0 oxomi.documents Integration entfallenen Parameter und erklärt, wie diese ersetzt werden können, sofern nötig.
Name | Erklärung |
---|---|
brand |
Filterung per Markenname ist nicht mehr vorgesehen, da dieser nicht zwingend eindeutig ist. Alternativ über brandId per Marken-ID filtern. |
category |
Filterung per Kategoriename ist nicht mehr vorgesehen, da dieser nicht zwingend eindeutig ist. Alternativ über categoryIds per Kategorie-ID filtern. |
search |
Falls eine Suche benötigt wird, sollte die UniversalSearch verwendet werden. |
showDetails |
Früher wurde hiermit der Name unter dem Dokument ein- bzw. ausgeschaltet. Der Name der Dokumente wird nun standardmäßig angezeigt und kann mithilfe der CSS Klasse oxomi-content-name-cust ausgeblendet werden. |
Die nachfolgende Tabelle beschreibt die in der FE 2.0 oxomi.documents Integration umbenannten Parameter.
Name | Ersatz |
---|---|
languages | additionalLanguages |
supplierNumber | supplierNumbers |
brandId | brandIds |
tag | tags |
categoryId | categoryIds |
type | types |
lang | filterLanguages |
country | filterCountries |
languages | additionalLanguages |
order | orderHandler |
Die Integration oxomi.catalogsWithDownload wurde vollständig durch die neue oxomi.documents Integration ersetzt. Hierfür muss der Parameter showActions: true verwendet werden.
Die Integration oxomi.catalogsWithLanguages wurde vollständig durch die neue oxomi.documents Integration ersetzt. Hierfür muss der Parameter showAdditionalLanguages: true verwendet werden.
Die Integration oxomi.embedCatalog wurde umbenannt in oxomi.embedDocument.
Die nachfolgende Tabelle beschreibt die in der FE 2. 0 oxomi.embedDocument Integration umbenannten Parameter.
Name | Ersatz |
---|---|
catalog | document |
Die Integration oxomi.embedCatalogWithDownload wurde vollständig durch die neue oxomi.embedDocument Integration ersetzt. Hierfür muss der Parameter showActions: true verwendet werden.
Die nachfolgende Tabelle beschreibt die in der FE 2. 0 oxomi.embedDocument Integration umbenannten Parameter.
Name | Ersatz |
---|---|
catalog | document |
Die Integration oxomi.embedCatalogWithLanguages wurde vollständig durch die neue oxomi.embedDocument Integration ersetzt. Hierfür muss der Parameter showAdditionalLanguages: true verwendet werden.
Die nachfolgende Tabelle beschreibt die in der FE 2.0 oxomi.embedDocument Integration umbenannten Parameter.
Name | Ersatz |
---|---|
catalog | document |
languages | additionalLanguages |
order | orderHandler |
Die Integration oxomi.openCatalog wurde umbenannt in oxomi.openDocument.
Die nachfolgende Tabelle beschreibt die in der FE 2.0 oxomi.news Integration entfallenen Parameter und erklärt, wie diese ersetzt werden können, sofern nötig.
Name | Erklärung |
---|---|
download | Für diese Funktionalität steht die Integration oxomi.downloadDocument zur Verfügung. Außerdem kann oxomi.embedDocument verwendet werden mit dem Parameter directDownload, falls es darum geht, ob das Cover-Bild angezeigt werden soll. |
Die nachfolgende Tabelle beschreibt die in der FE 2.0 oxomi.embedDocument Integration umbenannten Parameter.
Name | Ersatz |
---|---|
catalog | document |
page | pageNumber |
Die Integration oxomi.downloadCatalog wurde umbenannt in oxomi.downloadDocument.
Die nachfolgende Tabelle beschreibt die in der FE 2.0 oxomi.embedDocument Integration umbenannten Parameter.
Name | Ersatz |
---|---|
catalog | document |
page | pageNumber |
Die Integration oxomi.videoBrands wurde vollständig durch die neue oxomi.universalSearch Integration ersetzt. Hierfür muss der Parameter displayedResults: videos verwendet werden, um die Universal Search auf die Anzeige von Videos einzuschränken.
Die Integration oxomi.videos behält ihren Namen oxomi.videos.
Die nachfolgende Tabelle beschreibt die in der FE 2.0 oxomi.videos Integration entfallenen Parameter und erklärt, wie diese ersetzt werden können, sofern nötig.
Name | Erklärung |
---|---|
brand |
Filterung per Markenname ist nicht mehr vorgesehen, da dieser nicht zwingend eindeutig ist. Alternativ über brandId per Marken-ID filtern. |
category |
Filterung per Kategoriename ist nicht mehr vorgesehen, da dieser nicht zwingend eindeutig ist. Alternativ über categoryIds per Kategorie-ID filtern. |
size |
Die Video-Kacheln sind jetzt immer gleich groß. Die Größe ist konsistent mit der UniversalSearch. |
width |
Die Video-Kacheln sind jetzt immer gleich groß. Die Größe ist konsistent mit der UniversalSearch. |
height |
Die Video-Kacheln sind jetzt immer gleich groß. Die Größe ist konsistent mit der UniversalSearch. |
search |
Falls eine Suche benötigt wird, sollte die UniversalSearch verwendet werden. |
showDetails |
Früher wurde damit der Name unter dem Video ein/ausgeschaltet. Der Name der Videos wird nun standardmäßig angezeigt und kann mithilfe der CSS Klasse oxomi-content-name-cust ausgeblendet werden. |
mode |
Videos öffnen jetzt immer im Overlay. Dieses Verhalten ist Konsistent mit der UniversalSearch. |
Die nachfolgende Tabelle beschreibt die in der FE 2.0 oxomi.videos Integration umbenannten Parameter.
Name | Ersatz |
---|---|
supplierNumber | supplierNumbers |
brandId | brandIds |
tag | tags |
categoryId | categoryIds |
type | types |
lang | filterLanguages |
country | filterCountries |
languages | additionalLanguages |
Die Integration oxomi.embedVideo behält ihren Namen oxomi.embedVideo.
Die nachfolgende Tabelle beschreibt die in der FE 2.0 oxomi.embedVideo Integration entfallenen Parameter und erklärt, wie diese ersetzt werden können, sofern nötig.
Name | Erklärung |
---|---|
size |
Die Größe des eingebetteten Videos wird jetzt durch den Container, in welchem das Video eingebettet wird, bestimmt. Sollte jedoch die Option mode: overlay ausgewählt werden, so wird hier die aus der UniversalSearch bekannte Standardkachel angezeigt. |
width |
Die Größe des eingebetteten Videos wird jetzt durch den Container, in welchem das Video eingebettet wird, bestimmt. Sollte jedoch die Option mode: overlay ausgewählt werden, so wird hier die aus der UniversalSearch bekannte Standardkachel angezeigt. |
height |
Die Größe des eingebetteten Videos wird jetzt durch den Container, in welchem das Video eingebettet wird, bestimmt. Sollte jedoch die Option mode: overlay ausgewählt werden, so wird hier die aus der UniversalSearch bekannte Standardkachel angezeigt. |
Die nachfolgende Tabelle beschreibt die in der FE 2. 0 oxomi.embedVideo Integration umbenannten Parameter.
Name | Ersatz |
---|---|
showDetails | showName |
Die Integration oxomi.openVideo behält ihren Namen oxomi.openVideo.
Die nachfolgende Tabelle beschreibt die in der FE 2. 0 oxomi.openVideo Integration umbenannten Parameter.
Name | Ersatz |
---|---|
paused | autoplay |
Die Integration oxomi.galleryBrands wurde vollständig durch die neue oxomi.universalSearch Integration ersetzt. Hierfür muss der Parameter displayedResults: galleries verwendet werden, um die Universal Search auf die Anzeige von Exposés einzuschränken.
Die Integration oxomi.galleries behält ihren Namen oxomi.galleries.
Die nachfolgende Tabelle beschreibt die in der FE 2.0 oxomi.galleries Integration entfallenen Parameter und erklärt, wie diese ersetzt werden können, sofern nötig.
Name | Erklärung |
---|---|
showDetails |
Früher wurde damit der Name unter dem Expose ein/ausgeschaltet. Der Name der Videos wird nun standardmäßig angezeigt und kann mithilfe der CSS Klasse oxomi-content-name-cust ausgeblendet werden. |
brand |
Filterung per Markenname ist nicht mehr vorgesehen, da dieser nicht zwingend eindeutig ist. Alternativ über brandId per Marken-ID filtern. |
category |
Filterung per Kategoriename ist nicht mehr vorgesehen, da dieser nicht zwingend eindeutig ist. Alternativ über categoryIds per Kategorie-ID filtern. |
Die nachfolgende Tabelle beschreibt die in der FE 2.0 oxomi.galleries Integration umbenannten Parameter.
Name | Ersatz |
---|---|
supplierNumber | supplierNumbers |
brandId | brandIds |
tag | tags |
categoryId | categoryIds |
type | types |
lang | filterLanguages |
country | filterCountries |
languages | additionalLanguages |
Die Integration oxomi.embedGallery behält ihren Namen oxomi.embedGallery.
Die nachfolgende Tabelle beschreibt die in der FE 2.0 oxomi.embedGallery Integration entfallenen Parameter und erklärt, wie diese ersetzt werden können, sofern nötig.
Name | Erklärung |
---|---|
showDetails |
Früher wurde damit der Name unter dem Expose ein/ausgeschaltet. Der Name der Videos wird nun standardmäßig angezeigt und kann mithilfe der CSS Klasse oxomi-content-name-cust ausgeblendet werden. |
mode |
Der Parameter wurde durch den Parameter inline ersetzt. Soll der Expose-Viewer direkt eingebettet werden, so muss hier true als Wert angegeben werden. |
Die Integration oxomi.stories behält ihren Namen oxomi.stories.
Die nachfolgende Tabelle beschreibt die in der FE 2.0 oxomi.stories Integration entfallenen Parameter und erklärt, wie diese ersetzt werden können, sofern nötig.
Name | Erklärung |
---|---|
brand |
Filterung per Markenname ist nicht mehr vorgesehen, da dieser nicht zwingend eindeutig ist. Alternativ über brandId per Marken-ID filtern. |
category |
Filterung per Kategoriename ist nicht mehr vorgesehen, da dieser nicht zwingend eindeutig ist. Alternativ über categoryIds per Kategorie-ID filtern. |
Die nachfolgende Tabelle beschreibt die in der FE 2.0 oxomi.stories Integration umbenannten Parameter.
Name | Ersatz |
---|---|
supplierNumber | supplierNumbers |
brandId | brandIds |
tag | tags |
categoryId | categoryIds |
type | types |
lang | filterLanguages |
country | filterCountries |
languages | additionalLanguages |
Dokumentseiten - oxomi.itemPages
Ersetzt durch oxomi.productData mit Informationstyp pages. Mehrere Anfragen für ein Produkt können nun in einem Aufruf gebündelt werden.
Dokumentseiten (mit Download-Button) - oxomi.itemPagesWithDownload
Ersetzt durch oxomi.productData mit Informationstyp pages und Parameter showActions: true. Mehrere Anfragen für ein Produkt können nun in einem Aufruf gebündelt werden.
Bilder - oxomi.itemImages
Ersetzt durch oxomi.productData mit Informationstyp product-images. Mehrere Anfragen für ein Produkt können nun in einem Aufruf gebündelt werden.
Videos - oxomi.itemVideos
Ersetzt durch oxomi.productData mit Informationstyp videos. Mehrere Anfragen für ein Produkt können nun in einem Aufruf gebündelt werden.
Exposes - oxomi.itemGalleries
Ersetzt durch oxomi.productData mit Informationstyp galleries. Mehrere Anfragen für ein Produkt können nun in einem Aufruf gebündelt werden.
Dateien - oxomi.itemAttachments
Ersetzt durch oxomi.productData mit Informationstyp attachments. Mehrere Anfragen für ein Produkt können nun in einem Aufruf gebündelt werden.
Langtext - oxomi.itemText
Ersetzt durch oxomi.productData mit Informationstyp html-description. Mehrere Anfragen für ein Produkt können nun in einem Aufruf gebündelt werden.
Artikelbeziehungen - oxomi.itemReferences
Ersetzt durch oxomi.productData mit Informationstyp relationships. Mehrere Anfragen für ein Produkt können nun in einem Aufruf gebündelt werden.
Datenblatt - oxomi.itemDatasheet
Die Integration oxomi.itemDatasheet wurde umbenannt in oxomi.productDatasheet.
Die nachfolgende Tabelle beschreibt die in der FE 2.0 oxomi.productDatasheet Integration entfallenen Parameter und erklärt, wie diese ersetzt werden können, sofern nötig.
Name | Erklärung |
---|---|
tag |
Existiert im neuen Datenmodell nicht mehr. |
videoMode |
Existiert im neuen Datenmodell nicht mehr. |
includeOutdated |
Existiert im neuen Datenmodell nicht mehr. |
onlyOutdated |
Existiert im neuen Datenmodell nicht mehr. |
fullWithHeading |
Darstellung wurde komplett überarbeitet. |
showItemGroups |
Darstellung wurde komplett überarbeitet. |
lang |
Ersetzt durch filterLanguages in oxomi.init. |
country |
Ersetzt durch filterCountries in oxomi.init. |
Die nachfolgende Tabelle beschreibt die in der FE 2. 0 oxomi.productDatasheet Integration umbenannten Parameter.
Name | Ersatz |
---|---|
supplierItemNumber | itemNumber |
Datenblatt öffnen - oxomi.openProductDatasheet
Die nachfolgende Tabelle beschreibt die in der FE 2. 0 oxomi.openProductDatasheet Integration umbenannten Parameter.
Name | Ersatz |
---|---|
supplierItemNumber | itemNumber |
Datenblatt-PDF-Download - oxomi.downloadItemDatasheet
Entfällt als aufrufbare Einzel-Integration, da es im Datenblatt integriert ist.
Stammdaten - oxomi.itemMasterdata
Ersetzt durch oxomi.productData mit Informationstypen header und commercial. Mehrere Anfragen für ein Produkt können nun in einem Aufruf gebündelt werden.
Datenverfügbarkeit - oxomi.exists
Ersetzt durch oxomi.productDataExists. Ein Aufruf ist aber nun oftmals nicht mehr nötig, da ein gesammelter Aufruf an oxomi.productData abgesetzt werden kann.
Merkmale - oxomi.itemFeatures
Ersetzt durch oxomi.productData mit Informationstyp features. Mehrere Anfragen für ein Produkt können nun in einem Aufruf gebündelt werden.
Bauphasen - oxomi.itemInformationPerPhase
Ersetzt durch oxomi.productData mit Informationstyp building-phases. Mehrere Anfragen für ein Produkt können nun in einem Aufruf gebündelt werden.
3D-Viewer - oxomi.item3dViewer
Umbenannt zu oxomi.product3dViewer.
3D-Modell-Verfügbarkeitsprüfung - oxomi.item3dExists
Umbenannt zu oxomi.product3dExists.
Die zuvor während der Initialisierung (oxomi.init) angegebenen Callbacks wurden durch eine neuartige Implementierung mittels Buzz ersetzt. Hierbei kann die eigentliche Abfrage-Logik nahezu identisch bleiben, muss aber in die neue Struktur überführt werden. Sehen Sie hierfür am besten die neuen Artikel zu Buzz und Infoplay bzw. die unten verlinkten Alternativen zu den von ihnen verwendeten Funktionen.
Die Datenstruktur der zurück gegebenen Produktinformationen orientiert sich hier sehr stark an den alten Callbacks. Sie müssten sich also nahezu eins zu eins übernehmen lassen.
Einen Einblick in die genaueren Unterschiede des Funktionsaufbaus kann auch ein Blick in unsere Infoplay Integrationsbeispiele zu FE 1.0 und FE 2.0 bieten.
Infoplay 2.0
Die Callbacks infoplayItemLookup, infoplayBasketHandlerund infoplayItemHandler wurden durch eine neue Implementierung mittels Buzz ersetzt.
infoplayItemLookup -> fetchProductData und enhanceProductData
infoplayBasketHandler -> addProductToBasket
Infoplay Direct
Der Callback infoplayProductLookup wurde durch eine neue Implementierung mittels Buzz ersetzt.
infoplayProductLookup -> enhanceProductData