Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Section

Viewer Preferences

Info

Note that changes of the viewer preferences will be effective within some minutes after uploading the changed Customization.zip file. The changes are applied also on existing envelopes. Note that changes may have legal effect even on older envelopes (e.g. enabling/disabling the SkipFinishConfirmDialog, FinishWorkstepOnOpen, AcceptAgreementDisabledUntilRequiredActionsDone but also others); consider the impact of a change carefully.



NameDescriptionValuesNote
MessageForwardingDialogBehaviourEither ‘Show’ or ‘Allow’; If ‘Show’ is set and forwarding JS PostMessages to e.g. a parent iFrame when setting PostmessageClient query parameter the user will get asked if he/she wants to allow this. When ‘Allow’ is set, the user will not get asked and sending messages to the iFrame automatically gets allowed.Possible values: 0, 1 (default)
ShowPageNavigationBarAllows to disable the page navigation bar on the left side of the viewerPossible values: 0, 1 (default)Deprecated => Use ShowPageNavigationButtons instead
ShowThumbnailsIf enabled, the thumbnail display will be visible, otherwise falsePossible values: 0, 1 (default)
SkipFinishConfirmDialogIf enabled, finish action will be executed immediately without confirm dialogPossible values: 0 (default), 1
SkipDocumentDialogIf enabled, the download document dialog after finishing the workstep will be skippedPossible values: 0 (default), 1
ShowImagesInFullWidthIf enabled, available width will be used for images which might stretch themPossible values: 0 (default), 1
DisableGeolocationIf enabled, Geolocation won’t be used for webservice callsPossible values: 0 (default), 1
ShowDocumentDownloadDialogAfterAutomaticFinishIf enabled, the “Download documents dialog” after automatically finishing the workstep will be shown (e.g. acknowledge receipt scenario)Possible values: 0 (default), 1
AttachmentsMaxFileSizeAllows to configure the maximum file size for attachments in kBytesPossible values: Any integer value, (default: 2048)Not possible via customization
SkipPreviewImageOnDisposableCertificateAllows to disable the preview image of the signature when using the Namirial Disposable certificate functionalityPossible values: 0, 1 (default)
LoadCustomJsIf enabled, a Custom.js file will be loaded when the page is opened allowing to configure customized dataPossible values: 0 (default), 1Not possible via customization
AllowCustomButtonsIf enabled, custom buttons can be added via xyzmo.Customization pluginPossible values: 0 (default), 1Not possible via customization
GuidingBehaviorDefines how the viewer should guide through the tasksPossible values: GuideOnlyRequiredTasks, GuideRequiredAndOptionalTasks (default), GuideDisabled
FormFieldsGuidingBehaviorDefining how the viewer should guide through form fieldsPossible values: AllowSubmitAlways (default), AllowSubmitOnlyAfterAllRequiredFieldsAreDone
ShowVersionNumberDefining if the viewer should show the version numberPossible values: 0, 1 (default)Deprecated => Use ShowStatusBar instead
EnableWarningPopupOnLeaveDefining if the viewer should display a warning popup when the user leaves the pagePossible values: 0, 1 (default)
WarningPopupDisplayAfterDefining when the warning popup should be displayedPossible values: FillOrSignField (default), Authentication, Always, Agreement
FinishWorkstepOnOpenIf set to 1 the workstep is automatically finished when opened in the viewer, if finishing is possiblePossible values: 0 (default), 1Not possible via customization
MultipleSignatureTypesAndBatchSigningSettings / IsUseBatchSigningCheckedByDefaultIf enabled, the “Use batch signing” checkbox inside the dialog when signing a signature field is checked by defaultPossible values: 0, 1 (default)
MultipleSignatureTypesAndBatchSigningSettings / IsRememberSignatureTypeCheckedByDefaultIf enabled, the “Remember signature type” checkbox inside the dialog when signing a signature field is checked by defaultPossible values: 0 (default), 1
MultipleSignatureTypesAndBatchSigningSettings / IsRememberBatchSigningDecisionCheckedByDefaultIf enabled, the “remember batch signing decision” checkbox inside the dialog when signing a signature field is checked by defaultPossible values: 0 (default), 1
MultipleSignatureTypesAndBatchSigningSettings / SkipMultipleSignatureTypesAndBatchSigningDialogIfBatchSigningPossibleIf enabled, and the IsUseBatchSigningCheckedByDefault is also enabled, the dialog to confirm the batch signing (and optionally choosing the signature type) will be skipped if either the signature type to use has been remembered earlier or a preferred type is setPossible values: 0 (default), 1
AutoFinishAfterRequiredTasksDoneIf enabled, finish action will be automatically triggered after last required task is donePossible values: 0 (default), 1
GuidingBehaviorOnFinishedTaskDefines the guiding behavior after a task has been completed (e.g. signature field has been signed). This flag is not taken into account if the guiding is disabledPossible values: NoMove, MoveToNext (default), MoveToNextAndActivate
SkipThankYouDialogIf enabled, hints that the document can now be finished after all required tasks have been done, will be shownPossible values: 0 (default), 1Deprecated => Use ShowFinishPossibleHint instead
DisplayRejectButtonInLeftBar (replaced by DisplayRejectButtonInTopBar in SSP 4.15.54 or higher)If enabled, the ‘reject’ button will be displayed in the left bar below the ‘finish’ button as wellPossible values: 0 (default), 1
NativeAppsUrlSchemeDefines the url scheme for the native SAW Viewer applications (needed for customized SAW Viewer apps)Possible values: Any custom URL scheme (default: esignanywhere)Not possible via customization
DocumentViewingModeDefines whether the envelope is displayed in its entirety or if only a specific document is shown at a timePossible values: EndlessPaperAllDocuments (default), EndlessPaperPerDocument
ThumbnailModeDefines the appearance of the thumbnail view: all pages of the entire document are shown, or only the first page of each document within an envelopePossible values: ShowAllPages (default), ShowFirstPageOnly
ShowTopBarDefines if the top bar should be visible or not. If disabled, also the ‘GuidingBehavior’ and the ‘DisplayRejectButtonInTopBar’ will be deactivated.Possible values: 0, 1 (default)
DisplayRejectButtonInTopBar (replaces DisplayRejectButtonInLeftBar from 4.15.54)If enabled, the ‘reject’ button will be displayed in the top bar next to the ‘finish’ button as well.Possible values: 0 (default), 1
PhoneNumberInputSettings/DefaultCountryDefine If ‘auto’ , then WhoIsPlugin is used to find the country code via IP address is defined, the first one of the list is preselected or use ISO 3166-1 alpha-2 code (f.e. ‘it’)Possible values: auto (default), ISO 3166-1 alpha-2 code (f.e. ‘it’)
PhoneNumberInputSettings/PreferredCountryListDefine If ‘auto’ , then WhoIsPlugin is used to find the country code via IP address is defined, the first one of the list is preselected or use ISO 3166-1 alpha-2 code (f.e. ‘it’)Possible values: it,ro,at,de (default), ISO 3166-1 alpha-2 code (f.e. ‘it’)
TriggerBankIdDesktopAppDefines if the BankID desktop app should be triggered from the browser when authenticating via BankID.Possible values: 0 (default), 1Not possible via customization
ShowPageGapDefines whether or not to show a small gap between pages containing some bits of information (like corresponding document and page x/y) in Desktop/Tablet UIPossible values: 0, 1 (default)
AutoStartGuidingDefines if the guiding (if disabled at all) should be started directly upon start.Possible values: 0 (default), 1
ShowFinishPossibleHintIf enabled, hints that the document can now be finished after all required tasks have been done, will be shownPossible values: 0, 1 (default)
ShowStartGuidingHintIf enabled, a hint to the next button is shown, where the guide can be startedPossible values: 0, 1 (default)
ShowStatusBarDefines if the status bar at the bottom should be visible or not. If disabled, product and version number and biometric signature device selection window is not availablePossible values: 0, 1 (default)
ShowPageNavigationButtonsallows to disable the page navigation buttons on the left side of the viewerPossible values: 0, 1 (default)
ShowZoomButtonsallows to disable the zoom buttons on the left side of the viewerPossible values: 0, 1 (default)
ShowNoGeolocationWarningDefines if a warning should be shown in case the browser does not allow to retrieve the geolocation.Possible values: 0 (default), 1Not possible via customization
SkipRejectConfirmDialogIf enabled, reject action will be executed immediately without confirm dialogPossible values: 0 (default), 1
DisableSignOnPhoneDefines if SignOnPhone (if configured appropriately) should be offered as an option to sign biometrically.Possible values: 0 (default), 1
DisableMouseForBiometricSignatureDefines if 'Mouse' should be offered as an option to sign biometrically upon using SIGNificant Device Driver.Possible values: 1 (default), 0
SignatureComplexityChecks/Draw2Sign/MinimumPacketsMinimum count/amount of packets for a signature. Default is empty value or 0 => All signatures are accepted in terms of lengthDefault: 0 (disabled)
SignatureComplexityChecks/Draw2Sign/MinimumTimeInMs

Minimum time in milliseconds for a signature. Default is empty value or 0 => All signatures are accepted in terms of duration

Default: 0 (disabled)


...