Skip to content

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

EinstellungTypStandardBeschreibung
maxChartsPerAnalytic — Maximale Anzahl Charts pro Analyticint20
hideDashboardSection — Analytics-Bereich im Dashboard ausblendenboolfalseWenn aktiviert, wird der Bereich mit angehefteten Charts im Shopware-Dashboard ausgeblendet. Berichte sind weiterhin über das Hauptmenü erreichbar.
overviewReportId — ÜbersichtsberichtEntitätsauswahl (ssd_analytic)(keiner)Der Bericht, der als Analytics-Übersicht angezeigt wird. Wird aus der Berichtsliste ausgeblendet.

Hinweis zu maxChartsPerAnalytic: In der config.xml ist 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.

SpalteTypHinweise
idbinäre UUIDPrimärschlüssel
nameZeichenkette (übersetzt)Pflichtfeld. Der Anzeigename des Berichts.
columnsintAnzahl der Rasterspalten in der Berichtsansicht (1–4). Standard: 2.
layoutJSONChart-Reihenfolge und spaltenbreite pro Chart ({ chartOrder: [], chartSpans: {} }).
filtersJSONFilterset auf Berichtsebene. Reserviert für eine zukünftige Dashboard-Filter-Funktion; in dieser Version nicht mit der Benutzeroberfläche verknüpft.
is_systemboolKennzeichnet systemseitig eingepflegte Datensätze (z. B. den Standard-Übersichtsbericht). Systemdatensätze sind nicht löschbar.
created_at / updated_atdatetimeVon Shopware verwaltet.

Übersetzungstabelle (ssd_analytic_translation):

SpalteTypHinweise
nameZeichenkettePflichtfeld. Berichtsname in der jeweiligen Sprache.

Assoziationen:

BeziehungZielÜberHinweise
Many-to-manyssd_analytics_chartssd_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.

SpalteTypHinweise
idbinäre UUIDPrimärschlüssel
titleZeichenkette (übersetzt)Pflichtfeld. Anzeigename des Charts.
descriptionZeichenkette (übersetzt)Optional. Wird als Untertitel auf der Chart-Karte angezeigt.
chart_typeZeichenketteEiner von: line, bar, pie, donut, number, table.
data_sourceZeichenketteEiner von: order, customer, product, line_item.
metricZeichenketteEiner von: count, sum, avg.
metric_fieldZeichenkette, nullableFür sum/avg — das aggregierte Feld (z. B. amount_total, quantity).
time_granularityZeichenketteZeiteinheit: day, week, month, quarter, year. Standard: day.
filtersJSONArray der auf die Abfrage angewendeten Filterobjekte.
breakdownZeichenkette, nullableOptionale Aufschlüsselung nach einer einzelnen Eigenschaft (z. B. sales_channel_id, state_id).
date_range_typeZeichenketteVordefinierter Bezeichner (z. B. last_30d, this_month, custom). Standard: last_30d.
date_range_start / date_range_enddatetime, nullableWird verwendet, wenn date_range_type auf custom gesetzt ist.
compare_previousboolWenn true, ruft die Abfrage auch den entsprechenden Vorperiodenwert für die Delta-Anzeige ab. Standard: false.
configJSONZusätzliche ApexCharts-Konfigurationsüberschreibungen.
position_x / position_y / width / heightintReserviert; wird von der aktuellen Layout-Engine nicht verwendet. Spaltenbreiten pro Chart werden in ssd_analytic.layout.chartSpans gespeichert.
pinned_to_dashboardboolGibt an, ob der Chart im Shopware-Dashboard-Bereich erscheint. Standard: false.
dashboard_sort_orderint, nullableAnzeigereihenfolge im Raster der angehefteten Dashboard-Charts.
created_at / updated_atdatetimeVon Shopware verwaltet.

Übersetzungstabelle (ssd_analytics_chart_translation):

SpalteTypHinweise
titleZeichenkettePflichtfeld. Chart-Name in der jeweiligen Sprache.
descriptionZeichenketteOptional.

Assoziationen:

BeziehungZielÜberHinweise
Many-to-manyssd_analyticssd_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.

SpalteTypHinweise
analytic_idbinäre UUID (FK)Referenz auf ssd_analytic.id.
chart_idbinäre UUID (FK)Referenz auf ssd_analytics_chart.id.
sort_orderintAnzeigereihenfolge innerhalb des Berichts.
created_atdatetime

ACL-Berechtigungen

Das Plugin registriert die eigene ACL-Ressource ssd_analytic. Weisen Sie diese Rollen den Admin-Benutzern unter Einstellungen > System > Berechtigungen zu.

RolleSchlüsselGewährt
Betrachterssd_analytic.viewerBerichte und Charts lesen; Plugin-Systemkonfiguration lesen.
Bearbeiterssd_analytic.editorBestehende Berichte und Charts aktualisieren (bearbeiten); Systemkonfiguration aktualisieren.
Erstellerssd_analytic.creatorNeue Berichte und Charts erstellen. Erfordert Betrachter + Bearbeiter.
Löscherssd_analytic.deleterBerichte und Charts löschen. Erfordert Betrachter.

Benutzer ohne mindestens die Betrachter-Rolle sehen den Analytics-Menüpunkt nicht.

API-Routen

RouteMethodeErforderliche BerechtigungZweck
/api/ssd-analytics/queryPOSTssd_analytic:readChart-Abfrage ausführen. Gibt data, dateRange, previousData, previousDateRange, availableBreakdowns, initialFilters zurück.
/api/ssd-analytics/data-sourcesGETssd_analytic:readVerfügbare Datenquellen mit Metriken, filterbaren Eigenschaften, Aufschlüsselungsoptionen und Initialfiltern zurückgeben.

Your Vision. Signed, Sealed, Delivered.