CIB documentServer technischer Leitfaden (DE)


Schneller Einstieg

Installation

Je nachdem, ob der CIB documentServer in einem Servlet Container wie Tomcat oder auf einem Application-Server wie JBoss oder BEA Weblogic installiert werden soll, gibt es verschiedene Vorgehensweisen. Im Folgenden wird exemplarisch anhand von Tomcat, JBoss und BEA Weblogic beschrieben, wie der CIB documentServer im jeweiligen Umfeld deployed werden kann.

Falls Sie den CIB documentServer als Webservice installieren möchten, finden Sie in diesem Kapitel ebenfalls alle notwendigen Informationen zum Deployment. Anhand von SOAP und JAX-WS wird die Installation als Webservice beschrieben.

Beachten Sie die Installationsvoraussetzungen.

Installationsvoraussetzungen
 Verwendung von CIB doXichange
 Installation in einem JEE Servlet-Container
 Installation in Apache Tomcat
 Installation in einem JEE Application-Server
      ▸ Erstellen eines EAR
      ▸ Erstellen eines EAR mit entpacktem WAR
      ▸ Installation in Wildfly 12 Final sowie JBoss EAP 7.0
      ▸ Installation in GlassFish 5
      ▸ Installation in BEA Weblogic 12
      ▸ Vollinstallation mit Apache Tomcat unter Windows
 Andere Installationsthemen
     ▸ Installation als Webservice
     ▸ Andere Installationen
     ▸ Parallele Installationen
 Anlauftests und Fehlersuche
     ▸ Aufruf Weboberfläche
     ▸ Anlauftest CIB documentServer
     ▸ Anlauftest CIB formserver
     ▸ Vorbereitung der Umgebung
     ▸ Aufruf der Beispiele
     ▸ Logging und Fehlersuche
     ▸ Maintenance Feature
Installationsvoraussetzungen

Für die Verwendung des CIB documentServer auf einem Server werden eine Java-Laufzeitumgebung (JRE oder JDK) und ein JEE Servlet-Container oder ein JEE Application-Server benötigt.

Bitte installieren Sie eine geeignete aktuelle Java-Laufzeitumgebung (JRE oder JDK) 32bit oder 64bit als Standardinstallation auf Ihrer gewünschten Serverplattform. Konfigurieren Sie die Java VM geeignet für einen Produktionsbetrieb: Speichereinstellungen, Auswahl Garbage-Collector, weitere Einstellungen.

Stellen Sie dann einen Servlet-Container oder Application-Server bereit, laut der Anleitungen der Hersteller. Im einfachsten Fall entpacken Sie ein aktuelles Tomcat.zip, das für Ihre Plattform geeignet ist. Konfigurieren Sie den Servlet-Container bzw. Application-Server geeignet für einen Produktionsbetrieb: Speichereinstellungen, Threads, Timeouts, Loadbalancing, vorgelagerter Webserver, weitere Einstellungen.

Installieren Sie den CIB documentServer wie nachfolgend beschrieben.

Dabei ist insbesondere darauf zu achten, dass das CibDocumentServer.war nach dem Deployment entpackt im Servlet-Container oder Application-Server vorliegen muss. Ein Betrieb des CIB documentServer ist sonst nicht möglich.

Der Einsatz von EAR-Dateien ist immer dann erforderlich, wenn die CibDocumentServer.properties-Datei anders nicht neben das .war deployed werden kann. Die meisten Application-Server erfordern daher diesen Schritt.

Verwendung von CIB doXichange

(Unterstützt ab CIB documentServer Version 1.9, vorausgesetzt wird CIB job 2.0.1)

Mit CIB doXichange wird ein Dokument in ein PDF (Version 1.4) konvertiert. Dazu wird LibreOffice powered by CIB verwendet.

Unterstützt werden die Plattformen Windows 32/64bit und Linux 32/64bit

Die Dokument Konvertierung wird für folgende Extensions angeboten:

.123, .602, .abw, .bmp, .cdr, .cgm, .cmx, .cwk, .dbf, .dif, .doc, .docm, .docx, .dot, .dotm, .dotx, .dxf, .emf, .eps, .fb2, .fh, .fh1, .fh10, .fh11, .fh2, .fh3, .fh4, .fh5, .fh6, .fh7, .fh8, .fh9, .fodg, .fodp, .fods, .fodt, .gnm, .gnumeric, .htm, .html, .hwp, .key, .lrf, .lwp, .mcw, .met, .mml, .mw, .mwd, .numbers, .nx^d, .odc, .odf, .odg, .odg, .odm, .odp, .ods, .odt, .otg, .otm, .otp, .ots, .ott, .p65, .pages, .pbm, .pcd, .pct, .pcx, .pgm, .pict, .pm, .pm6, .pmd, .pot, .potm, .potm, .potx, .potx, .ppm, .pps, .ppsx, .ppsx, .ppt, .pptm, .pptm, .pptx, .psd, .pub, .ras, .sgf, .sgv, .slk, .stc, .std, .sti, .stw, .svg, .svgz, .svm, .sxc, .sxd, .sxg, .sxi, .sxm, .sxw, .sylk, .tga, .tif, .tiff, .uof, .uop, .uos, .uot, .vdx, .vsd, .vsdm, .vsdx, .wb2, .wdb, .wk1, .wk1, .wk3, .wks, .wmf, .wn, .wpd, .wpg, .wps, .wps, .wq1, .wq2, .wri, .xbm, .xlc, .xlk, .xlm, .xls, .xlsb, .xlsm, .xlsx, .xlt, .xltm, .xltx, .xlw, .xpm, .zabw.

 

LibreOffice powered by CIB Installationen

Die Linux Versionen 32/64 Bit werden als .tar.gz-Archive ausgeliefert. 
Die Windows Versionen 32/64 Bit als ZIP-Archiv.

In der Konfiguration muss das LibreOffice-Installationsverzeichnis eingetragen werden, siehe dazu das Kapitel „Konfiguration CIB doXichange“.

Zu beachten:

Unter Windows ist es erforderlich, dass die VisualC++ redistributables für die verwendete Architektur (x86/x64) installiert sind. Sie sind zu finden unter:

"https://www.microsoft.com/de-de/download/details.aspx?id=40784"

Bei Verwendung eines LibreOffice 64bit ist auch ein CIB documentserver 64bit erforderlich. Das analoge gilt für die 32bit Versionen.

Installierte makros ausführen

Ab CIB documentServer 1.10.5 ist es möglich ein in LibreOffice installiertes Macro ausführen.

Details hierzu werden im Leitfaden für CIB job ausführlich dargestellt, konkrett im Kapitel 4.11.



Installation in einem JEE Servlet-Container

Um den CIB documentServer in einem Servlet-Container zu installieren, ist im Allgemeinen wie folgt vorzugehen:

Deployen Sie das Applikationsarchiv CibDocumentServer.war in einen neuen Context CibDocumentServer. 
Undeployen Sie gegebenenfalls vorher einen vorhandenen Context dieses Namens. 
Deployen Sie so, dass das Archiv im entsprechenden Applikationsunterverzeichnis entpackt wird.

Starten Sie den Servlet-Container.

Im Log muss während des Starts des Containers ein Eintrag "Context CIB documentServer initialized." erscheinen.

Installation in Apache Tomcat

1.     Versionen von Apache Tomcat ab 8.5.38 in Kombination mit Java JDK ab 8u161 werden empfohlen.

2.     Kopieren Sie das Applikationsarchiv CibDocumentServer.war in das Unterverzeichnis webapps Ihrer Tomcat-Installation.

3.     Löschen Sie aus dem Unterverzeichnis conf/Catalina/localhost gegebenenfalls vorher die Kontextdatei CibDocumentServer.xml.

4.     Stellen Sie sicher, dass es keinen Eintrag <Context path= "/CibDocumentServer"…</Context> in der Datei conf/server.xml gibt.

5.     Sie haben zwei Möglichkeiten, die CibDocumentServer.properties abzulegen: 
Kopieren Sie die Datei in den Ordner webapps, so müssen Sie keine weiteren Einstellungen vornehmen. 
Legen Sie die Properties-Datei an einem anderen Ort ab, so muss dieses Verzeichnis im Classpath der Webanwendung CIB documentServer sein. Wie Sie die Einstellungen Ihren individuellen Bedürfnissen anpassen, finden Sie im Abschnitt Konfiguration.

6.     Starten Sie Tomcat. Im Log muss während des Starts des Containers ein Eintrag "Context CIB documentServer initialized." erscheinen.



Installation in einem JEE Application-Server

Soll der CIB documentServer auf einem Application-Server wie JBoss, GlassFish oder BEA Weblogic installiert werden, kann das über die WAR-Datei oder über eine sogenannte EAR-Datei erfolgen. Zur Erstellung einer EAR-Datei gibt es zwei Verfahren (WAR entpackt/nicht entpackt), die nachfolgend beschrieben werden. Welches Verfahren bei welchem Serverprodukt einzusetzen ist wird dann bei den jeweiligen Installationsanleitungen benannt.

Erstellen eines EAR

Der Inhalt des EAR besteht aus:

1.     Datei CibDocumentServer.war (unverändertes Archiv wie von CIB erhalten)

2.     Datei CibDocumentServer.properties (Konfiguration oder Forward-Konfiguration)

3.     Unterordner META-INF

4.     Datei META-INF/application.xml (EAR-Descriptor)

Minimaler Inhalt der Datei application.xml im Unterordner META-INF:

<?xml
version="1.0" encoding="UTF-8"?>
<application>
<display-name>CIB
documentserver</display-name>
<description>Deployment
package for CIB documentserver</description>
<module><web>
       <web-uri>CibDocumentServer.war</web-uri>
       <context-root>CibDocumentServer</context-root>
</web></module>
</application>

Abschließend müssen Sie aus den genannten vier Elementen ein Zip-Archiv erzeugen, in CibDocumentServer-<version>.ear umbenennen und deployen.




Erstellen eines EAR mit entpacktem WAR

Der Inhalt des EAR besteht aus:

1.     Ordner CibDocumentServer (entpackte CibDocumentServer.war)

2.     Datei CibDocumentServer.properties (Konfiguration oder Forward-Konfiguration)

3.     Unterordner META-INF

4.     Datei META-INF/application.xml (EAR-Descriptor)

Minimaler Inhalt der Datei application.xml im Unterordner META-INF: 

<?xml
version="1.0" encoding="UTF-8"?>
<application>
<display-name>CIB
documentserver</display-name>
<description>Deployment
package for CIB documentserver</description>
<module><web>
       <web-uri>CibDocumentServer</web-uri>
       <context-root>CibDocumentServer</context-root>
</web></module>
</application>

Abschließend müssen Sie aus den genannten vier Elementen ein Zip-Archiv erzeugen, in CibDocumentServer-<version>.ear umbenennen und deployen.



Installation in Wildfly 12 Final sowie JBoss EAP 7.0

Installation eines WAR Archivs

Dies ist ab Version 1.15.6 unterstützt. Für vorherige Versionen gehen Sie bitte zum Abschnitt 3.1.3.3.2 Installation eines entpackten WAR

1.     Wildfly herunterfahren.

2.     Legen Sie folgende Verzeichnisstruktur unter das Unterverzeichnis „modulescib/documentserver/main“

3.     Die „CibDocumentServer.properties“-Datei ins Unterverzeichnis „cib/documentserver/main“ kopieren

4.     Im Unterverzeichnis „cib/documentserver/main“ eine neue Datei module.xml mit dem folgenden Inhalt erzeugen

<?xml
version="1.0" encoding="UTF-8"?>  
<module
xmlns="urn:jboss:module:1.1"
name="cib.documentserver">  
    <resources>  
        <resource-root
path="."/>  
    </resources>  
</module>

5.     Kopieren Sie das Applikationsarchiv CibDocumentServer.war in das Unterverzeichnis „standalone/deployments“

6.     Wildfly neustarten


Installation eines entpackten WAR

1.     Wildfly herunterfahren.

2.     In dem Ordner „standalone/deployments“ einen weiteren Ordner „CibDocumentServer.war“ erstellen.

3.     In diesen Ordner das unveränderte „.war“ entpacken.

4.     Die „CibDocumentServer.properties“-Datei ins Verzeichnis „standalone/deployments“ kopieren.

5.     Eine leere Marker-Datei mit dem Namen „CibDocumentServer.war.dodeploy“ erstellen

6.     Diese Datei „CibDocumentServer.war.dodeploy“ mit einem Texteditor öffnen, den Text „CibDocumentServer.war“ (Ohne Anfürungszeichen) eintragenund die Datei speichern.

7.     Wildfly neustarten



Installation in GlassFish 5

Das CibDocumentServer.war kann mit den GlassFish Kommandozeilentools oder der grafischen WebUI ohne weitere Änderungen deployed werden.

Die Konfigurationsdatei CibDocumentServer.properties kann im Verzeichnis glassfish\domains\<domain>\applications Ihrer GlassFish domain abgelegt werden.

Installation eines EAR in GlassFish 5

Im GlassFish Application-Server muss das EAR ohne entpacktem WAR verwendet werden, siehe oben.


Installation in BEA Weblogic 12

Die Kompatibilität mit Oracle Weblogic 12 ist erst ab Version 1.15.2 gegeben.

Für das Deployment können folgende Wege verwendet werden.

Erst ab Version 1.15.8 ist das automatische Deployment einer War-Datei berücksichtigt.


Installation eines EAR

1.     Beenden Sie den BEA weblogic 12 Server

2.     Die EAR-Datei in den Ordner „autodeploy“ der weblogic-Domain kopieren (<beahome>/.../<domain>/autodeploy)

3.      BEA weblogic 12 Server starten

4.     Das Deployen des CIB documentServer geschieht nun automatisch. Es wird zusätzlich automatisch ein entsprechender Eintrag in der Datei „config.xml“ (<beahome>/.../<domain>/config/config.xml) vorgenommen

5.     Zum Löschen des CIB documentServer den weblogic-Server herunterfahren und die EARDatei aus dem „autodeploy“-Verzeichnis entfernen. Beim nächsten Start des weblogic Servers wird der zugehörige Eintrag aus der „config.xml“-Datei automatisch entfernt.


Installation eines entpackten WAR

1.     Beenden Sie den BEA weblogic 12 Server

2.     Entfernen Sie sämtliche <app-deployment>-Elemente die auf den CibDocumentServer verweisen, aus der Weblogic 12 Konfigurationsdatei:

<bea-home>/.../<domain>/config/config.xml

3.     Konfiguration des CIB documentServers in CibDocumentServer.properties vornehmen

4.     Deployen des ausgepackten WAR Archivs:

-          Entpacken Sie das WAR in das Verzeichnis

<bea-home>/.../<domain>/autodeploy/CibDocumentServer

-          Kopieren Sie Ihre CibDocumentServer.properties nach 

<bea-home>/.../<domain>/autodeploy/CibDocumentServer.properties

5.     Starten Sie den BEA weblogic 12 Server

Nach dem Start des Weblogic Servers wird der CIB documentServer deployed. Es wird zusätzlich automatisch der notwendige Eintrag in der Weblogic Server Konfigurationsdatei „config.xml“ vorgenommen. Diese befindet sich im folgenden Verzeichnis 

<bea-home>/.../<domain>/config/

Zum Löschen des CIB documentServer beenden Sie bitte den BEA weblogic-Server. Entfernen Sie danach das CibDocumentServer-Verzeichnis sowie die CibDocumentServer.properties-Datei aus dem autodeploy-Verzeichnis. Beim nächsten Start des weblogic Servers wird der zugehörige Eintrag aus der „config.xml“-Datei automatisch entfernt.


Installation eines WAR Archivs

1.     Beenden Sie den BEA weblogic 12 Server

2.     Entfernen Sie sämtliche <app-deployment>-Elemente die auf den CibDocumentServer verweisen, aus der Weblogic 12 Konfigurationsdatei:

<bea-home>/.../<domain>/config/config.xml

3.     Konfiguration des CIB documentServers in CibDocumentServer.properties vornehmen

4.     Legen Sie ein weiteres Verzeichnis für externe Konfigurationsdateien fest. Zum Beispiel:

<bea-home>/.../<domain>/config/cib

5.     Kopieren Sie Ihre CibDocumentServer.properties nach 

<bea-home>/.../<domain>/config/cib/CibDocumentServer.properties

6.     Kopieren Sie das WAR Archiv nach 

<bea-home>/.../<domain>/autodeploy/

7.     Starten Sie den BEA weblogic 12 Server

Nach dem Start des Weblogic Servers wird der CIB documentServer deployed. Es wird zusätzlich automatisch der notwendige Eintrag in der Weblogic Server Konfigurationsdatei „config.xml“ vorgenommen. Diese befindet sich im folgenden Verzeichnis 

<bea-home>/.../<domain>/config/

Zum Löschen des CIB documentServer beenden Sie bitte den BEA weblogic-Server. Entfernen Sie danach das CibDocumentServer-Verzeichnis sowie die CibDocumentServer.properties-Datei aus dem autodeploy-Verzeichnis. Beim nächsten Start des weblogic Servers wird der zugehörige Eintrag aus der „config.xml“-Datei automatisch entfernt.



Vollinstallation mit Apache Tomcat unter Windows

In diesem Abschnitt wird als Beispiel eine Schritt-für-Schritt-Installation des CIB documentServer und aller nötigen Komponenten in einer Windowsumgebung von Grund auf beschrieben.

Es ist darauf zu achten, dass Tomcat und die verwendete Java-Umgebung kompatibel zueinander sind, also beides in einer 32bit- bzw. beides in einer 64bit-Version vorliegt. Es wird für dieses Beispiel JDK8 und Tomcat in der Version 9.0.5 herangezogen.

1.     Java installieren:

a.     JDK8 mit allen Features im Standardverzeichnis installieren.

b.     JRE8 im Standardverzeichnis installieren.

2.     Tomcat entpacken:

a.     Tomcat-Archivdatei entpacken nach C:/cib/apache-tomcat-9.0.5
Alternativ Tomcat mit dem Windows-Installer als Service in dieses Verzeichnis installieren. Dann entfällt Schritt 3.

b.     Datei C:/cib/apache-tomcat-9.0.5/conf/server.xml konfigurieren:
Um das Tomcat Access Logging zu aktivieren, den Eintrag „org.apache.catalina.valves.AccessLogValve“ aktivieren.

3.     Tomcat als Service installieren, um direkt nach dem Systemstart zur Verfügung zu stehen:

a.     JAVA_HOME im System für alle User auf Pfad zu gewünschtem JDK setzen, zum Beispiel JAVA_HOME= C:\Program Files\Java\jdk1.8.0_161

b.     Die Datei C:/cib/apache-tomcat-9.0.5/bin/tomcat9.exe berechtigen (Win7 und Server2008):
Rechtsklick->Eigenschaften->Sicherheit: Zulassen klicken.
Bei Kompatibilität->Alle Benutzer->Als Administrator starten. Ok.

c.     Ebenso für tomcat6w.exe, tomcat7.exe, tomcat7w.exe (je nach Tomcat Version).

d.     Eingabeaufforderungskonsole mit Administratorrechten öffnen (Startmenü>Alle Programme>Zubehör>Eingabeaufforderung Rechtsklick>Als Administrator ausführen)

e.     C:/cib/apache-tomcat-9.0.5/bin/service.bat remove in Eingabeaufforderung aufrufen.

f.      C:/cib/apache-tomcat-9.0.5/bin/service.bat install in Eingabeaufforderung aufrufen.

g.     C:/cib/apache-tomcat-9.0.5/bin/tomcat9.exe aufrufen (Win7, Server2008), alle UAC und Windows Firewall Sicherheitsmeldungen zu Tomcat und socketserver.exe genehmigen.

h.     Eingabeaufforderung schließen, um Tomcat wieder zu beenden.

i.      Auf dem Desktop eine Verknüpfung auf „C:/cib/apache-tomcat-9.0.5/bin/tomcat9w.exe“ anlegen.

j.      In den Eigenschaften der Verknüpfung auf den Reiter „Verknüpfung“ wechseln und Schaltfläche „Erweitert…“ anklicken.

k.     Im Menü „Erweiterte Eigenschaften“ die Option „Als Administrator ausführen“ aktivieren.

4.     CIB documentServer installieren:

a.     Mittels Tomcat9w.exe, welches über die Verknüpfung oder über die installierte Verknüpfung „Configure Tomcat“ gestartet wird, können nun diverse Tomcat-Parameter eingestellt werden:
Konfigurieren Sie damit den Service auf Startup "Automatic".
Erhöhen Sie ggf. die Speicherwerte bei den Java-Einstellungen, zum Beispiel 512/512.
Fügen Sie folgende Garbage-Collection-Einstellungen den VM-Parametern hinzu:
-Xincgc -XX:MaxGCPauseMillis=500
Hinweis: In den Java-Einstellungen ist für Tomcat standardmäßig die Server-JVM des JDK eingestellt.

b.     Um den Dienst in Betrieb zu nehmen, den Windows-Rechner neu starten, oder über Tomcat9w im Reiter „General“ starten (klicken auf die „Start“-Schaltfläche).

c.     Im Browser die Adresse „localhost:8080“ aufrufen.
Prüfen, ob im Browser die Tomcat Homepage angezeigt wird, mit dem Text „If you're seeing this page via a web browser, it means you've setup Tomcat successfully."

5.     CIB documentServer installieren:

a.     CibDocumentServer-Forward.properties nach C:/cib/apache-tomcat-9.0.5/webapps kopieren.

b.     CibDocumentServer-Forward.properties nach CibDocumentServer.properties umbenennen.

c.     CibDocumentServer-Forward.properties konfigurieren:
de.cib.docserv.ForwardConfigurationFilename=C:/cib/conf/CibDocumentServer.properties

d.     Inhalt des Verzeichnisses opt/cib kopieren nach C:/cib

e.     Datei C:/cib/conf/CibDocumentServer.properties konfigurieren:
de.cib.docserv.JobConfigfilename=C:/cib/conf/jobconfig.xml
de.cib.docserv.LogConfigFilename=C:/cib/conf/log4j.xml
de.cib.docserv.LogPath=C:/cib/logs

f.      Bei asynchronen Jobs mit langer Laufzeit: de.cib.docserv.socket.SocketTimeout=36000000

g.     Datei C:/cib/conf/jobconfig.xml konfigurieren:
LicenseCompany und LicenseKey eintragen oder LicenseFile hinterlegen (siehe Kapitel 6.30 CIB Job – Technischer Leitfaden)
Templates-Verzeichnisse setzten auf c:/cib/templates (die einzelnen Verzeichniseinträge können bei Bedarf auch individuell den eigenen Anforderungen gemäß angepasst werden)

h.     Datei C:/cib/conf/log4j.xml konfigurieren:
Pfad zu cibdocserv.log anpassen: <param name ="FileNamePattern" value= "C:/cib/logs/cibdocserv.%d{yyyy-MM-dd}.log"/>

i.      CibDocumentServer.war nach C:/cib/apache-tomcat-9.0.5/webapps kopieren.
Hier ist anzumerken, dass in einer 64bit-Windowsumgebung sowohl die 32bit- als auch als 64bit-Version des DocumentServers betrieben werden kann, ungeachtet der Bitanzahl der installierten Java- bzw. Tomcat-Umgebung.

6.     Überprüfung der Funktionsfähigkeit:

a.     Fortfahren mit den Kapiteln „Anlauftests und Fehlersuche

b.     Aufruf Weboberfläche“ und „Anlauftest CIB documentServer“.

c.     Weiterführende Hinweise zu den Einstellungen des DocumentServers können im Kapitel „Konfiguration“ vorgefunden werden.


Andere Installationsthemen

Installation als Webservice
SOAP

Um den CIB documentServer als SOAP-Webservice zu installieren, ist wie folgt vorzugehen:

1.     Deployen Sie das CibDocumentServer.war wie gewohnt.

2.     Kopieren Sie die Datei CibDocumentServer.properties in dasselbe Verzeichnis. Auf die Datei muss aus dem Root-Verzeichnis der CibDocumentServer web application mit der relativen Pfadangabe ../CibDocumentServer.properties zugegriffen werden können.

3.     Kopieren Sie die Datei CibDocumentServer.wsdl in dasselbe Verzeichnis. Die CibDocumentServer-Applikation muss mit dem relativen Pfad ../CibDocumentServer.wsdl darauf zugreifen können.

4.     Ändern Sie bitte in der Datei CibDocumentServer.wsdl die URL ihres Dienstendpunkts (service endpoint). In der Regel lautet die Endung CibDocumentServer/soap/Generate. Achten Sie dabei bitte auf Groß- und Kleinschreibung.

5.     Zur Überprüfung, ob der CIB documentServer als SOAP-Webservice installiert wurde, rufen Sie bitte die URL des Dienstendpunkts mit dem Parameter „wsdl“ auf. Wurde der Webservice korrekt installiert, erscheint bei diesem Aufruf der Inhalt der „wsdl“-Datei.

Bsp.: http://localhost:8080/CibDocumentServer/soap/Generate?wsdl

In den meisten Fällen bietet es sich an, dass Sie die drei oben genannten Dateien in ein EAR-file packen, wobei Sie die Dateien vorher angepasst haben müssen. Ihr JEE Anwendungsserver wird die Dateien dann in die vorgegebenen Verzeichnisse entpacken, wenn Sie das ear file deployen.


JAX-WS

Um den CIB documentServer als JAX-WS Webservice zu installieren, muss JAX-WS auf dem Server installiert sein. Eine aktuelle Version von JAX-WS kann hier heruntergeladen werden: https://jax-ws.dev.java.net/.

Um JAX-WS beispielsweise in Tomcat zu installieren, ist folgendermaßen vorzugehen:

1.     Auspacken von JAX-WS

2.     Führen Sie die JAXWS<version>-<datum>.jar aus (Doppelklick auf die Datei)

3.     Akzeptieren Sie die Lizenzbedingungen (ganz nach unten scrollen)

4.     Das Archiv wird in ein Unterverzeichnis jaxws-ri entpackt

5.     Hinzufügen von JAX-WS in Tomcat

6.     Kopieren Sie jaxws-ri/lib/*.jar nach TOMCATHOME/shared/lib

7.     Anpassen der Datei TOMCATHOME/conf/catalina.properties

8.     Verweisen Sie mit dem Eintrag shared.loader auf die kopierten jar-Dateien:

9.     shared.loader=${catalina.home}/shared/lib,${catalina.home}/shared/lib/*.jar´

10.   Passen Sie falls nötig die Rechte in der Datei TOMCATHOME/conf/catalina.policy an

11.   Starten Sie Tomcat neu


Andere Installationen

Alle mitgelieferten Binaries der CIB docgen Module und der CIB documentServer Zusatzmodule befinden sich im Unterverzeichnis bin des Applikationsarchivs CibDocumentServer.war. Sie dürfen aus Lizenzrechtlichen Gründen nicht außerhalb des CIB documentServer eingesetzt werden.

Die Auftragsdateien der Beispiele und das XML-Schema befinden sich im Client-Paket im Unterverzeichnis example/jobs und die Templates der Beispiele finden Sie im Verzeichnis example/templates.

Parallele Installationen

Der CIB documentServer kann mehrmals (mehrere Instanzen der Webanwendung) in einem einzigen Servlet-Container betrieben werden. Ein Grund kann zum Beispiel der Einsatz zweier verschiedener Versionen des CIB documentServers gleichzeitig sein.

Es sind dazu bestimmte Voraussetzungen zu erfüllen:

1.     Die URLs müssen verschieden sein: Kopieren Sie hierzu die CibDocumentServer.war-Datei der gewünschten Version für eine oder jede Instanz, und benennen Sie sie um.

2.     Passen Sie in der jeweiligen War-Datei in der Datei META-INF/Context.xml die URL entsprechend dem Dateinamen an.

3.     Die Instanzen müssen bei der Version 1.4.x des CIB documentServers getrennte Konfigurationen nutzen: Belegen Sie dazu die Konfigurationswerte in der Datei WEB-INF/web.xml mit individuellen Werten in jeder war-Datei, oder verweisen Sie in der WEB-INF/web.xml über die Einstellung de.cib.docserv.ForwardConfigurationFilename auf getrennte CibDocumentServer.properties

4.     Ab der Version 1.5.x können die Instanzen auch identische Konfigurationen nutzen. Siehe Portwahl.

5.     Die Socketserver müssen bei der Version 1.4.x einen getrennten Portbereich nutzen: Setzen Sie die zugehörigen Einstellungen in den individuellen Konfigurationen auf disjunkte Portnummern: de.cib.docserv.socket.FirstPort. Beachten Sie, dass die verwendeten Portnummern auch durch de.cib.docserv.MaxProcessCount beeinflusst werden.

6.     Die Socketserver können bei der Version 1.5.x eine "dynamische Portwahl" vornehmen. Diese muss aktiviert werden (de.cib.docserv.socket.UseDynamicPort­Selection), und ein ausreichend großer Portbereich für die Gesamtanzahl an Socketservern (de.cib.docserv.MaxProcessCount) vorgegeben sein (de.cib.docserv.socket.FirstPort, de.cib.docserv.socket.LastPort.

7.     Ab SocketServer 1.7.0 und documentServer 1.20.0 wird die Vorbelegung eines Portbereiches nicht mehr benötigt. Durch das Aktivieren der Property wird nach der Anzahl von benötigtem freiem Port gesucht und vorreserviert.

8.     Empfohlen ist ein individuelles Logverzeichnis, obwohl dasselbe benutzt werden kann (de.cib.docserv.LogPath). Individuelle Log-Einstellungen sind möglich (de.cib.docserv.LogOptions).

9.     Es sollte dieselbe jobconfig.xml verwendet werden, wenn die beiden Instanzen die selbe Version und die gleichen Aufgaben haben, ansonsten sollten zwei getrennte jobconfig.xml konfiguriert werden (de.cib.docserv.JobConfigfilename).

10.   Schriftarten und Druckerbeschreibungsdateien (Fonts, ppd-Dateien) werden in der Regel gemeinsam genutzt. Wenn nicht, erfordert dies eine getrennte jobconfig.xml.


Beispiel 1 CIB documentServer 1.4.x:

CibDocumentsServer1.war

CibDocumentServer2.war

WEB-INF/web.xml

WEB-INF/web.xml

de.cib.docserv.socket.FirstPort=51000

de.cib.docserv.socket.FirstPort=52000

Rest identisch

Rest identisch


Beispiel 2 CIB documentServer 1.4.x:

CibDocumentsServer.war

CibDocumentServer1.war

WEB-INF/web.xml

WEB-INF/web.xml

Unverändert

de.cib.docserv.ForwardConfigurationFilename= CibDocumentServer1.properties

CibDocumentServer.properties

CibDocumentServer1.properties

Unverändert

de.cib.docserv.socket.FirstPort=51000

 

de.cib.docserv.LogPath=/opt/cib1/logs

 

de.cib.docserv.JobConfigfilename=/opt/cib1/conf/jobconfig.xml


Beispiel 3 CIB documentServer 1.5.x:

CibDocumentsServer1.war

CibDocumentServer2.war

WEB-INF/web.xml

WEB-INF/web.xml

Unverändert

Unverändert

CibDocumentServer.properties

de.cib.docserv.socket.FirstPort=50000

de.cib.docserv.socket.LastPort=50019

de.cib.docserv.MaxProcessCount=10

de.cib.docserv.socket.UseDynamicPortSelection=true

 

Beispiel 4 CIB documentServer 1.20.x:

CibDocumentsServer1.war

CibDocumentServer2.war

WEB-INF/web.xml

WEB-INF/web.xml

Unverändert

Unverändert

CibDocumentServer.properties

de.cib.docserv.MaxProcessCount=10

de.cib.docserv.socket.UseDynamicPortSelection=true

Anlauftests und Fehlersuche
Aufruf Weboberfläche

Nach der Installation des Applikationsarchivs CibDocumentServer.war auf der Maschine MyServername und dem erfolgreichen Start des Servlet-Containers kann mit folgendem Link im Standardbrowser die Weboberfläche des CIB documentServers aufgerufen werden:

Protokoll://MyServername:Port/CibDocumentServer/

Der Server MyServer muss über das verwendete Protokoll und den entsprechenden Port vom Client aus erreichbar sein.

Beispiel (Tomcat):

http://MyServername:8080/CibDocumentServer/

Gegebenenfalls müssen Sie bei anderen Servlet-Containern einen anderen Port eingeben.



Diese Weboberfläche bietet Ihnen die Möglichkeit, einen ersten Anlauftest des CIB documentServers durchzuführen, Aufträge direkt auszuführen und Logging-Einstellungen vorzunehmen (ab Version 1.4.19d).

Über die Schaltfläche „Show configuration“ können die entsprechenden gesetzten Einstellungen und Pfade angezeigt werden (ab Version 1.10.1):

Anlauftest CIB documentServer

Drücken Sie nun auf den “test job“-Link, um dadurch einen ersten Anlauftest des CIB documentServers durchzuführen. Der Standardbrowser sendet nun eine Beispiel-Auftragdatei an das CIB documentServer Servlet. Dieses erzeugt einen Servermanager, der die vordefinierte Anzahl von Socketserver-Prozessen startet. Sie erkennen dies im Log des Servlet-Containers. Der Auftrag wird von einem dieser Prozesse bearbeitet, und das entstehende PDF an den Standardbrowser zurückgesendet.

Im Standardbrowser öffnet sich das Adobe Reader Plugin und zeigt im Erfolgsfall das erzeugte PDF an. Im Fehlerfall zeigt der Standardbrowser ein XML mit Informationen zu den aufgetretenen Fehlern an.

Nutzen Sie die Zurück-Funktion des Browsers, um zur Weboberfläche zurückzukehren.

Anlauftest CIB formserver

Um den CIB formserver zu testen, rufen Sie das mitgelieferte Beispielformular auf:

Beispiel (Tomcat):

http://MyServername:8080/CibDocumentServer/forms/formserver-sample.pdf

Gegebenenfalls müssen Sie bei anderen Servlet-Containern einen anderen Port eingeben.

Füllen Sie nun das Formular aus, und klicken Sie auf die Senden-Schaltfläche am Ende der Seite. Dies sendet die eingegebenen Daten an den CIB formserver, der diese über den CIB documentServer in das Formular einmischt.

Das ausgefüllte Formular wird im Browser angezeigt. Speichern Sie es lokal mit den eingetragenen Daten ab.

Nutzen Sie die Zurück-Funktion des Browsers, um zur Weboberfläche zurückzukehren.

Vorbereitung der Umgebung

Folgendes Vorgehen wird empfohlen, um die Umgebung für den CIB documentServer optimal vorzubereiten. Für die Durchführung der Anlauftests ist das nicht erforderlich. Eine detaillierte Beschreibung für diese Standard-Konfiguration finden Sie im Abschnitt „Beispielsituation zur Konfiguration einschließlich forward-Properties“.

Legen Sie folgende Verzeichnisse an:

/opt/cib/conf

/opt/cib/logs

/opt/cib/ppd

/opt/cib/fonts

/opt/cib/templates

/opt/cib/forms

Das Template-Verzeichnis befindet sich im Client-Paket unter examples/templates. Legen Sie den Inhalt dieses Verzeichnisses im angelegten Verzeichnis /opt/cib/templates ab. Damit der CIB documentServer auf  die Templates zugreifen kann, müssen Sie die Pfadangaben in der jobconfig.xml ggf. anpassen (siehe auch Abschnitt Konfiguration). Die Beispielauftragsdateien befinden sich im Verzeichnis example/jobs des Clientpakets.

Die CibDocumentServer.properties sollte im angelegten Verzeichnis /opt/cib/conf liegen. In diesem Verzeichnis ist auch die Datei jobconfig.xml zu finden, deren Pfad in der CibDocumentServer.properties angegeben werden muss. Außerdem wird dort auch der Pfad zu den Logdateien angegeben (Verzeichnis /opt/cib/logs). Die jobconfig.xml enthält neben dem Pfad zu den Templates (/opt/cib/templates) auch die Pfade zu den Fonts (/opt/cib/fonts) und den Druckereinstellungen (/opt/cib/ppd).

Die ausfüllbaren Formulare für den CIB pdf formserver werden im Formular-Verzeichnis (/opt/cib/forms) hinterlegt. Das PDF, in das die Daten eingemischt werden, liegt dagegen im Template-Verzeichnis (/opt/cib/templates).

Aufruf der Beispiele

Wählen Sie nun in der Weboberfläche einen der Beispielaufträge aus dem “jobs“-Verzeichnis, zum Beispiel example/jobs/examples/Job-Shop.xml.

Klicken Sie auf die Ausführen-Schaltfläche.

Der Standardbrowser sendet die Auftragdatei an das CIB documentServer Servlet. Dieses erzeugt einen Servermanager, der die vordefinierte Anzahl von Socketserver-Prozessen startet. Sie erkennen dies im Log des Servlet-Containers. Der Auftrag wird von einem dieser Prozesse bearbeitet, und das entstehende PDF an den Standardbrowser zurückgesendet.

Im Standardbrowser öffnet sich das Adobe Reader Plugin und zeigt das erzeugte PDF an. Im Fehlerfall zeigt der Standardbrowser ein XML mit Informationen zu den aufgetretenen Fehlern an.

Konfiguration finden Sie weitere Einstellungsmöglichkeiten für das Logging, die über die Konfigurationsdatei CibDocumentServer.properties festgelegt werden können.

Zur Fehlersuche können Sie die entsprechenden Logfiles auswerten. Fehler, die in der Java Webanwendung selbst verursacht werden, sind in den Logfiles des Application-Servers zu finden. Fehler im Socketserver werden durch die Logging-Einstellung „S“ in der Datei socketserver.log protokolliert. Treten Fehler bei der Jobverarbeitung auf, sind diese im Logfile jobtrace.log (Logging-Einstellung „J“) enthalten. Sollten Fehler in den CIB-Modulen auftreten, werden diese in den entsprechenden Logfiles ausgegeben (separates Logfile je Modul: Logging-Einstellungen „MPF“).

Wenn Sie bei der Auswertung dieser Logfiles Hilfe benötigen und das Problem im Abschnitt FAQs nicht beantwortet wird, wenden Sie sich an den CIB support.

Maintenance Feature

Verfügbar ab Version 1.10.1.

Das Maintenance Feature kann sowohl über die Konfigurationsdatei als auch über die Weboberfläche aktiviert werden.

Im Abschnitt „3.2 Konfiguration“ dieses Leitfadens finden Sie die Einstellungsmöglichkeiten für das Maintenance Feature, die über die Konfigurationsdatei CibDocumentServer.properties festgelegt werden können.

Über die Weboberfläche besteht die Möglichkeit, das Maintenance Feature aus oder einzuschalten. Dies geschieht über die beiden Links "Maintenance off" bzw. "Maintenance on". (Vgl. dazu auch die Screenshots am Ende des Kapitels)

 

Bei aktiviertem Maintenance Feature wird im Fall, dass während eines Jobs eine nicht bekannte bzw. nicht erwartete Fehlermeldung auftritt, ein zusätzlicher Port erzeugt. Der Auftrag/Job wird dann über diesen speziellen Port bei aktiviertem Logging erneut ausgeführt.

Mit dem Klick auf den Link „Maintenance on“ können weitere Einstellungen vorgenommen werden.

Ist eine konkrete Fehlermeldung schon bekannt, kann man diese über das Formularfeld "Known error codes" ausschließen. Das bedeutet, für die angegebenen Fehlermeldungen werden die Aufträge nicht erneut über den Maintenance Port ausgeführt.

Hier ist es auch möglich, eine Liste von bekannten Fehlermeldungen einzugeben. Dafür bitte ein ";" als Trennzeichen verwenden (Beispiel: "404;437;454").

Um Belastungssituationen zu vermeiden besteht auch die Möglichkeit, die Anzahl der Aufträge zu begrenzen, die über den Maintenance Port ausgeführt werden. Dies kann für einen konkreten Zeitbereich festgelegt werden. Über die Formularfelder "Max of executions" und "Time range" kann man angeben, wie viele Aufträge pro Zeitabschnitt maximal ausgeführt werden.

Erst nach Ausfüllen der Formularfelder wird das Maintenance Feature mit Klick auf die Schaltfläche „Configure“ aktiviert.

Zur Fehlersuche können Sie die entsprechenden Logfiles auswerten.
Wenn Sie bei der Auswertung dieser Logfiles Hilfe benötigen und das Probem im Abschnitt FAQs nicht beantwortet wird, wenden Sie sich an den CIB Support.

Screenshot: Maintenance Feature aktivieren


Screenshot: Konfigurationseinstellungen