CIB doXiview - Beschreibung der Start Parameter

Über dieses Dokument

Dieses Dokument enthält Informationen über die verfügbaren Start Parameter und deren gültigen Werte, zur Konfiguration von CIB doXiview.

Ziel dieses Dokuments ist es, die benötigten Informationen für die Anbindung und die Konfiguration von CIB doXiview in eine integrierende Anwendung darzustellen, und die Integration zu erleichtern.

CIB doXiview Parameter: Allgemein

CIB doXiview kann, abhängig vom Aufruf, Parameter aus zwei unterschiedlichen Quellen annehmen:

• Über die URL, üblicherweise über die Adresszeile des Browser angegeben
• Über Start Parameter, die über das IWC-framework an doXiview übergeben werden.

Start Parameter sind vergleichbar mit URL Parametern, da diese ebenfalls als Schlüssel / Wert Paare festgelegt sind. Der Unterschied besteht allerdings darin, dass Start Parameter mittels JavaScript von der Anwendung übergeben werden, die doXiview einbettet.

IWC Modus

CIB doXiview kann in eine andere Webanwendung integriert werden. In diesem Fall muss festgelegt werden, ob das interne oder externe IWC framework verwendet werden soll. Wenn CIB doXiview nicht in eine andere Anwendung integriert ist, muss der IWC Modus auf „standalone“ gesetzt werden.

Start Parameter Anfordern

Bevor sich CIB doXiview mit der integrierenden Anwendung verbinden kann, muss doXiview angewiesen werden, diese Verbindung aufzubauen. Sofern der Parameter iwc_mode nicht auf „standalone“ gesetzt ist, versucht doXiview standardmäßig die Verbindung aufzubauen.

Repository Aliasse

Ein Repository Alias gibt an, aus welcher Quelle Dokumente geladen werden sollen.

webstore Repository

Das webstore Repository ist ein Dienst, um temporär Dateien zu speichern. Der Dienst wird auch als UND (Up aNd Download) bezeichnet. Eine über diesen Dienst abgelegte Datei erhält einen eindeutigen Kennzeichner. Die webstore-id. Über diese ID kann die Datei später wieder geladen werden.

doXima Repository

Das doXima Repository holt Dokumente vom CIB doXima Server über eine Dokument-ID und zeigt diese im CIB doXiview an.

HTTP Repository

Das HTTP Repository erlaubt es dem Benutzer, ein Dokument per HTTP zu laden, indem die URL dieses Dokuments angegeben wird. Dieses Dokumentenrepository ist ein Spezialfall, denn der Benutzer muss hier den Parameter repo_alias nicht angeben. Aus sicherheitsgründen sind nur URLs erlaubt, die mit „http://“ oder „https://“ beginnen.

Der Parameter „httpBundle“ erwartet eine JSON Struktur, welche die Parameter aller zu öffnenden Dokumente beinhaltet:

{
   "bundleName": "test-bundle",
   "httpParameters":  "Authorization=Baerer abc",
   "documents": [{
        "cacheId": "example_v1",
        "url": "http://...",
        "name": "example document",
        "mimeType": "application/pdf" 
    }, ...]
}

CMIS Repository

CMIS ist ein offener Standard zur Anbindung von Content-Management-Systemen. Das Dokument das geladen werden soll, wird über eine ID angegeben. Server und Zugangsdaten können aus Sicherheitsgründen auch am Server konfiguriert werden.

Aus einem CMIS-Repository können mehrere Dokumente gleichzeitig geöffnet werden. der Parameter cmisSortProperty gibt eine CMIS-Eigenschaft an, nach welcher die Dokumente aus dem CMIS-Repository sortiert werden sollen (optional).

Archiv Repository

Das Archiv Repository ist ein spezielles Repository für den Archiv-Modus. Über eine ID kann ein Dokument aus der Archiv-Datenbank geladen werden.

UI Stildefinition

Die UI Stildefinition bestimmt das „Look and Feel“ des CIB doXiview. Damit sind in erster Linie das Farbschema und die Icons gemeint.

Der Parameter „uistyle“ setzt voraus, dass individuelle Icons und CSS Dateien vorhanden sind um das Aussehen von CIB doXiview zu verändern. Alternativ kann auch der Parameter „customColor“ genutzt werden, um die Farbe des Viewers anzupassen.

UI Modi

Der UI Modus bestimmt, welche Buttons auf der Anwendungsschaltfläche verfügbar sind. Über den „ui“ Parameter wird eine hinterlegte Toolbar-Konfiguration referenziert.

Vertikale Toolbar

Die vertikale Toolbar auf der linken Seite von CIB doXiview bietet diverse Inhalte.
Mit Hilfe des Parameters verticalToolbarContent kann angegeben werden, welcher Inhalt beim Start angezeigt werden sol.

Archiv Spezifisch

Search on Open

Search on Open erlaubt es dem Benutzer in einem Dokument zu suchen, sobald es geladen wurde.
Zusätzlich kann der Benutzer bestimmen, ob die Suche Groß- und Kleinschreibung beachten soll und ob nur ganze Wörter verglichen werden sollen.

Lesezeichen

Die folgenden Parameter erlauben dem Nutzer die Konfiguration von Lesezeichen.

Navigation bei Anmerkungen

Bei der Darstellung eines Archivdokuments werden mehrere zusätzliche Navigationswidgets angezeigt, die dem Benutzer eine Navigation zwischen Seiten, Dokumenten und Anmerkungen anbietet. Um diese Navigation bei Anmerkungen zu verstecken wird der Parameter annotatedPageNavigation verwendet. Es ist auch möglich zur ersten mit einer Anmerkung versehenen Seite zu springen, sobald ein Archivobjekt geladen wurde. Dafür kann der Parameter jumpToFirstAnnotatedPage verwendet werden.

Lazy Loading

Lazy Loading gibt CIB doXiview vor, ob Dokumente gleichzeitig oder eines nach dem anderen geladen werden sollen.

Dokumentenseiten- / Seitennavigationswidget Verstecken

In manchen Fällen ist es erforderlich, dass die Dokument- und Seitennavigationswidgets auf der Archivnavigationstoolbar versteckt werden.

Checkmasken

Um Verletzungen von Checkmasken im CIB doXiview prüfen zu können, kann der Start Parameter checkMask mit einer gültigen Checkmaske gesetzt werden. Der Inhalt dieses Parameters wird dann an den CIB documentServer weitergereicht und CIB doXiview zeigt ein Toolbar Icon, mit dem die Sichtbarkeit der Checkmaskverletzungen ein- bzw. ausgeblendet werden kann. Der Parameter checkMaskEnabled gibt an, ob das Anzeigen der Checkmasken aktiv sein soll.

Navigationstext

Für den Fall dass man CI konforme Dokumente hat, sollte es möglich sein den Text des Dokumentnavigationswidget auf etwas anderes zu setzen (z. B. „Seite“), so dass die Dokumentnavigation für den Benutzer analog zur Seitennavigation erscheint.

Toolbar für Anmerkungen

Die folgenden Start Parameter können verwendet werden, um die Toolbar für Anmerkungen zu steuern

• annotationToolBarMode: Bestimmt über die Größe der Toolbar für Anmerkungen.
• showAnnotationToolBarConfig: Bestimmt, ob der Button zur Konfiguration der Toolbar für Anmerkungen angezeigt wird. Damit ist es möglich, den Benutzer auf eine Größe bezüglich der Toolbar für Anmerkungen zu beschränken.

Aktueller Benutzer

Es ist möglich, den aktuellen Benutzer mittels dieses Parameters zu setzen. Dies wird z. B. bei der Erzeugung von Lesezeichen oder Ebenen verwendet.

Benutzerspezifische Einstellungen

Es ist möglich benutzerspezifische Einstellungen über Parameter wie beispielsweise die Zoomstufe zu setzen. Die zuletzt verwendeten Werte werden an die einbettende Anwendung über den terminate Aufruf zurückgegeben.

Zuletzt Verwendete Zoomstufe

Die zuletzt vom Benutzer verwendete Zoomstufe.

Zwei-Spalten-Ansicht

Bestimmt, ob das Dokument in der Zwei-Spalten-Ansicht angezeigt werden soll oder nicht.

Checkbox-Cheatsheet Anzeigen

Bestimmt, ob das Checkbox-Cheatsheet-Benachrichtigungsfenster beim Verwenden von Checkboxen gezeigt werden soll.

Geöffneter / Geschlossener Seitennavigationsbaum

Bestimmt, ob der Seitennavigationsbaum geöffnet oder geschlossen sein soll, wenn CIB doXiview geöffnet wird.

Webedit Größe

Dieser Parameter gibt an, ob der Webedit-Text-Editor auf die volle Größe des Seitenrasters gesetzt werden soll. Ansonsten wird seine Größe auf die Hälfte des Seitenrasters gesetzt.

Stempelkonfiguration

Die Stempelkonfiguration enthält eine Anzahl von Stempelkonfigurationen, die für das Anbringen von Stempel verwendet werden sollen.

Zuletzt Ausgewählter Stempel

Der zuletzt ausgewählte Stempel enthält den Namen des letzten Stempel, den der Benutzer ausgewählt hatte.

Dokument aktualisieren

CIB doXiview bietet verschiedene Wege, Dokumente im Quell-Repository zu aktualisieren. Oft ist es dazu auch notwendig, die integrierende Anwendung über die Aktualisierung zu informieren. Wie und wo ein Dokument abgelegt oder aktualisiert werden soll, wird über den Parameter documentVersionUpdateMode bestimmt. Abhängig von dem gesetzten Wert, sind ggf. weitere Parameter notwendig.

Name des Integrators

Der Parameter integratorName legt den Namen der integrierenden Anwendung fest. Er wird verwendet, um dem Benutzer aussagekräftigere Benachrichtigungen anzuzeigen.

Ablage im webstore

Die Aktualisierung über den webstore Dienst ist die einfachste Art, ein Dokument zu aktualisieren. CIB doXiview legt die neue Dokument-Version im webstore ab, und übergibt der integrierenden Anwendung die generierte webstoreID. Der Integrator kann diese ID nutzen, um das neue Dokument abzuholen.

E-Mail Versand

Das aktualisierte Dokument kann auch per E-Mail versendet werden.

Ablage per HTTP

Das aktualisierte Dokument kann per http POST direkt an einen festgelegten Server gesendet werden. Optional können zusätzliche HTTP Header Felder definiert werden, welche beim Speichern der neuen Dokumentversion mit der Anfrage gesendet werden.
Somit können beispielsweise Authentifizierungs-Informationen übertragen werden.

Editieren

Der Parameter isSnippetEditingAllowed legt fest, ob das Editieren von rec-Bereichen erlaubt ist.

Drucken

CIB doXiview bietet die Option, Dokumente zu drucken. Das kann über den Drucken-Button in CIB doXiview geschehen, oder über den Integrator. Um den Druckdialog aus dem Integrator zu öffnen, muss der Parameter externalPrint auf true gesetzt sein.
Der Parameter print kann verwendet werden, um CIB doXiview zu sagen, dass der Druckdialog geöffnet werden soll, sobald das Dokument geladen wurde.
Der Parameter printMode gibt an, über welchen Weg das Dokument gedruckt werden soll.

Kontext

Der Kontext ist ein beliebiger Wert, welcher beim Drucken an den Gerätedienst übergeben wird. Über den Kontext kann dieser beispielsweise die verfügbaren oder zu verwendenden Drucker bestimmen.

Lese- und Präsentations-Modus

CIB doXiview bietet einen Lesemodus, in dem das Dokument in voller Größe und ohne Toolbar oder Seitennavigation angezeigt wird. Zudem gibt es einen Präsentationsmodus, der besonders gut für Präsentationen geeignet ist.

Initiale Dokument-Ansicht

Erste Seite

Standardmäßig wird in CIB doXiview die erste Seite eines Dokuments beim Start angezeigt. Mit dem Start-Parameter firstPage kann die initial anzuzeigende Seitennummer angegeben werden.

Teildokument

Wird ein Bündel geöffnet (.zip / .jview), wird standardmäßig das erste Teildokument angezeigt. Der Start-Parameter documentIndex gibt den Index des initial anzuzeigenden Teildokuments an.

Optionsleiste

Allgemein

CIB doXiview bietet eine Optionsleiste, welche diverse Optionen zum Bearbeiten eines Dokuments bietet. Standardmäßig ist keine Option verfügbar. Die benötigten Funktionen können jedoch bei Bedarf aktualisiert werden.

Um nicht jede Funktion separat aktivieren oder deaktivieren zu müssen, gibt es zwei spezielle Parameter um die Bearbeitung komplett zu aktivieren oder zu deaktivieren.

Optionsleiste anzeigen

Standardmäßig ist die Optionsleiste nicht sichtbar. Mit folgendem Parameter kann die Optionsleiste beim Start aktiviert werden.

Der Parameter optionsbarVisible bestimmt, ob die Options-Leiste beim Start sichtbar ist.

Inhalt in der Optionsleiste anzeigen

Der parameter optionsbarContent bestimmt, welcher Inhalt in der Options-Leiste beim Start angezeigt werden soll.

Dokument signieren

Es ist möglich, einem Dokument digitale Signaturen hinzuzufügen. Der Parameter signMode aktiviert die Funktion und gibt den zu verwendenden Mechanismus zum Unterschreiben an.
Standardmäßig ist die Funktion deaktiviert. Um CIB doXisign zu verwenden, muss der Parameter auf internal gesetzt sein.

Dokument versiegeln

Enthält ein Dokument mehrere Signaturen, kann über den Parameter sealDocument angegeben werden, zu welchem Zeitpunkt das Dokukent versiegelt werden soll. Sobald die erste Unterschrift geleistet wurde, oder sobald die letzte Unterschrift geleistet wurde.
Wurde das Dokument versiegelt, ist eine Bearbeitung der Formularfelder nicht mehr möglich.

Formularfelder

Der Parameter formEnabled erlaubt es, Formularfelder zu editieren.

Formular-Benutzerführung

Mit Hilfe des Parameters formUserGuidanceEnabled kann eine Benutzerführung aktiviert werden, welche die verfügbaren Formularfelder, sowie die Information darüber welche bereits ausgefüllt wurden, anzeigt.

Titel

Standardmäßig zeigt CIB doXiview den Dateinamen des aktuellen Dokuments im Seitenraster. Um stattdessen einen bestimmten Titel zu setzen, kann der Parameter title verwendet werden.

Textauswahl

Standardmäßig ist die Textauswahl in CIB doXiview aktiviert. Um stattdessen das Standard-Mauswerkzeug zu verwenden, kann der Parameter textSelectionActive verwendet werden.

Geöffneter / Geschlossener Miniaturansicht-Baum für Bündel-Fall

Bestimmt, ob der Baum in die Miniaturansicht erweitert oder reduziert werden sollte, wenn ein Bündel in webview geöffnet wird.

Rechnungen

Startparameter, die die Funktionsweise des Invoice-Moduls beeinflussen:

OCR (Texterkennung)

Startparameter, die die Funktionsweise des Ocr-Modus beeinflussen sind nachfolgend aufgeführt.

Datei ziehen und ablegen

Der Parameter dndFileEnabled bestimmt, ob Dateien mit Ziehen und Ablegen geöffnet werden können.

PDF Anlagen

Der Parameter openAttachmentEnabled bestimmt, ob eine PDF-Anlage in einem neuen Tab geöffnet werden kann.

Eindeutiger Cache-Eintrag

CIB doXiview speichert geöffnete Dokumente temporär in einem Serverseitigen Cache-Eintrag, um es bei erneutem Öffnen schneller anzeigen zu können.

In manchen Fällen ist es jedoch erwünscht, das Dokument erneut zu rendern, statt die vorhandenen (möglicherweise veralteten) Daten zu verwenden.
Mit Hilfe des Parameters useUniqueCache kann der Server angewiesen werden, für das zu öffnende Dokument einen eindeutigen Cache-Eintrag zu erstellen und bereits generierte Dateien zu ignorieren.

Dokument-Informationen

Der Parameter documentInfoOnOpen bestimmt, ob die Dokumentinformationen beim Start von doXiview angezeigt werden sollen.

Präsentationsmodus

Der Parameter presentationModeActive bestimmt, ob die Präsentationsansicht für das geöffnete Dokument verfügbar sein soll.

Wortstatistiken

Der Parameter wordStatisticsEnabled bestimmt, ob die Funktionen zur linguistischen Analyse aktiv sein sollen.