APEX-Print-Master [free] Die Drucklösung für Standardreports in Oracle APEX Dokumentation Version: 1.2 Status: Final Autor Oracle APEX Competence Center Sphinx IT Consulting GmbH
Inhalt 1 Einleitung 3 2 Technische Voraussetzungen 3 3 Restriktionen 3 4 Installation Überblick 4 4.1 Installation Webserver 5 4.1.1 Servlet für Druck 6 4.1.2 Servlet für Nachdruck 6 4.1.3 Servlet zur Ausgabe der verfügbaren Netzwerkdrucker 6 4.2 Installation - Datenbank 7 4.2.1 Apex Print Installation 7 4.2.2 Anpassen von DB und Passwörter 7 4.2.3 Install.bat anpassen 7 4.2.4 grants_synonyms_as_system.sql anpassen 7 4.2.5 Install.bat ausführen 7 4.2.6 Prüfen der Log Dateien 8 4.2.7 Konfigurationsdaten anpassen 8 4.3 Installation - APEX Applikation 9 4.3.1 DB Schema dem Workspace zuordnen 9 4.3.2 APEX Applikation importieren 9 5 anwenden 11 5.1 Applikation 11 5.2 Screen Existing APEX Reports 11 5.2.1 Screen Print Definition and Columns 12 5.3 Screen APEX Report Print Log 15 5.4 Screen Domain 16 6 Integration in bestehende Oracle APEX Applikationen 17 6.1 Zuweisung Static ID für den Report 18 6.2 Anlegen Item [page#]_print 19 6.2.1 Anlegen Button 6.2.2 Prozess für diesen Button anlegen 19 21 6.3 Anlegen Item [page#]_report_id 24 6.4 Anlegen Item [page#]_responsetype 25 6.5 Drucken 26 6.6 Der Output 27 Seite 2 von 28
1 Einleitung Der ist eine kostenfreie Oracle APEX4.1 Anwendung, welche die Druckfunktionalität aus einer Oracle APEX Applikation optimiert. Damit hat der Nutzer die Möglichkeit bestehende APEX Reports für den Ausdruck mit den entsprechenden Formatierungen zu versehen um die gewünschte Darstellung zu erreichen. Reports lassen sich einfach und schnell von Oracle APEX Entwicklern in den APEX-Print- Master[free] integrieren. Mit der App kann der Anwender druckbare Reports aus Oracle APEX aufrufen, speichern und auch später wieder reproduzieren. So ist das WYSIWYG Prinzip nun auch für Oracle APEX Reports gültig. 2 Technische Voraussetzungen Technische Umsetzung erfolgte mit APEX4.1, JAVA und JASPER Reports. Folgende technische Voraussetzungen müssen erfüllt sein: Oracle Datenbank Oracle APEX4.1 Installation oder höher Acrobat Reader 7.0 oder höher JAVA 1.6 Installation oder höher Tomcat Version 6.0.29 oder höher Jasper Reports wird in der Installation mitgeliefert. 3 Restriktionen Programmteile die nicht der Konfiguration oder Erweiterung dienen werden verschlüsselt geliefert. Seite 3 von 28
4 Installation Überblick Die Installation des enthält folgende Schritte: Oracle Datenbank o Schema APEXPRT_OWNER o Schema APEXPRT_USER APEX Applikation Webserver Alle erforderlichen Daten und Dateien sind in der ZIP-Datei enthalten. Abb.: Struktur der ZIP-Datei Seite 4 von 28
4.1 Installation Webserver Alle benötigten Dateien (inklusive Jasper Reports) sind in der Datei ApexPrint.war inkludiert. Sie befindet sich im Verzeichnis Webserver (des entpackten ZIP-Files). Beispielhaft wird hier eine Tomcat Version 7.0.30 Installation beschrieben: 1. Kopieren des Oracle JDBC Drivers (z.b. ojdbc14.jar) in das Tomcat Verzeichnis lib 2. In der Datei conf/server.xml den Connection-Pool wie folgt einrichten (siehe auch Beispiel im Order "Webserver\Beispiele": <!-- Global JNDI resources --> <GlobalNamingResources>... <Resource auth="container" driverclassname="oracle.jdbc.driver.oracledriver" maxactive="8" maxidle="4" name="jdbc/apexprint" password="change_on_install" type="javax.sql.datasource" url="jdbc:oracle:thin:@[server]:[port]:[sid]" username="app_owner"/> </GlobalNamingResources> 3. Die Werte für username, password, server, port, sid sind auf Ihre Datenbankwerte zu änderen 4. Kopieren der Datei ApexPrint.war in das Verzeichnis webapps 5. Tomcat starten und wieder stoppen (dadurch wird die Applikation ins server.xml eingetragen) 6. Verknüpfen der Applikation mit dem Connection-Pool (im server.xml): Ersetzen der Zeile <Context docbase="apexprint" path="/apexprint" reloadable="true" mit source="org.eclipse.jst.j2ee.server:apexprint"/> <Context docbase="apexprint" path="/apexprint" reloadable="true" source="org.eclipse.jst.j2ee.server:apexprint"> <ResourceLink global="jdbc/apexprint" name="jdbc/apexprint" type="javax.sql.datasource" /> </Context> 7. Tomcat starten damit ist die Webserver Installation abgeschlossen. 8. Funktionstest: starten sie mit dem in Punkt 4.1.3 angegebenen Link ob das Servlet korrekt funktioniert Seite 5 von 28
4.1.1 Servlet für Druck Das Servlet wird über folgende URL angesprochen: http://[server]:[port]/apexprint/renderer?preportid=[oid aus PRINT_DEF_RUN] 4.1.2 Servlet für Nachdruck Das Servlet wird über folgende URL angesprochen: http://[server]:[port]/apexprint/reprint?preportid=[oid aus PRINT_DEF_RUN] 4.1.3 Servlet zur Ausgabe der verfügbaren Netzwerkdrucker Das Servlet wird über folgende URL angesprochen: http://[server]:[port]/apexprint/printerlist Ausgabe wie folgt: Seite 6 von 28
4.2 Installation - Datenbank 4.2.1 Apex Print Installation Alle Dateien werden im Verzeichnis ApexPrint geliefert. In diesem Verzeichnis sind einige kleine Anpassungen wie in den nächsten Punkten beschrieben zu tätigen. 4.2.2 Anpassen von DB und Passwörter In den Files connect_apexprt.sql connect_system.sql den Datenbanknamen und die entsprechenden Passwörter anpassen. 4.2.3 Install.bat anpassen In dieser Datei sind die Pfade zu Ihrer SQL-Installation und auf das Verzeichnis in welchem die ZIP-Datei entpackt wurde fest zu legen, um eine korrekte Ausführung zu ermöglichen. SQL Pfad Pfad zum Installationsverzeichnis 4.2.4 grants_synonyms_as_system.sql anpassen In dieser Datei ist die Definition ihres Anwendungsschemas erforderlich. Ersetzten sie SKILL_DB mit ihrem Schemanamen. Codeauszug: -- to the application Schema GRANT APEXPRT_ROLE TO SKILL_DB; 4.2.5 Install.bat ausführen Wurden alle Anpassungen durchgeführt, kann nun die Datei Install.bat ausgeführt werden. Seite 7 von 28
4.2.6 Prüfen der Log Dateien Nach Ausführung der Installation müssen die folgenden Dateien auf eventuell aufgetretene Fehlermeldungen geprüft werden. Sie finden diese Dateien ebenfalls im Installationsverzeichnis. install_log.txt ( Objekte Installation ) install_log1.txt ( Daten Installation ) 4.2.7 Konfigurationsdaten anpassen 4.2.7.1 Tabelle T_DOMAIN_VALUE (Schema: APEXPRT_OWNER) Hier sind die IP Adresse und der Port für den Webserver anzupassen. Betroffen sind die beiden Datensätze mit CODE PRINT_URL bzw. REPRINT_URL. Seite 8 von 28
4.3 Installation - APEX Applikation 4.3.1 DB Schema dem Workspace zuordnen Melden Sie sich im Apex an ihrem INTERNAL Workspace als Benutzer ADMIN an und ordnen sie das Datenbank-Schema APEXPRT_OWNER ihrem Applikations-Workspace zu. Home > Manage Workspaces > Manage Workspace to Schema Assignments 4.3.2 APEX Applikation importieren Sie können sich nun an ihrem Applikations-Workspace mit einem Benutzer, welcher Administratoren Rechte besitzt, anmelden. Wechseln Sie in den Application Builder und importieren Sie hier die mitgelieferte APEX Application (\Apex-Print-Master[free]_Install\ApexApplikation\f119.sql ) und folgend Sie dem Wizard ( siehe Abbildungen unten ). Abb. APEX Applikation importieren / Datei auswählen Seite 9 von 28
Abb. Applikation importieren / Einstellungen Damit ist die Installation der APEX Application abgeschlossen und diese kann gestartet werden. Seite 10 von 28
5 anwenden 5.1 Applikation Der ist eine eigenständige APEX Applikation. Im Folgenden werden die einzelnen Seiten und Ihre Funktionalitäten beschrieben. 5.2 Screen Existing APEX Reports Dargestellt werden hier alle jene Reports, die eine Static ID im APEX zugewiesen haben (unabhängig von der Applikation). Siehe dazu Kapitel 5.5. Seite 11 von 28
5.2.1 Screen Print Definition and Columns Region Print Definition Hier wird der Druck für diesen Report allgemein definiert: Report Static ID: Nur Anzeige der Static ID des Reports Orientation: Eingabe, ob Report Horizontal (Landscape) oder Vertikal (Portrait) gedruckt werden soll Letter Size: <noch nicht implementiertes Feature> Save Report: Der Reports kann hier (für einen späteren erneuten Aufruf) gespeichert werden Save Duration Days: Eingabe der Tage, wie lange der Report gespeichert werden soll Title: Definition des zu druckenden Report-Titels Page Header: Definition der zu druckenden Seiten-Überschrift Width: Definition der Seitenbreite des Reports Height: Definition der Seitenhöhe des Reports Report Template: Auswahl des Jasper Templates (siehe Kapitel 5.2.1.2) Report Region ID: Nur Anzeigefeld Create User: Anzeige, wer diese Print Definition erzeugt hat Modify User: Anzeige, wer diese Print Definition zuletzt geändert hat Create Date: Datum und Uhrzeit, wann diese Print Definition erzeugt wurde Modify Date: : Datum und Uhrzeit, wann diese Print Definition geändert wurde Seite 12 von 28
Region Print Column Hier wird der Druck für einzelne Report Columns allgemein definiert: Oid: Anzeige des Primary Keys Column Alias: Anzeige des Namens der Spalte Column Text: Anzeige der Überschrift der Spalte (Label) Header is bold: Die Überschrift der Spalte wird fett gedruckt Header is underline: Die Überschrift der Spalte wird unterstrichen Header alignment: Die Überschrift der Spalte wird positioniert (links, rechts, mitte) Seq: Die Reihenfolge der Spalten, wie sie im Druck erscheinen kann geändert werden Width: Die Breite der Spalte kann geändert werden Height: Die Höhe der Spalte kann geändert werden Column is bold: Der Wert der Spalte wird fett gedruckt Column is underline: Der Wert der Spalte wird unterstrichen Format Mask: Der Wert der Spalte kann formatiert werden Bei Number Feldern zum Beispiel: ###0.00;-###0.00 Bei Date Feldern zum Beispiel: dd.mm.yyyy Column alignment: Der Wert der Spalte wird positioniert (links, rechts, mitte) Column Datatyp: Hier muss der gewünschte Datentyp der Spalte bestimmt werden Create User: Anzeige, wer diese Print Column Definition erzeugt hat Create Date: Datum und Uhrzeit, wann diese Print Column Definition erzeugt wurde Modify User: Anzeige, wer diese Print Column Definition geändert hat Modify Date: Datum und Uhrzeit, wann diese Print Column Definition geändert wurde 5.2.1.1 Screen Report Parameter Erreichbar durch Drücken des Buttons Report Parameter : Hier definieren Sie jene Parameter, die bei der Integration des auszuführenden Reports mit Werten befüllt werden. Siehe dazu Kapitel 6.2.2 Seite 13 von 28
5.2.1.2 Screen Report Template Erreichbar durch Drücken des Buttons Report Template : Hier kann das Template für Jasper Reports geändert werden. Wird hier eine Änderung vorgenommen, muss auch ein neuer Template Name vergeben werden. Das vorgegebene Standard Template kann nicht geändert werden. In der Print Definition selbst kann das Template ausgewählt werden (Standard oder eigene Templates). Siehe Kapitel 5.2.1 Seite 14 von 28
5.3 Screen APEX Report Print Log Erreichbar durch Drücken des Tabs APEX Report Print Log : Hier wird jeder Druck dokumentiert: Report Title: Name des Reports, der ausgeführt wurde Report Static ID: Die Static ID des Reports, der ausgeführt wurde (siehe auch Kapitel 5.2.1) Session ID: Die eindeutige ID des Drucks User: Name des Users, der den Druck ausgelöst hat (den Print Button gedrückt hat) Start Datetime: Datum und Uhrzeit bei der der Druck ausgelöst wurde (der Print Button gedrückt wurde) End Datetime: Datum und Uhrzeit zu der der Output generiert wurde Duration JAVA: Dauer (in Sekunden) für die Hintergrundberechnungen Duration Total: Dauer (in Sekunden) für die gesamte Reporterstellung (APEX-JAVA- JASPER) Mimetype: Ausgabeformat Der Mimetype wird dann gespeichert und hier angezeigt, wenn im Screen Print Definition and Columns des jeweiligen Reports das Flag Save Report auf Yes gesetzt wird. Siehe dazu auch Kapitel 5.2.1 Reprint: Ist ein Mimetype gespeichert, kann dieser Report durch Drücken des Report- Icons auch reproduziert werden. Seite 15 von 28
5.4 Screen Domain Erreichbar durch Drücken des Tabs Domain : Speicherung verschiedener Domains im System. Seite 16 von 28
6 Integration in bestehende Oracle APEX Applikationen Die Integration des APEX-Print-Masters[free] in einen bestehenden APEX Report ist sehr einfach. Legen Sie dafür 3 Items an: In diesem Beispiel P3_PRINT, P3_REPORT_ID und P3_RESPONSETYPE. Weiters ist dem Report eine Static ID zuzuweisen. Siehe dazu Kapitel 5.2.1: Seite 17 von 28
6.1 Zuweisung Static ID für den Report Dem Report, welcher integriert werden soll, ist eine ID zuzuweisen: Machen Sie einen Doppelklick auf den betroffenen Report (Im Beispiel Artikel Report ) und geben Sie bei den Attributes die Static ID ein. Diese ID muss eindeutig für alle zu integrierenden Reports sein. Seite 18 von 28
6.2 Anlegen Item [page#]_print Print Button mit dessen Hilfe der Druck gestartet wird. 6.2.1 Anlegen Button Legen Sie den Button [page#]_print im APEX an: Führen Sie dazu folgende Schritte durch: Seite 19 von 28
Displayed: Label: Button Displayed Attributes: Seite 20 von 28
Button Request Value: 6.2.2 Prozess für diesen Button anlegen Seite 21 von 28
Führen Sie dazu folgende Schritte durch: Name: Process Point: Source: Dieser Source Code wird im Screen Print Definition and Columns bereits generiert angeboten und muss hier nur noch mit Copy/Paste eingefügt werden. Es sind lediglich die Placeholder mit den richtigen Werten zu ersetzen. Seite 22 von 28
Hier der generierte Source Code im Screen Print Definition and Columns : Seite 23 von 28
6.3 Anlegen Item [page#]_report_id Zur Speicherung der internen Report ID legen Sie folgendes Hidden Feld an: Die tatsächliche ID des Reports wird im oben bereits definierten Prozess bereits zugewiesen: Seite 24 von 28
6.4 Anlegen Item [page#]_responsetype Hier handelt es sich um eine Liste, mit dessen Hilfe der Typ des Outputs ausgewählt werden kann. Folgende Typen können ausgewählt werden: Default ist der Typ pdf. Info: Das Item [page#]_responsetype muss nicht angelegt werden, wenn nur ein PDF Druck gefordert ist. Seite 25 von 28
6.5 Drucken Bei Druck des Print Button wird der Report gestartet und kann (wie im Beispiel das Report.pdf) sofort betrachtet werden. Seite 26 von 28
6.6 Der Output Seite 27 von 28
Wie bereits oben erläutert ist der Output individuell anpassbar: Via Report Definitions (siehe Kapitel 5.2.1 ) Via Jasper Reports Template Anpassungen (siehe Kapitel 5.2.1.2) Seite 28 von 28