Integration Guide pdoc SigCapture SDK

Transcription

1 Integration Guide pdoc SigCapture SDK Version 1.5 August 1, 2017 Copyright 2017 Topaz Systems Inc. All rights reserved. For Topaz Systems, Inc. trademarks and patents, visit

2 Table of Contents 1 Introduction Overview Key Features Operating Systems Supported Signature Capture Devices Components of pdoc SigCapture SDK Classes Capture Properties Methods SetSignatureInfo StartSign ClearSign CloseConnection GetSignatureImage GetSignatureData GetSigString GetDeviceInfo SaveAsSIGFile SaveAsSIGPFile TabletDisplay Methods IsTabletDisplaySupported IsTabletDisplayConnected GetTabletDisplayMonitorNumber Integration with Host Application Using standard Capture Control Using host provided Control Back to Top

3 1 Introduction pdoc SigCapture SDK provides capabilities for capturing secured biometric handwritten signatures using Signature Capture devices from Topaz Systems, Signature Capture devices from epadlink, Windows Tablets, and GemView Tablet Displays on Windows Platforms. The signatures captured using this SDK can be used in conjunction with Topaz pdoc SigEmbed SDK to embed signatures into a PDF document. The SDK provides methods to generate the images of the captured signatures and hence can be used in any application requiring signature images too. The biometric signature data for the captured signature can be obtained in encrypted form and saved in any database for future use. 2 Overview Supports capturing of biometric handwritten signatures using Topaz and epadlink signature pads. Provides API for capturing handwritten signatures using Windows tablets and GemView Tablet Displays. Provides APIs to export the captured handwritten signature as an image along with the raw biometric data for future use, like embedding into any document. This SDK can be used in conjunction with the Topaz pdoc SigEmbed SDK to sign a signature field in a PDF document. 3 Back to Top

4 3 Key Features pdoc SigCapture SDK will support the following key features. Host Applications can use the standard control provided by the SDK for capturing and displaying signatures or they can provide host defined signature capture area handles. Set the signature information Set the signature appearance options like ink color Set whether smoothing for signatures is enabled or not Set the minimum number of signature points required to qualify a signature as valid Initiate signature capture Clear the captured signature Export signature image Export the raw biometric signature data in secured form Provide the connected Signature Pad information Check whether a signature is valid or not Export the captured signature data as a Topaz SigPlus compatible.sig format Export the captured signature data as.sigp format Check if a GemView Tablet Display is supported for signature capture Check if a GemView Tablet Display is connected to the PC Retrieve the monitor number of the GemView Tablet Display Specify if custom text is to be displayed in the signature image Specify the custom text that is to be displayed in the signature image Specify the percentage of the signature image that will be used for displaying for custom text 4 Operating Systems Supported The pdoc SigCapture SDK is supported for operating systems Windows Vista and higher, and Windows Tablets. 4 Back to Top

5 5 Signature Capture Devices The pdoc SigCapture SDK supports capturing signatures using signature capture devices from Topaz Systems and epadlink. It also supports capturing signatures from Windows tablets and GemView Tablet Displays; to capture signatures from Windows Tablets, you must acquire a special licensed version of the SDK. Contact Topaz Systems ( for further information. Signature Capture Device drivers need to be installed separately for the pdoc SigCapture SDK to capture signatures using signature pad devices. 6 Components of pdoc SigCapture SDK The main component of pdoc SigCapture SDK is pdoc.sigcapture.dll. As pdoc SigCapture SDK requires supporting components installed by the device drivers for capturing signatures, the following list of files needs to be available along with the pdoc.sigcapture.dll in the same folder for integrating pdoc SigCapture SDK into any application. 1. AxInterop.EpadInkLib.dll 2. Interop.EpadInkLib.dll 3. AxInterop.GIIEPADLib.dll 4. Interop.GIIEPADLib.dll 5. AxInterop.SIGPLUSLib.dll 6. Interop.SIGPLUSLib.dll 7. SigUtil.dll 8. epadservice.dll (This file is required only if you do not have epadlink drivers installed in the machine and are using either Topaz Signature Pad or a Windows Tablet to capture the signatures) 9. WintabDotNet.dll 10. Microsoft.Ink.dll 11. pdocsdkconfig.enc Microsoft Visual Studio 2008 with.net framework 3.5 is used as the development IDE for developing pdoc.sigcapture.dll and hence.net framework 3.5 should be available in the end user machine for pdoc SigCapture SDK to work properly. 5 Back to Top

6 7 Classes The primary output component of this SDK will be pdoc.sigcapture.dll; following are the classes contained in this library. Properties and methods of each class are explained below their respective classes. 7.1 Capture Namespace pdoc.sigcapture public class Capture Properties Name Description SigViewer Enable Smoothing MinSigPoints IntPtr SigViewer bool EnableSmoothing int MinSigPoints Specifies the host defined signature capture area handle. The scribblings on the device are displayed on this area. Currently this is available only for devices from epadlink and for Windows Tablets. Not applicable for Topaz Signature Pads. Specifies if signature smoothing is enabled or not. Specifies the minimum number of points for signature to be valid. IsSignature InkColor bool IsSignature { get; } Color InkColor Specifies if the captured signature is acceptable or not based on the Minimum Number of Signature Points set. True if the captured signature is valid. Specifies the ink color for the signature InkThickness short InkThickness Specifies the ink thickness for signature PadName string PadName { get; } Returns the name of the connected signature pad. PadSerialNumb er string PadSerialNumber { get; } Returns the Serial Number of the connected signature pad if the pad has one. 6 Back to Top

7 breqserialnum ber bool PadSerialNumber Specifies if calling GetDeviceInfo method should read the serial number of the connected device. Applicable only for epadlink Signature Pads. For Topaz Signature Pads, Windows Tablets and GemView Tablet Display devices, the connected signature pad Serial Number is returned even without setting this property. ExternalDevice Check bool ExternalDeviceCheck Specifies if external signature capture devices should be enabled for signing or not. This property is useful when using a GemView Tablet Display for singing. Setting this to true will avoid checking for external signature pads and speed up the connection opening process with the GemView Tablet Display. ErrorMessage string ErrorMessage { get; } The message that describes the last error. UseTabletDispla y bool UseTabletDisplay If the application has previously detected that a GemView Tablet Display is connected to the PC and to specify that the signature capture should not check the GemView Tablet Display existence again (to speed up the signing experience), set this property to true. TabletDisplayNa me string TabletDisplayName If the UseTabletDisplay property is set to true, the TabletDisplayName property should be set too. When the application has detected the presence of the GemView Tablet Display, it can get the name of the Tablet Display. TabletDisplaySe rialnumber string TabletDisplaySerialNumber If the UseTabletDisplay property is set to true, the TabletDisplaySerialNumber property should be set too. When the application has detected the presence of the GemView Tablet Display, it can get the Serial Number of the Tablet Display. DisplayXLine bool DisplayXLine Specifies if a line with X in the beginning should be displayed in the signature capture or not. Set it to true to display the X and the line. This is applicable for epadlink pads, GemView Tablet Displays, and Windows Tablets. DisplayCustomT ext bool DisplayCustomText Specifies if display of custom text in the signature image is enabled or not. This property should be set before calling GetSignatureImage method. By default this value is set to False. 7 Back to Top

8 CustomTextPerc ent CustomTextLine 1 CustomTextLine 2 int CustomTextPercent string CustomTextLine1 string CustomTextLine2 If the DisplayCustomText property is set to true, the CustomTextPercent property specifies the percent of signature image that should be used for displaying the custom text. The minimum percent of signature image that is allocated for custom text should be between 20 and 50. Any value less than 20 is treated as 20 and value greater than 50 will be treated as 50. This property should be set before calling GetSignatureImage method. If the percent is set to be between 20 and 50 and if the custom text specified does not fit in the space available, the text would be omitted and only the squiggle is drawn on the image. If the DisplayCustomText property is set to true, the CustomTextLine1 property specifies the first line of custom text to be displayed in the signature image. This property should be set before calling GetSignatureImage method. If the DisplayCustomText property is set to true, the CustomTextLine2 property specifies the second line of custom text to be displayed in the signature image. This property should be set before calling GetSignatureImage method. The special version of pdoc SigCapture SDK for Windows Tablets does not support GemView Tablet Displays and hence the following properties (described above) are not applicable. breqserialnumber ExternalDeviceCheck UseTabletDisplay TabletDisplayName TabletDisplaySerialNumber 8 Back to Top

9 7.1.2 Methods SetSignatureInfo Sets the signature information, which will be persisted into the raw biometric signature data. void SetSignatureInfo(string FirstName, string LastName, string ID, string Location); Parameters Parameter Name Type Description FirstName String First Name LastName String Last Name ID String ID Location String Geographical Location StartSign Initiates the signature capture bool StartSign(); Returns True if initiation of the signature capture is successful and False if failed ClearSign Clears the currently capture signature void ClearSign(); CloseConnection Closes the connection with the connected signature capture device and ends the signature capture void CloseConnection(); 9 Back to Top

10 GetSignatureImage Returns the image (BMP, JPG or PNG) of the captured signature in the form of Base64 string string GetSignatureImage(int ImageFormat, Color BkColor, int iwidth, int iheight, bool bcenter, bool btransparency, bool bmaxupscalefactor, float fupscalepercent); Parameters Parameter Name Type Description ImageFormat Int Image Format (i.e. BMP, JPEG or PNG) 0 BMP 1 JPEG 2 - PNG BkColor Color Background color for the image iwidth int Width of the required image iheight Int Height of the required image bcenter Boolean Specifies if the signature should be centered in the image btransparency Boolean Specifies if the signature image should be transparent. Applicable only for PNG. bmaxupscalefactor Boolean Specifies if the Maximum Upscale Factor has to be applied while scaling up signature for display. fupscalepercent Float Specifies the percentage of the target image to be used while generating the image if the size of the signature squiggle captured is smaller than the specified image size Base64 encoded string containing the image binary data GetSignatureData Returns the encrypted raw biometric signature data in the form of Base64 string string GetSignatureData(); Base64 encoded string containing the encrypted biometric data GetSigString Returns the signature data as string that is compatible with Topaz s SigPlus SigString format string GetSigString(); String containing the signature data Back to Top

11 GetDeviceInfo Retrieves the information of the connected signature capture device. Before calling the PadName and PadSerialNumber properties, this method needs to be invoked. void GetDeviceInfo(); SaveAsSIGFile Saves the captured signature into a Topaz SigPlus compatible Signature (.SIG) file. One needs to call GetSignatureData method before saving the signature as a SIG file. bool SaveAsSIGFile(string strsigfilename); Boolean indicating if the File was generated successfully or not SaveAsSIGPFile Saves the captured signature into a.sigp file. One needs to call GetSignatureData method before saving the signature as a SIGP file. In addition to the information in the SIG file, this file contains information about pressure for each point and also the device that is used to capture the signature. bool SaveAsSIGPFile(string strsigpfilename); Boolean indicating if the File was generated successfully or not Back to Top

12 7.2 TabletDisplay Namespace pdoc.sigcapture public class TabletDisplay Methods IsTabletDisplaySupported Checks whether using GemView Tablet Display for signature capture is supported or not in this version of the SDK. bool IsTabletDisplaySupported(); Returns True if GemView Tablet Display is supported and False if not supported IsTabletDisplayConnected Checks whether GemView Tablet Display is connected to the PC or not. bool IsTabletDisplayConnected(); Returns True if GemView Tablet Display is connected and False if not connected GetTabletDisplayMonitorNumber Retrieves the monitor number of the GemView Tablet Display (if connected) as set in the Tablet Display Manager. int GetTabletDisplayMonitorNumber(); Returns the monitor number Back to Top

13 8 Integration with Host Application 8.1 Using standard Capture Control This section explains how the pdoc SigCapture SDK can be integrated with a host application. This section assumes that pdoc SigCapture SDK along with the required signature capture device drivers are already installed. Microsoft Visual Studio 2008 is used as the reference IDE for explaining the integration. 1. Open Microsoft Visual Studio Click on File New Project and under Visual C#, select Windows Forms Application. 3. Give a name for the project (e.g. SigCaptureSDKSample). 4. Change the name of the Form1 to Sample (i.e. Sample.cs). 5. If the application has to capture user information, one can insert labels and text boxes to capture the relevant information. 6. Right click on the General section of the Toolbox and select Choose Items as shown below Back to Top

14 7. In the opened Choose Toolbox Items window, under.net Framework Components, click on Browse and select the pdoc.sigcapture.dll provided to you as part of the SDK and then make sure that the component Capture is in selected mode as shown below. 8. Click on the OK button. The Capture Control will now be displayed in the General section of the Toolbox as shown below Back to Top

15 9. Select Capture and Drag it onto the Form. Set the BackColor of the Capture object to White if needed. Now the Form looks like that shown below. 8.2 Using host provided Control 1. Alternatively, instead of a standard SDK capture component, host provided control (Picture Box or any other native.net Framework Control for) can also be used to capture a signature and display the same (applicable only to applications using epadlink signature capture devices and Windows Tablets). The form below is a variant of the above form containing a.net Picture Box in the place of the Capture SDK Control. In this case, the scribbling on the signature capture device is reflected in the Picture Box Back to Top

16 2. Now add a button named Start Sign to the application. If using the Capture Control from the pdoc SigCapture SDK, the button code will be as below. private void btnstartsign_click(object sender, EventArgs e) { capture1.setsignatureinfo(txtfirstname.text, txtlastname.text, txt .text, txtlocation.text); capture1.startsign(); } If using a Picture Box control from the.net Framework, the button code will be as below. private void btnstartsign_click(object sender, EventArgs e) { capture1.setsignatureinfo(txtfirstname.text, txtlastname.text, txt .text, txtlocation.text); capture1.sigviewer = picturebox1.handle; capture1.startsign(); } For the usage of other methods and properties of pdoc SigCapture SDK, refer to the Sample Application (along with the source code) provided along with the SDK Back to Top