Versions Compared

Version Old Version 2 New Version Current
Changes made by

Florian Pieper

Anna Janzen

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Expand
titleChangelog

  • 30.09.2022 → Eingangsparameter “downloadinnewtabtarget“ hinzugefügt

  • 26.09.2022: Widget-Dokumentation angelegt

...

...

Beschreibung

Auf dieser Seite finden Sie die technische Beschreibung zur Integration des PDF-Viewers. Mit dem PDF Viewer können PDF-Dokumente gesichtet werden. Innerhalb des PDF-Viewers können viele Zusatzfunktionen wie ein Downloadbutton, ein Warenkorb, eine Suche etc. nutzen und ergänzen. Im Folgenden finden Sie den Überblick über den Inhalt dieser Seite:

...

Inhalt

Table of Contents
minLevel1
maxLevel6
outlinefalse
styledefault
typelist
printabletrue

Parameter “xs-pdf-viewer”

...

Eingang

Parameter

Pflicht

Beschriebung

Beispielwert

linkID

Ja

Externe Link-ID des Uploads, der im Viewer geöffnet werden soll. Die ID kann im Infopaket-Upload am Upload erzeugt werden.

b8fd8f7c-d815-41a3-b36b-d7120821d1d1

download

Nein

Aktiviert die Downloadfunktion der PDF-Dokumente für diesen Kanal. Wenn deaktiviert, wird der Downloadbutton nicht angezeigt.

true

shopcart

Nein

Aktiviert das Warenkorbevent, dass das einbindende System zum Öffnen des Warenkorboverlays verwenden kann. Wenn deaktiviert, wird der Warenkorbbutton im PDF-Viewer nicht angezeigt.

true

shopsearch

Nein

Aktiviert das Suchevent, dass das einbindende System zur weiteren Suche verwenden kann. Wenn deaktiviert, wird der Suchbutton für den Shop nicht angezeigt.

true

externalsearch

Nein

true

donwloadinnewtab

Nein

Wird der Parameter auf true gesetzt, so öffnet sich beim klick auf den Downloadbutton ein neuer Tab und die Datei wird heruntergeladen

true

downloadinnewtabtarget

Nein

In Verbindung mit “downloadinnewtab” zu verwenden. Wird nur verwendet, wenn “downloadinnewtab” auf true gesetzt ist

Gibt das Ziel an, das die Download-URL öffnen soll

Im Standard oder wenn kein Wert gesetzt ist, wird “_blank“ verwendet

Code Block
{
  ...
  "downloadinnewtabtarget": "_parent"
}

style

Nein

JSON-Objekt zur Definition der Primär- und Sekundär-Farbe des Widgets. Das Objekt hat zwei Felder:

  • primarycolor: Primärfarbe. Als Wert wird ein Hexadezimal-String erwartet (Beispiel: "#616161").

  • secondarycolor: Sekundärfarbe. Als Wert wird ein Hexadezimal-String erwartet (Beispiel: "#D3D3D3").

Code Block
"style":{
  "primarycolor": "#616161",
  "secondarycolor": "#D3D3D3"
}

Ausgang

status

Dieses Event wird immer beim Initialisieren ausgegeben.

  • error

  • complete

  • found

shopsearch

Dieses Event wird nur ausgegeben, wenn diese Funktion für den entsprechenden Kanal angeschaltet wurde.

Das Event beinhaltet folgende zwei Informationen.

  • searchterm

    • String / Kann leer sein

  • manufacturerid

    • String / Kann leer sein

  • callback

    • thumbnailurl: String, URL zum Thumbnail des Dokumentes. Bei Abruf muss der OAuth2 Token im Header der Anfrage mitgegeben werden.

    • uploaddescription: String, Uploadbeschreibung des Dokumentes

    • widgetstate: String, Status des Widgets für Rücksprung. Muss dem Widget beim Rücksprung in den Parametern übergeben werden um den Status wiederherzustellen.

Code Block
{
   "searchterm":"test",
   "manufacturerid":"testid"
   "callback": {
      "searchterm":"test",
      "manufacturerid":"testid",
      "thumbnailurl": "https://2.0.open-datacheck.de/webservicehub/DateiabrufOMD?type=LO&fileID=c2l0ZXMvZGVmYXVsdC9maWxlcy9pbmZvcGFja2FnZS8yLzEzMDEvMTYzNTE3MjczMi90aHVtYm5haWxzLzEwMzE5MjY0LnBkZi5qcGVn"
      "uploaddescription": "Installation 2021"
   }
}

shopcart

Dieses Event wird nur ausgegeben, wenn diese Funktion für den entsprechenden Kanal angeschaltet wurde.

  • thumbnailurl: String, URL zum Thumbnail des Dokumentes. Bei Abruf muss der OAuth2 Token im Header der Anfrage mitgegeben werden.

  • uploaddescription: String, Uploadbeschreibung des Dokumentes

  • widgetstate: String, Status des Widgets für Rücksprung. Muss dem Widget beim Rücksprung in den Parametern übergeben werden um den Status wiederherzustellen.

Code Block
{
  "searchterm":"test",
  "manufacturerid":"testid"
  "thumbnailurl": "https://2.0.open-datacheck.de/webservicehub/DateiabrufOMD?type=LO&fileID=c2l0ZXMvZGVmYXVsdC9maWxlcy9pbmZvcGFja2FnZS8yLzEzMDEvMTYzNTE3MjczMi90aHVtYm5haWxzLzEwMzE5MjY0LnBkZi5qcGVn"
  "uploaddescription": "Installation 2021""
}

shopcart

Dieses Event wird bei einem Klick auf einen externen Link in einem PDF Dokument ausgegeben.

Ausgabe des im PDF Dokument angegebene Wert für den externen Link als String

Beispielabbildung

...

Beispielparameter

Code Block
{
    "linkID" : "b8fd8f7c-d815-41a3-b36b-d7120821d1d1",
    "download" : false,
    "shopcart" : false,
    "shopsearch" : true,
    "externalsearch" : true,
    "donwloadinnewtab" : true,
    "style":{
        "primarycolor": "#616161",
        "secondarycolor": "#D3D3D3"
    }
}

...