Technische Dokumentation von Dokumenten am Artikel
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 | |||
---|---|---|---|
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
Dokumenttypen
| [“VI”, “VP“] |
videodefaultposter | Nein | Im Web verfügbares Bild das beim starten des Videos angezeigt wird, wenn kein Videoposter vorhanden ist. | |
style | Nein | JSON-Objekt zur Definition der Primär- und Sekundär-Farbe des Widgets. Das Objekt hat zwei Felder:
|
"style":{
"primarycolor": "#616161",
"secondarycolor": "#D3D3D3"
} |
pdfviewer |
| Das Objekt dient als Konfigurationsobjekt für den PDF-Viewer Aktuell gibt es nur eine Oberkategorie
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.
|
|
dialogstatus | Nein | Dieses Event wird beim öffnen und schließen eines Dialoges ausgegeben. Werte:
|
|
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
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)