CIB documentServer technischer Leitfaden (DE)

Diese Datei enthält dann Ihre kunden- und serverspezifische Konfiguration.

Eine umfangreich kommentierte Vorlage wird für Ihre Plattform mitgeliefert.

Sollten Sie den CIB documentServer als EAR-Datei deployen, so legen sie die CibDocumentServer.properties ins EAR neben die CibDocumentServer.war.

 Deployen Sie den CIB documentServer als WAR-Datei, so legen Sie die CibDocumentServer.properties neben das WAR (abhängig vom Application-Server).

Zuerst wird die CibDocumentServer.properties stets im Classpath der CibDocumentServer-Webanwendung gesucht. Hierüber wird auch die Properties-Datei im EAR gefunden.

Beispiel:

##CIB documentserver Forward Configuration. 
# Requires CIB documentserver 1.4.19d or newer 
# Forward to this configuration: 
de.cib.docserv.ForwardConfigurationFilename=
/opt/cib/conf/CibDocumentServer.properties

-Dde.cib.docserv.ForwardConfigurationFilename=
/opt/cib/conf/CibDocumentServer.properties

Legen Sie hier den Pfad zur Konfiguration von CIB job und CIB docgen fest. In der angegebenen Datei befinden sich keine Einstellungen zum CIB documentServer selbst.

Wenn die Socketserver-Prozesse beim Start der CIB documentServer Webanwendung gleich gestartet werden sollen, also auch beim Start des Application-Servers, geben Sie hier true an.

de.cib.docserv.socket.IdleShutdownTime=3600

Wenn in bestimmten Zeiträumen keine Last auf der Maschine ist, können sich die Socketserver-Prozesse nach dieser Zeit (in Sekunden) automatisch beenden. Sie werden bei Bedarf automatisch wieder gestartet. Bei einer Angabe von 0 werden die SocketServer-Prozesse nicht automatisch beendet.

de.cib.docserv.MaxProcessCount=10

An dieser Stelle sollten Sie den CIB documentServer an Ihre Serverhardware und den gewünschten Durchsatz anpassen. Mehr Socketserver-Prozesse lassen weniger Rechenleistung für andere Anwendungen. Weniger Prozesse erreichen gegebenenfalls die gesetzten Durchsatzzahlen nicht. Andere wesentliche performance-relevante Einstellungen gibt es im CIB documentServer nicht.

de.cib.docserv.MaxJobCountPerProcess=100

Damit aktivieren Sie einen automatischen Neustart der Socketserver-Prozesse, wenn die angegebene Zahl an Jobs bearbeitet wurde. Die Logdateien von CIB job und den CIB docgen werden dabei neu begonnen, und können auf diese Weise in der Größe begrenzt werden. Eine Angabe von -1 schaltet den automatischen Neustart ab.

de.cib.docserv.job.MaxJobExecutionTime=600000

Falls Anwender einen Einfluss auf die Laufzeit der Aufträge haben (RTF, Datensatzanzahl), kann mit dieser Einstellung die Laufzeit von Aufträgen begrenzt werden. Diese werden dann abgebrochen, und der Socketserver beendet. Die aufrufende Anwendung erhält eine Fehlerantwort, aber die Anwender können somit den Server nicht für längere Zeit blockieren. Bei einer Angabe von 0 wird kein Abbruch vorgenommen.

Diese Einstellung benötigt CIB socketserver 1.6.1, CIB job 1.6.2 und CIB merge 3.10.3. Die Funktion ist derzeit nur für „merge“-Kommandos wirksam.

de.cib.docserv.socket.MaxMemory=250

Mit dieser Einstellung kann die maximale Anzahl des allokierbaren Arbeitsspeichers für jeden Prozess des CIB socketserver in Megabyte definiert werden. Erreicht ein CIB socketserver dieses Limit, beendet sich der Prozess. Diese Einstellung, multipliziert mit der Anzahl der CIB socketserver (siehe Property de.cib.docserv.MaxProcessCount), ergibt einen groben Wert für den maximal verwendeten Arbeitsspeicher der nativen Prozesse.

Diese Einstellung benötigt den CIB socketserver 1.6.2 und steht derzeit unter den Plattformen Linux-x86, Solaris-x86 und Solaris Sparc zur Verfügung.

Falls auf Ihrem System Ports bereits belegt sind oder Vorgaben für Ports existieren kann hier die Nummer des ersten Ports aus der Port-Range spezifiziert werden. Jeder weitere Socketserver-Prozess vergrößert die Range um eins (siehe MaxProcessCount).

Bei dynamischer Portreservierung gibt dieser Wert den Beginn des Bereichs an, in dem der CIB documentServer versucht, Ports zu reservieren. Ab Version 1.20.0 es nicht mehr notwendig, für die dynamische Portreservierung ein Initialport einzusetzen. Siehe UseDynamicPortSelection.

de.cib.docserv.socket.LastPort=50200

Bei Einsatz von dynamischer Portreservierung gibt dieser Wert das Ende des Bereichs an, in dem der CIB documentServer versucht, Ports zu reservieren. Ab Version 1.20.0 wird diese Property nicht mehr unterstützt. Siehe UseDynamicPortSelection.

de.cib.docserv.socket.UseDynamicPortSelection=true

Aktivieren Sie die dynamische Portreservierung, wenn Sie mehr als einen CIB documentServer auf einer Maschine einsetzen wollen oder die genaue Portrange nicht festlegen wollen. Siehe auch FirstPort und LastPort. Ab 1.5.26

Ab Version 1.20.0 wurde das Verhalten der Property geändert. Es wird nicht mehr durch einen bestimmten Portrange gesucht. Es wird dynamisch für freie Ports geprüft und so viele reserviert wie in der Property MaxProcessCount eingesetzt.

Das Einsetzen der Propery LastPort wird nicht mehr benötigt und ab der Version 1.20.0 steht diese nicht mehr zur Verfügung.

Der ausgesuchte Portrange hängt von dem Betriebsystem und ist normallerweise:

-         49152 – 65535 für Windows

-         32765 – 60999 für Linux

Legen Sie hier den Pfad zu den ausfüllbaren Formularen für den CIB formserver fest. Diese können dann über die URL des CIB documentServers ergänzt um /forms aufgerufen werden.

Der Pfad zu den Formularen, in die die eingegebenen Daten gespeichert werden, wird in der jobconfig.xml festgelegt (pdfmerge, WorkSpace).

Ab 1.5.x

de.cib.docserv.LoggingMode = log4j (ab CIB documentServer 1.16.0)

Ist ein LogConfigFilename angegeben, wird dieser für die Konfiguration des Loggings berückichtigt.

Wenn die Datei nicht existiert wird ausschliesslich auf der Konsole geloggt.

Durch Angabe des LoggingMode kann man log4j oder log4j2 setzen.

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

Diese beiden Parameter steuern die Art und den Ort der Logdateien.

Durch Angabe einer Buchstabenfolge in den LogOptions (z.B. de.cib.docserv.LogOptions=SMPFJEOIZ) werden Logdateien erstellt. Die Dateinamen sind fest vorgegeben.

Ist ein LogPath angegeben, werden die Logdateien dort erzeugt. Ansonsten werden die Logdateien im Arbeitsverzeichnis des Socketserver-Prozesses angelegt.

Wenn der angegebene LogPath nicht existiert, werden die Logdateien im Arbeitsverzeichnis (Angabe über die Property „de.cib.docserv.ServerWorkingDirectory“) des Socketserver Prozesses angelegt (ab 1.11.1)

Durch Angabe folgender Buchstaben kann die Logausgabe des entsprechenden Moduls aktiviert werden:

de.cib.docserv.AutoMaintenance

Wenn die Maintenance Funktionalität beim Start des Application Servers gleich gestartet werden soll, geben Sie hier "true" an.

de.cib.docserv.KnownErrorCodes

Legen Sie hier fest, für welche Fehlermeldungen die Aufträge durch den Maintenance-Prozess nicht erneut ausgeführt werden sollen.

de.cib.docserv.ExecutionsNumber

de.cib.docserv.TimeSection

Mit diesen beiden Einstellungen kann die maximale Anzahl Aufträge pro angegebenen Zeitabschnitt, die durch den Maintenance-Prozess ausgeführt werden, definiert werden. Erreicht der Maintenance-Prozess dieses Limit, dann werden keine weiteren Aufträge durchgeführt, bis die angegebene Zeit abgelaufen ist.

de.cib.docserv.MaintenanceLogPath

Geben Sie hier bitte ein spezifisches Verzeichnis zur Ausgabe der erzeugten Logdateien an. Das Verzeichnis muss bereits existieren.

Wird hier kein Verzeichnis angegeben, wird das Arbeitsverzeichnis unter CibDocumentServer/work verwendet.

de.cib.docserv.socket.Environment1=

…

de.cib.docserv.socket.Environment9=

Es besteht die Möglichkeit, bis zu 10 unterschiedliche Umgebungsvariablen zu konfigurieren. So können Sie beispielsweise den LD_LIBRARY_PATH, LIBPATH oder die Zeitzone setzen. Falls der Wert dieses Parameters leer ist, wird er nicht ausgewertet.

Beispiel:

de.cib.docserv.socket.Environment=LD_LIBRARY_PATH=../bin

de.cib.docserv.socket.Environment1=TZ=AST+04ADT

Damit wird der Funktionsumfang um die Unterstützung von automatischer Text- und Barcodeerkennung erweitert. Diese kann über das Modul CIB ocr erfolgen, welches hierzu entsprechende Dateien für jede zu erkennende Sprache benötigt.

/opt/jboss/servers/default/deploy/CibDocumentServer-1.4.19d.ear enthält folgende CibDocumentServer.properties:

/opt/cib/logs

/opt/cib/ppd

/opt/cib/fonts

/opt/cib/templates

/opt/cib/forms

Darin sind in folgenden Dateien neben weiteren Angaben folgende Pfadangaben gesetzt: /opt/cib/conf/CibDocumentServer.properties