Einrichtung des CCM Reportings

Java Optionen anpassen

Folgende Option muss mit in die $JAVA_OPTS aufgenommen werden:

                -Djava.awt.headless=true

Dies kann je nach Installation an den folgenden Stellen angegeben werden:

  • Windows: $TOMCAT_HOME\bin\tomcat1w.exe starten und im Tab “Java” ins Feld “Java Options” eintragen.
  • Linux/Unix: $TOMCAT_HOME/bin/catalina.sh – dort wird die Variable $JAVA_OPTS bereits gesetzt und die Option braucht nur hinzugefügt werden. Falls die Variable dort nicht gesetzt ist, wäre setenv.sh noch ein weiterer Ort zur Konfiguration.

 

Global Properties

In den Global Properties folgende Einträge anlegen:

Name Wert Beschreibung
BIRT_RUNTIME_LOCATION z.B.: C:\B2B\tomcat_all\ reporting\ReportEngine_4_2_1 Pfad zum Ordner, in dem die „ReportEngine“ liegt; der Ordner muss von Hand angelegt werden
B3P_BIRT_LIBRARIES z.B.: C:\B2B\tomcat_all\ reporting\ReportEngine_4_2_1\lib Pfad zum lib-Ordner der ReportEngine; der Ordner muss von Hand angelegt werden
BIRT_LOG_LOCATION z.B.: C:\B2B\tomcat_all\ reporting\birt-log Pfad zum Log-Ordner der BIRT ReportEngine; der Ordner muss per Hand angelegt werden
REPORT_OUTPUT_PATH z.B.: C:\B2B\tomcat_all\ reporting\reports Pfad zum Ordner in dem die generierten Reports abgelegt werden sollen
REPORT_TEMP_FOLDER_PATH z.B.: C:\B2B\tomcat_all\ reporting\temp Pfad zum temporären Verzeichnis des CCM Reporting. Hier werden (1) die Designs aus der Datenbank zwischengespeichert (2) die XML-Dateien abgelegt, die von den DataProvidern aus dem CCM-Index erzeugt werden, und die den fachlichen Reports als Datenquelle dienen
REPORT_SERVER_DOWNLOAD z.B.: 192.168.0.0:1880 URI und Port des Report-Servers, hier kann (abweichend von der Property REPORT_SERVER) eine weitere Adresse für den Download von Dokumenten aus derm Viewer- bzw. Explorer-Modul konfiguriert werden. Hier kann z.B. eine interne Adresse stehen, wenn REPORT_SERVER eine externe Adresse und damit zu langsam ist (optional - nur bei Viewer & Explorer – Modul).
REPORT_SERVER z.B.: 192.168.0.0:1880 URI und Port des Report-Servers (nur bei Viewer & Explorer – Modul)
REPORT_SERVER_HTTP true/false Mit dieser Property wird festgelegt, ob der Reporting-Server per http oder https aufgerufen werden soll.
true (default): Die Kommunikation wird über http hergestellt
false: die Kommunikation wird über https hergestellt
B3P_REPORTING_DB_DRIVER z.B:  org.apache.derby.jdbc.ClientDriver Angabe der Treiberklasse (vollqualifiziert) der Datenbank, aus der Reports erstellt werden
B3P_REPORTING_DB_PASSWORD z.B.: YWRtbW4= Angabe des Passwortes zur Datenbank; rein BASE64-Codiert (ohne Salt)
Achtung: dies ist eine andere BASE64-Codierung als z.B. die der Passwörter der Mail Postfächer
Einen Encoder/Decoder findet man beispielsweise hier:
Base64Decoder: http://www.motobit.com/util/base64-decoder-encoder.asp
B3P_REPORTING_DB_USER z.B.: admin Angabe des User der Datenbank in Klartext
B3P_REPORTING_DB_URI z.B.: jdbc:derby://localhost:1527/B2BBP_M1.0 URI zur Datenbank
B3P_REPORTING_DB_SCHEMA z.B. dbo nur falls das Datenbankschema nicht admin ist
B3P_REPORTING_SEND_MAIL X anlegen, wenn Mailversand der Reports gewünscht ist

Service ReportJob

Einen neuen SCHEDULER-Job anlegen mit

Feld Wert
Id/Name ReportJob
Typ SCHEDULER
Klasse org.b2bbp.service.inbound.scheduled.SchedulerRegisterService

Service-Properties

In den Service-Properties folgende Eigenschaften anlegen

Eigenschaft Wert Beschreibung
B3P_SCHEDULER_REGISTER_CLASSNAME com.nextlevel.ccm.reporting.generateReportJob.RunReportJob  
B3P_SCHEDULER_NAME Job: CCM Reporting Dieser Name wird im Nachrichtenmonitor in der Spalte “System” angezeigt, wenn der ReportJob gelaufen ist
B3P_SCHEDULER_TYPE CRON Der ReportJob soll jeden Tag zu einer bestimmten Uhrzeit loslaufen
B3P_CRON_HOURS 0 Stunde zu der der ReportJob jeden Tag loslaufen soll
B3P_CRON_MINUTES 15 Minute zu der der ReportJob jeden Tag loslaufen soll
B3P_DELAY_REPEAT true Einstellung des CRON-Jobs, dass der Job täglich laufen soll
B3P_SMTP_HOST <smtp server> angeben, falls Mailversand der Reports gewünscht
B3P_SMTP_PORT <smtp server port> angeben, falls Mailversand der Reports gewünscht
B3P_SMTP_USER <smtp server username> angeben, falls Mailversand der Reports gewünscht
B3P_SMTP_PASSWORD <smtp server passwort> angeben, falls Mailversand der Reports gewünscht

Extensions

Reporting_JobList

In der Extension Reporting_JobList werden die periodisch zu generierenden Reports verwaltet. In den Extensions muss eine .txt-Datei wie folgt angelegt werden:

Typ Provider Version
Reporting_JobList b2bbp.org 1.0

Das Einstellen der Jobs geschieht dann über das Modul ReportAdmin.

Report Designs

Die ReportDesigns müssen als Extension hochgeladen werden. Dazu muss für jeden Reporttyp eine Extension mit folgenden Werten angelegt und das angepasste Design hochgeladen werden:

Feld Wert Beschreibung
Typ z.B. Nachrichtenverkehr Name des Reportdesigns
Provider design.b2bbp.org an Provider und Version erkennt ccm, dass es sich um Reportdesigns handelt
Version 1.0 an Provider und Version erkennt ccm, dass es sich um Reportdesigns handelt
Dokument z.B. nachrichtenverkehr.rptdesign Reportdesign (xml-Datei)

Reporting Module (Client) einrichten

Report Admin

Dieses Modul dient zum Administrieren und Konfigurieren des ReportJobs sowie zur manuellen Generierung von Reports.

Folgendes Override muss in den Rollenattributen hinzugefügt werden:

AttributId Wert
Module_ReportAdmin Override={view=mainView,type=AddChild,target=toolBarBox,name=org.b2bbp.ui.uicomponent.MainNavLinkButton,value=[id:’reportingAdminButton’;label:’Reporting Admin’;isExtension:’false’;type:’com.nextlevel.ccm.report.ui.swf’;provider:’nextlevel.com’;version:’1.0’;container:’applicationViewStack’;toolTip:’Report Admin’;width:’180’;labelPlacement:’right’;textAlign:’left’;horizontalGap:’10’;paddingLeft:’5’;paddingRight:’5’;iconURL:’images/famfamfam-icons/chart_bar_edit.png’]}

Das Modul erscheint unter folgendem Icon:

Report Explorer

Dieses Modul dient zum Navigieren durch alle generierten Reports.

Folgendes Override muss in den Rollenattributen hinzugefügt werden:

AttributId Wert
Module_ReportExplorer Override={view=mainView,type=AddChild,target=toolBarBox,name=org.b2bbp.ui.uicomponent.MainNavLinkButton,value=[id:’reportingExplorerButton’;label:’Reporting Explorer’;isExtension:’false’;type:’com.nextlevel.ccm.reportExplorer.ui.swf’;provider:’nextlevel.com’;version:’1.0’;container:’applicationViewStack’;toolTip:’Report Explorer’;width:’180’;labelPlacement:’right’;textAlign:’left’;horizontalGap:’10’;paddingLeft:’5’;paddingRight:’5’;iconURL:’images/famfamfam-icons/chart_bar_add.png’]}

Das Modul erscheint unter folgendem Icon:

Report Viewer

Dieses Modul zeigt die aktuellsten Reports an, die von ReportJob generiert worden sind.

Folgendes Override muss in den Rollenattributen hinzugefügt werden:

AttributId Wert
Module_ReportViewer Override={view=mainView,type=AddChild,target=toolBarBox,name=org.b2bbp.ui.uicomponent.MainNavLinkButton,value=[id:’reportingViewerButton’;label:’Reporting Viewer’;isExtension:’false’;type:’com.nextlevel.ccm.reportViewer.ui.swf’;provider:’nextlevel.com’;version:’1.0’;container:’applicationViewStack’;toolTip:’Report Viewer’;width:’180’;labelPlacement:’right’;textAlign:’left’;horizontalGap:’10’;paddingLeft:’5’;paddingRight:’5’;iconURL:’images/famfamfam-icons/chart_bar.png’]}

Das Modul erscheint unter folgendem Icon:

Rollen und BenutzerAdministration

In der Rollen- und BenutzerAdministration die Rollen anlegen bzw. zuordnen.

Zuätzliche Input Parameter definieren

Gelegentlich kann es vorkommen, dass neben den Standard Report-Parametern (u.a. Startdatum und Enddatum, Mandant) noch zusätzliche Such- oder Filterparameter zur Report-Generierung benötigt werden. In der Extension “B3P_REPORT_ADD_INPUT_PARAM” können reportspezifische Parameter konfiguriert werden. Die Konfiguration wird dabei wie folgt festgelegt:

<Anzeigelabel neben dem Inputfeld>

Eine vollständige Konfiguration für ein zusätzliches Inputfeld könnte also wie folgt aussehen:

Protokollnr.

 Zur Zeit gibt es diese drei Typen an Inputfeldern:

  1. TEXT_BOX
  2. COMBO_BOX_SINGLE_SELECT
  3. COMBO_BOX_MULTIPLE_SELECTS

Für den 2. und 3. Typen kann man noch eine Liste von Werten angeben (mit “|” getrennt) , die der Nutzer dann auswählen kann, wobei sich Typ 2 von Typ 3 darin unterscheidet, dass bei Typ 3 der Nutzer direkt mehrere Werte (per Strg-Taste) auswählen kann. Eine Konfiguration sehe z.B. wie folgt aus:

Kuendigung=id=OBJECT_TYPE_CMB_M;width=120;type=COMBO_BOX_MULTIPLE_SELECTS;label=Abrechnungsklasse;values=TK|SVK|BV

View Me   Edit Me