Fatchip GmbH Wiki

Diese Seite ist nicht editierbar. Sie können den Quelltext sehen, jedoch nicht verändern. Kontaktieren Sie den Administrator, wenn Sie glauben, dass hier ein Fehler vorliegt.
====== OXID Plugin - OXID 2 Tradebyte Connector ======
für OXID 6.x

Das Plugin bei FATCHIP: https://www.fatchip.de/Plugins/OXID-eShop/OXID-2-Tradebyte-Connector-2-0.html \\
Das Plugin auf Github: https://github.com/FATCHIP-GmbH/plugin-oxid6-oxid2tradebyte (private)

{{:public:fc_plugin_oxid2tradebyte_usecase_process_de.png?nolink&800|}}
===== Voraussetzungen =====

  * OXID CE/PE/EE ab Version 6.0.x bis 6.2.x
  * FTP-Zugang zu Ihrem Shop-System
  * Für OXID-Versionen ab 6.2. benötigen Sie SSH-Zugriff auf die Shop-Installation.

----

===== Installation =====
=== Inhalt aus dem Pluginpaket kopieren ===
Kopiern Sie den Inhalt aus dem Pluginpaket fcOxid2Tradebyte_VERSION_oxid6_source in SHOPROOT/source/modules Ihrer OXID eShop-Installation (bei FTP - binären Übertragungsmodus nutzen). 

{{:public:faq:ox2tb_ox6:200706_ftp_ox2tb_ox6.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: \\ <code javascript>
  "autoload": {
    "psr-4": {
      "FATCHIP\\": "./source/modules/fc"
    }
  },
</code> 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:\\
<code> /vendor/bin/oe-console oe:module:install-configuration source/modules/fc/fctradebyteone
/vendor/bin/oe-console oe:module:apply-configuration </code>
Bei erfolgreichem Einlesen/Import erscheint die Nachricht\\
**Module configuration has been installed**

=== OXID 2 Tradebyte Connector aktivieren ===
Aktivieren Sie den OXID 2 Tradebyte Connector im OXID Administrationsbereich unter //Erweiterungen -> Module -> FATCHIP Oxid2Tradebyte Connector//. 

{{:public:o2tb_1.5.png?nolink&800|}}

----

===== Update =====
Plugin Update wenn vorherige Pluginversion unter 2.4.0

=== Löschen der alten Moduldateien ===
Da sich die Ordnerstruktur des Moduls geändert hat, sollten Sie unbedingt alle alten Moduldateien löschen, damit es im Modul nicht zu unvorhersehbaren Verhaltensweisen kommt.

=== Inhalt aus dem Ordner „copy_this“ kopieren ===
In dem Pluginpaket fcTradebyteOne_oxid_source befindet sich der Ordner //copy_this//, kopieren Sie den Inhalt aus diesem Ordner in das Hauptverzeichnis Ihres OXID eShops. (bei FTP - binären Übertragungsmodus nutzen).

{{:public:tbonecopythis.jpg?nolink&800|}}

=== Migrations-Script ausführen ===
Wenn Sie von einer Pluginversion unter Version 2.4.0 updaten, müssen Sie das Datenbank-Migrations-Script ausführen. Das Migrations-Script können Sie auch über die Kommandozeile oder einen Browser aufrufen und ist im folgendem Verzeichnis zu finden. \\ ///modules/fc/fcTradebyteOne/scripts/fctradebyteone_migrate_db.php// 

=== OXID 2 Tradebyte Connector deaktivieren und aktivieren === 
Nach der Updateinstallation müssen Sie den OXID 2 Tradebyte Connector im OXID Administrationsbereich unter //Erweiterungen -> Module -> FATCHIP Oxid2Tradebyte Connector// einmal deaktivieren und danach wieder aktiveren. 

{{:public:o2tb_4.7.png?nolink&800|}}

----

===== Konfiguration =====
=== OXID 2 Tradebyte Connector Grundeinstellungen ===
Die Grundeinstellungen des Connectors finden Sie unter //Erweiterungen -> Module -> FATCHIP Oxid2Tradebyte Connector -> Einstellungen -> Grundeinstellungen//. 

{{:public:o2tb_2.1.png?nolink&800|}}

^ Konfiguration ^ Beschreibung ^
|Supportkey|Den Supportkey finden Sie in der E-Mail mit Ihrem Plugin. Ohne Nennung dieses Keys kann Ihnen die FATCHIP GmbH keinen Support leisten.|
|aktiv|OXID 2 Tradebyte Connector aktiv oder inaktiv schalten|
|PHP-Interpreter für den Exportaufruf|Hier müssen Sie den verwendeten PHP-Interpreter eintragen. Dies sind mögliche PHP-Interpreter-Pfade: \\ ///usr/bin/php// \\ ///usr/bin/php_cli// \\ ///usr/bin/php5//|

=== Tradebyte Channels ===
Die OXID 2 Tradebyte Connector Channels finden Sie unter //Erweiterungen -> Module -> FATCHIP Oxid2Tradebyte Connector -> Einstellungen -> Tradebyte Channels//. Hier können Sie entscheiden, welche Channels aktiv oder inaktiv sein sollen. Die XML mit Ihren Produktdaten wird für die aktiven Channels aufbereitet und auf dem Tradebyte Server zur Verfügung gestellt. 

{{:public:o2tb_2.2.png?nolink&800|}} 

^ Konfiguration ^ Beschreibung ^
|Active Dropdown|Über das Dropdown können Sie einzelne Channels aktiv oder inaktiv schalten.|
|{{:public:o2tb_2.2_1.png?nolink&300|}}|//Inactive, but visible in admin:// \\ Dieser Channel ist inaktiv, wird aber bei den Artikeln im OXID Administrationsbereich angezeigt.|

=== Tradebyte sFTP und REST-API Zugangsdaten ===
Es stehen zwei verschiedene Verbindungsarten zu Tradebyte zur Verfügung. Entweder eine Verbindung über einen sFTP-Server oder über die Tradebyte REST-API. Die Zugangsdaten können Sie unter //Erweiterungen -> Module -> FATCHIP Oxid2Tradebyte Connector -> Einstellungen -> Tradebyte sFTP Zugangsdaten// oder //Tradebyte REST-API Zugangsdaten// hinterlegen.

Die Verbindung über REST-API sollte immer der bevorzugte Weg sein und wird auch von Tradebyte forciert.

{{:public:o2tb_2.3.png?nolink&800|}}

^ Konfiguration ^ Beschreibung ^
|sFTP-Upload aktiv|Verbindung zu Tradebyte über einen sFTP-Server aktivieren|
|Host-URL|Host-URL (sFTP Zugangsdaten)|
|Benutzername|Benutzername (sFTP Zugangsdaten)|
|Passwort|Passwort (sFTP Zugangsdaten)|
|REST Upload aktiv (Deaktivieren zu Testzwecken)|Verbindung zu Tradebyte über die REST-API aktivieren|
|API-URL (i.e. rest.trade-server.net)|Für die benötigten Zugangsdaten müssen Sie einen API Benutzer im TB.One Webinterface anlegen.|
|Händlernummer|Tradebyte Händlernummer (REST-API Zugangsdaten)|
|Username|Benutzername (REST-API Zugangsdaten)|
|Password|Passwort (REST-API Zugangsdaten)|

=== Tradebyte Order Import ===
Neben dem Export der Produkte zu Tradebyte, ist es auch möglich die Bestellungen aus anderen Channels zu importieren. Die Einstellungen für den Import der Bestellungen können Sie unter //Erweiterungen -> Module -> FATCHIP Oxid2Tradebyte Connector -> Einstellungen -> Order Import// vornehmen.

{{:public:o2tb_2.4.png?nolink&800|}}

^ Konfiguration ^ Beschreibung ^
|Order import active|Import der Bestellungen aktivieren oder deaktivieren|
|Kommunikationsart Order Import|Order Importiert über sFTP oder REST API|
|Order xml dir on remote server|Der Pfad zum Verzeichnis auf dem entfernten Server, in dem die XML-Datei mit den Bestellungen aus den Channels liegt.|
|Default payment id, which will be used for order import|Die Standard Bezahlmethode für importierte Bestellungen aus den Channels.|
|Default delivery method id, which will be used for order import|Die Standard Versandart für importierte Bestellungen aus den Channels.|
|Default VAT for order import|Der Standard Mehrwertsteuersatz für importierte Bestellungen aus den Channels.|
|Used for non-existing users to generate username.|Ein Kürzel bzw. Text für die Benutzernamen der importierten Bestellungen aus den Channels.|

=== Tradebyte Produkte Einstellungen ===
Die Produkte Einstellungen können Sie unter //Erweiterungen -> Module -> FATCHIP Oxid2Tradebyte Connector -> Einstellungen -> Produkte Einstellungen// vornehmen.

{{:public:o2tb_2.5.png?nolink&800|}}

^ Konfiguration ^ Beschreibung ^
|OXID aktiv Status überschreiben|Wenn der OXID aktiv Status überschrieben wird, werden auch inaktive Produkte exportiert.|
|Eigene EAN generieren wenn nicht gepflegt|Wenn keine EAN Nummer eingepflegt ist, wird für den Export eine generiert.|

=== Tradebyte Logging ===
Das Logging können Sie unter //Erweiterungen -> Module -> FATCHIP Oxid2Tradebyte Connector -> Einstellungen -> Logging// aktivieren. Durch das Aktivieren der Logging Funktion werden Exportinformationen in einer Log-Datei gespeichert.

{{:public:o2tb_2.6.png?nolink&800|}} 

^ Konfiguration ^ Beschreibung ^
|Loglevel (1-4)|1: Nur Fehler \\ 2: Fehler und Warnungen \\ 3: Fehler, Warnungen und Abläufe \\ 4: Entwicklerdebugging|
|XML Archivierungsdauer in Tagen|Hier können Sie die Archivierungsdauer in Tagen einstellen.|

=== Tradebyte Tags ===
Im OXID Administrationsbereich unter //FC Tradebyte -> Tags// können Sie Tags für verschiedene Channels anlegen und für den Export einzelnen Produkten zuordnen. In diesem Beispiel sehen Sie zwei Tags (Farbe und Geschlecht) für den Amazon.de Channel. 

{{:public:o2tb_2.7.png?nolink&800|}} 

^ Konfiguration ^ Beschreibung ^
|Titel|Der Titel des Tags (z.B. Geschlecht)|
|Channel|Hier können Sie auswählen, für welchen Channel das Tag verfügbar sein soll.|
|Options|Die verschiedenen Werte des Tags können später den Produkten zugeordnet werden.|

----

===== Export =====

=== Artikel für den Export vorbereiten ===
Damit die Artikel für Tradebyte aufbereitet und exportiert werden, müssen diese für den Export aktiviert werden. Unter //Artikel verwalten -> Artikel -> Oxid2Tb Reiter// können Sie auswählen welcher Channel für diesen Artikel aktiv sein soll und den Artikel für den Export aufbereiten.

{{:public:o2tb_3.1.png?nolink&800|}}

^ Konfiguration ^ Beschreibung ^
|Channel, alternativer Preis|Hier können Sie einen Channel für diesen Artikel aktivieren. Außerdem habe Sie die Möglichkeit einen alternativen Preis für den Export festzulegen.|
|alternative Langbeschreibung|Eine alternative Langbeschreibung für den Export an Tradebyte.|
|alternative Produktbilder für Tradebyte|Artikelbilder werden in der Detailansicht eines Artikels verwendet. Sie können bis zu 7 Artikelbilder pro Artikel hochladen. Nach dem Hochladen wird der Dateiname im jeweiligen Eingabefeld angezeigt. Wenn noch kein Bild hochgeladen wurde, wird --- angezeigt. \\ Es können Bilder mit maximal 2 MB oder 1500*1500 Pixel Auflösung hochgeladen werden. Diese Einschränkung gilt, um Probleme mit dem PHP-Speicherlimit zu vermeiden. Danach wird aus diesen Bildern automatisch das Artikelbild, Zoombild, Thumbnail und Icon generiert.|
|{{:public:o2tb_3.1_1.png?nolink&500}}|Hier können Sie dem Artikel bestimmte Tags zuweisen. \\ Dazu wählen Sie einen Tag und eine passende Option aus und bestätigen die Eingabe über den „Add“ Button. \\ Die Tags und deren Optionen wurden zuvor im Schritt 2.7 angelegt.|
|Channel Tag, Tag Value| |

=== Einzelne Varianten vom Export ausschließen ===
Unter //Artikel verwalten -> Artikel -> Varianten -> Oxid2Tb Reiter// können einzelne Varianten vom Export ausgeschlossen werden. Diese Varianten Artikel werden nicht für Tradebyte aufbereitet und exportiert.

{{:public:o2tb_3.4.png?nolink&800|}}

=== Export manuell erstellen ===
Sie können unter //FC Tradebyte -> Oxid2Tb -> Stamm// den Export manuell anstoßen. Wenn Sie Artikel für den Export aktiviert haben, wird eine XML-Datei erstellt und auf dem Tradebyte Server zur Verfügung gestellt. 

{{:public:o2tb_3.2.png?nolink&800|}}

=== Export über einen Cronjob erstellen ===
Neben dem manuellen Erzeugen von Exporten, kann der Export und der Order Import auch über einen Cronjob erstellt werden. Dazu müssen Sie einen minütlichen Cronjob erstellen, der folgende PHP-Dateien aufruft. 
  
<code>/modules/fc/fcTradebyteOne/scripts/fctradebyteone_export_batch.php</code> (Tradebyte Export)
<code>/modules/fc/TradebyteOne/scripts/fctradebyteone_order_import_batch.php</code> (Tradebyte Order Import)
<code>/modules/fc/TradebyteOne/scripts/fctradebyteone_status_export_batch.php</code> (Tradebyte Order Status Export)
<code>/modules/fc/TradebyteOne/scripts/fctradebyteonestockexport_batch.php</code> (Tradebyte Lagerbestandsexport)

----

===== FAQs =====

  - [[#Welche OXID eShop Versionen sind mit dem OXID 2 Tradebyte Connector von FATCHIP kompatibel?]]
  - [[#Wie muss ich den FATCHIP OXID 2 Tradebyte Connector konfigurieren?]]
  - [[#Welche Bilder (Stamm vs. alternative Bilder aus dem Plugin) werden mit welcher Priorität in die XML geschrieben?]]
  - [[#Können die Produkte, die an Tradebyte exportiert werden sollen, direkt im OXID eShop definiert werden?]]
  - [[#Ist an den Bestellungen die in OXID importiert werden ersichtlich, über welcher Verkaufskanäle die Bestellungen mittels Tradebyte verkauft werden?]]
  - [[#Wie werden Versandbenachrichtigungen und Paketnummern an Tradebyte übermittelt?]]
  - [[#Wie verarbeitet das Plugin Teilstornierungen von Artikelpositionen auf OXID Seite bzw. wie verhält es sich bei Teillieferungen?]]
  - [[#Wichtige Information zur Benennung der XML Importdatei]]
  - [[#Ist es möglich sFTP zu nutzen?]]
  - [[#Das Plugin ist richtig konfiguriert, es werden aber dennoch keine bzw. nicht alle Artikel exportiert.]]
  - [[#Wie kann ein neuer Channel hinzugefügt werden?]]
  - [[#Warum werden meine Attribute nicht exportiert?]]

=== 1. Welche OXID eShop Versionen sind mit dem OXID 2 Tradebyte Connector von FATCHIP kompatibel? ===
Die aktuellsten Informationen hierzu erhalten Sie in der [[https://www.fatchip.de/Plugins/OXID-eShop/OXID-2-Tradebyte-Connector-2-0.html#matrix|Kompatibilitätsmatrix]] in unserem Shop.

=== 2. Wie muss ich das FATCHIP OXID 2 Tradebyte Plugin konfigurieren? ===
Eine detaillierte Schritt für Schritt Anleitung zu der Konfiguration des FATCHIP OXID 2 Tradebyte Connectors finden Sie hier {{:public:faq:modulbeschreibung_oxid2tb_kurzpraesentation.pdf|}}.

=== 3. Welche Bilder (Stamm vs. alternative Bilder aus dem Plugin) werden mit welcher Priorität in die XML geschrieben? ===
Hinsichtlich der Bilder hat der OXID2TB Reiter Vorrang. Das bedeutet, dass das oberste Bild im OXID2TB das oberste Bild im "normalen" Bilderstamm überschreibt. Ist das dritte Bild im "normalen" Bilderstamm mit einem Bild versehen und das dritte Bild im OXID2TB Reiter nicht, wird das Bild aus dem "normalen" Bilderstamm übermittelt. Fazit: Sind im normalen Bilderstamm 5 Bilder und im OXID2TB 3 Bilder, wird gemischt. 3 Bilder kommen von OXID2TB, die beiden restlichen vom "normalen Bilderstamm".

=== 4. Können die Produkte, die an Tradebyte exportiert werden sollen, direkt im OXID eShop definiert werden? ===
Ja, dies kann bequem über ein zusätzliches Häkchen (pro Tradebyte-Kanal) im Adminbereich erfolgen, da bei dem Plugin ein entsprechender Reiter mitgeliefert wird. Wir empfehlen die Markierung der Artikel per WaWi-Schnittstelle oder Ähnlichem zu setzen.

=== 5. Ist an den Bestellungen die in OXID importiert werden ersichtlich, über welcher Verkaufskanäle die Bestellungen mittels Tradebyte verkauft werden? ===
Ja, der entsprechende Vermerk wird in einem neuen oxorder-Feld abgelegt und kann dann weiterverarbeitet werden.

=== 6. Wie werden Versandbenachrichtigungen und Paketnummern an Tradebyte übermittelt? ===
Cronjobgesteuert über die Tradebyte REST API.

=== 7. Wie verarbeitet das Plugin Teilstornierungen von Artikelpositionen auf OXID Seite bzw. wie verhält es sich bei Teillieferungen? ===
Teilstornos werden an Tradebyte per REST API übergeben. Da es für Teillieferungen kein gängiges OXID Standard Verhalten gibt, lässt sich hier auch kein standardisiertes Verhalten festlegen. Dies kann aber individuell im Plugin erweitert werden, vorausgesetzt der OXID eShop wurde bereits um die entsprechenden Funktionen erweitert.

=== 8. Wichtige Information zur Benennung der XML Importdatei ===
Die Importdatei darf im Namen das Wort "TEST" NICHT enthalten.

=== 9. Ist es möglich sFTP zu nutzen? ===
Ein Nutzung von sFTP ist ab der Version 1.0.3 möglich.

=== 10. Das Plugin ist richtig konfiguriert, es werden aber dennoch keine bzw. nicht alle Artikel exportiert. ===
Zu Tradebyte werden keine Artikel ohne EAN Nummer übertragen. Prüfen Sie daher bitte ob bei allen Artikel EAN-Nummern gepflegt sind oder aktivieren Sie bei Bedarf im Plugin die Option „Eigene EAN generieren wenn nicht gepflegt“. Danach sollte der Export wie gewünscht funktionieren.

=== 11. Wie kann ein neuer Channel hinzugefügt werden? ===
Wenn Sie für den Export einen neuen Channel hinzufügen möchten, müssen zwei Anpassungen vorgenommen werden.

1. In der Datei **fcTradebyteOneChannels.xml** den neuen Kanal hinzufügen

**Beispiel:**
<code>
<channel>
     <title>Weltbild.de</title>
     <abbreviation>wbde</abbreviation>
</channel>
</code>

**Pfad:**
<code>
/modules/fc/fcTradebyteOne/files/fcTradebyteOneChannels.xml
</code>

Der Titel **//Weltbild.de//** im Tag <code><title>Weltbild.de</title></code> und das Kanalkürzel **//wbde//** im Tag <code><abbreviation>wbde</abbreviation></code> stehen hier exemplarisch für den Kanal Weltbild und müssen dementsprechend für den gewünschten Kanal angepasst werden.

Das passende Kanalkürzel erhalten Sie von Ihrem Tradebyte Account-Manager oder im Tradebyte Kundencenter unter https://infocenter.tradebyte.com.

2. In der Datei **fctradebyteone_lang.php** die Übersetzungen für den neuen Kanal hinzufügen

**Beispiel:**

<code>
'GENERAL_ARTICLE_FCTBONEWBDEPRICE'     => 'Weltbild.de Preis',
'GENERAL_ARTICLE_FCTBONEWBDEACTIVE'    => 'Weltbild.de aktiv',
</code>

Das Kanalkürzel **//WBDE//** in der Konstante (z.B. //GENERAL_ARTICLE_FCTBONE__**WBDE**__PRICE//) steht hier exemplarisch für den Kanal Weltbild.de und muss dementsprechend angepasst werden.
Die Konstante für die Übersetzung muss eindeutig sein und ggf. für mehrere Sprachen (de/en) gesetzt werden.

**Pfade (de/en):**
<code>
/modules/fc/fcTradebyteOne/application/views/admin/de/fctradebyteone_lang.php
/modules/fc/fcTradebyteOne/application/views/admin/en/fctradebyteone_lang.php
</code>

=== 12. Warum werden meine Attribute nicht exportiert ===
Für den Export der Attribute muss der jeweilige Wert in dem Feld **//Oxid2Tb attribute//** (Attribute -> Reiter "Oxid2Tb") gesetzt sein.

----

===== 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 OXID 2 Tradebyte 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/OXID-2-Tradebyte-Connector-2-0.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
Fatchip GmbH Wiki

Benutzer-Werkzeuge

Webseiten-Werkzeuge

Seiten-Werkzeuge
