Berichte
- Beschreibung
- Funktionalität
- Im- und Export
- Zusammensetzung des Dateinamens eines Berichtes
- Verwandte Themen
- Technische Dokumentation
- Tipps zur Benutzung von BIRT zur Berichterstellung im ClassiX System
Beschreibung
Im ClassiX System können alle auf dem Bildschirm dargestellten Listen über die Zwischenablage in andere Programme - wie z.B. Excel - übertragen werden. Folgerichtig können und werden aus diesen Listen Berichte erstellt. Ein Bericht ist - dem ClassiX Sprachgebrauch nach - eine mit einem Designtool aufbereitete Liste, die Listen stellen somit auch immer die Datenbasis für Berichte dar.
Einen neuen Report erstellt man daher am besten aus dem Reporting-Fenster heraus, das schon mit den Daten einer Liste aufgerufen wurde. Nur in diesem Fall, wenn also auch schon Daten (aus einer Liste) zur Verfügung stehen, können Sie den Bericht Designer öffnen. Falls Sie kein aktuelles Listenfenster mit Daten haben, können Sie sich aber auch auf eine schon existierende XML-Datei aufbauend arbeiten.
Alternativ könnten Sie das Bericht-Fenster auch dafür geöffnet haben, weil Sie einen vorhandenen Bericht bearbeiten möchten. Sie können dann z.B. den Namen und/oder die Beschreibung ändern oder das Layout des Berichts mit dem Berichte Designtool bearbeiten.
Eine weitere Möglichkeit zur Erstellung von Berichten ist die Nutzung des Datenabfrage Assistenten.
Funktionalität
- Eingabefenster
- Definierte Nummernbereiche
- Listenfenster
- Selektionsfenster
- Selektionsfenster zur Berichtsausführung
Eingabefenster
Dieses Fenster dient der Pflege von Berichten. Auf dem Reiter Bericht im Eingabefenster befinden sich einige Allgemeine Angaben zu einem Bericht. Diese lassen sich an dieser Stelle auch editieren und werden durch Klicken auf das Speichern-Symbol oder den OK-Knopf gespeichert. Legen Sie einen neuen Bericht an, sollten Sie im Feld Berichtsname dem Bericht einen Namen geben und gegebenenfalls eine weitergehende Beschreibung eintragen. Über die Kategorie wird im ClassiX® System bestimmt, welche Berichte zu welcher Liste / zu welchem Listenfenster gehören. Diese ist daher entsprechend sorgfältig auszuwählen.
Eine Besonderheit ist, dass es in der Toolbar dieses Eingabefensters zwei Knöpfe gibt, den Berichte Designtool zu starten. Der Knopf Reporttool-Designer kann immer dann verwendet werden, wenn schon Daten bekannt sind, also z.B. wenn dieses Eingabefenster aus dem Reporting-Fenster heraus aufgerufen wurde. Die andere Möglichkeit den Designer zu starten, ohne dass man aus dem Reporting-Fenster gekommen ist - also keine Daten bekannt sind- , ist der Knopf Reporttool-Designer, aus Datei laden. Es wird dort nach einer XML-Datei gefragt.
Menüpunkt | Beschreibung |
---|---|
Bearbeiten | - |
: Merkmale | |
: : Einfügen | Ein im System bereits vorhandenes Sachmerkmal wird dem Bericht hinzugefügt |
: : Anlegen | |
: : : Voreinstellbares | Ein neu angelegtes voreinstellbares Sachmerkmal wird dem Bericht hinzugefügt |
: : : Errechnetes | Ein neu angelegtes errechnetes Sachmerkmal wird dem Bericht hinzugefügt |
: : : Bedingtes | Ein neu angelegtes bedingtes Sachmerkmal wird dem Bericht hinzugefügt |
: : Entfernen | Das in der Liste der Merkmale selektierte Sachmerkmal wird von dem Bericht entfernt |
: Schließen | Fenster schließen |
BIRT Berichtsdesigner | - |
: BIRT einrichten | BIRT Berichte werden mit dem auf eclipse basierenden BIRT Designtool editiert. Diese Berichte haben als Datei die Endung .rptdesign. Um durch Doppelklick auf eine solche Datei den Designer direkt aufrufen zu können, muss diese Endung im System registriert und der entsprechende Aufruf konfiguriert (über eine Datei eclipsecall.bat) werden. Dieses geschieht durch diesen Menüpunkt, führt man diesen aus, können BIRT Berichte direkt durch Doppelklick aus einem Verzeichnis heraus zum Editieren aufgerufen werden. (nur ab ClassiX DLL Version 4.5 verfügbar) |
: Version | Versionsinformationen zum Bericht Designtool anzeigen |
Suchen | Listenfenster aufrufen |
Symbol | Beschreibung |
---|---|
Neuen Bericht anlegen | |
Änderungen speichern | |
Bericht löschen | |
Bericht drucken | |
Notizen anlegen/bearbeiten | |
Layout-Vergleich aufrufen (Stimmt die aktuelle ClassiX-Liste mit der Liste im BIRT-Report überein? siehe Umgebungsvariable CX_DIFF_EDITOR) | |
Bericht Designtool (BIRT) aufrufen | |
Bericht Designtool (BIRT) aus Datei laden |
Feld | Beschreibung |
---|---|
Bericht | |
: Bericht | |
: : Berichtsname | Name des Berichtes. Diesen Namen sehen die User, wenn sie ein Bericht über den Button "In die Zwischenablage kopieren" erstellen wollen. |
: : Berichts-ID | Eindeutige ID (Nummer) des Berichts - siehe Definierte Nummernbereiche |
: : Datenkonnektor | Der Datenkonnektor, dem dieser Bericht zugeordnet ist. |
: : Kundeneigener Bericht | Handelt es sich um einen kundeneigenen bzw. kundenspezifischen Bericht, dann wird das Design zum Bericht als *.rptdesign Datei im Kundenunterordner des BIRT Verzeichnisses gespeichert bzw. dort zum Erstellen des Berichts gesucht. Wird bei der Zusammensetzung des Dateinames verwendet. |
: Dateiname | |
: : Kontext (App Name) | Hier muss der Modulname (ohne die Endung .mod) eingegeben werden, aus dem dieser Bericht aufgerufen wird, zum Beispiel itemedt für einen Bericht aus dem Teilestamm. Der Modulname darf keine Umlaute, Leer-, oder Sonderzeichen enthalten. Dieses wird beim Speichern abgeprüft. Wird bei der Zusammensetzung des Dateinamens verwendet. |
: : Berichtsname | Mit diesem Namen wird die Datei mit dem Design für den Bericht erstellt (*.rptdesign). Der Dateiname darf keine Umlaute, Leer-, oder Sonderzeichen enthalten. Dieses wird beim Speichern abgeprüft. Wird bei der Zusammensetzung des Dateinamens verwendet. |
: : Standardliste | Mit dieser Auswahl wird der Bericht als Standardliste im angegebenen Kontext angezeigt. Für wen dies gilt, kann im Reiter "Freigabe/Standard" definiert werden. |
: Beschreibung | |
: : Beschreibung | Erläutender Beschreibungstext zum Bericht |
: Ausgabe | |
: : Medium | Definition des Ausgabemediums des Berichts.
Für das Drucken und Anzeigen werden standardisierte Windowsfunktionen verwendet. Ist z.B. PDF als Format gewählt, muss gewährleistet sein, dass das automatische Anzeigen und Drucken von Dateien im PDF Format auf dem Windowssystem möglich ist. |
: : Papier Ausrichtung | Auswahl zwischen "Hochformat" und "Querformat" für die Formatierung der Ausgabe |
: : Format | Datenformat der Ausgabedatei. Die Ausgabe des Berichts unterscheidet sich je nach Format. Die Standardbericht sind für die Ausgabe im PDF Format optimiert. |
: : Papier Format | Definition der Papiergröße mit der die Ausgabedatei formatiert werden soll. Mögliche Definitionen sind A0- A10, US Legal and US Letter |
: : Bericht bleibt aktiviert! | Der Bericht bleibt nach dem Schliessen des Berichtsfensters bzw. nach dem Drucken oder der Datenübermittlung an BIRT geladen. |
: Drucker | |
: : Standarddrucker | Defintion des Druckers, auf dem der Bericht ausgegeben werden soll. |
: : Kopien | Defintion des Druckers, auf dem die Kopien ausgegeben werden sollen. |
: : Anzahl Kopien | Die Anzahl der Kopien. |
: Archivierung | |
: : Keine | Diese Optionen gelten als Voreinstellung für den Bericht und werden bei der Selektion des Berichtes in das Reporting-Fenster übernommen. Sie können dort aber überschrieben werden.
Beim Registrieren wird ein der Druck dieses Reports registriert. Dies bedeutet, dass eine Ausgabe-Objekt erzeugt wird, welches den aufrufenden User, das Datum und die Uhrzeit speichert. Somit kann man nachvollziehen wann und wer einen Report gedruckt hat. Beim Archivieren wird zusätzlich zum Registrieren auch ein PDF des gedruckten Reports gespeichert. Dieses wird entweder in der Datenbank oder in einem Verzeichnis abgelegt. Zu letzt genannte Option wird über die Option "Archivierung in Verzeichnis" und durch die Auswahl des Verzeichnisses aktiviert. |
: : Registrieren | |
: : Archivieren | |
Listenaufbau | |
: Prozeduren | Lokal definierte Prozeduren, welche innerhalb der Datenspalten aufgerufen werden können. Über den Notizknopf kann der Inhalt in einem separaten Fenster bearbeitet werden. |
: Listenspalten |
Als Listenspalten werden die Spalten der Liste bezeichnet. Die Listenspalten bestimmen, welche Daten der Objekte ausgewertet ausgegeben werden |
: : Laden | Es werden die Spalten der aufrufenden Liste als Datenspalten übernommen und am Bericht hinterlegt. Anschließend können die nicht benötigten Spalten des Standardformats entfernt werden. |
: : Einfügen | Es kann eine neue Spalte eingefügt werden. Die kann entweder "manuell" geschehen, indem man die Spaltendefinition selbst erfasst oder über den Zugriffsausdruck-Konfigurator, der einem bei der Definition der Spalte unterstützt. |
: : Liste | Zeigt die definierten Spalten an. Per Doppelklick kann die Datenspalten Definition editiert werden. |
: : Pfeile | Verschiebt markierte Spalten. Dadurch kann die Reihenfolge der Spalten in der Liste verändert werden. |
: : Entfernen | Löscht die selektierten Spalten. |
: Listensortierung | |
: : Laden | Es wird die aktuelle Listensortierung der angezeigten Liste übernommen. Anschließend können Sie die Spalten bearbeiten. |
: : Einfügen | Eine neue Spalte einfügen. Diese kann entweder als Spaltenzahl (bei Null beginnend) oder als Zugriffsausdruck (z.B. "uniqueID") angegeben werden |
: : Liste | Per Doppelklick kann die Zeile editiert werden. Mit der rechten Maustaste kann ein Kontextmenü zur weiteren Bearbeitung geöffnet werden. |
: : Pfeile | Verschiebt markierte Spalten. Dadurch kann die Reihenfolge der Spalten in der Liste verändert werden. |
: : Entfernen | Löscht die selektierte Spalten. |
Merkmale |
Für den Bericht können Merkmale definiert werden, auf die später im BIRT-Bericht über einer Variable bzw. bei der Filterung der Datenbasis über den PlugSpace zugegriffen werden können. Die Merkmale werden immer in der letzten Variable, die an BIRT übergeben wird, definiert. Die einzelnen Merkmale werden durch "||" getrennt zu einem String zusammen gesetzt. Mit diesem Javascript können Sie z.B. die Variablen in einem Array in BIRT definieren.
Beispiel für einen BIRT-Bericht mit Merkmalen ist die Inventur-Zählliste! |
Automation | |
: Automation |
Als Datenbasis werden die Objekte einer Liste bezeichnet, welche die Grundlage des Berichts oder des Kopierens in die Zwischenablage darstellt. |
: : Bericht ausführen | Über "Bericht ausführen" wird die Datenbasis neu zusammengestellt, indem die Kommandos der Reihe nach ausgeführt werden.
In der Regel sind auch die Kommandos zum Aufruf der Liste hinterlegt. Dies bietet Ihnen folgende Möglichkeit: Sie können die Berichte in ihre Favoriten ziehen. Sie haben dann die Möglichkeit den Bericht über diese zu öffnen und sich die Datenbasis über "Bericht ausführen" zusammenstellen zu lassen. Es wird sowohl das Listefenster geöffnet, die Daten zusammengestellt und direkt das Reporting-Fenster geöffnet, so dass ohne viel Aufwand der Bericht gedruckt werden kann. |
: : Datenquelle | |
: : : Datenkonnektor | Die Datenbasis kommt aus dem Datenkonnektor. |
: : : Eigene Definition | Die Datenbasis wird anhand von Kommandos selbst in diesem Bericht definiert. |
: : Daten aus Datenkonnektor | Diese Gruppe wird nur angezeigt, wenn in der Gruppe "Datenquelle" die Option "Datenkonnektor" ausgewählt ist. |
: : : Auswahlfenster | Die Datenbasis wird über eine im Datenkonnektor definierte Auswahl-App vom Benutzer zur Laufzeit bestimmt. Hier kann auch die entsprechende Auswahl-App gewählt werden. |
: : : Grundgesamtheit | Die Grundgesamtheit des Datenkonnektors wird verwendet. Rechts werden die Befehle zur Erstellung der Grundgesamtheit zur Information angezeigt. |
: : Eigene Kommandos zur Abfrage der Datenbasis |
Diese Gruppe wird nur angezeigt, wenn in der Gruppe "Datenquelle" die Option "Eigene Definition" ausgewählt ist. Hier können Befehle zur Erstellung der Datenbasis definiert werden. Weitere Informationen dazu finden Sie hier. Diese Befehle werden nur ausgeführt wenn nicht schon eine Datenbasis vorgegeben wurde. Wenn der Bericht für eine Liste aufgerufen wird oder aus einem speziellen Kommando, werden diese Befehle nicht ausgeführt. Wird der Bericht hingegen als Automatikbericht gestartet, werden diese Befehle ausgeführt. |
: Kommandos zur Filterung der Datenbasis |
Diese Kommandos werden nach Holen der Datenbasis ausgeführt und können zur Filterung verwendet werden. Weitere Informationen finden Sie hier. Die hier angegebenen Befehle werden unabhängig vom Start und der Quelle der Datenbasis immer ausgeführt. |
Freigabe/Standard | |
: Bericht freigegeben für | In dieser Liste werden Mandanten, Kostenstellenknoten, Kostenstellen und Benutzer eingetragen, die den Bericht bei der Auswahl im "Drucke Bericht" Dialog angezeigt bekommen. Diese Bericht können trotzdem noch als Standard Bericht in den Benutzereinstellungen und im Bericht definiert werden.
Wenn keine Auswahl getroffen wird, ist der Bericht für alle Benutzer und Mandanten verfügbar. |
: Standard Bericht für | In dieser Liste können Mandanten, Kostenstellenknoten, Kostenstellen und Benutzer eingetragen werden, die den Bericht als Standardformatierung in der Bildschirmanzeige verwenden sollen.
Jeder Benutzer kann nur einen gültigen Standard Bericht haben. Das System sucht in der Reihenfolge Benutzer - Kostenstelle - Kostenstellenknoten - Mandanten. Ist ein Bericht bereits in der Benutzereinstellungen definiert, wird dieser verwendet. |
Knopf | Beschreibung |
---|---|
Zurück | Das Fenster wird geschlossen. |
Speichern | Der Bericht wird gespeichert. |
Definierte Nummernbereiche
Die Nummern für die Berichte sind in Kategorien einzuteilen:
Kategorie | Nummernbereich |
---|---|
Kasse | 100000 |
Anlagenbuchhaltung | 200000 |
Kostenrechnung | 300000 |
Verkauf | 400000 |
Einkauf | 500000 |
Fertigung | 600000 |
Sonstige | 010000 |
Listenfenster
Dieses Fenster dient der Auflistung von Berichten.
Menüpunkt | Beschreibung |
---|---|
Bearbeiten | - |
: Datenaustausch | - |
: : Import | Die Daten zu Berichten werden aus *.rpt Dateien geladen |
: : Export | Die Daten zu Berichten werden in *.rpt Dateien exportiert |
: : Alle in einzelne Dateien exportieren | Alle Daten zu den Berichten in einzelne *.rpt dateien exportieren |
Datenkonnektor | Öffnet die Übersichtsliste der Datenkonnektoren |
Prüfungen | - |
: : Fehlender Design (*.rptdesign) zu einem Bericht | - |
: : : Anlistung | Sucht anhand der vorhandenen Reports die dazugehörigen *.rptdesign Dateien. Berichte ohne Design werden in der Listbox angelistet. Berichte, die noch nicht importiert wurden, werden nicht berücksichtigt. |
: : : Ausgabe in Datei | Sucht anhand der vorhandenen Reports die dazugehörigen *.rptdesign Dateien. Die Namen der Berichte ohne Design werden in ein ASCII-File ausgegeben. Berichte, die noch nicht importiert wurden, werden nicht berücksichtigt. |
: : Fehlender Bericht zu einem Design (*.rptdesign) | - |
: : : Anlistung | Sucht anhand der sich im BIRT-Verzeichnis befindlichen *.rptdesign Dateien die dazugehörigen Reports. Das Ergebnis wird in einem Attention-Fenster ausgegeben. Berichte die noch nicht importiert wurden, werden nicht berücksichtigt. |
: : : Ausgabe in Datei | Sucht anhand der sich im BIRT-Verzeichnis befindlichen *.rptdesign Dateien die dazugehörigen Reports. Das Ergebnis wird als ASCII-File ausgegeben. Berichte die noch nicht importiert wurden, werden nicht berücksichtigt. |
Symbol | Beschreibung |
---|---|
Neuen Bericht anlegen | |
Bericht bearbeiten | |
Bericht löschen | |
Hardcopy drucken | |
Notizen anlegen/bearbeiten |
Feld | Beschreibung |
---|---|
Datenkontext | Zeigt alle Beriche aus dem ausgewählten Datenkontext an |
Datenkonnektor | Zeigt alle Berichte an, für die der ausgewählte Datenkonnektor verwendet wird |
Nummer | Nach der ID Nummer des Berichts suchen |
Volltextsuche | Der eingegebene Suchbegriff wird in verschiedenen Datenfeldern gesucht, z. B. Berichtsname, Beschreibung und Kontext |
Knopf | Beschreibung |
---|---|
Zurück | Das Fenster wird geschlossen. |
Bearbeiten | Der ausgewählte Bericht wird im Eingabefenster angezeigt. |
Selektionsfenster
Dieses Fenster dient der Selektion eines Berichts.
Feld | Beschreibung |
---|---|
Datenkontext | Zeigt alle Beriche aus dem ausgewählten Datenkontext an |
Datenkonnektor | Zeigt alle Berichte an, für die der ausgewählte Datenkonnektor verwendet wird |
Nummer | Nach der ID Nummer des Berichts suchen |
Volltextsuche | Der eingegebene Suchbegriff wird in verschiedenen Datenfeldern gesucht, z. B. Berichtsname, Beschreibung und Kontext |
Knopf | Beschreibung |
---|---|
Zurück | Die Selektion wird abgebrochen. |
Auswählen | Der selektierte Bericht wird übernommen. |
Selektionsfenster zur Berichtsausführung
(Automatik Bericht ausführen)
Dieses Fenster dient der Selektion eines Berichts, der ausgeführt werden soll.
Feld | Beschreibung |
---|---|
Datenkontext | Zeigt alle ausführbaren Beriche aus dem ausgewählten Datenkontext an |
Datenkonnektor | Zeigt alle ausführbaren Berichte an, für die der ausgewählte Datenkonnektor verwendet wird |
Nummer | Nach der ID Nummer des ausführbaren Berichts suchen |
Volltextsuche | Der eingegebene Suchbegriff wird in verschiedenen Datenfeldern von ausführbaren Berichten gesucht, z. B. Berichtsname, Beschreibung und Kontext |
Knopf | Beschreibung |
---|---|
Zurück | Die Selektion wird abgebrochen. |
Bericht ausführen | Der selektierte Bericht wird ausgeführt. |
Im- und Export
Damit allgemeine Änderungen an Berichten in einer Historie überschaubar werden und Änderungen an Standardformularen gleich allen ClassiX Kunden zur Verfügung gestellt werden können, gibt es die Möglichkeit, Berichte in eine Textdatei zu exportieren oder aus dieser zu importieren.
Hierbei setzt sich der entstehende Dateiname wie folgt zusammen:
[Modulname]-[Kurzname][_Kundenkürzel bei Ableitungen].rpt
Wurde das Kennzeichen "Kundenableitung" gesetzt, so wird die Datei nicht direkt in das Standard-Berichteverzeichnis exportiert, sondern in ein Unterverzeichnis mit dem Kundenkürzel.
Wird versucht ein Standardformular zu importieren, für das es eine Kundenableitung gibt, so meldet das System einen Fehler und bricht ab. Es ist also nicht möglich, die erarbeitete Kundenableitung mit einem Standardformular zu überschreiben.
Um sicher zugehen, dass es beim Im- und Exportieren keine Probleme mit Kodierungstabellen gibt, wurde die Regel eingeführt, dass der Kurzname und der Modulname keine Umlaute, Leer-, oder Sonderzeichen enthalten dürfen. Dieses wird beim Speichern überprüft und der Bericht wird, wenn er nicht dieser Regel entspricht, nicht gespeichert.
Zusammensetzung des Dateinamens eines Berichtes
Für den Dateinamen werden folgende Widgets angezogen: Kontext , Berichtsname und Kundeneigener Bericht.
Der Inhalt der Widgets Kontext und Berichtsname werden mit dem Zeichen"-" miteinander verbunden und die Checkbox "Kundeneigener Bericht" steuert, ob "_" mit Kundenkürzel an den Dateinamen angefügt wird, bevor es auf ".rptdesign" endet.
Beispiel:
Widgets | Dateiname |
---|---|
Kontext: itemList |
itemList-Artikelliste.rptdesign |
Kontext: itemList Berichtsname: Artikelliste Checkbox "Kundeneigener Bericht" aktiviert |
itemList-Artikelliste_cx.rptdesign |
Verwandte Themen
Technische Dokumentation
Erweiterung: "My reports" (wie "My favourites"), pro User, als Struktur
Im Moment: eine (für alle) Struktur "REPORTS"
Einfachstes Interface: Modul mit einer Liste besitzt einen Knopf "-Reporting", mit SELECT: Widget(, ListBox) classID SendMsg(SELECT_REPORT) -> Reporting.mod mit Report-Auswahl als Tree ab dem automatisch gefundenen Knoten in der Struktur; Knöpfe "Drucken" und "Neu" (bei "Neu" wird EDIT_REPORT mit dem Widget gesendet -> in reprtedt.mod automatische Erstellung des default-Layout). Sonst als Menüpunkt in MiniWorkbench.
Im Edit-Fenster muss ein "REPORTS"-Struktur-Knoten zugewiesen werden; der Knoten kann auch automatisch erstellt werden.
Reports
Modulname
report.mod
Klassen
Security
Neben der Beschränkung der Zugriffsrechte über die Klasse und deren Datenfelder kann das Modul über einige der empfangenen Messages in seiner Nutzung beschränkt werden.
Message | Parameter | Funktion | Security |
---|---|---|---|
Message | Parameter | Funktion | Empfangs-Modul |
---|---|---|---|