actions - Fehlertexte & E-Mails
Der Abschnitt actions beschreibt die Konfiguration von Fehlermeldungen und E-Mail-Vorlagen, die im Zusammenhang mit sogenannten Shopaktionen stehen.
Inhaltsverzeichnis
Definition Shopaktionen
Als Shopaktionen bezeichent WEBSALE Anfragen an das Shopsystem, um bestimmte Vorgänge auszuführen – beispielsweise das Hinzufügen eines Produkts zur Merkliste, den Login-Vorgang, das Anlegen eines Benutzerkontos oder andere Aktionen, die eine Interaktion mit dem Backend erfordern.
Das Shopsystem prüft dabei die Anfrage und führt die angeforderte Aktion aus, sofern keine Fehler auftreten. Fehler können zum Beispiel entstehen, wenn ein Produkt nicht mehr verfügbar ist, erforderliche Voraussetzungen nicht erfüllt sind oder ein unerwarteter Systemfehler vorliegt.
In diesen Fällen liefert das System einen Fehlercode zurück.
Fehlermeldungen
Solche Fehlercodes sind für die direkte Ausgabe im Frontend jedoch nicht geeignet, da sie für Käufer nicht verständlich sind. Damit im Shop eine sprechende und fachlich passende Fehlermeldung angezeigt werden kann, müssen diese technischen Codes einem lesbaren Text zugeordnet werden.
Hierfür erzeugt WEBSALE für jeden Fehlercode automatisch einen Textbaustein. Über diesen Textbaustein kann der im Frontend ausgegebene Fehlertext angepasst werden.
Aufbau der Textbausteine ws.error
Die Namen dieser Textbausteine beginnen immer mit ws.error. Dadurch lassen sie sich auch gezielt über die Suche des Textbaustein-Dienstes im Admin-Interface finden und pflegen.
Die Benennung folgt in der Regel diesem Schema:
ws.error.<configId>.<errorCode>Dabei entspricht <configId> in vielen Fällen der betroffenen Aktionskonfiguration unterhalb von actions, und <errorCode> dem jeweiligen Fehlercode der Aktion.
Bedeutung eines ws.error - Textbausteins ermitteln
Beispiel:
ws.error.accountDelete.actionNotAllowedUm die Bedeutung eines solchen Textbausteins zu ermitteln, wird der mittlere Teil des Namens betrachtet, hier also accountDelete.
Anschließend kann in der Dokumentation nach der zugehörigen Aktionskonfiguration actions.accountDelete gesucht werden. Dort findet sich im Abschnitt der Fehlercodes die Beschreibung zu actionNotAllowed.
Die Beschreibung des Fehlercodes erläutert, in welchem Fall die Meldung ausgegeben wird und hilft Ihnen somit, den passenden Text für den Fehler für die Fronten Darstellung zu formulieren.
Erfolgsmeldungen
Erfolgsmeldungen sind nicht Bestandteil der Aktions-Konfigurationen. Sie werden direkt über die Templates der Storefront definiert und können dort bei Bedarf angepasst werden. Die darin enthaltenen Texte lassen sich über die Templates selbst oder über die zugehörigen Textbausteine ändern.
E-Mail-Vorlagen
Zusätzlich enthalten die Aktionen auch Konfigurationsmöglichkeiten für E-Mail-Vorlagen, die im Rahmen bestimmter erfolgreicher Aktionen versendet werden – etwa bei einer erfolgreichen Registrierung oder einer abgeschlossenen Bestellung. Hier können Absender, Empfänger, Betreff und E-Mail-Template hinterlegt werden.
REST API Konfiguration
Eine Konfiguration der über actions gelieferten Fehlercodes, für die ein ws.error-Textbaustein erzeugt worden ist, können nicht mehr über die REST API Konfiguration berabeitet werden.
E-Mail-Vorlagen sind davon nicht betroffen.
Übersicht der actions für Fehlertexte & E-Mails
- actions - Alphabetische Übersicht — Über diese Seiten lassen sich alle Aktionen schnell auffinden und direkt zur entsprechenden thematischen Gruppe aufrufen. Sie dient damit als zentrale Referenz für eine gezielte Suche und eine effiziente Bearbeitung einzelner Aktionskonfigurationen.
- actions - Anmeldung & Registrierung — Diese Seite enthält alle Aktionen, die den Anmeldungs- und Registrierungsprozess im Onlineshop betreffen. Hier sind alle Meldungen und E-Mail-Vorlagen dokumentiert, die beim Anmelden, Entsperren eines Kontos oder beim Zurücksetzen eines Passworts ausgegeben etc. werden.
- actions - Benutzerkonto — Diese Seite enthält alle Aktionen, die das Benutzerkonto betreffen und enthält somit alle Meldungen und E-Mail-Vorlagen, die beim Erstellen, Ändern, Löschen und Prüfen von Kontodaten auftreten.
- actions - Newsletter — Diese Seite enthält alle Aktionen, die den Newsletter-Versand betreffen.
- actions - Produkte — Diese Seite enthält alle Aktionen, die im Zusammenhang mit Produkten stehen.
- actions - Sicherheit & Datenschutz — Diese Seite enthält alle Aktionen, die die Sicherheit und den Datenschutz im Shop betreffen. Dazu zählen Meldungen und Benachrichtigungen rund um die Sitzungssteuerung und den Consent Layer zur Verwaltung von Einwilligungen.
- actions - Testmodus — Dieser Bereich umfasst alle Aktionen, die zur Steuerung des Testmodus dienen. Sie ermöglichen das Aktivieren, Deaktivieren oder Umschalten des Testmodus innerhalb des Systems.
- actions - Warenkorb & Checkout — Diese Seite enthält alle Aktionen, die während des Bestellvorgangs im Shop ausgeführt werden.
- actions - Formulare — Diese Seite enthält alle Aktionen, die das Absenden von Formularen betreffen. Hier werden die zugehörigen Meldungen und E-Mail-Vorlagen dokumentiert, die beim Versenden von Formularen über den Shop ausgegeben werden – beispielsweise bei Kontakt-, Anfrage- oder Serviceformularen.