Lade...
 

Installation von Birt

Installation von BIRT

Wenn Sie Birt schon installiert haben und nur noch benutzen wollen (auch zur Fehlersuche), folgen sie bitte diesem Link.

BIRT ist ein Reporting Tool, das in Java geschrieben ist. Daher setzt es eine Java-Umgebung voraus (http://java.sun.com).

Installation von BIRT in Eclipse

Sofern BIRT noch nicht in Ihrer Eclipse-Version vorhanden ist, können Sie dies bei Bedarf jederzeit nachholen.

Um BIRT zu installieren, wird es in einer bestehenden Eclipse-Version mit dem Update-Manger automatisch nachinstalliert. Von einer bereits vorgefertigten Installation von Eclipse wird abgeraten, da aus Kompatibilitätsproblemen die BIRT-Version 4.6.0 benötigt wird, die aber im Allgemeinen nicht in Komplettpaketen verfügbar ist. Haben Sie eine andere Version als 4.6.0 installiert, können Sie nach dieser Anleitung BIRT wieder deinstallieren, um es schließlich nach der hier aufgeführten Seite zu installieren.

Für die BIRT Version 4.6.0 wird Java 1.8 JDK/JRE (Java 9 und 10 werden nicht unterstützt) benötigt. Falls Sie eine ältere Version installiert haben, können Sie sich hier die neuste Version herunterladen und installieren. Folgen Sie dabei einfach den Anweisungen auf dem Bildschirm.

Installation in Eclipse

  1. Eclipse starten
  2. Help →Install New Software…
  3. Klicken Sie neben der oberen Combobox auf den Button "Add..."
  4. Name: "BIRT 460", Location: "http://download.eclipse.org/birt/update-site/4.10.0", OK
  5. "Show only the latest version of available software ", "Group Items bei Category" und "Contact all update sites during install to find required software" anwählen
  6. "Select All" klicken, es sollte jetzt in etwa so aussehen:
    BIRT-installation.png
  7. Button "Next", "Next", "Finish"
  8. Nach der Installation Eclipse neu starten

Manuelle Installation des BIRT-Plugins (ohne Update-Manager)

BIRT benötigt die folgenden Plug-Ins in Eclipse, deren Vorhandensein Sie vor der manuellen Installation prüfen müssen. Prüfen Sie darüber hinaus möglichst auch, ob die aktuellste Version des Plug-Ins installiert ist.

Ob ein Plug-In vorhanden ist oder nicht, können Sie beispielsweise prüfen, indem Sie sich die Liste aller installierten Plug-Ins anzeigen lassen. Diese finden Sie unter Help → About Eclipse → Installation Details → Plug-Ins. Obige Namen (u.a. mit verschiedenen Erweiterungen) müssen in der Spalte "Plug-in Name" vorkommen.

Wie alle anderen Plug-Ins auch, müssen Sie den Inhalt des ZIP-Ordners in ihr Eclipse-Verzeichnis extrahieren. Beachten Sie dabei, dass ein Ordner "eclipse/" im ZIP-Ordner bereits vorhanden ist.

Sie müssen sich von der BIRT-Download-Seite das BIRT-Framework herunterladen. Ob Sie bereits BIRT installiert haben, erkennen Sie ebenfalls in der Liste aller installierten Plug-ins an dortigen Einträgen mit dem Namen BIRT.

-->

Einbinden von BIRT in ClassiX®

Nachdem BIRT in Eclipse installiert wurde, muss es in ClassiX® eingebunden werden.

BIRT wird auf zwei Arten verwendet:

Für beide Modi muss eine unterschiedliche Installation durchgeführt werden.

Außerdem sollte noch das Barcode-Plugin hinzugefügt werden, um das Drucken von Barcodes zu ermöglichen.

Installation BIRT-Runtime (zum Ausführen von Reports)

  1. Download von BIRT-Runtime 4.10.0: https://www.eclipse.org/downloads/download.php?file=/birt/downloads/drops/R-R1-4.10.0-202210031241/birt-runtime-4.10.0-20221001.zip
  2. Entpacken nach z.B. C:\birt-runtime-4.10.0; das BIRT-Verzeichnis muss dabei für den Nutzer schreibbar sein
  3. Auf dem Rechner/Server muss mind. die Java Version 11 verhanden sein 
Name Beschreibung Beispiel Definition
BIRT_HOME In diesem Verzeichnis werden die BIRT Programme gesucht
SET BIRT_HOME=C:\birt-runtime-4.10.0
Wird über die allg. Windows-Umgebungsvariable auf dem PC oder über die aufrufende Batchdatei definiert.
BIRT_RESOURCE_FOLDER In dieses Verzeichnis werden Report-Elemente für das ClassiX® Projekt abgelegt
SET BIRT_RESOURCE_FOLDER= %CX_ROOTDIR%\BIRT
Wird in der "projekt_START" Batchdatei definiert
(z. Bsp.: Evaluate_START.bat)
CLASSPATH Mit dieser Variablen sucht Java die BIRT- und ClassiX-Bibliotheken
SET CLASSPATH= %CX_BIN%\birt-interface.jar; %BIRT_HOME%\ReportEngine\lib\*; %BIRT_HOME%\ReportEngine\addons\*; %CLASSPATH%
CX_REPORTS In diesen Verzeichnissen sucht ClassiX nach den Reports
SET CX_REPORTS= %CX_ROOTDIR%\BIRT\%CX_PROJECT_NAME%; %CX_ROOTDIR%\BIRT
CX_REPORT_DATA In dieses Verzeichnis werden die xml-Dateien für die Data-Source abgelegt, die beim Bearbeiten der Berichte in Eclipse-BIRT zum Erstellen der Vorschau genutzt wird.

In älteren Berichten muss diese Variable auf C:\Temp gesetzt werden.

In neueren Berichten kann die Umgebungsvariable auch davon abweichen, da mittels eines Skriptes überprüft wird, wie diese gesetzt ist. Dafür muss die Umgebungsvariable aber als allg. Windows-Umgebungsvariable und nicht über die aufrufende Batchdatei definiert werden, da sowohl ClassiX als auch Eclipse diese Variable benutzt!
Ob ein Skript vorhanden ist kann im Bericht überprüft werden unter Data-Explorer -> Data Source -> Data Source -> Property Binding -> ist Code bei "XML Data Source File" vorhanden? Um zu testen, ob der richtige Pfad benutzt wird, muss man ein Data-Binding anlegen in den man den oben beschriebenen Code reinkopiert und anschließend die Preview aufrufen, damit der Code ausgeführt wird.

 

Achtung!
Auf diese Umgebungsvariable greifen beim Bearbeiten von BIRT-Berichten sowohl ClassiX als auch Eclipse-BIRT zu. Definieren Sie diese Umgebungsvariable deshalb bitte als Windows-Umgebungsvariable und nicht in der aufrufenden Batchdatei.

Für den normalen Benutzer sollte CX_REPORT_DATA in der aufrufenden Batch auf %TEMP% gesetzt werden.

Für die Benutzer, die mit Eclipse die Berichte bearbeiten, sollte CX_REPORT_DATA als eigene Windowsvariable gesetzt werden.

ältere Reports:

CX_REPORT_DATA=C:\Temp
oder
CX_REPORT_DATA=%TEMP%, wenn darüber C:\Temp erreicht wird.

neue Reports:

CX_REPORT_DATA=beliebig, aber als Windows-Umgebungsvariable! 

PATH Sollte automatisch gesetzt werden wenn Java installiert wurde. Deshalb nur kontrollieren falls Fehler auftreten:
Dieses Verzeichnis wird unter anderem dazu genutzt den Ort der Java Report Engine (JRE) zu lokalisieren, mit der Java-Programme aufgerufen werden. Da BIRT und auch das Birt-Interface in Java geschrieben ist, muss der Pfad das Installationsverzeichnis des JRE beinhalten. 
SET PATH= "C:\Program Files (x86)\Java\jre\bin"; %Path%
Wird über die allg. Windows-Umgebungsvariable auf dem PC oder über die aufrufende Batchdatei definiert.

Achtung!
Wird ClassiX® nicht mit Rechten zum Vollzugriff gestartet, kann es ab der BIRT 3.7.2-Runtime zu Fehlern kommen.
Nähere Hinweise finden Sie im Abschnitt Konfiguration von BIRT ab 3.7.2.

Installation von BIRT an einer ClassiX® Workstation (zum Entwerfen von Reports)

Der BIRT-Designer ist ein Plugin für Eclipse. Zur Installation siehe bitte hier. Anschließend sind gewisse Einstellungen in Eclipse vorzunehmen:

  1. Window/Preferences
  2. "Report Design" aufklappen
  3. Layout: Default Unit nach Belieben setzen (z.B. cm oder mm)
  4. Resource: Auswahl des Resource-Folders (zentraler Folder, kann leider nicht projektabhängig sein): y:\classix\Evaluate\BIRT

In den ClassiX-Projekten werden folgende Umgebungsvariablen verwendet und sollten in den Batch-Files oder der Systemumgebung gesetzt werden:

Name Beschreibung Beispiel Definition
CX_REPORTS_OUT In dieses Verzeichnis werden neue Reports abgelegt, die in ClassiX automatisch erstellt werden SET CX_REPORTS_OUT=%CX_ROOTDIR%\BIRT\%CX_PROJECT_NAME% ClassiX (Evaluate_START.bat)
CX_REPORT_DATA In dieses Verzeichnis werden die xml-Dateien für die Data-Source abgelegt, die beim Bearbeiten der Berichte in Eclipse-BIRT zum Erstellen der Vorschau genutzt wird.

In älteren Berichten muss diese Variable auf C:\Temp gesetzt werden.

In neueren Berichten kann die Umgebungsvariable auch davon abweichen, da mittels eines Skriptes überprüft wird, wie diese gesetzt ist. Dafür muss die Umgebungsvariable aber als allg. Windows-Umgebungsvariable und nicht über die aufrufende Batchdatei definiert werden, da sowohl ClassiX als auch Eclipse diese Variable benutzt!
Ob ein Skript vorhanden ist kann im Bericht überprüft werden unter Data-Explorer -> Data Source -> Data Source -> Property Binding -> ist Code bei "XML Data Source File" vorhanden? Um zu testen, ob der richtige Pfad benutzt wird, muss man ein Data-Binding anlegen in den man den oben beschriebenen Code reinkopiert und anschließend die Preview aufrufen, damit der Code ausgeführt wird.

ältere Reports:

CX_REPORT_DATA=C:\Temp
oder
CX_REPORT_DATA=%TEMP%, wenn darüber C:\Temp erreicht wird.

neue Reports:

CX_REPORT_DATA=beliebig, aber als Windows-Umgebungsvariable!

Achtung!
Auf diese Umgebungsvariable greift beim Bearbeiten von BIRT-Berichten sowohl ClassiX als auch Eclipse-BIRT zu. Definieren Sie deshalb bitte diese Umgebungsvariable als Windows-Umgebungsvariable und nicht in der aufrufenden Batchdatei.

BIRT-Report-Dokumente haben die Endungen .rptdesign und .rptlibrary. Diese sollten als Dateiendungen mit "eclipse.exe" verknüpft werden, damit sie aus ClassiX oder dem Explorer aus geöffnet werden können.

Registry Eintrag für .rptdesign und .rptlibrary

Windows Registry Editor Version 5.00 [HKEY_CLASSES_ROOT\.rptdesign] @="birt_rpt_file" [HKEY_CLASSES_ROOT\.rptlibrary] @="birt_rpt_file" [HKEY_CLASSES_ROOT\birt_rpt_file] @="BIRT Report-Datei" [HKEY_CLASSES_ROOT\birt_rpt_file\shell] @="" [HKEY_CLASSES_ROOT\birt_rpt_file\shell\open] [HKEY_CLASSES_ROOT\birt_rpt_file\shell\open\command] @="\"C:\\eclipse\\eclipse.exe\" \"%1\" 0 0 "

 

Installation des Barcode-Plugins für Birt

 

Um das Barcode-Plugin verwenden zu können, müssen Sie hier das .zip File herunterladen und entpacken. Nun müssen Sie das .jar File "org.instantview.birt.barcode_0.1.0.jar" aus dem Verzeichnis build an zwei Orte kopieren (zur ausführlichen Installations-Beschreibung und zur Fehlerbehebung siehe Anleitung für Anwender).

  1. Barcode-Plugin im Designer verwenden:
    Kopieren des Plugins "org.instantview.birt.barcode_0.1.0.jar" ins Installationsverzeichnis von Eclipse in den Unterordner Plugins (Beispiel: C:\eclipse\plugins)
  2. Barcode-Plugin verwenden um Reports mit Barcodes von ClassiX aus drucken zu können:
    Kopieren des Plugins "org.instantview.birt.barcode_0.1.0.jar" ins Birt-Home-Verzeichnis in den Unterordner ReportEngine\Plugins. Das Birt-Home-Verzeichnis sollte bereits als Systemvariable festgelegt worden sein (siehe oben; Beispiel: c:\programme\birt-runtime-osgi-4_6_0\ReportEngine\plugins).

Zur Weiterentwicklung des Plug-Ins siehe Anleitung für Entwickler.

Fehlersuche bei der Installation von BIRT

Falls bei der Installation von BIRT Fehler auftreten sollten, überprüfen Sie bitte, ob die folgenden Plug-ins installiert sind:

Ob ein Plug-In vorhanden ist oder nicht, können Sie beispielsweise prüfen, indem Sie sich die Liste aller installierten Plug-Ins anzeigen lassen. Diese finden Sie unter Help → About Eclipse → Installation Details → Plug-Ins. Obige Namen (u.a. mit verschiedenen Erweiterungen) müssen in der Spalte "Plug-in Name" vorkommen.

Falls nicht alle Plug-ins installiert sind, müssen Sie diese nachinstallieren. Dazu gehen Sie bitte folgendermaßen vor:

  1. Help →Install New Software…
  2. Klicken Sie neben der oberen Combobox auf den Button "Add..."
  3. Name: "....", Location: "...."
    1. Name: "DTP", Location: "http://download.eclipse.org/datatools/updates"
    2. Name: "EMF", Location: "http://download.eclipse.org/modeling/emf/updates/releases/"
    3. Name: "GEF", Location: "http://download.eclipse.org/tools/gef/updates/releases/"
    4. Name: "WTP", Location: "http://download.eclipse.org/webtools/repository/helios/"
  4. Button "Next", "Next", "Finish"
  5. Nach der Installation Eclipse neu starten

Falls trotz der Nachinstallation BIRT nicht richtig funktioniert, löschen Sie das Installationsverzeichnis von Eclipse (meist "C:\Eclipse") am besten komplett und starten Sie von neuem.

Update von 2.5.1 auf 3.7.2

Anfang Mai 2012 wird das System von der BIRT-Version 2.5.1 auf 3.7.2 umgestellt, um die Features der neueren Versionen nutzen zu können. Um auf die neue Version umzustellen gehen Sie bitte folgendermaßen vor:

Zum Verändern und Erstellen von Reports in Eclipse:

Zum Drucken von Reports von ClassiX aus:

Zum Erstellen und Drucken von Barcodes in Reports:

  • Überprüfen ob das Barcode-Plugin noch ordnungsgemäß in den Verzeichnissen vorhanden ist, wie in dieser Anleitung beschrieben.

Folgende Internetseiten beschreiben die Neuerungen, die zwischen Version 2.5.1 und 3.7.2 eingeführt wurden:

Update von 3.7.2 auf 4.6.0

Anfang 2018 wird das System von der BIRT-Version 3.7.2 auf 4.6.0 umgestellt, um die Features der neueren Versionen nutzen zu können. Um auf die neue Version umzustellen gehen Sie bitte folgendermaßen vor:

Zum Drucken von Reports von ClassiX aus:

Zum Erstellen und Drucken von Barcodes in Reports:

  • Überprüfen ob das Barcode-Plugin noch ordnungsgemäß in den Verzeichnissen vorhanden ist, wie in dieser Anleitung beschrieben.

Update von 4.6.0 auf 4.9.0

Um auf die neue Version umzustellen sind folgende Änderungen nötig:

  1. Ab BIRT Version 4.9 ist mindestens Java 11 erforderlich.
  2. Ab Version 4.7 muss der Addons Ordner zum CLASSPATH hinzugefügt werden, siehe die Liste oben für ein Beispiel.

Zum Drucken von Reports von ClassiX aus:

Zum Erstellen und Drucken von Barcodes in Reports:

  • Überprüfen ob das Barcode-Plugin noch ordnungsgemäß in den Verzeichnissen vorhanden ist, wie in dieser Anleitung beschrieben.

Konfiguration von BIRT ab 3.7.2

 

Möglichkeit 1: Vollzugriff auf BIRT-Runtime-osgi_3-7-2/BIRT-Runtime-osgi_4-6-0

In dem Verzeichnis der BIRT-Runtime-osgi-4_6_0/ReportEngine muss der Ordner "Configuration" für jeden User mit Lese- und Änderungsrechten Versehen werden, sonst können die Reports nicht erstellt werden. In der Praxis wird bei fast allen Kunden Vollzugriff auf den gesamten Ordner der BIRT-Runtime-osgi-4_6_0 für alle User gesetzt, um Probleme dieser Art generell zu vermeiden. Dabei ist zu überprüfen, ob bei den Rechten für alle Nutzer die Punkte "Unterordner und Dateien löschen" und "Löschen" zumindest für den Ordner "Configuration" gesetzt wurden. Die alleinige Berechtigung für Schreiben und Ändern reicht nicht aus, da temporäre Dateien aus den Unterordnern wirklich gelöscht und neu erstellt werden.

Möglichkeit 2: ClassiX mit Administrator-Rechten starten

Wird ClassiX mit Administrator-Rechten gestartet, hat der Nutzer automatisch Vollzugriff auf den Ordner "Configuration", sodass keine weiteren Probleme auftreten.

Batch-Dateien können unter Windows 7 im Kontextmenü als Administrator gestartet werden:

startAdminContext.PNG

Wird ClassiX über eine Verknüpfung ausgeführt, so kann dieser über "Rechtsklick → Eigenschaften → Verknüpfung → Erweitert → Als Administrator ausführen" die Administrationsrechte hinzugefügt werden.

startAdminShortcut1.pngstartAdminShortcut2.PNG

Benutzung von BIRT

Mit diesem Link kommen Sie Zur Benutzung von und Fehlersuche in BIRT. Hier werden Tipps und Tricks zur Reporterstellung vorgestellt und sie können im Abschnitt Fehlersuche nach Lösungsvorschlägen schauen.