Konfigurationsreferenz
Diese Referenz listet alle Einstellungen unter Einstellungen > Erweiterungen > Erweitertes Analytics Dashboard, die Datenbankentitäten des Plugins sowie die ACL-Berechtigungen auf. Die Einstellungsbeschreibungen wurden direkt aus der config.xml des Plugins generiert; um eine Beschreibung zu ändern, bearbeiten Sie config.xml und führen Sie den Extraktor erneut aus.
Plugin-Einstellungen
Allgemeine Einstellungen
| Einstellung | Typ | Standard | Beschreibung |
|---|---|---|---|
maxChartsPerAnalytic — Maximale Anzahl Charts pro Analytic | int | 20 | — |
hideDashboardSection — Analytics-Bereich im Dashboard ausblenden | bool | false | Wenn aktiviert, wird der Bereich mit angehefteten Charts im Shopware-Dashboard ausgeblendet. Berichte sind weiterhin über das Hauptmenü erreichbar. |
overviewReportId — Übersichtsbericht | Entitätsauswahl (ssd_analytic) | (keiner) | Der Bericht, der als Analytics-Übersicht angezeigt wird. Wird aus der Berichtsliste ausgeblendet. |
Hinweis zu
maxChartsPerAnalytic: In derconfig.xmlist derzeit kein Hilfetext definiert. Die Einstellung begrenzt, wie viele Charts ein einzelner Bericht enthalten darf, um übermäßig große Berichtsseiten zu verhindern.
Entitäten
ssd_analytic — Bericht
Repräsentiert eine benannte Sammlung von Charts mit konfigurierbarem Rasterlayout.
| Spalte | Typ | Hinweise |
|---|---|---|
id | binäre UUID | Primärschlüssel |
name | Zeichenkette (übersetzt) | Pflichtfeld. Der Anzeigename des Berichts. |
columns | int | Anzahl der Rasterspalten in der Berichtsansicht (1–4). Standard: 2. |
layout | JSON | Chart-Reihenfolge und spaltenbreite pro Chart ({ chartOrder: [], chartSpans: {} }). |
filters | JSON | Filterset auf Berichtsebene. Reserviert für eine zukünftige Dashboard-Filter-Funktion; in dieser Version nicht mit der Benutzeroberfläche verknüpft. |
is_system | bool | Kennzeichnet systemseitig eingepflegte Datensätze (z. B. den Standard-Übersichtsbericht). Systemdatensätze sind nicht löschbar. |
created_at / updated_at | datetime | Von Shopware verwaltet. |
Übersetzungstabelle (ssd_analytic_translation):
| Spalte | Typ | Hinweise |
|---|---|---|
name | Zeichenkette | Pflichtfeld. Berichtsname in der jeweiligen Sprache. |
Assoziationen:
| Beziehung | Ziel | Über | Hinweise |
|---|---|---|---|
| Many-to-many | ssd_analytics_chart | ssd_analytic_chart (Mapping-Tabelle) | Kaskadenlöschung beim Entfernen des Berichts. |
ssd_analytics_chart — Chart
Speichert die vollständige Konfiguration eines Charts: Datenquelle, Metrik, Filter, Visualisierungstyp und Layout-Hinweise.
| Spalte | Typ | Hinweise |
|---|---|---|
id | binäre UUID | Primärschlüssel |
title | Zeichenkette (übersetzt) | Pflichtfeld. Anzeigename des Charts. |
description | Zeichenkette (übersetzt) | Optional. Wird als Untertitel auf der Chart-Karte angezeigt. |
chart_type | Zeichenkette | Einer von: line, bar, pie, donut, number, table. |
data_source | Zeichenkette | Einer von: order, customer, product, line_item. |
metric | Zeichenkette | Einer von: count, sum, avg. |
metric_field | Zeichenkette, nullable | Für sum/avg — das aggregierte Feld (z. B. amount_total, quantity). |
time_granularity | Zeichenkette | Zeiteinheit: day, week, month, quarter, year. Standard: day. |
filters | JSON | Array der auf die Abfrage angewendeten Filterobjekte. |
breakdown | Zeichenkette, nullable | Optionale Aufschlüsselung nach einer einzelnen Eigenschaft (z. B. sales_channel_id, state_id). |
date_range_type | Zeichenkette | Vordefinierter Bezeichner (z. B. last_30d, this_month, custom). Standard: last_30d. |
date_range_start / date_range_end | datetime, nullable | Wird verwendet, wenn date_range_type auf custom gesetzt ist. |
compare_previous | bool | Wenn true, ruft die Abfrage auch den entsprechenden Vorperiodenwert für die Delta-Anzeige ab. Standard: false. |
config | JSON | Zusätzliche ApexCharts-Konfigurationsüberschreibungen. |
position_x / position_y / width / height | int | Reserviert; wird von der aktuellen Layout-Engine nicht verwendet. Spaltenbreiten pro Chart werden in ssd_analytic.layout.chartSpans gespeichert. |
pinned_to_dashboard | bool | Gibt an, ob der Chart im Shopware-Dashboard-Bereich erscheint. Standard: false. |
dashboard_sort_order | int, nullable | Anzeigereihenfolge im Raster der angehefteten Dashboard-Charts. |
created_at / updated_at | datetime | Von Shopware verwaltet. |
Übersetzungstabelle (ssd_analytics_chart_translation):
| Spalte | Typ | Hinweise |
|---|---|---|
title | Zeichenkette | Pflichtfeld. Chart-Name in der jeweiligen Sprache. |
description | Zeichenkette | Optional. |
Assoziationen:
| Beziehung | Ziel | Über | Hinweise |
|---|---|---|---|
| Many-to-many | ssd_analytic | ssd_analytic_chart (Mapping-Tabelle) | Kaskadenlöschung beim Entfernen des Charts. |
ssd_analytic_chart — Mapping-Tabelle
Verknüpft Berichte mit Charts und enthält die Sortierreihenfolge.
| Spalte | Typ | Hinweise |
|---|---|---|
analytic_id | binäre UUID (FK) | Referenz auf ssd_analytic.id. |
chart_id | binäre UUID (FK) | Referenz auf ssd_analytics_chart.id. |
sort_order | int | Anzeigereihenfolge innerhalb des Berichts. |
created_at | datetime |
ACL-Berechtigungen
Das Plugin registriert die eigene ACL-Ressource ssd_analytic. Weisen Sie diese Rollen den Admin-Benutzern unter Einstellungen > System > Berechtigungen zu.
| Rolle | Schlüssel | Gewährt |
|---|---|---|
| Betrachter | ssd_analytic.viewer | Berichte und Charts lesen; Plugin-Systemkonfiguration lesen. |
| Bearbeiter | ssd_analytic.editor | Bestehende Berichte und Charts aktualisieren (bearbeiten); Systemkonfiguration aktualisieren. |
| Ersteller | ssd_analytic.creator | Neue Berichte und Charts erstellen. Erfordert Betrachter + Bearbeiter. |
| Löscher | ssd_analytic.deleter | Berichte und Charts löschen. Erfordert Betrachter. |
Benutzer ohne mindestens die Betrachter-Rolle sehen den Analytics-Menüpunkt nicht.
API-Routen
| Route | Methode | Erforderliche Berechtigung | Zweck |
|---|---|---|---|
/api/ssd-analytics/query | POST | ssd_analytic:read | Chart-Abfrage ausführen. Gibt data, dateRange, previousData, previousDateRange, availableBreakdowns, initialFilters zurück. |
/api/ssd-analytics/data-sources | GET | ssd_analytic:read | Verfügbare Datenquellen mit Metriken, filterbaren Eigenschaften, Aufschlüsselungsoptionen und Initialfiltern zurückgeben. |
