Dokumentation AntUniimex

Transkript

1 Dokumentation AntUniimex Kompatibel mit Shopware bis 4.3 Plugin-Version: Stand: Inhaltsangabe 1 Inhaltsangabe 2 Einleitung 3 Akzeptierte Dateiformate 3.1 CSV-Format 3.2 Längenspezifisches Textformat 4 Benutzeroberfläche - Allgemein 5 Konfiguration 5.1 Optionen 5.2 Rhythmus 5.3 Bezugsmodus 5.4 Zuordnung Gemeinsamkeiten der Treiber CSV Längen-spezifisches Textformat Skripting 5.5 Erweitert 5.6 Letzter Log 6 Sonstiges 6.1 Skripts (Fortgeschritten) Zuordnungsskripts Vor/Nachskripts 6.2 Cronjob einrichten 7 Vorgaben/Bespiele 7.1 Import Artikelimport Einzelne Artikel Variantenartikel Dazugehörige Bilder Preisimport LiveShopping Import Kundenimport Bestellungsexport 7.2 Skripting 7.1 Preise mit Komma durch Preise mit Punkt ersetzen Einleitung AntUniimex ist eine Abkürzung für antony Universal Import Export und befasst sich allgemein mit dem Importieren und Exportieren Shopware-relevanter Daten. Er ermöglicht es, CSV-Dateien mit Shopware-verschiedenen Spalten in das Shopware-Format umzuwandeln. Zudem kann man durch Zuordnungsskripte und Vor/Nach-Skripte Daten manipulieren und ganze Zeilen überspringen. Akzeptierte Dateiformate Akzeptiert werden das CSV-Format sowie das längenspezifische Textformat. CSV-Format Das CSV-Format trennt Spalten anhand eines konfigurierten Zeichens. Die meist verwendeten Zeichen sind das Semikolon und Komma. Beispiel-Text;19;14,95 Spalteninhalte, die dieses Trennzeichen enthalten, sollten zwischen dem sogenannten Kapselungszeichen stehen. " Beispiel-Text ; mit Semikolon ";19;14,95

2 Wenn auch dieses Kapselungszeichen innerhalb eines Spalteninhaltes vorkommt, so muss dieses durch ein Escapezeichen markiert werden. "Beispiel-Text mit vorkommenden \" Kapselungszeichen \"";19;14,95 Diese genannten Zeichen können in der Treiberkonfiguration definiert werden. Näheres zur Konfiguration erfahren sie unter dem Punkt Konfiguration > Optionen. Längenspezifisches Textformat Bei dem längenspezifischen Textformat handelt es sich um Spalten, die eine vorgegebene Größe haben. Beispiel Lieferant 19 14,95 Beispiel Lieferant ,99 Haben Spalten einen längeren Inhalt so werden diese abgeschnitten. Langer Beispiel Liefer19 14,95 Beispiel Lieferant ,99 Benutzeroberfläche - Allgemein Konfiguration hinzufügen - hiermit kann eine neue Konfiguration angelegt werden Konfigurationen importieren - ermöglicht es, eine zuvor exportierte Datei wieder zu importieren Konfigurationen exportieren - ermöglicht durch Anhaken der entsprechenden Konfigurationen diese zu exportieren und abzuspeichern 4.

3 4. 5. Konfigurationsliste - listet alle bereits angelegten Konfigurationen auf Konfigurationsdetails - dieser Bereich zeigt alle Details zu einer zuvor aus der Konfigurationsliste ausgewählten Konfiguration Konfiguration Optionen 1. CronJob aktiv - markiert diese Konfiguration für die zeitlich gesteuerte Ausführung als aktiv Cache löschen - löscht nach jedem Import den Rewrite-Cache 3. Modus - Auswahl zwischen verschiedenen Modi (derzeit möglich: Artikelimport, Kundenimport, Bestellungsexport, Preisimport, LiveShopping Import) 4. Treiber - Auswahl zwischen Dateiformaten (derzeit möglich: CSV-Datei, längenspezifische Textdatei), siehe Akzeptierte Dateiformate für nähere Informationen Name - ermöglicht es, die Konfiguration zu benennen Import Block Größe - ermöglicht das Einstellen der Blockgröße bei einem Import. Die Block Größe bestimmt wie viele Datensätze pro Import-Anfrage importiert werden. Es ist eine wichtige Einstellung, da die Anfragen auf nach einer gewissen Zeit abgebrochen werden (Timeout) und damit der Import fehlschlägt. Hat man lediglich Artikeldaten so ist der Standard von 25 ausreichend. Bei Artikelimporten mit Bildern die pro Datensatz deutlich mehr Zeit benötigen wird eine Block Größe von 5 empfohlen!

4 Standard für dieses Feld ist 25 Artikel-Kategorie-Zuordnung löschen - ermöglicht das Löschen von Artikel-Kategorie-Zuordnungen. Artikel die Kategorien zugeordnet sind werden über eine sogenannte Artikel-Kategorie-Zuordnung in der Datenbank abgebildet. Um diese Zuordnung ggf. zu löschen wurde diese Option eingebaut. Wurde "Alle vor Import gewählt", so werden vor jedem Datensatz alle Zuordnungen gelöscht und während des Imports ggf. Neue angelegt. Ist "Keine Option" gewählt so bleiben diese Zuordnungen bestehen und Neue Kategorien werden hinzugefügt. Mit Kopfzeile im Export - definiert, ob bei einem Export die Kopfzeile (mit Spaltennamen) ausgegeben werden soll Timeout Download/Import/PostProcess - definiert den Timeout für das Backend Framework ExtJS und zeitkritische Abfragen. Standardwert ist ms (30 Sekunden). Während eines Downloads (bei Importen), beim Importieren selber und beim Nachbearbeiten des Imports (PostProcess), kann es passieren, das die jeweilige Abfrage den Timeout erreicht und abbricht. Um dies zu verhindern, kann man für diese Optionen den Timeout erhöhen. Zu beachten ist, dass dies nur eine Möglichkeit ist die Abfragedauer zu erhöhen, dies ist unter anderem von weiteren Servereinstellungen abhängig auf die wir keinen Einfluss haben können. Treiberkonfiguration - je nach ausgewähltem Treiber gibt es hier die Möglichkeit diesen näher zu konfigurieren. Bisher kann man nur den CSV-Treiber konfigurieren Rhythmus Im Rhythmus-Tab kann der Cronjob näher eingestellt werden. Durch Angabe eines Start- und Enddatums kann der Zeitraum bestimmt werden, wogegen durch Wochentag, Monat, Tag, Stunde, Minute der Zeitpunkt innerhalb des Zeitraums definiert werden kann!

5 Startdatum - Definiert das Startdatum ab dem der CronJob ausgeführt werden soll Enddatum - Definiert das Datum bis zu dem der CronJob ausgeführt werden soll Wochentag - Definiert die Wochentage an dem der CronJob ausgeführt werden soll Monat - Definiert die Monate an dem der CronJob ausgeführt werden soll Tag - Definiert die Tage an dem der CronJob ausgeführt werden soll Stunde - Definiert die Stunden an dem der CronJob ausgeführt werden soll Minute - Definiert die Minuten an dem der CronJob ausgeführt werden soll Es ist möglich durch drücken der STRG-Taste mehrere Felder bei Wochentag, Monat, Tag, Stunde und Minute auszuwählen! Bezugsmodus Unter diesem Tab ist es möglich den Bezugsmodus einzustellen. Dies bedeutet, dass man eine Auswahl aus mehreren Modis hat von denen man eine Import-Datei beziehen möchte bzw. beim Export speichern. Der Upload/Download ist eine Ausnahme, diesen kann man nur manuell bedienen, da man beim Import die Datei angeben bzw. beim Export speichern muss. 1. Modus - Bestimmt von welchem Ort das Plugin die Datei bei einem Import beziehen soll oder wo die Datei bei einem Export gespeichert wird a.

6 a. Upload/Download - nur für den manuellen Gebrauch bestimmt. Ermöglicht es, beim Ausführen der Konfiguration eine Datei anzugeben oder bei einem Export diese zu downloaden FTP - bezieht oder speichert die Datei am angegebenen FTP-Ort Dateisystem - bezieht oder speichert die Datei vom Server auf dem die Shopware Installation läuft b. c. FTP-Host - definiert den Host des FTP-Servers (Beispiel: "import-host.de") FTP-Port - definiert den Port des FTP-Servers (Beispiel: "21") FTP-Benutzername - definiert den Benutzernamen des FTP-Servers FTP-Passwort - definiert das Passwort des FTP-Benutzers FTP-Dateipfad - definiert den kompletten Dateipfad vom Benutzer-Root aus. (Beispiel: "/shop/data/import/article.csv") Dateipfad - definiert den kompletten absoluten Pfad zur Datei. (Beispiel: "/var/www/shopware/htdocs/article.csv") Zu Beachten ist die "open_basedir"-einstellung der PHP-Installation. Es ist unter anderem auch möglich eine URL zu einer Datei in diesem Feld anzugeben! Zuordnung Die Aufgabe der Zuordnungen ist es, Spalten aus der Datei den Spalten von Shopware zuzuordnen. Die Quelle-Spaltennamen orientieren sich an dem Namen der Spalte, welche in der Kopfzeile der Import-Datei angegeben ist. Beim Ziel-Spaltennamen handelt es sich vom Namen her um Shopware-Felder, welche durch von uns ergänzte Felder erweitert wurden (Bsp. Artikelimport mit Bildern). Bei einem Export ist das Ziel die Shopware-Felder von der die Daten kommen, bei der Quelle können Sie angeben wie das Feld innerhalb der Export-Datei benannt werden soll. (Wird nur angezeigt, wenn im Optionen-Tab die Option "Mit Kopfzeile im Export" angehakt ist) Gemeinsamkeiten der Treiber CSV Zuordnung hinzufügen - Fügt eine leere Zuordnung zur Zuordnungsliste hinzu Sortieren - ermöglicht es, Zuordnungen zu sortieren Zuordnungsskript bearbeiten - öffnet ein Fenster mit einem kleinen Editor in dem ein Zuordnungsskript hinterlegt werden kann Zuordnung löschen - löscht eine Zuordnung 1. Quelle - Quelle ist die Spalte innerhalb der Datei Ziel - ist die Spalte von Shopware der die Quelle zugeordnet werden soll Längen-spezifisches Textformat

7 Skripting Quelle - dient hier zum Benennen der Spalte, um für sie die Übersicht zu gewähren; zudem ermöglicht es bei Skripts über das Array $orgdata den Originalwert zu ermitteln. Von Index - definiert ab welchem Zeichen einer Zeile die Spalte beginnen soll Bis Index - definiert bis zu welchem Zeichen einer Zeile die Spalte gehen soll Ziel - ist die Spalte von Shopware welcher der Wert, der zwischen Von Index und Bis Index ausgeschnitten wird, zugeordnet wird. Anzusprechen auch hier via $data in den Zuordnungsskripts Zeilennummer anzeigen - wenn diese Option aktiviert ist werden im Editorfeld vor jeder Zeile die Zeilennummern angezeigt Skript ausführen - ermöglicht es, das im Editorfeld geschriebene Skript auf syntaktische Korrektheit zu prüfen und dient dazu kleinere Abschnitte zu testen indem vorher Testdaten definiert werden Editorfeld - enthält ihr Skript, welches Sie dieser Zuordnung zuweisen wollen Speichern - speichert das von Ihnen im Editorfeld geschriebene Skript Abbrechen - bricht den aktuellen Vorgang ab. Änderungen werden verworfen Nähere Informationen finden Sie unter Vor/Nachskripts Erweitert

8 1. Zeilennummer anzeigen - wenn diese Option aktiviert ist werden im Editorfeld vor jeder Zeile die Zeilennummern angezeigt Skript Davor / Editorfeld - in diesem Feld können Sie ein Skript hinterlegen, welches vor jeder Importzeile ausgeführt wird 3. Skript Danach / Editorfeld - in diesem Feld können Sie ein Skript hinterlegen, welches nach jeder Importzeile ausgeführt wird Letzter Log

9 In diesem Feld wird zum zuletzt ausgeführten Zeitpunkt ein Ereignislog angezeigt. Er enthält eine allgemeine Übersicht darüber, wie viele Zeilen hinzugefügt, bearbeitet, übersprungen und fehlerhaft sind. Darunter befindet sich eine Übersicht der Fehler. Angegeben sind die Von / Bis Werte, die definieren, in welchem Import-Block dies stattgefunden hat, eine Identifikationsnummer (bei Artikeln die Artikelnummer) und der dazugehörige Fehler. Sonstiges Skripts (Fortgeschritten) Zuordnungsskripts In den Zuordnungskripts lassen sich mittels PHP undter anderem Skripts realisieren, die Daten umstrukturieren, Felder bei gewissen Bedingungen anlegen oder anders setzen. Zur Verfügung stehen folgende Arrays: $orgdata - enthält alle originalen Daten aus der Datei. Diese sind nach deren Spaltennamen benannt! $data - enthält die zugeordneten Felder (anhand der Zuordnungsliste). Die Benennung geht aus der Spalte "Ziel" in der Zuordnungsliste hervor. Dieses Array enthält alle Daten, welche später importiert werden sollen.

10 Beispiel: Feld in der CSV: Artikelnummer Shopware-Feld: ordernumber Mit $orgdata["artikelnummer"] und $data["ordernumber"] können nun Originalwerte abgefragt, ausgewertet und verändert abgespeichert werden! Vor/Nachskripts Zur Verfügung steht bei dieser Art von Skripts das Array $item. Es enthält Werte, welche durch den Namen des Ziels aus der Zuordnungsliste benannt sind. Als Zusatzfunktion gibt es beim Skript, das davor ausgeführt wird, die Variable $doimport. Diese lässt sich mit den Werten true (Datensatz wird importiert) bzw. false (Datensatz wird übersprungen) beschreiben. Standardwert ist true! Cronjob einrichten Lesen Sie sich dazu folgenden Artikel des Shopware-Wikipedias durch. -> Vorgaben/Bespiele Import Artikelimport Einzelne Artikel Pflichtfelder ordernumber - Artikelnummer name - Artikelname price - Preis des Artikels supplier - Hersteller des Artikels Die Mehrwertsteuer (tax) hat 19 als Standardwert und ist somit nicht zwingend notwendig! Zudem können alle üblichen Felder von Shopware importiert werden! Variantenartikel Pflichtfelder ordernumber - Artikelnummer mainnumber - Artikelnummer des Hauptartikels name - Artikelname price - Preis des Artikels supplier - Hersteller des Artikels configuratorsetid - muss gesetzt sein - Wert ist unerheblich (Bsp.: "1") configuratortype - gibt die Art des Konfigurators an (0 = Standard, 1 = Auswahl, 2 = Tabelle) configuratoroptions - gibt Optionen an. Beispiel: "Größe:XL Farbe:blau" Mehrere Optionen werden durch eine sogenannte Pipe " " getrennt, Optionsname und Optionswert jeweils durch einen Doppelpunkt! Die Konfigurator-Optionen können auch durch Zuordnungsskripts aus anderen Formaten/mehreren Spalten erzeugt werden. Empfohlene Felder additionaltext - Zusätzlicher Text des Variantenartikels Dazugehörige Bilder

11 Pflichtfelder images imagemain imageposition imagedescription Die genannten Felder sind zusätzlich zu den Pflichtfeldern für einzelne Artikel bzw. Variantenartikel zu sehen! Bilder werden grundsätzlich im Feld images angegeben. Mehrere werden hierbei durch eine Pipe " " getrennt. Anzugeben ist hier die komplette URL bzw. der komplette Pfad zum Bild! Im Feld imagemain wird nochmals die URL des Bildes eingetragen, welches als Vorschaubild dienen soll. Das Feld imageposition definiert die Positionen der Bilder in der Reihenfolge, in der sie auch im Feld images angegeben sind. Mehrere Angaben werden durch eine Pipe " " getrennt. Bilder müssen von 0 aufwärts nummeriert werden, damit die Reihenfolge korrekt übernommen wird! Beispiel: "1 3 2" - hierbei bekommt das erste Bild die Position 1, das zweite Bild die Position 3 und das dritte Bild die Position Im Feld imagedescription können Sie eine Bildbeschreibung für jedes Bild wiederum getrennt durch eine Pipe " " angeben. Beispiel: "Beschreibung Bild 1 Beschreibung Bild 2 Beschreibung Bild 3" Die Anzahl von Positionen und Beschreibungen muss der Anzahl der Bilder übereinstimmen! Preisimport Pflichtfelder: ordernumber tax Dynamische Felder: price pseudoprice baseprice percent from Alle dynamischen Felder sind mit einer Angabe zur Kundengruppe zu versehen. Beispiele: price_ek, pseudoprice_h So lassen sich spezifisch für jede Kundengruppe die verschiedenen Preise definieren. Mit dem Feld from lassen sich zudem Staffelpreise realisieren. Hierbei müssen die Datensätze in aufsteigender Reihenfolge des Feldes from ang eordnet sein. LiveShopping Import Pflichtfelder: ordernumber - Artikelnummer des Artikels für den das LiveShopping angelegt werden soll ordernumber_ls - Artikelnummer unter der der LiveShopping-Artikel verfügbar sein wird valid_from - Zeitpunkt ab dem das LiveShopping gültig ist. Format: YYYY-MM-DD HH:MM valid_to - Zeitpunkt bis zu dem das LiveShopping gültig ist. Format: YYYY-MM-DD HH:MM Optionale Felder: name - Name des LiveShoppings. Standard: "LiveShopping {ordernumber_ls}" type - Typ des LiveShoppings. 1 = Standard, 2 = Rabatt pro Minute, 3 = Aufpreis pro Minute. Standard: 1 sells - Initialer Lagerbestand max_quantity - Aktueller Lagerbestand max_quantity_enable - Limitierter Bestand. 1 = limitiert, 2 = nicht limitiert customergroups - Kundengruppen für die das LiveShopping gelten soll. Format besteht aus den Kundengruppenkürzeln getrennt durch Pipes " ". Beispiel: "EK H" ordernumber_variants - Limitierung auf Varianten. Anzugeben ist die Artikelnummer getrennt durch Pipes " ". Beispiel:" SW SW " shop_ids - IDs der Subshops für die das LiveShopping gelten soll getrennt durch Pipes " ". Beispiel: "1 2" price_x - Startpreis des Artikels. X steht für das Kundengruppenkürzel

12 endprice_x - Endpreis des Artikels. X steht für das Kundengruppenkürzel is_net - Angabe ob Preisangaben Brutto oder Netto sind. 1 = Netto, 0 = Brutto Kundenimport Pflichtfelder: oder customernumber (zur Identifikation eines Kunden) Alle weiteren Felder finden Sie im folgenden Artikel des Shopware-Wikipedia: -> Bestellungsexport Eine Auflistung aller möglichen Felder finden Sie im folgenden Artikel des Shopware-Wikipedia: -> Alle Felder die exportiert werden sollen müssen auch in den Zuordnungen hinterlegt werden. Hierbei ist zu beachten, dass das Ziel die Shopware-Felder sind und die Quelle das Feld in der Export-Datei. Zuordnungsskripts können ebenfalls hinterlegt werden! Derzeit gibt es nur die Möglichkeit, alle Bestellung zu exportieren. Eine Weiterentwicklung wurde vorgemerkt! Skripting Preise mit Komma durch Preise mit Punkt ersetzen Nehmen wir an, dass das Preisfeld in der Datei "Preis" heißt und dieses verändert in das Shopware-Feld "price" geschrieben werden soll, so wird mit folgender Zeile das Komma durch einen Punkt ersetzt. Komma durch Punkt setzen $data["price"] = str_replace(",", ".", $orgdata["preis"]);