mirror of
https://github.com/OpenXE-org/OpenXE.git
synced 2024-11-14 20:17:14 +01:00
1 line
19 KiB
Plaintext
1 line
19 KiB
Plaintext
<p><strong><span style="font-size:28px;">Berichte</span></strong></p><p>Mit dem Modul Berichte können Sie sich Unternehmensdaten aus der Xentral Datenbank in Tabellen mit Hilfe von SQL Statements nach Ihren eigenen, unternehmensspezifischen Bedürfnissen ausgeben und exportieren lassen. <br /> </p><h1>Übersicht</h1><p>In der Übersicht sehen Sie alle bereits erstellten Berichte und haben die Möglichkeit neue Berichte über den Button "+ Neuer Eintrag" hinzuzufügen. Sie können außerdem die Berichte über die im Bericht hinterlegten Kategorien und den Berichtenamen durchsuchen, um so schnell Ihren Bericht in der Kachelübersicht zu finden.<br />In einer Kachel können Sie mit den Icons oben rechts den Bericht bearbeiten (Stift-Icon), den Bericht löschen (X), den Bericht kopieren (Papier-Icon) und sich mit dem Info Icon die Beschreibung des Berichts anzeigen lassen. <br />Außerdem haben Sie unten links schwarze Icons (TABLE, CSV, PDF und JSON) zur Auswahl:</p><ul><li><p>TABLE: Mit einem Klick gelangen Sie direkt in die Live Ansicht Ihres Berichts</p></li><li><p>CSV: Download Ihres Berichts als CSV Datei. Haben Sie bei Variablen Ihres Berichts den Haken "Manuell bearbeiten" aktiviert und auch Werte in der Werteauswahl, erscheint ein Dialogfenster in dem Sie die Werte für die Variable zur Befüllung des SQL Statements auswählen können. Ansonsten wird der hinterlegte Standardwert zur Befüllung verwendet.</p></li><li><p>PDF: Download Ihres Berichts als PDF Datei. Haben Sie bei Variablen Ihres Berichts den Haken "Manuell bearbeiten" aktiviert und auch Werte in der Werteauswahl, erscheint ein Dialogfenster in dem Sie die Werte für die Variable zur Befüllung des SQL Statements auswählen können. Ansonsten wird der hinterlegte Standardwert zur Befüllung verwendet.</p></li><li><p>JSON: Gibt den Bericht als JSON Datei zurück.</p></li></ul> <h1>Erstellen / Bearbeiten eines neuen Berichts</h1><p><span style="line-height:100%">Im Reiter „Details“ finden Sie verschiedene Bereiche (Einstellungen, Struktur und Notiz) um Details für Ihren Bericht zu definieren.</span></p><p> </p><h2>Bereich Einstellungen</h2><p><span style="line-height:100%">Hier werden grundlegende Informationen über den Bericht hinterlegt. Folgende Felder stehen Ihnen zur Verfügung:</span></p><ul><li><p><span style="line-height:100%">Name: Geben Sie einen aussagekräften Namen für Ihren Bericht an, um ihn in der Suche der Berichtsübersicht schnell finden zu können.</span></p></li><li><p><span style="line-height:100%">Kategorie: Geben Sie eine frei wählbare Kategorie für Ihren Bericht an. In der Suche der Berichtsübersicht können Sie Ihre Berichte nach Kategorie suchen und anzeigen lassen.</span></p></li><li><p><span style="line-height:100%">Beschreibung: Geben Sie eine Beschreibung an, wie z.B. für welchen Zweck dieser Bericht ist, welche Informationen er ausgibt, oder wofür die erstellten Variablen sind.</span></p></li><li><p><span style="line-height:100%">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 (und bearbeiten?)</span></p></li></ul>Mit einem Klick auf den Button "+ Neue Variable" können Sie eine neue Variable, also einen Platzhalter für Ihr SQL Statement anlegen. Variablen werden im SQL Statement groß geschrieben und von geschweiften Klammern umschlossen, z.B. {PROJEKTNAME}. Folgende Felder stehen Ihnen zur Verfügung:<ul><li><p>Variablenname: Geben Sie einen Variablennamen aus Ihrem SQL Statement an, z.B. PROJEKTNAME</p><ul><li><p>Zulässige Zeichen für Variablennamen: Großbuchstaben, Ziffern, Unterstrich ("_")</p></li><li><p>Unzulässige Zeichen: Kleinbuchstaben, Umlaute sowie "ß", andere Sonderzeichen</p></li></ul></li><li><p>Standardwert: Legen Sie einen Standardwert für diese Variable fest, falls keine weiteren Werte im Feld Werteauswahl hinterlegt wurden.</p></li><li><p>Manuell bearbeiten: Ist dieser Haken aktiviert, bekommen Sie bei der CSV und PDF Ausgabe vorher ein Dialogfenster angezeigt, bei der die nachfolgenden Felder relevant sind:</p><ul><li><p>Dialogtext: Beschriftung des Auswahlfeldes für die Werte im Feld "Werteauswahl".</p></li><li><p>Beschreibung: Dient nur Ihren internen Zwecken und hat sonst keine weitere Verwendung.</p></li><li><p>Werteauswahl: Hier können Sie kommasepariert Ihre Werte die Sie zur Auswahl im Dialogfenster für den Download haben wollen und im Anschluss in den Bericht gefüllt werden, festlegen. Die Werteauswahl wird automatisch um einen Alias mit Doppelpunkt ergänzt, z.B. wird aus ja,nein ein Ja:ja,Nein:nein</p></li></ul></li></ul><p> </p><h2>Bereich Struktur</h2><p><span style="line-height:100%">Hier erfolgt die Eingabe Ihres SQL Statements und es besteht die Möglichkeit ein direktes Ergebnis Ihrer Abfrage zu erhalten. Folgende Felder stehen Ihnen zur Verfügung:</span></p><ul><li><span style="line-height:100%">SQL Statement: Tragen Sie hier Ihr erstelltes SQL Statement ein. Mit dem Play Button an der rechten Seite des Textfeldes können Sie Ihr SQL Statement direkt ausführen und bekommen im Feld Ergebnis eine Rückmeldung, ob das SQL Statement erfolgreich ausgeführt werden konnte oder bei Misserfolg eine Fehlermeldung.</span></li></ul><p><span style="line-height:100%">Ändern Sie etwas an einem bereits gespeicherten SQL Statement, bekommen Sie einen Warnhinweis ("Achtung: ungespeicherte Änderungen!") angezeigt, um Sie darauf aufmerksam zu machen, Ihre Änderungen zu speichern.</span></p><h3>Verwendung von Variablen</h3>Variablen, die Sie als Parameter festgelegt haben, können Sie in ihrer Abfrage verwenden, indem Sie die Variablennamen in geschweiften Klammern eingeben.<br />Zusätzlich zu den von Ihnen festgelegten Parametern stehen Ihnen diese Variablen zur verfügung:<ul><li><p>USER_ID: Id des aktuellen Benutzers</p></li><li><p>USER_PROJECTS: Liste aller Projekte, auf die der aktuelle Benutzer zugriff hat. Kann z.B. zur einschränkung der Ausgabe verwendet werden: "<a href="1" target="_blank">[1]</a> WHERE auftrag.projekt in {USER_PROJECTS}"</p></li><li><p>USER_ADMIN: 1 = aktueller Benutzer ist ein Administrator, 0 = aktueller Benutzer ist kein Administrator</p></li><li><p>REPORT_PROJECT: Id des Projektes, dem der aktuelle Bericht zugeordnet ist.</p></li><li><p>DOCTYPE: (Nur wenn der Bericht aus einem Belegmenü aufgerufen wird) enthält einen dieser belgtypen: "angebot", "auftrag", "gutschrift", "rechnung", "lieferschein", "bestellung", "produktion"</p></li><li><p>DOCID: (Nur wenn der Bericht aus einem Belegmenü aufgerufen wird) enthält die Datenbank Id des Belegs</p></li></ul><h2>Bereich Spalten</h2><p>Die Tabelle zeigt Ihre angelegten Spalten wie Sie im Reiter "Ansicht" und bei Exporten zu sehen sein werden. Sie können Ihre Spalten jederzeit bearbeiten und löschen.</p><h3>Button "+ Neue Spalten"</h3><p>Mit dem Button "+ Neue Spalten" können Sie eine neue Spalte für Ihre Tabelle anlegen. Folgende Felder stehen Ihnen zur Verfügung:</p><ul><li>Spaltenname SQL: Geben Sie die Spalte aus Ihrem SQL Statement an, er darf keinen Tabellenalias beinhalten (z.B. kein a.name, sondern name).</li><li>Bezeichnung: Geben Sie einen Spaltennamen an, um die Überschrift dieser Spalte für die spätere Ansicht oder den Export zu definieren.</li><li>Spaltenbreite (optional): Dieser Wert definiert die Spaltenbreite für die spätere Ansicht oder dem Export.</li><li>Ausrichtung: Gibt die Ausrichtung (Rechts, Mitte, Links) des Inhalts einer Spalte für die spätere Ansicht oder beim Export an.</li><li>Sortierung: Gibt an, ob eine Spalte alphabetisch oder nummerisch sortiert werden soll. Nummerische Sortierung funktioniert nur, wenn die Datenbank Spalte einen nummerischen Datentyp hat. </li><li>Spalte summieren (optional): Ist diese Option aktiviert, wird am unteren Ende der Tabelle der Wert dieser Spalte aufsummiert und in der Ansicht oder dem Export angezeigt.</li><li>Reihenfolge: Beim Erzeugen des Berichts, werden die Spalten nach dieser Zahl aufsteigend angeordnet.</li></ul><p>Button "Spalten erzeugen"</p><p>Mit dem Button "Spalten erzeugen" können Sie sich die Spalten automatisch vom System anlegen lassen und bei Bedarf nachträglich bearbeiten. Damit Sie diese Funktion nutzen können, muss das SQL Statement durch den Play Button (siehe Feld SQL Statement) einmal erfolgreich ausgeführt worden sein.<br /> </p><h3>Button "Alle Spalten löschen"</h3><p>Mit dem Button "Alle Spalten löschen" können Sie alle Spalten aus der Spaltenübersicht löschen. Dies empfiehlt sich zum Beispiel, wenn Sie eine große Ausgabe Ihres SQL Statements ändern und nicht jede Spalte einzeln aus der Spaltenübersicht löschen wollen.<br /> </p><h2>Bereich CSV Eigenschaften</h2><div>Das hier eingestellte Trennzeichen und Feldtrennzeichen wird beim erzeugen einer CSV Datei für diesen Bericht verwendet. Passen Sie diese Einstellungen an, wenn der Bericht von einem Zielsystem verarbeitet werden soll, das bestimmte Trennzeichen voraussetzt.<br /> </div><h2>Bereich Notiz</h2><p>Das Feld "Interne Bemerkung" dient nur für Ihre internen Zwecke und hat sonst keine weitere Bedeutung.</p><h2>Freigaben von Berichten</h2><p>Möchten Sie für verschiedene Benutzer, verschiedene Bereiche anzeigen, können Sie dies über Freigaben steuern. In der Übersicht sehen Sie alle bisher erstellten Freigaben für Benutzer und deren freigegebenen Bereiche.</p><h3>Anlegen / Bearbeiten einer Freigabe</h3><p>Mit einem Klick auf "+ Neue Freigabe" legen Sie eine neue Freigabe an. Folgende Felder stehen Ihnen bei der Erstellung / Bearbeitung im Freigabe-Dialog zur Verfügung:</p><ul><li><p>Mitarbeiter: Wählen Sie den Mitarbeiter aus, für den die Freigabe gelten soll.</p></li><li><p>Freigeben: Wählen Sie aus, welche Bereiche für den Mitarbeiter freigegeben sein sollen. Sie haben die Auswahl zwischen 1. Graph, 2. Download, 3. Aktionsmenü und 4. Tab (Reiter).</p></li></ul><h3>Allgemeine Freigabe Einstellungen</h3><h3>1. Graph im Dashboard</h3><p>Folgt.<br /> </p><h3>2. Datei-Download im Dashboard</h3><ul><li><p>Ö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.</p></li><li><p>PDF: Ist dieser Haken gesetzt, kann der Bericht als PDF Datei heruntergeladen werden.</p></li><li><p>CSV: Ist dieser Haken gesetzt, kann der Bericht als CSV Datei heruntergeladen werden.</p></li></ul><h3>3. Aktionsmenü in Belegen</h3><p>Möchten Sie einen Bericht zu einer bestimmten Belegart schnell aufrufen und nicht erst über das Berichtemodul gehen, können Sie den Bericht ins Aktionsmenü eines Belegs integrieren. Folgende Felder stehen Ihnen zur Verfügung:</p><ul><li><p>Ö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.</p></li><li><p>Beleg: Wählen Sie aus, für welche Belegart der Bericht ins Aktionsmenü eingefügt werden soll. Mögliche Belegarten: Angebot, Auftrag, Rechnung, Gutschrift, Lieferschein, Bestellung und Produktion.</p></li><li><p>Menü-Beschriftung: Geben Sie die Beschriftung an, mit der der Bericht im Aktionsmenü angezeigt werden soll. Bleibt das Feld leer, wird der Name des Berichts verwendet.</p></li><li><p>Format: Bestimmt in welchem Format der Bericht im Aktionsmenü heruntergeladen wird. Es steht das Format CSV und PDF zur Verfügung.</p></li></ul><h3>4. Tab (Reiter) in Software</h3><p>Möchten Sie einen Bericht zu einer bestimmten Belegart schnell ansehen, können Sie den Bericht als Tab (=Reiter) in der Belegoberfläche integrieren. Folgende Felder stehen Ihnen zur Verfügung:</p><ul><li><p>Ö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. </p></li><li>Beleg: Wählen Sie aus, für welche Belegart der Bericht als Reiter eingefügt werden soll. Mögliche Belegarten: Angebot, Auftrag, Rechnung, Gutschrift, Lieferschein, Bestellung und Produktion</li><li>Action: Hier legen Sie fest auf welcher Seite des Belegs der Reiter eingefügt werden soll. Bleibt das Feld leer, wird die Übersichtsseite der Belegart ausgewählt.<br />Tipp: Um die richtige Action zu ermitteln, gehen Sie zu genau der Ansicht im Beleg, in der der Reiter sichtbar werden soll und kopieren Sie aus der Adresszeile ihre Browsers den Wert hinter action=<br />Beispiel: ihrexentraldomain/index.php?module=auftrag&action=<span style="color:#2ecc71;">edit</span>&id=1</li><li><p>Tab-Beschriftung: Geben Sie den sichtbaren Namen, den der Reiter haben soll an.</p></li></ul><p> </p><h2>Übertragung von Berichten</h2><p>Im Reiter "Übertragung" gibt es verschiedene Möglichkeiten, wie Sie Ihre Berichte (automatisch) übertragen können.</p><h3>Per FTP Übertragen</h3><p>Folgende Felder stehen Ihnen zur Verfügung:</p><ul><li><p>Aktivieren: Nur wenn dieser Haken gesetzt ist, findet die FTP Übertragung statt.</p></li><li><p>Typ: Auswahl des Typs (FTP, FTP mit SSL, oder SFTP)</p></li><li><p>FTP-Host: Geben Sie den Hostnamen Ihres FTP Servers an.</p></li><li><p>Port: Geben Sie den Port Ihres FTP-Servers an. Falls leer, wird der Standardport 22 für FTP verwendet.</p></li><li><p>FTP-Benutzer: Geben Sie den Benutzernamen Ihres FTP Servers an.</p></li><li><p>FTP-Passwort: Geben Sie das Passwort Ihres FTP Servers an.</p></li><li><p>Übertragungsintervall:</p><ul><li><p>alle X Tage: Eingabe einer Zahl, z.B. 5 -> alle 5 Tage wird der Bericht per FTP übertragen.</p></li><li><p>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.</p></li><li><p>Monatlich am: Eingabe einer Zahl, z.B. 3 -> immer am 3. Tag eines Monats wird der Bericht per FTP übertragen, also einmal im Monat.</p></li></ul></li><li><p>Uhrzeit: Geben Sie die Uhrzeit an, zu der der Bericht per FTP übertragen werden soll.</p></li><li><p>Format: Bestimmt in welchem Format der Bericht als Datei auf den FTP Server übertragen wird. Es steht das Format CSV und PDF zur Verfügung.</p></li><li><p>Dateiname: Geben Sie den Namen ein, den die Datei des Berichts haben soll. Falls dieses Feld leer bleibt, wird der Name des Berichts verwendet. Außerdem stehen Ihnen die Variablen {TIMESTAMP}, {DATUM} und {BERICHTNAME} zur Verfügung, die im Dateinamen dementsprechend ersetzt werden.</p></li></ul><h3>E-Mail Versand</h3><p>Folgende Felder stehen Ihnen zur Verfügung:</p><ul><li><p>Aktivieren: Nur wenn dieser Haken gesetzt ist, findet der Versand per E-Mail statt.</p></li><li><p>E-Mail-Empfänger: Geben Sie die E-Mail Adresse des Empfängers für den Bericht an.</p></li><li><p>Betreff: Geben Sie den Betreff für die E-Mail an.</p></li><li><p>Übertragungsintervall:</p><ul><li><p>alle X Tage: Eingabe einer Zahl z.B. 5 -> alle 5 Tage wird der Bericht per E-Mail versendet.</p></li><li><p>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.</p></li><li><p>Monatlich am: Eingabe einer Zahl, z.B. 3 -> immer am 3. Tag eines Monats wird der Breicht er E-Mail versendet, also einmal im Monat.</p></li></ul></li><li><p>Uhrzeit: Geben Sie die Uhrzeit an, zu der der Bericht per E-Mail versendet werden soll.</p></li><li><p>Format: Bestimmt in welchem Format der Bericht als Datei der E-Mail angehangen wird. Es steht das Format CSV und PDF zur Verfügung.</p></li><li><p>Dateiname: Geben Sie den Namen ein, den die Datei des Berichts haben soll. Falls dieses Feld leer bleibt, wird der Name des Berichts verwendet. Außerdem stehen Ihnen die Variablen {TIMESTAMP}, {DATUM} und {BERICHTNAME} zur Verfügung, die im Dateinamen dementsprechend ersetzt werden.</p></li></ul><h3>URL teilen</h3><p>Benötigen Sie den Bericht als Download über eine URL um ihn z.B. an Kollegen oder diverse Anwendungen zu schicken, können Sie die folgenden Felder verwenden:</p><ul><li><p>Format: Bestimmt in welchem Format der Bericht beim Aufruf der URL heruntergeladen wird. Zur Auswahl stehen PDF und CSV.</p></li><li><p>Verfügbarkeit: Geben Sie ein "von" und "bis" Datum an, um festzulegen, in welchem Zeitraum die URL gültig ist. Bleiben diese Felder leer, funktioniert die URL immer.</p></li><li><p>Abruf über URL: Um die URL für den Bericht zu erhalten, drücken Sie den Button "+ Neue URL erzeugen". Die erstellte URL wird Ihnen angezeigt und Sie können mit dem Kopieren Icon rechts neben dem Textfeld die URL in Ihre Zwischenablage kopieren. Jedes Mal wenn Sie eine neue URL erzeugen, verlieren alle vorherigen URLs ihre Gültigkeit.</p></li></ul><h3>API-Zugriff Freigeben</h3><p>Wenn andere Anwendungen und externe Tools automatisiert auf den Bericht zugreifen können sollen, kann der Bericht zum Zugfriff per REST-API freigegeben werden.<br />Vorraussetzung ist, dass bereits ein REST-API Account angelegt wurde.</p><ul><li><p>Aktivieren: Wenn der Haken gesetzt ist, kann über die REST-API auf den Bericht zugegriffen werden.</p></li><li><p>API-Account: Wählen Sie hier den API-Account aus, für den der Bericht freigegeben werden soll. Anwendungen müssen diesen API-Account verwenden um den Bericht abrufen zu können.</p></li><li><p>Format: Bestimmt in welchem Format der Bericht beim Aufruf der REST-API heruntergeladen wird. Zur Auswahl stehen PDF und CSV.</p></li></ul>Wie der Bericht per REST-API aufgerufen wird, kann der REST-API Dokumentation entnommen werden. Endpunkt: v1/reports<br /> <h2>Live Ansicht eines Berichts</h2><p>Im Reiter "Ansicht" bekommen Sie das Ergebnis Ihres SQL Statements ausgegeben. Sämtliche Spaltendefinitionen die Sie vorher erstellt haben werden verwendet, wie z.B. die Ausrichtung und Breite einer Spalte.<br />Diese Tabelle können Sie wie die anderen Tabellen in Xentral sortieren (falls kein ORDER BY in Ihrem SQL Statement verwendet wurde) und durchsuchen.</p><h3>Parameter</h3><p>Wenn Sie für den Bericht Parameter mit dem gesetzten Haken bei "Manuell bearbeten" hinterlegt haben, wird für jeden Parameter ein Eingabefeld neben der Tabelle angezeigt.<br />Wenn Sie Ihre Parameter gewählt haben, klicken Sie einmal auf "Parameter festlegen" um die Parameter in die Tabellenansicht zu übernehmen.<br /> </p> |