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

Haben Sie Eclipse noch nicht installiert, folgen Sie bitte zunächst dieser Anleitung.

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 3.7.2 benötigt wird, die aber im Allgemeinen nicht in Komplettpaketen verfügbar ist. Haben Sie eine andere Version als 3.7.2 installiert, können Sie nach dieser Anleitung BIRT wieder deinstallieren, um es schließlich nach der hier aufgeführten Seite zu installieren.

In ClassiX® wird Eclipse auch als Editor und Debugging-Werkzeug eingesetzt. Da BIRT aber auch das DTD-Plugin mit einschließt, beachten Sie bei Benutzung des InstantView-Features bitte die Hinweise zur Assoziation von .mod-Dateien.
Zur Installation des InstantView-Features

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", Location: "http://download.eclipse.org/birt/update-site/3.7"
  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:
  7. Button "Next", "Next", "Finish"
  8. Nach der Installation Eclipse neu starten

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 3.7.2: http://www.eclipse.org/downloads/download.php?file=/birt/downloads/drops/R-R1-3_7_2-201202141408/birt-runtime-osgi-3_7_2.zip
  2. Entpacken nach z.B. c:\programme\ (dort entsteht ein Ordner birt-runtime-osgi-3_7_2); das BIRT-Verzeichnis muss dabei für den Nutzer schreibbar sein
Name Beschreibung Beispiel Definition
BIRT_HOME In diesem Verzeichnis werden die BIRT Programme gesucht BIRT_HOME=c:\programme\birt-runtime-osgi-3_7_2 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\*;%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.
Wenn kein Report bearbeitet werden soll, dann reicht es die Umgebungsvariable auf %TEMP% zu setzen.
CX_REPORT_DATA=%TEMP% Wird über die allg. Windows-Umgebungsvariable auf dem PC oder über die aufrufende Batchdatei definiert.

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.
Dieser Pfad wird in den rptDesign-Dateien fest angegeben und kann nicht durch einen Platzhalter wie %TEMP% ersetzt werden.
Es ist daher wichtig, dass der Pfad C:\Temp erreicht wird.
CX_REPORT_DATA=C:\Temp
oder
CX_REPORT_DATA=%TEMP%, wenn darüber C:\Temp erreicht wird.
Wird über die allg. Windows-Umgebungsvariable auf dem PC oder über die aufrufende Batchdatei definiert.

BIRT-Report-Dokumente haben die Endungen .rptdesign und .rptlibrary. Diese sollten als Dateiendungen mit "eclipsecall.bat" 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\\eclipsecall.bat\" \"%1\" 0 0 \"C:\\eclipse\\eclipse.exe\""

 

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-3_7_2\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:

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

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.