Print bookPrint book

CIB webTom technischer Leitfaden

Site: CIB eLearning
Course: CIB webTom
Book: CIB webTom technischer Leitfaden
Printed by: Guest user
Date: Wednesday, 1 May 2024, 4:35 AM

Description


Table of contents

1. Einzelschritte zur Installation und Konfiguration

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

  1. Alle Punkte im Leitfaden CIB webdesk im Kapitel Installation
    • Ergebnis ist ein lauffähiger CIB webdesk (Optional: inkl. Benutzeroberfläche)
    • CIB webdesk enthält die Webservice Schnittstellen für darkdesk (u.a. Dokumentgenerierung) und darktom (Vorlagenverwaltung)
  2. Konfiguration CIB webTom
  3. (Optional) Konfiguration und Deployment von CIB webEdit und CIB webRec (Bausteinbearbeitung im Web)
  4. Deployment CIB webTom

2. Konfiguration CIB webTom

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


3. Funktionsweise der Konfiguration

CIB webTom wird mit Hilfe einer beim Start der Webapplikation eingelesenen Properties-Dateien konfiguriert, welche im ausgelieferten WAR-Archiv (Im Verzeichnis „WEB-INF\classes\“) enthalten ist.

  • application.properties
  • clientRights.properties – Autorisierung (Welcher User hat Zugriff auf welchen Mandanten?)
  • log4j2.xml – Logging

Die Konfigurationsdateien können auch unter „CATALINA_HOME/shared/classes“ abgelegt werden. Konkret können clientRights.properties, log4j2.xml und webtom.properties (überlagert application.properties in dem WAR-Archiv) in diesem Verzeichnis abgelegt werden.

Des Weiteren ist folgende Konfigurationsdatei im WAR-Archiv enthalten, die vor dem Deployment manuell oder per Skript angepasst werden müssen:

  • config.json – Benutzeroberfläche


4. Konfigurationsparameter

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

Allgemeine Parameter
 CIB documentServer
 Authentifizierung (LDAP und Token)
 Platzhalter & Pfade
Allgemeine Parameter

Parametername

Erläuterung

darktom.url

URL über welche der CIB webTom auf den CIB webdesk Webservices bzw. darktom zugreift.

Beispiel: „http://localhost:8080/webdesk/webservices/“

darktom.callingSystem

Autorisierung gegenüber CIB webdesk. Dieser Wert muss mit dem im CIB webdesk hinterlegten Parameter „webdesk.leanAuthCallingSystem“ übereinstimmen.

Default: „webtom“

webtom.centralClient

Mandantennummer des zentralen Mandanten.

Beispiel: "0000"


CIB documentServer

documentServer.host

Beispiel: „localhost“

documentServer.port

Beispiel: „8080“


Authentifizierung (LDAP und Token)

Parametername

Erläuterung

ldap.url

Beispiel: ldap://ldap.company.de

ldap.user

Benutzer, mit der Berechtigung, die anderen Benutzer zu sehen. Angabe mit „full DN“

Beispiel: CN=auth_webtom,CN=Users,DC=example,DC=de

ldap.password

Passwort des angegebenen Benutzers.

ldap.folder

Ordner, ab dem rekursiv nach den Benutzern gesucht wird

Beispiel: OU=Anwender,DC=example,DC=de

ldap.userNameAttribute

Attribut, in dem der Name gespeichert ist, der beim Login angegeben wird

Beispiel: samAccountName

ldap.groupAttribute

Attribut, in dem die zugehörigen Gruppen eines Benutzers gespeichert sind (siehe auch Konfiguration Autorisierung)

Beispiel: memberOf

ldap.modifiedDateFormat

Beispiel: yyyyMMddHHmmss.SX (java.text.SimpleDateFormat)

authentication.jwtSecret

Schlüssel zum Verschlüsseln der Tokens. Base64 Format und empfohlene Länge eines sicheren Passworts.

authentication.tokenValidMinutes

Anzahl an Minuten für diese das Token gültig ist.

Default: 60

authentication.tokenProlongMinutes

Anzahl an Minuten seit Erstellung des Tokens in denen ein abgelaufenes Token verlängert werden kann, wenn der Benutzer sich in dieser Zeit nicht verändert hat.

Default: 1440

Platzhalter & Pfade

Parametername

Erläuterung

superFolder

Basisverzeichnis für alle Arbeitsverzeichnisse.

Beispiel: „/var/webtom“

tempFileStore.cacheFolder

Verzeichnis für nicht temporäre Dateien, die während des Betriebs von CIB webTom erzeugt werden. Bei Clusterbetrieb muss dieses Verzeichnis von allen zugreifbar sein.

Default: „${superFolder}/tmp“

tempFileStore.cleanupMinutes

Dateien, die älter sind, als die angegebene Anzahl an Minuten, werden gelöscht.

Default: 60

generation.cacheFolder

Ergebnisse der Vorlagenanalyse.

Default: „${superFolder}/generation“

preview.cacheFolder

Vorschau Bilder für Vorlagen.

Default: „${superFolder}/preview“

packageDeploy.cacheFolder

Bausteine für die Dokumentgenerierung.

Default: „${superFolder}/packagedeploy“

packageDeploy.cleanupMinutes

Dateien, die älter sind, als die angegebene Anzahl an Minuten, werden gelöscht.

Default: 1440

5. Konfiguration Logging

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

Die Konfiguration der zu schreibenden Log-Dateien muss durch den Kunden in dieser Datei angepasst werden. Es wird empfohlen, bei dem Kunden-Deployment ggf. die Log4j2 Konfigurationsdatei zu ersetzen.

Auf Wunsch des Kunden kann bei der Lieferung des CIB webTom die log4j2 Konfiguration auch weggelassen werden.

Im Folgenden ein Beispiel der Log4j Konfiguration des CIB webTom. Gelb Markiert sind Einträge, die durch den Kunden passend ersetzt werden müssen.

<?xml version="1.0" encoding="UTF-8"?>
<Configuration status="WARN">   
 <Properties>
        <Property name="format">%5p %d{dd.MM.yy HH:mm:ss} [%t] [%c{1}:%L] %m%n</Property>
    </Properties>
    <Appenders>
              <File name="file" fileName="/home/techadmin/webtom.log">
                    <PatternLayout>
                <Pattern>${format}</Pattern>
            </PatternLayout>
       </File>
        <Console name="Console" target="SYSTEM_OUT">
            <PatternLayout pattern="${format}" />
        </Console>
    </Appenders>
    <Loggers>
        <Root level="info">
            <AppenderRef ref="Console" />
            <AppenderRef ref="file" />
        </Root>
        <Logger name="de.cib.webtom" level="debug" additivity="false">
            <AppenderRef ref="Console" />
            <AppenderRef ref="file" />
        </Logger>
    </Loggers>

6. Konfiguration Benutzeroberfläche

CIB webTom bietet die Möglichkeit verschiedene Eigenschaften in der Benutzeroberfläche zu konfigurieren. Dies sind insbesondere für die Werte von Auswahlfeldern (ComboBox) in CIB webTom Vorlageneigenschaften relevant. Beispielhaft können hier Archiv- bzw. Ablageschlüssel, Kontakteintragsthemen und weitere kundenspezifische Werte administriert werden. Umgebungsparameter und CIB-webDesk Attribute sind farblich gekennzeichnet.

Parametername

Erläuterung

supportedLanguages

Unterstützte Sprachen

Beispiel: [„de“, „en“]

allowedChars

Erlaubte Zeichen in Benennungen

Beispiel: a-zA-z0-9._-

webeditUrl

Beispiel: /webedit/index

changeCommentRequired

Kommentare beim Import erforderlich

Default: true

disableEditBricks

Online-Editieren verbieten

Default: false

disableTemplateTree

Vorlagenbaum sperren

Default: false

repositoryKeys

Ablageschlüssel

Beispiel: { "1010": "08000, Kunde, Verträge, KUAKTE, 6, Kundenstammdaten" }

branchOfficeSource

Ansprechpartnerdaten

Beispiel: { „value“: „0“, „text“: „Filialdaten am Kunden“ }

archiveStates

Archivierungsstatus

Beispiel: { „value“: „10“, „text“: „Aktiv“ }

letterTypes

Brieftyp

Beispiel: { „value“: „1“, „text“: „Brief Standard“ }

envelopeTypes

Umschlagstyp

Beispiel: { „value“: „1“, „text“: „C6 oder C4, 0.27“ }

draftProperties

Eigenschaften Sichtbarkeit

Beispiel: { „value“: „2“, „text“: „verbieten“ }

firstTab

Erster Reiter

Beispiel: { „value“: „0“, „text“: „Partner“ }

paperWeight

Papier

Beispiel: { „value“: „1“, „text“: „80g, 5.0, 0.08“ }

contactSubjects

Thema Kontakteintrag

Beispiel: { „value“: „0“, „text“: „Thema“ }

shippingTypes

Versandform

Beispiel: { „value“: „0“, „text“: „Einschreiben“ }

shippingNotes

Versandvermerk

Beispiel: { „value“: „0“, „text“: „Vertraulich“ }

forwardRules

Vorausverfügung

Beispiel: { „value“: „0“, „text“: „Nicht nachsenden“ }

shippingData

Vorbelegter Ansprechpartner

Beispiel: { „value“: „0“, „text“: „Sachbearbeiter“ }

systemReleases

Releasefilter

Beispiel: [ 0, 1, 2 ]

7. Konfiguration Authorisierung

Die Konfigurationsdatei „clientRights.properties“ definiert, welcher Benutzer auf welchen Mandanten Zugriff erhält. Der Aufbau dieser Properties-Datei sieht wie folgt aus:

all=Tester&&Tester2
<Mandant>=<UserDN> oder <Group> mit „&&“ getrennt
0000=cn=admin,dc=ldap,dc=example,dc=internal


8. Deployment des CIB webTom

Da CIB webTom die Konfiguration jeweils innerhalb des von CIB software GmbH bereitgestellten WAR Files mitbringt, muss bei dem Deployment auf die jeweiligen Application-Server die Konfiguration 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 oder der Umgebung. Die notwendigen Anpassungen werden im Normalfall durch CIB software GmbH in bei der Freigabe der CIB webTom Version kommuniziert.
  3. Einstellung der CIB webTom Version in das Kunden-Deployment-System
  4. Anpassung des WAR Files durch das Kunden-Deployment-System, beispielsweise:
    • Auspacken der WAR Datei
    • Anpassung der Konfigurationsdateien
  5. Gegebenenfalls Undeployment der alten CIB webTom Version, falls eine Version bereits im Einsatz ist
  6. Herunterfahren der jeweiligen Servlet Container
  7. Aufspielen des CIB webTom 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 webTom 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.


9. Anlegen des zentralen Mandanten

  1. Anmelden in der Web-Oberfläche am zentralen Mandanten (webtom.centralClient siehe Allgemeine Parameter) und einem Benutzer der in der clientRights.properties-Datei eingetragen und für diesen Mandanten berechtigt wurde.
  2. Es folgt eine Fehlermeldung, da dieser Mandant noch nicht existiert, weil wir ihn noch anlegen müssen
  3. Klicken auf „Mandantenadministration“ im linken Navigationsbaum
  4. Mit der Oberfläche über „Neuer Mandant“ den zentralen Mandanten anlegen


10. Monitoring des CIB webTom

Ping

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


Log-Dateien

CIB webTom nutzt „Log4j2“ zum Loggen von Nachrichten in Log-Dateien.

Folgende Dateien werden im Regelfall geschrieben:

  • webtom.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.


11. Melden von Fehlern

CIB webTom 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 webTom
  • Versionen der Laufzeitumgebung des CIB webTom
  • Namen der verwendeten Komponenten (Datenbank, Servlet Container etc.)
  • Beschreibung der Handlungsfolge
  • Zeitpunkt des Fehlers
  • Log-Dateien des CIB webTom
  • Gegebenenfalls weitere Dateien und Informationen, um den Fehler nachstellen zu können wie Vorlagen-Dateien.
  • Gegebenenfalls Screenshots des Fehlers wenn in der CIB webTom Benutzeroberfläche. Wenn möglich, den gesamten sichtbaren Bereich auf dem Screenshot unterbringen.
  • Ansprechpartner auf Kundenseite, der für Rückfragen zur Verfügung steht