Benutzerdefinierte Berichte erstellen

Data Crow ermöglicht es den Nutzern, eigene Berichte hinzuzufügen oder die vorhandenen Berichte zu ändern.
Die Berichte werden mit der Software Jaspersoft Studio erstellt. Diese Software kann kostenlos heruntergeladen werden.

Voraussetzungen #

• Zur Erstellung des Berichts muss die Jaspersoft Studio-Software installiert werden. Laden Sie die Software herunter von: https://community.jaspersoft.com/project/jaspersoft-studio. Laden Sie die neueste verfügbare Version herunter.
• Sie benötigen Data Crow Version 4.0.7 oder höher.
• Sie müssen Java installiert haben (Version 17 oder höher). Diese kann von der Oracle-Website heruntergeladen werden: https://www.oracle.com/java/. Dies ist auch eine Voraussetzung für den Betrieb von Data Crow.

Der Berichtsprozess
#

Berichtsvorlagen

Data Crow verwendet kompilierte Berichte von Jaspersoft (.jasper-Datei). Diese befinden sich im Ordner "reports" des Data Crow-Installationsordners.
Wenn die Software aktualisiert wird, wird der Benutzer gefragt, ob er die Berichte in den Berichtsordner der Installation in den Benutzerordner kopieren möchte. Wenn Sie Ihre erstellten oder geänderten Berichte testen möchten, kopieren Sie sie in den Berichtsordner des Benutzerordner.

Jedes Mal, wenn der Berichtsdialog geöffnet wird, durchsucht Data Crow den Berichtsordner des Benutzerordner für bestehende .jasper-Berichtsdateien. Da Data Crow aus mehreren Modulen besteht, müssen die Berichte im Berichtsordner des jeweiligen Moduls abgelegt werden. Die Ordnerstruktur für Berichte für ein bestimmtes Modul ist wie folgt
folgt: /Berichte/<Modulname

Beispiel für Microsoft Windows:

D:\Daten Crow\Daten\Berichte\Software

D:\Daten Crow\Daten\Berichte\Film

Beispiel für Linux:

/Home/Daten Crow Data/Berichte/Software

Anmerkung: kann es sein, dass Ihr Benutzerordner auch Unterverzeichnisse namens PDF und HTML enthält. Dies sind Überbleibsel aus älteren Data Crow-Versionen. Diese werden nicht mehr verwendet und können sicher entfernt werden. Das Gleiche gilt für die darin enthaltenen Dateien.

Erstellung von Berichten

Wenn Sie einen Bericht über Data Crow ausführen (Extras > Bericht erstellen), führt Data Crow drei Dinge aus:

• Data Crow erstellt einen XML-Export der ausgewählten Elemente.
• Data Crow füllt die .jasper-Berichtsdatei mit den XML-Daten.
• Und als letzter Schritt wird der ausgefüllte Bericht im gewählten Zielformat (RTF, PDF oder HTML) gespeichert.

Das Wichtigste ist, dass Data Crow für die Erstellung der Berichte XML-Extrakte verwendet und nicht direkt auf die Datenbank zugreift. Wir werden das XML im nächsten Kapitel verwenden, um einen neuen Bericht zu erstellen (oder einen bestehenden zu ändern).

Zweitens ist es für den Berichtsprozess nicht mehr erforderlich, die Bilder zu exportieren. Jaspersoft tut dies bei Bedarf automatisch, wie es bei den HTML-Berichten der Fall ist.

Einen neuen Bericht erstellen #

Lassen Sie uns einen neuen Bericht erstellen! Wir benötigen eine XML-Datei mit Data Crow-Elementen (als Quelle), um einen Bericht in Jaspersoft zu erstellen und zu gestalten.

Erstellen Sie einen XML-Export

Zunächst benötigen wir eine XML-Beispieldatei, damit wir diese für die Gestaltung unseres Berichts verwenden können.

1. Start Datenkrähe
2. Wählen Sie das Modul, für das Sie einen Bericht erstellen möchten
3. Markieren Sie ein oder mehrere Elemente in der Übersicht, klicken Sie mit der rechten Maustaste und wählen Sie Artikel-Export-Assistent:
   
4. Wählen Sie XML-Export und drücken Sie Weiter
5. Wählen Sie die Zieldatei aus und drücken Sie Weiter
   
   Belassen Sie die Option Bilder auf dem Standardwert
   
6. Lassen Sie alle Felder ausgewählt und drücken Sie Weiter
   
7. Die XML-Datei wird nun erstellt und auf der Festplatte gespeichert.

Beachten Sie, dass wir diese XML-Datei nur als Beispiel für die Erstellung unseres neuen Berichts verwenden werden. Data Crow erstellt den XML-Extrakt automatisch, wenn Sie den Bericht in Data Crow ausführen (Extras > Bericht erstellen). Es ist wichtig, dass Sie die Elemente auswählen, die die meisten Informationen enthalten, sowie ein paar Elemente mit sehr wenigen Informationen. Dies ist immer gut, um den Bericht zu testen.

JasperSoft Studio #

Starten Sie anschließend Jaspersoft Studio. Beim ersten Start werden Sie aufgefordert, einen Speicherort für den Arbeitsbereich auszuwählen. Wählen Sie einen beliebigen Ort. Schließen Sie nach dem Start einen der Begrüßungsbildschirme, bis Sie sich im eigentlichen Arbeitsbereich befinden.

Als erstes müssen wir die XML-Datei, die wir exportiert haben, als Daten-Adapter. Datenadapter werden verwendet, um Berichte mit Daten zu füllen. Wählen Sie die Repository Explorer und klicken Sie mit der rechten Maustaste auf die Registerkarte Datenadapter. Wählen Sie aus dem Rechtsklickmenü Datenadapter erstellen.

Wählen Sie XML-Dokument;

Drücken Sie auf Weiter, um den XML-Datenadapter weiter zu konfigurieren

Füllen Sie mindestens die folgenden Felder aus (andere Felder sind optional und werden in der Dokumentation von Jaspersoft Studio erläutert):

• Name: Geben Sie einen beliebigen Namen ein, der für Sie selbst erkennbar ist.
• Datei: Wählen Sie den XML-Export, wie er von Data Crow erstellt wurde. In meinem Fall war dies text.xml. Beachten Sie, dass diese Datei für die Ausführung des Berichts durch Data Crow nicht verwendet wird, sondern nur für die Gestaltung des Berichts.
• Aktivieren Sie das Kontrollkästchen "Beim Ausfüllen des Berichts den Xpath-Ausdruck des Berichts verwenden". Dies ist sehr wichtig, da Sie sonst einen leeren Bericht für Ihre Testläufe erhalten.

Presse Test um Ihre Einrichtung zu testen.
Presse Oberfläche um die Erstellung des Datenadapters zu beenden.

Einen leeren Bericht erstellen

Wir haben jetzt also eine XML-Datei, die als Datenadapter in Ihrer Jaspersoft-Umgebung eingerichtet ist. Der nächste logische Schritt besteht darin, einen neuen Bericht zu erstellen, der den Datenadapter als Eingabe verwendet.

Navigieren Sie zum Projekt-Explorer. Standardmäßig enthält dieser ein Projekt namens MyReports. Sie können jeden anderen Projektnamen verwenden, der für die Data Crow-Berichte nicht wichtig ist.

Klicken Sie mit der rechten Maustaste auf das Projekt und wählen Sie Neu, Jasper Report.

Jetzt können Sie eine Berichtsvorlage. Für Data Crow-Berichte können Sie jede beliebige Berichtsvorlage wählen. Für weitere Einzelheiten zu diesen Vorlagen verweise ich Sie auf die Jaspersoft Studio-Dokumentation. Für den Moment werde ich die Vorlage Blank A4 wählen. Drücken Sie . Weiter.

Anschließend werden Sie von Jaspersoft Studio aufgefordert, den Bericht zu benennen, damit er in Ihrem Projekt gespeichert werden kann.
Geben Sie dem Bericht einen aussagekräftigen Namen; der Name der Berichtsdatei wird in der Berichtsauswahl von Data Crow angezeigt. Für dieses Beispiel nenne ich diesen Bericht Test. Drücken Sie Weiter um mit dem nächsten Schritt fortzufahren.

Jetzt sind wir im Schritt, wo wir den Datenadapter mit dem Bericht verknüpfen. Dies ermöglicht dem Bericht, die verfügbaren Felder zu finden und sie mit Informationen zu füllen, wenn der Bericht ausgeführt wird.

• Wählen Sie den Datenadapter aus der Dropdown-Liste aus. In meinem Fall heißt er Test XML.
• In dem Feld darunter wird die Struktur der XML-Datei angezeigt. Nun müssen wir festlegen, wie Jaspersoft Studio die XML-Informationen verwenden soll. Für
  Im Beispiel können Sie sehen, dass ich Software-Elemente exportiert habe. Es sind insgesamt 4 Elemente vorhanden, jedes Element wird als Software-Element dargestellt. Wenn wir uns ein einzelnes Element ansehen, können wir alle Felder sehen:
  
• Doppelklicken Sie auf den Knoten, der alle Felder enthält. Dadurch werden alle Elemente im Bericht verfügbar.
  
  Beachten Sie, dass Sie bei XML-Exporten aus anderen Modulen z.B. Film, Buch, Musikalbum, etc. anstelle von software-item. Die folgenden Schritte sind genau dieselben. Drücken Sie Weiter.
• Im nächsten Schritt müssen Sie die Felder auswählen, die in den Bericht aufgenommen werden sollen. Wenn keine Felder aufgelistet sind oder dieser Schritt übersprungen wird, bedeutet dies, dass Sie im vorherigen Schritt einen Fehler gemacht haben. Ich habe alle Felder ausgewählt, indem ich auf die Schaltfläche >> gedrückt habe. Ich empfehle, alle Felder hinzuzufügen, da dies die größte Flexibilität bietet.
  
• An dieser Stelle können Sie wählen Oberfläche den Assistenten. Alternativ können Sie fortfahren, indem Sie auf Weiter was Sie zu der Option führt, die Gruppierung einzurichten. Die Gruppierung wird jedoch in diesem Leitfaden nicht behandelt; ich muss Sie auf die Dokumentation von Jaspersoft Studio verweisen. Sie wird von Data Crow unterstützt, Sie brauchen sich also keine Sorgen zu machen.

Jetzt haben wir einen leeren Bericht mit einem konfigurierten Datenadapter.

Tipps und Tricks zur Gestaltung #

Eine ausführliche Dokumentation zur Gestaltung Ihres Berichts in der Jaspersoft Studio-Software finden Sie auf der Jaspersoft-Website:
https://community.jaspersoft.com/project/jaspersoft-studio

Es sind sowohl Handbücher als auch Wikis verfügbar.

Um Ihnen den Einstieg zu erleichtern, erkläre ich Ihnen einige der Grundlagen.

Layout des Berichts

In der Mitte des Bildschirms finden Sie den Bericht selbst. Sie können die verschiedenen Abschnitte sehen, wie z. B. Titel, Seitenkopf usw. Sie können die Größe der Abschnitte mit der Maus ändern.

Diese Abschnitte können aus dem Gliederungsabschnitt entfernt (oder hinzugefügt) werden:

Hinzufügen von Feldern

Alle Felder als Teil des XML-Datenadapters befinden sich im Gliederungsabschnitt des Arbeitsbereichs. Von hier aus können Sie Felder auf den Bericht ziehen und ablegen:

Multi-Referenzfelder

Beachten Sie, dass ich für jedes Multireferenzfeld eine Feldname-Listenfeld (siehe oben für Beispiele, wie Kategorien-Liste). Dieser enthält die durch Komma getrennten Werte. Wenn Sie stattdessen über die einzelnen Elemente iterieren wollen, müssen Sie eine Liste Element.

Bildfelder (Bilder)

Optional können Sie auch zuerst ein bestimmtes Element in den Bericht einfügen und dann den zu verwendenden Wert angeben. Fügen wir zum Beispiel ein Bild hinzu. Auf der rechten Seite des Bildschirms finden Sie einen Abschnitt namens Palette. Hier finden Sie alle verfügbaren Feldtypen. Wählen Sie Bild und ziehen Sie es per Drag & Drop in den Bericht.

Wählen Sie im daraufhin angezeigten Dialogfeld Benutzerdefinierter Ausdruck. Dadurch wird das Feld Optionen aktiviert.

Drücken Sie die Taste.

Unter
Standardmäßig werden alle Felder angezeigt. Wählen Sie das Bildfeld aus, das Sie hinzufügen möchten, und doppelklicken Sie darauf. Ich habe das Feld Bild-Vorderseite ausgewählt.

Inhalt eines leeren Feldes

Jaspersoft gibt NULL aus, wenn das Feld leer ist. Ich ziehe es vor, dass das Feld nichts anzeigt, wenn ein Feld leer ist. Dies kann über die Eigenschaften des Feldes erfolgen. Wählen Sie das Feld aus, indem Sie auf das Feld im Fenster Hauptbericht Ansicht. Im folgenden Beispiel habe ich das Feld Titel ausgewählt.

Lassen Sie uns die Eigenschaften dieses Feldes ändern. Klicken Sie auf das Feld (wie im obigen Beispiel geschehen). Navigieren Sie nun zum Abschnitt Eigenschaften.
Wählen Sie Textfeld.

Kästchen ankreuzen Strecken mit Überlauf. Wenn der Inhalt zu groß ist, wird das Feld gestreckt, so dass der gesamte Inhalt sichtbar wird.

Feldpositionierung

Jedes dem Bericht hinzugefügte Feld wird automatisch in Bezug auf den oberen Rand ausgerichtet. Dies kann sehr nützlich sein, wenn Sie möchten, dass Ihr Feld immer an der gleichen Stelle bleibt; wenn der Bericht gestreckt wird, bleibt die Position des Feldes in der gleichen relativen Entfernung vom oberen Rand des Berichtsabschnitts.

Dies ist problematisch, wenn Sie das Feld unterhalb eines Textfeldes platziert haben (siehe oben), das Dehnungen mit Überlauf.
Das Feld wird über dem gestreckten Feld platziert, da es sich relativ zum oberen Rand des Berichtsabschnitts positioniert, nicht relativ zum darüber liegenden Feld.

Um dies zu berücksichtigen, setzen Sie dieses Feld auf Position Type Schwimmer stattdessen:

Andere Felder

Es stehen viele Feldtypen zur Verfügung, um den Quellinhalt (die XML-Informationen) anzuzeigen. Es sind auch Felder wie die Seitenzahl verfügbar. Diese Felder finden Sie im Abschnitt "Palette":

Bericht Vorschau #

Während des Entwurfsprozesses können Sie jederzeit eine Vorschau des Berichts erstellen. Klicken Sie auf die Schaltfläche Vorschau, wie unten gezeigt:

In der Vorschau können Sie sehen, wie der Bericht für den Endbenutzer aussieht. Außerdem wird der Bericht auf Fehler geprüft.

Kompilieren und Bereitstellen des Berichts #

Wenn Sie mit dem Bericht fertig sind, können Sie ihn erstellen und ihn Data Crow zur Verfügung stellen. Stellen Sie zunächst sicher, dass Sie die Berichtsdatei speichern. Es ist am besten, die Änderungen immer vor der Erstellung zu speichern, da sie sonst im Endergebnis fehlen könnten.

Navigieren Sie zu Projekt > Sauber. Dadurch wird eine .jasper-Datei erstellt.
Jetzt müssen Sie nur noch die .jasper-Datei in den Ordner Data Crow reports des Benutzerordners kopieren. Die Struktur des Berichtsordners wird im Kapitel "Berichtsprozess" erläutert;
/Berichte/

Sie müssen Data Crow nicht neu starten, um den Bericht auszuführen. Öffnen Sie einfach erneut den Berichtsdialog. Für dieses Beispiel habe ich die Datei "Test.jasper" in den Ordner "reports" meines Benutzerordners kopiert:

• C:\Benutzer\RJ\Daten\Entwicklungsdaten\Berichte\Software

Starten Sie die Bericht erstellen Werkzeug:

Wählen Sie die Test Bericht, den Sie gerade erstellt haben:

Und wählen Sie die Berichtstyp:

Und natürlich die Zieldatei - die Datei, die Ihren Bericht enthalten wird.
Wählen Sie Ausführen, um den Bericht zu erstellen;

Das war's - Sie sollten jetzt eine Berichtsdatei mit Informationen über Ihre Artikel haben!