Allgemein

CLARC ENTERPRISE 5 schreibt die in den Vorgängerversionen bewährten technischen Prinzipien fort. Alle Dienste verwenden die selben Verfahren und die Konfiguration der einzelnen Dienste und Szenarien, sowie die Informationen zu den im Prozess befindlichen Inhalten werden in gleicher Weise in einer zentralen Datenbank gespeichert. Bei einem Update von Version 4 gilt es jedoch einige wichtige Dinge zu beachten, um dieses erfolgreich durchführen zu können.

Ein Update von Version 4 ist kein Problem, auch wenn die unten beschriebenen Hinweise umfangreich sind. CLARC ENTERPRISE hat sich strukturell nicht verändert und bestehende Konfigurationen inkl. des Scriptings sind ohne weiteres kompatibel. Einige Neuerungen gilt es aufgrund der 64 Bit Variante und einiger Änderungen in den Engines jedoch zu beachten. Unter Beachtung der Hinweise zu Version 5 sollten alle Szenarien nach einem Update wieder verwendbar sein.

Als wesentliche Änderung der Version 5 gegenüber den Vorgängerversionen ist zunächst die Bereitstellung in einer 64 Bit-Version anzuführen. Die Installation erfolgt nun grundsätzlich auch in dieser Variante. Eine Installation in der 32 Bit-Variante ist aber nach wie vor möglich, aber sofern keine Dinge vorliegen, welche die Installation in 32 Bit Variante notwendig machen, nicht empfohlen. Die Unterscheidung zwischen 64 und 32 Bit bei der Installation und im Betrieb ist insbesondere jedoch am Client zu beachten. Hierzu bitte auch die Hinweise zur neuen Version beachten.

Checkliste

Schritt
Liegt eine aktualisierte Lizenz für CLARC ENTERPRISE vor?
Besteht die Möglichkeit, das Update zunächst auf einem dem Produktivsystem nahekommenden Testsystem durchzuführen?
Sind alle Jobs zu Ende verarbeitet?
Ist ausreichend Platz in der Datenbank?
Wo liegt die bestehende Installation ("C:\Program Files (x86)\")?
Sollen alte Userexits zunächst weiterverwendet werden?
Haben alle verwendeten Conversion Engines eine Entsprechung in Version 5?
Sind vor einer Umstellung auf 64 Bit die Konfigurationen für alle entfallenen Engines dokumentiert?
Bestehen Datensicherungen der Datenbank und des clarc enterprise Serververzeichnisses?

Vorbereitungen

Bereitstellung CLARC ENTERPRISE 5 Lizenz

Für ein Update einer Installation von CLARC ENTERPRISE Version 4 auf 5 wird eine neue Lizenz benötigt. Kunden und Partner erhalten diese Lizenz im Rahmen eines gültigen Wartungsvertrages kostenfrei über license@cto.de.

Alle Jobs zu Ende verarbeiten

Vor dem Update auf Version 5 sollten alle im System befindlichen Aufträge fertig abgearbeitet und exportiert sein und keine neuen mehr einlaufen.

Datenbank prüfen

wichtiger Hinweis
Mit CLARC ENTERPRISE 5 steigen die Anforderungen an den Speicherplatz der Datenbank! Aus diesem Grund werden die Microsoft SQL Server Express Edition in den Versionen vor Version 2008 R2 nicht mehr unterstützt!

Microsoft SQL Server Version prüfen

Microsoft SQL Server Express Edition Version	maximale Datenbankgröße
2005 (nicht mehr untersützt)	4 GB
2008 (nicht mehr untersützt)	4 GB
2008 R2	10 GB
2012	10 GB
2014	10 GB

Freien Speicher der Datenbank prüfen

Wichtiger Hinweis

Vor einem Update auf CLARC ENTERPRISE Version 5 sollte die Datenbank noch eine verfügbare Mindestkapazität von 2 GB verfügen!

CLARC ENTERPRISE hat als solches keine großen Ansprüche an die Datenbank, da kaum eine dauerhafte Anlage von Informationen erfolgt. Lediglich die eigenen Konfigurationsdaten werden dauerhaft in der Datenbank geführt. Teil dieser Konfigurationsdaten sind aber Abbilder von Enignes, welche in der Datenbank abgelegt sind. So hat die Datenbank ohne Bewegungsdaten in einem durchschnittlich konfigurierten System bisher eine Größe zwischen 0,5 und 1 GB. Vor allem die Konfigurationsdatenbank, sprich die entsprechende Tabelle, kann aber durchaus sehr groß sein. Der unscheinbare Knoten "LibraryData" enthält jeweils ein komplettes Abbild des verwendeten Standes der im übergeordneten Knoten konfigurierten Engine bzw. des Userexits.

CLARC ENTERPRISE legt bei jedem Update ein Backup der von diesem betroffenen Datenbanktabellen an. Zum einen als XML-Export der Konfigurationsdatenbank in das Backup-Verzeichnis der bestehenden CLARC ENTERPRISE Installation. Zum anderen werden die Tabellen in der Datenbank als Kopie hinterlegt:

Bei dieser CLARC ENTERPRISE Installation ist die Datenbank mit den Backup-Tabellen über 4GB groß! Nach dem Bereinigen betrug die Größe der Datenbank 0,3 GB.

Ab CLARC ENTERPRISE Version 5 werden zu jeder Engine zwei Abbilder der jeweiligen Engine- bzw. Userexit-DLL in der Datenbank hinterlegt, einmal für die 32 Bit und einmal für die 64 Bit Variante. Zusammen mit einer aus der Entwicklungsumgebung resultierenden Vergrößerung der Assemblies ergibt sich eine erhebliche Vergrößerung der Konfigurationstabelle in der Datenbank. So kann eine bisher nur 0,5 GB große Tabelle in CLARC ENTERPRISE Version 5 1,5 GB in Anspruch nehmen!

Wichtiger Hinweis

Löschen Sie die Backup-Tabellen vorheriger Update-Installationen.

Entscheidung für 32 Bit oder 64 Bit

CLARC ENTERPRISE steht in Version 5 für Server und Client in einer 32 Bit und in einer 64 Bit bereit. Am Server wird die Installation in 64 Bit empfohlen. Die Installation ist jedoch auch in 32 Bit möglich. Ist die Weiterverwendung von Engines und Userexits der Vorgängerversion notwendig, ist die Installation der 32 Bit Version sogar notwendig. Am Client hängt die Entscheidung für die Installation der 32 Bit oder 64 Bit Variante der jeweiligen Clientkomponente zum einen von der Plattform, sprich vom installierten Betriebssystem, von der Notwendigkeit zu Scannen und von der installierten Officevariante ab.

Grundsätzlich wird die Installation der 64 Bit Variante empfohlen. Allerdings kann aus verschiedenen Gründen eine Installation der 32 Bit Variante sinnvoll erscheinen. So etwa, wenn Userexits zunächst weitergenutzt werden sollen. Bei der Entscheidung für eine Variante müssen also die bestehenden Szenarien beachtet werden.
Folgende Fragen sind zu stellen:

Frage	Aussage	Konsequenz
Ist am Server noch eine Systemumgebung in 32 Bit installiert?	Ja	Der Betrieb von CLARC ENTERPRISE wird auf diesem System nicht mehr unterstützt. (ab Windows Server 2008 R2 unterstützt Microsoft nur 64 Bit Installationen)
Müssen bestehende Userexits vorübergehend weiterverwendet werden?	Ja
Wenn ja, ist in Zukunft noch der Aufruf des Konfigurationsdialoges notwendig?	Ja	Die Installation des Servers in der 32 Variante ist möglich und erlaubt den Zugriff auf Konfigurationsdialoge. Die Umstellung auf 64 Bit sowie die Umstellung der Userexits auf die neue Userexit-Struktur, ist die bessere Lösung. Wichtiger Hinweis Bei 32 Bit Engines aus CLARC ENTERPRISE Version 4, die unter 5.0 weitergenutzt werden sollen, kann die Konfiguration nur aufgerufen werden, wenn der Capture Server und mit ihm das Capture Configuration Center in der 32 Bit Variante installiert wurde.
Ist die Weiterverwendung einer in Version 5 entfallenen Conversion Engine geplant?	Ja	Eine Weiterverwendung von Conversion Engines aus Version 4.3 ist technisch möglich, es besteht aber kein Support.
Wenn ja, ist in Zukunft noch der Aufruf des Konfigurationsdialoges notwendig?	Ja	Die Installation des Servers in der 32 Variante ist möglich und erlaubt den Zugriff auf Konfigurationsdialoge. Die Umstellung auf 64 Bit sowie die Umstellung der nicht mehr unterstützten Conversion-Engines auf eine Alternative ist die bessere Lösung.
Die Installation des bestehenden Systems liegt unter "C:\Program Files (x86)\" und soll mit dem Update auf 64 Bit umgestellt werden?	Ja	Die Installation wurde im Standardprogrammordner für 32 Bit Programme vorgenommen. Grundsätzlich kann in diesem Order auch ein 64 Bit Programm problemlos installiert werden. Um der Systemkonvention gerecht zu werden, sollte die Installation auf einen alternativen Pfad umgezogen werden.
Die Installation liegt unter "C:\Program Files\" und soll mit dem Update auf 64 Bit umgestellt werden?	Ja	Die Installation liegt bereits in einem korrekten Verzeichnis, das Update kann ohne weiteres erfolgen.
Die Insallation liegt in einem eigenen, separaten Verzeichnis?	Ja	Hier spielt die Unterscheidung nach 32 Bit bzw. 64 Bit keine Rolle, das Update kann ohne weiteres erfolgen.

Dokumentation bestehender Engine Konfiguationen

Nach einer Umstellung auf 64 Bit können die bestehenden Konfigurationen für nur in 32 Bit verfügbare Engines im Capture Configuration Center nicht mehr aufgerufen werden. Die bestehende Konfiguration sollte daher grundsätzlich gut dokumentiert werden!

Nicht für alle Engines besteht nach einem Update auf CLARC ENTERPRISE Version 5.0 ein 1:1 Nachfolger. Bitte beachten Sie hierzu die oben angegebenen Hinweise. Sofern eine Installation in 64 Bit vorgenommen wird, können die bestehenden Engine-Konfigurationen nicht mehr aufgerufen werden. Problematisch ist dies, bei Engines, die entfallen sind, bzw. für solche die eine Alternative notwendig machen. Hier ist zu empfehlen die bestehenden Konfigurationen ausreichend zu dokumentieren, so dass man diese nach dem Update nachvollziehen kann. Wie eine Dokumenation erstellt werden kann, ist hier Erstellen einer Enigne Dokumentation beispielhaft erläutert.

Datensicherung der Datenbank und des CLARC ENTERPRISE-Serververzeichnisses

Es ist zu empfehlen, vor einem Update sowohl die Datenbank als auch das Programmverzeichnis von CLARC ENTERPRISE zu sichern.

Durchführen des Updates

Umstellung Testsystem

Grundsätzlich gilt die Empfehlung die Umstellung zunächst an einem möglicherweise bestehendem, der Produktivumgebung nahekommenden Testsystem durchzuführen.

Update durchführen

Nun kann das Update wie gewohnt durchgeführt werden. In Abhängigkeit der oben geschilderten Themen bezüglich der 32 Bit oder 64 Bit Variante muss das Setup aller Haupt- und Teildienste entsprechend gestartet werden.
wichtiger Hinweis

Im CD-Menü ist für die Serverkomponenten der Aufruf der Setups nur für 64 Bit vorgesehen, da dies die empfohlene Variante ist.
Im ISO finden sich unter dem Pfad "\setups\server32Bit\" die Einzelaufrufe für die Installation der Serverkomponenten in 32 Bit.
Alle Module müssen bei einer Installation des Capture Enterprise-Dienstes natürlich auch in 32 Bit installiert werden!

Besonderheiten beim Durchführen der Installation sind an sich nicht zu beachten. Es sollten alle Dienste mit einem Mal aktualisiert werden, also alle notwendigen Setups hintereinander erfolgen, da die 64 Bit Version des Enterprise-Dienstes die jeweilige 32 Bit Version der Teildienste aus CLARC ENTERPRISE 4 nicht korrekt verwalten kann.

LDAP Konfiguration aktualisieren

Bei einem Update von Version 4 auf 5 muss die LDAP Konfiguration im ASE Config-Dialog aktualisiert werden.

Starten der Serverdienste

Nach einem erfolgreichen Update sollten die Serverdienste korrekt starten. Aufträge sollten allerdings noch nicht verarbeitet werden. Um Anmeldungen zu verhindern, kann nach einer erfolgreichen Anmeldung im /wiki/spaces/CD/pages/1650724 der ASE-Dienst über das Web-Center beendet werden.

Umstellen der Engines

Der nächste wichtige Schritt ist die Umstellung der bestehenden Engines und Userexits. Hier ist zu beachten, dass einige Änderungen bei Engines und Userexits erfolgt sind. Bis auf wenige Ausnahmen haben die Engines nun einen anderen, etwas sprechenderen Dateinamen. Einige Engines wurden strukturell umgestellt bzw. zusammengefasst und einige sind entfallen. Bitte hierzu die Informationen zu Was ist neu beachten.

Wichtiger Hinweis

Werden Engines oder Userexits neu benannt oder neu angelegt, bitte nicht vergessen, diese in den entsprechenden Szenarien neu zuzuweisen!

Umstellung von Engines mit 1:1 Entsprechung

Angabe einer 64 Bit DLL

CLARC ENTERPRISE 5 Dienste und Clients werden auf aktuellen Systemen im Standard in der 64 Bit Variante installiert. In verschiedenen Situationen ist aber noch die Installation eines 32 Bit Clients notwendig. 32 Bit Clients können die Engines (etwa Recognition Engines) und Userexits nicht laden und benötigen eine 32 Bit Version. Nach einem Update von Version 4 sind in CLARC ENTERPRISE 5 zunächst nur die 32 Bit konfiguriert. Ihre 64 Bit Entsprechung muss nun entsprechend angegeben werden.

Wichtiger Hinweis

Bei einigen Engines wurde nur der Name bzw. der Dateiname der DLL nur ein wenig geändert, es ist jedoch wichtig auch bei diesen die aktuelle 32 Bit als auch die jeweilige 64 Bit Engine anzugeben, wie etwa z.B. beim SAPMOD Export (ccezsapmodexport.dll).

Um die Engine umstellen zu können, ist auf der jeweiligen Engine im Configuration Center das Kontextmenü aufzurufen und dort die Funktion "Edit" aufzurufen.

Während sich im Reiter Engine/Win32 eine konfigurierte Engine finden lässt, wird unter Win64 keine Angabe zu finden sein. Hier ist nun die 64 Bit Version der Engine anzugeben. Weiter ist zum einen zu prüfen, ob unter Win32 die aktuelle Engine eingestellt ist (Achtung! Namensänderungen). Zum anderen ist sicherzustellen, dass beide Einträge auf die gleiche Engine verweisen.

Umstellung auf neue Engines

Einige Engines wurden strukturell erheblich umgestellt. So wurden etwa die Recognition Engines für die OCR in eine gemeinsame zusammengefasst. Hier ist zu empfehlen, eine neue anzulegen und zu konfigurieren, sowie die bestehende zu löschen. Falls nicht, ist unbedingt der Konfigurationsdialog aufzurufen und die Konfiguration mit OK zu bestätigen.

Anpassung Remotequery-Userexit

Der Remotequery Userexit funktioniert grundsätzlich wie bisher. In Version 5 wurde aber im Vergleich zur Version 4 das Kommunikationsprotokoll grundlegend geändert. So ist nur noch ein Port zu konfiguieren und die Kommunikation erfolgt nun per Http. Zudem ist nun eine Authentifizierung anzugeben. Das erlaubt den Zugriff von einem Client eines Testsystems auf den Remotequery-Dienst einer Produktivumgebung. Alle weiteren Einstellungen eines Remotequery-Userexits sind kompatibel. Nach Durchführung der unten angegebenen Schritte sollte der neue Remotequery Userexit genau so funktionieren, wie der alte vorher.

Schritte zur Umstellung:

Umstellen auf die neue DLL (siehe Umstellung auf neue Engines weiter oben, hier kann die bestehende Konfiguration aber erhalten bleiben)
Aufruf der Konfiguration
Angabe eines CLARC ENTERPRISE-Benutzers zur Authentifizierung

4. Bestätigen der Konfiguration mit OK
5. Refresh des Server-Caches
6. nach Umstellung aller Engines gegebenenfalls Neustart des Capture Enterprise Dienstes

Umstellung von entfallenen Engines

Einige Eninges sind in Version 5 ohne direkten Ersatz entfallen. Es gibt jedoch für alle entfallenen Engines (bis auf die im EASY Umfeld nicht verwendeten) ein alternatives Vorgehen.

Umstellung Recognition Engines

Die Umstellung der Recoengines ist relativ einfach. Hier ist eine neue Engine mit der nun gemeinsamen OCR Recognition Engine zu erstellen und zu konfigurieren. Entgegen dem Vorgänger ergeben sich nun mehr Möglichkeiten der Anpassung. Im Konfigurationsdialog ist nun das entsprechende OCR-System zu wählen. Die Einstellungen ohne den nun möglichen Expertenmodus sollten, bezogen auf das jeweilige OCR System, einen Betrieb wie in CLARC ENTERPRISE Version 4 erlauben.

Umstellung EASY Documents SOAP Userexit

Mit CLARC ENTERPRISE Version 5.0 entfällt der bisher in Version 4 gern genutzte Documents SOAP Userexit zugunsten einer Integration in die Remote-Query Integration. Im Folgenden soll nun kurz anhand eines Beispiels beschrieben werden, wie der Umstieg zu Remote Query erfolgen kann. Zunächst ist die bestehende Konfiguation gut zu dokumentieren. Hierzu ist einfach die vorher erstellte Konfiguration des bisherigen Userexits in Version 4 heranzuziehen.

Erstellen der Dokumentation

Um die Konfiguration dokumentieren zu können, ist zunächst die Engine Konfiguration aufzurufen. Dies erfolgt je nach Engine über einen Doppelklick auf den entsprechenden Knoten unterhalb des jeweiligen Engine-Types, in unserem Fall ist es ein Knoten unterhalb von Userexits.

Anschließend sollten alle Reiter der erscheinenden Maske mit einem Screenshot festgehalten werden. Auch der Name des Userexits ist festzuhalten, hier kann, sofern der Knoten markiert ist, mit F2 der Umbennungsdialog aufgerufen werden. Dann einfach den Inhalt mit Copy & Paste übertragen.

Anlage der Remote Query-Connection

Unter Software\Remotequery ist über das Kontextmenü der Dialog zu Anlage einer Verbindung aufzurufen.

Im nun folgenden Dialog ist nun ein Name für eine Verbindung anzugeben und der Verbindungstyp festzulegen. In diesem Fall ist nun "EASY Documents" auszuwählen. Die Verbindungsdaten zum Document SOAP-Server werden nun nicht mehr am Userexit hinterlegt sondern an der Remote Query-Verbindung. Diese Verbindung kann auch für weitere Userexits verwendet werden, welche das gleiche System verwenden.

Im Reiter "EASY Documents" sind nun die Verbindungsparameter zu hinterlegen. Hier können die Einstellungen aus dem Reiter "Basics" des bisherigen Userexits übernommen werden.

Umbenennen oder Löschen des alten Userexits

Der nach dem Update noch bestehende Userexit kann nun gelöscht (Klick mit rechter Maustaste auf "\Engines\Userexit
[alter Userexit]") werden, auf jeden Fall aber muss er umbenannt werden.
Einrichten des neuen Remotequery Userexits

Über das Kontextmenü des Knotens "Userexits" ist nun ein neuer Userexit anzulegen.

Dieser muss den Namen des alten Userexits erhalten.

Nun ist unter Engines jeweils für 64 Bit und 32 Bit die Engine "ccremotequeryuserexit.dll" auszuwählen. Die Konfiguration ist dann mit "OK" zu bestätigen.

Konfiguration des neuen Userexits

Mit einem Doppelklick auf den neu eingerichteten Userexit ist nun die Konfiguration des Userexits aufzurufen.

Im ersten Reiter sind nun die Verbindungsparameter zum Remote Query Service der CLARC ENTERPRISE Installation anzugeben. Neu ab CLARC ENTERPRISE Version 5 ist, dass der Benutzer sich nun gegen den Remote Query-Dienst zu authentifizieren hat. Hier sind die Daten eines CLARC ENTERPRISE Benutzers anzugeben.

Definition der Query-Parameter

Mit der Umstellung des Zugriffs auf Documents im Rahmen eines eigenen Userexits auf Remote Query ändert sich auch die Defintion der Abfrage und die Zuordnung der Maskenfelder zu Inhalten. Grundsätzlich verhält sich Remotequery so, als würde es auf eine Datenbank zugreifen. Die Abfrage wird nun tatsächlich als Select formuliert und die Bedingungen der Suche wird in einem Where-Teil dieses Selects definiert.
Die Defintion der Abfrage erfolgt im Reiter "Query":

Aufbau des Selects:
SELECT [Feldliste<Feld1>,<Feld2>,<Feldn>] FROM documents.[Mappentyp] WHERE [<Feldname>{=,LIKE} <Feldwert> ][AND,OR] ... ORDER BY <Feldname> [ASC,DESC]
Der Aufbau des Selects erklärt sich aus folgender Darstellung. Wichtig ist, dass die Felder in Documents vorhanden sind. Der Mappentyp wird mit dem Präfix "documents" angegeben.

Beispiel:
SELECT EmpNumber, EmpLastName, EmpFirstName, EmpId,
DlcFile_LastModified, DlcFile_LastEditor, DlcFile_Created, DlcFile_Owner
FROM documents.ehrEmp
WHERE EmpClientId=1 AND EmpState='released'
ORDER BY EmpLastName

Zuordnung der Maskenfelder für die Übernahme

Im Reiter Assignment werden die Felder des Selects nun Maskenfeldern zugeordnet.

Updates von Clients

Für das Update von Clientsystemen gibt es kaum Regeln zu beachten, die Installation und Einrichtung ist unproblematisch.

EWORK

Es wird dringend empfohlen, eWork Clients in 32 Bit zu installieren, da Scanner bisher keinen 64 Bit Betrieb unterstützten. Mit der Installation der 32 Bit Version bleiben auch die getroffenen Einstellungen erhalten.

OFFICECAPTURE

Die Auswahl, ob man am Client eine 32 Bit oder 64 Bit Version installiert, hängt zu allererst von der installierten Office-Plattform ab. Hier sollte die entsprechende Plattform gewählt werden.

PRINTCAPTURE

Hier kann die Entscheidung dem Setup überlassen werden. Der printCapture Client wird entsprechend der Betriebssystemplattform installiert.

Browser nicht unterstützt