ViewSign Professional SDK Documentation FAQ: Difference between revisions
No edit summary |
No edit summary |
||
| Line 81: | Line 81: | ||
Please note that the replacements arent' used immediately, instead they are used after the first "fresh" use of a screen after a replacement has been set. E.g. if you replace an advertisement image while advertisements are shown, the new images are used after a '''ShowAdvertisementScreen''' call. | Please note that the replacements arent' used immediately, instead they are used after the first "fresh" use of a screen after a replacement has been set. E.g. if you replace an advertisement image while advertisements are shown, the new images are used after a '''ShowAdvertisementScreen''' call. | ||
==How can I reduce the amount of data transfered because of the PDF images?== | |||
Usually, all pages of a PDF/workstep are preloaded in background in this order: | |||
# first shown page (usually page 1) | |||
# pages with a signature field | |||
# pages before/after a page with a signature field | |||
# all remaining pages | |||
The preloading of the "remaining pages" can be disabled in _global.xml: | |||
PdfPages\PreloadAll | |||
Furthermore, the image quality of the images can be reduced in _global.xml: | |||
PdfPages\RenderResolutionFactor | |||
* e.g. 1.0 means that the pages is rendered in the exact required size (optimal quality) | |||
* e.g. 0.75 means that the pixel width/height of the rendered image have just 75 % of the optimal quality size | |||
[[Category:ViewSign Professional]] | [[Category:ViewSign Professional]] | ||
Revision as of 08:28, 1 September 2020
How do I skip the manual calibration for Wacom DTU devices
Please calibrate the DTU once and then you find in c:\Users\USERNAME\AppData\Roaming\WTablet\ two files tablet.dat and wacom.dat which have to be roll-out during the DTU installation to avoid recalibrating on every single station.
How do I show another advertisement screen than the default advertisement screen?
You can either enable transitions to other advertisement screens by placing buttons, or by using the SDK command ShowAdvertismenetScreen(string screenId)
How can I prevent the operator from clicking buttons via the Screen Monitor?
In the _global.xml, there is a config entry ScreenMonitor\DisabledButtons, where you can configure buttons which can not be clicked from the ScreenMonitor.
The following would disable all "accept" buttons in all sign dialogs (pdf sign dialog, enroll sign dialog, custom sign screen dialog)";".
<ScreenMonitor showInTray="true"> ... <DisabledButtons>sigAccept;enrollAccept;custSigAccept</DisabledButtons> </ScreenMonitor>
Please note that in Citrix/RDP/Horizon scenarios, this must be configured on the thin client side.
My usecase requires a manual confirmation of every taken customer signature. Is this possible?
This is possible by setting operatorCheckSignature to true. This parameter is part of the Kiosk API methods "WorkstepOpen" and "PdfLoad". When this feature is enabled, the Kiosk SDK will show a dialog to the operator after a captured signature from the customer. The operator is then able to accept or reject the signature.
How can I decrease the CPU consumption of the Screen Monitor?
In the _global.xml, there is a config entry ScreenMonitor\IntervalInMs, where you can set the update interval in milliseconds. When you increase the interval (decrease the refresh rate), the CPU consumption will be lower. Furthermore, the config entry ScreenMonitor\RenderingMode can be set to LowQuality for a further performance improvement.
How can I manage centralized advertisements?
You have to redirect the location of the layout configuration xml (inside _global.xml) and all paths to images, videos, .. inside the layout configuration xml to a network share.
Example: configure the layout for a DTU 1031 (1280x800) to a network share \\myCompanyNetwork\kioskConfigShare.
- Copy kioskConfig_1280_800.xml and all used videos and images to \\myCompanyNetwork\kioskConfigShare
- Inside _global.xml, map to the copied kioskConfig_1280_800.xml:
... <KioskConfigs> ... <Config width="1280" height="800">\\myCompanyNetwork\kioskConfigShare\kioskConfig_1280_800.xml</Config> //if the signing screen uses 1280x800, this configuration will be used ... </KioskConfigs> ...
- Inside \\myCompanyNetwork\kioskConfigShare\kioskConfig_1280_800.xml, redirect all image paths to the network share, e.g.:
<slideShow x="120" y="10" width="784" height="748" backColor="White" > <image path="\\myCompanyNetwork\kioskConfigShare\PromoScreen1.jpg" intervalInSeconds="5"/> <video path="\\myCompanyNetwork\kioskConfigShare\SIGNificant Server.avi" /> </slideShow>
How can I implement different branches in my survey?
You can use multiple custFormShowScreen buttons on one CustomFormScreen which direct to different screens.
Sample:
<CustomFormScreen id="screen1" backColor="...">
...
<button ...>
<action type="custFormShowScreen" parameter="screen2.A"/>
</button>
<button ...>
<action type="custFormShowScreen" parameter="screen2.B"/>
</button>
</CustomFormScreen>
<CustomFormScreen id="screen2.A" backColor="...">
...
</CustomFormScreen>
<CustomFormScreen id="screen2.B" backColor="...">
...
</CustomFormScreen>
How can I enable or disable the accept button?
When using local PDFs, the accept button is shown when the enableAcceptButton parameter of PdfShow is set to true, and all required signature fields are signed.
When using a workstep, the accept button is shown when the workstep policy allows finishing and all required workstep tasks are completed.
My Kiosk SDK integration does not connect to the Kiosk. Why?
When you try to connect the Kiosk SDK integration library (xyzmo.Sdk.dll or xyzmo.Sdk-VERSION.jar) to the Kiosk SDK, the Kiosk SDK (SIGNificant Kiosk SDK.exe) must be started first. The integration library will not start the Kiosk SDK. Furthermore, the integration library and the Kiosk SDK must be from the same version. E.g. a xyzmo.Sdk.dll 1.3.69.0 will not be able to connect to Kiosk 1.3.93.0.
How can I replace images like advertisement images on the fly?
With the API command OverrideResource, every image in a screen XML file can be replaced during run time. To replace e.g. a resource with relative path "Resources/Kiosk/SlideShowDefault/PromoScreen1.jpg" on the fly, call OverrideResource("Resources/Kiosk/SlideShowDefault/PromoScreen1.jpg", imageData). This works for all used images and videos in all screens (like advertisement slideshow images). With ClearOverrideResourceCache the resource replacements are removed.
<AdvertisementScreen id="adSlideShow" backColor="Black">
<slideShow x="120" y="10" width="1040" height="780" backColor="White" >
<image path="Resources/Kiosk/SlideShowDefault/PromoScreen1.jpg" intervalInSeconds="5"/>
...
Please note that the replacements arent' used immediately, instead they are used after the first "fresh" use of a screen after a replacement has been set. E.g. if you replace an advertisement image while advertisements are shown, the new images are used after a ShowAdvertisementScreen call.
How can I reduce the amount of data transfered because of the PDF images?
Usually, all pages of a PDF/workstep are preloaded in background in this order:
- first shown page (usually page 1)
- pages with a signature field
- pages before/after a page with a signature field
- all remaining pages
The preloading of the "remaining pages" can be disabled in _global.xml:
PdfPages\PreloadAll
Furthermore, the image quality of the images can be reduced in _global.xml:
PdfPages\RenderResolutionFactor
- e.g. 1.0 means that the pages is rendered in the exact required size (optimal quality)
- e.g. 0.75 means that the pixel width/height of the rendered image have just 75 % of the optimal quality size