SignAnyWhere Viewer - Customization

Viewer Preferences

Name Description Values Note
ShowPageNavigationBar Allows to disable the page navigation bar on the left side of the viewer Possible values: 0, 1 (default) Deprecated => Use ShowPageNavigationButtons instead
ShowThumbnails If enabled, the thumbnail display will be visible, otherwise false Possible values: 0, 1 (default)
SkipFinishConfirmDialog If enabled, finish action will be executed immediately without confirm dialog Possible values: 0 (default), 1
SkipDocumentDialog If enabled, the download document dialog after finishing the workstep will be skipped Possible values: 0 (default), 1
ShowImagesInFullWidth If enabled, available width will be used for images which might stretch them Possible values: 0 (default), 1
DisableGeolocation If enabled, Geolocation won’t be used for webservice calls Possible values: 0 (default), 1
ShowDocumentDownloadDialogAfterAutomaticFinish If enabled, the “Download documents dialog” after automatically finishing the workstep will be shown (e.g. acknowledge receipt scenario) Possible values: 0 (default), 1
AttachmentsMaxFileSize Allows to configure the maximum file size for attachments in kBytes Possible values: Any integer value, (default: 2048) Not possible via customization
SkipPreviewImageOnDisposableCertificate Allows to disable the preview image of the signature when using the Namirial Disposable certificate functionality Possible values: 0, 1 (default)
LoadCustomJs If enabled, a Custom.js file will be loaded when the page is opened allowing to configure customized data Possible values: 0 (default), 1 Not possible via customization
AllowCustomButtons If enabled, custom buttons can be added via xyzmo.Customization plugin Possible values: 0 (default), 1 Not possible via customization
GuidingBehavior Defines how the viewer should guide through the tasks Possible values: GuideOnlyRequiredTasks, GuideRequiredAndOptionalTasks (default), GuideDisabled
FormFieldsGuidingBehavior Defining how the viewer should guide through form fields Possible values: AllowSubmitAlways (default), AllowSubmitOnlyAfterAllRequiredFieldsAreDone
ShowVersionNumber Defining if the viewer should show the version number Possible values: 0, 1 (default) Deprecated => Use ShowStatusBar instead
EnableWarningPopupOnLeave Defining if the viewer should display a warning popup when the user leaves the page Possible values: 0, 1 (default)
WarningPopupDisplayAfter Defining when the warning popup should be displayed Possible values: FillOrSignField (default), Authentication, Always, Agreement
FinishWorkstepOnOpen If set to 1 the workstep is automatically finished when opened in the viewer, if finishing is possible Possible values: 0 (default), 1 Not possible via customization
MultipleSignatureTypesAndBatchSigningSettings / IsUseBatchSigningCheckedByDefault If enabled, the “Use batch signing” checkbox inside the dialog when signing a signature field is checked by default Possible values: 0, 1 (default)
MultipleSignatureTypesAndBatchSigningSettings / IsRememberSignatureTypeCheckedByDefault If enabled, the “Remember signature type” checkbox inside the dialog when signing a signature field is checked by default Possible values: 0 (default), 1
MultipleSignatureTypesAndBatchSigningSettings / IsRememberBatchSigningDecisionCheckedByDefault If enabled, the “remember batch signing decision” checkbox inside the dialog when signing a signature field is checked by default Possible values: 0 (default), 1
MultipleSignatureTypesAndBatchSigningSettings / SkipMultipleSignatureTypesAndBatchSigningDialogIfBatchSigningPossible If 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 set Possible values: 0 (default), 1
AutoFinishAfterRequiredTasksDone If enabled, finish action will be automatically triggered after last required task is done Possible values: 0 (default), 1
GuidingBehaviorOnFinishedTask Defines 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 disabled Possible values: NoMove, MoveToNext (default), MoveToNextAndActivate
SkipThankYouDialog If enabled, hints that the document can now be finished after all required tasks have been done, will be shown Possible values: 0 (default), 1 Deprecated => 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 well Possible values: 0 (default), 1
NativeAppsUrlScheme Defines 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
DocumentViewingMode Defines whether the envelope is displayed in its entirety or if only a specific document is shown at a time Possible values: EndlessPaperAllDocuments (default), EndlessPaperPerDocument
ThumbnailMode Defines the appearance of the thumbnail view: all pages of the entire document are shown, or only the first page of each document within an envelope Possible values: ShowAllPages (default), ShowFirstPageOnly
ShowTopBar Defines 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/DefaultCountry Define ‘auto’, then WhoIsPlugin is used to find the country code via IP address 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/PreferredCountryList Define ‘auto’, then WhoIsPlugin is used to find the country code via IP address 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’)
TriggerBankIdDesktopApp Defines if the BankID desktop app should be triggered from the browser when authenticating via BankID. Possible values: 0 (default), 1 Not possible via customization
ShowPageGap Defines 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 UI Possible values: 0, 1 (default)
AutoStartGuiding Defines if the guiding (if disabled at all) should be started directly upon start. Possible values: 0 (default), 1
ShowFinishPossibleHint If enabled, hints that the document can now be finished after all required tasks have been done, will be shown Possible values: 0, 1 (default)
ShowStartGuidingHint If enabled, a hint to the next button is shown, where the guide can be started Possible values: 0, 1 (default)
ShowStatusBar Defines 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 available Possible values: 0, 1 (default)
ShowPageNavigationButtons allows to disable the page navigation buttons on the left side of the viewer Possible values: 0, 1 (default)
ShowZoomButtons allows to disable the zoom buttons on the left side of the viewer Possible values: 0, 1 (default)
ShowNoGeolocationWarning Defines if a warning should be shown in case the browser does not allow to retrieve the geolocation. Possible values: 0 (default), 1 Not possible via customization
SkipRejectConfirmDialog If enabled, reject action will be executed immediately without confirm dialog Possible values: 0 (default), 1

Document Policies

 

Name Description Values
AllowSaveDocument Is the client allowed to save the workstep document Possible values: 0 (default), 1
AllowSaveAuditTrail Is the client allowed to save the audittrail document Possible values: 0 (default), 1
AllowRotatingPages Is the client allowed to rotate the pages of the document Possible values: 0 , 1 (default)
AllowAppendFileToWorkstep Is the client allowed to append a file to the workstep Possible values: 0 (default), 1
AllowAppendTasksToWorkstep Is the client allowed to add append tasks to the workstep Possible values: 0 (default), 1
AllowEmailDocument Is the client allowed to email the workstep document Possible values: 0 (default), 1
AllowPrintDocument Is the client allowed to print the workstep document Possible values: 0 (default), 1
AllowFinishWorkstep Is the client allowed to finish the workstep Possible values: 0 , 1 (default)
AllowRejectWorkstep Is the client allowed to reject the workstep Possible values: 0 (default), 1
AllowRejectWorkstepDelegation Is the client allowed to reject the workstep with reject type ‘Delegation’ Possible values: 0 , 1 (default)
AllowUndoLastAction Is the client allowed to undo actions Possible values: 0 (default), 1
AllowColorizePdfForms Is the client allowed to colorize pdf forms Possible values: 0 (default), 1
AllowReloadOfFinishedWorkstep Is the client allowed to view/download the document after finishing Possible values: 0 , 1 (default)
AllowAdhocPdfAttachments Is the client allowed to add adhoc attachments Possible values: 0 (default), 1
AllowAdhocSignatures Is the client allowed to add signatures which are not defined in the tasks Possible values: 0 (default), 1
AllowAdhocStampings Is the client allowed to add stampings which are not defined in the tasks Possible values: 0 (default), 1
AllowAdhocFreeHandAnnotations Is the client allowed to add adhoc freehand annotations Possible values: 0 (default), 1
AllowAdhocTypewriterAnnotations Is the client allowed to add adhoc typewriter annotations Possible values: 0 (default), 1
AllowAdhocPictureAnnotations Is the client allowed to add adhoc picture annotations Possible values: 0 , 1 (default)
AllowAdhocPdfPageAppending Is the client allowed to append adhoc documents Possible values: 0 (default), 1

Configurations

Configurations for API integrations, where you directly configure the workstep per recipient.

WorkstepIdStampConfiguration

In the configuration of the workstep you can define the stamp imprint:

<workstepIdStampConfiguration>
    <referenceCorner>Upper_Left</referenceCorner>
    <color>White</color>
    <location width="340" height="15" marginLeft="3" marginTop="3" />
</workstepIdStampConfiguration>

NotificationConfiguration

Also the notification configuration is possible via the workstep configuration.

<NotificationConfiguration>
    <NotificationEventsNotToSend>
        <NotificationEvent>ActionCalledEvent</NotificationEvent>
        <NotificationEvent>WorkstepCreated</NotificationEvent>
        <NotificationEvent>SignWorkstepDocument</NotificationEvent>
    </NotificationEventsNotToSend>
    <NotificationUrl>http://localhost:52094/ReceiverSample.aspx?WorkstepId=##WorkstepId##&EventType=##EventType##&Source=##Source##&Time=##Time##&Description=##Description</NotificationUrl>
</NotificationConfiguration>

StampImprintConfiguration

You also can define the stamp imprint for signature fields configuration.

Sample:
<sig id="...">
...
  <AllowedSignatureTypes>
                <sigType id="..." type="Picture">
                  <allowedCapturingMethods>Click2Sign</allowedCapturingMethods>
                  <StampImprintConfiguration>
                               <DisplayExtraInformation>1</DisplayExtraInformation>
                               <DisplayEmail>1</DisplayEmail>
                               <DisplayIp>0</DisplayIp>
                               <DisplayName>1</DisplayName>
                               <DisplaySignatureDate>1</DisplaySignatureDate>
                               <FontFamily>Times New Roman</FontFamily>
                               <FontSize>11</FontSize>
                  </StampImprintConfiguration>
                </sigType>
  </AllowedSignatureTypes>
</sig>

SignAnyWhere Viewer – Opening Link

Opening a workstep with the SAW Viewer is quite easy. Just reference to the SAW Viewer endpoint and use a workstepid parameter.

<http|https>://<server>/<virtualDirectory>/SignAnywhere.html?WorkstepId=<WorkstepId>

Parameters

Parameter Values Description
setLng (de|en|it|…) defines the UI language, if not defined the browser language is used if available, otherwise fallback to English
isRemoteDesktop (0|1) defines if Device Driver should establish a connection to DeviceDriver Client Components. Required in Citrix environments when not configured in _global.xml
ignoreDeviceDriver (0|1) defines that no device driver should be loaded. Was implemented for situations where SignOnPhone should be used.

SignAnyWhere Viewer Client Finish Action

You can configure a client finish action to be redirected to an predefined URL for the signer.

  <FinishAction>
    ...
    <ClientAction CallClientActionOnlyAfterSuccessfulSync="1" clientName="SIGNificant SignAnywhere">http://myurl.com</ClientAction>
    ...
  </FinishAction>