====== OXID Plugin - Tradebyte 2 OXID Connector ====== für OXID 6.x Das Plugin bei FATCHIP: https://www.fatchip.de/Plugins/OXID-eShop/Tradebyte-2-OXID-Connector.html\\ Das Plugin auf Github: https://github.com/FATCHIP-GmbH/plugin-oxid6-tradebyte2oxid (private) ===== Voraussetzungen ===== * OXID Version 6 * FTP-Zugang zu Ihrem Shop-System * Für OXID-Versionen ab 6.2. benötigen Sie SSH-Zugriff auf die Shop-Installation. ---- ===== Installation ===== ==== Composer ==== Öffnen Sie die Datei **composer.json** im Stammverzeichnis Ihres Shops und fügen Sie das Repository hinzu oder vervollständigen Sie die vorhandene Konfiguration: \\ "repositories": [{ "type": "composer", "url": "https://packages.fatchip.de/packages" }] Nach erfolgter Ergänzung der Datei //composer.json// können Sie da Plugin installieren.\\ Melden Sie sich dazu per SSH an dem Server an, auf dem sich die Shop-Installation befindet, und navigieren Sie zu dem Verzeichnis, in dem sich der Source- und Vendorornder befinden.\\ Führen Sie folgenden Befehl aus, um das Plugin zu installieren composer require fatchip-gmbh/plugin-oxid6-tradebyte2oxid Beachten Sie, dass der genaue Aufruf des Composers für Ihre konkrete OXID-Installation abweichen kann. \\ Sie werden nun nach einem Benutzer und einem Passwort gefragt. Geben Sie die Zugangsdaten ein, welche Ihnen per E-Mail übersandt wurden.\\ Bitte speichern Sie diese Zugangsdaten **nicht** auf Ihrem Server, da es sonst zu Problemen kommt, sollten Sie mehrere unserer Plugins einsetzen oder einsetzen wollen. Nach korrekter Eingabe der Zugangsdaten wird das Plugin installiert. ==== Manuell ==== === Inhalt aus dem Ordner „modules“ kopieren === In dem Pluginpaket fcTradebyte2Oxid_oxid6_source befindet sich der Ordner //copy_this//, kopieren Sie den Inhalt aus diesem Ordner in das "Source" Ordner Ihres OXID eShops (bei FTP - binären Übertragungsmodus nutzen). {{:public:20190402_tb2oxid_01_copy_files.png?nolink&800|}} === composer.json aktualisieren === Öffnen Sie die Datei **composer.json** im Stammverzeichnis Ihres Shops und fügen Sie diese Autoload-Konfiguration hinzu oder vervollständigen Sie die vorhandene Konfiguration: \\ "autoload": { "psr-4": { "FATCHIP\\": "./source/modules/fc" } }, Nach erfolgter Ergänzung der Datei //composer.json// müssen die Änderungen dem OXID-System mitgeteilt werden.\\ Rufen Sie hierzu das Programm //composer// mit der Aktion //dump-autoload// auf (**//composer dump-autoload//**).\\ Beachten Sie, dass der genaue Aufruf des Composers für Ihre konkrete OXID-Installation abweichen kann. \\ \\ Nach erfolgreicher Aktion wird folgende Meldung angezeigt: //Generating autoload files// **In OXID-Versionen ab 6.2 (ältere Versionen können den Schritt überspringen)** muss die Modulkonfiguration eingelesen werden.\\ Melden Sie sich dazu per SSH an dem Server an, auf dem sich die Shop-Installation befindet, und navigieren Sie zu dem Verzeichnis, in dem sich der Source- und Vendorornder befinden. Führen Sie die folgenden Befehle aus:\\ vendor/bin/oe-console oe:module:install-configuration source/modules/fc/fctradebytemarket vendor/bin/oe-console oe:module:apply-configuration Bei erfolgreichem Einlesen/Import erscheint die Nachricht\\ **Module configuration has been installed** === FATCHIP Tradebyte2Oxid Connector aktivieren === Aktivieren Sie das Plugin im OXID Administrationsbereich unter //Erweiterungen -> Module -> FATCHIP Tradebyte2Oxid Connector//. {{:public:20190312_tb2oxid_3_activation.png?nolink&800|}} ---- ===== Konfiguration ===== Erweiterungen -> Module -> FATCHIP Tradebyte2Oxid Connector -> Einstell. === Einstellungen: Verbindung === Die Tradebyte 2 OXID Connector Verbindungseinstellungen finden Sie unter //Konfiguration -> Tradebyte Verbindungseinstellungen REST// oder //Konfiguration -> Tradebyte Verbindungseinstellungen FTP//. Hier können Sie zwischen der Verbindung über die REST API oder über FTP Server wählen. {{:public:20190312_tb2oxid_11a_config_rest.png?nolink&800|}} {{:public:20190312_tb2oxid_11b_config_ftp.png?nolink&800|}} ^ Konfiguration ^ Beschreibung^ |Benutzername (REST API)|Benutzername für die Verbindung über die REST API| |Passwort (REST API)|Passwort für die Verbindung über die REST API| |REST Server (Format: rest.trade-server.net)|REST Server URL im Format // rest.trade-server.net //| |Händler ID|Tradebyte Händler ID| |Vertriebskanal|Tradebyte Vertriebskanal| |Kanalzeichen|:?:| |Benutzername (FTP Server)|Benutzername für die Verbindung über den FTP Server| |Passwort (FTP Server)|Passwort für die Verbindung über den FTP Server| |FTP Server (Format: ftp.trade-server.net)|FTP Server URL im Format // ftp.trade-server.net //| |Datei nach dem Download vom FTP Server löschen (nur zu Testzwecken deaktivieren)|Die XML-Datei wird nach dem erfolgreichen Download vom Tradebyte Server gelöscht.| |falls noch nicht vorhanden, Download der Datei mehrfach im 5 Minuten Takt versuchen|Falls die aktuelle XML-Datei noch nicht vorhanden ist, wird alle 5 Minuten eine neuer Download Versuch gestartet| === Einstellungen: Script === Die Tradebyte 2 OXID Connector Script-Einstellungen finden Sie unter //Konfiguration -> Script-Einstellungen//. Hier können Sie die Kommunikationsart für die verschiedenen Scripte festlegen. {{:public:20190312_tb2oxid_12_config_script.png?nolink&800|}} ^ Konfiguration ^ Beschreibung ^ |Kommunikationsart Tradebyte Vollimport|Kommunikationsart für den Tradebyte Vollimport \\ {{:public:tb2oxid_2.2_1.png?nolink&300|}} \\ //Rest API:// Verbindung über die Tradebyte REST API \\ //Order:// Datei wird aus dem Import Ordner in Ihrem OXID Hauptverzeichnis importiert \\ //FTP:// Verbindung über den Tradebyte FTP Server| |Kommunikationsart Tradebyte Delta-Import|Kommunikationsart für den Tradebyte Delta-Import| |Kommunikationsart Lagerbestands-Vollimport|Kommunikationsart für den Lagerbestands-Vollimport| |Kommunikationsart Lagerbestands-Detla-Import|Kommunikationsart für den Lagerbestands-Delta-Import| |Kommunikationsart Order-Export|Kommunikationsart für den Order-Export| |Kommunikationsart Bestell-Status-Import|Kommunikationsart für den Bestell-Status-Import| |Kommunikationsart Stock-Export|Kommunikationsart für den Lagerbestands-Export| |Kommunikationsart Tradebyte Kategorie-Import|Kommunikationsart für den Tradebyte Kategorie-Import| === Einstellungen: Produkt-Import === Die Tradebyte 2 OXID Connector Produkt-Import-Einstellungen finden Sie unter //Konfiguration -> Produkt-Import-Einstellungen//. Hier können Sie den Import der Produktdaten aus Tradebyte konfigurieren und auf Ihren OXID eShop abstimmen. {{:public:20190312_tb2oxid_13_config_product_import.png?nolink&800|}} ^ Konfiguration ^ Beschreibung ^ |Neue Kategorien als versteckt importieren|Neue Kategorien werden als versteckte Kategorien in OXID importiert.| |Große Dateien zur Verarbeitung in kleine XMLs aufteilen (bei Problemen mit memory_limit aktivieren)|Eine große Tradebyte XML-Datei wird in mehrere kleinere Dateien aufgeteilt.| |Zeitfenster (in Sekunden) für Delta-Import|Das erlaubte Zeitfenster für den Delta-Import| |in Tradebyte nicht mehr vorhandene Produkte in OXID löschen|Produkte, die nicht mehr in Tradebyte vorhanden sind, werden auch im OXID eShop gelöscht.| |in Tradebyte nicht mehr vorhandene Varianten in OXID löschen|Varianten, die nicht mehr in Tradebyte vorhanden sind, werden auch im OXID eShop gelöscht.| |in Tradebyte nicht mehr vorhandene Attribute in OXID löschen|Attribute, die nicht mehr in Tradebyte vorhanden sind, werden auch im OXID eShop gelöscht.| |in Tradebyte nicht mehr vorhandene Kategorien in OXID löschen|Kategorien, die nicht mehr in Tradebyte vorhanden sind, werden auch im OXID eShop gelöscht.| |in Tradebyte nicht mehr vorhandene Marken in OXID löschen|Marken, die nicht mehr in Tradebyte vorhanden sind, werden auch im OXID eShop gelöscht.| |in Tradebyte nicht mehr vorhandene Lieferanten in OXID löschen|Lieferanten, die nicht mehr in Tradebyte vorhanden sind, werden auch im OXID eShop gelöscht.| |in Tradebyte nicht mehr vorhandene Produktkategorisierungen in OXID löschen|Produktkategorisierungen, die nicht mehr in Tradebyte vorhanden sind, werden auch im OXID eShop gelöscht.| |in Tradebyte nicht mehr vorhandene Crosssellings in OXID löschen|Crosssellings, die nicht mehr in Tradebyte vorhanden sind, werden auch im OXID eShop gelöscht.| |in Tradebyte nicht mehr vorhandene Produkt zu Attribut Beziehungen in OXID löschen|Produkt zu Attribut Beziehungen, die nicht mehr in Tradebyte vorhanden sind, werden auch im OXID eShop gelöscht.| |in Tradebyte nicht mehr vorhandene Produkt-Logos zu Attribut Beziehungen in OXID löschen|Produkt zu Attribut Beziehungen, die nicht mehr in Tradebyte vorhanden sind, werden auch im OXID eShop gelöscht.| |in Tradebyte nicht mehr vorhandene Produkt-Logos in OXID löschen|Produkt-Logos, die nicht mehr in Tradebyte vorhanden sind, werden auch im OXID eShop gelöscht.| |Varianten Bilder in Vaterprodukt einfügen|Die Varianten Bilder aus Tradebyte werden auch bei dem OXID Hauptartikel hinterlegt.| |Tradebyte-Artikelnummer anstatt Tradebyte-Produkt-ID als oxarticles.OXID verwenden|Die Tradebyte-Artikelnummer wird anstatt der Tradebyte-Produkt-ID als oxarticles verwendet.| |Variantenmerkmale auch als Attribut importieren|Variantenmerkmale aus Tradebyte werden im OXID eShop auch als Attribut angelegt.| |Standard Lieferstatus wenn Artikel wieder beschaffbar \\ {{:public:tb2oxid_2.3_1.png?nolink&300|}}|Hier können Sie den OXID Lieferstatus für wieder beschaffbare Artikel festlegen.| |Standard Lieferstatus wenn Artikel nicht wieder beschaffbar|Hier können Sie den OXID Lieferstatus für **NICHT** wieder beschaffbare Artikel festlegen.| |Artikel import XML file handling \\ {{:public:tb2oxid_2.3_2.png?nolink&300|}}|Hier können Sie entscheiden, was mit der Tradebyte XML-Datei nach dem Import passieren soll.| |Archivierte XMLs Aufbewahrungszeit in Tagen.|Hier können Sie entscheiden, wie lange die Tradebyte XML-Datei aufbewahrt werden soll.| |leere Kategorien löschen|Leere Kategorien werden im OXID eShop gelöscht.| |ungenutzte Attribute löschen|Ungenutzte Attribute werden im OXID eShop gelöscht.| |ungenutzte Marken löschen|Ungenutzte Marken werden im OXID eShop gelöscht.| |Artikel mit Streichpreis automatisch auf negative Nachlässe ignorieren setzen.|Artikel die einen Streichpreis haben, können keine negativen Nachlässe bekommen.| |Während des Imports keine Bilder runterladen (nur zu Testzwecken aktivieren)|Wenn diese Einstellung aktiv ist, werden während des Imports keine Produktbilder herunter geladen.| |Master-Bilder beim Download von Tradebyte auf konfigurierte Zoom-Größe verkleinern (spart Speicherplatz)|Master-Bilder aus Tradebyte werden beim Import auf die OXID Zoom-Größe skaliert.| |Tradebyte last change Timestamp auswerten |Wenn der Tradebyte last change Timestamp eines Produktes älter als die angegebene Differenz ist, werden nur Preis und Lagerbestand abgeglichen, sonst alle Felder.| |Tradebyte last change Timestamp Differenz in Sekunden|Die Differenz in Sekunden, wenn die Option „Tradebyte last change Timestamp auswerten“ aktiv ist.| |XML Dateigrößen-Validierung, Mindestgröße im Vergleich zur letzten XML in Prozent (z.B. 80), nur für Vollimport|Bei dem Vollimport können Sie die Dateigröße der XML-Datei überprüfen und eine Mindestgröße in Prozent angeben.| |Sprach-Mapping (leer lassen wenn das multilinguale Format nicht verwendet wird) \\ Format-Beispiel: \\ //0 => deutsch// \\ //1 => englisch//|Wenn Sie einen mehrsprachigen Shop verwenden, können Sie hier das Sprach-Mapping hinterlegen.| === Einstellungen: FATCHIP FatSearch === Die Tradebyte 2 OXID Connector Produkt-Import-Einstellungen finden Sie unter //Konfiguration -> FATCHIP FatSearch Einstellungen//. Wenn Sie das FATCHIP FatSearch Plugin verwenden, können Sie hier den Import konfigurieren. {{:public:20190312_tb2oxid_14_config_fcfatsearch.png?nolink&800|}} ^ Konfiguration ^ Beschreibung ^ |Verwendet Ihr Shop das FATCHIP FatSearch Plugin?|Wenn Sie das FATCHIP FatSearch Plugin einsetzten, \\ aktivieren Sie die Option.| |Tradebyte Attributswerte mit FatSearch Attributswerten synchronisieren|Die Tradebyte Attribute werden mit den FatSearch Attributen abgeglichen.| === Einstellungen: Bestell-Export === Die Tradebyte 2 OXID Connector Bestell-Export-Einstellungen finden Sie unter //Konfiguration -> Bestell-Export-Einstellungen//. Bestellungen aus Ihrem OXID eShop werden zu Tradebyte exportiert, hier können Sie diesen Bestell-Export konfigurieren. {{:public:20190312_tb2oxid_15_config_order_export.png?nolink&800|}} ^ Konfiguration ^ Beschreibung ^ |Nur bezahlte Bestellungen an TB.Market exportieren|Es werden lediglich als bezahlt markierte Bestellungen an Tradebyte exportiert.| |Versandart-Typ ausgeben (nur zu Testzwecken aktivieren)|Die Versandart wird mit der Bestellung exportiert.| |Zahlart-Typ ausgeben (nur zu Testzwecken aktivieren)|Die Zahlungsart wird mit der Bestellung exportiert.| |Artikel MwSt.-Satz ausgeben (nur zu Testzwecken aktivieren)|Der Mehrwertsteuersatz wird mit der Bestellung exportiert.| |Pfad zu Bestell-Export-Datei|Der Pfad zu der Bestell-Export XML-Datei in Ihrem OXID eShop Verzeichnis. \\ //ihr-oxid-eshop.de/export/orders///| === Einstellungen: Lagerbestands-Export === Die Tradebyte 2 OXID Connector Lagerbestands-Export Einstellungen finden Sie unter //Konfiguration -> Lagerbestands-Export Einstellungen//. Bestellungen aus Ihrem OXID eShop werden zu Tradebyte exportiert, hier können Sie diesen Bestell-Export konfigurieren. {{:public:20190312_tb2oxid_16_config_stock_export.png?nolink&800|}} ^ Konfiguration ^ Beschreibung ^ |Pfad zu Lagerbestands-Export-Datei |Der Pfad zu der Lagerbestands-Export XML-Datei in Ihrem OXID eShop Verzeichnis. \\ //ihr-oxid-eshop.de/export/stock///| === Andere Einstellungen === Weitere Tradebyte 2 OXID Connector Einstellungen finden Sie unter //FC Tradebyte -> TB2OXID -> Konfiguration -> Andere Einstellungen//. {{:public:20190312_tb2oxid_17_config_other.png?nolink&800|}} ^ Konfiguration ^ Beschreibung ^ |Logging aktiv|Es wird ein Logfile im log Ordner des OXID eShops erstellt.| |Verbose-Modus aktiv|Weitere Debuging Informationen im Logfile anzeigen.| |Skript läuft schon Lockfile Logik deaktivieren (nur zu Testzwecken aktivieren)|Hier können Sie die Lockfile Logik zu Testzwecken deaktivieren.| |Skript läuft schon Lockfile-Pfad|Der Pfad Lockfile z.B. ///var/www/localhost/tmp///| |Empfänger-Email-Adresse für Fehler-Emails|E-Mail Adresse für Fehlermeldungen.| === Sytemcheck === Im OXID Administrationsbereich unter //FC Tradebyte -> Systemcheck// können Sie prüfen ob alle Systemvoraussetzungen für eine korrekte Pluginfunktion gegeben sind. {{:public:20190312_tb2oxid_21_system_check.png?nolink&800|}} ---- ===== Anwendung ===== === Tradebyte 2 OXID Cronjobs einstellen === Damit die Synchronisation der Artikeldaten funktioniert, müssen die folgenden Cronjobs einrichten werden. * ///source/modules/fc/fctradebytemarket/batch/TradebyteImportBatch.php// \\ Dieses Script importiert alle Artikel-, Kategorie-, Hersteller- und Attributinformationen. Bei OXID Enterprise Edition müssen Sie noch die Shop-ID als ersten Paramater hinzufügen. Der Change-Date-Check Flag kann mit einem zweiten Paramater überschrieben werden (0 = do full import, 1 = do change-date-check import). \\ Wir empfehlen diesen Cronjob **einmal täglich** zu starten.\\ \\ * ///source/modules/fc/fctradebytemarket/batch/TradebyteImportDeltaBatch.php// \\ Dieses Script importiert Preis- und Lagerbestandsaktualisierungen von Tradebyte in den OXID eShop. Bei OXID Enterprise Edition müssen Sie noch die Shop-ID als ersten Paramater hinzufügen. \\ Wir empfehlen diesen Cronjob **stündlich** zu starten.\\ \\ * ///source/modules/fc/fctradebytemarket/batch/TradebyteStockBatch.php// \\ Dieses Script importiert alle Lagerbestände aus Tradebyte in den OXID eShop. \\ Wir empfehlen diesen Cronjob **jede halbe Stunde** zu starten. \\ \\ * ///source/modules/fc/fctradebytemarket/batch/TradebyteOrderExportBatch.php// \\ Dieses Script exportiert alle Bestellungen aus dem OXID eShop zu Tradebyte. \\ Wir empfehlen diesen Cronjob **stündlich** zu starten. \\ \\ * //source/modules/fc/fctradebytemarket/batch/TradebyteOrderStatusImportBatch.php// \\ Dieses Script importiert alle Bestellstatus aus Tradebyte in den OXID eShop. \\ Wir empfehlen diesen Cronjob **stündlich** zu starten.\\ \\ * ///source/modules/fc/fctradebytemarket/batch/TradebyteArchiveCleanupBatch.php// \\ Dieses Script löscht archivierte XML-Dateien, die älter sind als die konfigurierte Aufbewahrungszeit in Tagen. \\ Wir empfehlen diesen Cronjob **stündlich** zu starten. === Tradebyte 2 OXID Übersicht === Im OXID Administrationsbereich unter //FC Tradebyte -> TB2OXID -> Main// können Sie den aktuellen Bestand Ihrer OXID Datenbank einsehen und die Tradebyte 2 OXID Jobausführungen überwachen. {{:public:20190312_tb2oxid_31_overview.png?nolink&800|}} ---- ===== FAQs ===== - [[#Welche OXID eShop Versionen sind mit dem Tradebyte 2 OXID Connector von FATCHIP kompatibel?]] - [[#Wie werden die Bilddaten zwischen Tradebyte und OXID übertragen?]] === 1. Welche OXID eShop Versionen sind mit dem Tradebyte 2 OXID Connector von FATCHIP kompatibel? === Die aktuellsten Informationen hierzu erhalten Sie in der [[https://www.fatchip.de/Plugins/OXID-eShop/Tradebyte-2-OXID-Connector.html#matrix|Kompatibilitätsmatrix]] in unserem Shop. === 2. Wie werden die Bilddaten zwischen Tradebyte und OXID übertragen? === Bei der Übertragung der Bilddaten finden insgesamt 2 Schritte statt:\\ * **Schritt 1**\\ Vom Tradebyte Server wird die hinterlegte XML-Datei im Shop Verzeichnis /import/tradebyte/ generiert,\\ die Variante des Uploads hängt von der Konfiguration des Tradebyte Plugins ab:\\ a.) REST-API über PHP Curl Erweiterung http://php.net/manual/de/book.curl.php\\ b.) FTP Upload über PHP FTP Erweiterung http://php.net/manual/de/intro.ftp.php * **Schritt 2 **\\ Nachdem die XML-Datei ins Verzeichnis /import/tradebyte/ kopiert wurde, liest der Connector die XML-Datei ein und crawlt dabei alle hinterlegten Bildlinks aus den folgenden Tags:\\ \\ Bildlink Bildlink Der hinterlegte Bildlink ist die absolute URL des Bildes. Wenn das gecrawlte Bild vorhanden ist, wird es im OXID eShop im Master Bild Verzeichnis gespeichert z.B. "/out/pictures/master/" oder "/out/pictures/master/product/" (je nach OXID Version). ---- ===== Support ===== Sollten Sie Hilfe von FATCHIP benötigen, schicken Sie bitte eine detaillierte Fehlerbeschreibung inkl. Plugin- und Shopversion an //support@fatchip.de//. ---- ===== Weitere Informationen ===== Sollte das OXID Plugin Tradebyte 2 OXID Connector nach der Installation nicht wie erwartet funktionieren, prüfen Sie ob alle Installationsschritte richtig durchgeführt worden sind.\\ Weitere Informationen finden Sie in unserem Online Shop unter: https://www.fatchip.de/Plugins/OXID-eShop/Tradebyte-2-OXID-Connector.html Außerdem bietet FATCHIP einen Plugin-Installationsservice an. Weitere Informationen hierzu finden Sie unter:\\ https://www.fatchip.de/Servicepakete/Plugin-Installationsservice-OXID-eShop-PE.html\\ https://www.fatchip.de/Servicepakete/Plugin-Installationsservice-OXID-eShop-EE.html