Einstellungen: web
Folgende Einstellungen sind in der settings.properties mit dem Präfix "web." möglich.
web.ssmPublicUrl
Beschreibung | Beschreibt die öffentliche URL der signoSign/Universal Anwendung. Sie wird verwendet um Access-URLs zur Anwendung zu generieren. Bspw. für Links in Benachrichtigungs-Mails der Workflows. |
Mögliche Werte | Jede vom Client erreichbare URL. |
Standardwert | - |
Wird dieser Wert nicht bestimmt, wird die öffentliche URL durch die eingehenden Anfragen erschlossen, wenn möglich. Der Server loggt beim Start eine Warnung wenn der Schlüssel nicht gesetzt ist. Für die Nutzung von Single Sign On ist dieser Wert zwingend erforderlich.
web.ssmInternalUrl
Beschreibung | Diese Eigenschaft definiert eine URL, unter der die signoSign/Universal-Anwendung vom Server aus erreichbar ist. Diese URL wird insbesondere für REST-Aufrufe verwendet, die nicht über eine öffentliche Schnittstelle aufgerufen werden müssen. Sie reduziert den öffentlichen Verkehr und erleichtert den Lastausgleich. |
Mögliche Werte | Jede vom Server erreichbare URL. |
Standardwert |
Es wird empfohlen, mit dieser URL immer auf die eigene Server-Instanz zu verweisen.
web.showLeaveUnchangedDialog
Beschreibung | Diese Einstellung bestimmt, ob beim Verlassen eines unveränderten Dokumentes ein Dialog angezeigt wird, der den Benutzer darauf hinweist, dass keine Änderungen am Dokument vorgenommen wurden. | |
Mögliche Werte |
| Dialog wird beim Verlassen eines unveränderten Dokumentes angezeigt. |
| Dialog wird beim Verlassen eines unveränderten Dokumentes nicht angezeigt. | |
Standardwert |
|
web.supportedCaptureInput
Beschreibung | Diese Einstellung definiert eine Liste von erlaubten Eingabetypen für die Signatur. Bei der Erfassung wird geprüft, ob der verwendete Eingabetyp in der Liste enthalten ist. Ist der Eingabetyp nicht enthalten, wird die Erfassung mit einem Hinweis über die gültigen Eingabetypen abgebrochen. | |
Mögliche Werte |
| Erlaubt die Erfassung via Maus-Eingabe. |
| Erlaubt die Erfassung via Toucheingabe. | |
| Erlaubt die Erfassung via elektronischen Stift. | |
| Erlaubt die Erfassung via signotec Unterschriftenpad. | |
| Erlaubt das Unterschreiben mittels Fernsignatur durch sign-me der D-Trust GmbH. | |
| Erlaubt das Signieren mit Click-to-Sign ohne Unterschriftenerfassung. | |
Standardwert |
|
Bis auf den Eingabetyp
PAD
, werden alle Eingabetypen anhand von JavaScript-Eventtypen erkannt.Die Anwendung erwartet Druckwerte zwischen 0 und 1. Alle Werte über 1 werden serverseitig auf 1 gekürzt.
Der Eingabetyp PAD erfordert die Installation des signoPAD-API/Web auf dem Client-System.
web.signatureFieldsOrderMode
Beschreibung | Diese Einstellung bestimmt, in welcher Reihenfolge die Signaturfelder im Viewer abgesprungen werden, wenn das Unterschreiben aller Felder durch Klick auf die Unterschreiben-Button gestartet oder der Signaturprozess durch die Einstellung automatedSignStartMode gestartet wird. | |
Mögliche Werte |
| Die Signaturfelder werden in der Reihenfolge abgesprungen, wie sie in das Dokument eingebracht worden sind. Diese Reihenfolge ist seitenübergreifend und eindeutig für das gesamte Dokument. Technisch ist dies die Reihenfolge im „Fields“-Eintrag des Dokuments. |
| Die Signaturfelder werden in der im Dokument spezifizierten manuellen Tab-Order abgesprungen. Diese Reihenfolge ist nur pro Seite eindeutig, es werden daher zunächst alle Felder auf der ersten Seite, dann alle Felder auf der zweiten Seite usw. abgesprungen. Technisch ist dies die Reihenfolge im „Annots“-Eintrag der jeweiligen Seite. | |
Standardwert |
|
web.hardwarePadsOnly
Beschreibung | Diese Einstellung bestimmt, ob ausschließlich mit Signaturpads oder auch mit der Maus oder einem Touchgerät unterschrieben werden kann. Wird diese Option aktiviert und es wird kein Signaturgerät erkannt, werden sämtliche Signaturfelder im Dokument ausgeblendet. Bei Verwendung der signoSign/Universal-Apps wird diese Option ignoriert. | |
Mögliche Werte |
| Nur Signatur-Pads sind zur Unterschrift erlaubt. |
| Unterschrift mit der Maus oder einem Touchgerät ist möglich. | |
Standardwert |
|
Diese Einstellung wurde zugunsten der Einstellung web.supportedCaptureInput als veraltet markiert.
web.disableMouseSignature
Beschreibung | Diese Einstellung entscheidet darüber, ob Unterschriften mit dem Mauszeiger unterdrückt werden. | |
Mögliche Werte |
| Unterschriften mit der Maus werden unterbunden. |
| Unterschriften können mit der Maus gezeichnet werden. | |
Standardwert |
|
Diese Einstellung wurde zugunsten der Einstellung web.supportedCaptureInput als veraltet markiert.
web.photoAllowedInApp
Beschreibung | Über die signoSign/Universal-Apps können Signaturen zusammen mit einem Foto in ein Dokument eingebracht werden. Diese Einstellung entscheidet darüber, ob diese Option während des Signaturprozessen zur Verfügung steht. | |
Mögliche Werte |
| Zeigt den Foto-Button. |
| Zeigt den Foto-Button nicht an. | |
Standardwert |
|
Diese Einstellung als veraltet markiert und wird in zukünftigen Versionen entfernt.
web.logoutUrl
Beschreibung | Beim Logout-Vorgang (signoSign/Universal Logout Button) versucht der Server den Client in folgender Reihenfolge zu mehreren URLs umzuleiten. Zuerst wird die URL, die mit dem Request-Parameter |
Mögliche Werte | Die URL, zu der nach dem Abmelden und Verlassen der Anwendung weitergeleitet wird. |
Standardwert |
Ist dieser Wert auf keinem Weg definiert, wird auf https://www.signotec.com weitergeleitet.
web.saveBeforeExport
Beschreibung | Diese Einstellung bestimmt, ob vor dem Herunterladen eines Dokuments aus dem Viewer heraus der Speicherprozess durchgeführt wird oder nicht. Alle weiteren Einstellungen, die den Speicherprozess beeinflussen wie etwa saveImportedDocuments werden hierfür berücksichtigt. In jedem Fall enthält das heruntergeladene Dokument den momentanen Zustand. | |
Mögliche Werte |
| Vor jedem Herunterladen wird automatisch gespeichert. |
| Vor dem Herunterladen wird nicht automatisch gespeichert. Zum Speichern muss der separate Button verwendet werden. | |
Standardwert |
|
web.saveImportedDocuments
Beschreibung | Diese Einstellung entscheidet darüber, ob Dokumente, die nicht aus der Persistenz geladen wurden, beim Speicherprozess persistiert werden. Wird eine URL zum entfernten Speichern definiert, wird diese auch immer verwendet. | |
Mögliche Werte |
| Importierte Dokumente werden beim Speichern in die Persistenz geschrieben. |
| Ein Speichern synchronisiert lediglich das geladene Dokument am Server. | |
Standardwert |
|
Ist dieser Wert false
und ein Dokument wird direkt als Datei oder URL an die Anwendung übergeben (s.a. POST /viewer/document der REST-API), wird das Dokument beim Ausführen des Speicherprozesses nicht persistiert sondern lediglich mit dem Backend synchronisiert. Eine Ausnahme ist das Remote-Saving.
web.clientDebugLogging
Beschreibung | Diese Einstellung aktiviert die clientseitige Debug-Protokollierung über JavaScript. Alle Ausgaben werden zur Information in die Browserkonsole geschrieben. Es wird empfohlen, diese Option im produktiven Betrieb zugunsten der Leistung zu deaktivieren. | |
Mögliche Werte |
| Aktiviert das clientseitige Debug-Logging. |
| Deaktiviert das clientseitige Debug-Logging. | |
Standardwert |
|
web.idleTimeout
Beschreibung | Diese Einstellung legt den Zeitraum fest, nach dem ein geladenes Dokuments eines Benutzers durch den Server geschlossen wird. Der Timeout ist für den Fall vorgesehen, dass eine Sitzung unkonventionell durch den Client beendet wurde und der Server nicht darüber informiert werden konnte. Besteht in diesem Fall kein Serverseitiger Timeout, bleibt das Dokument bis zum Timeout der Session im Arbeitsspeicher. |
Mögliche Werte | Ganzzahliger Wert in Minuten. Die Angabe von 0 deaktiviert den Timeout. |
Standardwert | 60 |
web.captureBiometricData
Beschreibung | Diese Einstellung aktiviert die Erfassung der biometrischen Daten bei der Unterschriftenerfassung. Wenn diese Funktion aktiviert ist, werden zusätzliche Eigenschaften der Unterschrift wie z. B. der zeitliche Ablauf und Stiftdruck erfasst. | |
Mögliche Werte |
| Biometrische Daten werden bei der Unterschrift erfasst. |
| Biometrische Daten werden bei der Unterschrift nicht erfasst. | |
Standardwert |
|
web.mockMode
Beschreibung | Im Mock-Mode werden gestartete Unterschriften umgehend mit zufällig generierten Punkten bestätigt. Die Verwendung von Signatur-Pads ist in diesem Modus deaktiviert, jedoch wird in der Anwendung die gleiche Sequenz von Events ausgelöst, wie wenn ein Signaturgerät angeschlossen ist. Darüber hinaus werden alle Formularfelder in diesem Prozess mit dem Wert 1 befüllt, um Konflikte mit Pflichtfeldern zu vermeiden. | |
Mögliche Werte |
| Mock-Modus ist aktiviert |
| Mock-Modus ist deaktiviert | |
Standardwert |
|
Diese Einstellung ermöglicht das Durchführen von Lasttests und simuliert einen Benutzer.
web.proposeNewViewer
Beschreibung | Die Einstellung regelt die Option für den Benutzer, beim Öffnen des Viewers eine experimentelle Variante des Viewers auszuprobieren, die sich derzeit in einer Testphase befindet. Benutzer können ihre Auswahl mithilfe einer Checkbox speichern, und diese Informationen werden in einem Cookie abgelegt. Die gespeicherte Entscheidung kann rückgängig gemacht werden, indem die entsprechenden Cookies gelöscht werden. Der Viewer kann zusätzlich durch das Hinzufügen des HTTP-Parameters "newviewer" gesteuert werden. | |
Mögliche Werte |
| Die Nachfrage wird beim Öffnen des Viewer gestellt. |
| Die Nachfrage wird beim Öffnen des Viewer nicht gestellt. | |
Standardwert |
|
Der neue Viewer befindet sich in einer Testphase.
web.documentSharingLeaveUrl
Beschreibung | Diese Einstellung regelt, zu welcher URL der Benutzer weitergeleitet wird, sobald ein geteiltes Dokument verlassen wird. | |
Mögliche Werte | Eine valide URL | Die URL zu der weitergeleitet wird, sobald ein geteiltes Dokument verlassen wird. |
- | Der Benutzer wird nach Verlassen des geteilten Dokuments nicht weitergeleitet | |
Standardwert | - |
web.defaultViewer
Beschreibung | Diese Einstellung regelt, ob der neue oder der alte Viewer als Standard verwendet werden soll. | |
Mögliche Werte |
| Der alte Viewer wird als Standard verwendet. |
| Der neue Viewer wird als Standard verwendet. | |
Standardwert |
|
web.postSaveAction
Beschreibung | Definiert eine zusätzliche Aktion, die nach dem Speichern eines Dokuments ausgeführt wird. | |
Mögliche Werte |
| Keine zusätzliche Aktion wird ausgeführt. |
| Nach dem Speichern wird der Benutzer zur referrer zurückgeleitet. | |
Standardwert |
|
Sichtbarkeit der Toolbar-Buttons
Für viele Toolbar-Buttons kann die Sichtbarkeit eingestellt werden. Es kann eingestellt werden, ob ein Button sichtbar ist, ob er nur im Untermenü angezeigt wird, ob er abhängig vom verfügbaren Platz in der Kopfzeile angezeigt wird oder ob er priorisiert in der Kopfzeile angezeigt werden soll, was bedeutet, dass dieser Button als letztes in das Untermenü verschoben wird. Im folgenden werden alle möglichen Werte aufgelistet.
Einstellungen | web.logoutUrl | |
Mögliche Werte |
| Der Button wird ausschließlich im Untermenü aufgeführt. |
| Der Button wird nicht dargestellt. | |
| Der Button wird abhängig von der Auflösung in der Kopfzeile oder im Untermenü angezeigt. | |
| Der Button wird priorisiert in der Kopfzeile angezeigt. | |
Standardwert |
|
Design-Einstellungen
Folgende Einstellungen nehmen Einfluss auf das Design der UI.
web.accentColor
Beschreibung | Diese Einstellung legt die Akzentfarbe für den Dokumentenpool, den Viewer und durch den Server versandte E-Mails fest. |
Mögliche Werte | Ein hexadezimaler Farbcode (RGB). |
Standardwert |
|
web.logo
Beschreibung | Diese Einstellung legt das Logo für den Dokumentenpool und durch den Server versandte E-Mails fest. |
Mögliche Werte | Eine URL zu einem Bild, das vom Server erreichbar ist. |
Standardwert | - |
web.favicon
Beschreibung | Diese Einstellung legt das Favicon für den Dokumentenpool und den Viewer fest. |
Mögliche Werte | Eine URL zu einem Bild, das vom Server erreichbar ist. |
Standardwert | - |
web.signatureColor
Beschreibung | Diese Einstellung bestimmt die Strichfarbe der Unterschrift. | |
Mögliche Werte |
| Ein 6 Nummern Farbcode. |
| Ein 3 Nummern Farbcode. | |
| Alle Farbnamen, die in CSS einem gültigem Farbwert entsprechen. | |
Standardwert |
|
Einstellungen für signotec Unterschriftenpads
Die folgenden Einstellungen sind relevant, wenn signotec Unterschriftenpads verwendet werden.
web.serialPadSearchType
Beschreibung | Diese Einstellung bestimmt, ob und an welchen Ports des Client-Geräts nach seriellen Pads gesucht wird. Standardmäßig wird nicht nach seriellen Geräten gesucht. | |
Mögliche Werte |
| Es wird keine Suche nach seriellen Pads durchgeführt. |
| Durch ein Semikolon getrennte Werte. Beispiel: Die Suche wird auf den Ports COM2, COM3, COM5 und COM7 durchgeführt. | |
| Die Suche wird auf allen vorhandenen COM-Ports durchgeführt. | |
Standardwert |
|
web.wssDomainPort
Beschreibung | Diese Einstellung bestimmt den Domain-Namen und den Port unter dem der WebSocket der signoPAD-API/Web angesprochen wird. Weitere Informationen hierzu finden Sie in der Dokumentation der signoPAD-API/Web. |
Mögliche Werte | Die URL, unter welcher der Websocket der signoPAD-API/Web erreichbar ist. |
Standardwert |
Der Betrieb der signoPAD-API/Web ohne TLS aus einer TLS geschützten Umgebung hat je nach Browser Einschränkungen. Weitere Informationen hierzu finden Sie in der Dokumentation der signoPAD-API/Web.
Ohne explizite Angabe eines Protokolls wird zunächst versucht eine Verbindung per WSS und bei Misserfolg noch einmal über WS aufzubauen.
Bei expliziter Angabe eines Protokolls findet auch nur ein Verbindungsversuch über dieses statt.
web.padCertificationAuthorities
Beschreibung | Mit dieser Einstellung kann eine PEM-Datei festgelegt werden, die eine oder mehrere Zertifikatketten von Zertifizierungsstellen enthält. Die Reihenfolge der Zertifikate in der Datei kann frei gewählt werden. Wenn eine Datei festgelegt ist, wird signoSign/Universal prüfen, ob das im Signaturgerät gespeicherte Signaturzertifikat von einem der enthaltenen Zertifikate signiert wurde. Ist dies nicht der Fall, können keine Unterschriften erfasst werden. Diese Funktion ist standardmäßig deaktiviert. |
Mögliche Werte | Absoluter oder relativer Dateipfad zu einer PEM-Datei. |
Standardwert | - |
web.legacySignatureImage
Beschreibung | Die Einstellung legt fest, ob bei der Erfassung einer Signatur über die signoPAD-API/Web eine Raster- oder Vektorgrafik erzeugt und in das PDF eingebunden wird. | |
Mögliche Werte |
| Das Signaturbild wird als Rastergrafik ins PDF eingebracht. |
| Das Signaturbild wird als Vektorgrafik ins PDF eingebracht. | |
Standardwert |
|
web.dynamicSignatureStrokes
Beschreibung | Legt fest, ob Signaturen mit einer dynamischen oder konstanten Strichstärke erfasst werden. | |
Mögliche Werte |
| Signaturen werden mit einer dynamischen Strichstärke erfasst. |
| Signaturen werden mit einer konstanten Strichstärke erfasst. | |
Standardwert |
|
web.signPadDocumentView
Beschreibung | Entscheidet darüber, ob beim Erfassen einer Unterschrift mit einem Signiergerät ein Ausschnitt des Dokuments um die Signatur herum dargestellt wird. (s.a. signPadDocumentViewScalingFactor, signPadDocumentViewMarginLeft und signPadDocumentViewMarginTop) | |
Mögliche Werte |
| Beim Unterzeichnen auf einem Signiergerät, wird ein Ausschnitt des Dokuments angezeigt. |
| Beim Unterzeichnen auf einem Signiergerät, wird ein standardisierter Dialog angezeigt. | |
Standardwert |
|
web.signPadDocumentViewMarginTop
Beschreibung | Diese Einstellung stellt den oberen Rand des Unterschriftenfeldes im Dokumentenausschnitt dar. Je größer der Wert, desto größer wird der Abstand zum oberen Rand. |
Mögliche Werte | Ganzzahlige Werte zwischen 0 und 100. |
Standardwert | 75 |
web.autoShowDocumentOnPad
Beschreibung | Die Einstellung bestimmt, ob beim Öffnen des Viewers automatisch die Dokumentenanzeige auf dem Signaturgerät gestartet werden soll. Der Autostart wird nur ausgeführt, wenn ein signotec Delta Gerät gefunden wurde und die signoPAD-API/Web auf dem Client installiert ist. Standardmäßig ist diese Funktion aktiviert. | |
Mögliche Werte |
| Sofern der Lesemodus funktional zur Verfügung steht, wird er gestartet. |
| Sofern der Lesemodus funktional zur Verfügung steht, kann er manuell gestartet werden. | |
Standardwert |
|
web.signPadDocumentViewScalingFactor
Beschreibung | Diese Einstellung stellt den Skalierungsfaktor für den Dokumentenausschnitt auf dem Signaturgerät ein. Es ist ein Integer-Wert, der die Skalierung in Prozent angibt. |
Mögliche Werte | Ganzzahlige Werte zwischen 10 (Minimaler Zoom) und 200 (maximaler Zoom). |
Standardwert | 100 |
web.signPadDocumentViewMarginLeft
Beschreibung | Diese Einstellung stellt den linken Rand des Unterschriftenfeldes im Dokumentenausschnitt dar. Je größer der Wert, desto mehr Abstand hat das Feld zum linken Rand. |
Mögliche Werte | Ganzzahlige Werte zwischen 0 und 100. |
Standardwert | 25 |