Einbinden von Dokumenten

Hinweis: Derzeit werden Dokumente standardmäßig im Flash-Viewer geöffnet. Ist kein Flash vorhanden, wird der neue HTML5-Viewer zum Öffnen genutzt.

Setzen Sie in oxomi.init den Parameter forceHTML5 auf true, um immer den HTML5-Viewer zu nutzen.

Setzen Sie in oxomi.init den Parameter forceFlash auf true, um immer den Flash-Viewer zu nutzen, auch wenn der OXOMI-Standard geändert wird.

Markenübersicht für Dokumente

Binden Sie eine Markenübersicht von Dokumenten mit der Funktion oxomi.catalogBrands ein. Mit Klick auf eine Marke erscheinen die entsprechenden Dokumente der jeweiligen Marke.

Parameter Beschreibung
target

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

brandCategory

Gibt den Namen einer gewünschten Kategorie an.

brandTag

Gibt einen Tag an, nach dem gefiltert werden soll.

brandSortBy Legt die Sortierung der Markenübersicht fest. Die nachfolgenden Werte stehen hier zur Verfügung.

Wert Beschreibung
priority Standard-Sortierung nach Priorität, kleinste Prioritäts-Zahl wird zuerst gezeigt. Bei gleicher Priorität wird alphanumerisch sortiert. Dies ist der verwendete Standard-Wert.
name Sortiert alphanumerisch nach dem Namen.
date Sortierung nach Datum, neuste Objekte werden zuerst gezeigt.
random Das Ergebnis ist zufällig gemischt.

brandGroupBy

Lässt das Ergebnis gruppiert zurückgeben, falls angegeben. Mögliche Gruppierungen sind:

Wert Beschreibung
category Gruppiert nach Kategorie
brand Gruppiert nach Marke
type Gruppiert nach Typ
tag Gruppiert nach Tags

Hinweis: Falls gruppiert wird, so wird eine andere Struktur des Ergebnisobjekts zurückgegeben.

brandLimit

Begrenzt die Anzahl der angezeigten Ergebnisse. Standard-Wert ist 1024 (max. 2048)

brandSearch

Gibt an, ob zusätzlich auch ein Sucheingabefeld eingebunden wird. Das hier verwendete Template kann über den Parameter searchBarTemplate geändert werden.

own

Wird dieser Parameter auf false gesetzt, so wird die eigene Marke aus der Ergebnisliste entfernt. Um keine Filterung vorzunehmen, müssen Sie den Filter leer lassen.

brandPriorityStart

Ist dieser Parameter gefüllt, erscheinen im Ergebnis nur Marken, deren Markenpriorität gleich oder höher als dieser Wert ist.

brandPriorityEnd

Ist dieser Parameter gefüllt, erscheinen im Ergebnis nur Marken, deren Markenpriorität gleich oder niedriger als dieser Wert ist.

withDownload

Belegen Sie diesen Parameter mit true, wenn für die Anzeige der Dokumente das Template  Dokumente mit Download-Button verwendet werden soll.

withLanguages

Belegen Sie diesen Parameter mit true, wenn für die Anzeige das Template  Dokumente als Sprachversionen anzeigen verwendet werden soll.

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.

Neben den hier angegebenen Parametern zur Filterung der anzuzeigenden Marken, können zusätzlich noch die Parameter von  oxomi.catalogs angegeben werden, um die entsprechende Listen-Darstellung mit den verknüpften Dokumenten zu filtern.

Beispiel:

oxomi.catalogBrands({ brandCategory: 'Sanitär',
                      brandSearch: true });

Dokumente anzeigen

Benutzen Sie hierfür die Funktion oxomi.catalogs. Mit dieser Funktion können Sie in Ihrer Webseite alle Kataloge eines Lieferanten ausgeben lassen.

Parameter Beschreibung
target

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

supplierNumber

Gibt die Lieferantennummer an für den Fall, dass die Werksnummer nicht eindeutig ist. Hier können Sie Ihre eigenen Lieferantennummern verwenden, wenn Sie diese in der Partnerschaft zum Lieferanten gepflegt haben (siehe:  Lieferantennummern).

excludedSupplierNumbers

Hiermit könnnen Sie Lieferantennummern ausschließen.

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

Nutzen Sie hier Tags als Auswahlkriterium. Vergessen Sie nicht die Prefixes "@" (für Artikelnummern) oder "#" (für Kategorien) mit anzugeben. Geben Sie mehrere Tags durch Kommas getrennt an.

category

Definiert den Namen einer Kategorie als Auswahlkriterium. Um mehrere Kategorien auszuwählen benutzten Sie | als Trennzeichen.

sortBy

Legt eine Sortierung fest. 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 Dokumentennamen 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.

groupBy

Lässt das Ergebnis gruppiert zurückgeben, falls angegeben. Mögliche Gruppierungen sind:

Wert Beschreibung
category Gruppiert nach Kategorie
brand Gruppiert nach Marke
type Gruppiert nach Typ
tag Gruppiert nach Tags

Hinweis: Falls gruppiert wird, so wird eine andere Struktur des Ergebnisobjekts zurückgegeben.

groupFilter

Wird dieser Parameter auf true gesetzt und der Parameter groupBy ist gesetzt, werden über dem Ergebnis Schaltflächen zur Filterung durch den Nutzer auf einzelne Gruppen angezeigt.

start

Definiert wieviel Elemente in der Ergebnisliste übersprungen werden. Soll z.B. mit dem Dritten Element begonnen werden, dann tragen Sie hier den Wert 2 ein.

Hinweis: Nutzen Sie diesen Parameter, um "seitenweise" durch die Ergebnismenge zu navigieren.

type

Gibt den Dokument-Typ an, nach dem gefiltert werden soll. Verwenden Sie hier die entsprechenden  Typen-Codes. Als Trennzeichen mehrerer Dokument-Typen wird | unterstützt.

own

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

limit

Begrenzt die Anzahl der angezeigten Ergebnisse. Standard-Wert ist 128 (max. 1024)

search

Belegen Sie diesen Parameter mit dem Wert true, um ein funktionsfähiges Sucheingabefeld mit einzubinden.

showDetails

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

includeOutdated

Belegen Sie diesen Parameter mit dem Wert true, damit auch archivierte Dokumente in den Ergebnissen angezeigt werden.

onlyOutdated

Belegen Sie diesen Parameter mit dem Wert true, damit nur archivierte Dokumente in den Ergebnissen angezeigt werden. Dieser Parameter überschreibt den Parameter includeOutdated.

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.

Beispiel:

oxomi.catalogs({ supplierNumber: 'L10190',
                 target: '#my-catalog-list' });

Dokumente mit Download-Button

Sie haben die Möglichkeit durch die Funktion oxomi.catalogsWithDownload die Anzeige der Dokumenten um Buttons zu erweitern. In dieser Variante erscheinen neben dem Titelbild des Dokuments die beiden Buttons "Download" und "Blätteransicht".

Mit Klick auf den Button "Download" kann das Dokument direkt heruntergeladen werden. Mit Klick auf den Button "Blätteransicht" öffnet sich wie gewöhnlich das Dokument im entsprechenden Portalfenster.

Sollten Sie die Anforderung haben eine Bestellfunktion für das entsprechende Dokument anbieten zu wollen, so können Sie den optionalen Parameter order nutzen, um auf diese Weise eine eigene Bestellfunktion zu implementieren. Der Button "Bestellen" erscheint sobald der Parameter mit einer Callback-Funktion belegt ist.

Beispiel: Dokumente anzeigen mit Download-Button

oxomi.catalogsWithDownload({
              supplierNumber: 'L10190',
              target: '#my-catalog-list',
              order: function (catalog) {
                        alert('Hier koennen Sie bestellen.');
                     }
});

Dokumente als Sprachversionen anzeigen

Sollten Sie die Anforderung haben alle Sprachversionen eines Dokuments zusammengefasst anzeigen zu wollen, nutzen hierfür die Funktion oxomi.catalogsWithLanguages. Bei dieser Integrationsfunktion erscheinen neben dem Titelbild des Dokuments die beiden Buttons "Download" und "Blätteransicht", jeweils für die mit dem Dokument verknüpfte Sprachversion.

Beispiel: Dokumente als Sprachversionen anzeigen

oxomi.catalogsWithLanguages({
              supplierNumber: 'L10190',
              target: '#my-catalog-list'
});

Mithilfe des optionalen Parameter languages können Sie die Reihenfolge der angezeigten Sprachversionen bestimmen. Übergeben Sie eine Kommas separierte Liste mit den gewünschten  Sprachen-Codes. Nicht genannte Sprachen-Codes werden in der Integration ausgelassen und nicht angezeigt.

Beispiel: Reihenfolge der Sprachversionen

oxomi.catalogsWithLanguages({
              supplierNumber: 'L10190',
              target: '#my-catalog-list',
              languages: 'fr,en'
});

Kombinieren Sie diese Funktion mit dem optionalen Parameter order, um die Belegung des "Bestellen" Buttons mit einer Funktion zu belegen.

Achtung: Der Wert des Parameters languages darf keine Leerzeichen enthalten.

Dokument-Typen

Die nachfolgendende Liste zeigt alle verfügbaren Dokumenten-Typen und die dazugehörigen Codes für die Verwendung in der Integration:

Typ Code
Aktion promotion
Katalog catalog
Preisliste pricelist
Ersatzteile spareparts
Prospekt flyer
Handbuch manual
Datenblatt datasheet
Zertifikat certificate
Werkszeugnis factory_certificate
Sicherheitsdatenblatt material_safety_data_sheet
Anleitung instruction
Leistungserklärung declaration_of_performance
Präsentation presentation
Sonstiges other

Einen Beschreibungstext der jeweiligen  Dokumenten-Typen finden Sie hinter dem Link.

Dokumente (Seiten) zu einem Artikel

Benutzen Sie hierfür die Funktion oxomi.itemPages. Diese Funktion ermöglicht es passende Seiten aus Katalogen, Aktionen, Preislisten usw. für einen Artikel anzuzeigen. Sollten keine passenden Seiten gefunden werden, so wird das HTML nicht verändert.

Parameter Beschreibung
target

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

itemNumber

Gibt die Artikelnummer an, für die Seiten gesucht werden sollen.

 Hinweis: Die Angabe der Artikelnummer wird als Suchanfrage ausgeführt. Dies bedeutet, dass gegebenenfalls auch Seiten ausgegeben werden, die ähnliche Nummern enthalten.

supplierItemNumber

Gibt die Werksnummer des Artikels an, damit auch Dokumente des Herstellers gefunden werden können.

supplierNumber

Gibt die Lieferantennummer an für den Fall, dass die Werksnummer nicht eindeutig ist. Hier können Sie Ihre eigenen Lieferantennummern verwenden, wenn Sie diese in der Partnerschaft zum Lieferanten gepflegt haben (siehe:  Lieferantennummern).

model

Gibt das Modell bzw. den Typ des Artikels an, damit auch danach gesucht werden kann.

ean

Gibt die EAN des Artikels an, damit auch nach dieser gesucht werden kann.

category

Definiert den Namen einer Kategorie als Auswahlkriterium. Um mehrere Kategorien auszuwählen benutzten Sie | als Trennzeichen.

own

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

query

Formulieren Sie hier eine Suchanfrage, nach der passende Dokumentseiten gesucht werden. Die Anfrage kann auch Logik mit OR und AND beinhalten.

tag

Nutzen Sie hier Tags als Auswahlkriterium. Vergessen Sie nicht die Prefixes "@" (für Artikelnummern) oder "#" (für Kategorien) mit anzugeben. Geben Sie mehrere Tags durch Kommas getrennt an.

type

Gibt den Dokument-Typ an, nach dem gefiltert werden soll. Verwenden Sie hier die entsprechenden  Typen-Codes. Als Trennzeichen mehrerer Dokument-Typen wird | unterstützt.

limit

Begrenzt die Anzahl der angezeigten Ergebnisse. Standard-Wert ist 10

showDetails

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

includeOutdated

Belegen Sie diesen Parameter mit dem Wert true, damit auch archivierte Dokumente in den Ergebnissen angezeigt werden.

onlyOutdated

Belegen Sie diesen Parameter mit dem Wert true, damit nur archivierte Dokumente in den Ergebnissen angezeigt werden. Dieser Parameter überschreibt den Parameter includeOutdated.

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.

Beispiel:

oxomi.itemPages({ supplierNumber: 'L10190',
                  itemNumber: 'A20876' });

Dokumente (Seiten) mit Download-Button

Die Funktion oxomi.itemPagesWithDownload erweitert die Anzeige der Dokumentseiten um die Buttons "Download" und "Blätteransicht".

Mit Klick auf den Button "Download" kann das Dokument direkt heruntergeladen werden. Mit Klick auf den Button "Blätteransicht" öffnet sich wie gewöhnlich das Dokument im entsprechenden Portalfenster.

Beispiel: Dokumentseiten mit Download-Button

oxomi.itemPagesWithDownload({
            supplierNumber: 'L10190',
            itemNumber: 'A20876'
    });

Dokument einbetten

Benutzen Sie hierfür die Funktion oxomi.embedCatalog. Diese Funktion ermöglicht es, ein bestimmtes Dokument direkt in eine Webseite einzubetten.

Parameter Beschreibung
target

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

catalog

Gibt die ID oder den Code des Dokuments an, welches eingebettet werden soll. Existieren mehrere Kataloge mit dem gegebenen Code, wird das aktuellste verwendet.

own

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

Beispiel:

oxomi.embedCatalog({
    catalog: '9000179',
    target: '#my-catalog'
});

Dokument einbetten mit Download-Button

Die Funktion oxomi.embedCatalogWithDownload erweitert die direkte Einbettung eines Dokuments um die Buttons "Download" und "Blätteransicht".

Mit Klick auf den Button "Download" kann das Dokument direkt heruntergeladen werden. Mit Klick auf den Button "Blätteransicht" öffnet sich wie gewöhnlich das Dokument im entsprechenden Portalfenster.

Beispiel:

oxomi.embedCatalogWithDownload({
    catalog: '9000179',
    target: '#my-catalog'
});

Dokument öffnen

Benutzen Sie hierfür die Funktion oxomi.openCatalog. Diese Funktion öffnet das angegebene Dokument in einem Overlay.

Hinweis: Derzeit werden Dokumente standardmäßig im Flash-Viewer geöffnet. Ist kein Flash vorhanden, wird der neue HTML5-Viewer zum Öffnen genutzt.

Setzen Sie in oxomi.init den Parameter forceHTML5 auf true, um immer den HTML5-Viewer zu nutzen.

Setzen Sie in oxomi.init den Parameter forceFlash auf true, um immer den Flash-Viewer zu nutzen, auch wenn der OXOMI-Standard geändert wird.

Parameter Beschreibung
catalog

Gibt die ID oder den Code des Dokuments an, welches geöffnet werden soll. Existieren mehrere Kataloge mit dem gegebenen Code, wird das aktuellste verwendet.

page

Legt die Seite fest, die beim Start geöffnet werden soll.

query

Markiert den hier übergebenen Wert auf den Dokumentseiten.

singlePage

Belegen Sie diesen Parameter mit true, wenn der Katalog in einer Einzelseiten Ansicht geöffnet werden soll.

Beispiel:

oxomi.openCatalog({ catalog: '9000179' });

Dokument downloaden

Benutzen Sie hierfür die Funktion oxomi.downloadCatalog. Diese Funktion fragt das angegebene Dokument zum Download an.

Parameter Beschreibung
catalog

Gibt die ID oder den Code des Dokuments an, welches heruntergeladen werden soll. Existieren mehrere Kataloge mit dem gegebenen Code, wird das aktuellste verwendet.

page

Hier kann eine Seitennummer angegeben werden, falls eine einzelne Seite heruntergeladen werden soll.

Beispiel:

oxomi.downloadCatalog({ catalog: '9000179' });