CIB webdesk technischer Leitfaden

Site: CIB eLearning
Course: CIB webdesk
Book: CIB webdesk technischer Leitfaden
Printed by: Guest user
Date: Tuesday, 25 June 2024, 5:43 PM

1. Einleitung

Dieses Dokument gibt einen Überblick über den Aufbau der Applikation, ihre wichtigsten Komponenten und dient als Leitfaden für Installation, Konfiguration und Betrieb von CIB webdesk.


2. CIB Webdesk im kontext von CIB coSys

CIB webdesk dient im Rahmen von CIB coSys der Erzeugung von Korrespondenzen und deren anschließender Ablage und/oder Ausgabe über verschiedene Ausgabewege wie z.B. den Druck an einem lokalen Arbeitsplatzdrucker oder über eine zentrale Druckstraße im Rechenzentrum.

Der für die Korrespondenzerstellung notwendige Schritt der Datenerfassung zur Versorgung der Dokumentvorlagen mit den jeweils geeigneten Nutzdaten wird ebenfalls von CIB webdesk abgedeckt. Diese Datenerfassung erfolgt in der Regel über eine Reihe von nacheinander abzuarbeitenden Formularen, kann aber auch komplett ohne Benutzerinteraktion über die Dunkelverarbeitungsschnittstelle CIB darkdesk erfolgen. Der Vorgang der Datenerfassung über die Web-Oberfläche wird im Folgenden auch als Datenerfassungsinterview oder schlicht als Interview bezeichnet, wobei beide Begriffe sowohl den Vorgang der Datenerfassung als auch die Menge der dazu verwendeten Masken bezeichnen kann.

Für die Korrespondenzerstellung werden in CIB webdesk Dokumentvorlagen verwendet, die zuvor mit Hilfe von CIB webTom und CIB workbench erstellt und konfiguriert wurden. Falls eine Dokumentenvorlage die Restdatenerfassung unterstützt, wird CIB webdialog in die Oberfläche des Datenerfassungsinterview integriert. Für die integrierte Vorschaufunktion und die Freigabe von Korrespondenzen kommt CIB doXiview zum Einsatz. Die Dokumenterzeugung selbst wird schließlich an CIB documentServer delegiert.

3. Grundlegendes zur Architektur

CIB webdesk ist eine Java Application nach Servlet Spezifikation Version 2.6, die für den Betrieb in einem Computercluster ausgelegt ist. Die einzelnen Funktionen der Applikation werden hierbei von Komponenten zur Verfügung gestellt und nach außen über eine Web Service Schnittstelle verfügbar gemacht.

Die Datenhaltung erfolgt mit Hilfe eines relationalen Datenbankmanagementsystems. CIB webdesk verfügt über eine im Web Browser ausgeführte Benutzeroberfläche. Ein großer Teil der Funktionali­tät steht aber über eine mit Hilfe von Web Services implementierte Dunkelverarbeitungs­schnitt­stelle zur Verfügung.



4. Wichtige Komponenten

Es folgt eine Kurzbeschreibung der Komponenten in CIB webdesk. Für Details siehe bitte die entsprechenden JavaDocs der jeweiligen APIs.




4.1. CIB darkdesk

darkdesk Info

DarkdeskInfo stellt Methoden zur Verfügung, um die Version des auf diesem Server installierten CIB webdesk abzufragen.


dardesk Generation

Stellt die Methoden zur Erzeugung und Nachmischen von Dokumenten zur Verfügung. Des Weiteren kann über diese Komponente die Support-Files abgerufen werden.

Die Methoden stehen meist in zwei Formen zur Verfügung: „einfache“ Erzeugung und „mehrfache“ Erzeugung. Die „mehrfache“ Erzeugung stellt die gleiche Funktionalität wie die „einfache“ Erzeugung dar, mit dem Unterschied dass in einem Aufruf mehrere Erzeugungen möglich sind.

Sollen Message Queues zur Verarbeitung genutzt werden, sind die Methoden mit „MQ“ im Namen zu verwenden.


dardesk Search

Die Komponente dient zur Suche nach CIB coSys Objekten wie Vorlagen, Paketen und deren Attributen.


dardesk Security

Über diese Komponente kann ein Benutzer authentifiziert werden.


dardesk FieldSettings

Über diese Komponente können Informationen, wie verwendete Bausteine und deren Variablenfelder von Paketen und Vorlagen abgefragt werden.



4.2. CIB darktom

CIB darktom stellt die Funktionen zur Bearbeitung und Administration von CIB coSys Objekten zur Verfügung.


darktom Core

In dieser Komponente werden die Basisfunktionalitäten bereitgestellt. Es ist möglich, CWPs ein- und aus zu checken, Objekte zu erstellen, zu ändern, zu löschen, zu exportieren und zu suchen.

Des Weiteren kann die Änderungshistorie eines Objekts abgefragt werden.


darktom Admin

Diese Komponente dient zur Administration von Mandanten. Es können Mandanten angelegt, gelöscht und „eingefroren“ werden. Der Status der Pilotierung kann für Mandanten gesetzt werden. Zusätzlich ist es möglich, die existierenden Mandanten abzufragen.


darktom Extensions

Über die Komponente „CIB darktom Erweiterungen” können „Zuordnungen“ administriert und gesucht werden. Des Weiteren können darüber die „kundeneigenen Versionsdaten“ administriert werden.


darktom Reference Search

Über diese Komponente können Referenzen zwischen CIB coSys Objekten gesucht werden. Beispielsweise können alle Vorlagen, die einen bestimmten Baustein enthalten, gesucht


4.3. CIB darkdialog

CIB darkdialog stellt die Schnittstelle zu der Restdatenerfassung innerhalb CIB webdesk zur Verfügung. Über die Schnittstellen können Restdatenerfassungen vorbereitet werden, welche der Endbenutzer dann über die Weboberfläche von CIB webdesk aufrufen und bearbeiten kann. Über die Komponente kann dann das vom Endbenutzer abgespeicherte Ergebnis wieder abgerufen werden.

Für weiterführende Informationen, Konzepte und Details siehe Dokumentation „CIB webdesk - Anbindung CIB jrules und CIB webdialog“.


5. Installation



5.1. Einzelschritte zur Installation und Konfiguration

Folgende Schritte werden benötigt, um eine lauffähige CIB webdesk Installation herzustellen:

  1. Bereitstellung der Laufzeitumgebung
  2. Installation des Webservice Stacks
  3. Konfiguration der Java Umgebung
  4. Konfiguration Datenbank und Erstellung relevanter Datenbanktabellen
  5. Konfiguration des Dateisystems
  6. Installation CIB documentserver
  7. Konfiguration CIB webdesk
  8. Deployment CIB webdesk


5.2. Bereitstellung der Laufzeitumgebung

Zur Installation von CIB webdesk ist es nötig eine geeignete Laufzeitumgebung zur Verfügung zu stellen. Folgende Komponenten werden als Laufzeitumgebung benötigt:

  • Java Development Kit (JDK) (Version 1.8). Es wird empfohlen, die 64 Bit Version zu verwenden, damit CIB webdesk mehr RAM nutzen kann. Möglich sind Oracle sowie OpenJDK. Ab Version 4.5.2 werden auch JDK Version 9, 11 und 13 unterstützt.
  • Apache Tomcat Servlet Container (Version 8.5 sowie 9.X) oder Oracle Weblogic 12c
  • Datenbank (Oracle 12, 18 und 19c)

Die Installation dieser Komponenten ist in der Dokumentation des jeweiligen Produkts erläutert. Zusätzlich sind allerdings einige manuelle Schritte notwendig, um den von CIB webdesk verwendeten Web Service Stack korrekt zu installieren.

Informationen zu aktuell freigegebenen Laufzeitumgebung sind über den CIB Support erhältlich.


5.3. Installation des web service Stacks (Bis Version 4.5.1)

Ab Version 4.5.2 nicht mehr notwendig. Aus bereits gepatchten Application-Servern müssen die JAX-WS Libraries entfernt werden.

CIB webdesk verwendet JAX-WS um Web Services anbieten und konsumieren zu können. Hierbei wird die Referenzimplementierung der JAX-WS verwendet, die kostenlos heruntergeladen werden kann.

Folgende JAX-WS Versionen sind produktiv im Einsatz:

  • JAX-WS RI 2.2.6b21
  • JAX-WS RI 2.2.8
  • JAX-WS RI 2.3.1

Der Download liefert ein ZIP-Archiv mit mehreren Verzeichnissen und Dateien. Entpacken Sie dieses Archiv in ein beliebiges Verzeichnis auf Ihrer Festplatte und führen Sie anschließend die folgenden Schritte aus.

        1.      Kopieren Sie sämtliche JAR-Dateien aus dem Verzeichnis JAXWS_UNZIP_DIR/jaxws-ri/lib in das Verzeichnis CATALINA_HOME/shared/lib

        2.      Bearbeiten Sie die Datei CATALINA_HOME/conf/catalina.properties mit einem beliebigen Texteditor. Suchen Sie nach der Zeile die mit der Zeichenkette „shared.loader=“ beginnt.

         ${catalina.base}/shared/lib,${catalina.base}/shared/lib/*.jar,${catalina.home}/shared/lib,${catalina.home}/shared/lib/*.jar

                  Speichern Sie anschließend die Datei und beenden Sie den Texteditor.

Hierbei bezeichnet der Platzhalter JAXWS_UNZIP_DIR das Verzeichnis, in welches Sie die JAX-WS Referenzimplementierung entpackt haben. CATALINA_HOME bezeichnet das Installationsverzeichnis von Apache Tomcat.

Informationen zu aktuell freigegebenen JAX-WS-RI Version sind über den CIB Support erhältlich.


5.4. Installation des Datenbanktreibers

Der Datenbanktreiber kann direkt bei Oracle heruntergeladen werden. Der Einsatz der Die aktuellste Version für JAVA 8, ojdbc8.jar, wird empfohlen. Informationen zu aktuell freigegebenen OJDBC Version sind über den CIB Support erhältlich.

Die JAR kann der JAX-WS Libraries in das Verzeichnis CATALINA_HOME/shared/lib kopiert werden. Siehe Vorgehen in 2 Installation des Webservice Stacks beschrieben.



5.5. Konfiguration der Java Umgebung

Es wird empfohlen, folgende Einstellungen an der Java Virtual Machine, in der der Apache Tomcat läuft, vorzunehmen. Details zu den Einstellungen siehe Oracle Dokumentation.

-Xms128m

Minimale Größe des allokierbaren Speichers

-Xmx756m

Reservierte Größe des allokierbaren Speichers. Je nach Verwendung des 64 Bit Java und je nach Größe des verfügbaren RAMs des Servers kann der Wert auch erhöht werden.

-XX:MaxPermSize=256m

Größe des „PermgenSpaces“. Diese Option muss aktuell gesetzt werden, da sonst während der Laufzeit Fehlern auftreten.

-Dlog4j.configurationFile

Log4j2 Datei.

Beispiel: „file:///var/lib/tomcat8/shared/classes/log4j2.xml“

-Duser.language=de

-Duser.country=DE

Sprache für CIB webDialog (Restdatenerfassung) konfigurieren.

 

Ab webdesk Version 4.5.2 nicht mehr unterstützt:

-Dlog4j.configuration

Log4j (Version 1) Datei.

Beispiel: „file:///srv/webdesk/wbdconfig/log4j.xml“




5.6. Konfiguration Datenbank

Allgemein
Datenbank-Zeichensatz
Benutzte DB-Optionen
Datenbankbenutzer
Datenbanktabellen
Konfiguration der Datenbankverbindung

Allgemein

CIB webdesk benötigt eine Datenbank für den Betrieb. Die Installation eines relationalen Datenbankmanagementsystems wird an dieser Stelle übersprungen, da dies außerhalb des Rahmens dieses Dokuments liegt. Ein solches System steht in vielen Fällen bereits zur Verfügung oder muss entsprechend der zughörigen Dokumentation separat installiert werden.

Dazu sind mehrere Informationen aus dieser Dokumentation zu berücksichtigen, die in den folgenden Abschnitten aufgeführt sind (siehe „Datenbank-Zeichensatz“ und folgende).

Im Hinblick auf CIB webdesk ist letztlich das Anlegen des von CIB webdesk benötigten Datenbankschemas und der relevanten Tabellen vorzunehmen und die Anpassung der Konfigurationsdatei von CIB webdesk durchzuführen.

Zur Anlage der Tabellen sind jeweils aktuelle SQL-Skripten zu verwenden. Diese können über den CIB Support angefordert werden.

Für die Installation der SQL-Skripte und für den Betrieb müssen die Rechte

  • create or replace view
  • create or replace TRIGGER
  • create sequence
  • create index

dem Datenbankbenutzer hinzugefügt werden.


Datenbank-Zeichensatz

Characterset                             AL32UTF8 (Oracle)

Im Umfeld PostgreSQL wird UTF-8 verwendet.

Diese Zeichensätze sind fest in der DB definiert und können in der Regel nicht nachträglich geändert werden.


Benutzte DB-Optionen

Es sind keine besonderen Optionen bekannt oder vereinbart.


Datenbankbenutzer

CIB webdesk benötigt genau einen technischen Datenbankbenutzer. Der Datenbankbenutzer benötigt mindestens folgende Rechte:

  • Lesen der CIB webdesk Datenbanktabellen (SELECT)
  • Schreiben der CIB webdesk Datenbanktabellen (UPDATE, INSERT, DELETE)
  • Es wird empfohlen, keine diesem Benutzer Speicherbegrenzung („Quota“) zuzuordnen.


Datenbanktabellen

Name

Enthält ggf. datenschutzrelevante Daten

Beschreibung

ASSOCIATION

Gruppenzuordnung der Vorlagen und Vorlagenbaum.

CLUSTER_LOCK

CONFIGURATION

Mandantenbeschreibung

CONTENT

Alle Binärdaten von Vorlagen, Pakten und Hilfsobjekten.

COSYS_WEBDIALOGSESSION

X

Ablage der Daten aus der Restadatenerfassungsmaske.

DOC_AC

 

DRAFTS

X

Ablage für Entwürfe. Enthält Kundendaten.

EDITSESSION

Session Informationen zur Freitextnachbearbeitung.

ELEMENT

X

Ablage der RTF-Snippets aus der Freitextnachbearbeitung.

ELEMENTCONTAINER

Zuordnung RTF-Snippet zu Dokument.

FAVORITES

Vorlagen die als Favoriten markiert wurden.

FILING

X

Ablage für generierte Dokumente

FM_TRK_ARCH_OUT

 

FM_TRK_ARCH_PROC

 

FM_TRK_CENTRAL_PRINT_OUT

 

FM_TRK_CENTRAL_PRINT_PROC

 

FM_TRK_IN

 

FM_TRK_ORDERING_OUT

 

FM_TRK_ORDERING_PROC

 

GENERAL_CONTENT

 

 

HISTORY

Änderungshistorie der Vorlagen.

ID_GENERATORS

Barcode ID Generator..

META_CUSTOMER

Kundenspezifische Metadaten der Vorlagen.

META_DATASOURCE

Metadaten der Datenquelle.

META_LAYOUT

Metadaten der Layoutpakete.

META_PRINT_PROFILE

Metadaten der Druckprofile.

META_REMINDER

Metadaten der Wiedervorlageschablonen.

META_TEMPLATE

Metadaten der Vorlagen.

PACKAGE

Pakete und Hilfsobjekte (Mandantpaket, Signaturpaket, Datenquellen, ...)

PARTNERS

 

REF_INCLUDES

Referenzen Includes (In welchen Bausteinen werden Bausteine verwendet?).

REF_PACKAGE_ELEMENTS

Referenzen Bausteine (In welchen Vorlagen bzw. Paketen sind bestimmte Bausteine vorhanden?)

REF_VARIABLES

Referenzen Variablen (In welchen Bausteine werden bestimmte Variablen verwendet?)

SEQUENCE_TRACKING_ENTRIES

 

STACKED_DOCUMENTS

 

STACK_BUNDLES

 

STATISTICS

Daten der Vorlagenstatistik.

SUPPORT_FILE

X

Ablage für Support-Dateien.

TEMPLATE

Vorlagen (dynamisch, statisch und Papiervorlagen).

TEMPLATE_INDIVIDUALIZED

Individualisierte Vorlagen.

TEMPLATE_PREVIEW

Thumbnails (Vorschaubilder) der Vorlagen.

USER_CONTACTPERSON

Am Benutzer abgespeicherte Ansprechpartner.

USER_SIGNATUREDEFAULTS

Am Benutzer abgespeicherte vorbelegte Unterzeichner.

VALUE_TABLES

 

VALUE_TABLE_RECORDS

 

VERSION_INDIVIDUALIZED

Versionsinformationen zu individualisierten Vorlagen.

VERSION_PACKAGE

Versionsinformationen der Pakete und Hilfsobjekte.

VERSION_TEMPLATE

Versionsinformationen der Vorlagen.

WBD_TRK_COMMIT

 

WBD_TRK_POSTCOMMIT

 

WBD_TRK_RESULT

 

WORKFLOW_STATE

 

CIB webdesk interner Freigabeworkflow via E-Mail


Konfiguration der Datenbankverbindung

Die Datenbankverbindung wird über eine Reihe von Parametern konfiguriert, die in der Datei webdesk.properties zu finden sind.

Details dazu finden Sie im Kapitel Datenbank.



5.7. Konfiguration Dateisystem

CIB webdesk sowie die nativen CIB Module arbeiten auch auf Dateisystemebene. Dabei dürfen keine UNC-Pfade zum Einsatz kommen. Sollte ein nicht auf dem Server befindliches Dateisystem genutzt werden, muss die Einbindung des Dateisystems derart erfolgen, dass für die Installation von CIB webdesk und CIB documentServer das Dateisystem wie das lokale Dateisystem angesprochen werden kann.

Beispielsweise müssen Network File Systeme unter einem Linux direkt gemountet werden. UNC Pfade unter Windows sind nicht erlaubt. (z.B. „\\docserv\jobs“).

Es muss sichergestellt sein, dass die Verzeichnisse existieren, die in der Konfiguration von CIB webdesk (siehe Beschreibung unter „Platzhalter & Pfade“) sowie der Logdatei Konfiguration eingestellt sind, bevor CIB webdesk ausgeführt wird. CIB webdesk legt diese Verzeichnisse nicht selbständig an sondern protokolliert ihr Fehlen im Log. Bei Fehlen der Verzeichnisse kann CIB webdesk nicht ordnungsgemäß starten oder es treten bei Verwendung Fehler auf.

Wichtiger Hinweis zu dem Zusammenspiel CIB webdesk und CIB documentServer:

Bestimmte Pfade bzw. Verzeichnisse müssen zwingend von CIB webdesk und CIB documentServer gleichermaßen erreichbar sein. Erkennbar sind die Verzeichnisse anhand der Namen in der Konfiguration von CIB webdesk. Endet der Parametername eines Konfigurationsparameters auf „FromDocumentServerView“, so handelt es sich dabei um ein Verzeichnis, das von CIB webdesk und CIB documentServer für den Datenaustausch genutzt wird. Damit können die Verzeichnisse aus beiden Perspektiven unterschiedlichen montiert sein (mount point) und die Module auf getrennten Maschinen betrieben werden.

Beispiel: „superFolder“ und „superFolderFromDocumentServerView“.


Beispiel A

CIB webdesk und CIB documentserver laufen auf der gleichen Instanz, z.B. innerhalb derselben Tomcat-Instanz bzw. auf einem System: Es kann direkt ein Verzeichnis konfiguriert werden:

superFolder

/var/webdesk/packages

superFolderFromDocumentServerView

/var/webdesk/packages



Beispiel B

CIB webdesk und CIB documentServer laufen auf unterschiedlichen Instanzen in getrennten Systemen: Es muss sichergestellt werden, dass die Verzeichnisse zwischen den Instanzen bzw. Systemen erreichbar sind. Beispielsweise kann ein Network File System genutzt werden, welches auf den Instanzen von CIB webdesk und CIB documentServer unterschiedlich montiert wird.

Gegeben ist ein zentrales NFS „nfsmount“.

Instanz A, CIB webdesk: NFS gemounted nach „/var/webdesk/nfsmount“

Instanz B, CIB documentserver: NFS gemounted nach „/var/documentserver/nfsmount“

Daraus ergibt sich die Konfiguration des CIB webdesk:

superFolder

/var/webdesk/nfsmount

superFolderFromDocumentServerView

/var/documentserver/nfsmount

So kann für unterschiedliche, getrennte CIB webdesk-Instanzen ein gemeinsamer CIB documentServer genutzt werden.


5.8. Installation CIB Documentserver

Damit CIB webdesk Dokumente erstellen kann, benötigt CIB webdesk den CIB documentServer. Zur Installation dieser Webapplikation siehe „Technischer Leitfaden CIB documentServer“.


6. Konfiguration CIB webdesk

CIB webdesk benötigt pro Instanz, bzw. Knoten eines Clusters, eine eigene Konfiguration. Beim Deployment von CIB webdesk muss die Konfiguration des CIB webdesk eingestellt werden.


6.1. Funktionsweise der Konfiguration

Allgemein
Das Plugin-Konzept von CIB webdesk
Einsteuern von Konfigurationseigenschaften mit Hilfe eines Plugins

Allgemein

CIB webdesk wird mit Hilfe einer beim Start der Webapplikation eingelesenen Properties-Datei konfiguriert, welche im ausgelieferten WAR-Archiv enthalten ist.

Die CIB webdesk Properties Datei kann an folgenden Orten abgelegt werden

  • Im Classpath
  • Im „user.home“ Verzeichnis
  • In einem beliebigen Verzeichnis, das über die Tomcat Aufrufparameter (z.B. in /etc/default/tomcat8 oder in CATALINA_HOME/bin/setenv.sh) „-DWBD_CONFIG_DIR“ gesetzt werden kann

CIB webdesk verfügt über einen Plugin-Mechanismus, der es erlaubt, die Applikation mit einer eigenen Komponente zu erweitern, die sich in den Einlesevorgang der Konfigurationsdatei einklinkt und beliebige Konfigurationsschlüssel übersteuert. Alternativ kann die im WAR enthaltene Konfigurationsdatei vor dem Deployment manuell oder per Skript angepasst werden.


Das Plugin-Konzept von CIB webdesk

Grundsätzlich werden dafür nur Standardmechanismen für Web-Applikationen genutzt.

Intern verwendet CIB webdesk das Spring Framework, das auch für die Implementierung des Plugin-Mechanismus verwendet wurde. Ein Plugin für CIB webdesk besteht daher mindestens aus einer Spring Konfigurationsdatei, in welcher Beans definiert werden, die vom Spring Framework beim Startup der Applikation automatisch erzeugt werden. In der Regel beinhaltet ein Plugin außerdem eigene Klassen, die in einem JAR-Archiv bereitgestellt werden können.

Die Konfigurationsdatei des Plugins ist eine XML-Datei, deren Dateiname auf „-config.xml“ enden muss. Sie muss zudem in das Verzeichnis WEB-INF/plugins unterhalb des Deployment-Verzeichnisses von CIB webdesk kopiert werden. In dieser Datei werden Beans definiert, die dann bei Initialisierung der Webapplikation vom Spring Framework instanziiert werden. Ein Beispiel für eine einfache Bean-Definition kann dem folgenden Listing entnommen werden.

<?xml version="1.0" encoding="UTF-8"?>
<!--  SPRING CONFIG -->
<beans xmlns=
"http://www.springframework.org/schema/beans"
       xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
       xmlns:context="http://www.springframework.org/schema/context"
       xsi:schemaLocation=
"http://www.springframework.org/schema/beans
            http://www.springframework.org/schema/beans/spring-beans-2.5.xsd
            http://www.springframework.org/schema/context
         http://www.springframework.org/schema/context/spring-context-2.5.xsd"
>
       <bean class="com.example.MyBeanClass" scope="singleton">
            <property name=
"foo" value="bar" />
      </bean>
</beans>

Diese Konfiguration erzeugt beim Hochfahren des Spring Application Context, was bei der Initialisierung von CIB webdesk geschieht, ein Objekt vom Typ com.example.MyBeanClass und setzt die Property „foo“ dieser Bean auf den Wert „bar“. Der Wert „singleton“ des scope-Attributs legt dabei fest, dass die Bean nur einmal im Application Context abgelegt wird und alle Anfragen auf die Bean dieselbe Instanz zurückliefern.

Eine umfassende Erläuterung würde den Rahmen dieses Dokuments sprengen. Es sei deshalb auf die Dokumentation des Spring Frameworks verwiesen.

Wenn CIB webdesk Plugin-spezifische Klassen beinhalten soll, müssen diese in einem JAR-Archiv im Verzeichnis WEB-INF/lib unterhalb des Deployment-Verzeichnisses von CIB webdesk zur Verfügung gestellt werden. Um das Beispiel aus dem obigen Listing aufzugreifen, müsste hier also ein JAR-Archiv bereitgestellt werden, welches (mindestens) das Paket com.example und darin die Klasse MyBeanClass enthält.

Wichtig: Achten Sie darauf, dass die in der XML-Konfiguration definierten Properties Ihrer Beans korrekt geschrieben und öffentlich (public) sichtbar sind. Wenn die Konfiguration fehlerhaft ist, kann CIB webdesk nicht ordnungsgemäß gestartet werden.


Einsteuern von Konfigurationseigenschaften mit Hilfe eines Plugins

Ein Plugin zur Einsteuerung von externen Konfigurationsparametern in CIB webdesk muss eine Bean im Singleton-Scope ablegen, die das Interface de.cib.webdesk.configuration.application.ExternalConfigPlaceholderResolver implementiert. Dieses Interface definiert eine einzige Methode namens resolvePlaceholder, die einen Wert für einen als Parameter übergebenen Schlüssel zurückliefert. So kann ein Plugin entwickelt werden, das z.B. Werte aus einem externen Web Service oder einer Konfigurations­Datenbank zurückliefert.

Wenn CIB webdesk auf seine Konfiguration zugreift und ein solches Konfigurationsplugin vorhanden ist, ruft die Anwendung zunächst die resolvePlaceholder-Methode des Plugins. Erst wenn diese keinen Wert (d.h. null) zurückliefert, wertet CIB webdesk den Wert aus seiner internen Konfigurationsdatei aus. So können existierende Werte für Parameter in der im WAR enthaltenen Konfiguration mit externen Werten überladen werden.

Die verfügbaren Konfigurationsparameter, die auf diese Weise externalisiert werden können, werden im Abschnitt Konfigurationsparameter beschrieben. Alle in diesem Abschnitt als erforderlich gekennzeichneten Parameter müssen für den erfolgreichen Betrieb von CIB webdesk zwingend über das kundenspezifische Konfigurationsplugin (oder direkt in der enthaltenen Konfigurationsdatei) gesetzt werden.

6.2. Konfigurationsparameter

Im Folgenden werden die wichtigsten Konfigurationsparameter für CIB webdesk beschrieben. Erforderliche Konfigurationsparameter, die nicht über einen direkt verwendbaren Default-Wert verfügen sind hierbei farblich gekennzeichnet.

Allgemeine Parameter
Datenbank
Session-Cleaner
Vorlagencache
Cleaning (DB und Festplatte)
CIB documentServer
Platzhalter & Pfade
Restdatenerfassung
PDF-Erstellung
Darkdesk-Benachrichtigungen
Serienbrief-Erstellung
Verschiedenes

Allgemeine Parameter

Parametername

Erläuterung

cosys.centralClient

Mandantennummer des zentralen Mandanten.

Beispiel: "2000"

cosys.releaseFilter

Release-Filter für die Selektion von Vorlagenversionen.

Beispiel: „4900“



Datenbank

Parametername

Erläuterung

db.url

JDBC-URL zur Herstellung von Datenbankverbindungen. Das Format dieser URL hängt vom verwendeten JDBC-Treiber ab und ist der entsprechenden Dokumentation zu entnehmen.

Beispiel: "jdbc:oracle:thin:@hostname:1521:orcl"

db.user

Benutzername zur Authentifizierung am Datenbankserver.

db.password

Passwort zur Authentifizierung am Datenbankserver.

db.driverClass

Vollqualifizierter Klassenname des JDBC-Treibers, der für die Verbindungsherstellung zur Datenbank verwendet wird. Dieser Parameter kann die folgenden Wertausprägungen annehmen:

  • oracle.jdbc.driver.OracleDriver (für Oracle-Datenbanken)
  • org.postgresql.Driver (für PostgreSQL-Datenbanken)

db.hibernate.dialect

Der SQL-Dialekt, der von der in CIB webdesk integrierten Persistenz-Bibliothek Hibernate bei der automatischen Erzeugung von SQL-Abfragen verwendet wird. Dieser Parameter kann die folgenden Wertausprägungen annehmen:

  • org.hibernate.dialect.Oracle10gDialect (für Oracle-Datenbanken)
  • org.hibernate.dialect.PostgreSQLDialect (für PostgreSQL-Datenbanken)

db.maxActive

Maximale Anzahl gleichzeitig aktiver Datenbankverbindungen.

Default: 5

db.maxWait

Maximale Wartezeit auf eine Datenbankverbindung in Millisekunden bevor ein Fehler ausgelöst wird.

Default: 15000



Session-Cleaner

Parametername

Erläuterung

webdesk.sessionConversationCleaner.delay

Definiert in welchem zeitlichen Abstand der Conversation-Cleaner ausgeführt werden soll. „Simple spring bean that is triggered by a spring timer task in webdesk-conversation-config.xml. Each time the task calls checkForTimedOutConversations(), it builds a http POST request for each active session inside the application and thereby calls the ConversationCleanupFilter servlet filter to actually clean up timed out conversation scopes for the session given inside the cookie of the POST request.“

Default: 10000 (10 Sek)

webdesk.sessionTimeoutNotifyEnabled

Definiert ob der Nutzer eine Nachricht beim Ablauf der Session angezeigt bekommen soll und ob ein Cleanup-POST-Request an die in der Property „webdesk.sessionConversationCleanupRequestUrl“ definierten URL gesendet werden soll.

Default: True

webdesk.sessionConversationCleanupRequestUrl

Die URL gibt die Zieladresse für den simulierten Browserzugriff an und muss zwingend ohne netzwerktechnische Umwege auf die eigene Tomcat zeigen. Eine Adressierung über einen Dispatcher/LoadBalancer ist nicht zulässig. Nur http wird aktuell unterstützt nicht https.

Ist diese Property nicht gesetzt, wird folgende Warnung angezeigt „No URL for ConversationCleaner configured, feature disabled. This might cause memory issues!“.

Beispiel: http://localhost:8080/webdesk

Default: nicht gefüllt

webdesk.sessionConversationTimeout

 

Definiert die Lebenszeit einer Conversation bzw. einer Browser-Tab-Session, wenn größer als 0. In dem Fall das diese Property den Wert 0 hat, wird die Lebenszeit der Conversation bestimmt durch die Properties webdesk.sessionTimeoutNotifyEnabled, webdesk.sessionTimeoutNotifyDelay und webdesk.sessionTimeoutNotifyUserReplyDelay. Hat die Property webdesk.sessionTimeoutNotifyEnabled den Wert „false“, so wird die Lebenszeit einer Conversation über die Application-Property (web.xml) auf 480 min gestellt.

Default: 0

webdesk.sessionTimeoutNotifyDelay

Definiert wie lange bei Inaktivität webdesk wartet bis dem Nutzer die Nachricht anzeigt wird, das die aktuelle Session abläuft.

Default: 900000 (15 min)

webdesk.sessionTimeoutNotifyUserReplyDelay

Definiert wie lange auf die Antwort des Nutzers (zu webdesk.sessionTimeoutNotifyDelay Nachricht) gewartet wird.

Default: 300000 (5 min)




Vorlagencache

Parametername

Erläuterung

templateTreeCache.cacheTO

Diese Property ist deprecated.

Cache für die Rolle TO ist deaktiviert.

templateTreeCache.cacheTST

Setzen Sie diesen Wert auf false um den Vorlagencache für Benutzer in der Rolle Tester zu deaktivieren.

Default: false

templateTreeCache.cacheSB

Setzen Sie diesen Wert auf false um den Vorlagencache für Benutzer in der Rolle Sachbearbeiter zu deaktivieren.

Default: true

templateTreeCache.cacheTOTimeout

Diese Property ist deprecated.

Cache für die Rolle TO ist deaktiviert.

templateTreeCache.cacheTSTTimeout

Timeout des Vorlagencaches in Millisekunden für Benutzer in der Rolle Tester. Setzen Sie diesen Wert auf 0 um den Vorlagencache für Benutzer in der Rolle Tester zu deaktivieren.

Default: 0

templateTreeCache.cacheSBTimeout

Timeout des Vorlagencaches in Millisekunden für Benutzer in der Rolle Sachbearbeiter. Setzen Sie diesen Wert auf 0 um den Vorlagencache für Benutzer in der Rolle Sachbearbeiter zu deaktivieren.

Default: 3600000

templateTreeCache.cleanTaskPeriod

Ausführungs-Intervall in Millisekunden für den Task, der periodisch abgelaufene Objekte aus dem Cache (Vorlagen/Paketen) entfernt. Setzen Sie diesen Wert auf 0 um das Entfernen abgelaufener Cache-Objekte zu deaktivieren. Beachten Sie dass, dies den Hauptspeicherbedarf der Anwendung erhöht.

Default: 1800000

darktom.cacheInvalidationPeriod

Diese bewirkt, dass alle 10 Sekunden die Änderungshistorie abgefragt und modifizierte Objekte aus dem Cache geworfen werden.

Default: Deaktiviert



Cleaning (DB und Festplatte)

Parametername

Erläuterung

webdesk.cleanJobs

Zeit in Millisekunden, nach der die Arbeitsverzeichnisse zurückliegender webdesk-Dokumenterzeugungsjobs gelöscht werden. Setzen Sie diesen Wert auf 0 um das Löschen der Arbeitsverzeichnisse zu deaktivieren.

Default: 600000 (10 Minuten)

webdesk.cleanPackages

Paketverzeichnisse löschen. 0=deaktiviert, 1=aktiviert

Default: Deaktiviert

webdesk.cleanWebdialogRepositories

Cache der Restdatenerfassungsmasken löschen. 0=deaktiviert, 1=aktiviert

Default: Deaktiviert

webdesk.fileSystemCacheCleaner.period

Zeit in Millisekunden, nach der die Arbeitsverzeichnisse zurückliegender Paketverzeichnisse und Cache der Restdatenerfassungsmasken (webdialog) gelöscht werden.

Default: Deaktiviert

webdesk.fileSystemCacheCleaner.startAt

Startzeitpunkt des Löschlaufs Default: 00:00 (HH:MM)

webdesk.fileSystemCacheCleaner.skipCentralPackages

Definiert ob zentrale Pakete gelöscht werden sollen. Relevant falls webdesk.cleanPackages aktiviert.

Default: false

filing.cleaningPeriod

Siehe 8.6 Bereinigung der Dokumentablage

filing.ageLimitCommittedDocuments

Siehe 8.6 Bereinigung der Dokumentablage

filing.ageLimitUncommitedDocuments

Siehe 8.6 Bereinigung der Dokumentablage

webdesk.transactionTracking. .\.
            autoClean.fileAge

Zeit in Millisekunden, nach der die Sequence Tracking Daten (auch: Transaction Tracking Daten) einer Dokumenterzeugungssequenz gelöscht werden.

Default: 7200000 (2 Stunden)



CIB documentServer

Parametername

Erläuterung

webdesk.documentServerUrl

URL der für die Dokumenterzeugung verwendeten Instanz des CIB documentServers.

webdesk.documentServerPort

Portnummer, auf welcher die für die Dokumenterzeugung verwendete Instanz des CIB documentServers auf eingehende Verbindungen lauscht.

Default: 8080

webdesk.documentServerServletName

Name des Dokumenterzeugungsservlets, das in der für die Dokumenterzeugung verwendeten Instanz des CIB documentServers ausgeführt wird.

Default: "/CibDocumentServer/Generate"



Platzhalter & Pfade

Parametername

Erläuterung

superFolder

Basisverzeichnis für alle Arbeitsverzeichnisse.

Beispiel: „/var/webdesk“

superFolderFromDocumentServerView

Pfad zum durch den Parameter superFolder bestimmten Basisverzeichnis relativ zum Ausführungsverzeichnis von CIB documentserver.

Beispiel: „/var/webdesk“

secureBaseDir

Verzeichnis für nicht flüchtige Dateien, die während des Betriebs von CIB webdesk erzeugt werden, wie z.B. die Ergebnisdateien der Dokumenterzeugung.

Default: ${superFolder}

secureBaseDirFromDocumentServerView

Pfad zu dem durch den Parameter secureBaseDir bestimmten Verzeichnis für nicht-flüchtige Dateien, relativ zum Ausführungsverzeichnis von CIB documentserver.

Default: ${superFolderFromDocumentServerView}

workBaseDir

Verzeichnis für temporäre Dateien, die während des Betriebs von CIB webdesk erzeugt werden.

Default: ${superFolder}

workBaseDirFromDocumentServerView

Pfad zu dem durch den Parameter workBaseDir bestimmten Verzeichnis für temporäre Dateien.

Default: ${superFolderFromDocumentServerView}

tomcat.webappsPath

Pfad des webapps-Verzeichnisses der verwendeten Tomcat-Instanz.

Beispiel: „/var/webapps“

tomcat.servletUrl

URL der Web-Oberfläche von CIB webdesk.

Beispiel: „http://localhost:8080/webdesks“

logDir

Verzeichnis für von CIB webdesk geschriebene Protokolldateien. Damit sind Dokumentnachverfolgung und Abrechnungslogging gemeint.

Beispiel: „/var/webdesk/logs“

webdesk.packagePath

Verzeichnis, in welches Vorlagen-Pakete für die Dokumenterzeugung von CIB webdesk deployed werden.

Default: „${workBaseDir}/packages“

webdesk.packagePathForDocumentServer

Pfad zu dem durch den Parameter webdesk.packagePath festgelegten Paket-Deployment-Verzeichnis, relativ zum Ausführungsverzeichnis des CIB documentServers.

Default: „${workBaseDirFromDocumentServerView}/
                        packages“

webdesk.jobPath

Verzeichnis für temporär für Dokumenterzeugung benötigte Dateien.

Default: „${workBaseDir}/jobs“

webdesk.jobPathForDocumentServer

Pfad zu dem durch den Parameter webdesk.jobPath festgelegten Job-Verzeichnis, relativ zum Ausführungsverzeichnis des CIB documentServers.

Default: „${workBaseDirFromDocumentServerView}/
                        jobs“

webdesk.sharedPath

Verzeichnis, in dem über die Web-Oberfläche von CIB webdesk hochgeladene Eingabedateien für die Dokumenterzeugung abgelegt werden.

Default: „${secureBaseDir}/wbd_shared“

webdesk.sharedPathForDocumentServer

Pfad zu dem durch den Parameter webdesk.sharedPath festgelegten Upload-Verzeichnis, relativ zum Ausführungsverzeichnis des CIB documentServers.

Default: "${secureBaseDirFromDocumentServerView}/
                        wbd_shared"

webdesk.serialLetterRepositoryPath

Verzeichnis, in dem Dokumente nach der Freigabe zur Weitergabe an die Nachverarbeitung abgelegt werden.

Default: "${secureBaseDir}/repository“

webdesk.serialLetterRepository .\.
            PathOuter

Pfad zu dem durch den Parameter webdesk.serialLetterRepositoryPath festgelegten Repository-Verzeichnis, relativ zum Ausführungsverzeichnis des CIB documentServers.

Default: "${secureBaseDirFromDocumentServerView}/
                        repository“

webdesk.webdialogRepositories

Verzeichnis, in dem die für CIB webdialog benötigten Artefakte deployt werden (HTML, RUL und INC Dateien).

Default: "${secureBaseDir}/webdialog-repositories"

webdesk.webdialogRepositories .\.
            ForDocumentServer

Pfad zu dem durch den Parameter webdesk.webdialogRepositories festgelegten Webdialog-Deployment-Verzeichnis, relativ zum Ausführungsverzeichnis des CIB documentServers.

Default: "${secureBaseDirFromDocumentServerView}/
            webdialog-repositories"

webdesk.jviewTempPath

Temporäres Arbeitsverzeichnis zum Entpacken von CIB jView Dateien.

Default: "${workBaseDir}/jview_temp“

webdesk.supportRepository

Verzeichnis, in dem CIB im Fall von Fehlern bei der Dokumenterzeugung Fehleranalysedaten ablegt.

Default: "${superFolder}/support"

webdesk.contentCachePath

Basisverzeichnis des Datei-basierten Caches von CIB webdesk.

Default: "${workBaseDir}/content_cache"

webdesk.analyzePath

Temporäres Verzeichnis für die Ergebnisdateien der Vorlagenanalyse von CIB webdesk.

Default: "${workBaseDir}/analyze_result"

webdesk.transactionTracking. .\.
            businessTransactionCacheDir

Verzeichnis, in dem CIB webdesk Daten für die Vorgangsverfolgung ablegt.

Default: "${workBaseDir}/sequence_tracking_data"

webdesk.tracking.trackingLogDir

Verzeichnis, in dem CIB webdesk Protokolldateien für die Dokumentnachverfolgung ablegt.

Default: "${logDir}/tracking-logs"



Restdatenerfassung

Parametername

Erläuterung

darkdesk.webdialogStandaloneURL

URL, unter der CIB webdialog standalone aufgerufen werden kann.

Default: ${tomcat.servletUrl}/restdata/webdialog_standalone.zul

default.fontSizeMap

Werte-Tabelle für das Umsetzen der RTF-Fontgrößen (in pt) in die HTML-Fontgrößen (1 – 6).

Angabe einer Liste von max. fünf Fontgrößen in pt.

Das ergibt im Default-Fall die folgenden Bereiche für Fontgröße f:

0 < f <= 8pt „1“ (HTML-Fontgröße)
8pt < f <= 10pt „2“
10pt < f <= 12pt „3“
12pt < f <= 14pt „4“
14pt < f <= 16pt „5“
16pt < f „6“

Hinweise:

Die Angabe von Dezimalstellen ist möglich, z.B. „10.5“.
Die Anlieferung der Wertebereiche wird größensortiert erwartet.

Werden in der Tabelle RTF-Fontgrößen gezielt weggelassen, so wird auch die zugehörige HTML-Fontgröße nicht verwendet.

Beispiel:

„;10.5“ ergibt
0 < f <= 10.5t „2“
10.5pt< f „3“

Default: „8;10;12;14;16“

<mandant>.fontSizeMap

Mandantenspezifische fontSizeMap für die Restdatenerfassung.

Beispiel: 3000.fontSizeMap=9;11;13;15;17

webdialog.sessionCleaning.age

Alter eines Eintrags, ab dem er gelöscht werden kann als Zeitangabe. Ist der Wert leer oder nicht als Zeitangabe evaluierbar, erfolgt keine Löschung. Die Zeitangabe darf größer als 24 Stunden sein

webdialog.sessionCleaning.beginTime

Beginn-Zeit, ab der die Löschläufe täglich gestartet werden als Zeitangabe.

webdialog.sessionCleaning.endTime

Ende-Zeit, ab der die Löschläufe nicht mehr gestartet werden als Zeitangabe. In Abhängigkeit von der Dauer eines Löschlaufs kann die Beendigung dessen nach der Ende-Zeit liegen.

webdialog.sessionCleaning.frequency

Frequenz-Zeit der Löschläufe innerhalb Beginn-Ende-Zeiten als Zeitangabe. Ein nachfolgender Löschlauf beginnt um die Frequenz-Zeit versetzt zum Beginn des vorangegangenen Löschlaufs. Er beginnt aber frühestens nach dem Ablauf des vorherigen, wenn die Frequenz-Zeit zu kurz war, um den vorangegangenen zu beenden.

webdialog.sessionCleaning.maxNumberEntries

Anzahl der Einträge, die in einem Löschlauf gelöscht werden. Ist der Wert leer oder nicht als Ganzzahl evaluierbar, erfolgt keine Mengenbegrenzung.

Beispiel:

webdialog.sessionCleaning.age: 24:00:00
webdialog.sessionCleaning.maxNumberEntries: 100
webdialog.sessionCleaning.beginTime: (leer)
webdialog.sessionCleaning.endTime: (leer)
webdialog.sessionCleaning.frequency: 00:15:00

Job löscht kontinuierlich Einträge die älter als 24 Stunden sind; alle viertel Stunde 100 Zeilen aus der Tabelle.


PDF-Erstellung

Parametername

Erläuterung

generation.pdfAuthor

Autor-Attribut für mit Hilfe von CIB webdesk bzw. CIB darkdesk erstellte PDF-Dokumente.

Default: "CIB Korrespondenzmanagement"

webdesk.pdfA

Dieser Parameter steuert, ob mit Hilfe von CIB webdesk erstellte PDF-Dokumente PDF/A konform sind.

Werte: "true" oder "false"

Default: "false"

webdesk.pdfAVersion

Dieser Parameter steuert die PDF/A Version.

Werte: PDF/A-1b, PDF/A-2b, PDF/A-3b

Default: PDF/A-1b

webdesk.pdfASerial

Dieser Parameter steuert, ob mit Hilfe von CIB webdesk erstellte Serienbriefe PDF/A konform sind.

Werte: "true" oder "false"

Default: "false"

webdesk.embedFonts

Dieser Parameter steuert, ob CIB webdesk bei der Dokumenterzeugung Schriftarten in die erstellten PDF-Dokumente einbettet.

Werte: "true" oder "false"

Default: "true"

webdesk.embeddedFontsList

Dieser Parameter akzeptiert als Wert eine Semikolon-separierte Liste von Schriftartennamen. Wurde der Wert des Parameters webdesk.embedFonts auf "true" gesetzt, und ist diese Liste nicht leer, so werden bei der PDF-Erzeugung via CIB webdesk nur die Schriften eingebettet, die in dieser Liste enthalten sind.

webdesk.embedFontsSerial

Dieser Parameter steuert, ob CIB webdesk bei der Erzeugung von Serienbriefen die im Dokument verwendeten Schriftarten in die erzeugten PDF-Dokumente einbettet.

Werte: "true" oder "false"

Default: "true"

webdesk.embeddedFontsListSerial

Dieser Parameter verhält sich analog zu webdesk.embeddedFontsList, wird allerdings nur bei der Generierung von Serienbriefen ausgewertet.

webdesk.encryptOwnerPassword

Vgl. CIB format – Technischer Leitfaden, Abschnitt: Spezielle Optionen für die kryptisierte PDF-Ausgabe (EncryptOwnerPassword)

webdesk.encryptUserPassword

Vgl. CIB format – Technischer Leitfaden, Abschnitt: Spezielle Optionen für die kryptisierte PDF-Ausgabe (EncryptUserPassword)

webdesk.encryptEnablePrinting

Vgl. CIB format – Technischer Leitfaden, Abschnitt: Spezielle Optionen für die kryptisierte PDF-Ausgabe (EncryptEnablePrinting)

webdesk.encryptEnableModifying

Vgl. CIB format – Technischer Leitfaden, Abschnitt: Spezielle Optionen für die kryptisierte PDF-Ausgabe (EncryptEnableModifying)

webdesk.encryptEnableNotes

Vgl. CIB format – Technischer Leitfaden, Abschnitt: Spezielle Optionen für die kryptisierte PDF-Ausgabe (EncryptEnableNotes)

webdesk.encryptEnableClipboard

Vgl. CIB format – Technischer Leitfaden, Abschnitt: Spezielle Optionen für die kryptisierte PDF-Ausgabe (EncryptEnableClipboard)

webdesk.encryptEnableForms

Vgl. CIB format – Technischer Leitfaden, Abschnitt: Spezielle Optionen für die kryptisierte PDF-Ausgabe (EncryptEnableForms)

webdesk.encryptEnableAssembling

Vgl. CIB format – Technischer Leitfaden, Abschnitt: Spezielle Optionen für die kryptisierte PDF-Ausgabe (EncryptEnableAssembling)

webdesk.encryptEnableExtract

Vgl. CIB format – Technischer Leitfaden, Abschnitt: Spezielle Optionen für die kryptisierte PDF-Ausgabe (EncryptEnableExtract)

webdesk.encryptSecurityBits

Vgl. CIB format – Technischer Leitfaden, Abschnitt: Spezielle Optionen für die kryptisierte PDF-Ausgabe (EncryptEnableSecurityBits)

webdesk.encryptOwnerPasswordSerial

Vgl. CIB format – Technischer Leitfaden, Abschnitt: Spezielle Optionen für die kryptisierte PDF-Ausgabe (EncryptOwnerPassword)

webdesk.encryptUserPasswordSerial

Vgl. CIB format – Technischer Leitfaden, Abschnitt: Spezielle Optionen für die kryptisierte PDF-Ausgabe (EncryptUserPassword)

webdesk.encryptEnablePrintingSerial

Vgl. CIB format – Technischer Leitfaden, Abschnitt: Spezielle Optionen für die kryptisierte PDF-Ausgabe (EncryptEnablePrinting)

webdesk.encryptEnableModifyingSerial

Vgl. CIB format – Technischer Leitfaden, Abschnitt: Spezielle Optionen für die kryptisierte PDF-Ausgabe (EncryptEnableModifying)

webdesk.encryptEnableNotesSerial

Vgl. CIB format – Technischer Leitfaden, Abschnitt: Spezielle Optionen für die kryptisierte PDF-Ausgabe (EncryptEnableNotes)

webdesk.encryptEnableClipboardSerial

Vgl. CIB format – Technischer Leitfaden, Abschnitt: Spezielle Optionen für die kryptisierte PDF-Ausgabe (EncryptEnableClipboard)

webdesk.encryptEnableFormsSerial

Vgl. CIB format – Technischer Leitfaden, Abschnitt: Spezielle Optionen für die kryptisierte PDF-Ausgabe (EncryptEnableForms)

webdesk.encryptEnableAssemblingSerial

Vgl. CIB format – Technischer Leitfaden, Abschnitt: Spezielle Optionen für die kryptisierte PDF-Ausgabe (EncryptEnableAssembling)

webdesk.encryptEnableExtractSerial

Vgl. CIB format – Technischer Leitfaden, Abschnitt: Spezielle Optionen für die kryptisierte PDF-Ausgabe (EncryptEnableExtract)

webdesk.encryptSecurityBitsSerial

Vgl. CIB format – Technischer Leitfaden, Abschnitt: Spezielle Optionen für die kryptisierte PDF-Ausgabe (EncryptEnableSecurityBits)



Darkdesk-Benachrichtigungen

Parametername

Erläuterung

darkdesk.notificationMailServer

Hostname oder IP-Adresse des für den Versand von Benachrichtigung verwendeten SMTP-Servers.

Beispiel: "127.0.0.1" oder "localhost"

darkdesk.notificationMailFrom

Absenderadresse für von CIB darkdesk versandte Benachrichtigungs-E-Mails.

Beispiel: "noreply@cib.de"

darkdesk.notificationMailUser

Benutzername für die Anmeldung an dem für den Versand von Benachrichtigungs-E-Mails verwendeten SMTP-Server.

Beispiel: "smtp-user"

darkdesk.notificationMailPassword

Passwort für die Anmeldung an dem für den Versand von Benachrichtigungs-E-Mails verwendeten SMTP-Server.

Beispiel: "smtp-password"

darkdesk.notificationMailUseTLS

Dieser Parameter steuert, ob für die Anmeldung an dem für den Versand von Benachrichtigungs-E-Mails verwendeten SMTP-Server das TLS-Protokoll benutzt werden soll.

Werte: "true" oder "false"

Default: "false"

darkdesk.notificationUseMailService

Dieser Parameter steuert, ob für den Versand von Benachrichtigungen ein externer Web Service verwendet werden soll.

Werte: "true" oder "false"

Default: "false"

darkdesk.notificationMaxAttachmentSize

Maximale Größe in Bytes für Dateianhänge der von CIB darkdesk versandten Benachrichtungs-E-Mails.

Default: 1000000

darkdesk.failureMailTo

E-Mail-Adresse des Empfängers für von CIB darkdesk versandte Fehler-Benachrichtigungen. Wird dieser Parameter nicht gesetzt, so werden keine Fehler-Benachrichtigungen versandt.

Beispiel: "support@example.com"

darkdesk.failureMailSubject

Betreff für von CIB darkdesk versandte Fehler-Benachrichtigungen.

Beispiel: "Document Generation Failure“

darkdesk.successMailTo

E-Mail-Adresse des Empfängers für von CIB darkdesk versandte Erfolgs-Benachrichtigungen. Wird dieser Parameter nicht gesetzt, so werden keine Erfolgs-Benachrichtigungen versandt.

Beispiel: "support@example.com"

darkdesk.successMailSubject

Betreff für von CIB darkdesk versandte Erfolgs-Benachrichtigungen.

Beispiel: "Document Generation Success"



Serienbrief-Erstellung

Parametername

Erläuterung

webdesk.serialLetterTestPrintCount

Maximale Anzahl Serienbriefe in der Dokumentvorschau

Default: 50

webdesk.serialLetterMaxPrintCount

Maximale Anzahl Serienbriefe welche in einem Durchlauf erstellt werden können.

Default: -1 (unendlich)



Verschiedenes

Parametername

Erläuterung

darkdesk.concurrentJobsDefault

Maximale Anzahl nebenläufiger Dokumentgenerierungs-Jobs.

Default: 3

generation.mergeFilesizeLimit

Maximale-Dateigröße für das Ergebnis-RTF von CIB merge in Bytes. Dieser Parameter wird genutzt, um mögliche Endlosschleifen in Dokumentvorlagen zu erkennen. Überschreitet die Dateigröße des Ergebnis-RTFs den konfigurierten Wert, so bricht die Generierung mit einem Fehler ab. Wird dieser Parameter nicht gesetzt, führen Endlosschleifen in Dokumentvorlagen nicht zu einem vorzeitigen Abbruch der Generierung, es kann zu Hauptspeicher- und Dateiüberläufen kommen!

generation.obfuscateRtf

TRUE – das Mischergebnis (merge RTF) wird verschlüsselt ausgegeben (default).

FALSE – das Mischergebnis (merge RFT) wird unverschlüsselt ausgegeben.

Auswirkung:
Im „merge-Step“ wird der Parameter „-y“ gesetzt (TRUE) oder ausgesteuert (FALSE)

webdesk.encryptSupportFiles

Dieser Parameter steuert, ob die Support Files verschlüsselt werden, die CIB webdesk im Falle von Fehlern bei der Dokumenterzeugung schreibt. Als Passwort dient dabei jeweils der Dateiname des Support Files.

Werte: "true" oder "false"

Default: "true"


6.3. Konfiguration Logging

Im Regelfall wird die Konfiguration des Loggings von CIB software GmbH mitgeliefert. CIB webdesk nutzt ab Version 4.5.2 Log4j2 zum Loggen von Nachrichten in Log-Dateien.

Die Konfiguration der zu schreibenden Log-Dateien muss durch den Kunden in dieser Datei angepasst werden.

Im Folgenden ein Beispiel der Log4j2 Konfiguration des CIB webdesk:

<?xml version="1.0" encoding="UTF-8"?>
<Configuration status="WARN">
       <Properties>
             <Property name="defaultFormat">%5p %d{dd.MM.yy HH:mm:ss} [%t] [%c] %m%n</Property>
             <Property name="logDir">${sys:catalina.base}/logs</Property>
       </Properties>
       <Appenders>
             <Console name="console" target="SYSTEM_OUT">
                    <PatternLayout pattern="${defaultFormat}" />
             </Console>
             <File name="webdesk" fileName="${logDir}/webdesk.${date:yyyy-MM-dd}.log">
                    <PatternLayout pattern="${defaultFormat}" />
             </File>
       </Appenders>
       <Loggers>
             <Logger name="de.cib.webdesk" level="WARN" additivity="false">
                    <AppenderRef ref="console" />
                    <AppenderRef ref="webdesk" />
             </Logger>
             <Logger name="de.cib.darkdesk_1_0_0" level="WARN" additivity="false">
                    <AppenderRef ref="console" />
                    <AppenderRef ref="webdesk" />
             </Logger>
             <Logger name="de.cib.darkdesk_1_5_0" level="WARN" additivity="false">
                    <AppenderRef ref="console" />
                    <AppenderRef ref="webdesk" />
             </Logger>
             <Logger name="de.cib.darkdesk_1_6_0" level="WARN" additivity="false">
                    <AppenderRef ref="console" />
                    <AppenderRef ref="webdesk" />
             </Logger>
             <Logger name="de.cib.darktom_1_0_0" level="WARN" additivity="false">
                    <AppenderRef ref="console" />
                    <AppenderRef ref="webdesk" />
             </Logger>
             <Logger name="de.cib.darktom_1_5_0" level="WARN" additivity="false">
                    <AppenderRef ref="console" />
                    <AppenderRef ref="webdesk" />
             </Logger>
             <Logger name="de.cib.darkdialog_1_0_0" level="WARN" additivity="false">
                    <AppenderRef ref="console" />
                    <AppenderRef ref="webdesk" />
             </Logger>
             <Logger name="de.cib.darkdialog" level="WARN" additivity="false">
                    <AppenderRef ref="console" />
                    <AppenderRef ref="webdesk" />
             </Logger>
             <Logger name="de.cib.rules" level="WARN" additivity="false">
                    <AppenderRef ref="console" />
                    <AppenderRef ref="webdesk" />
             </Logger>
             <Logger name="de.cib.webdialog" level="WARN" additivity="false">
                    <AppenderRef ref="console" />
                    <AppenderRef ref="webdesk" />
             </Logger>
             <Logger name="performance" level="WARN" additivity="false">
                    <AppenderRef ref="console" />
                    <AppenderRef ref="webdesk" />
             </Logger>
             <Logger name="de.cib.webdesk.jaxwshandler.SoapCallLoggingHandler" level="WARN" additivity="false">
                    <AppenderRef ref="console" />
                    <AppenderRef ref="webdesk" />
             </Logger>
             <Logger name="de.cib.webtom" level="WARN" additivity="false">
                    <AppenderRef ref="console" />
                    <AppenderRef ref="webdesk" />
             </Logger>
             <!-- Silence unwanted 3rd-party logging -->  
             <Logger name ="org.hibernate.event.def.AbstractFlushingEventListener" level="INFO" additivity="false"/>
             <Logger name ="org.hibernate.util.JDBCExceptionReporter" level="INFO" additivity="false"/>
             <Root level="ERROR">
                    <AppenderRef ref="console" />
             </Root>
       </Loggers>
</Configuration>


6.4. Wertetabellen

Allgemein
Konfigurierbare Wertetabellen
Beispiele für Wertetabellen

Allgemein

CIB webdesk bietet die Möglichkeit verschiedene Eigenschaften in der Oberfläche per Wertetabellen zu konfigurieren. Dies sind insbesondere die unter 7.4.1 Konfigurierbare Wertetabellen aufgeführten Wertetabellen für die Vorbelegung von Auswahlfeldern (ComboBox) in CIB webdesk Interview-Masken. Es sei angemerkt, dass sich Eigenschaften nicht nur auf die Oberfläche auswirken können, sondern auch auf die interne technische Repräsentation sowie die Verarbeitung.

Aus diesem Grund sollten Änderungen mit Vorsicht durchgeführt werden. Es wird abgeraten zusätzliche Werte hinzuzufügen. Die Spaltennamen in den Wertetabellen dürfen nicht verändert oder entfernt werden.

Verkleinerung oder Ändern der Initialmenge (Entfernen, Umbenennung von Einträgen) ist in der Regel unproblematisch möglich.

Die Einstellungen aus CIB webTom werden beim Laden einer Vorlage für ein Interview in CIB webdesk ausgewertet. Daher ist bei Änderungen zu bedenken, dass Eingabefelder die im CIB webTom für die Vorlagenadmi­nistration genutzt werden, dort identisch konfiguriert sind (identisch Auswahlmenge mit übereinstimmenden IDs – weitere Details dazu sind in Technischer Leitfaden CIB webTom). Sind in CIB TOM Auswahlen möglich, die in CIB webdesk nicht vorgesehen sind, wird die Auswahl in der Regel auf einen verfügbaren Wert (i.d.R. erster) oder leer eingestellt.

Will man zu einem späteren Zeitpunkt Auswahlmöglichkeiten entfernen oder überarbeiten, ist zu bedenken, dass Entwürfe und noch nicht abgeschlossene Dokumente diese Daten enthalten können. Hier kann es zu unerwarteten Situationen kommen, da CIB webdesk in der Regel davon ausgeht, dass dieser Wert nicht mehr zu verwenden ist und die Einstellung beim Zugriff (d.h. Laden eines Entwurfs oder Dokuments) ohne weiteren Hinweis auf einen gültigen Auswahlwert oder eine leere Auswahl umstellt.

In bestimmten Fällen kann es notwendig sein weitere Konfigurationsdateien anzupassen. Dies trifft insbesondere auf Konfigurationsdateien für die Nachverarbeitung zu, da die Auswahlwerte aus CIB webdesk (z.B. Archivschlüssel) zusammen mit dem Dokument abgelegt und an die Nachverarbeitung weitergereicht werden.

Die Wertetabellen finden sich im Verzeichnis WEB-INF/valuetables, die Namen haben das Format cib_ref_[name].csv.  Die Tabellen liegen in dem Format CSV (comma separated values) vor und lassen sich mit einem beliebigen Texteditor bearbeiten. Das Character-Encoding ist UTF-8.

Es wird zwischen Einzel- und Multiwerttabellen unterschieden. Einzelwerttabellen bilden eine einfache Primärschlüssel-Wert Beziehung ab. Multiwerttabellen bieten die Möglichkeit zu einem Primärschlüssel mehrere Werte anzugeben. Die Konfiguration der Multiwerttabellen wird in der korrespondierenden cib_ref_[name].properties vorgenommen.

Wertetabellen, die im Weiteren nicht aufgeführt sind, werden ausschließlich intern durch CIB webdesk genutzt und sollten auf keinen Fall verändert werden.


Konfigurierbare Wertetabellen

Die folgende Liste führt die Wertetabellen auf, die bei Bedarf angepasst werden können:

  • cib_ref_envelopeType.csv                    Briefumschlagsart
  • cib_ref_letterType.csv                           Briefart
  • cib_ref_paperWeight.csv                      Papiergewicht
  • cib_ref_shippingNote.csv                     Versandvermerk
  • cib_ref_shippingType.csv                     Versandart
  • cib_ref_forwardRule.csv                       Vorausverfügung
  • cib_ref_branchOfficeSource.csv          Ansprechpartnerdaten


Es handelt sich um die entsprechenden Auswahlfelder (Combobox) im webdesk.


Beispiele für Wertetabellen

Nachfolgend sind je ein Beispiel für eine Einzelwerttabelle und eine Multiwerttabelle aufgeführt.

Einzelwertabelle:

cib_ref_shippingType.csv
ID;VALUE
-;---
0;Einschreiben
1;Einschreiben mit Rückschein
2;SB-Einschreiben
3;Übergabeeinschreiben 4;Einschreiben Einwurf
5;Einschreiben eigenhändig
6;Expressbrief

Diese Tabelle steuert den Inhalt der ComboBox „Versandart“ im Reiter „Empfänger“ im Interview.

Multiwertabelle:

cib_ref_letterType.csv

ID;SORT_INDEX;VALUE;COST;BASE_WEIGHT;FACTOR
1;1;Brief Standard;0.58;0;0
2;2;Brief Kompakt;0.90;0;0
3;3;Brief Gross;1.45;0;0
4;4;Infopost Standard;0.25;0;0
5;5;Infopost Kompakt;0.28;20;0.352
6;6;Infopost Gross;0.36;20;0.352

 Diese Tabelle steuert den Inhalt der Combobox  „Papiergewicht“  für den zentralen Druck und Postversand im Reiter „Dokumenterstellung“ im Interview. Hierfür werden die Spalten ID und VALUE verwendet. Die weiteren Werte werden bei der Berechnung der erwarteten Portokosten eines Serienbriefs verwendet.

Hinweis: Werte aus dieser Tabelle werden in der Nachverarbeitung verwendet, wobei nur die IDs durchgereicht werden Eine Änderung auf CIB webdesk Seite erfordert zumindest eine Überprüfung der Konfiguration bzw. des Verhaltens in der Nachverarbeitung – ggf. sind dort ebenfalls Konfigurationsänderungen notwendig.


6.5. URL-Parameter

Allgemein
Anmeldung
Vorbelegung Datensevice-Eingabefelder
Vorlagenauswahl und Interviewaktionen
Anpassung der Oberfläche
Einsprung in Entwurf, Workflow, Wiedervorlage
Einsprung in CIB doXiview
Aktivierung Techadmin Funktion

Allgemein

Das Verhalten von CIB webdesk kann durch eine Reihe von URL-Parametern festgelegt werden. Die Namen dieser Parameter sind konfigurierbar, um eine nahtlose Integration in das Kundenumfeld und etwaige Namenskonflikte zu vermeiden. Die Namen der verfügbaren URL-Parameter können in der Datei urlParametersMapping.properties im Verzeichnis WEB-INF/properties eingetragen werden.

Hinweis: Bitte beachten Sie, dass Sie in der Datei urlParametersMapping.properties nicht die Werte der jeweiligen Parameter bearbeiten können, sondern die Namen dieser Parameter. Wenn Sie also zum Beispiel in dieser Datei folgende Zeile eintragen

j_username=webdeskUsername

so hat dies zur Folge, dass Der Benutzername für den direkten Login in CIB webdesk spezifiziert werden kann, indem man in der Adresszeile den URL-Parameter webdeskUsername angibt.


Anmeldung

Parameter

Beschreibung

j_username

Benutzername, um einen direkten Login unter Umgehung der Anmeldemaske zu ermöglichen.

j_password

Passwort, um einen direkten Login unter Umgehung der Anmeldemaske zu ermöglichen.

j_external_session

Externe Session-ID einer Drittapplikation falls CIB webdesk aus einer solchen heraus gerufen wird und die Benutzersitzung in CIB webdesk an die aus der externen Applikation gekoppelt werden soll.

j_role

Die Rolle, mit der sich der Benutzer anmeldet, um einen direkten Login unter Umgehung der Anmeldemaske zu ermöglichen.

j_effective_company

Die Mandantennummer des effektiven Mandanten, in dessen Kontext der Benutzer mit CIB webdesk arbeiten soll. Dieser Parameter dient ebenfalls dem direkten Login unter Umgehung der Anmeldemaske.

j_user_company

Die Mandantennummer des Benutzers, um einen direkten Login unter Umgehung der Anmeldemaske zu ermöglichen.


Vorbelegung Datensevice-Eingabefelder

Abhängig vom jeweiligen Kundenoverlay.

Kundenoverlay GAD und Präsentationssystem

WS-Plugin Klasse „de.gad.services.GAD_KorrespondenzDatenVerwalterPOJOIF“

Parameter

Beschreibung

j_customer_number

Die Kundennummer, um direkt bei Einstieg in CIB webdesk einen bestimmten Kundenkontext für den jeweiligen Kunden zu etablieren.

j_account_number

Die Kontonummer, um direkt bei Einstieg in CIB webdesk einen bestimmten Kundenkontext für den Eigentümer des jeweiligen Kontos zu etablieren.

j_lock_customer

TRUE: Der Benutzer kann den aktiven Kunden in CIB webdesk nicht wechseln (nur sinnvoll in Kombination mit j_customer_number).

j_lock_account

TRUE: Der Benutzer kann das aktive Konto in CIB webdesk nicht wechseln (nur sinnvoll in Kombination mit j_account_number).

j_lock_datacontext

TRUE: Der Benutzer kann das aktive Konto und den Kunden in CIB webdesk nicht wechseln (nur sinnvoll in Kombination mit j_account_number oder j_customer_number).


Kundenoverlay cosys4cib

WS-Plugin Klasse „de.cib.webdesk.cibac.data.CIBACDataConnector“

Parameter

Beschreibung

j_cosys_jiratask

 

j_cosys_customercontactsign

 

j_cosys_customercontactemail

 

j_lock_customer

TRUE: Der Benutzer kann den aktiven Kunden in CIB webdesk nicht wechseln (nur sinnvoll in Kombination mit j_customer_number).

j_lock_account

TRUE: Der Benutzer kann das aktive Konto in CIB webdesk nicht wechseln (nur sinnvoll in Kombination mit j_account_number).


Kundenoverlay LHM

WS-Plugin Klasse „de.cib.webdesk.services.dataproviders.LHMLDAPDocumentDataProvider“

Parameter

Beschreibung

j_cosys_receiver_name

 

j_cosys_receiver_mail

 

j_cosys_receiver_org

 

j_lock_datacontext

TRUE: Der Benutzer kann den vorbelegten Empfänger in CIB webdesk nicht wechseln.


Vorlagenauswahl und Interviewaktionen

j_tmplate

Wenn für diesen Parameter ein gültiger Vorlagenname angegeben wird, so wird direkt bei Einstieg in CIB webdesk ein Interview mit der angegebenen Vorlage gestartet.

j_templateId

Wenn für diesen Parameter ein gültiger Vorlagenbezeichner einer existierenden Vorlage angegeben wird, so wird direkt bei Einstieg in CIB webdesk ein Interview mit der angegebenen Vorlage gestartet.

j_template_guid

Wenn für diesen Parameter eine gültige Guid einer existierenden Vorlage angegeben wird, so wird direkt bei Einstieg in CIB webdesk ein Interview mit der angegebenen Vorlage gestartet.

j_template_type

Der Parameter Templatetype kann benutzt werden, um in Kombination mit dem Parameter j_template oder j_templateId den Typ der zu öffnenden Vorlage festlegen zu können.

  • 10 für eine dynamische Vorlage
  • 11 für eine statische Vorlage
  • 12 für eine Papiervorlage

j_date_valid

Gültigkeitsdatum für Dokumentvorlagen, die zur Dokumenterzeugung in CIB webdesk verwendet werden.

j_lock_validity

TRUE: Der Benutzer kann das Gültigkeitsdatum für Dokumentvorlagen auf der ersten Interviewseite nicht ändern (nur sinnvoll in Kombination mit j_date_valid).

j_create_document_action

Mit Hilfe dieses Parameters lassen sich per URL Parameter übergebene Vorlagen direkt beim Einstieg in CIB webdesk automatisiert herunterladen oder anzeigen.

Bei statischen Vorlage reicht eine beliebige Belegung aus, damit diese direkt heruntergeladen werden.

Dynamische Vorlagen lassen sich mit der Belegung:

  • 0 erzeugen und im doXiview anzeigen
  • 1 erzeugen und als PDF herunterladen
  • 2 erzeugen und als RTF herunterladen


„j_first_tab“ und „j_first_tab_selector“

  • j_first_tab entspricht dem CIB webTom-Parameter "Erster Reiter".
  • Mit j_first_tab_selector kann gesteuert werden, ob die CIB webTom oder der URL-Parameter verwendet wird. Dabei verstehen wir unter CIB webTom-Parameter, die Parameter die an der Vorlage hinterlegt sind.
  • Wird j_first_tab nicht gesetzt, entspricht dies dem CIB webTom-Parameter "Informationen zur Vorlage".
  • Für j_first_tab_selector können folgende Werte definiert werden:
    • tom ist der Standardwert und verwendet die Parameter der Vorlage
    • url verwendet die übergebenen Parameter
  • Sind beide Parameter nicht gesetzt, entspricht dies dem aktuellen Verhalten, wenn im CIB webTom kein Wert gesetzt ist.
  • Daraus ergeben sich folgende, für diesen Anwendungsfall relevante Beispiele: 

Einstellung im CIB webTom

URL-Parameter j_first_tab

URL-Parameter j_first_tab_selector

Besonderheit

Resultierender Startreiter

Kommentar

Empfänger

5

tom

-

Empfänger

 

Empfänger

5

url

-

Restdatenerfassung

 

Empfänger

5

nicht gesetzt

-

Empfänger

Defaultwert von j_first_tab_selector ist 'webTom wird verwendet'

nicht gesetzt

5

tom

-

Restdatenerfassung

 

nicht gesetzt

5

url

-

Restdatenerfassung

 

Partner

nicht gesetzt

tom

-

Partner

 

Partner

nicht gesetzt

url

-

Partner

 

nicht gesetzt

nicht gesetzt

url

-

Information zur Vorlage

Gleiches Verhalten wie zuvor, als im CIB webTom nichts gesetzt wurde. Entspricht dem Verhalten von j_first_tab_selector=tom

Partner

5

url

Volldatenversorgte Vorlage

Information zur Vorlage

Restdatenerfassung wird als erster Reiter verwendet - laut Spezifikation wird im Fall, dass der erste Reiter nicht existiert, Information zur Vorlage geöffnet.

 

Beschreibung der Werte für den URL-Parameter j_first_tab:

Wert für URL-Parameter j_first_tab

Bedeutung (Reiter)

0

Information zur Vorlage

1

Nächster sichtbarer Reiter nach "Information zur Vorlage"

2

Empfänger

3

Ansprechpartner

4

Unterzeichner

5

Restdatenerfassung

6

Dokumenterstellung

7

Datenversorgung Kleinserie

8

Datenversorgung Serienbrief

9

Partner


Anpassung der Oberfläche

j_hide_tree

TRUE: Der Vorlagenbaum wird in der Benutzeroberfläche von CIB webdesk ausgeblendet.

j_hideHeader

TRUE: Der Header wird in der Benutzeroberfläche von CIB webdesk ausgeblendet

j_hideTemplateSearch

TRUE: Die Vorlagensuche wird in der Benutzeroberfläche von CIB webdesk ausgeblendet

j_pagecontext

Zu ladende Seite (Standard: mainview); Startparameter Prefix: webdesk; Mögliche Werte:

  • documentView: Lädt die Webview Schale
  • webdialogStandalone: Lädt die Webdialog Schale

j_openplugin

Öffnen eines Hauptmenüpunkts; Default: Vorlagen; Mögliche Werte: stack, draft;


Einsprung in Entwurf, Workflow, Wiedervorlage

j_draft

Identifier eines Entwurfs. Wenn dieser Parameter spezifiziert wird, lädt CIB webdesk direkt beim Einstieg in die Applikation den jeweiligen Entwurf in das Datenerfassungsinterview.

j_docId

Einsprung in bestehendes Dokument mit dieser ID im Interview.

j_workflow_id

Einsprung in Workflow mit dieser WorkflowID

j_reminderid

Einsprung in Wiedervorlageprozess mit dieser WiedervorlageprozessId

j_datapoolid

ID des Datenpools für die Pooldatenversorgung.


Einsprung in CIB doXiview

j_documentview_action

Steuert die in den CIB doxiview injecteten Knöpfe zur Workflowsteuerung. Mögliche Werte:

  • directcommit (Normaler Vorgang; Dokument kann in Workflow gehen)
  • stackpreview (Einzeldokument oder Bündel Stack ANSICHT)
  • stackrework (Einzeldokument Stack BEARBEITEN)
  • stackworkflow (Einzeldokument Stack WORKFLOW OHNE FINALE FREIGABE)
  • stackcommit (Einzeldokument Stack WORKFLOW MIT FINALER FREIGABE)
  • bundlecommit (Bündel freigeben)
  • inWorkflowApproval (In Workflow keine Freigabe)
  • inWorkflowFinish (In Workflow mit finaler Freigabe oder Workflow Abschließen bei gebündelten Einzeldokumenten)

j_documentview_docId

DokumentID des in dem DocumentViewers anzuzeigenden Dokuments; Immer im Zusammenspiel mit j_pagecontext=documentView zu verwenden

j_documentview_editorname

Der in CIB webEdit zu verwendende Editor für RTF webRec (Siehe Dokumentation CIB webedit)

j_documentview_nosavebutton

Steuert die Sichtbarkeit der in den CIB doXiview injecteten Speichern-Schaltfläche

j_documentview_sidepanel

Anzeige des Freigabedialogs direkt beim Öffnen des DocumentViewers, Default: false

j_documentview_url

Übersteuert die URL die in CIB webdesk konfiguriert ist zum DocumentViewer CIB doXiview

j_documentview_direct_[NAME]

Diese Parameter werden als Parameter in CIB doXiview gesteckt. Dabei wird "j_documentview_direct_" vom Namen getrennt und der Parameter als [NAME] in den CIB doXiview weitergereicht

j_outputservice_name

Gibt den Namen des Outputserviceses an, unter dem in den Webdesk Einstellungen unter "outputservice." + nameFromOuter + ".implementationType" die Einstellungen des von Webprint zu verwendenden Outputservices abzufragen.


Aktivierung Techadmin Funktion

Diese Feature ist aus Sicherheits- und Datenschutzgründen deaktiviert!

Parameter

Beschreibung

techadmin

Mit "true" wird der Reiter für die technische Administration und im Interview ein "Entwicklung-Menü" angezeigt; Muss in der CIB webdesk Konfiguration erlaubt werden


7. Betrieb



7.1. Deployment des CIB webdesk

Da CIB webdesk die Konfiguration jeweils innerhalb des von CIB software GmbH bereitgestellten WAR Files mitbringt, muss bei dem Deployment auf die jeweilige Apache Tomcat die Konfiguration angepasst werden. Auch bei Nutzung des „Plugin Konzepts“ muss die von CIB Software GmbH gelieferte WAR Datei vom Kunden selbst angepasst werden.

Im Folgenden wird ein allgemeines, beispielhaftes Vorgehen des Deployments beschrieben. Je nach Umgebung bei Kunden kann das automatische Deployment angepasst sein oder auf andere Art und Weise von statten gehen.

Für das Deployment sind folgende Schritte notwendig:

  1. Lieferung einer WAR bzw. ZIP Datei durch CIB software GmbH
  2. Gegebenenfalls Anpassungen des Kunden-Deployment-Systems, der Konfiguration, der Kunden-Plugins oder der Umgebung. Die notwendigen Anpassungen werden im Normalfall durch CIB software GmbH in bei der Freigabe der CIB webdesk Version kommuniziert.
  3. Einstellung der CIB webdesk Version in das Kunden-Deployment-System
  4. Anpassung des WAR Files durch das Kunden-Deployment-System, beispielsweise:
    1. Auspacken der WAR Datei
    2. Anreicherung der kundenspezifischen Plugins durch kopieren der entsprechenden Konfigurationsdateien nach „/WEB-INF/plugins“ und der benötigten Libraries nach „/WEB-INF/lib“ (Siehe Kapitel „Das Plugin-Konzept von CIB webdesk“)
    3. Anpassung der webdesk.properties Datei falls das Plugin Konzept nicht genutzt wird
  5. Gegebenenfalls Undeployment der alten CIB webdesk Version, falls eine Version bereits im Einsatz ist
  6. Herunterfahren der jeweiligen Servlet Containers
  7. Aufspielen des CIB webdesk auf den Servlet Container
  8. Starten des Servlet Containers durch das entsprechende Skript

Undeployment und Deployment sind abhängig von der Umgebung des Kunden und des eingesetzten Servlet Containers. Beispielsweise je nach Einstellungen der Apache Tomcat muss CIB webdesk unterschiedlich in die Apache Tomcat deployed werden. Ist „Autodeployment“ konfiguriert, genügt es, die WAR Datei direkt in den webapps Ordner zu kopieren. Andernfalls kann auch direkt das entpackte WAR-File im Apache Tomcat eingespielt werden.

Hinweis zu Apache Tomcat: Es wird nicht empfohlen, das automatische Redeployment zur Laufzeit über den Tomcat-Manager zu verwenden, da dies zu einem inkonsistenten Zustand der CIB webdesk Instanz führen kann.


7.2. Monitoring des CIB webdesk

Ping

Beim Kunden-Deployment kann in den Hauptordner des CIB webdesk eine entsprechende HTML-Datei hinterlegt werden, die von der Überwachung periodisch aufgerufen werden kann. Damit kann die grundsätzliche Erreichbarkeit des CIB webdesk im erwarteten Kontext geprüft werden.


Log-Dateien

CIB webdesk nutzt „Log4j2“ (Siehe Kapitel Konfiguration Logging) zum Loggen von Nachrichten in Log-Dateien.

Folgende Dateien werden im Regelfall geschrieben:

  • webdesk-<Datum>.log
  • Logdateien des verwendeten Web-Containers entsprechend Konfiguration (z.B. catalina.out bei Tomcat als Standard-Logdatei unterhalb des Verzeichnis logs)

Mittels individueller Log4j2- Konfiguration können die Log-Dateien an die spezifischen Erfordernisse angepasst werden.

Die Log-Dateien können automatisiert ausgewertet werden. Siehe dazu Abschnitt „Beschreibung wichtiger Log-Einträge“.


7.3. Melden von Fehlern

CIB webdesk und die weiteren CIB Produkte benötigen einen Service- und Wartungsvertrag. Bei Fragen dazu steht support@cib.de zur Verfügung.

Potentielle Fehler können in den CIB helpdesk http://helpdesk.cib.de eingestellt werden. Sollte kein Benutzer zur Verfügung stehen, steht der CIB support per E-Mail support@cib.de oder Telefonisch (siehe www.cib.de ) zur Verfügung.

  • Folgende Informationen werden zur Bearbeitung des Fehlers benötigt:
  • Version des CIB webdesk
  • Versionen der Laufzeitumgebung des CIB webdesk
  • Namen der verwendeten Komponenten (Datenbank, Servlet Container etc.)
  • Beschreibung der Handlungsfolge
  • Zeitpunkt des Fehlers
  • Log-Dateien des CIB webdesk
  • Gegebenenfalls weitere Dateien und Informationen, um den Fehler nachstellen zu können wie RTF-Dateien.
  • Gegebenenfalls Screenshots des Fehlers wenn in der CIB webdesk Oberfläche. Wenn möglich, den gesamten sichtbaren Bereich auf dem Screenshot unterbringen.
  • Ansprechpartner auf Kundenseite, der für Rückfragen zur Verfügung steht


7.4. Beschreibung wichtiger Log-Einträge

Verschiedene Fehlersituationen finden sich in der Log-Datei als Java-Exceptions wieder.
Ein Eintrag entspricht dabei dem folgenden Muster:

ERROR … :Exception occured (oder andere Meldung)
ERROR … : vollqualifizierter Name der Exception
ERROR … : mehrzeiliger Stacktrace mit Methodennamen und Zeilennummern
ERROR … : Caused by: Gekapselte Exception
ERROR … : mehrzeiliger Stacktrace mit Methodennamen und Zeilennummern

Es folgt eine Beschreibung besonderer Exceptions nach denen die Logdatei durchsucht werden können um Probleme in der technischen Infrastruktur oder beim Zusammenspiel der einzelnen Komponenten automatisiert zu erkennen. Die Meldungen bei den gekapselten Exceptions geben typischerweise genaueren Hinweis auf die konkrete Ursache.

Exception

Erläuterung

de.cib.webdesk.exceptions.AuthenticationException

Anmeldung am System fehlgeschlagen. Dies kann mehrere Gründe haben. Beispielsweise Nutzer ist nicht vorhanden oder Passwort nicht korrekt.

de.cib.webdesk.exceptions.StorageConnectionException

Hinweis auf Datenbank-Fehler. Sowohl aufgrund von Nicht-Erreichbarkeit, Netzwerkproblemen usw. als auch Konfigurationsfehler, fehlende Tabellen oder ähnliches.
Typische Standard Java Exceptions im Cause:
java.net.ConnectException
java.sql.SQLException

de.cib.webdesk.exceptions.WebdeskIOException

Hinweis auf Probleme mit dem Dateisystem. Prüfen sie ob alle erforderlichen Verzeichnisse existieren, Berechtigungen korrekt gesetzt sind und genügend Speicher auf dem Datenträger frei ist.
Typische Standard Java Exceptions im Cause:
java.io.IOException
java.io.FileNotFoundException

de.cib.webdesk.exceptions.DocumentServerCallException

Hinweis auf Probleme im CIB documentServer oder bei der Kommunikation mit diesem.

java.lang.OutOfMemoryError

Die JVM hat nicht mehr genügend Hauptspeicher. Prüfen sie die Aufrufargumente und stellen Sie wenn möglich einen Heapdump bereit, so dass geprüft werden kann ob ein Speicherleck in der Software vorliegt.

de.cib.webdesk.exceptions.WebdeskSystemException

Sollte ebenfalls überwacht werden, da ein Auftreten auf Konfigurationsprobleme oder Fehler in der Software hinweisen kann.

de.cib.webdesk.exceptions.WrongExternalAccountException

Es wurde versucht sich mit einem Mandanten anzumelden der in der Persistenz nicht angelegt ist. Kann bei gehäuftem Auftreten ein Hinweis auf Fehlkonfiguration oder ein organisatorisches Problem / falsche Integration von CIB darktom sein.

de.cib.webdesk.exceptions.DataModelCorruptionException

Deutet auf einen schwerwiegenden Fehler im internen Datenmodell hin.

 

Nachfolgende eine Liste von Exceptions, die im Regelbetrieb in der Logdatei auftreten können – typischerweise aber kein technisches Problem indizieren:

Exception

Erläuterung

de.cib.webdesk.exceptions.DocumentGenerationException

Fachlicher Fehler in Vorlagen oder Datenversorgung

de.cib.webdesk.exceptions.CheckMaskViolationException

Ein generiertes Dokument entspricht nicht der Prüfschablonen

de.cib.webdesk.exceptions.FontListViolationException

Ein generiertes Dokument entspricht nicht der Schriftenliste

de.cib.webdesk.exceptions.VersionException

Für eine Vorlage oder Paket konnte keine gültige Version ausgewählt werden

 

Andere Exceptions in den Logs deuten auf Fehler in der Fachlichkeit hin und müssen bei Auftreten durch CIB geprüft werden.


7.5. Temporäre Dateien und Bereinigung des Dateisystems

CIB webdesk verwendet Dateien bei unterschiedlichen Funktionen. Diese Dateien werden teils von automatisierten Lösch-Jobs periodisch entfernt, teils muss die betreibende Instanz selbst für die Bereinigung der entsprechenden Daten sorgen, da die Entscheidung, welche Daten wann gelöscht werden können nicht von der CIB als Produktanbieter, sondern nur vom Kunden als Integrator getroffen werden kann.

Folgende Daten werden automatisch bereinigt (per Konfiguration einzeln deaktivierbar):

  • Jobs-Verzeichnis: Die für die Dokumenterzeugung benötigten Artefakte werden von CIB webdesk in dynamisch erzeugten Unterverzeichnissen des Jobs-Verzeichnisses abgelegt, welches durch den Konfigurationsparameter webdesk.jobPath bestimmt wird. Pro Dokumenterzeugungsauftrag wird hierbei ein Verzeichnis angelegt, in dem dann unter anderem die Eingabedateien für die Dokumenterzeugung, aber auch Zwischen- und Endergebnis abgelegt werden.
    Die Konfigurationsparameter webdesk.cleanJobs bzw. darkdesk.cleanJobs können genutzt werden, um festzulegen, nach welchem Zeitraum ein Job-Verzeichnis gelöscht werden soll.
    Hierbei ist zu beachten, dass CIB webdesk in keinem Fall das Job-Verzeichnis eines noch in Bearbeitung befindlichen Jobs löscht.
  • Die Konfigurationsparameter webdesk.cleanJobs bzw. darkdesk.cleanJobs können genutzt werden, um festzulegen, nach welchem Zeitraum ein Job-Verzeichnis gelöscht werden soll.
    Hierbei ist zu beachten, dass CIB webdesk in keinem Fall das Job-Verzeichnis eines noch in Bearbeitung befindlichen Jobs löscht.

  • jview Temp: CIB webdesk lädt CIB jView Dateien für die Verarbeitung nicht vollständig in den Hauptspeicher. Stattdessen werden diese Dateien in einem temporären Verzeichnis im Dateisystem des Servers abgelegt und dann gepuffert verarbeitet um die Hauptspeicherlast so gering wie möglich zu halten. Der Konfigurationsparameter webdesk.cleanJobs wird auch herangezogen, um zu bestimmen, wann die Dateien im jView Temp Verzeichnis gelöscht werden.
  • Sequence Tracking Daten: Im Transaction Cache Verzeichnis sammelt CIB webdesk zu Supportzwecken die Daten, die im Rahmen einer Dokumenterzeugungssequenz entstehen. Eine solche Sequenz beginnt mit der Erfassung der Daten und endet mit der Generierung des Ergebnisdokuments. Da es sich bei diesen Daten um Support-Daten handelt, ist es nicht sinnvoll, diese Daten länger aufzuheben als zu Supportzwecken nötig ist. Aus diesem Grund werden auch die Sequence Tracking Daten periodisch automatisch gelöscht. Das maximale Dateialter wird hierbei über den Konfigurationsparameter webdesk.transactionTracking.autoClean.fileAge festgelegt.
  • Content Cache: CIB webdesk verfügt über einen Dateisystem-basierten Cache Mechanismus, der große Objekte zur Schonung des Hauptspeichers im lokalen Dateisystem des Servers vorhält. Das Verzeichnis, in dem diese Cache-Komponente die von ihr benötigten Dateien ablegt, wird jeweils beim Hochfahren von CIB webdesk automatisiert geleert.

Ferner gibt es eine Reihe von Verzeichnissen, deren Inhalt nach Ermessen des Betriebs regelmäßig gelöscht werden sollten. Es handelt sich dabei um die folgenden Verzeichnisse:

  • Support Repository: Die im Support Repository im Fehlerfall abgelegten Dateien sollten gelöscht werden, wenn sie nicht mehr benötigt werden.
  • Repository-Verzeichnis: Kommt die Dokumentfreigabe-Komponente von CIB webdesk zum Einsatz, so sollten die im Repository-Verzeichnis abgelegten Dateien nach erfolgreicher Nachverarbeitung gelöscht werden.
  • wbd_shared: Die Dateien, die beim Upload von Eingabedateien über die Web-Oberfläche von CIB webdesk im wbd_shared-Verzeichnis abgelegt werden, sollten regelmäßig gelöscht werden.
  • Package-Verzeichnis: Im Package-Verzeichnis legt CIB webdesk den Inhalt der Pakete ab, aus denen sich eine Dokumentvorlage zusammensetzt. Da Änderungen an den Paketen (bzw. den darin enthaltenen Bausteinen) alte Paketversionen obsolet machen können, empfiehlt es sich, dieses Verzeichnis regelmäßig zu leeren.
  • Webdialog Repositories: In diesem Verzeichnis werden die Artefakte abgelegt, die von CIB webdialog benötigt werden. Auch sie werden möglicherweise obsolet, wenn eine Dokumentvorlage oder ihre Pakete bearbeitet werden. Aus diesem Grund sollte auch dieses Verzeichnis regelmäßig geleert werden.


7.6. Bereinigung der Dokumentablage

Da die Dokumentablage über die Zeit eine beachtliche Größe erreichen kann (sofern sie denn benutzt wird) und auch nicht unbedingt als Langzeitarchiv gedacht ist die Verwendung von periodischen Löschläufen sinnvoll. Hierbei werden Dokumente die ein gewisses Alter erreicht haben endgültig gelöscht – geschützt sind nur solche auf die eine Wiedervorlage besteht, da diese nicht mehr richtig funktionieren würde wenn das Ursprungsdokument fehlt.

Die restlichen Dokumente werden in 3 Kategorien unterschieden für die das Löschalter separat konfiguriert werden kann. Die zugehörigen Properties dafür lauten

filing.ageLimitCommittedDocuments=1
filing.ageLimitUncommitedDocuments=1
stack.maxAgeUntilErased=0
und geben das Alter in Tagen für freigegebene, nicht freigegebene und Stapeldokumente (unabhängig vom Status) an. 0 bedeutet, dass diese Dokumente nie automatisch gelöscht werden sollen was z.B. für den Stapel gewünscht sein kann.

Es gibt 2 Varianten des Löschlaufes die im Folgenden beschrieben werden.


Löschlauf als Serverkomponente

In der webdesk-Webapplikation läuft ein eigener Thread der die genannten Löschkommandos periodisch durchführt. Zusätzlich zu den oben genannten Properties kann das Intervall über

filing.cleaningPeriod
sekundengenau eingestellt werden – beim Wert 0 werden die Löschläufe komplett deaktiviert. Pro Lauf und Kategorie werden bis zu 100 alte Dokumente auf einmal entfernt. Eventuell verknüpfte Stapeleinträge werden mit entfernt und Bündel die durch die Aktion leer werden würden ebenfalls gelöscht.

Löschlauf als unabhängiges Programm

Es steht auch eine eigene Java-Bibliothek zur Verfügung über die die Löschläufe explizit angestoßen werden können. Eine Konfiguration des Intervalls gibt es hier nicht, es wird genau ein Durchlauf ausgeführt, die Steuerung obliegt dem Aufrufer. Die Integration kann Java seitig über die Klasse

FilingCleaner
erfolgen oder als Kommandozeilenaufruf:
java -jar filing_cleaner.jar
Die Konfiguration erfolgt über die Datei config.properties auf der obersten Ebene des JAR-Archivs. Hier kann in
filing.maxResultsPerCleaningTask=5
zusätzlich die maximale Anzahl der zu löschenden Dokumente pro Lauf und Kategorie festgelegt werden.