Allgemeines

Mit den JavaScript basierten 3D/BIM Integrationsmöglichkeiten können 3D-Modelle (u.a. von CADENAS) einzelner Produkte abgefragt, geladen und visualisiert werden. Die Integration per JavaScript ist eine einfache Möglichkeit, 3D-Daten schnell und effektiv abzufragen oder mithilfe eines Viewers zu visualisieren. Die nachfolgende ausführliche Beschreibung der JavaScript-Integration setzt die im Artikel JavaScript Integrationsgrundlagen beschriebenen Grundlagen voraus. Der Artikel geht dabei insbesondere auf die Parameter (sowie deren Wertebereich) der vorhandenen Integrationsmöglichkeiten ein und veranschaulicht diese jeweils in einem interaktiven Showcase.

3D-Viewer

Die Integration oxomi.product3dViewer erlaubt es, ein 3D-Modell für einen Artikel mithilfe eines 3D-Viewers zu visualisieren. Hierfür wird die Artikelnummer (itemNumber) des entsprechenden Artikels und dessen Lieferantennummer (supplierNumber) benötigt. Die Lieferantennummer wird dabei benötigt, um die passende Partnerschaft zu finden. Durch diese wird der Mandant ermittelt, welcher den Artikel eingestellt hat. Abhängig von der 3D-Bibliothek, die dieser Mandant verwendet, wird dann der passende Viewer geladen.

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.product3dViewer({
    target: "#output",
    itemNumber: '123456',
    supplierNumber: '123456'
}).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
itemNumber string

Gibt die Artikelnummer des Produkts an, für welches das 3D-Modell im Viewer gerendert werden soll.

supplierNumber string

Gibt die Nummer des Lieferanten an, über welchen das Produkt bezogen wird.

Hinweis:

  • Wenn eigene Produkte angezeigt werden sollen, kann hier ein - eingetragen werden.
  • Sie können Ihre eigenen Lieferantennummern verwenden, wenn Sie diese in der Partnerschaft zum Lieferanten gepflegt haben (siehe: Lieferantennummern).
target string

Gibt das Ziel-Element an, in welches der gerenderte 3D-Viewer eingefügt wird.

Hinweis:

  • Wird der Parameter nicht angegeben, so wird #oxomi-3d-viewer als Default-Wert verwendet.
3D-Viewer - Showcase

Parameter

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
(itemNumber) Gibt die Artikelnummer des Produkts an, für welches das 3D-Modell im Viewer gerendert werden soll.
(supplierNumber) Gibt die Nummer des Lieferanten an, über welchen das Produkt bezogen wird.

Ausgabebereich

3D-Daten-Verfügbarkeitsprüfung

Die Integration oxomi.product3dExists führt eine „3D-Daten-Verfügbarkeitsprüfung“ durch. Damit kann überprüft werden, ob ein 3D-Modell für eine spezifizierte Artikelnummer existiert. Die Methode item3dExists liefert ein Promise zurück. Bei Erfüllung der Zusage gibt dieses entweder true zurück, wenn 3D-Daten für die angefragte Artikelnummer verfügbar sind, oder false andererseits.

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

Gibt die Artikelnummer des Produkts an, für welches die Verfügbarkeitsprüfung durchgeführt werden soll.

supplierNumber string

Gibt die Nummer des Lieferanten an, über welchen das Produkt bezogen wird.

Hinweis:

  • Wenn eigene Produkte angezeigt werden sollen, kann hier ein - eingetragen werden.
  • Sie können Ihre eigenen Lieferantennummern verwenden, wenn Sie diese in der Partnerschaft zum Lieferanten gepflegt haben (siehe: Lieferantennummern).
3D-Data Exists Check - Showcase

Parameter

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
(itemNumber) Gibt die Artikelnummer des Produkts an, für welches die Verfügbarkeitsprüfung durchgeführt werden soll.
(supplierNumber) Gibt die Nummer des Lieferanten an, über welchen das Produkt bezogen wird.

Ausgabebereich

Siehe auch
Enthält die Grundlagen zum Thema Javascript Integration.