Allgemeines

Mit den JavaScript basierten 3D/BIM Integrationsmöglichkeiten können 3D-Modelle einzelner Artikel 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

Diese Integration 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.

Parameter Beschreibung
itemNumber Definiert die Artikelnummer des Artikels, für welchen das 3D-Modell im Viewer gerendert werden soll.
supplierNumber Definiert die Nummer des Lieferanten, über welchen der Artikel bezogen wird. Wenn eigene Artikel angezeigt werden sollen, muss hier ein - eingetragen werden.
target Definiert das Ziel-Element, in welches der 3D-Viewer eingebettet werden soll. Als Wert wird hier eine HTML ID inklusive # erwartet.

Leere Ergebnisse - emptyResultHandler:

Standardmäßig wird die JavaScript-Integration von OXOMI keine Änderung an der Seite vornehmen, wenn keine Ergebnisse für eine artikelbezogene Abfrage gefunden wurden. Wenn Sie in diesem Fall aber anders reagieren möchten, um z.B. eine Meldung einzublenden, können Sie eine der folgenden Möglichkeiten verwenden. Grundsätzlich ist dies für alle artikelbezogenen Funktionen (itemXXXX(...)) möglich.

Am einfachsten ist es, den target Container standardmäßig auszublenden (style="display:none") und mit einer entsprechenden Meldung vorzubefüllen, etwa „Es wurden leider keine Bilder gefunden.“ Wenn Sie bei dem entsprechenden Aufruf den Parameter alwaysShowTarget: true mitgeben, wird der Container auch sichtbar gemacht, wenn nichts gefunden wurde. So wird Ihre Meldung auf der Seite eingeblendet.

Alternativ können Sie bei dem Aufruf itemXXX(...) eine Funktion im Parameter emptyResultHandler mitgeben. Diese wird aufgerufen, wenn der Server keine passenden Daten findet. Die Funktion erhält einen context Parameter, welcher alle Aufrufparameter (args), den Namen des Ziel-Containers (target) und die Serverantwort (json) enthält.

Weiterhin können Sie eine globale emptyResultHandler Funktion bei oxomi.init definieren, welche bei allen Aufrufen verwendet wird.

Beispiel:

// Behandlung auf globaler Ebene...
oxomi.init({portal: 'IHRE PORTAL-ID',
    accessToken: 'AUTHENTIFIZIERUNGS-TOKEN',
    emptyResultHandler: function(context) {
        document.querySelector(context.target).textContent = 'Es wurden keine Ergebnisse gefunden';
    }
});

// Behandlung pro Aufruf
oxomi.itemImages({
    supplierNumber: 'L10190',
    itemNumber: 'A20876',
    emptyResultHandler: function(context) {
        document.querySelector(context.target).textContent = 'Es wurden keine Bilder gefunden';
    }
});
3D-Viewer - Showcase

Allgemeine Parameter

Bitte geben Sie hier den Portal-Code beziehungsweise die Portal-ID an. Hier finden Sie weitere Informationen.
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.
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.
Bitte geben Sie hier wahlweise die Portallrollen an, um den Zugriff auf Dokumente zu steuern. Hier finden Sie weitere Informationen.

Aufruf Parameter

Definiert die Artikelnummer des Artikels, für welchen das 3D-Modell im Viewer gerendert werden soll.
Definiert die Nummer des Lieferanten, über welchen der Artikel bezogen wird. Wenn die Verfügbarkeit von eigenen Artikeln abgefragt werden soll, muss hier ein - eingetragen werden.

Ausgabebereich

3D-Daten-Verfügbarkeitsprüfung

Mit der „3D-Daten-Verfügbarkeitsprüfung“ 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.

Parameter Beschreibung
itemNumber Definiert die Artikelnummer des Artikels, für welchen die Verfügbarkeitsprüfung durchgeführt werden soll.
supplierNumber Definiert die Nummer des Lieferanten, über welchen der Artikel bezogen wird. Wenn die Verfügbarkeit von eigenen Artikeln abgefragt werden soll, muss hier ein - eingetragen werden.
3D-Data Exists Check - Showcase

Allgemeine Parameter

Bitte geben Sie hier den Portal-Code beziehungsweise die Portal-ID an. Hier finden Sie weitere Informationen.
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.
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.
Bitte geben Sie hier wahlweise die Portallrollen an, um den Zugriff auf Dokumente zu steuern. Hier finden Sie weitere Informationen.

Aufruf Parameter

Definiert die Artikelnummer des Artikels, für welchen die Verfügbarkeitsprüfung durchgeführt werden soll.
Definiert die Nummer des Lieferanten, über welchen der Artikel bezogen wird. Wenn die Verfügbarkeit von eigenen Artikeln abgefragt werden soll, muss hier ein - eingetragen werden.

Ausgabebereich

See also
Enthält die Grundlagen zum Thema Javascript Integration.