Technische Dokumentation von Dokumenten am Artikel

01.12.2022 → neuer Status not_found

30.09.2022 → neuen Eingangsparameter “downloadinnewtabtarget” hinzugefügt

26.09.2022 → Einbindung über Widget-Loader V2.0.0 hinzugefügt

09.08.2022 → Eingangsevent closeAllDialogs hinzugefügt

06.07.2022 → Hinzufügen Parameter style und pdfviewer, Loader-Version auf 1.0.1 geändert

04.05.2022 → Screenshots ausgetauscht

02.03.2022 → Umstellen Widget-Loader-Version auf 1.0.1

02.03.2022 → Umstellen URLs von GC nach OpenDatacheck

28.01.2022 → Erstellen der Dokumentation als Einzelseite


Beschreibung

Auf dieser Seite finden Sie die technische Dokumentation für die Integration und Abbildung von Artikeldokumenten wie Milieubildern, Datenblätter usw. an den Artikeldaten. Beispiele zur Darstellung nach der Integration finden Sie weiter unten auf der Seite. Hier können auch Video am Artikel mit abgebildet werden wie z.B. Montagevideos, Anwendungsvideos usw. Die Inhaltsübersicht finden Sie im Folgenden:


Inhalt


Integration per “xs-loader” Widget

Alle Widgets werden über den “xs-loader” eingebunden. Bitte machen Sie sich mit der Dokumentation https://itek-wissen.atlassian.net/wiki/spaces/SOF/pages/2841313293 vertraut.


Parameter “xs-articledocuments“

Dieses Widget stellt die Dokumente & Videos aus den Stammdaten des Lieferanten dar.

Eingang

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").

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

"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

{ ... "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

 

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:

Beispielabbildung

image-20220504-101009.png
Videoplayer

 

image-20220504-100909.png
Dokumentenvorschau (Video)

 

Beispielparameter

Beispielintegration

Folgendes Codesnippet in den HTML DOM einbetten.

Widget-Loader V1.x.x

Widget-Loader V2.x.x

Beispielevent “status”

Folgendes Codebeispiel wartet auf das Rückgabevent “status” von dem “articledocuments” Widget.

 

Beispielcode (PHP)

Widget-Loader V1.x.x

 

Widget-Loader V2.x.x