2. Knowledge Base
  3. Integrationshandbuch
  4. Inhalte
  5. Dokumente

Dokumente

Inhalte INT79
Zurück
Dokumente anzeigen

Die Integration oxomi.documents rendert eine Liste von Dokumenten in den angegebenen DOM-Container. Dabei wird das Cover-Bild des Dokuments sowie dessen Name angezeigt. Die Integration bietet verschiedene Filter-, Sortier- und Gruppiermöglichkeiten, mit denen Sie die Ergebnisse einschränken und anpassen können. Darüber hinaus können weitere Aktionsmöglichkeiten und ein Gruppenfilter angezeigt werden.

Die gerenderte Liste von Dokumenten enthält bis zu 50 Einträge. Falls mehr Dokumente gefunden wurden, so wird eine Karte mit dem Label „Weitere anzeigen“ dargestellt. Durch einen Klick auf diese Karte werden jedes Mal bis zu 15 weitere Dokumente nachgeladen.

Die oxomi.documents Integration bietet zudem verschiedene CSS -cust Klassen an um das Aussehen oder den Funktionsumfang der Integration zu beeinflussen. Weitere Informationen hierzu finden Sie im Artikel Individuelle CSS Regeln.

Der Aufruf der Integration liefert ein Promise zurück, welches Ihnen die Möglichkeit gibt, entsprechend auf den Abschluss des Aufrufs zu reagieren. Hierfür können Sie die then und catch Methoden des Promise Objekts verwenden. Der nachfolgende JavaScript-Code zeigt ein Beispiel, wie Sie auf den Abschluss des Aufrufs reagieren können. 

oxomi.documents({
    target: "#output",
    showActions: true,
    showGroupFilter: true,
    groupBy: "brand",
    supplierNumbers: "L10190"
}).then((result) => {
    console.log("success");
}).catch((error) => {
    console.log("failed");
});

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 gerenderte Liste von Dokumenten eingefügt wird.

Hinweis:

  • Wird der Parameter nicht angegeben, so wird #oxomi-documents als Default-Wert verwendet.
supplierNumbers string

Gibt die Lieferantennummern der Partner an, auf welche die Ergebnisse eingeschränkt werden sollen.

Hinweis:

  • Sie können Ihre eigenen Lieferantennummern verwenden, wenn Sie diese in der Partnerschaft zum Lieferanten gepflegt haben (siehe: Lieferantennummern).
  • Die Angabe von mehreren Werten erfolgt durch die Verwendung von , (Komma) oder | (Pipe) als Trennzeichen. Es dürfen keine Leerzeichen enthalten sein.
excludedSupplierNumbers string

Gibt die Lieferantennummern der Partner an, deren Inhalte von den Ergebnissen ausgeschlossen werden sollen.

Hinweis:

  • Sie können Ihre eigenen Lieferantennummern verwenden, wenn Sie diese in der Partnerschaft zum Lieferanten gepflegt haben (siehe: Lieferantennummern).
  • Die Angabe von mehreren Werten erfolgt durch die Verwendung von , (Komma) oder | (Pipe) als Trennzeichen. Es dürfen keine Leerzeichen enthalten sein.
brandIds string

Gibt die IDs der Marken an, auf welche die Ergebnisse eingeschränkt werden sollen.

Hinweis:

  • Die Angabe von mehreren Werten erfolgt durch die Verwendung von , (Komma) oder | (Pipe) als Trennzeichen. Es dürfen keine Leerzeichen enthalten sein.
  • Die ID kann in der Detailansicht gefunden werden. Hierzu muss unten rechts auf das Info-Icon geklickt werden. Anschließend kann die ID (Entity-ID) mit einem Klick auf das Kopieren-Icon kopiert werden.
  • Die ID der Marke eines Inhalts kann in der jeweiligen Detailansicht innerhalb der Portalinhalte eingesehen werden.
brands string

Gibt die Namen der Marken an, auf welche die Ergebnisse eingeschränkt werden sollen.

Hinweis:

  • Dieser Parameter sollte nach Möglichkeit nicht verwendet werden, da der Name einer Marke nicht eindeutig ist und geändert werden kann. Verwenden Sie stattdessen den Parameter brandIds.
  • Die Angabe von mehreren Werten erfolgt durch die Verwendung von , (Komma) oder | (Pipe) als Trennzeichen. Es dürfen keine Leerzeichen enthalten sein.
  • Die Groß- und Kleinschreibung wird bei der Angabe der Werte berücksichtigt.
seriesIds string

Gibt die IDs der Serien an, auf welche die Ergebnisse eingeschränkt werden sollen.

Hinweis:

  • Die Angabe von mehreren Werten erfolgt durch die Verwendung von , (Komma) oder | (Pipe) als Trennzeichen. Es dürfen keine Leerzeichen enthalten sein.
  • Die ID kann in der Detailansicht gefunden werden. Hierzu muss unten rechts auf das Info-Icon geklickt werden. Anschließend kann die ID (Entity-ID) mit einem Klick auf das Kopieren-Icon kopiert werden.
  • Die ID der Serie eines Inhalts kann in der jeweiligen Detailansicht innerhalb der Portalinhalte eingesehen werden.
tags string

Gibt die Tags an, auf welche die Ergebnisse eingeschränkt werden sollen.

Hinweis:

  • Die Angabe von mehreren Werten erfolgt durch die Verwendung von , (Komma) oder | (Pipe) als Trennzeichen. Es dürfen keine Leerzeichen enthalten sein.
  • Die Groß- und Kleinschreibung wird bei der Angabe der Werte berücksichtigt.
categoryIds string

Gibt die IDs der Kategorien an, auf welche die Ergebnisse eingeschränkt werden sollen.

Hinweis:

  • Die Angabe von mehreren Werten erfolgt durch die Verwendung von , (Komma) oder | (Pipe) als Trennzeichen. Es dürfen keine Leerzeichen enthalten sein.
  • Die ID kann in der Detailansicht gefunden werden. Hierzu muss unten rechts auf das Info-Icon geklickt werden. Anschließend kann die ID (Entity-ID) mit einem Klick auf das Kopieren-Icon kopiert werden.
  • Die ID der Kategorie eines Inhalts kann in der jeweiligen Detailansicht innerhalb der Portalinhalte eingesehen werden.
categories string

Gibt die Namen der Kategorien an, auf welche die Ergebnisse eingeschränkt werden sollen.

Hinweis:

  • Dieser Parameter sollte nach Möglichkeit nicht verwendet werden, da der Name einer Kategorie nicht eindeutig ist und geändert werden kann. Verwenden Sie stattdessen den Parameter categoryIds.
  • Die Angabe von mehreren Werten erfolgt durch die Verwendung von , (Komma) oder | (Pipe) als Trennzeichen. Es dürfen keine Leerzeichen enthalten sein.
  • Die Groß- und Kleinschreibung wird bei der Angabe der Werte berücksichtigt.
types string

Gibt die Dokument-Typen an, auf welche die Ergebnisse eingeschränkt werden sollen. Die verfügbaren Werte können hier eingesehen werden: Dokumenttypen

Hinweis:

  • Die Angabe von mehreren Werten erfolgt durch die Verwendung von , (Komma) oder | (Pipe) als Trennzeichen. Es dürfen keine Leerzeichen enthalten sein.
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:

  • Dieser Parameter steht nur für PRO Portale zur Verfügung. Zu den Preisen & Bestellmöglichkeiten
  • Die Angabe von mehreren Werten erfolgt durch die Verwendung von , (Komma) oder | (Pipe) als Trennzeichen. Es dürfen keine Leerzeichen enthalten sein.
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:

  • Dieser Parameter steht nur für PRO Portale zur Verfügung. Zu den Preisen & Bestellmöglichkeiten
  • Die Angabe von mehreren Werten erfolgt durch die Verwendung von , (Komma) oder | (Pipe) als Trennzeichen. Es dürfen keine Leerzeichen enthalten sein.
own boolean

Gibt an, ob nur eigene Dokumente oder nur Dokumente von anderen Anbietern angezeigt werden sollen.

Hinweis:

  • Dieser Parameter bezieht sich dabei ausschließlich auf die eigene Standardmarke.
  • Wird dieser Parameter auf true gesetzt, so werden ausschließlich eigene Dokumente angezeigt.
  • Wird dieser Parameter auf false gesetzt, so werden ausschließlich Dokumente von anderen Anbietern angezeigt.
  • Wird dieser Parameter nicht angegeben, so werden sowohl eigene als auch Dokumente von anderen Anbietern angezeigt, sofern diese über eine Partnerschaft verfügbar sind.
includeOutdated boolean

Gibt an, ob auch archivierte Dokumente in den Ergebnissen angezeigt werden sollen.

Hinweis:

  • Wird dieser Parameter auf true gesetzt, so werden auch archivierte Dokumente angezeigt.
  • Wird dieser Parameter auf false gesetzt, so werden ausschließlich aktuelle Dokumente angezeigt.
  • Wird der Parameter nicht angegeben, so wird false als Default-Wert verwendet.
  • Dieser Parameter wird nur angewendet, wenn in den Portaleinstellungen im Abschnitt „Standard“ die Option „Archiv aktivieren“ mit einem Wert größer 0 eingestellt ist.
onlyOutdated boolean

Gibt an, ob ausschließlich archivierte Dokumente in den Ergebnissen angezeigt werden sollen.

Hinweis:

  • Wird dieser Parameter auf true gesetzt, so werden ausschließlich archivierte Dokumente in den Ergebnissen angezeigt.
  • Sollte der Parameter auf true gesetzt sein, hat er Vorrang vor dem Parameter includeOutdated. Bei Einstellung auf false verhält sich der Parameter so, als wäre er nicht angegeben worden.
  • Wird der Parameter nicht angegeben, so wird false als Default-Wert verwendet.
  • Dieser Parameter wird nur angewendet, wenn in den Portaleinstellungen im Abschnitt „Standard“ die Option „Archiv aktivieren“ mit einem Wert größer 0 eingestellt ist.
singlePage boolean

Gibt an, ob das Dokument im Einzelseiten- oder Doppelseiten-Modus geöffnet werden soll.

Hinweis:

  • Wird dieser Parameter auf true gesetzt, so wird das Dokument im Einzelseiten-Modus geöffnet.
  • Wird dieser Parameter auf false gesetzt, so wird das Dokument im Doppelseiten-Modus geöffnet.
  • Wird dieser Parameter nicht angegeben, so wird automatisch ein Modus gewählt. Die Wahl des Modus hängt dabei von der Anzahl der Seiten des Dokuments, dem Seitenverhältnis und der Platform ab.
showActions boolean

Gibt an, ob zusätzliche Aktionen für die 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:

Aktion Beschreibung
Anschauen Öffnet den WebViewer so, als wäre das Cover-Bild des Dokuments angeklickt worden.
Downloaden Startet den Download des Dokuments. Voraussetzung für die Anzeige Download-Button ist, dass in Ihrer Portalkonfiguration unter „Sicherheit“ die Option „PDF-Download zulassen“ aktiv gesetzt ist
Bestellen Löst die Bestellaktion für das Dokument aus, sofern eine JavaScript-Funktion mit dem Parameter orderHandler hinterlegt wurde.

Hinweis:

  • Wird der Parameter nicht angegeben, so wird false als Default-Wert verwendet.
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:

Name Beschreibung
id Die technische OXOMI-ID des Dokuments.
code Der optional am Dokument hinterlegte Inhalts-Code.
name Der Name des Dokuments.
state Der aktuelle Status des Dokuments. Kann den Wert OK (aktuell gültig) oder ARCHIVED (archiviert) annehmen.
language Die Sprache des Dokuments als 2-buchstabiger ISO-Code .

Hinweis:

  • Dieser Parameter wird nur berücksichtigt, wenn der Parameter showActions auf true gesetzt wurde.
Interaktives Code-Beispiel
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:

  • Wird der Parameter nicht angegeben, so wird false als Default-Wert verwendet.
  • Kann zusammen mit dem Parameter additionalLanguages verwendet werden um die Sprachen und die Anzeigereihenfolge der Versionen zu beeinflussen.
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:

  • Dieser Parameter beeinflusst außerdem die Anzeige-Reihenfolge der Sprachversionen. Die Sprachversionen werden in der Reihenfolge angezeigt, wie sie in diesem Parameter angegeben werden.
  • Dieser Parameter wird nur berücksichtigt, wenn der Parameter showAdditionalLanguages auf true gesetzt wurde.
  • Die Angabe von mehreren Werten erfolgt durch die Verwendung von , (Komma) oder | (Pipe) als Trennzeichen. Es dürfen keine Leerzeichen enthalten sein.
sortBy string

Gibt die Sortierung der Ergebnisse vor. 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 Dokumentnamen 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.

Hinweis:

  • Wird der Parameter nicht angegeben, so wird priority als Default-Wert verwendet.
showGroupFilter boolean

Gibt an, ob ein Gruppenfilter angezeigt werden soll. Wird dieser Parameter auf true gesetzt, werden über dem Ergebnis Schaltflächen zur Filterung durch den Nutzer auf einzelne Gruppen angezeigt.

Hinweis:

  • Wird der Parameter nicht angegeben, so wird false als Default-Wert verwendet.
  • Der Gruppenfilter wird nur angezeigt, wenn der Parameter groupBy mit einem gültigen Wert angegeben wurde.
groupBy string

Gibt an ob und wie das Ergebnis gruppiert werden soll. Die nachfolgenden Werte stehen hier zur Verfügung:

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

Hinweis:

  • Wenn der Parameter angegeben wird, so verändert sich die Struktur der gerenderten Ansicht. Die Dokumente werden dann in Gruppen angezeigt, welche durch eine Überschrift gekennzeichnet sind.
  • In jeder Gruppe werden dann maximal 15 Dokumente angezeigt. Falls mehr Dokumente in einer Gruppe vorhanden sind, so wird eine Karte mit dem Label „Weitere Dokumente“ angezeigt. Durch einen Klick auf diese Karte werden jedes Mal bis zu 15 weitere Dokumente nachgeladen.
  • Dokumente die nicht in eine Gruppe eingeordnet werden können, werden in dieser Ansicht nicht angezeigt.
limit integer

Gibt die maximale Anzahl an Dokumente an, welche initial angezeigt werden sollen.

Hinweis:

  • Der maximal zulässige Wert für den Parameter beträgt 50.
  • Sind mehr Dokumente vorhanden, so ist es über eine entsprechend angezeigte Kachel möglich, weitere Dokumente nachzuladen.
  • Wird dieser Parameter nicht angegeben, so werden bei gruppierter Ansicht (siehe groupBy) bis zu 15 Dokumente pro Gruppe angezeigt. Andernfalls werden maximal 50 Dokumente angezeigt.
Dokumente anzeigen - Showcase

Parameter

Ausführen Mit Beispieldaten ausführen
Initialisierungsparameter
(portal)
Bitte geben Sie hier den Portal-Code beziehungsweise die Portal-ID an. Hier finden Sie weitere Informationen.
(user) Bitte geben Sie hier den Benutzernamen eines Portalbenutzers ein. Diese Eingabe wird zum Pflichtfeld, falls das entsprechende Portal Login-geschützt ist. Hier finden Sie weitere Informationen.
(roles) Bitte geben Sie hier wahlweise die Portallrollen an, um den Zugriff auf die Inhalte zu steuern. Hier finden Sie weitere Informationen.
(accessToken) Für die externe Authentifizierung kann ein im integrierenden System generierter Access-Token eingesetzt werden. Benutzen Sie den Access-Token Rechner, um Ihren individuellen Access-Token zu berechnen. Diese Eingabe wird zum Pflichtfeld, falls das entsprechende Portal Login-geschützt ist. Hier finden Sie weitere Informationen.
Hauptparameter
(supplierNumbers) Gibt die Lieferantennummern der Partner an, auf welche die Ergebnisse eingeschränkt werden sollen.
(excludedSupplierNumbers) Gibt die Lieferantennummern der Partner an, dessen Inhalte von den Ergebnissen ausgeschlossen werden sollen.
(brandIds) Gibt die IDs der Marken an, auf welche die Ergebnisse eingeschränkt werden sollen.
(seriesIds) Gibt die IDs der Serien an, auf welche die Ergebnisse eingeschränkt werden sollen.
(categoryIds) Gibt die IDs der Kategorien an, auf welche die Ergebnisse eingeschränkt werden sollen.
(tags) Gibt die Tags an, auf welche die Ergebnisse eingeschränkt werden sollen.
(types)
Gibt die Dokument-Typen an, auf welche die Ergebnisse eingeschränkt werden sollen. Die verfügbaren Werte können hier eingesehen werden: Dokumenttypen
(groupBy)
Gibt an ob und wie das Ergebnis gruppiert werden soll.
(showGroupFilter) Gibt an, ob ein Gruppenfilter angezeigt werden soll. Wird dieser Parameter auf Ja (true) gesetzt, werden über dem Ergebnis Schaltflächen zur Filterung durch den Nutzer auf einzelne Gruppen angezeigt. Dieser Parameter wird nur angewandt, wenn der Parameter Gruppierung mit einem gültigen Wert angegeben wurde.
(showActions) Gibt an, ob zusätzliche Aktionen für die Dokumente angezeigt werden sollen. Die zusätzlichen Aktionen werden als Schaltflächen unterhalb des Dokumentnamens angezeigt. Wird dieser Parameter auf Ja (true) gesetzt, so werden die zusätzlichen Aktionen angezeigt.
(showAdditionalLanguages) 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 Ja (true) gesetzt so wird ein Button mit dem Label „Weitere Sprachversionen“ angezeigt.
(additionalLanguages)
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
(includeOutdated) Gibt an, ob auch archivierte Dokumente in den Ergebnissen angezeigt werden sollen. Dieser Parameter wird nur angewandt, wenn der Parameter Nur archivierte Dokumente anzeigen mit einem anderen Wert als Ja (true) angegeben wurde.
(onlyOutdated) Gibt an, ob ausschließlich archivierte Dokumente in den Ergebnissen angezeigt werden sollen. Wenn dieser Parameter auf Ja (true) gesetzt wird, werden nur archivierte Dokumente in den Ergebnissen angezeigt. Außerdem hat der Parameter dann Vorrang vor dem Parameter Archivierte Dokumente anzeigen.
(own)
Gibt an, ob nur eigene Dokumente oder nur Dokumente von anderen Anbietern angezeigt werden sollen.
(singlePage) Gibt an, ob der WebViewer im Einzel- oder Doppelseitenmodus geöffnet werden soll. Wird dieser Parameter auf Einzelseite (true) gesetzt, so wird der WebViewer im Einzelseitenmodus geöffnet. BeiDoppelseite (false) wird der WebViewer im Doppelseitenmodus geöffnet.
(filterLanguages)
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
(filterCountries)
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
(limit) Gibt die maximale Anzahl an Dokumente an, welche initial angezeigt werden sollen.
Mit Beispieldaten ausführen Ausführen

Ausgabebereich

Dokument einbetten

Die Integration oxomi.embedDocument rendert entweder das Cover-Bild eines einzelnen angegebenen Dokuments (sowie dessen Name und weiterer Aktionen) oder das Dokument im Viewer geöffnet in den angegebenen DOM-Container.

Die Integration bietet zudem verschiedene CSS -cust Klassen an um das Aussehen oder den Funktionsumfang der Integration zu beeinflussen. Weitere Informationen hierzu finden Sie im Artikel Individuelle CSS Regeln.

Der Aufruf der Integration liefert ein Promise zurück, welches Ihnen die Möglichkeit gibt, entsprechend auf den Abschluss des Aufrufs zu reagieren. Hierfür können Sie die then und catch Methoden des Promise Objekts verwenden. Der nachfolgende JavaScript-Code zeigt ein Beispiel, wie Sie auf den Abschluss des Aufrufs reagieren können. 

oxomi.embedDocument({
    target: "#output",
    document: "90000053",
    singlePage: false,
    showActions: true,
    showAdditionalLanguages: true,
    additionalLanguages: "en"
}).then((result) => {
    console.log("success");
}).catch((error) => {
    console.log("failed");
});

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
document string

Gibt die ID oder den Code des Dokuments an.

Hinweis:

  • Wird ein Code angegeben, für den mehrere Dokumente existieren, so wird das aktuellste verwendet.
  • Die ID kann in der Detailansicht gefunden werden. Hierzu muss unten rechts auf das Info-Icon geklickt werden. Anschließend kann die ID (Entity-ID) mit einem Klick auf das Kopieren-Icon kopiert werden.
pageNumber string

Legt die Seite des Dokuments fest, die beim Öffnen des Dokuments angezeigt werden soll.

Hinweis:

  • Es handelt sich hierbei um die technische Seitenzahl des Dokuments ohne Berücksichtigung von Seitenversatz und -zuordnungen.
target string

Gibt das Ziel-Element an, in welches das gerenderte Dokument eingefügt wird.

Hinweis:

  • Wird der Parameter nicht angegeben, so wird #oxomi-document als Default-Wert verwendet.
singlePage boolean

Gibt an, ob das Dokument im Einzelseiten- oder Doppelseiten-Modus geöffnet werden soll.

Hinweis:

  • Wird dieser Parameter auf true gesetzt, so wird das Dokument im Einzelseiten-Modus geöffnet.
  • Wird dieser Parameter auf false gesetzt, so wird das Dokument im Doppelseiten-Modus geöffnet.
  • Wird dieser Parameter nicht angegeben, so wird automatisch ein Modus gewählt. Die Wahl des Modus hängt dabei von der Anzahl der Seiten des Dokuments, dem Seitenverhältnis und der Platform ab.
showActions boolean

Gibt an, ob zusätzliche Aktionen für das Dokument 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:

Aktion Beschreibung
Anschauen Öffnet den WebViewer so, als wäre das Cover-Bild des Dokuments angeklickt worden.
Downloaden Startet den Download des Dokuments. Voraussetzung für die Anzeige Download-Button ist, dass in Ihrer Portalkonfiguration unter „Sicherheit“ die Option „PDF-Download zulassen“ aktiv gesetzt ist
Bestellen Löst die Bestellaktion für das Dokument aus, sofern eine JavaScript-Funktion mit dem Parameter orderHandler hinterlegt wurde.

Hinweis:

  • Wird der Parameter nicht angegeben, so wird false als Default-Wert verwendet.
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:

Name Beschreibung
id Die technische OXOMI-ID des Dokuments.
code Der optional am Dokument hinterlegte Inhalts-Code.
name Der Name des Dokuments.
state Der aktuelle Status des Dokuments. Kann den Wert OK (aktuell gültig) oder ARCHIVED (archiviert) annehmen.
language Die Sprache des Dokuments als 2-buchstabiger ISO-Code .

Hinweis:

  • Dieser Parameter wird nur berücksichtigt, wenn der Parameter showActions auf true gesetzt wurde.
Interaktives Code-Beispiel
directDownload boolean

Gibt an, ob das Dokument heruntergeladen werden soll, wenn auf das Cover-Bild geklickt wird.

Hinweis:

  • Wird der Parameter nicht angegeben, so wird false als Default-Wert verwendet.
  • Wird dieser Parameter auf true gesetzt, so wird das Dokument direkt heruntergeladen, wenn auf das Cover-Bild geklickt wird.
  • Wird dieser Parameter auf false gesetzt oder nicht angegeben, so wird das Standardverhalten der Integration verwendet.
inline boolean

Gibt an, ob das Dokument im Ziel-Element mit geöffnetem Viewer direkt eingebettet werden soll.

Hinweis:

  • Wird der Parameter nicht angegeben, so wird false als Default-Wert verwendet.
  • Wird dieser Parameter auf true gesetzt, so wird das Dokument direkt im Ziel-Element eingebettet. Dies ändert das Standardverhalten der Integration! Zusätzliche Aktionen werden dann nicht angezeigt.
  • Wird dieser Parameter auf false gesetzt oder nicht angegeben, so wird das Standardverhalten der Integration verwendet.
  • Das Ziel-Element wird mit dem Parameter target angegeben.
  • Aktuell kann auf diese Weise nur ein Dokument pro Seite eingebettet werden.
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:

  • Wird der Parameter nicht angegeben, so wird false als Default-Wert verwendet.
  • Kann zusammen mit dem Parameter additionalLanguages verwendet werden um die Sprachen und die Anzeigereihenfolge der Versionen zu beeinflussen.
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:

  • Dieser Parameter beeinflusst außerdem die Anzeige-Reihenfolge der Sprachversionen. Die Sprachversionen werden in der Reihenfolge angezeigt, wie sie in diesem Parameter angegeben werden.
  • Dieser Parameter wird nur berücksichtigt, wenn der Parameter showAdditionalLanguages auf true gesetzt wurde.
  • Die Angabe von mehreren Werten erfolgt durch die Verwendung von , (Komma) oder | (Pipe) als Trennzeichen. Es dürfen keine Leerzeichen enthalten sein.
Dokument einbetten - Showcase

Parameter

Ausführen Mit Beispieldaten ausführen
Initialisierungsparameter
(portal)
Bitte geben Sie hier den Portal-Code beziehungsweise die Portal-ID an. Hier finden Sie weitere Informationen.
(user) Bitte geben Sie hier den Benutzernamen eines Portalbenutzers ein. Diese Eingabe wird zum Pflichtfeld, falls das entsprechende Portal Login-geschützt ist. Hier finden Sie weitere Informationen.
(roles) Bitte geben Sie hier wahlweise die Portallrollen an, um den Zugriff auf die Inhalte zu steuern. Hier finden Sie weitere Informationen.
(accessToken) Für die externe Authentifizierung kann ein im integrierenden System generierter Access-Token eingesetzt werden. Benutzen Sie den Access-Token Rechner, um Ihren individuellen Access-Token zu berechnen. Diese Eingabe wird zum Pflichtfeld, falls das entsprechende Portal Login-geschützt ist. Hier finden Sie weitere Informationen.
Hauptparameter
(document) Geben Sie hier entweder ID (aus der URL der Detailseite) oder Code eines Dokuments an. Codes werden von Nachfolgedokumenten übernommen, IDs sind einzigartig.
(pageNumber) Legt die Seite des Dokuments fest, die beim Öffnen des Dokuments angezeigt werden soll.
(singlePage) Gibt an, ob der WebViewer im Einzel- oder Doppelseitenmodus geöffnet werden soll. Wird dieser Parameter auf Einzelseite (true) gesetzt, so wird der WebViewer im Einzelseitenmodus geöffnet. BeiDoppelseite (false) wird der WebViewer im Doppelseitenmodus geöffnet.
(showActions) Gibt an, ob zusätzliche Aktionen für das Dokument angezeigt werden sollen. Die zusätzlichen Aktionen werden als Schaltflächen unterhalb des Dokumentnamens angezeigt. Wird dieser Parameter auf Ja (true) gesetzt, so werden die zusätzlichen Aktionen angezeigt.
(inline) Gibt an, ob das Dokument im Ziel-Element mit geöffnetem Viewer direkt eingebettet werden soll.
(showAdditionalLanguages) 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 Ja (true) gesetzt so wird ein Button mit dem Label „Weitere Sprachversionen“ angezeigt.
(additionalLanguages)
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
Mit Beispieldaten ausführen Ausführen

Ausgabebereich

Dokument öffnen

Mit der Integration oxomi.openDocument kann ein Dokument in einem Overlay geöffnet werden. So können Sie beispielsweise ein Dokument aus einer Dokumentenliste oder aus einem anderen Kontext heraus anzeigen. Dabei können Sie verschiedene Parameter übergeben, um beispielsweise eine bestimmte Seite des Dokuments zu öffnen oder eine Suche zu starten.

Der Aufruf der Integration liefert ein Promise zurück, welches Ihnen die Möglichkeit gibt, entsprechend auf den Abschluss des Aufrufs zu reagieren. Hierfür können Sie die then und catch Methoden des Promise Objekts verwenden. Der nachfolgende JavaScript-Code zeigt ein Beispiel, wie Sie auf den Abschluss des Aufrufs reagieren können. 

oxomi.openDocument({
    document: "90000161",
    pageNumber: "4",
    query: "Schrauben"
}).then((result) => {
    console.log("success");
}).catch((error) => {
    console.log("failed");
});

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
document string

Gibt die ID oder den Code des Dokuments an.

Hinweis:

  • Wird ein Code angegeben, für den mehrere Dokumente existieren, so wird das aktuellste verwendet.
  • Die ID kann in der Detailansicht gefunden werden. Hierzu muss unten rechts auf das Info-Icon geklickt werden. Anschließend kann die ID (Entity-ID) mit einem Klick auf das Kopieren-Icon kopiert werden.
pageNumber string

Legt die Seite des Dokuments fest, die beim Öffnen des Dokuments angezeigt werden soll.

Hinweis:

  • Es handelt sich hierbei um die technische Seitenzahl des Dokuments ohne Berücksichtigung von Seitenversatz und -zuordnungen.
query string

Markiert den hier übergebenen Wert auf den Dokumentseiten.

singlePage boolean

Gibt an, ob das Dokument im Einzelseiten- oder Doppelseiten-Modus geöffnet werden soll.

Hinweis:

  • Wird dieser Parameter auf true gesetzt, so wird das Dokument im Einzelseiten-Modus geöffnet.
  • Wird dieser Parameter auf false gesetzt, so wird das Dokument im Doppelseiten-Modus geöffnet.
  • Wird dieser Parameter nicht angegeben, so wird automatisch ein Modus gewählt. Die Wahl des Modus hängt dabei von der Anzahl der Seiten des Dokuments, dem Seitenverhältnis und der Platform ab.
externalLinksEnabled boolean

Gibt an, ob externe Links im Overlay geöffnet werden sollen. Ein externer Link ist ein im Dokument enthaltener Link, der nicht auf eine Seite des Dokuments verweist, sondern auf eine externe Seite.

Hinweis:

  • Wird der Parameter nicht angegeben, so wird true als Default-Wert verwendet.
  • Wird dieser Parameter auf true gesetzt, so werden externe Links geöffnet.
  • Wird dieser Parameter auf false gesetzt, so werden externe Links ignoriert.
Interaktives Code-Beispiel
Dokument öffnen - Showcase

Parameter

Ausführen Mit Beispieldaten ausführen
Initialisierungsparameter
(portal)
Bitte geben Sie hier den Portal-Code beziehungsweise die Portal-ID an. Hier finden Sie weitere Informationen.
(user) Bitte geben Sie hier den Benutzernamen eines Portalbenutzers ein. Diese Eingabe wird zum Pflichtfeld, falls das entsprechende Portal Login-geschützt ist. Hier finden Sie weitere Informationen.
(roles) Bitte geben Sie hier wahlweise die Portallrollen an, um den Zugriff auf die Inhalte zu steuern. Hier finden Sie weitere Informationen.
(accessToken) Für die externe Authentifizierung kann ein im integrierenden System generierter Access-Token eingesetzt werden. Benutzen Sie den Access-Token Rechner, um Ihren individuellen Access-Token zu berechnen. Diese Eingabe wird zum Pflichtfeld, falls das entsprechende Portal Login-geschützt ist. Hier finden Sie weitere Informationen.
Hauptparameter
(document) Geben Sie hier entweder ID (aus der URL der Detailseite) oder Code eines Dokuments an. Codes werden von Nachfolgedokumenten übernommen, IDs sind einzigartig.
(pageNumber) Legt die Seite des Dokuments fest, die beim Öffnen des Dokuments angezeigt werden soll.
(singlePage) Gibt an, ob der WebViewer im Einzel- oder Doppelseitenmodus geöffnet werden soll. Wird dieser Parameter auf Einzelseite (true) gesetzt, so wird der WebViewer im Einzelseitenmodus geöffnet. BeiDoppelseite (false) wird der WebViewer im Doppelseitenmodus geöffnet.
(query) Markiert den hier übergebenen Wert auf den Dokumentseiten.
Mit Beispieldaten ausführen Ausführen

Ausgabebereich

Dokument downloaden

Die Integration oxomi.downloadDocument ermöglicht es, ein Dokument oder eine einzelne Seite zum Download anzufordern. Dies ist beispielsweise nützlich, wenn Sie einen Download-Button auf Ihrer Seite anbieten wollen.

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
document string

Gibt die ID oder den Code des Dokuments an.

Hinweis:

  • Wird ein Code angegeben, für den mehrere Dokumente existieren, so wird das aktuellste verwendet.
  • Die ID kann in der Detailansicht gefunden werden. Hierzu muss unten rechts auf das Info-Icon geklickt werden. Anschließend kann die ID (Entity-ID) mit einem Klick auf das Kopieren-Icon kopiert werden.
pageNumber string

Legt die Seite des Dokuments fest, die heruntergeladen werden soll.

Hinweis:

  • Es handelt sich hierbei um die technische Seitenzahl des Dokuments ohne Berücksichtigung von Seitenversatz und -zuordnungen.
Beispiel:
oxomi.downloadDocument({ document: "9000179" });
Interaktives Code-Beispiel
Dokument downloaden - Showcase

Parameter

Ausführen Mit Beispieldaten ausführen
Initialisierungsparameter
(portal)
Bitte geben Sie hier den Portal-Code beziehungsweise die Portal-ID an. Hier finden Sie weitere Informationen.
(user) Bitte geben Sie hier den Benutzernamen eines Portalbenutzers ein. Diese Eingabe wird zum Pflichtfeld, falls das entsprechende Portal Login-geschützt ist. Hier finden Sie weitere Informationen.
(roles) Bitte geben Sie hier wahlweise die Portallrollen an, um den Zugriff auf die Inhalte zu steuern. Hier finden Sie weitere Informationen.
(accessToken) Für die externe Authentifizierung kann ein im integrierenden System generierter Access-Token eingesetzt werden. Benutzen Sie den Access-Token Rechner, um Ihren individuellen Access-Token zu berechnen. Diese Eingabe wird zum Pflichtfeld, falls das entsprechende Portal Login-geschützt ist. Hier finden Sie weitere Informationen.
Hauptparameter
(document) Geben Sie hier entweder ID (aus der URL der Detailseite) oder Code eines Dokuments an. Codes werden von Nachfolgedokumenten übernommen, IDs sind einzigartig.
(pageNumber) Legt die Seite des Dokuments fest, die heruntergeladen werden soll.
Mit Beispieldaten ausführen Ausführen

Ausgabebereich

Paperclip-Dialog vorbefüllen

Um die Felder des Paperclip-Dialogs vorzubelegen, kann die BUZZ Capability fetchPaperclipData genutzt werden. Die so vorbefüllten Daten können im weiteren Verlauf vom Kunde noch bearbeitet werden.

Ergänzend können auch die Kontaktdaten des Benutzers vorbefüllt werden, falls diese nicht durch einen Portalbenutzer hinterlegt wurden. Weitere Informationen dazu finden Sie unter: Nutzerdaten anreichern

Als Ergebnis wird ein Objekt mit den folgenden Feldern erwartet. Es müssen hierbei nicht alle Felder angegeben werden.

Parameter Parametertyp Beschreibung
customer.name string Vollständiger Name des Kunden
customer.email string Email-Adresse des Kunden
customer.number string Kundennummer
customer.street string Straße und Hausnummer der Kundenadresse
customer.zip string Postleitzahl der Kundenadresse
customer.city string Stadt, in der der Kunde ansässig ist
message.subject string Betreff der Anfrage
message.body string Nachrichtentext der Anfrage
message.createCover boolean

Legt fest, ob der Paperclip ein Deckblatt enthalten soll.

message.createToc boolean

Legt fest, ob der Paperclip ein Inhaltsverzeichnis enthalten soll.

Hinweis:

  • Wird nur berücksichtigt, wenn message.createCover auf true gesetzt ist.

Beispiel:

shop.addCapability('fetchPaperclipData', function (message) {
    const paperclipCustomer = {
        name: 'Max Mustermann',
        email: 'max@musterfirma.de',
        number: '123-MUSTER'
    };

    const paperclipMessage = {
        subject: 'Beispielanfrage',
        body: 'Sehr geehrte Damen und Herren,\n\nich habe folgende Anfrage:\n\n...',
        createCover: false,
        createToc: false,
    };

    message.reply({
        customer: paperclipCustomer,
        message: paperclipMessage
    });
});

Interaktives Code-Beispiel

Siehe auch
Enthält die Grundlagen zum Thema Javascript Integration.
Enthält Informationen über die BUZZ Schnittstelle.
Beschreibt, wie die Anreicherung von Produktdaten mittels Infoplay funktioniert.