Settings: web | signotec Knowledge Base

The following settings are possible in settings.properties with the prefix ‘web.’.

web.ssmPublicUrl

Description	Describes the public URL of the signoSign/Universal application. It is used to generate access URLs to the application. For example for links in messaging emails of the workflows.
Possible values	Any URL accessible by the client.
Default value	-

If this value is not defined, the incoming requests will open the public URL, if possible. The server logs a warning during start-up if the key is not set. This value is mandatory for the use of single sign-on.

web.ssmInternalUrl

Description	This property defines a URL from which the signoSign/Universal application can be accessed by the server. This URL is used in particular for REST calls that do not need to be implemented from a public interface. They reduce public traffic and facilitate load balancing.
Possible values	Any URL accessible by the server.
Default value	http://localhost:8080/signoSignUniversal

It is recommended that you always refer to your own server instance with this URL.

web.showLeaveUnchangedDialog

Description	This setting defines whether a dialogue box is displayed when leaving an unchanged document that notifies the user that no changes have been made to the document.
Possible values	`true`	A dialogue box will be displayed when leaving an unchanged document.
	`false`	A dialogue box will not be displayed when leaving an unchanged document.
Default value	`false`

web.supportedCaptureInput

Description	This setting defines a list of permitted input types for the signature. During capturing, it is checked whether the input type used is included in the list. If the input type is not included, capturing is cancelled with a note regarding the valid input types.
Possible values	`MOUSE`	Permits capture via mouse input.
	`TOUCH`	Permits capture via touch input.
	`PEN`	Permits capture via electronic pen.
	`PAD`	Permits capture via signotec signature pad.
	`SIGNME`	Permits signing by means of remote signature with sign-me from D-Trust GmbH.
	`CLICK`	Allows signing with click-to-sign without signature capture.
Default value	`MOUSE`,`TOUCH`,`PEN`,`PAD`,`SIGNME`,`CLICK`

With the exception of the input type PAD, all input types are recognised using JavaScript event types.
The application expects pressure values between 0 and 1. All values above 1 are reduced to 1 on the server side.
The PAD input type requires the installation of the signoPAD-API/Web on the client system.

web.signatureFieldsOrderMode

Description	This setting defines the order in which the signature fields are jumped to in the Viewer when the signing process for all fields is started by clicking the Sign button or the signing process is started by the automatedSignStartMode setting.
Possible values	`FIELDORDER`	The signature fields are jumped to in the order in which they were inserted into the document. This order applies to all pages and is unique to the entire document. Technically, this is the order in the ‘Fields’ entry of the document.
	`TABORDER`	The signature fields are jumped to in the manual tab order specified in the document. This order is only unique to each page. This means all of the fields on the first page are jumped to, then all of the fields on the second page and so on. Technically, this is the order in the ‘Annots’ entry of the respective page.
Default value	`FIELDORDER`

web.hardwarePadsOnly

Description	This setting defines whether documents can only be signed with signature pads, or with the mouse or a touch device as well. If this option is enabled and no signature device is detected, all signature fields in the document will be hidden. This option is ignored when using signoSign/Universal apps.
Possible values	`true`	Only signature pads may be used for signing.
	`false`	Signature with the mouse or a touch device is possible.
Default value	`false`

This setting has been marked as obsolete in favour of the setting web.supportedCaptureInput.

web.disableMouseSignature

Description	This setting determines whether signatures with the mouse pointer are disabled.
Possible values	`true`	Signatures with the mouse are prevented.
	`false`	Signatures can be provided with the mouse.
Default value	`false`

This setting has been marked as obsolete in favour of the setting web.supportedCaptureInput.

web.photoAllowedInApp

Description	signoSign/Universal apps allow signatures to be inserted into a document together with a photo. This setting determines whether this option is available during the signing processes.
Possible values	`true`	Displays the photo button.
	`false`	Does not display the photo button.
Default value	`true`

This setting is marked as obsolete and will be removed in future versions.

web.logoutUrl

Description	In the logout process (signoSign/Universal logout button), the server attempts to redirect the client to several URLs in the following order. First, the URL that was sent with the request parameter `referer` when the document was loaded is used. If no `referer` was transferred, the user will be redirected to the logout URL.
Possible values	The URL to which the client is redirected after logout and the application has been closed.
Default value	https://www.signotec.com

If this value is not defined in any way, the client is redirected to https://www.signotec.com.

web.saveBeforeExport

Description	This setting determines whether saving is performed before a document is downloaded from the Viewer. All other settings that affect the saving process, such as saveImportedDocuments, are taken into account for this purpose. In any case, the downloaded document contains the current status.
Possible values	`true`	Saving is performed automatically before each download.
	`false`	Saving is not performed automatically before downloading. The separate button has to be used in order to save.
Default value	`false`

web.saveImportedDocuments

Description	This setting determines whether documents that were not loaded from the persistence become persistent during the save process. This is also always used if a URL to remote storage is defined.
Possible values	`true`	Imported documents are written in the persistence when they are saved.
	`false`	Saving only synchronises the loaded document on the server.
Default value	`false`

If this value is false and a document is transferred directly to the application as a file or URL (see also POST/Viewer/document), the document is not persisted during the storage process but is merely synchronised with the backend. Remote saving is an exception.

web.clientDebugLogging

Description	This setting enables debug logging on the client side via JavaScript. All outputs are written in the browser console for information purposes. We recommend disabling this option in live operations to improve performance.
Possible values	`true`	Enables client-side debug logging.
	`false`	Disables client-side debug logging.
Default value	`false`

web.idleTimeout

Description	This setting specifies the time period after which a document loaded by the user is closed by the server. The timeout is intended for cases where a session was terminated unconventionally by the client and the server could not be informed of this. If there is no server-side timeout in this case, the document remains in the working memory until the session times out.
Possible values	Integer values in minutes. Specifying this value as 0 disables the timeout.
Default value	60

web.captureBiometricData

Description	This setting enables the capturing of biometric data during the signature capture. If this function is enabled, additional properties of the signature such as time taken and pen pressure are captured.
Possible values	`true`	Biometric data is captured when signing.
	`false`	Biometric data is not captured when signing.
Default value	`true`

web.mockMode

Description	In mock mode, started signatures are immediately confirmed with randomly generated points. The use of signature pads is disabled in this mode, but the same sequence of events is triggered in the application as if a signature device is connected. In addition, all form fields in this process are populated with the value 1 to avoid conflicts with the mandatory fields.
Possible values	`true`	Mock mode is enabled.
	`false`	Mock mode is disabled.
Default value	`false`

This setting enables load tests to be carried out and simulates a user.

web.documentSharingLeaveUrl

Description	This setting controls which URL the user is redirected to when they leave a shared document.
Possible values	A valid URL	The URL to which the user is redirected when leaving a shared document.
	-	The user is not redirected after leaving the shared document.
Default value	-

web.defaultViewer

Description	This setting determines whether the new or the old Viewer should be used as the default.
Possible values	`DEFAULT`	The old Viewer is used as the default.
	`NEWVIEWER`	The new Viewer is used as the default.
Default value	`NEWVIEWER`

This setting serves as a temporary solution to maintain compatibility with the new Viewer implementation and will be removed again in the foreseeable future.

web.postSaveAction

Description	Defines an additional action that is performed after a document is saved.
Possible values	`NONE`	No additional action is performed.
	`REFERRER`	After saving, the user is redirected back to the referrer.
Default value	`NONE`

The visibility of many of the toolbar buttons can be configured. A button can be configured to be visible, to be displayed in the submenu only, to be displayed in the header provided there is space available or to be displayed in the header as a matter of priority, which means that this button is moved to the submenu as a last resort. All possible values are listed below.

Settings	web.logoutUrl web.showDocumentOnPadButtonVisibility web.resizeButtonsVisibility web.logoutButtonVisibility web.sharingButtonVisibility web.addNoteButtonVisibility web.thumbnailButtonVisibility web.saveButtonVisibility web.summaryButtonVisibility web.signButtonVisibility web.addSignatureFieldButtonVisibility web.exportButtonVisibility
Possible values	`SUBMENU`	The button is only listed in the submenu.
	`HIDDEN`	The button is not displayed.
	`AUTO`	The button is displayed in the header or the submenu, depending on the resolution.
	`HEADER`	The button is displayed in the header as a matter of priority.
Default value	`AUTO`

Design settings

The following settings influence the design of the UI.

web.accentColor

Description	This setting specifies the accent colour for the Document Pool, the Viewer and emails sent by the server.
Possible values	A hexadecimal colour code (RGB).
Default value	`#ee7900`

web.logo

Description	This setting specifies the logo for the Document Pool and emails sent by the server.
Possible values	A URL to an image that is accessible from the server.
Default value	-

web.favicon

Description	This setting specifies the favicon for the Document Pool and the Viewer.
Possible values	A URL to an image that is accessible from the server.
Default value	-

web.signatureColor

Description	This setting defines the pen colour of the signature.
Possible values	`#0000FF`	A 6-number colour code.
	`#00F`	A 3-number colour code.
	`BLUE, RED, BLACK, CYAN, DARK_GRAY, GRAY, GREEN, LIGHT_GRAY, MAGENTA, PINK, ORANGE, WHITE, YELLOW`	All colour names that correspond to a valid colour value in CSS.
Default value	`BLUE`

Settings for signotec signature pads

The following settings are relevant when using signotec signature pads.

web.serialPadSearchType

Description	This setting defines whether to search for serial pads and at which ports of the client device. Serial devices are not searched for by default.
Possible values	`NONE`	A search for serial pads is not run.
	`2;3;5;7`	Values separated by a semicolon. Example: The search is run on the ports COM2, COM3, COM5 and COM7.
	`ALL`	The search will be run on all existing COM ports.
Default value	`NONE`

web.wssDomainPort

Description	This setting defines the domain names and the port from which the WebSocket of the signoPAD API/Web can be addressed. You can find more information on this in the signoPAD API/Web documentation.
Possible values	The URL from which the Websocket of the signoPAD API/Web can be reached.
Default value	local.signotecwebsocket.de:49494

Depending on the browser, there are restrictions on operating the signoPAD API/Web without TLS from a TLS-protected environment. You can find more information on this in the signoPAD API/Web documentation.
If a protocol is not explicitly specified, an attempt is made to establish a connection via WSS. If this fails, another attempt is made via WS.
If a protocol is explicitly specified, an attempt is made to establish a connection via this protocol only.

web.padCertificationAuthorities

Description	This setting can be used to define a PEM file that contains one or more certificate chains from certification authorities. The order of the certificates in the file can be freely selected. If a file is defined, signoSign/Universal checks whether the signature certificate stored in the signature device has been signed by one of the contained certificates. If this is not the case, then no signatures can be captured. This function is disabled by default. This setting serves to ensure that only signing devices with known signature certificates can be used.
Possible values	Absolute or relative file path to a PEM file.
Default value	-

web.legacySignatureImage

Description	This setting defines whether capturing a signature via the signoPAD API/Web generates a raster or a vector graphic and incorporates it into the PDF.
Possible values	`true`	The signature image is inserted into the PDF as a raster graphic.
	`false`	The signature image is inserted into the PDF as a vector graphic.
Default value	`false`

web.dynamicSignatureStrokes

Description	Defines whether signatures are captured with dynamic or constant stroke widths.
Possible values	`true`	Signatures are captured with a dynamic stroke width.
	`false`	Signatures are captured with a constant stroke width.
Default value	`true`

web.signPadDocumentView

Description	Determines whether an excerpt of the document is displayed around the signature when capturing a signature with a signing device. (s.a. signPadDocumentViewScalingFactor, signPadDocumentViewMarginLeft und signPadDocumentViewMarginTop)
Possible values	`true`	An excerpt of the document is displayed when signing on a signature device.
	`false`	A standard dialogue box is displayed when signing on a signature device.
Default value	`true`

web.signPadDocumentViewMarginTop

Description	This setting displays the upper edge of the signature field in the document excerpt. The larger the value, the greater the distance from the upper edge.
Possible values	Integer values between 0 and 100.
Default value	75

web.autoShowDocumentOnPad

Description	This setting defines whether the document display on the signature device is to be started automatically when the Viewer is opened. Autostart is only launched if a signotec Delta device has been found and signoPAD API/Web is installed on the client. This function is enabled by default.
Possible values	`true`	Reading mode is started if it is enabled.
	`false`	If reading mode is functionally available, it can be started manually.
Default value	`true`

web.signPadDocumentViewScalingFactor

Description	This setting adjusts the scaling factor for the document excerpt on the signature device. It is an integer value that specifies the scaling in per cent.
Possible values	Integer values between 10 (minimum zoom) and 200 (maximum zoom).
Default value	100

web.signPadDocumentViewMarginLeft

Description	This setting displays the left-hand edge of the signature field in the document excerpt. The larger the value, the greater the distance of the field from the left-hand edge.
Possible values	Integer values between 0 and 100.
Default value	25