Version vom 3. November 2020, 16:09 Uhr

ACHTUNG: Die Schnittstelle befindet sich derzeit noch in der Entwicklung! Das Wiki orientiert sich am aktuellen Entwicklungsstand. Die Schnittstelle kann zwar im OBS aktiviert werden, ist jedoch noch nicht für den Live-Betrieb gedacht, da sich noch grundlegende Änderungen ergeben können. Wer die Schnittstelle dennoch für den Live-Betrieb verwenden möchte, kann sich an den Support für eine Freischaltung wenden. Bitte beachten Sie jedoch, dass wir den Schnittstelle vor der offiziellen Freigabe nicht supporten werden. Eine Verwendung erfolgt auf eigene Gefahr. Siehe dazu auch Bekannte Probleme unter Funktionsumfang. Wenn die OBS-Schnittstelle von uns offiziell für den Live-Betrieb freigegeben wird, wird es dafür einen entsprechenden Eintrag in den Update-Informationen im Info-Widget geben. Wer sich unsicher ist, wann der Umstieg erfolgen soll/kann, sollte auf die offizielle Freigabe warten.

Der brShop24 wird von der Genossenschaft 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 GraphQL zur Verfügung. Aktuell ist geplant die Übertragung von Personen und Preislisten ab Anfang März 2020 und Artikel ab Anfang April 2020 zu unterstützen.

ACHTUNG: Für die Preisübertragung wird das kostenpflichtige Modul 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!
Siehe auch die Punkte Umstellung/Migration VShop 4 und 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:

Import	Export
Auftragsimport (OpenTRANS 1.0)	Personen/Ansprechpartner/Kostenstellen
Depots + Partner	Preislisten
Anreden
Kundentypen
Kundenqualifikation

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.

Export Personen

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ü

B Preislisten verwalten

Öffnet die Preislistenverwaltung der Schnittstelle.

I Bestellvorlagen verwalten

Öffnet die Shoplistenverwaltung der Schnittstelle.

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).

U Bestellungen einlesen

Liest die vorhanden Bestelldateien aus dem Shop-Verzeichnis ein. Für den automatischen Import siehe Automatiken: Bestellungen einlesen.

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:

Depots/Lager mit Partner
Anreden
Kundentypen (u. a. B2B, B2C)
Kundenqualifikation (u. a. neuer Kunden, Stammkunde)

Für den automatischen Import siehe 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.

X Konfiguration

Öffnet die 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 Ticketsystem beim OBS-Support.

Y Testumgebung

Öffnet eine Testumgebung, um die Anbindung zu testen.

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

Installation/Einrichtung

Eine neue Schnittstelle muss vom Support freigegeben werden. Fragen Sie dies am besten per 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 GraphQL. Um mit Ihrem Shop kommunizieren zu können, benötigen Sie die URL zu Ihrem Shop und folgende 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. https://meinshop.brshop24.de)
OAuth2.ClientId
OAuth2.ClientSecret
OAuth2.TokenEndpoint (z. B. https://oauth.brshop24.de/token)

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.

Abholung

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 FTP Jobliste.

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.

Import

Nutzen Sie dazu unsere Hilfe-Seite für Shop-Automatiken. Der Import von Bestellungen erfolgt mit ShopGetBestellungen.

weitere Automatiken

Eine Übersicht aller verfügbaren Automatiken finden Sie auf der entsrepchenden Hilfe-Seite für Shop-Automatiken.

HINWEIS: Achten Sie darauf, dass brShop24 in der Angabe Verfügbar in enthalten ist!

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:

A Anreden

Die Einstellungen für "Anreden" werden für den Export von Personen benötigt.

L Lager und Lagerlieferanten

Die Einstellungen für "Depot" und "Partner" werden für den Export von Preisen und Artikel benötigt.

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/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 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

Eine Migration der Daten im OBS ist bisher nicht geplant, kann aber auf Anfrage von uns durchgeführt werden. Dies wird nach Aufwand berechnet.

HINWEIS: Aktuell ist noch ein Test mit migrierten Daten geplant, damit gewährleistet werden kann, dass OBS auch auf Bestandsdaten zugreifen kann. Dies ist zum Beispiel für Kundendaten interessant, die Sie aus OBS schon in den VShop 4 übertragen haben.

Häufig gestellte Fragen (FAQ)

Migration VShop4

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

Warum wird eine Preisliste nicht in den Shop übertragen?

Bitte beachten Sie hier die 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 Depots ab. Stellen Sie also sicher, dass die Depots entsprechdn gepflegt sind.

@@ Zeile 1: / Zeile 1: @@
 {{Kostenpflichtige Module}}
-{{Achtung|Die Schnittstelle befindet sich derzeit noch in der Entwicklung! Das Wiki orientiert sich am aktuellen Entwicklungsstand. Die Schnittstelle kann zwar im OBS aktiviert werden, ist jedoch noch nicht für den Live-Betrieb gedacht, da sich noch grundlegende Änderungen ergeben können. Wer die Schnittstelle dennoch für den Live-Betrieb verwenden möchte, kann sich an den Support für eine Freischaltung wenden. Bitte beachten Sie jedoch, dass wir den Schnittstelle vor der offiziellen Freigabe nicht supporten werden. Eine Verwendung erfolgt auf eigene Gefahr. Siehe dazu auch [[#Bekannte_Probleme|Bekannte Probleme]] unter [[#Funktionsumfang|Funktionsumfang]]. Wenn die OBS-Schnittstelle von uns offiziell für den Live-Betrieb freigegeben wird, wird es dafür einen entsprechenden Eintrag in den Update-Informationen im Info-Widget geben. Wer sich unsicher ist, wann der Umstieg erfolgen soll, sollte auf die offizielle Freigabe warten.}}
+{{Achtung|Die Schnittstelle befindet sich derzeit noch in der Entwicklung! Das Wiki orientiert sich am aktuellen Entwicklungsstand. Die Schnittstelle kann zwar im OBS aktiviert werden, ist jedoch noch nicht für den Live-Betrieb gedacht, da sich noch grundlegende Änderungen ergeben können. Wer die Schnittstelle dennoch für den Live-Betrieb verwenden möchte, kann sich an den Support für eine Freischaltung wenden. Bitte beachten Sie jedoch, dass wir den Schnittstelle vor der offiziellen Freigabe nicht supporten werden. Eine Verwendung erfolgt auf eigene Gefahr. Siehe dazu auch [[#Bekannte_Probleme|Bekannte Probleme]] unter [[#Funktionsumfang|Funktionsumfang]]. Wenn die OBS-Schnittstelle von uns offiziell für den Live-Betrieb freigegeben wird, wird es dafür einen entsprechenden Eintrag in den Update-Informationen im Info-Widget geben. Wer sich unsicher ist, wann der Umstieg erfolgen soll/kann, sollte auf die offizielle Freigabe warten.}}
 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. Aktuell ist geplant die Übertragung von Personen und Preislisten ab Anfang März 2020 und Artikel ab Anfang April 2020 zu unterstützen.
 {{Achtung|Für die Preisübertragung wird das kostenpflichtige Modul [[OBS/Kostenpflichtige_Module/Preislisten|Preislisten]] vorausgesetzt!}}

Kostenpflichtige Module/Internet-Shop/brShop24: Unterschied zwischen den Versionen

Version vom 3. November 2020, 16:09 Uhr

Inhaltsverzeichnis

Funktionsumfang

Bekannte Probleme

Import Bestellungen

Export Personen

Bestellvorlagen/Shoppinglisten

Menü

Erklärungen/Funktionen

Installation/Einrichtung

Kommunikation mit dem Shop

Abholung und Import Aufträge

Abholung

Import

weitere Automatiken

Zuordnungen

Umstellung/Migration VShop 4

Häufig gestellte Fragen (FAQ)

Migration VShop4

Preise/Preislisten

Navigationsmenü

Kostenpflichtige Module/Internet-Shop/brShop24: Unterschied zwischen den Versionen

Version vom 3. November 2020, 16:09 Uhr

Funktionsumfang

Bekannte Probleme

Import Bestellungen

Export Personen

Bestellvorlagen/Shoppinglisten

Menü

Erklärungen/Funktionen

Installation/Einrichtung

Kommunikation mit dem Shop

Abholung und Import Aufträge

Abholung

Import

weitere Automatiken

Zuordnungen

Umstellung/Migration VShop 4

Häufig gestellte Fragen (FAQ)

Migration VShop4

Preise/Preislisten

Navigationsmenü

Suche