CIB doXiview technischer Leitfaden
Erste Schritte bei der Verwendung von CIB webEdit in CIB doXiview
Bisher wurden Wege beschrieben, die es ermöglichen, Dokumente anzuzeigen. Darüber hinaus ist es aber auch möglich, definierte Dokumentbereiche in RTF Dokumenten (RTF-Snippets) zu editieren. Eine vollständige Dokumentation des Anwendungsfalls ist in der Dokumentation „CIB doXiview – Integration CIB webEdit“ enthalten.
Anbei folgt eine Kurzanleitung mit den wichtigsten Punkten zur Verwendung von CIB webEdit:
1) Einrichten des CIB elementstores
Die editierbaren RTF-Snippets werden in einer zentralen Datenbank, dem sogenannten „CIB elementstore“, hinterlegt. CIB doXiview speichert dort Freitextbereiche und CIB webEdit lädt diese, damit sie mittels CIB webRec editiert werden können.
Zum
Einrichten der Tabellenstrukturen nutzen Sie bitte das beigelegte SQL-Skript:
create-tables.sql
2) Deployment und Konfiguration von „CIB webEdit“
Nachdem der CIB elementstore eingerichtet wurde, muss er den Web-Applikationen bekannt gemacht werden. Dies geschieht über Konfigurationseinstellungen in der folgenden Datei:
webedit/WEB-INF/classes/environment-config.properties
In der gleichen Datei muss zusätzlich konfiguriert werden, wo CIB webEdit deployt wurde:
elementStore.url = @elementStore.cdnhost@/webedit/api/v1
Wird CIB webRec nicht im selben Applicationserver deployt wie CIB webEdit (siehe Punkt 3), so muss zusätzlich die Basis-Url von CIB webRec über die Property webrec.url konfiguriert werden.
3) Deployment und Konfiguration von „CIB webRec“
Die .war Datei von CIB webRec kann in einem beliebigen Applicationserver deployt werden.
4) Konfiguration von „CIB doXiview“
Da CIB doXiview ebenfalls Zugriff auf den CIB elementstore und auf CIB webEdit benötigt, sind Anpassungen in der folgenden Konfigurationsdatei notwendig:
doxiview/WEB-INF/classes/environment-config.properties
Bitte tragen Sie dort analog zum CIB webEdit Projekt die Konfigurationswerte ein.
5) Integration von CIB doXiview über CIB iwc.
Die Integration von CIB doXiview durch die Kundenanwendung über CIB iwc wie in Abschnitt CIB doXiview technischer Leitfaden beschrieben, ist Voraussetzung für diesen Anwendungsfall. Beim Öffnen des Viewers wird CIB doXiview über die JavaScript-Schnittstelle nach Startparametern fragen.
Die von CIB doXiview angeforderten Startparameter müssen als JSON-Objekt der folgenden Struktur entsprechen:
var startParameters = {
"loginContext": {
"userId": "test-userId",
"clientId": "test-clientId",
"clientIdEffective": "test-clientIdEffective"
},
"webedit": {
"editorName": "CIB webRec"
},
"doxiview": {
"uistyle": "cib",
"ui": "webedit",
"isSnippetEditingAllowed": "true",
"isWebeditFullsize": "false",
"propagateDocumentVersionUpdates": "false",
"repo_alias": "http-repository",
"urlField": "http://localhost:8080/test.rec_multipage.rtf",
"ext": "rtf"
}
};
Wichtig sind hier vor allem die folgenden neuen Startparameter:
Startparameter |
Wert |
loginContext |
Informationen über den Benutzer. |
editorName |
Spezifiziert den Editor für die Freitextbearbeitung. Durch die Angabe von „CIB webRec“ wird der konfigurierte Webeditor verwendet. |
isSnippetEditingAllowed |
Erlaubt / Verbietet das Editieren von RTF-Snippets |
isWebeditFullsize |
Bestimmt, ob der Editor den gesamten Viewer-Bereich überlagern soll. |
Mit diesen wenigen Schritten sollten Sie bereits in der Lage sein, RTF-Snippets zu editieren. CIB doXiview wird versuchen über weitere JavaScript Callbacks Informationen an seinen Integrator zu kommunizieren. Detail-Informationen dazu finden Sie in der Dokumentation:
„CIB doxiview – Integration CIB webEdit“