Mit dem Modul "Berichte" können Unternehmensdaten aus der xentral Datenbank, mithilfe von SQL Statements, nach unternehmensspezifischen Bedürfnissen in Tabellenform ausgegeben und exportiert werden.
In der Übersicht sind alle bereits erstellten Berichte einzusehen und neue Berichte können über die Schaltfläche "+ Neuer Eintrag" hinzugefügt werden. Außerdem können die Berichte über die, im Bericht hinterlegten, Kategorien und Berichtsnamen durchsucht werden, um den Bericht in der Kachelübersicht schnell zu finden. In einer Kachel kann mit den Icons oben rechts der Bericht bearbeitet (Stift-Icon), der Bericht gelöscht (X), der Bericht kopiert (Papier-Icon) und mit dem Info-Icon die Beschreibung des Berichts angezeigt werden.
Zudem stehen unten links schwarze Icons zur Auswahl:
-
TABLE: Ein Klick führt direkt in die Live-Ansicht des Berichts
-
CSV: Der Bericht wird als CSV Datei heruntergeladen. Wenn bei den Variablen des Berichts der Haken "Manuell bearbeiten" aktiviert und Werte in der Werteauswahl eingetragen wurden, erscheint ein Dialogfenster. In diesem können die Werte für die Variable zur Befüllung des SQL Statements ausgewählt werden können. Ansonsten wird der hinterlegte Standardwert zur Befüllung verwendet
-
PDF: Download des Berichts als PDF Datei. Wenn bei den Variablen des Berichts der Haken "Manuell bearbeiten" aktiviert und auch Werte in der Werteauswahl eingetragen wurden, erscheint ein Dialogfenster. In diesem können die Werte für die Variable zur Befüllung des SQL Statements ausgewählt werden. Ansonsten wird der hinterlegte Standardwert zur Befüllung verwendet
-
Chart: Damit der Chart in der Übersicht neben Table, CSV und PDF angezeigt wird, musst du im jeweiligen Bericht in den Einstellungen für Graphen im Dashboard die Freigabe für den Graph an entsprechender Stelle mit "Ja" angeben. Wenn du darauf klickst erscheint eine Grafik
Um auf die weiteren Informationen über einen Bericht zuzugreifen, wird im Folgenden auf einen konkreten Bericht Bezug genommen. Um auf diese Informationen zugreifen zu können, muss auf diesen konkreten Bericht geklickt werden.
Im Reiter "Ansicht" wird das Ergebnis des SQL Statements ausgegeben. Sämtliche Spaltendefinitionen, die vorher erstellt wurden, werden angezeigt. Diese Tabelle kann, wie die anderen Tabellen auch, in xentral sortiert und durchsucht werden, sofern kein ORDER BY im SQL Statement verwendet wurde.
In der Ansicht werden die Sortierungsstatements nicht berücksichtigt, da hier manuell die Sortierung ausgewählt werden kann. Ein Export des Berichts ist dennoch trotzdem entsprechend sortiert, sofern ein ORDER BY in SQL Statement vorhanden ist.
Wenn für den Bericht Parameter mit dem gesetzten Haken bei "Manuell bearbeiten" hinterlegt wurden, wird für jeden Parameter ein Eingabefeld neben der Tabelle angezeigt. Falls die Parameter gewählt worden sind, ist ein Mal auf "Parameter festlegen" zu klicken, um die Parameter in die Tabellenansicht zu übernehmen. Die Parameter dürfen nicht leer sein, d.h. es muss immer ein Wert eingegeben werden. Die Parameter sind fix und können derzeit innerhalb des SQL-Statements nicht geändert werden.
Im Reiter „Details“ befinden sich verschiedene Bereiche, um die Eigenschaften des Berichts zu definieren.
Es können diverse Einstellungen für den Bericht vorgenommen werden.
Folgende Felder stehen zur Verfügung:
-
Name → Es ist ein aussagekräftiger Name für den Bericht anzugeben, um diesen in der Suche der Berichtsübersicht schnell zu finden
-
Kategorie → Es ist eine frei wählbare Kategorie für den Bericht anzugeben. Dadurch können in der Berichtsübersicht die Berichte nach Kategorie durchsucht und angezeigt werden
-
Beschreibung → Es ist eine Beschreibung anzugeben, wie z.B. der Zweck, die Informationen des Berichts oder die Verwendung der erstellten Variablen
-
Projekt → Schränkt die Sichtbarkeit in der Berichtsübersicht ein, d.h. nur Benutzer mit den entsprechenden Projektrechten können diesen Bericht in der Berichtsübersicht sehen
-
Aus Datei laden → Falls eine Datei mit den nötigen Einstellungen vorhanden ist, kann diese durch den Klick auf die Schaltfläche "Datei auswählen" geladen werden
Mit einem Klick auf die Schaltfläche "+ Neue Variable" kann eine neue Variable, d.h. ein Platzhalter für das SQL Statement, angelegt werden. Variablen werden im SQL Statement groß geschrieben und von geschweiften Klammern umschlossen, z.B. {PROJEKTNAME}.
Folgende Felder stehen zur Verfügung:
-
Variablenname → Es ist ein Variablenname aus dem SQL Statement anzugeben
-
Zulässige Zeichen → Großbuchstaben, Ziffern, Unterstrich ("_")
-
Unzulässige Zeichen → Kleinbuchstaben, Umlaute, "ß" und andere Sonderzeichen
-
-
Standardwert → Falls keine weiteren Werte im Feld "Werteauswahl" hinterlegt wurden, ist ein Standardwert für diese Variable festzulegen
-
Manuell bearbeiten → Ist dieser Haken aktiviert, wird bei der CSV und PDF Ausgabe vorher ein Dialogfenster angezeigt, bei dem die nachfolgenden Felder relevant sind:
-
Dialogtext → Beschriftung des Auswahlfeldes für die Werte im Feld "Werteauswahl"
-
Beschreibung → Dient nur internen Zwecken und hat keine weitere Verwendung
-
Eingabe → Aus dem Drop-Down-Menü ist die gewünschte Eingabe auszuwählen
-
Werteauswahl → Hier können kommasepariert die Werte, die zur Auswahl im Dialogfenster für den Download gewünscht und im Anschluss in den Bericht gefüllt werden, festgelegt werden. Die Werteauswahl wird automatisch um einen Alias mit Doppelpunkt ergänzt, z.B. wird aus ja,nein ein Ja:ja,Nein:nein
-
Über den Reiter "Details" können die Strukturen angepasst werden. Hier erfolgt die Eingabe des SQL Statements und es besteht die Möglichkeit, ein direktes Ergebnis der Abfrage zu erhalten. Die Bezeichnungen der einzelnen Datenbanktabellen und -spalten kannst du sehr einfach über das Modul Datenbank Ansicht herausfinden.
Folgende Felder stehen zur Verfügung:
-
SQL Statement: Hier ist das erstellte SQL Statement einzutragen. Mit der "Play"-Schaltfläche an der rechten Seite des Textfeldes kann das SQL Statement direkt ausgeführt werden. Im Feld "Ergebnis" erscheint eine Rückmeldung, ob das SQL Statement erfolgreich ausgeführt werden konnte. Bei Misserfolg erscheint eine Fehlermeldung.
Anmerkung
Wird an einem bereits gespeicherten SQL Statement etwas geändert, erscheint ein Warnhinweis, um auf die Speicherung der Änderungen hinzuweisen.
Verwendung von Variablen
Variablen, die als Parameter festgelegt wurden, können in der Abfrage verwendet werden, indem die Variablennamen in geschweiften Klammern eingegeben werden. Beachte, dass SQL Befehle wie UPDATE oder SET als Name oder Wert nicht zulässig sind, da sie ein Konflikt verursachen können. Zusätzlich zu den festgelegten Parametern stehen folgende Variablen zur Verfügung:
-
USER_ID → ID des aktuellen Benutzers
-
USER_PROJECTS → Liste aller Projekte, auf die der aktuelle Benutzer zugreifen kann. Kann z.B. zur Einschränkung der Ausgabe verwendet werden: "[1] WHERE auftrag.projekt in {USER_PROJECTS}"
-
USER_ADMIN → 1 = aktueller Benutzer ist ein Administrator, 0 = aktueller Benutzer ist kein Administrator
-
REPORT_PROJECT → ID des Projektes, dem der aktuelle Bericht zugeordnet ist
-
DOCTYPE → Ist nur zu verwenden, wenn der Bericht aus einem Belegmenü aufgerufen wird. Enthält einen dieser Belegtypen: "angebot", "auftrag", "gutschrift", "rechnung", "lieferschein", "bestellung", "produktion"
-
DOCID → Erscheint nur wenn der Bericht aus einem Belegmenü aufgerufen wird. Enthält die Datenbank-ID des Belegs
Anmerkung
Die Tabelle User und anderer Tabellen (z.B. Userrights, Userkonfigurationen) kann nur angesprochen werden, wenn das Wort in Hochkommas `` gesetzt wird. Das ist notwendig, damit der SQL Bericht das Wort nicht als Befehl missversteht.
Die Tabelle zeigt die angelegten Spalten, die im Reiter "Ansicht" und bei Exporten zu sehen sind. Die Spalten können jederzeit bearbeitet und gelöscht werden.
Schaltfläche "+ Neue Spalten"
Mit der Schaltfläche "+ Neue Spalten" kann eine neue Spalte für die Tabelle angelegt werden.
Folgende Felder stehen zur Verfügung:
-
Spaltenname SQL → Es ist die Spalte aus dem SQL Statement anzugeben. Der Spaltenname darf keinen Tabellenalias beinhalten, z.B. kein a.name, sondern name
-
Bezeichnung → Es ist ein Spaltennamen anzugeben, um die Spaltenüberschrift für die spätere Ansicht oder den Export zu definieren
-
Spaltenbreite → Dieser optionale Wert definiert die Spaltenbreite für die spätere Ansicht oder den Export
-
Ausrichtung → Gibt die Ausrichtung (Rechts, Mitte, Links) des Inhalts einer Spalte für "Ansicht" oder den Export an. Die gewünschte Ausrichtung ist aus dem Drop-Down-Menü zu wählen
-
Sortierung → Gibt an, ob eine Spalte alphabetisch oder numerisch sortiert werden soll. Numerische Sortierung funktioniert nur, wenn die Datenbank Spalte einen numerischen Datentyp hat
-
Formatierung → Aus dem Drop-Down-Menü kann die gewünschte Formatierung gewählt werden, z.B. der Geldbetrag in EUR
-
Spalte summieren → Diese Option ist optional. Ist diese aktiviert, wird am unteren Ende der Tabelle der Wert dieser Spalte aufsummiert und in der Ansicht und dem Export angezeigt
-
Reihenfolge → Beim Erzeugen des Berichts werden die Spalten nach dieser Zahl aufsteigend angeordnet
Schaltfläche "Spalten erzeugen"
Mit der Schaltfläche "Spalten erzeugen" können die Spalten automatisch vom System angelegt und bei Bedarf nachträglich bearbeitet werden. Um diese Funktion zu nutzen, muss das SQL Statement durch die "Play"-Schaltfläche (siehe Feld "SQL Statement") einmal erfolgreich ausgeführt worden sein.
Schaltfläche "Alle Spalten löschen"
Mit der Schaltfläche "Alle Spalten löschen" können alle Spalten aus der Spaltenübersicht gelöscht werden. Dies empfiehlt sich zum Beispiel, wenn eine große Ausgabe des SQL Statements geändert und nicht jede Spalte einzeln aus der Spaltenübersicht gelöscht werden soll.
Das hier eingestellte CSV Trennzeichen und Feldtrennzeichen wird bei der Erzeugung einer CSV Datei für diesen Bericht verwendet. Diese Einstellungen sind anzupassen, wenn der Bericht von einem Zielsystem verarbeitet werden soll, welches bestimmte Trennzeichen voraussetzt.
Sollen für verschiedene Benutzer verschiedene Bereiche angezeigt werden, kann dies über "Freigaben" gesteuert werden. In der Übersicht sind alle bisher erstellten Freigaben für Benutzer und deren freigegebenen Bereiche einzusehen.
Mit einem Klick auf "+ Neue Freigabe" wird eine neue Freigabe angelegt.
Folgende Felder stehen bei der Erstellung / Bearbeitung im Freigabe-Dialog zur Verfügung:
-
Mitarbeiter: Es ist der Mitarbeiter auszuwählen, für welchen die Freigabe gelten soll
-
Freigeben: Es ist auszuwählen, welche Bereiche für den Mitarbeiter freigegeben sein sollen. Zur Auswahl stehen dabei 1. Graph, 2. Download, 3. Aktionsmenü und 4. Tab (Reiter)
1. Graph im Dashboard
Der Graph im Dashboard hat eher rudimentäre Funktionen und funktioniert nur für eine Tabelle, nicht mit einem Join.
-
Öffentlich freigeben → Durch Anhaken werden persönliche Freigaben überschrieben
-
Typ → Aus dem Drop-Down-Menü ist die Darstellung des Graphs im Dashboard auszuwählen
-
x-Achsenbeschriftung → Die Beschriftung wird aus der Tabelle entnommen
-
y-Achsenbeschriftung → Es ist die Beschriftung einzutragen
-
Achsenspalte → Die gewünschte Achsenspalte ist einzutragen
-
Daten-Spalte(n) → Die gewünschte Daten-Spalte ist einzutragen
-
Gruppier-Spalte → Die gewünschte Gruppier-Spalte ist einzutragen
-
Datumsformat → Es ist ein Datumsformat aus dem Drop-Down-Menü zu wählen
-
Datumsformat → Aus dem Drop-Down-Menü ist das Datumsformat zu wählen, möglich sind Tage, Wochen und Monate
Anmerkung
Als Spaltenbeschriftung sollten gut verständliche Aliase verwendet werden. Zudem dürfen Aliase nicht doppelt verwendet werden.
2. Datei-Download im Dashboard
-
Öffentlich freigeben → Ist dieser Haken gesetzt, kann jeder Benutzer den Bericht in der Übersicht herunterladen. Zusätzlich müssen noch Haken bei den Formaten gesetzt werden
-
PDF → Ist dieser Haken gesetzt, kann der Bericht als PDF Datei heruntergeladen werden
-
CSV → Ist dieser Haken gesetzt, kann der Bericht als CSV Datei heruntergeladen werden
3. Aktionsmenü in Belegen
Soll ein Bericht zu einer bestimmten Belegart schnell aufgerufen werden, kann der Bericht ins Aktionsmenü eines Belegs integriert werden.
Folgende Felder stehen zur Verfügung:
-
Öffentlich freigeben → Ist dieser Haken gesetzt, wird der Bericht bei allen Benutzern, die Mitarbeiter des im Bericht hinterlegten Projekts sind, in den Belegen im Aktionsmenü angezeigt. Ist dieser Haken nicht gesetzt, ist der Bericht nur bei den Benutzern mit zuvor angelegter, passender Freigabe im Aktionsmenü des Belegs zu sehen
-
Beleg→ Es ist auszuwählen, für welche Belegart der Bericht ins Aktionsmenü eingefügt werden soll. Mögliche Belegarten sind dabei Angebot, Auftrag, Rechnung, Gutschrift, Lieferschein, Bestellung und Produktion
-
Menü-Beschriftung → Es ist die Beschriftung anzugeben, mit welcher der Bericht im Aktionsmenü angezeigt werden soll. Bleibt das Feld leer, wird der Name des Berichts verwendet
-
Format → Bestimmt, in welchem Format der Bericht im Aktionsmenü heruntergeladen wird. Verfügbar sind die Formate CSV und PDF
4. Tab (Reiter) in Software
Soll ein Bericht zu einer bestimmten Belegart schnell angezeigt werden, kann der Bericht als Reiter in der Belegoberfläche integriert werden.
Folgende Felder stehen zur Verfügung:
-
Öffentlich freigeben → Ist dieser Haken gesetzt, wird der Bericht als Reiter in der Detailansicht des Belegs angezeigt. Ist dieser Haken nicht gesetzt, ist der Bericht nur bei den Benutzern mit zuvor angelegter, passender Freigabe als Reiter zu sehen
-
Modul → Hier ist auszuwählen, für welches Modul der Bericht als Reiter eingefügt werden soll. Mögliche Modularten sind hierbei Angebot, Auftrag, Rechnung, Gutschrift, Lieferschein, Bestellung und Produktion
-
Action → Hier ist festgelegt, auf welcher Seite des Belegs der Reiter eingefügt werden soll. Bleibt das Feld leer, wird die Übersichtsseite der Belegart ausgewählt
Anmerkung
Um die richtige Action zu ermitteln, ist genau zu der Ansicht im Beleg zu gehen, in der der Reiter sichtbar werden soll und aus der Adresszeile des Browsers der Wert hinter action= zu kopieren. Beispiel: ihrexentraldomain/index.php?module=auftrag&action=edit&id=1
-
Tab-Beschriftung: Es ist der sichtbare Name anzugeben, welchen der Reiter tragen sollcarry
-
Position→ aus dem Drop-Down-Menü ist auszuwählen, ob der Tab vor oder nach dem Freifeld entstehen sollfield
Im Reiter "Übertragung" gibt es verschiedene Möglichkeiten, wie Berichte automatisch übertragen werden können.
Berichte können u.a. per FTP automatisch übertragen werden.
Folgende Felder stehen dazu zur Verfügung:
-
Aktivieren → Nur wenn dieser Haken gesetzt ist, findet die FTP Übertragung stattplace
-
Aktivieren → Nur wenn dieser Haken gesetzt ist, findet die FTP Übertragung stattmade
-
Passiver Modus → Setze den Haken, um den passiven FTP Modus zu aktivieren. Du kannst diesen Modus einsetzen, wenn der Server keine Verbindung zum Client aufbauen kann. Dies ist beispielsweise der Fall, wenn der Client sich hinter einem Router befindet, der die Adresse des Clients mittels NAT umschreibt, oder wenn eine Firewall das Netzwerk des Clients vor Zugriffen von außen abschirmt. Die Firewall erlaubt in diesem Fall die Datenverbindung, weil sie ihren Ursprung innerhalb der geschützten Zone hat.zone
-
FTP-Host → Der Hostname des FTP Servers ist anzugeben
-
Port → Der Port des FTP-Servers ist anzugeben. Falls dieses Feld leer ist, wird der Standardport 22 für FTP verwendet
-
FTP-Benutzer → Der Benutzername des FTP Servers ist anzugeben
-
FTP-Passwort → Das Passwort des FTP Servers ist anzugeben
-
Übertragungsintervall
-
alle X Tage → Eingabe einer Zahl, z.B. 5 → alle 5 Tage wird der Bericht per FTP übertragen
-
Wöchentlich am → Eingabe einer Zahl, z.B. 2 → immer am 2. Tag der Woche wird der Bericht per FTP übertragen, also einmal in der Woche
-
Monatlich am →Eingabe einer Zahl, z.B. 3 → immer am 3. Tag eines Monats wird der Bericht per FTP übertragen, also einmal im Monat
-
-
Uhrzeit → Hier gibst du die Uhrzeit an, zu welcher der Bericht per FTP übertragen werden soll. Das klappt in der Regel nur, wenn die Übertragung vor dieser Uhrzeit am selben Tag eingerichtet wird. Beispiel: Wenn die Übertragung täglich um 9 Uhr stattfinden soll, dann muss die Übertragung vor 9 Uhr eingerichtet und gespeichert werden
-
Format → Bestimmt, in welchem Format der Bericht als Datei auf den FTP Server übertragen wird. Es stehen die Format CSV und PDF zur Verfügung
-
Dateiname → Es ist der Dateiname des Berichts einzugeben. Falls dieses Feld leer bleibt, wird der Name des Berichts verwendet. Außerdem stehen die Variablen {TIMESTAMP}, {DATUM} und {BERICHTNAME} zur Verfügung, die im Dateinamen dementsprechend ersetzt werden. Der Dateiname sollte am Besten nur aus Buchstaben, Zahlen und Variablen bestehen. Bei Sonderzeichen und auch z.B. "-" kann es sein, dass der Bericht dadurch nicht versendet wird.
Wenn du Berichte per E-Mail versenden möchtest, stelle bitte sicher, dass der Prozessstarter Berichte FTP Übertragung aktiv ist.Weitere Informationen zum Thema Prozessstarter findest du hier.
Folgende Felder stehen zur Verfügung:
-
Aktivieren → Nur wenn dieser Haken gesetzt ist, findet der Versand per E-Mail statt
-
E-Mail-Empfänger → Die E-Mail Adresse des Empfängers des Bericht ist anzugeben
-
Betreff → Der Betreff der E-Mail ist anzugeben
-
Übertragungsintervall
-
alle X Tage → Eingabe einer Zahl z.B. 5 → alle 5 Tage wird der Bericht per E-Mail versendet
-
Wöchentlich am → Eingabe einer Zahl, z.B. 2 → immer am 2. Tag der Woche wird der Bericht per E-Mail versendet, also einmal in der Woche
-
Monatlich am → Eingabe einer Zahl, z.B. 3 → immer am 3. Tag eines Monats wird der Breicht per E-Mail versendet, also einmal im Monat
-
-
Uhrzeit → Es ist die Uhrzeit anzugeben, zu welcher der Bericht per E-Mail versendet werden soll
-
Format → Bestimmt, in welchem Format der Bericht als Datei der E-Mail angehängt wird. Es stehen die Formate CSV und PDF zur Verfügung
-
Dateiname → Es ist der Dateiname des Berichts einzugeben. Falls dieses Feld leer bleibt, wird der Name des Berichts verwendet. Außerdem stehen die Variablen {TIMESTAMP}, {DATUM} und {BERICHTNAME} zur Verfügung, die im Dateinamen dementsprechend ersetzt werden
Falls der Bericht als Download über eine URL benötigt wird, können folgende Felder verwendet werden:
-
Format → Bestimmt, in welchem Format der Bericht beim Aufruf der URL heruntergeladen wird. Zur Auswahl stehen PDF und CSV
-
Verfügbarkeit → Es ist ein "von" und "bis" Datum anzugeben, um festzulegen, in welchem Zeitraum die URL gültig ist. Bleiben diese Felder leer, funktioniert die URL immer
-
Abruf über URL → Um die URL für den Bericht zu erhalten, ist auf die Schaltfläche "Neue URL erzeugen" zu klicken. Die erstellte URL wird angezeigt. Mit dem "Kopieren" Icon rechts neben dem Textfeld kann die URL in die Zwischenablage kopiert werden. Jedes Mal, wenn eine neue URL erzeugt wird, verlieren alle vorherigen URLs ihre Gültigkeit
Wenn andere Anwendungen und externe Tools automatisiert auf den Bericht zugreifen können sollen, kann der Bericht zum Zugriff per REST-API freigegeben werden. Vorraussetzung ist, dass bereits ein REST-API Account angelegt wurde.
Folgende Felder sind zu verwenden:
-
Aktivieren → Wenn der Haken gesetzt ist, kann über die REST-API auf den Bericht zugegriffen werden
-
API-Account → Es ist der API-Account auszuwählen, für den der Bericht freigegeben werden soll. Anwendungen müssen diesen API-Account verwenden, um den Bericht abrufen zu können
-
Format → Bestimmt, in welchem Format der Bericht beim Aufruf der REST-API heruntergeladen wird. Zur Auswahl stehen PDF und CSV
Wie der Bericht per REST-API aufgerufen wird, kann der REST-API Dokumentation entnommen werden. Endpunkt: /v1/reports