In diesem Abschnitt werden alle Parameter-Wert-Paare der Systemkonfiguration beschrieben, die das Verhalten einzelner Module, Komponenten und Funktionen des Onlineshops steuern. Die hier dokumentierten Konfigurationsknoten bilden die technische Grundlage für jeden WEBSALE Shop.

Jede Konfiguration besteht aus einem oder mehreren Knoten (z. B. accounts, basket, general), die in einer JSON-ähnlichen Struktur definiert sind.

Innerhalb dieser Knoten werden die einzelnen Parameter mit ihren möglichen Werten erläutert.
So können Administratoren oder Entwickler gezielt nachvollziehen, welche Optionen zur Verfügung stehen und wie diese auf das Verhalten des Systems wirken.

Alle Konfigurationseinstellungen können wahlweise über das Admin Interface oder über die REST API Konfiguration vorgenommen werden.

Inhaltsverzeichnis

1 Alphabetische Übersicht der Konfigurationen
2 Verwendung von Textbausteinen in Konfigurationen
3 URL-Zugriff auf Konfigurationen (temporär)

Alphabetische Übersicht der Konfigurationen

accounts - Benutzerkonten — Der Konfigurationsknoten accounts umfasst alle Einstellungen rund um die Verwaltung von Benutzerkonten im Onlineshop.
actions - Fehlertexte & E-Mails — Der Abschnitt actions beschreibt die Konfiguration von Fehlermeldungen und E-Mail-Vorlagen, die im Zusammenhang mit sogenannten Shopaktionen stehen.
app - WEBSALE APP — Der Knoten app umfasst alle Konfigurationen für die Anbindung und Steuerung der WEBSALE APP.
authentication - Authentifizierungs- & Zugriffsdaten — Der Konfigurationsbereich authentication dient der Verwaltung von Authentifizierungsinformationen und Zugangsdaten für externe Dienste, Schnittstellen oder Systeme.
b2b - Business-to-Business (B2B) — B2B-spezifische Einstellungen (z. B. Gruppen, Berechtigungen, Preislogik).
basket - Warenkorb — Der Abschnitt basket umfasst alle Einstellungen rund um den Warenkorb des Onlineshops.
creditCheck - Bonitätsprüfung
checkout - Bestellablauf
content - Katalog (Kategorien & Produkte) — Der Knoten content bildet die zentrale Konfigurationsebene für alle Inhalte des Katalogs.
customer - Kundendaten
finance - Währungen & Steuern
general - Allgemeine Shopeinstellungen — Der Knoten general bündelt sämtliche allgemeinen und systemweiten Grundeinstellungen des Onlineshops. Er ist einer der zentralsten und zugleich umfangreichsten Konfigurationsbereiche und enthält Parameter, die zahlreiche Module, Funktionen und Darstellungen des Shops beeinflussen.
inquiry - Formulare — Der Knoten inquiry steuert shopseitige Formulare (z. B. Kontakt, Widerruf, Retoure, Katalogbestellung).
maintenance - Wartungsmodus
messages - Ereignisgesteuerte E-Mails — Der Knoten messages dient zur Konfiguration benutzerdefinierter E-Mail-Benachrichtigungen, die automatisch ausgelöst werden, sobald im Shop bestimmte Ereignisse oder Zustände eintreten.
newsletter - Newsletter
payment - Zahlungsmethoden
search - Sortierung und Filterung
seoMetaData - Meta-Daten & Seo-Texte
security - Sicherheitsregeln
storefrontApi - Storefront-API
urls - URL (Webadressen)
Validierungs- und Prüfservices
E-Mails & E-Mail Einstellungen — Das WEBSALE Shopsystem versendet eine Vielzahl von E-Mails zu unterschiedlichen Zwecken, zum Beispiel im Checkout, im Kundenkonto, bei Formularanfragen oder für Benachrichtigungen.

Verwendung von Textbausteinen in Konfigurationen

Konfigurationen gelten grundsätzlich plattformweit und stehen damit im Standard allen darin enthaltenen Subshops zur Verfügung. Neben rein technischen Einstellungen können Konfigurationen auch sprachabhängige Inhalte enthalten, die im Frontend angezeigt werden, zum Beispiel Namen, Beschreibungen, Labels oder andere ausgaberelevante Texte.

Dies ist insbesondere dann relevant, wenn dieselbe Konfiguration in mehreren Sprachversionen eines Shops verwendet wird. In solchen Fällen ist es nicht ausreichend, einen festen Textwert direkt in der Konfiguration zu hinterlegen, da dieser ansonsten in allen Sprachvarianten identisch ausgegeben würde.

Beispiel:
Definition der Länder, die bei der Rechnungs- und Lieferadresse zur Auswahl angeboten werden.

{
  "active": true,
  "defaultTaxRate": "finance.taxRates.de",
  "isoAlpha2": "DE",
  "isoAlpha3": "DEU",
  "isoNum": "276",
  "name": "Deutschland",
  "usedTaxes": "finance.taxRates.de"
}

Im obigen Beispiel enthält der Parameter name einen festen Textwert. Dieser Wert würde im Frontend direkt angezeigt werden, zum Beispiel in einer Auswahlliste für Länder. In einem mehrsprachigen Shop wäre dies jedoch unflexibel, da dort je nach Sprache statt „Deutschland“ beispielsweise „Germany“ oder „Allemagne“ ausgegeben werden soll.

Aus diesem Grund können für solche ausgaberelevanten Texte auch Textbausteine verwendet werden:

{
  "active": true,
  "defaultTaxRate": "finance.taxRates.de",
  "isoAlpha2": "DE",
  "isoAlpha3": "DEU",
  "isoNum": "276",
  "name": "general.country.de.name",
  "usedTaxes": "finance.taxRates.de"
}

In diesem Fall verweist der Parameter name nicht auf einen festen Text, sondern auf einen Textbaustein. Der eigentliche sprachabhängige Inhalt wird dann über den Textbaustein-Dienst im Admin Interface je Sprache gepflegt. Auf diese Weise kann dieselbe Konfiguration in mehreren Sprachversionen eines Shops verwendet werden, ohne dass die Konfigurationsstruktur selbst je Sprache dupliziert werden muss.

Textbausteine in Konfigurationen können grundsätzlich frei vergeben und individuell angelegt werden. Dadurch lassen sich sprachabhängige Frontend-Texte zentral verwalten und konsistent in verschiedenen Konfigurationsbereichen wiederverwenden.

Eine Ausnahme bilden automatisch erzeugte Textbausteine für Fehlermeldungen innerhalb von Konfigurationen. Im Bereich actions werden für Fehlercodes systemseitig eigene Textbausteine erzeugt, deren Namen mit ws.error beginnen. Diese dienen dazu, technische Fehlercodes in verständliche und pflegbare Frontend-Fehlermeldungen zu übersetzen. Weitere Informationen dazu finden sich im Abschnitt actions - Fehlertexte & E-Mails.

Textbausteine können nicht nur in Konfigurationen, sondern auch in Templates verwendet werden. Dies ist insbesondere sinnvoll, da Templates ebenso wie Konfigurationen grundsätzlich für die gesamte Plattform gelten. Weitere Informationen zur Verwendung von Textbausteinen in Templates finden sich im Abschnitt Template Engine.

URL-Zugriff auf Konfigurationen (temporär)

Die in dieser Dokumentation beschriebenen Konfigurationsknoten entsprechen den technischen Strukturen, auf denen die Einstellungen im Admin Interface basieren. Im Admin Interface sind die einzelnen Knoten thematisch unter den jeweiligen Services (z. B. Katalog, Warenkorb, Bestellungen, Allgemein) eingeordnet.

Kann ein bestimmter Knoten im Menü nicht gefunden werden, lässt er sich derzeit auch direkt über die URL im Browser aufrufen.

Die URL folgt dabei stets dem Schema:

https://<shop-domain>/admin/config/<knotenname>

Beispiel:

https://<shop-domain>/admin/config/content.categoryFieldGroup

Dieser Aufruf öffnet direkt die Konfigurationsseite für den Knoten content.categoryFieldGroup im Admin Interface.

Der Direktaufruf per URL stellt derzeit einen temporären Workaround dar, solange viele Konfigurationen noch über „Konfiguration per Code“ bereitgestellt werden und noch keine eigene klickbare Oberfläche im Admin Interface besitzen.

Sobald die betreffenden Konfigurationen über die reguläre Benutzeroberfläche verfügbar sind, behalten wir uns vor, diese Aufruflogik jederzeit zu deaktivieren.