Feldzuordnung
Änderungen im Mapping
Werden Zuordnungen im Mapping angepasst ist in jedem Fall eine komplette Synchronisation des geänderten Objekttyps notwendig. Wird z.B. das Mapping von Artikeln angepasst, so ist eine Komplettübertragung aller Artikel vorzunehmen.
Überblick
- Mapping-Dateien definieren die Zuordnung zwischen WinLine-Feldern und Shopware-Feldern
- Für jeden Datentyp (Artikel, Bestellungen, Kunden) existieren eigene Mapping-Dateien
- Die Dateien unterstützen sowohl JSON- als auch YAML-Format
- Über die
_overwrite-Dateien (z.B.article6_overwrite.yml) können kundenspezifische Anpassungen vorgenommen werden, ohne die Standard-Mapping-Dateien zu verändern - Im Mapping können Werte direkt übernommen, umgerechnet oder über Umsetzungstabellen transformiert werden
Workflow
Mapping anpassen:
- Die passende Mapping-Datei identifizieren (z.B.
article6_overwrite.ymlfür Artikel) - Gewünschte Feldzuordnung ergänzen oder anpassen
- Bei Bedarf eine Umsetzungstabelle im Unterordner
Umsetzungstabellen/anlegen - Komplettsync für den geänderten Datentyp durchführen (z.B. alle Artikel neu synchronisieren)
- Ergebnis im Shop oder in der WinLine prüfen
Komplettsync erforderlich
Nach jeder Änderung am Mapping ist ein Komplettsync des betroffenen Objekttyps notwendig.
Mit Hilfe der Mapping-Dateien kann die Zuordnung zwischen WinLine- und Shopware-Feldern konfiguriert werden. Für Shopware 6 werden folgende Mapping-Dateien verwendet:
article6.yml/article6_overwrite.yml- Artikel-Mappingorder6.yml/order6.json- Bestell-Mappingcustomer6.yml- Kunden-Mappingcustomer6_kontakt.yml- Kontakte-Mappingcustomer6_kontakt_exisiting.yml- Bestehende Kontakte-Mappingindex.json- Index-Datei für Mapping-Zuordnung
Die Mapping-Dateien unterstützen sowohl das JSON- als auch das YAML-Format.
Eigenschaftszuordnungen ersetzen (Shopware 6)
Mit _options.replace: true gibt ein Eigenschaftenblock den vollständigen Sollzustand
für seine Eigenschaftsgruppen am Artikel vor:
Artikel_Data:
Eigenschaften_aus_zusatzfelder:
_options:
asList: true
replace: true
properties:
- id:
env:
- from helper.helper import gen_uuid
winline: C223_Zusatzfeld23
shop: id
eval: gen_uuid(f'Stromsystem:{wl_data}')
groupId:
default: 'aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa'
shop: groupId
name:
winline: C223_Zusatzfeld23
shop: name
eval: wl_data if wl_data else 'TBA'
Die Beispiel-groupId durch die ID der Eigenschaftsgruppe aus Shopware ersetzen.
Nach erfolgreicher Übertragung werden am jeweiligen Artikel diejenigen Zuordnungen
innerhalb der gemappten groupIds entfernt, deren Options-ID nicht mehr im aktuellen
Mappingergebnis vorkommt. Dies betrifft auch manuell ergänzte Zuordnungen in diesen
Gruppen. Andere Gruppen, andere Artikel und die gemeinsamen Eigenschaftsoptionen
bleiben erhalten. Bei einem Übertragungsfehler wird vor der Bereinigung abgebrochen.
Für Varianten denselben Eigenschaftenblock unter Variant ergänzen. Die Bereinigung
berücksichtigt die children des Hauptartikels und gilt jeweils nur für die Variante,
in deren Mapping replace: true aktiviert ist. Ohne eigene Ersetzungsoption werden
die Zuordnungen einer Variante nicht bereinigt.
Die Option gilt für einen Block mit einer nicht leeren properties-Liste.
Jeder Wert benötigt eine gültige id und groupId mit 32 Hex-Zeichen.
Eine leere Mappingliste wird abgelehnt, weil daraus keine Gruppen-IDs ermittelt
werden können. replace muss ein YAML-Boolean
(true oder false, ohne Anführungszeichen) sein. Ohne die Option oder mit false
werden Zuordnungen wie bisher ergänzt. Der gezeigte Fallback erzeugt bei leeren
Zusatzfeldern weiterhin TBA.
Sind die Gruppen-IDs bereits bekannt und wird die Soll-Liste anschließend explizit
auf properties: [] gesetzt, entfernt die Bereinigung alle Zuordnungen des Artikels
innerhalb dieser Gruppen. Ein fehlendes oder ungültiges properties-Feld wird bei
aktivierter Bereinigung als Fehler behandelt.
Nach Aktivierung alle betroffenen Artikel vollständig übertragen, damit bestehende Altzuordnungen bereinigt werden.
Eigenschaftenstamm im Artikelmapping
eigenschaftenList stellt die zum Artikel gehörenden Eigenschaftenstammdaten
bereits materialisiert bereit. Direkte Iteration verwendet diese Daten ohne
weitere Datenbankabfrage:
eigenschaften = list(filter(lambda wert: wert.Parent_C001_Eigenschaftenwert == 1045, wl_data))
Bestehende SQLAlchemy-Query-Aufrufe wie wl_data.filter(...).all() bleiben
verfügbar. Beim Wechsel auf diesen dynamischen Query-Pfad wird eine
RuntimeWarning ausgegeben, da seine Auswertung eine zusätzliche
Datenbankabfrage pro Artikel verursachen kann.
Einfachste Beispiele wäre eine Direktübertragung eines Feldes der WinLine in eines im Shop (siehe EAN).
Des Weiteren ist naütlrich auch eine 1/0 Übertragung möglich, um bspw. einen aktiv/inaktiv im Shop zu generieren.
"Variant":{
"EAN":{
"shop": "ean",
"winline": "C075_EANCode"
},
"ACTIVE":{
"shop": "active",
"winline": "C038_Inaktiv",
"eval": "False if wl_data else True"
}
},
Umsetzungstabellen
Soll ein Wert im Mapping zunächst umgesetzt werden, wird eine Umsetzungstabelle im JSON format benötigt, diese muss in dem Unterordner /Umsetzungstabellen/<umsetzungsname>.json angelegt werden. Dieser Unterordner muss sich in dem Ordner des Mappings befinden.
Im Mapping kann über den Aufruf self.umsetzungstabelle('<umsetzungsname>', wl_data) ein Wert transformiert werden. Der <umsetzungsname> ist der name der Umsetzungstabelle.
In der Umsetzungstabelle wird ein Wildcard Zeichen (Default:*) unterstützt und wenn kein Match gefunden wird, wird der original Wert zurückgegeben.
NOTE: Wird ein anderes Wildcard-Zeichen benötigt, weil die Daten selber den Stern enthalten, kann der Aufruf im Mapping um den Parameter wildcard='<Zeichen>' ergänzt werden.
Die Felder __comment__<NR> werden ignoriert und dienen nur dazu Informationen über die Umsetzungen anzuhängen.
Beispiel Umsetzungstabelle:
{
"__comment__1": "3: UPS",
"Standard Versand - Zone 3": "3",
"__comment__2": "Bahnexpress",
"Express": "4",
"Standard *": "5",
"*": "6"
}
In dieser Beispiel Umsetzungstabelle werden Lieferarten umgesetzt. So wird der Wert Standard Versand - Zone 3 zu 3, alle anderen Werte die mit Standard beginnen zu 5 und wird kein Match gefunden wird der Wert 6 zurück gegeben. Ist kein Default Wert gewünscht ("*": "6") kann dieser einfach weggelassen werden und es wird der Ursprüngliche Wert zurückgegeben.