|
|
| (122 dazwischenliegende Versionen von 3 Benutzern werden nicht angezeigt) |
| Zeile 1: |
Zeile 1: |
| {{Kostenpflichtige Module}}
| | #WEITERLEITUNG [[OBS/Stammdaten/Schnittstellen/Internet-Shop/brShop24]] |
| {{Achtung|Für die Verwendung der Schnittstelle sollten Sie mindestens die '''OBS-Version 003585''' haben. Aufgrund einiger Einschränkungen in der API, wird von OBS noch nicht der vollständige Funktionsumfang wie im VShop4 geboten. Bitte beachten Sie außerdem den Punkt [[#Bekannte_Probleme|Bekannte Probleme]] unter [[#Funktionsumfang|Funktionsumfang]].}}
| |
| Der brShop24 wird von der Genossenschaft [https://www.bueroring.de Büroring eG] entwickelt und angeboten. Diese ECommerce-Lösung soll langfristig den bisher angebotenen VShop 4 Pro ablösen. Für die Anbindung an den brShop24 steht Ihnen eine Schnittstelle basierend auf [https://de.wikipedia.org/wiki/GraphQL GraphQL] zur Verfügung.
| |
| {{Achtung|Für die Preisübertragung wird das kostenpflichtige Modul [[OBS/Kostenpflichtige_Module/Preislisten|Preislisten]] vorausgesetzt!}}
| |
| {{Achtung|Die Schnittstellen für VShop 4 Pro und brShop24 sind nicht kompatibel! Sollten Sie sich also für eine Umstellung Ihres VShop 4 Pro auf den das neue System brShop24 entscheiden, so muss dies im OBS ebenfalls umgestellt werden!<br/>Siehe auch die Punkte [[#Umstellung.2FMigration_VShop_4|Umstellung/Migration VShop 4]] und [[#faq_brshop24_allg_parallelbetrieb|FAQ Parallelbetrieb]].}}
| |
| =Funktionsumfang=
| |
| {{Achtung|Die hier aufgeführten Funktionen sind unter Vorbehalt in der aktuellen Version von OBS enthalten, da sich die Funktionalitäten in API und OBS noch ändern können.}}
| |
| Diese Schnittstelle unterstützt den Im- und Export von Daten wie folgt:
| |
| {| class="wikitable"
| |
| |-
| |
| ! Import!! Export
| |
| |-
| |
| | Auftragsimport (OpenTRANS 1.0)|| Preislisten
| |
| |-
| |
| | Depots + Partner|| Kundengruppen
| |
| |-
| |
| | Anreden|| Personen/Ansprechpartner/Kostenstellen
| |
| |-
| |
| | Kundentypen|| Shopping-Listen (Meistgekaufte Artikel/Top-Artikel)
| |
| |-
| |
| | Kundenqualifikation||
| |
| |-
| |
| | Job-Informationen (Ergebnis/Protokoll Preispflege)||
| |
| |-
| |
| | Kundengruppen (Migration)||
| |
| |-
| |
| | Benutzer (Migration)||
| |
| |}
| |
| {{Hinweis|Zu Beginn wird es nur Bestelldateien im Format OpenTRANS 1.0 geben. Das neuere Format 2.1 ist aber bereits eingeplant und soll zu einem späteren Zeitpunkt folgen.}}
| |
| ==Bekannte Probleme==
| |
| {{Hinweis|Die hier aufgeführten Probleme sollen einen Überblick zum Stand einzelner Funktionen geben, sollten Sie sich dazu entscheiden mit der Schnittstelle zu arbeiten.}}
| |
| ===Import Bestellungen===
| |
| *;eindeutige Identifikation von Artikeln
| |
| :Nach aktuellem Stand wird nur der aktuelle Katalog von Büroring eingespielt. Sollten jedoch auch von anderen Lieferanten Artikel im Shop verkauft werden, kann es bei den Artikelnummern zu "doppelten" Artikeln kommen. Derzeit fehlt noch die Möglichkeit dies beim Import unterscheiden zu können.
| |
| | |
| ===Personen===
| |
| *;Einfügen neuer Kundengruppen
| |
| :Die Datensätze werden im OBS nicht korrekt angelegt und können daher nicht exportiert werden.
| |
| *;Anzeige Webshop-Einstellungen
| |
| :Die Anzeige des Kundenstatus funktioniert aktuell nur, wenn die Kundennummer auch in einer Kundengruppe steht.
| |
| *;Export Kostenstellen Budgets
| |
| :Die Budgetverwaltung wurde bisher noch nicht im brShop24 umgesetzt und steht daher auch in der API noch nicht zur Verfügung.
| |
| | |
| ===Bestellvorlagen/Shoppinglisten===
| |
| *;Anzeige im Shop
| |
| :Nach aktuellem Stand können die Bestellvorlagen, die es auch schon für den VShop 4 exportiert werden konnten, in den brShop24 übertragen werden. Die Anzeige im Frontend (Ansicht für den Kunden) ist jedoch noch nicht umgesetzt. Sie können aktuell nur über den Admibereich prüfen, ob die Bestellvorlagen im Shop angekommen sind.
| |
| | |
| =Menü=
| |
| | |
| {{Vorlage:KlapptextFAQ
| |
| |menu_b
| |
| |B Preislisten verwalten
| |
| |Öffnet die [[Kostenpflichtige_Module/Internet-Shop/brShop24/Preise_übertragen#Preislisten_verwalten|Preislistenverwaltung der Schnittstelle]].
| |
| }}
| |
| | |
| {{Vorlage:KlapptextFAQ
| |
| |menu_f
| |
| |F Kundengruppen
| |
| |Öffnet die [[Kostenpflichtige_Module/Internet-Shop/brShop24/Kundengruppen_verwalten|Kundengruppenverwaltung der Schnittstelle]].
| |
| }}
| |
| | |
| {{Vorlage:KlapptextFAQ
| |
| |menu_i
| |
| |I Bestellvorlagen verwalten
| |
| |Öffnet die [[Kostenpflichtige_Module/Internet-Shop/brShop24/Shoppinglisten_übertragen|Shoplistenverwaltung der Schnittstelle]].
| |
| }}
| |
| | |
| {{Vorlage:KlapptextFAQ
| |
| |menu_m
| |
| |M Migration
| |
| |Startet die [[#Migration_im_OBS|Migration]] der Daten. Dabei werden die aktuellen Kudnendaten (Gruppen und Benutzer) eingelesen und im Personestamm, sofern automatisiert möglich, Webshop-Einstellungen angelegt und Ansprechpartner zugeordnet.
| |
| }}
| |
| | |
| {{Vorlage:KlapptextFAQ
| |
| |menu_t
| |
| |T Jobinformationen einlesen
| |
| |Die Jobinformationen sind ein Protokoll des Shops für die Preispflege-Jobs. Diese werden beim Exportieren der Preise angelegt. Beim Einlesen der Jobinformationen werden aufgetretene Fehler verarbeitet. Entsprechende Informationen finden Sie nach dem Import im Shop-Protokoll (Menüpunkt Z).
| |
| }}
| |
| | |
| {{Vorlage:KlapptextFAQ
| |
| |menu_u
| |
| |U Bestellungen einlesen
| |
| |Liest die vorhanden Bestelldateien aus dem Shop-Verzeichnis ein. Für den automatischen Import siehe [[Kostenpflichtige_Module/Internet-Shop/Einrichtung/Automatiken#Bestellungen_einlesen|Automatiken: Bestellungen einlesen]].
| |
| }}
| |
| | |
| {{Vorlage:KlapptextFAQ
| |
| |menu_w
| |
| |W Definitionen importieren
| |
| |Über diesen Menüpunkt können Sie alle für OBS-Relevanten Definitionen zur Vorbereitung der Datenexporte importieren. Dies umfasst aktuell folgende Definitionen:
| |
| *[[Kostenpflichtige_Module/Internet-Shop/Konfiguration/Zuordnungen/DepotPartner|Depots/Lager mit Partner]]
| |
| *[[Kostenpflichtige_Module/Internet-Shop/Konfiguration/Zuordnungen/Anreden#brShop24|Anreden]]
| |
| *Kundentypen (u. a. B2B, B2C)
| |
| *Kundenqualifikation (u. a. neuer Kunden, Stammkunde)
| |
| Für den automatischen Import siehe [[Kostenpflichtige_Module/Internet-Shop/Einrichtung/Automatiken#Definitionen_importieren|Automatiken: Definitionen importieren]].
| |
| {{Hinweis|Diese Definitionen spielen an verschiedenen Stellen eine wichtige Rolle. Sollten Sie die Definitionen noch nicht importiert und vor einem Datenexport zugeordnet haben, funktionert entweder der Datenexport nicht oder es werden Standardwerte verwendet.}}
| |
| }}
| |
| | |
| {{Vorlage:KlapptextFAQ
| |
| |menu_x
| |
| |X Konfiguration
| |
| |Öffnet die [[OBS/Stammdaten/Schnittstellen/Internet-Shop/Konfiguration|Konfiguration]] der Schnittstellen. Hier können die Einstellungen der Schnittstelle angepasst werden.{{Hinweis|Um Anpassungen vorzunehmen wird für die meisten Einstellungen ein Level von 3 oder 5 benötigt. Es ist möglich dieses Level anzupassen, auch kann ein Benutzer für die Schnittstelle ein abweichendes Benutzerlevel erhalten. Melden Sie sich bei Bedarf per [[OBS/System/Ticket-System|OBS Ticketsystem]] beim OBS-Support.}}
| |
| }}
| |
| | |
| {{Vorlage:KlapptextFAQ
| |
| |menu_y
| |
| |Y Testumgebung
| |
| |Öffnet eine Testumgebung, um die Anbindung zu testen.
| |
| }}
| |
| | |
| {{Vorlage:KlapptextFAQ
| |
| |menu_z
| |
| |Z Protokoll
| |
| |Über den Menüpunkt ''Z Protokoll'' des Shops-Menüs erhalten Sie Zugriff auf das Shop-Protokoll. Es werden vorrangig Hinweise zu Fehlern oder Problemen bei Im- und Exporten protokolliert. Über die Konfiguration kann mit Aktivierung des Debugmodus (Schlüssel ''Shop.Debug'') eine erweiterte Protokollierung aktiviert werden. Dafür benötigt ein Benutzer jedoch Administrationsrechte (Level 9) für die Schnittstelle.
| |
| }}
| |
| | |
| =Erklärungen/Funktionen=
| |
| *[[Kostenpflichtige_Module/Internet-Shop/brShop24/Kundengruppen_verwalten|Kundengruppen verwalten]]
| |
| *[[Kostenpflichtige_Module/Internet-Shop/brShop24/Personen_übertragen|Kunden übertragen]]
| |
| *[[Kostenpflichtige_Module/Internet-Shop/brShop24/Preise_übertragen|Preise übertragen]]
| |
| *[[Kostenpflichtige_Module/Internet-Shop/brShop24/Shoppinglisten_übertragen|Shoppinglisten übertragen (z. B. Bestellvorlagen)]]
| |
| | |
| =Installation/Einrichtung=
| |
| Eine neue Schnittstelle muss vom Support freigegeben werden. Fragen Sie dies am besten per [[OBS/System/Ticket-System|OBS Ticketsystem]] an.
| |
| {{Hinweis|Die vollständige Einrichtung kann ebenfalls vom Support übernommen werden. Dies wird dann jedoch nach Aufwand berechnet (in der Regel zwischen 15 und 30 Minuten). Teilen Sie uns dazu die Daten für die Anbindung (siehe unten) und die gewünschten Automatiken mit.}}
| |
| ==Kommunikation mit dem Shop==
| |
| Die Anbindung erfolgt über [https://de.wikipedia.org/wiki/GraphQL GraphQL]. Um mit Ihrem Shop kommunizieren zu können, '''benötigen''' Sie die '''[https://de.wikipedia.org/wiki/Uniform_Resource_Locator URL] zu Ihrem Shop''' und folgende '''[https://de.wikipedia.org/wiki/OAuth OAuth2]-Zugangsdaten''':
| |
| *Access Token URL
| |
| *Client ID
| |
| *Client Secret
| |
| Tragen Sie die Daten in den Einstellungen der Schnittstelle ein. Zu den Schnittstellen gelanden Sie über das Menü '''Stammdaten'''. Wählen sie dort unter '''I Schnittstellen''' den Punkt '''I Internet-Shop'''. Gehe Sie auf die Schnittstelle und drücken {{F10}} um das Shop-Menü zu öffnen. Die Einstellungen rufen Sie mit '''X Konfiguration''' auf. Die Daten müssen in folgende Einstellungen eingetragen werden:
| |
| *Shop.URL: Ihre Shop-URL (z. B. <nowiki>https://meinshop.brshop24.de</nowiki>)
| |
| *OAuth2.ClientId
| |
| *OAuth2.ClientSecret
| |
| *OAuth2.TokenEndpoint (z. B. <nowiki>https://oauth.brshop24.de/token</nowiki>)
| |
| {{Hinweis|Mit der Einstellung '''Shop.Aktiv''' lässt sich eine Schnittstelle deaktivieren. Falls die Daten für die Kommunkation richtig sind, prüfen Sie, ob diese Einstellung auf "J" (aktiv; "N" für inaktiv) steht.}}
| |
| | |
| ==Abholung und Import Aufträge==
| |
| Die Aufträge generiert OBS aus XML-Dateien im OpenTRANS-Format. Die Dateien können vom Büroring per FTP oder E-Mail bereitgestellt werden. Abhängig von der gewählten Methode muss im OBS entweder die automatische Abholung vom FTP oder das E-Mail-Konto eingerichtet sein. Ist dies nicht der Fall, werden ebenfalls die entsprechenden Zugangsdaten benötigt. Die Dateien sind in der Verzeichnisstruktur von OBS unter '''..\data\shop\<Schnittstelle-Nr.>\xml''' zu speichern.<br />
| |
| ===Abholung===
| |
| {{Vorlage:KlapptextFAQ
| |
| |abholung_ftp
| |
| |Abholung per FTP
| |
| |Für die Einrichtung benötigen Sie mindestens die Host-URL oder IP des FTP-Servers sowie Benutzername und Passwort. Wie Sie einen FTP-Job einrichten erfahren Sie auf unserer Wiki-Seite [[OBS/Zusatzprogramme/FTP_Jobliste|''FTP Jobliste'']].<br />
| |
| {{Hinweis|Soweit bekannt ist, wird für den Shop der gleiche FTP-Server verwendet, der auch für den Austausch der Bestellungen und Lieferavisen verwendet wird. Damit hier keine falschen Dateien abgeholt werden, sollte in ''Source-File'' mit einem Prefix gearbeitet werden. Bisher wird den Dateien des brShop24 der Prefix '''order-be-''' gegeben.}}
| |
| }}
| |
| {{Vorlage:KlapptextFAQ
| |
| |abholung_email
| |
| |Abholung per E-Mail
| |
| |Für den Empfang von Dateien per E-Mail muss das Konto im OBs eingerichtet sein und eine Filter-Regel für das Speichern des Anhangs in einem Verzeichnis ("Anhang speichern unter") eingerichtet werden.
| |
| *[[OBS/Stammdaten/Weitere_Stammdaten/E-Mail_Konten|Einrichten eines E-Mail-Kontos]]
| |
| *[[OBS/Stammdaten/E-Mail/Regeln|Filter-Regel einrichten]]
| |
| }}
| |
| | |
| ===Import===
| |
| Nutzen Sie dazu unsere [[Kostenpflichtige_Module/Internet-Shop/Einrichtung/Automatiken|'''Hilfe-Seite für Shop-Automatiken''']]. Der Import von Bestellungen erfolgt mit [[Kostenpflichtige_Module/Internet-Shop/Einrichtung/Automatiken#Bestellungen_einlesen|'''ShopGetBestellungen''']].
| |
| | |
| ==weitere Automatiken==
| |
| Eine Übersicht aller verfügbaren Automatiken finden Sie auf der entsrepchenden [[Kostenpflichtige_Module/Internet-Shop/Einrichtung/Automatiken|Hilfe-Seite für Shop-Automatiken]].{{Hinweis|Achten Sie darauf, dass '''brShop24''' in der Angabe ''Verfügbar in'' enthalten ist!}}
| |
| <br />
| |
| Die Einrichtung der '''automatischen Preispflege''' wird '''empfohlen''', '''wenn''' Sie ebenfalls die '''automatische Artikelpflege''' nutzen und Preise sich täglich ändern können.
| |
| | |
| ==Zuordnungen==
| |
| Für manche Funktionen der Schnittstelle werden zusätzliche Zuordnungen für bestimmte Daten benötigt. Die Zuordnung finden Sie in der Konfiguration unter {{F8}}. Folgende Punkte finden Sie derzeit dort:
| |
| *[[Kostenpflichtige_Module/Internet-Shop/Konfiguration/Zuordnungen/Anreden#brShop24|A Anreden]]
| |
| :Die Einstellungen für "Anreden" werden für den Export von Personen benötigt.
| |
| *[[Kostenpflichtige_Module/Internet-Shop/Konfiguration/Zuordnungen/DepotPartner|L Lager und Lagerlieferanten]]
| |
| :Die Einstellungen für "Depot" und "Partner" werden für den Export von Preisen und Artikel benötigt.
| |
| ==Mit der Schnittstelle Starten==
| |
| Sofern die Einrichtung abgeschlossen ist, empfehlen wir als erstes eine Datenmigration durchzuführen (siehe auch [[#Umstellung.2FMigration_VShop_4|Umstellung/Migration VShop 4]]). Dabei werden die vom VShop 4 migrierten Daten aus dem Shop ausgelesen und in OBS importiert. OBS versucht die importierten Daten anschließend mit den Stammdaten zu verknüpfen und erstellt für die Kunden die Webshop-Einstellungen und gibt die Ansprechpartner frei.
| |
| {{Achtung|Die Zuordnung läuft automatisiert und kann einige Minuten in Anspruch nehmen! Sollte der Vorgang abbrechen, können Sie die Migration erneut starten. Die Zuordnung erfolgt nur für Daten, die eindeutig identifiziert werden konnten!}}
| |
| <br />
| |
| Außerdem werden die Preislisten aus den im Shop vorhandenen Preislisten ermittelt und für die Schnittstelle freigegeben.
| |
| {{Achtung|Wir empfehlen die Preisdaten nach der Migration einmal vollständig zu exportieren. Da die Daten nicht verknüpft werden können, sollte danach beim Büroring darum gebeten werden die alten Preislisten aus dem Shop zu entfernen. Welche Preislisten OBS exportiert hat, sehen Sie in der [[Kostenpflichtige_Module/Internet-Shop/brShop24/Preise_übertragen#Shop-Men.C3.BC:_Preislisten_verwalten|Preislisten-Verwaltung der Schnittstelle]] (Shop-Menü: B Preislisten verwalten).}}
| |
| | |
| =Umstellung/Migration VShop 4=
| |
| Nach aktuellem Stand wird für Kunden mit VShop 4 vom Büroring eine Migration des bestehenden VShop 4 auf den neuen brShop24 durchgeführt. Dabei soll auch gewählt werden können, welche Daten bei der Migration übernommen werden. Wie dies genau aussieht, müssen Sie jedoch mit dem Büroring klären. Es gibt jedoch auch einige Punkte, die Sie beid er Migration für die Umstellung im OBS bedenken müssen.
| |
| *;Neue API
| |
| :Im Unterschied zum VShop 4 läuft die Schnittstelle zum brShop24 über eine API. OBS dies bringt ein paar Einschränkungen für die migrierten Daten mit sich. Es ist OBS nicht möglich die Daten wiederzufinden, die von OBS zuvor in den VShop 4 übertragen wurden. Wie sich dies auf die Pflege von Daten auswirkt, muss noch in Erfahrung gebracht werden, da im Testsystem keine migrierten Daten zur Verfügung stehen.
| |
| *;Besonderheit Preisdaten
| |
| :OBS arbeitet in Schnittstelle über eine sogenannte API-ID, also eine Identifikationsnnummer speziell für die neue API. OBS kann nur Preisdaten verändern, die auch über die API in den Shop übertragen wurden. Wir empfehlen daher die Preisdaten möglichst über OBS zu pflegen und nicht migrieren zu lassen.
| |
| *;Schnittstelle im OBS
| |
| :Die Schnittstelle muss im OBS freigeschaltet und eingerichtet werden (siehe dazu [[#Installation.2FEinrichtung|Installation/Einrichtung]]). Dies kann bereits vor der Migration geschehen. Bedenken Sie jedoch, dass die Aufträge erst importiert werden können, nachdem die Schnittstelle eingerichtet wurde. Gebe Sie uns also rechtzeitig Bescheid, damit wir die Schnittstelle freigeben können. Die Einrichtung kann auf Wunsch von uns kostenpflichtig übernommen werden.
| |
| *;Modul Preislisten
| |
| :Für den brShop24 wird das Modul [[OBS/Kostenpflichtige_Module/Preislisten|Preislisten]] für die Pflege von Preisen über die Schnittstelle vorrausgesetzt. Sollten Sie dieses Modul noch nicht nutzen, so müsste dies zuvor eingerichtet werden, wenn Sie Preise aus OBS in den Shop übertragen möchten. Die Einrichtung des Moduls kann mehrere Stunden in Anspruch nehmen. Wir empfehlen die Umstellung vor der Migration durchzuführen, da dies die Arbeitsweise mit Artikelpreisen verändert. Eine Schulung wird ebenfalls empfohlen.
| |
| *;Migration Freigaben OBS VShop 4 nach brShop24
| |
| :Über das Shop-Menü können Kundengruppen und Benutzer mit dem OBS-Personenstamm abgeglichen werden. Im Personenstamm werden dann für gefundene Datensätze Webshop-Einstelungen angelegt. Ansprechpartnern, welchen ein Benutzer eindeutig zugeordnet werden konnten, erhalten die Eigenschaft9013 und die Zuordnung zur Schnittstelle. Sollte die eindeutige Zuordnung ohne Benutzername erfolgt sein, so wird auch der Benutzername im Ansprechpartner hinterlegt.{{Hinweis|Es ist nicht möglich die Passwörter auszulesen. Diese können also nicht im Ansprechpartner hinterlegt werden. Sollten Sie zu einem späteren Zeitpunkt die den Benutzer im Shop aktualisieren wollen, müssten diesen zuvor ein Passwort gegeben werden, sollte noch keines vorhanden sein.}}
| |
| | |
| =Häufig gestellte Fragen (FAQ)=
| |
| ==Migration VShop4==
| |
| {{Vorlage:KlapptextFAQ
| |
| |faq_brshop24_allg_parallelbetrieb
| |
| |Können im OBS brShop24 und VShop4 parallel betrieben werden?
| |
| |Ja, es ist mögliche beide Shops im OBS zu verwalten. OBS ist in der Lage mehrere Schnittstellen, auch des gleichen Typs, zu verwalten. Die Schnittstellen arbeiten unabhängig voneinander. Nach unseren Informationen ist ein Parallelbetrieb seitens Büroring jedoch nicht gewünscht, da die Daten des VShop 4 nachträglich nicht oder nur mit deutlich größerem Aufwand in den brShop24 migriert werden könnten. Eventuell gehen Ihnen hier also Daten verloren, wenn der VShop4 abgeschaltet wird. Der brShop24 würde nach der Migration also Ihren aktuellen VShop 4 ersetzen. Bei Fragen zu dem Thema wenden Sie sich bitte an den Support des Büroring.
| |
| }}
| |
| | |
| ==Preise/Preislisten==
| |
| {{Vorlage:KlapptextFAQ
| |
| |faq_brshop24_pl_keineuebertragung
| |
| |Warum wird eine Preisliste nicht in den Shop übertragen?
| |
| |Bitte beachten Sie hier die [[Kostenpflichtige_Module/Internet-Shop/brShop24/Preise_übertragen#Voraussetzungen|Voraussetzungen]] für die Übertragung von Preislisten. Der Knackpunkt bei der Übertragung von Preislisten ist der Abgleich der Artikel. Um den Datenverkehr möglichst gering zu halten, versucht OBS nur die benötigten Daten zu übertragen. Das bedeutet, dass Artikelpreise für Artikel nicht übertragen werden, soltle der Artikel gar nicht im Shop vorkommen. Ein Abgleich aller Artikel mit dem Shop würde jedoch zu viel Zeit in Anspruch nehmen. Daher gleicht OBS die Daten über die in der Schnittstelle gepflegten [[Kostenpflichtige_Module/Internet-Shop/Konfiguration/Zuordnungen/DepotPartner#Depots.2FLager_in_Schnittstelle_brShop24|Depots]] ab. Stellen Sie also sicher, dass die Depots entsprechdn gepflegt sind.
| |
| }}
| |
