CIB workbench Anwenderhandbuch

Site: CIB eLearning
Course: CIB workbench
Book: CIB workbench Anwenderhandbuch
Printed by: Guest user
Date: Tuesday, 22 April 2025, 11:56 AM

Table of contents

1. Lieferumfang

Komponente

Softwareumfang

CIB workbench

CIBworkbench_Engine.dotm - Add-In für Microsoft® Word und Office Versionen – Befehlsstruktur, Microsoft® Word 2010, 2013 und 2016

CIB workbench Connector

CibWorkbenchConnector.exe

Enthaltene CIB office Module

CIB dialog Browser

cibdialg.dll

cibhtml.dll

cibgui32.dll

CIB format/output

cibprt32.dll

CIB job

cibjob32.dll

CIB merge

cibmrg32.dll

CIB view

cibvw32.dll

CIB pdf toolbox

cibpdf32.dll

 


2. Einführung

Die CIB workbench ist ein Add-In für Microsoft® Word zur Unterstützung bei der Entwicklung dynamischer Dokumentenprojekte. Sie dient bevorzugt als Werkzeug für Textorganisatoren. Die CIB workbench kann auf mehrere Arten effektiv eingesetzt werden. Hier einige Vorschläge/Möglichkeiten: CIB workbench

  • Interaktive Unterstützung beim Einfügen von Feldanweisungen in einen Textbaustein.
  • Modellierung von Textbausteinen über verschiedene Verzeichnisstrukturen.
  • Daneben ist eine komplette Test- und Analysenumgebung für die CIB office Module enthalten.
  • Je nach Edition Import von Dateninformationen für die Erstellung eines Dokumentprojektes
  • Je nach Edition Import/Export von Dokumentprojekten zur weiteren Verarbeitung z.B. in eine Dokument-Management Systemumgebung
  • Syntaktische Prüfung von Dokumentprojekten
  • Optimierung der gespeicherten Dateigrößen ganzer Ablageverzeichnisse
  • Erzeugung von Reports eines Dokumentprojektes

Die CIB workbench ermöglicht die komplette Dokumentprojekterstellung außerhalb der späteren Anwendung. Eine sinnvolle Vorbereitung im Arbeitsablauf ist dafür lediglich ein ausreichender Testdatenbestand für das geplante Dokumentenprojekt.


2.1. Freigabe-Informationen

Bei der CIB workbench handelt es sich um eine 32bit-Anwendung, die zusammen mit einem 32bit-MS Office verwendet werden kann. Der Einsatz einer 32bit CIB workbench mit MS Office 32bit auf einem 64bit Windows System ist jedoch problemlos möglich.

Die CIB workbench ist derzeit für die MS Word Versionen 2010, 2013, 2016 und 2019 freigegeben.

Die CIB workbench ist derzeit für WIN7, WIN8 und WIN10 (ab Version 2.9.201) freigegeben.


2.2. Unterschiedliche Editionen

Allgeein
CIB workbench XPS – paketierte Verzeichnisstruktur
CIB workbench XSS – Standard Verzeichnisstruktur

Allgemein

Die CIB workbench wird in unterschiedlichen Editionen ausgeliefert. Die Entscheidung, welcher Edition der Vorzug zu geben ist, hängt von der fachlichen Ablagestruktur der Vorlagen auf dem Client PC des Kunden ab. 

Wir unterscheiden in:

  • CIB workbench XPS – paketierte Verzeichnisstruktur
  • CIB workbench XSS – standard Verzeichnisstruktur

Die Edition ist in der CIB workbench Installation fest vorgegeben und kann vom Kunden nicht selbst geändert werden.

Abgesehen von der Ablagestruktur sowie Import- und Exportfunktionen ist der Funktionsumfang der vier Editionen soweit möglich identisch. Editionsspezifische Merkmale sind an den jeweiligen Stellen in diesem Handbuch beschrieben.


CIB workbench XPS – paketierte Verzeichnisstruktur

Kunden, die die CIB workbench im Zusammenspiel mit dem Korrespondenzsystem (CIB coSys) aus dem Hause CIB einsetzen, nutzen für Ihre gesamten Vorlagen, Textbausteine, Masken, Regelwerke eine paketierte Verzeichnisstruktur.

CIB workbench XPS – Konfiguration Arbeitsverzeichnis


In diesem Fall gibt das konfigurierte Arbeitsverzeichnis den Knoten für ein darunter automatisch verzweigtes System von weiteren Unterverzeichnissen vor.

CIB workbench XPS – Übersicht Arbeitsverzeichnis


CIB workbench XSS – Standard Verzeichnisstruktur

Die „Standardausführung“ XSS erlaubt beliebige Verzeichnisstrukturen und wird insbesondere in Projekten verwendet, deren Ablagestruktur von den anderen CIB workbench Editionen abweicht.

Die Anzahl der verwendeten Verzeichnisse sowie die Reihenfolge bei der Dokumentgenerierung sind frei konfigurierbar.

CIB workbench XSS – Beispiel für Arbeitsverzeichnisse


CIB workbench XSS – Übersicht Konfiguration Arbeitsverzeichnis


CIB workbench XSS – Detailkonfiguration der Arbeitsverzeichnisse


2.3. Weiterentwicklung

Die CIB workbench ist aus der Praxis der Vorlagenerstellung mit Hilfe von Standardtextsysteme entstanden. Sie wird im Hause CIB ständig weiterentwickelt. Falls Sie zu dem Produkt Anregungen haben, kontaktieren Sie uns bitte gerne:

  • Wir nehmen neue Anforderungen gerne und auch kurzfristig in unsere Planung auf.
  • Wir erweitern auch kundenspezifische zusätzliche „AddOns“ an das Grundmodul.


3. Installation

Die CIB workbench wird in Form eines dialoggesteuerten Setup ausgeliefert. Der Name des Setupprogrammes setzt sich zusammen aus dem Produktnamen und der Edition, die Sie einsetzen:

CIBworkbench<Edition>.exe

Das Setupprogramm ist durch geeignete Aufrufparameter auch vollständig im Hintergrund ablauffähig. Die jeweils aktuelle Setupversion können Sie sich am besten über den CIB Support als Download bereitstellen lassen.

Zusätzlich nutzen Großkunden oft einen speziell bereitgestellten Setup für deren hausinterne Softwareverteilungsverfahren.


3.1. Voraussetzungen für die Installation der CIB workbench

Um eine korrekte Installation und ein Arbeiten mit der CIB workbench zu ermöglichen, müssen auf dem Arbeitsplatzrechner gewisse Grundvoraussetzungen erfüllt sein.

Zertifikat und Makroschutz
Benötigte Module
MS Office 2010 (32bit)
MS Office 2013 (32bit)

Zertifikat und Makroschutz

Die CIB workbench wird mit einem gültigen Zertifikat ausgeliefert. Dieses Zertifikat muss auf dem Anwendersystem als vertrauenswürdig eingestuft sein. Dies lässt sich in den Wordoptionen, Vertrauensstellungscenter, Einstellungen für das Vertrauensstellungscenter überprüfen.

Vertrauenswürdige Speicherorte: Hier müssen aufgeführt sein

  • das Installationsverzeichnis der CIB workbench, damit das CIB workbench Addin und die übrigen CIB Module geladen werden können
  • das Autostart-Verzeichnis, damit es möglich ist die CIB workbench, bei entsprechender Einstellung automatisch mit MS Word zu starten (CIB workbench Konfiguration: „CIB workbench automatisch mit Word starten).

Vertrauenswürdige Herausgeber: Hier muss die CIB software GmbH aufgeführt sein.

Diese Einstellung wird durch MS Office durchgeführt, wenn dies beim ersten Laden des CIB workbench-Addins durch MS Word über die Sicherheitsoptionen entsprechend veranlasst wird.

MS Word – Einstellen der Sicherheitsoptionen


Es muss „Allen Dokumenten von diesem Herausgeber vertrauen“ angeklickt werden.
(Siehe auch Kapitel MS Office 2010)

Des Weiteren muss eine Makro-Ausführung erlaubt sein, d.h. es sind folgende Einstellungen vorzunehmen:

  • Einstellungen für Makros müssen mindestens auf: "Alle Makros außer digital signierten Makros deaktivieren"
  • Entwicklermakroeinstellungen: "Zugriff auf das VBA-Projektobjektmodell vertrauen" sollte aktiviert sein
  • Addins: „Anwendungs-Add-ins müssen von einem vertrauenswürdigen Herausgeber signiert sein“
  • ActiveX-Steuerelemente müssen aktiviert sein


Benötigte Module

Für den Ablauf der CIB workbench wird vorausgesetzt, dass eine Reihe Microsoft-Standardmodule auf dem Anwendersystem installiert sind.

Hierbei handelt es sich im Detail:

Verweis: Visual Basic For Applications (hier für MS Word 2013)
Datei(en): VBE7.DLL
Win 7 - C:\Program Files (x86)\Common Files\microsoft shared\VBA\VBA7.1
Win 10 - C:\Program Files (x86)\Common Files\microsoft shared\VBA\VBA7.1

Verweis: Microsoft Word 15.0 Object Library
Datei(en): MSWORD.OLB
Win7 - C:\Program Files (x86)\Microsoft Office\Office15
Win10 - C:\Program Files (x86)\Microsoft Office\Office15

Verweis: Microsoft Forms 2.0 Object Library
Datei(en): FM20.DLL, FM20DEU.DLL (bzw. entsprechende Sprache)
Win7 - C:\Windows\SysWOW64
Win10  - C:\Windows\SysWOW64

Verweis: Microsoft Office 15.0 Object Library
Datei(en): MSO.DLL, MSORES.DLL
Win7 - C:\Program Files (x86)\Common Files\microsoft shared\OFFICE15
Win10  - C:\Program Files (x86)\Common Files\microsoft shared\OFFICE15

Verweis: Microsoft Scripting Runtime
Datei(en): scrrun.DLL
Win7 - C:\Windows\SysWOW64
Win10  - C:\Windows\SysWOW64

Verweis: OLE Automation
Win7 Datei(en): STDOLE32.TLB
      - C:\Windows\SysWOW64
Win10 Datei(en): STDOLE2.TLB
        - C:\Windows\SysWOW64

Verweis: VSFlex Grid 8.0
Datei(en): vsflex8l.ocx
(installiert mit der CIB workbench)

Verweis: 7-zip Interfaces Typelib 1.0
Datei(en): 7z.dll, SevenZip.tlb
(installiert mit der CIB workbench)

Bis CIB workbench Version 2.8.200:
Verweis: Microsoft XML 4.0
Datei(en): msxml4.dll
Win7 - C:\Windows\SysWOW64

Ab CIB workbench Version 2.9.201:
Verweis: Microsoft XML 6.0
Datei(en): msxml6.dll
Win7 - C:\Windows\SysWOW64
Win10 - C:\Windows\SysWOW64?????

Die folgenden Module werden ab CIB workbench Version 2.8.194 nicht mehr benötigt:

Verweis: Microsoft Visual Basic for Applications Extensibility 5.3
Datei(en): VBE6EXT.OLB
Win7 - C:\Program Files (x86)\Common Files\microsoft shared\VBA\VBA6
Für MS Word 2010 gilt entsprechend VBA7

Verweis: Windows Scripting Host Object Model
Datei(en): wshom.ocx
Win7 - C:\Windows\SysWOW64

Verweis: Microsoft Windows Common Controls 6.0
Datei(en): MSCOMCTL.OCX
Win7 - C:\Windows\SysWOW64

Verweis: Microsoft ActiveX Data Objects 2.5
Datei(en): msado25.tlb
Win7 - C:\Program Files (x86)\Common Files\System\ado

Verweis: Microsoft Scripting Runtime
Datei(en): scrrun.dll
Win7 - C:\Windows\SysWOW64


MS Office 2010 (32bit)

Im Falle, dass beim Starten von MS Word 2010 bzw. beim Laden des CIB workbench Addins die Makro-Sicherheitswarnung erscheint, ist folgendermaßen vorzugehen:

  • Klick auf „Makros wurden deaktiviert“
  • Im Kasten „Sicherheitswarnung“:  „Inhalt aktivieren“ aufklappen
  • Anklicken „Erweiterte Optionen“
  • Jetzt „Allen Dokumenten von diesem Herausgeber vertrauen“ auswählen.

Damit erfolgt auch der Eintrag der CIB software GmbH in die Liste der vertrauenswürdigen Herausgeber.

In MS Office 2010 gibt es im Sicherheitscenter die Möglichkeit, den Datenausführungs­verhinderungsmodus zu aktivieren.

MS Word 2010 – Deaktivieren des Datenausführungsverhinderungsmodus

Bis Version 2.8.194 der CIB workbench muss der Datenausführungsverhinderungsmodus deaktiviert werden.

Die Entwicklermakroeinstellungen "Zugriff auf das VBA-Projektobjektmodell vertrauen" müssen aktiviert sein.


MS Office 2013 (32bit)

In MS Word 2013 ist der Datenausführungsverhinderungsmodus permanent aktiviert, es besteht keine Möglichkeit diesen Modus über die MS Word Optionen abzuschalten.

Bis Version 2.8.194 ist in dieser Konfiguration das Benutzen der CIB workbench nicht möglich.

Es ist erforderlich, den Datenausführungsverhinderungsmodus auf Systemebene komplett zu deaktivieren. Dazu ist folgendermaßen vorzugehen:

  • Es sind Admin-Rechte erforderlich
  • Öffnen der Kommando-Zeile
  • Eingeben von: bcdedit.exe /set nx AlwaysOff
  • Den PC neu starten
  • Die CIB workbench kann jetzt geladen werden


3.2. Installation in einer Kundenumgebung

Die CIB workbench ist nur auf dem Arbeitsplatz erforderlich, an dem künftig der Textorganisator Musterbriefe,- texte und -anschreiben entwirft.

Im Folgenden ist die Installation für Microsoft® Word 2013 beschrieben. Für andere Versionen ist die Installation ähnlich. MS Word2007 wird ab Version 2.8.197 der CIB workbench nicht mehr unterstützt.

Die Installation der Anwendung erfolgt über die Softwareverteilung. Sie legt auf dem Laufwerk C:\Programme (x86) das Verzeichnis "CIB software GmbH\CIB workbench" an.
Nach der Installation erfolgt die weitere Einrichtung der CIB workbench in Microsoft® Word.

Da Sie am Ende der Einrichtung nach einem Arbeitsverzeichnis gefragt werden, in welchem die erstellten Vorlagen gespeichert werden, ist es sinnvoll dies schon vorab anzulegen. Sie können hierzu ein beliebiges Laufwerk verwenden. z.B. C:\Workbench.

Über die Office-Schaltfläche und das Bedienfeld "Word-Optionen"

MS Word 2013 – Wechsel zu den Optionen


erreichen Sie folgendes Fenster:

MS Word – Aktivieren der Entwicklerregisterkarte


Hier ist die Option "Entwicklerregisterkarte... " zu aktivieren.
Über den Menüpunkt "Entwicklertools" - "Dokumentenvorlage" fügen Sie die CIB workbench zur vorhandenen Menüleiste hinzu.

MS Word – manuelle Aktivierung der CIB workbench


Sollte Ihnen die CIB workbench nicht direkt angezeigt werden, verzweigen Sie über das Bedienfeld "Hinzufügen" in den Windows-Explorer und wählen die Datei "CIBworkbench_Engine.dotm" im Verzeichnis "C:\Programme (x86)\CIB software GmbH\CIB workbench\AddIn" aus."

Sie werden aufgefordert, ein Arbeitsverzeichnis anzulegen, in welchem Ihre erstellten Vorlagen abgelegt werden. Dieses Arbeitsverzeichnis sollte sinnvollerweise vorher bereits angelegt sein, z.B. D:\Test.

CIB workbench Konfiguration des Arbeitsverzeichnisses


Nach erfolgter Installation und Einrichtung in Microsoft® Word sieht Ihre Menüleiste wie folgt aus:

Menüleiste CIB workbench XPS in MS Word


Hiermit ist die Installation und Einrichtung in Microsoft® Word abgeschlossen.


3.3. Manuelle Installation

Allgemein
Option: MSXML nicht installieren
Korrektur zu „Format übertragen“ nicht installieren

Allgemein

Zur Durchführung der Installation sind Administratorrechte erforderlich, zur späteren Benutzung der CIB workbench sind Benutzerrechte ausreichend.

Starten Sie zunächst das Setupprogramm in Ihrer Windowsumgebung:

Start des CIB workbench Setups



Aktionsauswahlmaske


Es erscheint eine erste Auswahlmaske, die Sie zur Wahl der gewünschten Komponenten auffordert:

Installationsauswahlmaske


Bei der Installation kann ausgewählt werden, ob auch die mitgelieferten Beispieldateien installiert werden sollen.


Die Versionen der einzelnen CIB office Module können Sie innerhalb von MS-Word mit dem CIB workbench Info-Button (Symbol) überprüfen. Für realistische Tests sollte in der CIB workbench mit den gleichen Versionen der CIB office Module getestet werden, die Sie auch in der Produktion auf Ihren Zielsystemen einsetzen.

Die Versionen der einzelnen CIB office Module können Sie innerhalb von MS-Word mit dem CIB workbench Info-Button (Symbol) überprüfen. Für realistische Tests sollte in der CIB workbench mit den gleichen Versionen der CIB office Module getestet werden, die Sie auch in der Produktion auf Ihren Zielsystemen einsetzen.


Option: MSXML nicht installieren

Wenn am Zielsystem die Softwarebibliothek MSXML bereits installiert ist, kann das CIB workbench Setup angewiesen werden dieses nicht mit zu installieren. Dies kann mit Hilfe der MSI Variablen NOMSXML erreicht werden.

Beispielaufrufe:

EXE:  CIBworkbench.exe /v“NOMSXML=TRUE“

MSI: msiecec /i CIBworkbench.msi NOMSXML=TRUE


Korrektur zu „Format übertragen“ nicht installieren

(Ab CIB workbench Version 2.8.184)

In MS Word besteht eine Unverträglichkeit zwischen VBA-Anwendungen und der Funktion „Format übertragen“. Dies äußert sich darin, dass die Funktion „Format übertragen“ nicht funktioniert, wenn ein VBA-Addin in MS Word geladen ist.

Für dieses Fehlverhalten existiert eine Korrektur von Microsoft, die durch Aktivieren des Eintrags „KeepUISpecModeAtVbaEnd“ in der Registry aktiviert wird. Dieser Registry-Eintrag wird durch den Setup der CIB workbench automatisch angelegt.

Wird dies vom Benutzer nicht gewünscht, kann dies über Setzen der Variable „REGFIX_FORMAT_PAINTER“ an den CIB workbench Setup erreicht werden. Der Fix wird nur installiert, wenn diese Variable beim Setup nicht explizit gesetzt wird.

Beispielaufruf:

CIBworkbench.exe /i /v"REGFIX_FORMAT_PAINTER=0"

3.4. Automatisierte Installation ohne Benutzerdialog (Silent Install)

Um eine unbeaufsichtigte Installation ohne Benutzerdialog durchzuführen kann der CIB workbench Setup auch mit speziellen Parametern aufgerufen werden:

Erstinstallation/Update

Beispiel:

CIBworkbench.exe /s /v/qn

Erstinstallation/Update inkl. ausführlichen Installationsprotokolls:

CIBworkbench.exe /s /v"/qn /l*v [Pfad zu Logfile]"

Beispiel:

CIBworkbench.exe /s /v"/qn /l*v c:\cibworkbench_install.log"

Wird die Installation über einen Dienst ausgeführt, also ohne eine angemeldeten Benutzer, muss der Aufruf „/v“ noch um den Parameter „ALLUSERS=2“ ergänzt werden. Dieser Parameter muss in Großbuchstaben gesetzt werden!

Beispiel:

CIBworkbench.exe /s /v"/qn /l*v c:\wb.log ALLUSERS=2"

3.5. Deinstallation

Eine Deinstallation der CIB workbench können Sie sowohl manuell als auch automatisiert per Programmsteuerung von außen vornehmen.


Manuelle Deinstallation

Öffnen Sie auf dem Windows Desktop | Start | Systemsteuerung | Software und klicken Sie auf den Eintrag: „CIB workbench ...“, um die Deinstallation zu starten.

Auf Windows 7 Systemen öffnen Sie auf dem Windows Desktop | Start | Systemsteuerung | Programme | Programme und Funktionen | Programm deinstallieren.



Automatisierte Deinstallation

Der CIB workbench Setup kann über den Parameter /x automatisch vom Zielsystem deinstalliert werden. In Kombination mit den Parametern /s /v/qn geschieht dies ohne erscheinen eines Benutzerdialogs. Beispiel:

CIBworkbench.exe /x /s /v/qn

Auch hier können wie bereits im Punkt „Automatische Installation ohne Benutzerdialog“ beschrieben die Parameter für das Installationsprotokoll (/l*v [Pfad zu Logfile]) sowie für die Installation über einen Dienst (ALLUSERS=2) angewandt werden.


3.6. Zusammenfassung sowie weitere Parameter

CIBworkbench.exe Parameter

/s

Silent Install, CIBworkbench.exe wird ohne Dialog gestartet

/x

Deinstallation; Produkt wird deinstalliert

/a

Administrativer Modus; Setup wird nur im Zielverzeichnis entpackt, nicht installiert.

/w

CIBworkbench.exe wartet bis die Installation abgeschlossen ist. Beim Ausführen über eine Batchdatei muss dieser Parameter zusammen mit „start /wait CIBworkbench.exe /w“ gestartet werden.

/v[MSI Parameter]

Parameter an den Windows Installer (msiexec) übergeben.


Windows Installer Parameter

/l[i|w|e|a|r|u|c|m|o|p|v|x|+|!|*] [Protokolldatei]

Installationsprotokoll erstellen

i =Statusmeldungen

w = Nicht schwerwiegende Warnungen

e = Alle Fehlermeldungen

a = Ausführung von Aktionen

r = Aktionsspezifische Einträge

u = Benutzeranforderungen

c = Ursprüngliche Benutzeroberflächenparameter

m = Informationen betreffend zu wenig Arbeitsspeicher od. schwerem Abbruch

o = Meldungen betreffend zu wenig Speicherplatz

p = Terminaleigenschaften

v = Ausführliche Ausgabe

x = Zusätzliche Debuginformationen

+ = An vorhandene Protokolldatei anhängen

! = Jede Zeile ins Protokoll aufnehmen

* = Alle Informationen mit Ausnahme der Optionen v und x protokollieren

/q[n|b|r|f]

Zu verwendende Benutzeroberfläche:

n = Keine Benutzeroberfläche (Silent Install)

b = Einfache Benutzeroberfläche

r = Reduzierte Benutzeroberfläche

f = Vollständige Benutzeroberfläche (Standard)

/norestart

Kein Neustart nach Abschluss der Installation durchführen

/promptrestart

Benutzereingabe, falls Neustart erforderlich

/forcerestart

Computer nach Abschluss der Installation immer neu starten

[PROPERTY=Eigenschaftswert]

Öffentliche Eigenschaft festlegen.

Beispiele:

INSTALLDIR=[Pfad]
Legt das Installationsverzeichnis fest

ALLUSERS=[Wert]
Legt fest wo Installationsinformationen gespeichert werden

  • Kein Wert: Eine „per-user Installation wird durchgeführt (Standard)
  • 2: Eine „per-machine“ Installation wird durchgeführt, sofern Administrator Privilegien vorhanden sind.


3.7. CIB workbench XPS – externe Konfigurationsdatei

(Ab CIB workbench Version 2.8.184)

In der XPS-Edition besteht die Möglichkeit, den XPS-Standard über eine Konfigurationsdatei Benutzer-spezifisch einzustellen.

Diese Datei „CIBworkbench_config.xml“ enthält die konfigurierbaren Parameter in der empfohlenen Voreinstellung und ist innerhalb des Programmverzeichnisses der CIB workbench im Unterordner „customconfig“ zu hinterlegen. Sie wird von CIB getrennt ausgeliefert, d.h. ist nicht im normalen Setup der CIB workbench enthalten. Die Konfigurierung und Verteilung dieser Datei liegt in der Verantwortung des Kunden-Rechenzentrums.

(Ab CIB workbench Version 2.8.197)

Die Datei „CIBworkbench_config.xml“ kann auch im CWP hinterlegt werden. Damit ist eine Projekt-spezifische Konfiguration möglich. Diese Datei würde diejenige aus dem Installationsverzeichnis überlagern.

Nähere Informationen sind über den CIB support erhältlich.


4. Aktivieren der CIB workbench

Die CIB workbench kann je nach Setupvariante entweder direkt in die von Microsoft® Word für AddIns vorgesehene Startup Umgebung installiert werden oder unterhalb einem Programmverzeichnis der CIB software GmbH oder in einem Verzeichnis Ihrer Wahl.

Die gewünschte Installationsvariante bestimmt der Kunde selbst und ist meist abhängig von allgemeinen Installationsvorgaben aus dem administrativen Systembereich des Kunden.


4.1. Erforderliche Zugriffsrechte

Für den Betrieb der CIB workbench sind Schreibrechte auf einige Verzeichnisse erforderlich:

  • Auf die in den globalen Variablen %TMP% und %TEMP% hinterlegten Verzeichnisse.
  • Auf die Benutzerbezogenen Verzeichnisse unter C:\Users\benutzer\Application Data
  • Auf die Benutzerbezogenen Verzeichnisse unter C:\Users\benutzer\AppData
  • Auf die Normal.dotm
  • Auf das in der CIB workbench Konfiguration eingetragene Arbeitsverzeichnis

Im Standard-Installationsverzeichnis (Programme(x86)) sind nur Lese beziehungsweise Executable-Reche erforderlich.

4.2. Automatisch über Startup-Verzeichnis

Sie können die Installation so ausführen, dass das Setup die CIB workbench automatisch im Startup-Verzeichnis Ihrer installierten MS Word Versionen hinterlegt. Beim Start von MS Word wird das CIB workbench Add-In dann auch immer automatisch in der Menüleiste von MS Word erscheinen.


4.3. Automatisch über umkonfiguriertes Startup-Verzeichnis

Sie können das von Microsoft festgelegte Autostart Verzeichnis für Add-Ins auch dauerhaft umstellen.

MS Word 2013 – Wechsel zu den Optionen


Wechseln Sie unter „Erweitert“ und dort unter der Rubrik „Allgemein“ auf den Knopf „Dateispeicherorte…“.

MS Word 2013 – Wechsel zu den Dateispeicherorten


Ändern Sie den Dateispeicherort für „Autostart“ auf das Installationsverzeichnis des CIB workbench AddIn (i.d.R. ist das unter „c:\Programme (x86)\CIB software GmbH\CIB workbench\AddIn“ zu finden).


MS Word 2013 – Autostart Verzeichnis für Add-Ins festlegen


Jeder neue Start Ihres MS Word2013 lädt nun die CIB workbench automatisch über Autostart.


4.4. Automatisch über die Einstellung "CIB workbench automatisch mit Microsoft® Word starten"

Sie können in der CIB workbench Konfiguration die Einstellung "CIB workbench automatisch mit Microsoft® Word starten" aktivieren. Ist diese Einstellung aktiviert wird die CIB workbench bei jedem Microsoft® Word automatisch mit geladen. Technisch wird das so gelöst, dass im Microsoft® Word Startup-Verzeichnis eine Verknüpfung zur CIB workbench DOTM erstellt wird.

Hinweis: Vor dem Deinstallieren bitte unbedingt diese Einstellung zurücksetzen, weil der Setup diese Verknüpfung nicht automatisch wieder entfernt und es somit beim Starten von Microsoft® Word zu Komplikation kommen kann.


CIB workbench automatisch mit Microsoft® Word starten

4.5. Automatisch über den CIB workbench Connector

Es gibt Kunden, die es in ihrer Infrastruktur nicht gestatten, dass Add-Ins von Drittherstellern in die Installationsbasis von MS Word eingebracht werden. In so einem Fall, wird das CIB workbench Add-In in der CIB-eigenen Installationsbasis in einem Unterverzeichnis „.\AddIn“ installiert.

Es besteht für eine Kundenanwendung jedoch die Möglichkeit, zum Start von MS Word den CIB workbench connector einzusetzen. Dieser connector übernimmt die Aufgabe, innerhalb von MS Word die CIB workbench zu starten und ggf. auch ein Dokumentprojekt mit zu öffnen.

Nähere Informationen zum CIB workbench connector finden Sie im Kapitel CIB workbench Connector.

4.6. Manuell über MS Word „AddIn Funktionalitäten“

Unter MS Word2013 aktivieren Sie die CIB workbench nach dem Start am besten wie folgt:

  • Aktivieren Sie die Entwicklungsregisterkarte über die Word Optionen unter „Menüband anpassen“.


Hier ist die Option "Entwicklertools" zu aktivieren.

  • Aktivieren Sie über den Menüpunkt „Entwicklertools“ -> „Dokumentvorlage“ das CIB workbench Add-in



4.7. Manuell über die Verknüpfung „CIB workbench mit Microsoft Word starten“

Mit dem Setup der CIB workbench wird ebenfalls die Verknüpfung „CIB workbench mit Microsoft Word starten“ ausgeliefert. Diese Verknüpfung befindet sich nach erfolgreicher Installation im Installationsverzeichnis der CIB workbench. Dieses kann eine Kundenanwendung dazu nutzen, um für eine spezielle Programmumgebung einen direkten Start der MS Word Umgebung inkl. des CIB workbench Add-In herzustellen.

Achtung:
Diese Möglichkeit sollte nicht für den allerersten Start nach Installation der CIB workbench verwendet werden. Hier muss manuell über MS Word „AddIn Funktionalitäten“ gegangen werden, damit die CIB software GmbH von MS Word in die Liste der vertrauenswürdigen Herausgeber aufgenommen wird.


5. CIB workbench im Kontext eines Dokumentmanagementsystem (DMS)

Neben der Unterstützung der CIB workbench bei der Gestaltung, Pflege von Vorlagen ist ein wesentlicher Aspekt die Integrationsmöglichkeit in eine umgebende Dokumentmanagementsystemumgebung (= DMS System).

Die CIB workbench Edition XPS ist darauf ausgelegt.

In sehr vereinfachter Form sieht der Kreislauf mit einem DMS System wie folgt aus:

Vorlagenkreislauf mir CIB workbench und DMS system

  • Das übergeordnete DMS System verwaltet und administriert die Vorlagen.
  • Zum Zwecke der Ausgestaltung der Vorlagen wird ein Standardtextsystem inklusive der CIB workbench integriert.
  • Innerhalb der CIB workbench findet die komplette Designphase der Vorlage und aller beteiligten Textbausteine statt.
  • Die CIB workbench unterstützt auch die Datenquelle, die eine Anwendung für eine Vorlage liefern kann.
  • Vollständige und sehr umfangreiche Tests der Vorlagen sind innerhalb der CIB workbench möglich.
  • Die CIB workbench generiert (optional) zusätzliche Masken und Regelwerke für eine – auf der Vorlage basierende - dynamische Restdatenerfassung.
  • Die CIB workbench stellt ein Gesamtpaket der Vorlage für den Rückimport in das DMS System bereit.

5.1. CIB workbench XPS zusammen mit CIB coSys

Wenn Sie CIB coSys als DMS System einsetzten, dann werden die von dort administrierten Vorlagenprojekte über eine CWP Datei (=CIB workbench Projektdatei) der CIB workbench zum laden bereitgestellt.

Architektur Teilbereich Textorganisation innerhalb CIB coSys (XPS Edition)


5.2. Lokale Ablage- / Verzeichnisstruktur der Vorlagen

Allgemein
CIB workbench XPS (Paketierte Verzeichnisstruktur)
CIB workbench XSS Edition (Kundenindividuelle Ablagestruktur)

Allgemein

Die CIB workbench ist an keine feste Verzeichnisstruktur als Ablage für ein Dokumentprojekt gebunden. Für die eigene Fachlichkeit ist es jedoch sinnvoll, sich an eine konkrete Verzeichnisvorgabe bei der Vorlagenverarbeitung zu halten.

Aus diesem Grund gibt es die bereits beschriebenen verschiedenen Editionen der CIB workbench die sich passend in die Kundenumgebung einfügen.


CIB workbench XPS (Paketierte Verzeichnisstruktur)

Wenn die CIB workbench in einem Umfeld mit dem CIB coSys Komponenten eingesetzt wird, dann erfolgt die Verwaltung der Vorlagen immer auf Basis einer Paketstruktur. Für die Paketstruktur geben Sie ein beliebiges zentrales Arbeitsverzeichnis vor.

Übersicht Konfiguration „paketierte Verzeichnisstruktur“


Unterhalb des gewählten Arbeitsverzeichnisses, in dem die CIB workbench die Unterordner Import, Export, Export_CIBworkbench und Workspace erzeugt, müssen Schreibrechte bestehen.

Übersicht „paketierte Verzeichnisstruktur“


Zentraler Paketpool: (ab CIB workbench Version 2.8.184):

Für die Umsetzung der optimierten Übermittlung von CWP Dateien aus Kunden-Anwendungen in die CIB workbench wurde ein zentraler Paket Pool eingeführt. Dieser Paket Pool wird in der Regel initial beim ersten Start der CIB workbench mit dem Bezeichner „PackagePool“ angelegt. Im Paketpool wird der statische Teil der Pakete auf dem Rechner des Textorganisators abgelegt, so dass beim Im- und Export nur die Bausteine bewegt werden, in denen Änderungen durchgeführt werden.

Ob dieser Paketpool genutzt wird, wird von CIB coSys in der Steuerdatei cib‑workbench‑instructions.xml des CWPs hinterlegt.


CIB workbench XSS Edition (Kundenindividuelle Ablagestruktur)

Die CIB workbench unterstützt in der XSS „Standard“ Edition beliebige Ablagestrukturen. Die verwendeten Verzeichnisse stellen Sie in der Konfiguration der CIB workbench ein.

Beachten Sie, ob der Vorlagentest und das Einfügen der INCLUDETEXT-Felder in der CIB workbench wie gewünscht funktionieren.

Zur Aufteilung von Dokumentenprojekten beachten Sie auch das Kapitel 7 Dokumentfachliche Begriffsdefinitionen.

5.3. VORLAGEN import/-export – Verbindung zu DMS-Umgebungen

Allgemein
XPS Edition – paketierte Ablagestruktur / CWP Paket
XSS Edition – Standard Ablagestruktur
Test und Freigabe ohne angeschlossenes DMS System

Allgemein

Die CIB workbench lässt sich an übergeordnete DMS-Systeme anbinden. Dafür stehen folgende Mechanismen bereit:

  • Bereitstellung von Textbausteinen in vorgegebenen Verzeichnisstrukturen
  • Importschnittstelle von CIB workbench Projektdateistrukturen (CWP) die über das Textorganisations Modul (TOM) aus dem CIB correspondencesystem (=CIB coSys) bereitgestellt werden (XPS Edition)
  • Exportschnittstelle in eine CIB workbench Projektdateistruktur (CWP), die sich insbesondere von dem Textorganisationsmodul (TO-Client) von CIB coSys weiterverarbeiten lässt (XPS Edition)

Die CIB workbench unterstützt über einzelne Menüfunktionen den Import von bereitgestellten Datenstrukturen. Diese können als Grundlage für die Verwendung in einem Dokumentprojekt dienen.

Ebenso können aus der CIB workbench fertig erstellte und lokal getestete Dokumentprojekte komplett exportiert und einem beliebigen Zielsystem (ggf. zum dortigen Import) zur Verfügung gestellt werden. Alle Strukturen und Schnittstellen des exportierten Paketes sind offen gelegt. Häufig werden DMS Systeme diese Schnittstelle nutzen.


XPS Edition – paketierte Ablagestruktur / CWP Paket

Die XPS Edition unterstützt den Import und Export über CWP Dateien (CIB Workbench Projekt-Dateien). Normalerweise wird der Import einer aktuellen Vorlage in die CIB workbench Umgebung auch durch den direkten Aufruf aus dem TOM ausgeführt. Sie haben jedoch auch die Möglichkeit, sich eine Vorlage lokal direkt als CWP-Datei in die CIB workbench zu importieren.


Import eines kompletten Dokumentprojektes (paketierte Ablagestruktur / CIB workbench Projektdatei)

Zum manuellen Laden einer CIB workbench Projektdatei wechseln Sie in die Bausteinverwaltung und drücken dort die Schaltfläche zum „Projekt laden“:


Innerhalb der Projektverwaltung wechseln Sie auf den Reiter „aus dem TO Modul“:


Dort wählen Sie nun aus den angebotenen Vorlageprojekten Ihr gewünschtes aus und bestätigen mit OK.


Export eines kompletten Dokumentprojektes (paketierte Ablagestruktur / CIB workbench Projektdatei)



Wenn Sie auf „Export starten“ klicken, wird das Projekt in eine .cwp Datei gepackt, die alle Informationen über das Projekt enthält. Im Export Fenster sehen Sie den Pfad zu der eben erzeugten Projektdatei (.cwp).

Bei Vorlagen mit Restdatenerfassung können Sie keine Maske generieren lassen, die vorhandene Maske beibehalten (diese Option wird angeboten, falls zum Zeitpunkt des Exports bereits eine Maske vorhanden ist) oder eine neue Maske generieren lassen. Wenn CIB webdesk in Ihrem System die Masken dynamisch generieren kann, wird dies automatisch angezeigt: „Keine Maske (Maske wird von CIB webdesk generiert)“. Wenn Sie diese Option auswählen, wird die Maske erst zur Laufzeit aus den aktuell vorhandenen Paketen generiert. Damit wirken die Änderungen eines Bausteins, der in mehreren Vorlagen verwendet werden, in der Maske aller Vorlagen, die diesen Baustein verwenden. Sonst müssten diese Vorlagen alle einzeln bearbeitet und ihre Masken neu erzeugt werden.

Die Option „CIB workbench“ unter der „Export starten“-Schaltfläche erstellt eine zusätzliche .cwp-Datei im Ordner „Export_CIBworkbench“. Diese Datei ist zur Analyse oder Weiterverarbeitung unabhängig von Ihrem System erforderlich, beispielsweise für den Support oder die Weiterentwicklung einer Vorlage durch Drittanbieter. Sie beinhaltet alle Dateien und Pakete, zusätzlich zur Datei im Ordner „Export“ auch die nicht bearbeiteten Pakete.

Bemerkung:

Die .cwp Dateien im Export Verzeichnis ihres Arbeitsverzeichnisses sind nicht zum wiederholten Öffnen in der CIB workbench konzipiert, sondern können ausschließlich zum Import in CIB tom verwendet werden.


XSS Edition – Standard Ablagestruktur

Bisher ist in dieser Umgebung noch kein Import / Export für ein angeschlossenes DMS System vorgesehen.

Zum Test- und Freigabeprozess siehe 5.3.3 Test und Freigabe ohne angeschlossenes DMS System.


Test und Freigabe ohne angeschlossenes DMS System

In der CIB workbench Edition XSS ist keine direkte Import/Export Möglichkeit für ein angeschlossenes DMS System vorhanden. Sicherung, Versionierung und Freigabeprozess für die Dokumentdateien sind unabhängig von der CIB workbench sicherzustellen.

In der Praxis hat sich ein Freigabeworkflow in drei Stufen bewährt. Dabei gilt für Test und Freigabe dieselbe Verzeichnisstruktur wie im CIB workbench Arbeitsverzeichnis.


CIB workbench Arbeitsverzeichnis - Entwicklung

Die CIB workbench arbeitet in ihrem Arbeitsverzeichnis direkt auf der Verzeichnisstruktur (Edition XSS). Sind mehrere Textorganisatoren an  der Erstellung und Wartung der Vorlagen beteiligt, so muss sichergestellt sein, dass jeder Textorganisator den aktuellen Stand aller Dokumentenbausteine und der Datenquelle zur Verfügung hat. Dies kann beispielsweise durch die gemeinsame Nutzung eines Arbeitsverzeichnisses auf einem Fileserver ermöglicht werden. Zusätzlich empfiehlt sich die Nutzung einer Versionsverwaltung.

Beim Test aus der CIB workbench werden die Dateien aus diesem Arbeitsverzeichnis verwendet.

Ist der Test erfolgreich, so werden alle freizugebenden Dateien von Ihrer Anwendung in das Verzeichnis "Freigabe zum Test" kopiert. Siehe auch 5.3.3.4 Auswahl und Bereitstellung der freizugebenden Dateien.


Freigabe zum Test - Test mit der Anwendung

Dieses Verzeichnis wird von Ihrer Anwendung zur Dokumentgenerierung in einem Testmodus verwendet. Hier kann jedes Dokumentenprojekt mit der Anwendung getestet werden, ohne die Produktion zu beeinflussen.

Ist der Test erfolgreich, so werden alle freizugebenden Dateien von Ihrer Anwendung in das Verzeichnis "Freigabe" kopiert. Siehe auch 5.3.3.4 Auswahl und Bereitstellung der freizugebenden Dateien.


Freigabe - Produktion

Dieses Verzeichnis wird von Ihrer Anwendung zur Dokumentgenerierung im Produktionsmodus verwendet. Hier nutzen die Anwender die produktiven Dokumentenprojekte.


Auswahl und Bereitstellung der freizugebenden Dateien

Das Arbeitsverzeichnis der CIB workbench ist initial manuell anzulegen und wird anschließend in der CIB workbench verwaltet.

Die Bereitstellung der Dokumentdateien in den Test- und Freigabe Verzeichnissen erfolgt durch Ihre Anwendung. Dazu kann beispielsweise auch ein batch-Script genutzt werden.

Beachten Sie bei der Konzeption und Implementierung des Freigabeprozesses auch die unterschiedlichen Bausteinkategorien,

  • Vorlagenspezifischen Bausteine
  • Allgemeine Bausteine
  • Wurzelbausteine

Aspekte für die Entscheidung sind hier

  • Wollen Sie immer den gesamten Vorlagenbestand zum Test oder zur Produktion freigeben oder nur eine konkrete Vorlage
  • Wollen Sie allgemeine Bausteine separat freigeben oder nur zusammen mit einer Vorlage
  • Soll die Freigabe auf Verzeichnisebene erfolgen oder nur für Dateien, die in der gerade freizugebenden Vorlage verwendet werden? Die CIB office Module können auch die Information liefern, welche Bausteine von einer bestimmten Vorlage verwendet werden. Kontaktieren Sie für Details den CIB support.
  • Bei allgemeinen Bausteinen oder Layouts ist es je nach Größe der Änderung oft unverhältnismäßig aufwändig, die Änderungen mit allen betroffenen Vorlagen zu testen. Hier ist der Test mit einer repräsentativen Stichprobe als Alternative überlegenswert.


6. Verwendung von Datenquellen in der CIB workbench

Die CIB workbench unterstützt die Vorlagenerstellung mit Ihrer Datenquelle(=Versorgungsvorlage oder Variablendatei) an zwei Stellen:

  • Einfügen von Feldern Ihrer Datenversorgung per Mausklick aus dem Menü „Variablen“ in Ihre Vorlagen
  • Lokaler Test Ihrer Vorlagen mit vorbereiteten Beispieldaten

In vielen Fällen kann für beide Zwecke die gleiche Datei verwendet werden.

Durch die Bereitstellung des verfügbaren Vorrats an Dokumentvariablen und eines Testdatenbestands kann die Arbeit an den Vorlagen erheblich erleichtert werden.

Wie weit die CIB workbench den Textorganisator hier unterstützt, hängt vom Aufbau der verwendeten Datenquellendatei ab, siehe dazu Kapiteln Struktur von Datenquellen in der Testumgebung und Struktur von Datenquellen in der Variablenverwaltung.

6.1. Datenquellen zur Verwendung als Testdaten

Falls in Ihrer CIB workbench Edition im Vorlagentest noch keine Datenquelle hinterlegt ist, so können Sie im Dialog zum Test eine Datenquelle zum Test festlegen, sofern nicht ausschließlich über das führende System, wie z.B. bei der XPS Edition oder über das Dokumentprojekt selbst Datenquellen zugeordnet wurden.

Die Anforderungen an Testdaten sind geringer als im Menü „Variablen“, siehe Struktur von Datenquellen in der Testumgebung.

Ist eine Datenquelle im Menü „Variablenmanager“, so wird diese auch automatisch für den Test vorbelegt. Abweichungen zwischen den beiden Anwendungen für die Datenquelle werden ggf. auch als Hinweis angezeigt.


6.2. Datenquellen im Menü „Variablenmanager“

Über das Menü „Variablenmanager“ können Sie Variablen aus der dem Vorlageprojekt zugeordneten Datenquelle per Mausklick in Ihre Vorlage einfügen. Das korrekte Einfügen per Mausklick ist von der für die CIB workbench passenden Vorgabe in der Datenquelle abhängig. Details dazu finden Sie im Kapitel 6.3 Struktur von Datenquellen in der Variablenverwaltung.


6.3. Datenquellen und CIB workbench Editionen

CIB workbench XSS Edition

Folgende Empfehlungen gelten für die CIB Workbench XSS Edition:

Um die Variablenverwaltung im Menü „Variablen“ und in der Testumgebung zu verwenden:

  • Verwenden Sie eine XML-Datenquelle vom Typ 1b oder 1d mit Comod-Knoten.
  • Geben Sie bei allen Variablen Werte für den Test an, z.B. <Kontonummer>123456</Kontonummer>
  • Wenn Sie mit dem Typ 1b einen Prefix-Delimiter verwenden, geben Sie bei allen Variablen zusätzlich das Attribut varPath an, z.B. <Kontonummer varPath=“Konto.Kontonummer“>

Wenn Sie Ihre XML-Datenquelle nur in der Testumgebung, nicht aber in der Variablenverwaltung nutzen wollen, sind lediglich Testdaten erforderlich, z.B. <Kontonr>123456</Kontonr>. Es kann eine beliebige XML-Datenstruktur verwendet werden (Typ 2).


CIB workbench Edition XPS mit fester Datenstruktur

Wenn Sie die CIB workbench zusammen mit einem System einsetzen, das die Datenquelle bereits an die CIB workbench liefert (z.B. CIB coSys mit der CIB workbench XPS Edition), so sind alle Voreinstellungen bereits getroffen und sollten in der CIB workbench nicht geändert werden.


6.4. Struktur von Datenquellen in der Testumgebung

Die Testdaten können in jeder für die Datenversorgung der CIB office Module gültigen XML-Struktur vorliegen, beispielsweise auch direkt aus Ihrer Produktions- oder Testumgebung.


6.5. Struktur von Datenquellen in der Variablenverwaltung

Die Funktionalität der Variablenverwaltung hängt von der vorliegenden Datenstruktur ab.

Übersicht über unterschiedliche Datenstrukturen
Datenquellen im Einzel CSV-Format
Datenquellen im Multi CSV-Format
Datenquelle mit XML-Strukturen mit <Comod> Knoten - Typ 1
Datenquelle im XML-Format (Typ 2) ohne <Comod> Knoten

Übersicht über unterschiedliche Datenstrukturen

Folgende Datenquellenstrukturen werden von der Variablenverwaltung (Menü „Variablen“) der CIB workbench unterschiedlich unterstützt:

  • flache Einzel-CSV (Typ 0a)
  • Multi-CSV Struktur (Typ 0b)
  • XML Struktur mit CoMod Strukturinformation (Typ 1a) - dataroot
  • XML Struktur mit erweiterter CoMod Information (Typ 1b) - job
  • XML Struktur mit umfangreicher CoMod Information ( Typ 1c) – gtv
  • XML Struktur mit CoModStrukturinformation (Typ 1d) - merge
  • XML Struktur ohne CoMod Information (Typ 2)

In den meisten Fällen empfiehlt sich die Verwendung einer XML Datenquelle mit CoMod Strukturinformation vom Typ 1b.


Funktionen in der Variablenverwaltung nach Datenstrukturen

Die Funktionalität der Variablenverwaltung hängt von der vorliegenden Datenstruktur ab:

 

CSV

XML

 

Einzel

Multi

mit CoMod

ohne CoMod

Typ

0a

0b

1a

1b

1c

1d

2

Struktur-information

-

-

dataroot

job

gtv

merge

-

Menü-bezeichnung

REF Name

REF Name

REF Name

spre­chend

spre­chend

REF Name

REF Name

Testwert

ja

ja

ja

ja

ja

ja

nein

Menükaskaden

nein*

ja

ja

ja

ja

ja

ja

Feldattribute

nein

nein

nein

ja

ja

nein

nein

prefix-delimiter

nein

nein

ja

ja

ja

ja

nein


Datenquellen im Einzel CSV-Format

Die Einträge der CSV Datei werden flach in dem Variablenmenü angezeigt. Überschreitet die Liste eine festgelegte Anzahl an Einträgen, dann werden automatisch Untermenüs mit angelegt. Diese Untermenüs enthalten eine feste Anzahl an Variablen. Dieses Verfahren dient der Übersichtlichkeit großer CSV Dateien.


Datenquellen im Multi CSV-Format

Optional können auch mehrere CSV Dateien (=Multi-CSV) importiert werden. Die Menüdarstellung innerhalb der CIB workbench erfolgt dann auf 2 Ebenen. Die erste Ebene enthält den Aliasnamen unter dem eine CSV Tabelle angesprochen werden kann. In der 2ten Ebene jedes Aliasnamen erscheinen alle verfügbaren Variablen in der jeweiligen Tabelle.


Datenquelle mit XML-Strukturen mit <CoMod> Knoten - Typ 1

Datenquellen vom Typ 1 werden XML-Datenquellen genannt, die einen CoMod Knoten enthalten.

Dieser kann Informationen zu Struktur, Datenbereich, Verarbeitungsweisen und mehr beinhalten. Der Comod-Knoten befindet sich immer direkt unter dem obersten Knoten, dessen Name beliebig gewählt werden kann.

Für die Verwendung in der CIB workbench entscheidend sind vor allem die Angaben zur Datenstruktur, Details dazu finden Sie auf den folgenden Seiten.

Ausführliche Informationen zu den weiteren Inhalten des CoMod Knoten finden Sie im Technischen Leitfaden zu CIB job.

Beispiel einer XML-Datendatei mit CoMod Knoten, Multi- und Datenbereich


Jede XML-Datendatei mit Comod-Knoten gehört zu einem der Untertypen 1a, 1b, 1c oder 1d. Der genaue Untertyp ist im Wert des Attributes „structure“ des Comod-Knoten definiert.

<Template>   
   <Comod>
        <defaults>
            <properties command="workbench">
                <property name="structure">dataroot</property>


Datenquelle im XML-Format (Typ 1a) mit CoMod-Knoten und structure: dataroot

Dieser Typ erlaubt lediglich die Angabe des DataRoot zu den Daten innerhalb der XML-Datei.

Es sind keine weiteren Attribute zu den einzelnen Variablen möglich.

<?xml version="1.0" encoding="ISO-8859-1"?>
<Template>    <Comod>
        <defaults>
            <properties command="workbench">
               <property name="structure">dataroot</property>
                <property name="DataRoot">Template/data</property>
            </properties>
        </defaults>    </Comod>    <data>
        <Adresse>
            <Vorname>Peter</Vorname>
            <Nachname>Clever</Nachname>             <PLZ>90401</PLZ>
            <Ort>Nürnberg</Ort>
            <Telefonnummer>0911/123456789</Telefonnummer>         </Adresse>
        <Kontodaten>
            <Kontotyp>Giro</Kontotyp>
            <Saldo>1.234,59</Saldo>
            <Kontonummer>08154711</Kontonummer>         </Kontodaten>
    </data>
</Template>


Datenquelle im XML-Format (Typ 1b) mit CoMod-Knoten und structure:job

Die CIB workbench versteht XML Strukturen die speziell für die Nutzung im Umfeld des CIB documentservers oder für die Nutzung als XML Auftrag für das CIB job Modul konzipiert sind.

Innerhalb des <Comod> Knoten ist Sie dazu eine  Property  command=„job“ erforderlich.

Großer Unterschied zum Typ 1a ist, dass ein multi Knoten hinzukommt, der alle Datengruppen und Tabellen definiert. Auch hier wird das Attribut DataRoot genutzt. Allerdings zeigt der XPath unter „DataRoot“ nicht auf die Daten selbst, sondern auf den multi Knoten innerhalb der XML-Datei.

<?xml version="1.0" encoding="ISO-8859-1"?>
<root>    <Comod>
        <defaults>
            <properties command="workbench">
                <property name="structure">job</property>
                <property name="DataRoot">//multi</property>
            </properties>
        </defaults>
    </Comod>

Zusätzlich kann hier auch ein prefix-delimiter definiert werden.

<property name="PrefixDelimiter">.</property>

Die Einstiegspunkte für die konkreten Daten sind unter dem Multi Knoten hinterlegt. Unter dem multi Knoten sind alle wichtigen Informationen zu den im XML vorhandenen Datengruppen hinterlegt:

<multi>
      <allgemeineVariablen type="superGroup" info="Allgemeine Variablen" level="1"> XML:datenquelle.xml;/*/data/allgemeineVariablen</allgemeineVariablen>       <adresse type="group" info="Adresse" isTable="1" level="1" minOccurs="1" maxOccurs="unbounded">XML:datenquelle.xml;/*/data/adresse</adresse>       <kontobezogendeDaten type="superGroup" info="Kontodaten" level="1"> XML:datenquelle.xml;/*/data/kontoDaten</kontobezogendeDaten>       <konto type="group" info="Standard" isTable="0" level="2" minOccurs="1" maxOccurs="1"> XML:datenquelle.xml;/*/data/konto</konto>
</multi>

Element

Pflicht

Werte

Beschreibung

Name

Ja

 

Aliasname, mit dem die Daten in der Vorlage angesprochen werden können

Wert

Ja

XPath Ausdruck

XPATH zu den Daten

 


Attribut

Pflicht

Werte

Beschreibung

type

Ja

group/supergroup

Typ des Datensatzes

info

Ja

 

Beschreibung – wird im Menü angezeigt

level

Ja

1/2/…

definiert die Ebene im Menü

isTable

Ja

0/1

zeigt, ob es sich um eine dynamische Tabelle handelt.

Hinweis:

Auf dynamische Tabellen können in der Textprogrammierung Schleifenanweisungen verwendet werden.

minOccurs

Ja

>=1

Mindestanzahl an Wiederholungen dieses Datensatzes

maxOccurs

ja

1/2/…/unbounded

Maxmialanzahl an Wiederholungen dieses Datensatzes

Ab dem XML-Format Typ 1b können auch Details zu den Variablen hinterlegt werden:

 <data>
        <allgemeineVariablen>
        </allgemeineVariablen>
        <adresseKunde>
            <vorname field="id001" type="text" info="Vorname " group="adresseKunde" varPath="adresseKunde.Vorname">Peter</vorname>
            <nachname field="id002" type="text" info="Nachname " group="adresseKunde" varPath="adresseKunde.Nachname">Clever</nachname>
            <telefonnummer field="id003" type="text" info="Telefonnummer" group="adresseKunde" varPath="adresseKunde.telefonnummer">0911-1234560</telefonnummer>
        </adresseKunde>
        <kontoDaten>
        </kontoDaten>
        <konto>
            <nummer field="kto_id001" type="text" info="Kontonummer" group="konto" varPath="konto.nummer">Peter</nummer>
            <saldo field="kto_id002" type="text" info="Saldo" group="konto" varPath="konto.saldo">1.234,56</saldo>
            <typ field="kto_id003" type="text" info="Art des Kontos" group="konto" varPath="konto.typ">Giro</typ>               
        </konto>
    </data>
</root>

Element

Pflicht

Werte

Beschreibung

Name

Ja

 

Name der Variablen

Wert

Ja

 

Wert, der beim Test angezeigt wird

 


Attribut

Pflicht

Werte

Beschreibung

type

Ja

int/text/…

Typ der Variablen

info

Ja

 

Beschreibung – wird im Menü angezeigt

group

Ja

 

Name der Gruppe, zu der die Variable gehört

varPath

Ja

Gruppenname.Varname

Aliasname + Prefix + Variablenname

Wird bei Einfügen der Variable ins Dokument als Name des REF Feldes verwendet

format

Nein

 

Unterschiedliches Format je Variablentyp


Bei der Verwendung von Prefix-Delimitern wird empfohlen, das Attribut varPath zu befüllen. So können die Variablen per Mausklick in das Dokument eingefügt werden. Eventuell wird es in zukünfigen Versionen eine automatische Ermittlung des Varpaths aus Aliasnamen + Prefixdelimiter + Name geben.

Falls aus den Vorlagen auch HTML Eingabemasken erzeugt werden sollen, stehen zusätzliche Attribute zur Verfügung, mit denen das Eingabefeld zu jeder Variablen genau definiert werden kann. Ausführliche Informationen dazu finden Sie im CIB format Leitfaden.


Format (Typ 1c) mit erweiterter CoMod-Knoten-Struktur: gtv

Diese XML Struktur ist nicht ganz so dynamisch wie die vom Typ 1b. Hier können aber die Attribute zur Variablenbeschreibung beliebig gewählt werden. Im CoMod-Knoten wird dafür dann eine Art Mappingliste hinterlegt.

Es bleibt auch frei, ob die zusätzliche Variablenbeschreibung als Attribut im Variablenknoten hinterlegt wird, oder ob die Variable die Informationen selber als Kinderknoten enthält.

Mit Attributen:

<Variable Anzeigeformat="100" Beispiel="Filiale Kassel" InternerFeldName="ZWGST" 
Info="Kunde: zuständige Geschäftsstelle" Typ="ZEICHENFELD"/>

Mit Kinderknoten:

<Variable>
    <Anzeigeformat>100</Anzeigeformat>     <Beispiel>Filiale Kassel</Beispiel>
    <Name>ZWGST</Name>
    <Info>Kunde: zuständige Geschäftsstelle</Info>
    <Typ>ZEICHENFELD</Typ>
</Variable>


Der CoMod-Knoten

Mit dieser Mappingtabelle können Sie eigene Namen für die Attribute der CIB workbench definieren. Folgende Attribute können gemappt werden:

Name

Konstante

Beschreibung

GroupNode

cCOMOD_ATTVAL_GROUP

Knoten ist vom Typ Gruppe

GroupKey

cCOMOD_ATTVAL_GROUP_KEY

Bezeichner der Gruppe im Menü

TableNode

cCOMOD_ATTVAL_TABLE

Knoten ist vom Typ Tabelle

TableKey

cCOMOD_ATTVAL_TABLE_KEY

Aliasname der Tabelle

TableName

cCOMOD_ATTVAL_TABLE_NAME

Bezeichner der Tabelle im Menü

FieldNode

cCOMOD_ATTVAL_FIELD

Knoten ist vom Typ Variable

FieldKey

cCOMOD_ATTVAL_FIELD_KEY

Eindeutige Bezeichner der Variablen und Name des REF Feldes

FieldValue

cCOMOD_ATTVAL_FIELD_VALUE

Testdaten der Variablen

FieldInfo

cCOMOD_ATTVAL_FIELD_INFO

Bezeichner der Variablen im Menü

FieldType

cCOMOD_ATTVAL_FIELD_TYPE

Type der Variablen

FieldFormat

cCOMOD_ATTVAL_FIELD_FORMAT

Format der Variablen

EnumNode

cCOMOD_ATTVAL_ENUM

Knoten ist vom Typ Enumeration

EnumEntityNode

cCOMOD_ATTVAL_ENUMENTITY

Knoten ist vom Typ Enumerationslistenpunkt

EnumEntityKey

cCOMOD_ATTVAL_ENUMENTITY_KEY

Schlüssel des Enumerationslistenpunkt

EnumEntityValue

cCOMOD_ATTVAL_ENUMENTITY_VALUE

Wert des Enumerationslistenpunkt

DataRoot

cCOMOD_ATTVAL_DATAROOT

XPATH Pfad zum Datenbereich


Datenbereich

Der Datenbereich beginnt direkt nach dem CoMod-Knoten. Die Struktur der Gruppen und Variablen wird 1 zu 1 in das Variablenmenü übernommen.

<?xml version="1.0" encoding="ISO-8859-1"?>
<Template>
    <Comod>
        <defaults>
            <properties command="workbench">
                <property name="structure">gtv</property>
                <property name="GroupNode">Gruppe</property>
                <property name="GroupKey">@Name</property>
                <property name="TableNode">Tabelle</property>
                <property name="TableKey">@Id</property>
                <property name="TableName">@Name</property>
                <property name="FieldNode">Variable</property>
                <property name="FieldType">@Typ</property>
                <property name="FieldKey">@InternerFeldName</property>
                <property name="FieldInfo">@Info</property>
                <property name="FieldValue">@Beispiel</property>
                <property name="FieldFormat">@Anzeigeformat</property>
                <property name="EnumNode">Enum</property>
                <property name="EnumEntityNode">EnumValue</property>
                <property name="EnumEntityKey">@Nr</property>
                <property name="EnumEntityValue">Value</property>
            </properties>
        </defaults>         <jobs/>     </Comod>
    <Gruppe Name="Allgemeine Variablen">
        <Variable Anzeigeformat="5" Beispiel="15:07" InternerFeldName="CURRENTTIME" Info="Aktuelle Zeit" Typ="ZEICHENFELD"/>         <Variable Anzeigeformat="10" Beispiel="YC8MC06" InternerFeldName="GENOUSERID" Info="Geno User Id" Typ="ZEICHENFELD"/>         <Variable Anzeigeformat="10" Beispiel="01.12.2000" InternerFeldName="CURRENTDATE" Info="Heutiges Datum" Typ="DATUM"/>
        <Variable Anzeigeformat="25" Beispiel="DE1234567890" InternerFeldName="STEUERNUMMER" Info="Nr. Steuer-Nr./USt.-ID-Nr." Typ="ZEICHENFELD"/>
        <Gruppe Name="zust. Gesch.stelle">
            <Variable Anzeigeformat="70" Beispiel="bank@bank.de" InternerFeldName="KUNZWSTTEMAIL" Info="zuständige Geschäftsstelle: E-Mail" Typ="ZEICHENFELD"/>             <Variable Anzeigeformat="32" Beispiel="+49 111 328161" InternerFeldName="KUNZWSTTFAX" Info="zuständige Geschäftsstelle: Fax" Typ="ZEICHENFELD"/>
            <Variable Anzeigeformat="32" Beispiel="Zweite Zeile Name" InternerFeldName="KUNZWSTNAME2" Info="zuständige Geschäftsstelle: Name2" Typ="ZEICHENFELD"/>
            <Variable Anzeigeformat="32" Beispiel="München" InternerFeldName="KUNZWSTORT" Info="zuständige Geschäftsstelle: Ort" Typ="ZEICHENFELD"/>
            <Variable Anzeigeformat="32" Beispiel="90111" InternerFeldName="KUNZWSTPLZ" Info="zuständige Geschäftsstelle: PLZ" Typ="ZEICHENFELD"/>
            <Variable Anzeigeformat="32" Beispiel="Musterstraße 10" InternerFeldName="KUNZWSTSTR" Info="zuständige Geschäftsstelle: Straße" Typ="ZEICHENFELD"/>
            <Variable Anzeigeformat="32" Beispiel="+49 111 328161 000" InternerFeldName="KUNZWSTTTEL" Info="zuständige Geschäftsstelle: Telefon" Typ="ZEICHENFELD"/>
            <Variable Anzeigeformat="32" Beispiel="www.bank.de" InternerFeldName="KUNZWSTTURL" Info="zuständige Geschäftsstelle: URL" Typ="ZEICHENFELD"/>
        </Gruppe>
    </Gruppe>
</Template>


Datenquelle im XML-Format (Typ 1d) mit CoMod-Knoten und Struktur: merge

Dieser XML-Datenquellentyp kann für die XSS Edition der CIB workbench verwendet werden, die nicht zwingend ein führendes System benötigt. Dieser Typ ist in der Struktur sehr einfach gehalten, ist für CIB merge optimiert und unterscheidet sich dadurch stark von den übrigen XML-Datenquellentypen:


Der CoMod-Knoten

Innerhalb des <CoMod> Knoten wird dieser Typ durch das Struktur-Attribut „merge“ gekennzeichnet. Darüber hinaus enthält der <CoMod>-Knoten die Angaben zu den Daten innerhalb der XML über den DataRoot-Knoten und den Prefixdelimiter. Der XPath im DataRoot-Knoten zeigt in der Regel auf den multi-Knoten innerhalb der XML Datei.

Ist kein CoMod Knoten enthalten, so nimmt die CIB workbench die im folgenden Beispiel verwendeten Werte als default und als Datenquellen-Typ 1d an.

<Comod>
      <defaults>
            <properties command="workbench">
                  <property name="structure">merge</property>
                  <property name="DataRoot">//multi</property>
                  <property name="PrefixDelimiter">.</property>
            </properties>       </defaults>
</Comod>


Datenbereich

Analog zum Datenquellentyp 1b enthält der multi-Knoten die Informationen zu den Datengruppen der XML, die als Einstiegspunkte für die konkreten Daten dienen.

<multi>
      <AliasName1>XML:<Datenquellenname>;<Pfad zum Knoten1></AliasName1>
      <AliasName2>XML:<Datenquellenname>;<Pfad zum Knoten2></AliasName2>
      …
</multi>

Beispiel:

<root>
      <Comod>
            <defaults>
                  <properties command="workbench">
                        <property name="structure">merge</property>
                        <property name="DataRoot">//multi</property>
                        <property name="PrefixDelimiter">.</property>
                  </properties>             </defaults>
      </Comod>
      <multi>
      <kontakt>XML:Datenquelle.xml;/root/Informationen/Kontakt</kontakt>
      <dokument>XMLDatenquelle.xml;/root/Informationen/Dokument</dokument>
      </multi>
      <Informationen>
            <Kontakt>
                  <Name>Marta Musterfrau</Name>
                  <Vorname>Marta</Vorname>
                  <Nachname>Musterfrau</Nachname>
                  <Adresse>Musterstr.1, 10000 Musterstadt</Adresse>
            </Kontakt>
            <Dokument>
                  <Datum>29/12/11</Datum>
                  <Beschreibung>Test</Beschreibung>
                  <Betreff/>
            </Dokument>
      </Informationen>
</root>

Anders als bei anderen Datenquellentypen enthält der Typ 1d weder im Multi- noch im Datenbereich Pflichtattribute, die z.B. zur Darstellung im Variablenmanager oder zur Festlegung eines Datentypen für bestimmte Datenknoten dienen.

Beim Einlesen der Datenfelder unter einem Aliasknoten werden je nach Art des Datenbereichs unter dem im Aliasnamen referenzierten XPATH in erster Linie alle Attributwerte und dann alle Unterknoten erster Ebene eingelesen und im Variablenmanager angezeigt. Duplikate werden nicht aussortiert.


Datenquelle im XML-Format (Typ 2) ohne <CoMod> Knoten

XML-Strukturen ohne Comod-Knoten werden im Variablenmenü vollständig dargestellt. Es findet keine Unterscheidung nach Daten- oder anderen Bereichen statt.

Beim Einfügen von Variablen in das Dokument aus dem Variablenmenü wird immer der Variablenname allein verwendet.

Es werden keine Aliasnamen oder prefix-delimiter ergänzt. Falls Sie einen prefix-delimiter verwenden, fügen Sie Aliasnamen und prefix-delimiter manuell zum Feldnamen hinzu. Als Alternative für das automatische Hinzufügen bietet sich in diesem Fall der XML-Typ 1b an.


7. Dokumentfachliche Begriffsdefinitionen

Der Haupteinsatzzweck des CIB workbench-Add-In ist eine komfortable Unterstützung bei der Erstellung von dynamischen Dokumentprojekten.

Eine Voraussetzung ist auch ein gemeinsames Verständnis über fachliche Begriffe die in diesem Zusammenhang häufig auftreten. Nachfolgend finden Sie ein paar Grundbegriffe erläutert, die insbesondere im Zusammenspiel der CIB workbench mit DMS Systemen (wie z.B. CIB coSys) eine Rolle spielen.

Dokumentprojekt / Vorlagenprojekt
Wurzelbaustein / Layout
Allgemeiner Textbaustein
Basisbaustein/Documentbase
Projektspezifischer Textbaustein
Zentraler oder Allgemeiner Programmbaustein
Maskendatei
Regelwerk
Mandant
Ergebnisdokument

Dokumentprojekt / Vorlagenprojekt

Mit Dokument- oder Vorlagenprojekt bezeichnet man die Gesamtmenge der an einer Vorlage beteiligten Dateien (Textbausteine, Logos, Restdatenerfassungsmasken …). Diese decken alle möglichen fachlichen Ausprägungen ab (z.B. Eingabemaske, Logikinformation u.a.).

Der spätere Anwender (Sachbearbeiter, Bearbeiter, Analyst,…) sieht als Resultat eines genutzten Vorlageprojektes nur ein fertig gemischtes personalisiertes Ergebnisdokument.

Ein Dokumentprojekt besteht mindestens aus einem Wurzelbaustein. Von dort können weitere Textbausteine verschiedenster Kategorien per Verweis eingebunden sein. Ebenso können per Verweis Grafikdateien angebunden sein. Für manche Kundenapplikationen gehören auch separate Maskendateien (i.d.R. im HTML Format) und optional separate Regelwerke (Scriptdateien) zum Umfang eines Dokumentprojektes.


Wurzelbaustein / Layout

Der Wurzelbaustein ist der Ausgangsbaustein des Dokumentprojektes. Er setzt die Seitenränder des Gesamtdokumentes. Außerdem werden noch weitere wichtige Eigenschaften durch das Wurzeldokument maßgeblich gesteuert.

  • Besondere Eigenschaften für die „Erste Seite“ bei Kopf- und Fußzeilen
  • Besondere Druckerschachteigenschaften

Wurzelbaustein

Ausgehend vom Wurzelbaustein werden weitere Bausteine angezogen.

Dies ist im Standardfall mindestens der Basisbaustein und ggf. allgemeine Bausteine (z.B. Kopfzeilen- und Fußzeilenbausteine).


Allgemeiner Textbaustein

Ein allgemeiner Textbaustein wird erzeugt, wenn der identische Inhalt in mehreren Dokumentprojekten Verwendung findet. Als aussagekräftiges Beispiel ist hier die Fußzeile mit den Angaben zu Vorstand/Adresse etc. zu nennen.



Basisbaustein/Documentbase

Beim Basisbaustein handelt es sich um einen speziellen projektspezifischen Textbaustein. Er repräsentiert den Ausgangspunkt für den fachlichen Inhalt des Dokumentprojektes und wird direkt aus dem Wurzeldokument eingebunden. Der Basisbaustein kann selbst weitere allgemeine und dokumentspezifische Bausteine einbinden. Jedes Dokumentprojekt enthält in der Regel genau einen Basisbaustein.

Übersicht Basisbausteine

Verträge oder Standardformular oder ähnlich Dokumentprojekte, teilt man sinnvollerweise in Bänder („Frames“) oder Streifen auf.


Projektspezifischer Textbaustein

Ein projektspezifischer Textbaustein ist ein Baustein, der nur in einer bestimmten Vorlage Verwendung findet. In einem Vorlageprojekt können beliebig viele projektspezifische Textbausteine eingebunden werden.

Übersicht Projekt-/Vorlagebausteine

Zentraler oder Allgemeiner Programmbaustein

Oftmals ist es sinnvoll sich für wiederkehrende Vorgänge ein paar zentrale Programmzeilen zu definieren.


Maskendatei

Ein Dokument, das sich aus vielen Textbausteinen mit variablen Anweisungen zusammensetzt, kann oft aus der aufrufenden Kundenanwendung nicht vollständig mit Daten versorgt werden. Aus diesem Grund ist eine dynamische Restdatenerfassung direkt auf Basis des aktuellen Variablenbestandes sinnvoll.

Die CIB workbench unterstützt das Erzeugen von Eingabemasken aus dem Textbausteinbestand in vielfältiger Weise und auf Basis verschiedener Dateiformate (bevorzugt HTML, PDF und RTF).


Regelwerk

Wenn ein Dokumentprojekt dynamische Eingabemasken nutzt, dann sind häufig auch zusätzliche Plausibilitätsprüfungen über die Eingabefelder innerhalb der Masken ein gewünschtes Merkmal. Diese Logik wird als Regelwerk oder Scriptcode bezeichnet und oftmals in separaten Dateien dem Dokumentprojekt hinterlegt.

Der Textorganisator wird beim Erzeugen dieser Regelwerke durch die Feldeigenschaftenmaske mit interaktiven Dialogen unterstützt.


Mandant

Institutseigene Filialen, Geschäftsstellen oder Partner mit eigenem Dokumentlayout und somit eigenem Vorrat an allgemeinen Wurzeldokumenten und Bausteinen. Es werden wenn möglich eindeutige ID-Kennzeichen innerhalb der Textbausteinnamen zur dynamischen Identifikation von Mandanten benutzt.


Ergebnisdokument

Als Ergebnisdokument wird bezeichnen das mit echten Daten angereicherte (=personalisierte) Resultat aus einer ausgewählten Vorlage und den dazu erfassten oder abgerufenen Daten in einer entsprechenden Umgebung des Sachbearbeiters (z.B. CIB webdesk) bezeichnet.


8. CIB workbench Benutzeroberfläche

Die CIB workbench präsentiert sich in einem eigenen CIB-Tabreiter in der Ribbontechnik von Microsoft. Die Untergliederung der Menüblöcke ist nach ähnlichen Kriterien wie in der Ausgabe für ältere Wordversionen gewählt. Die Funktionalität ist somit identisch für unterschiedliche Wordversionen.

Menüblock für Vorlagendesign in MS Word 2010 (XPS Edition)

Menüblock für Vorlagendesign in MS Word 2010 (XSS Edition)

Dieser Menüblock ist in vier getrennte Abschnitte untergliedert:

  • Vorlagendesign (Dokumenteigenschaften, Variablenverwaltung, häufige Feldanweisungen, Extras)
  • Textorganisation (Bausteinverwaltung/Testumgebung und Vorlagenüberprüfung)
  • Nützliche Shortcuts
  • Einstellungen der CIB workbench

 Als zusätzliche Funktionalität bietet die CIB workbench, wie alle CIB Produkte die als AddIn in Word integriert sind die Möglichkeit das Menü zu Minimieren und Maximieren, falls mehrere CIB Produkte gleichzeitig geladen sein sollten:

Durch Betätigen der Pfeile wird das gesamte Menü minimiert.

Maximiertes Menü der CIB workbench

Das minimierte Menü kann durch Betätigen des CIB workbench Icons wieder aufgeklappt werden.

Minimiertes Icon des CIB workbench Menüs


8.1. Menüblock für Vorlagendesign / Textbearbeitung

Menüpunkt „Dokumenteigenschaften“
Menüpunkt „Variablen“ / „Variablenmanager“
Menüpunkt „Feldanweisungen“
Menüpunkt „Extras“
Menüpunkt „REF Feldeigenschaften“

Menüpunkt „Dokumenteigenschaften“


Menüpunkt „Dokumenteigenschaften”


Dialogmaske „Dokumenteigenschaften“

Sie gelangen in die Maske Dokumenteigenschaften. Es handelt sich um dieselbe Maske, die Ihnen auch von Word unter Datei/Eigenschaften/Anpassen zur Verfügung steht. Hier können Sie verschiedene Dateieigenschaften festlegen oder ändern.


Menüpunkt „Variablen“ / „Variablenmanager“


Menüpunkt „Variablenmanager”

Dieser Menüpunkt öffnet den Variablenmanager. Hier werden in einer Baumstruktur alle Variablen aus der Versorgungsvorlage angezeigt. Die Variablen werden in der gleichen Reihenfolge angezeigt, in der sie in der Versorgungsvorlage stehen.

Sie können Ihrem Vorlagenprojekt auch lokal eine Datenquelle zuordnen, wenn nicht bereits durch ein umgebendes DMS geschehen. Definieren Sie dazu unter „Variablen | Datenquelle auswählen... | Hinzufügen“ eine XML- oder CSV-Datei und bestätigen Sie mit „OK“, um das Menü zu erzeugen.

Dialogfenster „Variablenmanager”

In der Variablenverwaltung stehen Ihnen alle Felder der Ihrem Vorlagenprojekt zugeordneten Datenversorgung zum Einfügen als REF-Felder zur Verfügung. Falls Sie in der Variablenverwaltung keine Einträge sehen sollten, müssen Sie zunächst eine Datenquelle festlegen. Dies wird im Folgenden Kapitel näher beschrieben.

Ab Version 2.8.186 der CIB workbench kann das Fenster des Variablenmanagers beliebig vergrößert werden. Die getroffenen Einstellungen werden beim nächsten Öffnen wieder verwendet.


Button „Datenquelle auswählen“

Klicken Sie in der Dialogmaske „Variablenverwaltung“ auf den Button „Datenquelle auswählen“ so erscheint das folgende Fenster.


Der Dialog „Datenquelle auswählen“ zeigt die dem Vorlagenprojekt zugeordnete(n) Datenquelle(n) mit ihrem jeweiligen Typen an. Näheres zu den Datenquellentypen finden Sie in Kapitel 6.3. In der Regel kann einem Vorlagenprojekt höchstens eine Datenquelle zugeordnet werden.

Bitte beachten Sie, dass für die XPS-Edition in diesem Dialog nur das Anzeigen der dem Vorlagenprojekt zugewiesenen Datenquellen möglich ist. Die Zuordnung in dieser Edition findet ausschließlich über das DMS System statt.

Bitte beachten Sie außerdem, dass es nur in der XPS Edition möglich ist, einer Vorlage mehr als eine Datenquelle zuzuordnen und die darin zur Verfügung gestellten Variablen zu verwenden. Über CIB tom können folgende Typen von Datenquellen aktiv zugeordnet werden:

  • Projektdaten
  • CSV-Datenquellen zur Generierung von Serienbriefen
  • Wiedervorlageschablonen

Weiter wird in der XPS Edition immer ein Set von in der Folgeverarbeitung gesichert versorgten Systemvariablen zur Verfügung gestellt.

Hinzufügen:
Verwenden Sie eine Edition, die es zulässt Datenquellen nicht nur über das Projekt selbst zu administrieren, so können Sie über „Hinzufügen“ im Bereich „Datenquellen verwalten“ Versorgungsvorlagen hinzufügen.


Stellen Sie für diese Funktion zunächst eine Datendatei, z. B. eine entsprechende XML– oder Multi-CSV-Datei, bereit. Wählen Sie aus der Dropdownliste den Datentyp aus, und im Falle einer Textdatei ob es sich um eine Multi-CSV-Datei handelt. Die angegebene Datei wird bei jedem Start von Word neu eingelesen und das Variablenmenü neu aufgebaut. Steht die Datei nicht zur Verfügung, so kann das Variablenmenü nicht erzeugt werden!

Bei einer Multi-CSV-Datei setzten Sie bei „Multi-Datenquelle“ ein Häkchen. Die CIB workbench erzeugt für jede Datendatei ein Untermenü mit dem Aliasnamen aus der Multi-CSV-Datei.


Individualisieren :
(XPS ab Version 2.8.184)

Über „Individualisieren“ ist es möglich, zu Testzwecken die Datenquellen zu tauschen.


Die Test-Datenquelle ist vorher im Workspace des Projektes hinterlegt worden. Sie ersetzt nun die Standard-Datenquelle des Projektes.


Button „Suchen“

Das Variablenmenü bietet eine Suchfunktion. Tragen Sie dazu in das Feld neben dem Button das zu suchendende Wort ein und klicken Sie dann auf „Suchen“. Im Variablenmenü werden nun die Treffer markiert und die dazugehörigen Gruppen aufgeklappt. Passende Treffer auf Ebene der Gruppennamen werden für ihre Suche ebenfalls gelb markiert. Für eine genauere Einschränkung der Suchergebnisse kann die Option „Groß-/Kleinschreibung beachten“ aktiviert werden. In diesem Fall werden nur Treffer mit exakter Schreibweise beachtet.



Variablen aus Wiedervorlagenschablonen (nur XPS)

In der CIB workbench kann einer Vorlage über CIB tom eine Wiedervorlageschablone zugeordnet werden. Wird eine solche Vorlage in der workbench bearbeitet, so können zusätzlich zu den Variablen der Datenquelle auch die Variablen der Wiedervorlagenschablone in das Dokument eingefügt werden. Diese Variablen stehen ebenfalls im Variablenmanager zu Auswahl:



Weitere Optionen



Felder ohne Feldattribute einfügen

Um Variablen aus der Datenquelle ohne cib-formfield-Schalter, beispielsweise zur Verwendung im reinen Druckbereich, einzufügen kann diese benutzerspezifische aktiviert werden.


Option „REF Feldnamen anzeigen“

(Ab CIB workbench Version 2.8.182)

Falls die Versorgungsvorlage die passenden Anzeigeinformationen zur Verfügung stellt, wie beispielsweise der Datenquellentyp 1b, so werden im Variablenmanager standardmäßig die sprechenden Namen der Variablen statt der technischen angezeigt.

Mit dem Aktivieren der Option „REF Feldnamen anzeigen“ ändert sich die Ansicht des Variablenmanagers. Zusätzlich zu den sprechenden Namen der Variablen werden parallel die technischen Namen (soweit vorhanden) angezeigt (vgl. Abbildung). Eine Suche in dieser Ansicht wird über alle Felder durchgeführt und farblich markiert.



Erstellen von dynamischen Tabellen aus dem Variablenmanager

(Ab CIB workbench Version 2.9.203)

Aus dynamischen Tabellen, die im Variablenmanager enthalten sind, kann automatisch eine SOLANGE-Schleife im Dokument erzeugt werden.

Das geschieht durch einen Rechtsklick auf die Tabellenüberschrift und danach anklicken von „Variablenliste generieren“:



Die Tabelle wird an Cursorposition in das Dokument eingefügt:



Menüpunkt „Feldanweisungen“

Unter diesem Menüpunkt sind alle wichtigen Feldfunktionen, die Sie für die Modellierung Ihrer Textbausteine benötigen, hinterlegt.

Die Menüfunktionen sind so gestaltet, dass Sie möglichst interaktiv geführt werden und mit möglichst vollständig vorgefertigten Feldanweisungen bei Ihrer Arbeit unterstützt werden.


Klicken Sie einfach auf einen Menüpunkt, um ein Template für eine Feldanweisung am Cursor einzufügen.

Passen Sie die Feldfunktion nun an Ihre Anforderungen an. Die genauen Spezifikationen zu den Feldfunktionen entnehmen Sie bitte der Word-Hilfe oder Ihren Unterlagen.


Menüpunkt „Baustein einfügen…“



Je nach Verzeichnisstruktur müssen Sie zunächst unter Konfiguration die verwendeten Verzeichnisse, beispielsweise für allgemeine Bausteine, einstellen. Nun stehen Ihnen alle .rtf-Dokumente aus diesen Verzeichnissen per Mausklick zur Verfügung.

Funktionen für spezifische Bausteine: Damit stehen Ihnen in jedem Dokument alle RTF-Dateien zum Einfügen zur Verfügung, die im gleichen Ordner wie das aktuelle Dokument gespeichert sind.

Beachten Sie bitte bei Unklarheiten zur Dokumentstruktur das Kapitel „Hinweise zur Verzeichnisstruktur“.

Aktivieren Sie die Vorschaufunktion so sehen Sie den aktuell markierten Baustein in dem kleinen Fenster, es ist auch eine Vergrößerung möglich unter „Große Vorschau“. Desweiteren können Sie wählen an welcher Stelle der Baustein eingebunden werden soll. Im momentan offenen Dokument an der aktuellen Cursorposition (Button „Einfügen“), in die Kopfzeile oder in die Fußzeile. Es erscheint dort folgender Befehl:

{ INCLUDETEXT "abaust2.rtf" }


Menüpunkt „neuen Baustein erstellen und einfügen…“


Wählen Sie einen Namen für den neuen Baustein und eine passende Bausteinvorlage; möchten Sie keine Vorlage nutzen, so markieren Sie einfach „leerer Baustein“. Damit Sie über diese Dialogmaske Bausteinvorlagen zum Einfügen angeboten bekommen, müssen Sie zunächst unter Einstellungen/CIB workbench Konfiguration und dort auf dem Tabreiter „Vorlagen“ allgemeine Bausteine hinzufügen. Nun stehen Ihnen alle so ausgewählten .rtf-Dokumente in der Dialogmaske „neuen Baustein erstellen und einfügen“ zur Verfügung.

Aktivieren Sie die Vorschaufunktion so sehen Sie den aktuell markierten Baustein in dem kleinen Fenster, es ist auch eine Vergrößerung möglich unter „Große Vorschau“.

Klicken Sie nun auf „Hinzufügen“ erscheint im aktuell geöffneten Dokument an der Cursorposition folgender Befehl:

{ INCLUDETEXT "NameNeuerBaustein.rtf" }

Falls Sie bei „Baustein nach dem Erstellen öffnen“ aktiviert haben, so öffnet sich der neue Baustein im Vordergrund.

Wenn Sie eine eigene Dokumentvorlage unter "Konfiguration | Eigene Vorlage nutzen" in der CIB workbench hinterlegt und aktiviert haben, so wird diese Dokumentformatvorlage automatisch mit allen neuen Bausteinen verknüpft.

Achtung:
Bei der Vergabe der Bausteinnamen sind Längen-Beschränkungen zu beachten.

Die CIB workbench orientiert sich an dem System-Standard. Das bedeutet, dass die Summe aus "Pfadlänge zu dem Baustein" und "Baustein-Namen" die Zeichen-Anzahl von 255 nicht überschreiten darf. Ansonsten kann es zu unerwünschten Effekten kommen, wie dass das Projekt nicht korrekt entpackt oder ein Baustein nicht geladen werden kann.


Menüpunkt „REF Feld einfügen

Mit diesem Menüpunkt fügen Sie einen REF Platzhalter als Feldfunktion an die aktuelle Cursorposition im Dokument ein. Wenn Sie vorher ein Wort/einen Text mit der Maus markieren, dann wird dieses Wort als Feldname mit in die REF Anweisung eingeschlossen. Es öffnet sich die Dialogmaske „Feldeigenschaften“, die im Kapitel 8.1.5 Menüpunkt „REF Feldeigenschaften“ im Detail erläutert wird.

Es kann zusätzlich noch eine Liste der bereits im RTF benutzten Variablen angezeigt werden.


{ REF AArt }


Menüpunkt „IF Feld einfügen…“

Klicken Sie direkt auf den Eintrag in der Leiste, so erscheint ein Dialogfeld, das Sie bei der Erstellung einer IF-Anweisung unterstützen soll.


Bei „Ausdruck1“ und „Ausdruck2“ legen Sie fest, welche Elemente verglichen werden sollen und bei „Operator“ wie sie verglichen werden sollen. Ist die gewählte Bedingung erfüllt, so werden die Eingaben aus dem Feld „Wenn-Wahr-Text“ ins Ergebnisdokument übernommen, ist die Bedingung nicht erfüllt, so werden analog die Eingaben aus dem Feld „Wenn-Falsch-Text“ ins Ergebnisdokument übernommen.


„varTextfeld“ soll zuvor als Textfeld definiert worden sein ({ REF varTextfeld\* <cib-formfield 

type="text" size="25" length="&lt;=60" /> }). Es wird folgender Text eingefügt:

{ IF "{ REF varTextfeld }" <> "" "{ REF varTextfeld }" "Es wurde nichts eingegeben" }


Menüpunkt „IF-Feldanweisungstemplate“

Innerhalb dieses Menüpunktes erhalten Sie eine Anweisung, welche unter einer bestimmten Bedingung ausgeführt werden soll. Markieren Sie (optional, sonst erscheint im Template als Variablenname „VARIABLE“, den Sie noch anpassen müssen) den Namen der von Ihnen gewünschten Variablen und wählen Sie anschließend im Menü Feldanweisungen den Menüpunkt IF (Feldinhalt=Wert) aus. Sofort wird der gewünschte Code an der von Ihnen vorgesehenen Stelle im Dokument eingefügt.

{ IF "REF Variable" = "Wert" "trifftzu" "trifftnichtzu" }


Menüpunkt „IF-Feldanweisungstemplate mit Checkboxlogik“

IF-Feldanweisungen werden häufig angewandt um Ankreuzfelder zu erstellen, daher gibt es die Möglichkeit, die nötigen Anweisungen als Template ins Dokument einzufügen.

{ PRINT "CIB:CNV:HTML_BEGIN" }
{ REF CheckBox\* <cib-formfield type="check" /> }
{ PRINT "CIB:CNV:HTML_END" }

{ PRINT "CIB:CNV:RESULT_BEGIN" }
{ IF "{ REF CheckBox }" = "1" "☑
" "" }
{ PRINT "CIB:CNV:RESULT_END" }

Wird in der Restdatenerfassung ein Häkchen beim Ankreuzfeld gesetzt, so erscheint im Ergebnisdokument ein ☑, sonst ein ☐. Möchten Sie einen anderen Namen verwenden, so müssen Sie an beiden Stellen, an denen der alte Name „CheckBox“ verwendet wurde, den neuen Namen eintragen.


Menüpunkt „SET-Feld einfügen…“

Anhand dieses Menüpunktes kann innerhalb eines Dokumentes an der Stelle des Cursors eine Variable gebildet bzw. verarbeitet werden (z.B. Zähler, Zwischensumme). Dieses Feld weist somit einer internen Variablen einen Wert (entweder Text oder eine Zahl) zu.
Durch Anhaken von „\*NOFORMAT Schalter hinzufügen“ kann dieser Wert zum nicht format-behafteten Wert gemacht werden


{ SET varKontonummer "123456" }


Menüpunkt „SET-Feldanweisungstemplate“

Anhand dieses Menüpunktes kann innerhalb eines Dokumentes an der Stelle des Cursors ein Template eingefügt werden, das anschließend aber noch angepasst werden muss.

{ SET VARIABLENNAME "Wert" }


Menüpunkt „COMPARE-Feld einfügen“

Dieser Menüpunkt eignet sich idealerweise zur internen Verwendung in kombinierten Abfragen (z.B. UND, ODER, MAX, MIN). Es werden zwei Werte miteinander verglichen. Der numerische Wert 1 wird geliefert wenn der Vergleich wahr ist oder 0 wenn der Vergleich falsch ist. Bei den Ausdrücken der zu vergleichenden Werte kann es sich um Feldnamen, Zeichenfolgen, Zahlen, geschachtelte Felder, die einen Wert zurückgeben, oder mathematische Formeln handeln.


{ COMPARE "{ REF varKontonummer }" = "100000" }


Menüpunkt „INCLUDETEXT“

Mit Hilfe dieses Menüpunktes können Grafiken und Text aus dem benannten Dokument eingefügt werden. Lediglich das Einfügen des gesamten Dokumentes ist möglich. Es kann auch der einzufügende Dokumentname zur Laufzeit aus REF-Anweisungen zusammengesetzt werden. Wurde ein Dokumentname mit der Maus markiert, wird dieses Dokument als das Einzufügende markiert. Für Grafiken ist es jedoch besser die INCLUDEPICTURE-Anweisung zu nutzen.

{ INCLUDETEXT "datei.rtf" }


Menüpunkt „INCLUDEPICTURE“

Mit Hilfe dieser Anweisung wird eine Grafik eingefügt. Den Dateinamen der Grafik müssen Sie per Hand anpassen. Alternativ zur Workbench kann auch über das Menü Einfügen eine Grafik eingebunden werden. Gehen Sie über „Einfügen“ zum Menüpunkt „Grafik“ anschließend „Aus Datei“. Wählen Sie die gewünschte Grafik und fügen Sie sie über „Einfügen u. Verknüpfen“ ein.

{INCLUDEPICTURE "bild.jpg"}


Menüpunkt „CIBDOCUMENTBASE einfügen“ (Nur In XPS Edition)

Wenn Sie eine CIB workbench Edition mit hierarchischer Verzeichnisstruktur verwenden, benötigen Sie in Ihrem Wurzeldokument diesen Befehl an der Stelle, an der die neue Vorlage eingebunden werden soll. In der Variablen „CIBDOCUMENTBASE“ steht der Name der Vorlage.

{ INCLUDETEXT "{ REF CIBDOCUMENTBASE }" }


Menüpunkt „SOLANGE – Schleife einfügen…“

Die SOLANGE-Schleife wird vor allem zur Erzeugung von dynamischen Tabellen eingesetzt. Sie stellt eine CIB eigene Erweiterung der IF-Anweisung dar. Im DANN-Teil einer SOLANGE-Schleife sollte immer eine Fortschaltung der in der IF-Prüfung verwendeten Ausdrücke vorhanden sein, wie beispielsweise eine NEXT-Anweisung. Ansonsten kann als Resultat eine Endlosschleife bei der Text-/Datenintegration auftreten.


In dieser Maske kann man sich seine SOLANGE-Schleife selbst ganz einfach zusammenklicken. Die Auswahlbox "Name der Datenquelle der Schleife" zeigt die Auflistung der dynamischen Tabellen, welche sich in der ausgewählten bzw. zugeordneten Datenquelle befinden. Des Weiteren ist es auch möglich seine eigene dynamische Tabelle zu definieren. In der Liste "Variablen aus der dynamischen Tabellen" finden Sie eine Auflistung aller Variablen, welche in der SOLANGE-Schleife verwendet werden können. Hier kann ausgewählt werden welche Variablen sich in SOLANGE-Schleife befinden sollen. Durch den Auswahlpunkt "Datensatz zuvor zurücksetzen" werden automatisch zwei NEXT Befehle eingefügt, siehe Menüpunkt 8.1.3.14. Es ist auch möglich eine Titelleiste/Überschrift für die SOLANGE-Schleife einzustellen.

{ IF { MERGEREC ?kunde } <> 0

DANN

{NEXT kunde}

\* SOLANGE }


Menüpunkt „NEXT-Funktion Datensatz zurücksetzten…“

Möchten Sie wieder auf den ersten Datensatz zurück springen, so benötigen Sie folgenden Befehl, den Sie einfach über diesen Menüpunkt einfügen können:

{ NEXT -kunde }{ NEXT kunde }

Dies ist nützlich, wenn Sie einen Datensatz z: B. in einer Schleife schon mal durchlaufen haben und diesen aber nochmals vom ersten Eintrag an benötigen.

Der Name der zurückzuschaltenden Schleife ist zwingend anzugeben. Wenn Sie alle Daten zurücksetzen möchten, vergeben Sie für das Einfügen einen willkürlichen Namen und löschen Sie ihn anschließend aus beiden Feldanweisungen.



Menüpunkt „{=<UNTERFUNKTIONEN>(,Ausdruck,)}“

(ab CIB workbench Version 2.8.188)


Alle Datums-, Logischen-, Rechen- und Text-Funktionen sind jetzt in einer eigenen Maske zusammengefasst.


Mit der Version 2.8.196 stehen dem Anwender eine ganze Reihe Datumsfunktionen zur Verfügung. Dabei handelt es sich im Einzelnen:

ADDDAYS

Tage addieren:

Zu einem Datum bzw. dem Wert einer Datums-Variablen wird eine bestimmte Anzahl an Tagen addiert und in einem gewünschten Format ausgegeben.

ADDMONTHS

Monate addieren:

Zu einem Datum bzw. dem Wert einer Datums-Variablen wird eine bestimmte Anzahl an Monaten addiert und in einem gewünschten Format ausgegeben.

ADDYEARS

Jahre addieren:

Zu einem Datum bzw. dem Wert einer Datums-Variablen wird eine bestimmte Anzahl an Jahren addiert und in einem gewünschten Format ausgegeben.

ADDWORKINGDAYS

Werktage addieren:

Zu einem Datum bzw. dem Wert einer Datums-Variablen wird eine bestimmte Anzahl an Werktagen addiert und in einem gewünschten Format ausgegeben.

Dabei werden optional die vom Anwender spezifizierten Feiertage berücksichtigt.

Zusätzlich kann angegeben werden, mit wie vielen Werktagen die Arbeitswoche zu rechnen ist. Als Standard wird 5 Werktage die Woche angenommen.

SUBTRACTDAYS

Tage subtrahieren:

Von einem Datum bzw. dem Wert einer Datums-Variablen wird eine bestimmte Anzahl an Tagen subtrahiert und in einem gewünschten Format ausgegeben.

SUBTRACTMONTHS

Monate subtrahieren:

Von einem Datum bzw. dem Wert einer Datums-Variablen wird eine bestimmte Anzahl an Monaten subtrahiert und in einem gewünschten Format ausgegeben.

SUBTRACTYEARS

Jahre subtrahieren:

Von einem Datum bzw. dem Wert einer Datums-Variablen wird eine bestimmte Anzahl an Jahren subtrahiert und in einem gewünschten Format ausgegeben.

GETDAYDIFF

Differenz in Tagen berechnen:

Mit Hilfe einer Funktion wird die Differenz zwischen 2 Datumswerten in Tagen berechnet. Dabei liefert die Funktion immer eine Ganzzahl zurück.

GETMONTHDIFF

Differenz in Monaten berechnen:

Mit Hilfe einer Funktion wird die Differenz zwischen 2 Datumswerten in Monaten berechnet. Dabei liefert die Funktion immer eine Ganzzahl zurück.

GETYEARDIFF

Differenz in Jahren berechnen:

Mit Hilfe einer Funktion wird die Differenz zwischen 2 Datumswerten in Jahren berechnet. Dabei liefert die Funktion immer eine Ganzzahl zurück.

GETLASTOFMONTH

Letzter Tag im Monat:

Diese Funktion ermittelt den letzten Tag im Monat zu einem vorgegebenen Datum.

GETFIRSTOFMONTH

Erster Tag im Monat:

Diese Funktion ermittelt den ersten Tag im Monat zu einem vorgegebenen Datum.

GETLASTOFQUARTER

Letzter Tag im Quartal:

Diese Funktion ermittelt den letzten Tag im Quartal zu einem vorgegebenen Datum.

GETFIRSTOFQUARTER

Erster Tag im Quartal:

Diese Funktion ermittelt den ersten Tag im Quartal zu einem vorgegebenen Datum.

GETLASTOFLASTMONTH

Letzter Tag des letzten Monats:

Diese Funktion ermittelt den letzten Tag des Vormonats zu einem vorgegebenen Datum.

GETFIRSTOFNEXTMONTH

Ersten Tag des nächsten Monats:
Diese Funktion ermittelt den ersten Tag des nächsten Monats zu einem vorgegebenen Datum.


Beispiele und die detaillierte Beschreibung des Funktions-Aufbaus sind in den jeweiligen Funktionsmasken enthalten.

Hier als Beispiel die Maske der ADDMONTHS-Funktion:


Bei dieser Funktion handelt es sich um eine binäre Und-Verknüpfung. Sie liefert den Wert 1 (TRUE), wenn von zwei Ausdrücken beide wahr sind, oder den Wert 0 (FALSE), wenn einer der Ausdrücke falsch ist. { = AND(0;1) } liefert 0, { = AND(1;1) } liefert 1

Ist es notwendig, mehr als zwei Argumente zu übergeben, muss anstelle der AND-Funktion die MIN-Funktion verwendet werden.