1 Themenübersicht
In diesem Dokument werden die Vorgehensweisen für den Export und den Import von Berichten mit Hilfe des Business Integration Server (BIS). Diese Vorgehensweisen enthalten allgemeine Anleitungsschritte, z. B. welche Reihenfolgen beim Import einzuhalten sind. Sie werden außerdem über mögliche Voraussetzungen und Auswirkungen informiert.
Die Beschreibung der Anwendung „Daten importieren“, die unter anderem auch Feld- und Button-Beschreibungen enthält, finden Sie in der Dokumentation Daten importieren.
2 Begriffsbestimmung
Berichte
Mit einem Bericht lassen sich Daten, die in Semiramis erfasst sind, in übersichtlicher Form ausgeben. Ein Bericht lässt sich beliebig oft und auf Basis der aktuell vorhandenen Daten ausgeben.
Berichte werden in Berichts- und Belegdokumente unterschieden. Berichte vom Dokumenttyp „Berichtsdokument“ können auf Basis von beliebigen Daten aus Semiramis erstellt werden. Sie besitzen im Allgemeinen die Form einer Liste und können in der Anwendung „Berichtsdokumente ausgeben“ ausgegeben werden. Belegdokumente können in den jeweiligen fachlichen Anwendungen, in denen Belege entstehen, ausgegeben werden. Sie beinhalten im Allgemeinen nur die Daten zu einem einzelnen Beleg.
Berichte können als System- oder als Entwicklungsobjekt angelegt werden. Ein Bericht als Entwicklungsobjekt hat den Vorteil, dass er in einem Entwicklungssystem verändert, versionisiert abgelegt und als Softwareaktualisierung in andere Systeme übertragen werden kann. Um Berichte auch in Nicht-Entwicklungssystem erstellen und verändern zu können bietet die Anwendung „Berichte“ die Möglichkeit sie als Systemobjekt anzulegen. Systemobjekte können nicht in andere Systeme transportiert werden.
Berichte enthalten ein oder mehrere Berichts-Dateien, die das Layout eines Berichts bestimmen.
Berichts-Datei
Mit einer Berichts-Datei wird das Aussehen des zu erzeugenden Berichtsdokuments festgelegt. Dazu werden die Berichts-Dateien in Crystal Reports bearbeitet. Berichts-Dateien können sprachabhängig oder sprachunabhängig sein.
Berichtsdokument
Die Ausgabe eines Berichts auf ein Ausgabegerät, wie einem Drucker, oder in eine Datei erzeugt ein Berichtsdokument oder ein Belegdokument. Das Berichtsdokument enthält eine Liste von Objekten, beispielsweise eine Liste von Adressen. Ein Belegdokument umfasst stets ein Objekt, beispielsweise einen Vertriebsauftrag. Die Dokumente können archiviert oder zum Beispiel als Fax oder per E-Mail an einen Partner übermittelt werden.
Extensible Markup Language (XML)
Mit XML können strukturierte Daten in einer Textdatei gespeichert werden. Die Beschreibungssprache ermöglicht die Definition, Übertragung, Überprüfung und Interpretation von Daten zwischen Applikationen und eignet sich besonders für den strukturierten Datenaustausch. Bei XML-Dokumenten erfolgt eine Trennung von Inhalt, Struktur und Information zur Darstellung. XML wird vom W3C als Standard koordiniert und definiert.
Text durch Trennzeichen getrennt (CSV)
CSV (comma separated values) ist ein Dateiformat, in dem die Werte der einzelnen Spalten durch ein Trennzeichen getrennt werden. Zeilen werden durch Zeilenumbrüche getrennt. Dieses Trennzeichen muss bekannt sein, um die Datei importieren zu können. Übliche Trennzeichen sind beispielsweise das einfache Komma und das Semikolon. In diesem Format gespeicherte Daten können in zahlreichen Anwendungsprogrammen verwendet und bearbeitet werden. Durch die einfache, nicht hierarchische Struktur von CSV ist dieses Datenformat zur Abbildung komplexer Datenstrukturen nicht geeignet.
Unicode-Text durch Tabulator getrennt (XLS)
Dieses Dateiformat ist ähnlich wie CSV, jedoch ist als Trennzeichen der Tabulator und als Zeichencodierung Unicode festgelegt. Dateien in diesem Format können unter anderem von Microsoft Excel verwendet werden. Um dieses Dateiformat in Excel zu speichern, müssen Sie in Excel ggf. das Dateiformat angeben.
3 Allgemeines
Das Business Entity „Bericht“ ist die Grundlage für die Ausgabe von Anwendungs-, Berichts- und Belegdokumenten. Um als Entwicklungsobjekte ausgelieferte Berichte auf jedem System anpassen zu können, können in der Anwendung „Berichte“ Berichte vom Berichtstyp „Entwicklungsobjekt“ geöffnet und in einen Bericht vom Berichtstyp „Systemobjekt“ dupliziert werden. Diese Berichte können nun angepasst werden. Es können in der Anwendung „Berichte“ auch vollständig neue Berichte erfasst werden.
Da das Anpassen von Berichten und insbesondere das Entwickeln und Testen von angepassten Berichten die Datenbank sehr start belasten kann, wird explizit empfohlen, die Anpassungen nicht auf dem Produktivsystem, sondern auf einem vorgelagerten Produktiv-Testsystem mit getrennter Datenbank durchzuführen. Um die so angepassten Berichte vom Typ „Systemobjekt“ nach erfolgreichem Test vom Produktiv-Testsystem zum Produktivsystem zu übertragen, wurde für das Business Entity „Berichte“ der Export und der Import realisiert. Die Beschreibung des Imports bzw. Exports von Berichten, die als Entwicklungsobjekt im Semiramis erfasst sind, finden Sie in der Dokumentation „Entwicklungsobjekte exportieren und importieren“.
Verwenden Sie den Export und Import von Berichten für folgende Zwecke:
- Weitergabe von Berichten vom Berichtstyp „Systemobjekt“, nach erfolgreichem Test, vom Produktiv-Testsystem zum Produktivsystem.
- Weitergabe eines Berichtes um die Reproduktion von Fehlern zu ermöglichen, die nur mit bestimmten angepassten Berichten auftreten.
4 Vorgehensweisen
Der Import und Export von Systemberichten erfolgt mit dem BIS. Führen Sie dazu einen Import bzw. Export für das Business Entity „Bericht“ („com.cisag.sys.repository.obj.Report“) wie in der Dokumentation Daten exportieren und Daten importieren aus. Es wird empfohlen beim Export und beim Import immer alle Attribute im Filter auszuwählen, da praktische alle Attribute Pflichtfelder sind.
4.1.1 Exportieren
Beim Export können Sie auf dem Karteireiter „Eingrenzung“ den oder die Berichte auswählen, die sie exportieren möchten.
Auf Grund der Tatsache, dass praktisch alle Attribute Pflichtfelder sind, ist nur Export in Form einer XML-Datei sinnvoll. Die in einem Bericht enthaltenen Berichts-Dateien werden beim Export – wie weiter unten beschrieben – als eigene, zusätzliche Dateien im nativen Format der jeweiligen Berichts-Datei exportiert. Damit können die exportierten „.rpt“-Dateien beispielsweise auch direkt mit Crystal Reports geöffnet werden.
Sie können hierbei sowohl Bericht vom Berichtstyp „Systemobjekt“ als auch Berichte vom Typ „Entwicklungsobjekt“ exportieren. Beim Export von Berichten vom Typ „Entwicklungsobjekt“ wird der Name des Namensraumes nicht mit exportiert. Im diese Berichte zu importieren, muss der Wert des Attributes „sourceType“ in der Quell-Datei von „ARCHIVE“ auf „LOCAL“ geändert werden.
4.1.2 Importieren
Für das Business Entity „Bericht“ selbst werden beim Import die Modi „CREATE“, „UPDATE“, „UPDATE_CREATE“, „VALIDATE“ und „DELETE“ unterstützt. Für die Dependents wird nur der Modus „UPDATE_CREATE“ unterstützt, wobei nicht in der Quell-Datei enthaltene Dependents gelöscht werden. Beachten Sie, dass beim Import von Berichten aus einer Datei gleichnamige vorhandene Berichte standardmäßig überschrieben werden.
Nach dem erfolgreichen Import von Berichten, die Berichts-Dateien im Format „RPT“ („.rpt“-Datei) enthalten, müssen die Daten des Berichts um Metadaten ergänzt werden, die nur der SOM aus der Berichts-Datei herauslesen kann. Hierzu zählen beispielsweise die vom Bericht verwendeten Datenquellen und Business Objects. Um die Daten zu ergänzen, führen Sie folgende Schritte aus:
- Öffnen Sie die Anwendung „Berichte“.
- Öffnen Sie den betreffenden Bericht.
- Drücken Sie den Button „Berichts-Dateien exportieren“ in der Standard-Symbolleiste.
- Das Dialog-Fenster „Berichts-Dateien exportieren“ wird geöffnet.
- Wählen Sie einen Ordner im Knowledge Store, in den Sie die Berichts-Dateien exportieren möchten und drücken Sie den Button „Auswählen“.
- Die Berichts-Dateien werden exportiert.
- Drücken Sie den Button „Berichts-Dateien importieren“ in der Standard-Symbolleiste.
- Das Dialog-Fenster „Berichts-Dateien importieren“ wird geöffnet.
- Wählen Sie einen Ordner im Knowledge Store, aus dem Sie die Berichts-Dateien importieren möchten und drücken Sie den Button „Auswählen“.
- Die Berichts-Dateien werden importiert und ihre Metadaten werden vom SOM analysiert.
- Drücken Sie den Button „Speichern“ in der Standard-Symbolleiste um den Bericht inklusive der Metadaten zu prüfen und zu speichern.
- Nun können Sie die Berichte gemäß ihrem Dokumenttyp verwenden.
5 Übersicht: Felder des Business Entitys
Im Folgenden werden die Pflichtfelder (P) und die Key-Attribute (K) der einzelnen Business Objects aufgeführt. Die Identifikations- und Pflichtfelder sind Änderungen unterworfen und können durch Anpassungen auch erweitert werden.
Das BIS-Datenmodell für Berichte besteht aus dem Hauptobjekt „Report“ und den Dependents „Parameters“, „Files“ und „Texts“. Das Hauptobjekt „Report“ des BIS-Datenmodells enthält folgende Attribute:
Feldname/Key-Attribut (K) | Bedeutung |
name (K) (P) | Name des Berichtes ohne Namensraum. Der Name eines Systemberichts darf nur Klein- und Großbuchstaben (ohne Umlaute) und die Ziffern 0-9 enthalten. Pflichtfeld. |
sourceType (P) | Typ des Berichtes. Pflichtfeld. Mögliche Werte beim Export sind:
· ARCHIVE: „Entwicklungsobjekt“ · LOCAL: „Systemobjekt“ Beim Import ist nur der Wert „LOCAL“ zulässig. Passen Sie den Wert, und gegebenenfalls den Namen des Berichts, in der Quell-Datei an, wenn Sie einen Bericht vom Typ „Entwicklungsobjekt“ als Bericht vom Typ „Systemobjekt“ importieren möchten. |
outputType (P) | Dokumenttyp des Berichtes. Pflichtfeld.
Der Dokumenttyp legt fest, ob der Bericht für die Erstellung von Berichtsdokumenten oder für die Erstellung von Belegen verwendet werden kann: Berichtsdokument: Der Bericht gibt eine Liste aus und kann in der Anwendung „Berichtsdokumente ausgeben“ verwendet werden. Der Bericht hat neben den allgemeinen Standardparametern mehrere Parameter vom Typ String, Valueset oder Zeitstempel. Belegdokument: Der Bericht gibt einen einzelnen Beleg aus und kann nicht in der Anwendung „Berichtsdokumente ausgeben“ verwendet werden. Um einen Bericht für die Ausgabe von Belegdokumenten zu verwenden, muss er in der Anwendung „Belegdokumentvorlagen“ in eine Belegdokumentvorlage eingetragen werden. Der Bericht hat neben den Standardparametern allgemein einen Parameter vom Typ GUID. Anwendungsdokument: Der Bericht gilt als Bestandteil der zugehörigen Anwendung zur Berichtsausgabe.
Mögliche Werte sind: · REPORT_OUTPUT: · DOCUMENT_OUTPUT: · APPLICATION_REPORT_OUTPUT: |
frameworkName (P) | Framework, bestehendes aus Name und Namensraum, dem der Bericht zugeordnet ist. Pflichtfeld. Berichte sind zur inhaltlichen Gruppierung Frameworks zugeordnet.
Diese Zuordnung wirkt sich bei der Vergabe und Prüfung von Berechtigungen auf Berichte aus. Darüber hinaus wird der Bericht im anwendungsspezifischen Karteireiter der Anwendung „Berichtsdokumente ausgeben“ unterhalb dieses Frameworks aufgeführt. |
displayName (P) | Bezeichnung des Berichtes. Pflichtfeld. Die Bezeichnung ist auf 80 Zeichen beschränkt und übersetzbar. |
originalLanguage (P) | Originalsprache des Berichtes. Pflichtfeld. Die Originalsprache wird verwendet, wenn ein Berichtsdokument in einer bestimmten Sprache erstellt werden soll und die Berichts-Datei oder ein Text in dieser Sprache nicht vorhanden ist.
In diesem Fall wird die Berichts-Datei bzw. der Text in der Originalsprache verwendet. |
directHelp | Direkthilfe in mehreren Sprachen zu dem Bericht. Die Direkthilfe wird beispielsweise in der Anwendung „Berichtsdokumente ausgeben“ angezeigt, um eine Hilfestellung für die Verwender des Berichts zu bieten |
Der Dependent „Parameters“ des BIS-Datenmodells beschreibt die Berichtsparameter und enthält folgende Attribute:
Feldname/Key-Attribut (K) | Bedeutung |
name (K) (P) | Name des Berichtsparameters. Pflichtfeld.
Folgende Namen sind vordefiniert bzw. für spätere Erweiterungen reserviert: SystemVariables, SystemValues, TextConstants, TextValues, ReportTitle und Report. Diese Namen sind als Konstanten an der Klasse „com.cisag.pgm.services.output.CisAttributes“ definiert. |
logicalDataTypeName | Für einen Berichtsparameter sollte ein logischer Datentyp angegeben werden, dessen Data-Description das Label, die Direkthilfe und die Wertehilfe für den Parameter definiert.
Der primitive Typ des Logischen Datentyps muss zum Typ des Parameterfeldes passen. Bei allen vordefinierten Berichtsparametern wird der logische Datentyp automatisch vorgegeben und ist nicht änderbar. |
Sequence (P) | Reihenfolge. Pflichtfeld. Reihenfolge in der Auflistung der Parameter |
Der Dependent „Files“ des BIS-Datenmodells beschreibt die Berichts-Dateien und enthält folgende Attribute:
Feldname/Key-Attribut (K) | Bedeutung |
language (K) (P) | Sprache der Berichts-Datei. Für sprachabhängige Dateien wird der Wert „X“ verwendet. |
languageDependent (P) | Sprachabhängig. Pflichtfeld.
Definiert, ob die Berichts-Datei sprachabhängig ist oder nicht. Ein Bericht kann maximal eine sprachunabhängige Datei und beliebig viele sprachabhängige Dateien besitzen. Wenn die Ausgabe in einer bestimmten Sprache erfolgen soll, haben die sprachabhängigen Berichts-Dateien Vorrang vor der sprachunabhängigen Berichts-Datei. Standardmäßig haben Berichte bei der Anlage eine sprachunabhängige Berichts-Datei. Durch die Verwendung sprachabhängiger Berichts-Dateien kann beispielsweise das Layout des Berichts sprachabhängig unterschiedlich gestaltet werden. Mögliche Werte sind · NO: „Nein“ · YES: „Ja“ |
format (P) | Dateiformat. Pflichtfeld.
· RPT: · RPT_WITH_META_DATA |
file (P) | Berichts-Datei. Dieses Attribut stellt die eigentliche Berichts-Datei dar, die als „.rpt“-Datei abgelegt wird. Die Berichts-Dateien werden beim Export in einem Ordner, der den Namen der Quell-Datei plus die Endung „files“ trägt, abgelegt. Der Name der Datei ergibt sich aus dem Namen des Berichts und der Sprache des Berichts. Für sprachabhängige Dateien wird dabei der Wert „X“ als Sprache verwendet. Beispiel: Import.xml Import.xml.files Import.xml.files/Report-X.rpt |
fileMetaData (P) | Metadaten zur Berichts-Datei. Dieses Attribut stellt die Datei mit den Metadaten zur eigentlichen eigentliche Berichts-Datei dar. Die Datei mit den Metadaten wird als Binär-Datei mit der Endung „-meta-data.bin“ abgelegt. Die Berichts-Dateien werden beim Export in einem Ordner, der den Namen der Quell-Datei plus die Endung „files“ trägt, abgelegt. Der Name der Datei ergibt sich aus dem Namen des Berichts und der Sprache des Berichts. Für sprachabhängige Dateien wird dabei der Wert „X“ als Sprache verwendet. Beispiel: Import.xml Import.xml.files Import.xml.files/Report-X-meta-data.bin Dieses Attribut ist nur für Berichte relevant, die das Format „RPT_WITH_META_DATA“ besitzen. Für Berichte mit dem Format „RPT“ müssen die Metadaten nach dem erfolgreichen Import in der Anwendung Berichte durch den SOM ergänzt werden. Nähere Informationen hierzu finden Sie im Abschnitt „Importieren“. |
lastModified (P) | Letzte Änderung. Pflichtfeld. Zeitpunkt, zu dem die Berichts-Datei zuletzt geändert wurde. |
Der Dependent „Texts“ des BIS-Datenmodells beschreibt die Texte des Berichts und enthält folgende Attribute:
Feldname/Key-Attribut (K) | Bedeutung |
constantName (K) (P) | Konstante. Pflichtfeld. Eindeutiger Konstantenname, der nur Großbuchstaben enthalten darf.
Über diesen erfolgt der Zugriff auf den Text des Berichts. Die Konstante ist auf 120 Zeichen beschränkt. |
text (P) | Übersetzung. Pflichtfeld. Übersetzbarer Text. Der Text ist auf 2000 Zeichen beschränkt. |