Reporte verwalten

Administratoren können im SCAYLE Panel eine beliebige Anzahl von Reporten angelegt und verwalten. Die einzelnen Schritte dafür erklären wir Dir nun im Detail.

Report erstellen

So erstellst Du Reporte:

1. Klicke auf Neuer Report.
2. Fülle alle Pflichtfelder aus, z.B. Name, Beschreibung, Format und Datenquelle.
3. Bestimme dabei, ob der Report automatisch generiert werden soll.
4. Erstelle die Abfrage.
5. Entscheide, welche Nutzerrollen und Firmenkennungen darauf Zugriff haben.
6. Füge bei Bedarf Platzhalter ein.

Schritt für Schritt im Detail

Klicke in der Übersicht den Button Neuer Report und es öffnet sich eine neue Seite, auf der Du die Einstellungen für den neuen Report vornehmen kannst.

Ein Report hat Pflichtfelder, die den Report bestimmen. Dies sind z.B. Name, Dateiname, Beschreibung, Dateiformat, ob der Report automatisch generiert werden soll, die eigentliche inhaltliche Abfrage und für welche Nutzerrollen der Report zugänglich sein soll.

Dateiformat

Du kannst zwischen den Datei-Formaten CSV und XSL wählen. Excel ist jedoch limitiert auf höchstens eine Million Einträge. Für größere Berichte sollte also immer CSV gewählt werden. Grundsätzlich eignet sich das CSV-Format besser für Reporte, da es leistungsstärker ist.

Datenquelle

Je nachdem welche Informationen Dein Report abfragt, muss Du die entsprechende Datenquelle auswählen. Willst Du beispielsweise einen Report für Gutscheine erstellen, musst Du als Datenquelle Kunden auswählen.

Folgende Auswahlmöglichkeiten stehen Dir bei der Auswahl der Datenquelle zur Verfügung:

• Produkt
• Kunden
• Checkout

Automatisierte Generierung

Reporte können zu verschiedenen Zeitpunkten an einem Tag automatisch generiert werden. Das gibt Dir die Möglichkeit, Reporte, deren Erstellung besonders lange dauert, beispielsweise nachts zu starten. So hast Du am nächsten Morgen den Report bereits fertig und kannst damit arbeiten.

Folgende Auswahlmöglichkeiten stehen Dir bei der automatischen Generierung zur Verfügung:

• deaktiviert
• jeden Tag um 8 Uhr
• jeden Tag um Mitternacht
• jeden Montag um Mitternacht
• alle zwei Stunden

Abgeschlossene Reporte findest Du in der Export-Übersicht. Dort werden alle generierten Reporte chronologisch dargestellt.

Abfrage

Die Abfrage beinhaltet eine SQL Query, die beim Erzeugen des Reportes ausgeführt wird. Beim Speichern eines Reportes wird die Query einmal initial getestet. Sollte diese Query fehlerhaft sein, erhältst Du darüber eine Benachrichtigung.

Eine detaillierte Fehlerbeschreibung kannst Du beim Key Account Management anfragen.

Reporte mit Platzhaltern

Innerhalb der Abfrage kannst Du verschiedene Platzhalter einfügen. Mit diesen Platzhaltern definierst Du ein Kriterium, das Du beim Erstellen eines Berichts direkt in das Platzhalterfeld eingeben kannst, z.B. die Produkt-IDs. So musst Du nicht jede Abfrage einzeln erstellen. Platzhalter aktivierst Du durch die Checkbox Anpassbar innerhalb der Report-Konfiguration.

[note] Reporte mit Platzhaltern können nicht automatisch generieren werden, da diese eine Benutzerinteraktion erfordern. [/note]

Für Reporte stehen verschiedene Platzhaltertypen zur Verfügung:

• Auto-Vervollständigung (z.B. Attributgruppen, Shops)
• Text
• Datum

Platzhalter innerhalb einer Abfrage sind an den geschweiften Klammern zu erkennen:

js

Copy

{.......}

Auto-Vervollständigung

Für die Nutzung der Auto-Vervollständigung muss der Platzhalter noch um den Key erweitert werden, der den Typen definiert.

js

Copy

{autocomplete:category}

Folgende Keys stehen zur Verwendung bereit:

Zusätzliche Optionen

Die Platzhalter lassen sich zusätzlich um Optionen ergänzen. Die Optionen haben Auswirkung auf die Abfrage der Parameter bei der Reporterstellung:

Beispiele

Query für Abfrage eines Shop-Namens:

sql

Copy

SELECT name
FROM applications
WHERE id = {autocomplete:shops|multiple:true ,label:"Shop" ,caption: "Für welchen Shop möchten Sie den Namen haben?"}

Reporte bearbeiten

Um einen Report direkt zu bearbeiten, klickst Du auf das Symbol Bearbeiten auf der rechten Seite. Es öffnet sich ein Fenster mit dem Report-Einstellungen, die Du nach deinen Wünschen anpassen kannst.

[note] Für die Bearbeitung der Report-Einstellungen benötigst Du eine spezielle Berechtigung. Die SQL-Abfrage (SQL Query) erfordert zudem eine weitere Berechtigung. Administratoren können dies in der Benutzerverwaltung anpassen. [/note]

Reporte extern abrufen (API)

Das SCAYLE Panel verfügt über eine API, um Reporte für externe Systeme erreichbar zu machen. Diese Schnittstelle nutzt zur Authentifizierung das Verfahren Basic Auth. Jeder SCAYLE Panel-Nutzer kann zur Authentifizierung hinterlegt werden. Grundsätzlich ist dann jeder erstellte Report über diese API erreichbar – solange Nutzerrolle am Report und Basic-Auth-Nutzer übereinstimmen.

Copy

https://username:password@{{tenant-space}}.panel.scayle.cloud/api/v1/external/reports/10/export

Funktionsweise

Über die oben gezeigte URL ist es möglich, immer die zuletzt generierte Version des Reportes herunterzuladen. Sollte es noch keinen aktuelleren Bericht geben, wird Dir entweder eine ältere Datei angezeigt (siehe Zeitstempel) oder Du erhältst eine Benachrichtigung, dass die Datei noch nicht komplett generiert wurde.

JSON

Copy

{
  "data": {
    "url": "https://url-to-the-file",
    "created_at": "2019-08-06 14:51:59",
    "finished_at": "2019-08-06 14:54:59"
  }
}

JSON

Copy

{
  "message": "Report is not generated or finished yet"
}

Download erzwingen

Über den URL-Parameter forceDownload=1 kann die Datei dennoch direkt heruntergeladen werden.

Copy

https://username:password@{{tenant-space}}.panel.scayle.cloud/api/v1/external/reports/10/export?forceDownload=1