Page tree
Skip to end of metadata
Go to start of metadata

This advanced feature is for customizing the eSignAnyWhere Viewer for the signers. You can change the colors and logo to align them to your CI and set eSAW Viewer behavior. Therefore you have to upload a ZIP-Archive with the new design settings. You can download a design template and change it. Moreover you are able to set a redirect URL when a document is finished.

You can find the the configuration for the customization of eSignAnyWhere in your organization settings in the section “Design of the document viewer for recipients”

The next screenshot shows these configurations:

If the feature is available for your organization, you can:

  • set a redirect URL for finished documents
  • upload a design
  • reset to default design
  • download a design template
  • download current design

The Customisation.zip file contains:

  • variables.xml: contains the style configuration of eSignAnyWhere. The comments in the file will help you to modify it.
  • global_variables.xml: contains settings for the eSAW Viewer
    • Note: In the global_variables.xml you can find the variable ContentSecurityPolicy. This variable allows you to integrate the viewer in an IFrame. Just enter the page URL in the “value” area on which you want to integrate the viewer. In addition to the possibility of the customization zip there are additional configurations for further scenarios available via API; and via _global.xml for on-premise. These are only required in exceptional cases or for special integration scenarios. Example: WhitelistedPostMessageClients
  • files/

In the files you can find the following:

  • logo_topbar
  • logo_loading
  • Localizations.template.custom
    • Here you can customize localizations for a specific eSAW organization
    • You can create your own Localizations.*.custom.json files, modify the elements which should be customized and add the file to the customization package
  • custom.css
    • Here you can customize the layout for a specific eSAW organization
    • You can adapt the layout of the SAW Viewer

If you have modified the files just put them in an archive and upload via UI. You can use svg instead of png, gif or jpg.

Customization of localizations

Following feature flag is necessary for this feature: UseCustomizationId

Please note the following: This is a non-default feature of eSignAnyWhere. If you are interested in this optional feature please contact us.

In detail the following options are possible:

  • Customize localizations for a specific eSAW organization (only possible in combination with eSAW and Customization Service):
    • The WSC customization package contains a Localizations.template.custom.json containing all keys & english values of the XLF but in JSON format.
    • You can create your own Localizations.*.custom.json files (e.g. Localizations.de.custom.json), modify the elements which should be customized and add the file to the customization package.
    • For better maintenance all items which have not been changed should be removed from the JSON file.

Note: Not all sections of the XLF file are allowed to be configured that way (e.g. to prevent possible problems with changing audit trail texts)

  • Customize localizations for the whole SSP instance (or in case Customization Service is not used):
    • Grab the Localizations.template.custom.json from the default customization service package (see Release Notes)
    • Modify the file like described above (content, filename)
    • Place the file in the i18n folder next to the XLF files
  • Combination of these two possibilities
    • In case of a 'combined' customization (JSON files available in Customization Service and i18n folder) the two JSON files will be merged. In case items are included in both files, the items from the Customization Service will override the ones from the i18n folder.

Please note: It is not recommended anymore to change the XLF files (SignAnyWhere Viewer) directly!

Customization of the SAW Viewer Layout (custom.css)

The following properties are allowed to change:

"display": {},
"visibility": {},
"width": {},
"height": {},
"border-radius": {},
"margin": {},
"margin-top": {},
"margin-bottom": {},
"margin-left": {},
"margin-right": {},
"padding": {},
"padding-top": {},
"padding-bottom": {},
"padding-left": {},
"padding-right": {},
"color": {},
"background-color": {},
"background-repeat": {},
"background-position": {},
"border-color": {}

Please also see the next sample:

#topBar {
    background-color: red
}

#leftBarView{
	visibility: hidden
}

Open variables.xml and look for the following lines of code to change the colors of for example the page navigation background.

Replace the following line:

<variable name="lighterGrayColor" value="#{[color:#d3d0d0]}#" comment="
	default: #d3d0d0
	used as thumbnail background, page navigation background, disabled form fields, menu button hover effects
" category=""/>

With this one:

<variable name="lighterGrayColor" value="#{[color:#8b8989]}#" comment="
	default: #d3d0d0
	used as thumbnail background, page navigation background, disabled form fields, menu button hover effects
" category="" />

After the page navigation background color we are now changing the document background color. Therefor, search for the following line and change it to the lines below:

Replace the following line:

<variable name="lightestGrayColor" value="#{[color:#ebeaea]}#" comment="
	default: #ebeaea
	mainly used for the document background and menu backgrounds
" category=""/>

With this one:

<variable name="lightestGrayColor" value="#{[color:#EEE9E9]}#" comment="
	default: #ebeaea
	mainly used for the document background and menu backgrounds
" category="" />

After the document background color we are now changing the top page navigation. Therefore, search for the following line and change it to the line below.

Replace the following line:

<variable name="defaultColor" value="#{[color:#661864]}#" comment="
	default: #661864
	affects the cancel button border, active page navigation bar items, top small bar, focused element in the document, upload progress bars, finished message background color, active page border, active thumbnail border, icons and headers in dialogs, batch signing progressbar foreground, SignOnPhone background color
" category="" />

With this one:

<variable name="defaultColor" value="#{[color:#000088]}#" comment="
	default: #661864
	affects the cancel button border, active page navigation bar items, top small bar, focused element in the document, upload progress bars, finished message background color, active page border, active thumbnail border, icons and headers in dialogs, batch signing progressbar foreground, SignOnPhone background color
" category="" />

After this configurations the viewer should look like the following:


 For changing the Logo you have to put your Logo in the subfolder /files. Then you have to change the variables.xml to set the new files (e.g. my-logo-large.png and my-logo-small.png).

<variable name="logoCollapsedUrl" value="#{[image:my-logo-small.png]}#" ... />
<variable name="logoExpandedUrl" value="#{[image:my-logo-large.png]}#" ... />

Save the files and pack it in a zip-file (e.g. “my-style.zip”), with same structure as the downloaded Customization.zip, and upload it as new design in your organization settings.

There are to places in the XML where you can define the logo:

  • For the loading screen
  • and for the top bar


Loading screenTop bar




It may take some minutes until the new design is applied to your eSignAnyWhere Viewer.

Viewer Preferences

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 ‘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/PreferredCountryListDefine ‘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’)
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

Document Policies


NameDescriptionValues
AllowSaveDocumentIs the client allowed to save the workstep documentPossible values: 0 (default), 1
AllowSaveAuditTrailIs the client allowed to save the audittrail documentPossible values: 0 (default), 1
AllowRotatingPagesIs the client allowed to rotate the pages of the documentPossible values: 0 , 1 (default)
AllowAppendFileToWorkstepIs the client allowed to append a file to the workstepPossible values: 0 (default), 1
AllowAppendTasksToWorkstepIs the client allowed to add append tasks to the workstepPossible values: 0 (default), 1
AllowEmailDocumentIs the client allowed to email the workstep documentPossible values: 0 (default), 1
AllowPrintDocumentIs the client allowed to print the workstep documentPossible values: 0 (default), 1
AllowFinishWorkstepIs the client allowed to finish the workstepPossible values: 0 , 1 (default)
AllowRejectWorkstepIs the client allowed to reject the workstepPossible values: 0 (default), 1
AllowRejectWorkstepDelegationIs the client allowed to reject the workstep with reject type ‘Delegation’Possible values: 0 , 1 (default)
AllowUndoLastActionIs the client allowed to undo actionsPossible values: 0 (default), 1
AllowColorizePdfFormsIs the client allowed to colorize pdf formsPossible values: 0 (default), 1
AllowReloadOfFinishedWorkstepIs the client allowed to view/download the document after finishingPossible values: 0 , 1 (default)
AllowAdhocPdfAttachmentsIs the client allowed to add adhoc attachmentsPossible values: 0 (default), 1
AllowAdhocSignaturesIs the client allowed to add signatures which are not defined in the tasksPossible values: 0 (default), 1
AllowAdhocStampingsIs the client allowed to add stampings which are not defined in the tasksPossible values: 0 (default), 1
AllowAdhocFreeHandAnnotationsIs the client allowed to add adhoc freehand annotationsPossible values: 0 (default), 1
AllowAdhocTypewriterAnnotationsIs the client allowed to add adhoc typewriter annotationsPossible values: 0 (default), 1
AllowAdhocPictureAnnotationsIs the client allowed to add adhoc picture annotationsPossible values: 0 , 1 (default)
AllowAdhocPdfPageAppendingIs the client allowed to append adhoc documentsPossible 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.

  <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>

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


ParameterValuesDescription
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>
  • No labels