Versions Compared

Version Old Version 7 New Version Current
Changes made by

Anna Janzen

Anna Janzen

Saved on

Key

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

...

Eingang

Parameter

Pflicht

Beschreibung

Beispielwert

manufacturerid

Ja

ID des Herstellers auf dem System

COSMO

manufacturerpid

Ja

Werksartikelnummer

test1234

manufactureridtype

Ja

Der IDTyp der bei einer Anfrage verwendet wird. Das Feld muss nur gesetzt werden, wenn die ManufacturerID von einem anderen System verwendet werden soll.

Diese Funktionalität steht nur zur Verfügung, wenn eine IDHUB Integration beauftragt wurde.

odc

types

Nein

Einschränkung der Bild & Dokumenttypen, die zur Anzeige gebracht werden sollen als “Stringarray”. Werden keine Types angegeben, werden alle referenzierten Bilder, Dokumente & Videos angezeigt.

Bildtypen

  • B_ = Fotorealistisches Produktbild in Farbe

  • S_ = Fotorealistisches Schwarz-Weiß-Bild

  • U_ = Unvermaßtes Bild (Strichzeichnung)

  • V_ = Vermaßtes Bild (Strichzeichnung)

  • X_ = Explosionszeichnung

  • MI = Milieubild, Badszene

  • DT = Detailbild/-ansicht

  • KV = Keyvisuals – Leitbilder

  • LO = Logo

  • LS = Lifestyle (Emotionsbilder mit Menschen)

Dokumenttypen

  • 2D = 2D-Draufsicht

  • 2F = 2D-Frontale

  • 2S = 2D-Seitenansicht

  • 3C = 3D-Daten

  • 3B = 3D-Daten

  • 3A = 3D-Daten zur Darstellung im Browser

  • AN = Animation

  • DB = Datenblatt

  • GG = Gefahrgut – Datenblatt

  • IS = Instruktion/Bedienungsanleitung

  • MA = Montageanleitung

  • VM = Montagevideo

  • TI = Technische Info

  • VT = Tutorial

  • TZ = Technische Zeichnung

  • VI = Video

  • WA = Wartungsanleitung

  • VP = Produktvideo

  • PA = Planungsanleitung

  • PP = Prospekte

  • ZL = Zulassung

  • SB = Schaltbild

  • SF = Schulungsfolie

  • PF = Pflegeanleitung

  • LE = Bauproduktenverordnung

  • EL = ErP-Label

  • EP = Einzelprospekt

  • UP = UBA-Positivliste

  • WL = WELL-Label

  • BS = Brandschutz

  • EX = EX-Schut

  • AS = Arbeitsschutz

  • KS = Korrisionsschutz

  • CE = CE-Konformitätserklärung

  • VD = VDS-Zulassung

  • SS = Schallschutznachweis

  • PL = Prüfreport Lithiumbatterie

[“VI”, “VP“]

videodefaultposter

Nein

Im Web verfügbares Bild das beim starten des Videos angezeigt wird, wenn kein Videoposter vorhanden ist.

https://url.png

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"
}

pdfviewer

Das Objekt dient als Konfigurationsobjekt für den PDF-Viewer

Aktuell gibt es nur eine Oberkategorie

  • position

    • top

    • right

    • bottom

    • left

Alle Werte werden als Pixel-Werte implementiert. Eine Einheit muss nicht zwingend angegeben werden.

Code Block
"pdfviewer":{
             "position":{
                   "top": "150px",
                   "right": "20px",
                   "bottom": "50px",
                   "left": "20px"
             }
}

downloadinnewtab

Nein

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

Code Block
{
  ...
  "downloadinnewtab": 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"
}

Ausgang

status

ja

Dieses Event wird immer beim Initialisieren ausgegeben.

  • error

  • complete

  • found

  • not_found

 

dialogstatus

Nein

Dieses Event wird beim öffnen und schließen eines Dialoges ausgegeben. Werte:

  • open

  • close

Eingangsevents

closeAlldialogs

Dieses Event kann an das Widget emittet werden. Das Widget fängt das Event und schließt daraufhin alle zu Zeit geöffneten Dialogfenster.

Beispielaufruf:

Code Block
document.querySelector("xs-articledocuments").dispatchEvent(new Event("closeAllDialogs"))

...

Beispielabbildung

...

image-20220504-100909.png

Beispielparameter

Code Block
breakoutModewide
{
   "channelid":2,
   "manufacturerpid":"test",
   "manufacturerid":"testid",
   "manufactureridtype":"opendatacheck_shk",
   "types":[
      "VI",
      "VP",
      "VM"
   ],
   "style":{
      "primarycolor": "#616161",
      "secondarycolor": "#D3D3D3"
   },
   "pdfviewer":{
             "position":{
                   "top": "150px",
                   "right": "20px",
                   "bottom": "50px",
                   "left": "20px"
             }
    }
}

...