SDK

Technical

Reference Manual

Content

1. Introduction        4

1.1 Installation        4

1.2 Windows Desktop SDK 2.0        6

1.3 Web Based SDK 2.0        7

1.4 Supported Scanners        7

1.5 Official Website Reference        7

2. LibFXScan SDK 2.0        8

2.1 Basic Knowledge        8

2.2 Demo UI Introduction        8

2.2.1 Set and Scan        9

2.2.2 Refresh        11

2.2.3 Command and Edit        11

2.2.4 FileList        14

2.2.5 RemoveFile        14

2.2.6 Calibration        15

2.2.7 ECO        17

2.2.8 PaperReady        18

2.2.9 EjectPaper        18

2.2.10 PaperStatus        19

2.3 Non-UI Introduction        19

2.3.1 ini File Setting        20

2.3.2 Scan        20

2.3.3 Calibrate        21

2.3.4 VTM300        22

2.4 API Introduction        24

2.4.1 Lib API        25

2.4.2 CallBack Function        32

2.4.3 AutoCaptureDemo        34

2.4.4 Helpful Tips        35

2.5 Command Introduction        35

2.5.1 Key and Value        35

2.5.2 Recognize Type        57

3. WebFXScan SDK 2.0        59

3.1 Basic Knowledge        59

3.2 Demo UI Introduction        61

3.2.1 Scan Page        61

3.2.2 ini File Setting        63

3.2.3 Change Command        64

3.3 API Introduction        65

3.3.1 Web API        65

3.3.2 Calibration        65

3.4 Command Introduction        66

3.5 Http/Https demo using IIS        67

3.5.1 IIS Installation & Setting        67

3.5.2 Save Path Setting        71

4. Support Reference        72

4.1  Basic Knowledge        73

4.1.1 General FAQ        73

4.1.2 IssueDetector Tool        79

4.2 Common Issue        83

4.2.1 Init Fail        83

4.2.2 Connection Error        83

4.2.3 No Device        83

4.2.4 OCR Mismatch        87

4.2.5 No Recognize Result        88

4.2.6 Visual Studio Debug        89

4.2.7 Can’t get RFID information of SecureScan X200        90

4.3 Return Message        91

4.3.1 Error Code        91

4.3.2 Event Code        101

4.3.3 Web2.0 Error/Event Code        102

4.3.4 IP Code        102

4.4 Register        108

4.4.1 License Key Registration        108

4.4.2 Register with Scanner Serial Number        118

1. Introduction

Plustek SDK is available in two versions, we shall walk you through how to use both SDKs step by step in this manual.

• Windows Desktop SDK (hereinafter referred to as “LibFXScan” or “Lib SDK”)
• Web Based SDK (hereinafter referred to as “WebFXScan” or “Web SDK”)

1.1 Installation

https://github.com/aviswpm/PlustekSDK

Important Note

• Before using LibWFXDemo.exe or index.html , please ensure that PlustekSDK_LDSetup is installed.
• Before installing the Plustek SDK, ensure you have the compatible scanner driver installed and the scanner is connected to your computer.
• The provided demo code for LibFXScan requires Microsoft Visual C++ 2015 Redistributable for compilation.
• .NET Framework version 4.6.2 or above is required.
• For advanced services or tailored solutions, paid consultations are available, please visit Plustek. If further technical support is required, a technical support fee of USD$300/day will be charged.

Installation Steps

• Clone Demo Code: Obtain the demo code for your chosen SDK version from GitHub .
• Install the SDK: Download and run the PlustekSDK_LDSetup based on your operating system (32-bit or 64-bit).

Silent Installation

If you need a silent installation version, please contact us to download the offline installation version SDK. The GitHub version does not support silent installation.

1. Open the Offline SDK package, depending on which platform need install.

• Installer\x64\setup.ini
• Installer\x86\setup.ini

2. Configuration setup.ini

• [Setup]

• install_path : Specify the installation path. If not specified, the default path is:

• "C:\Program Files\Plustek"
• "C:\Program Files (x86)\Plustek"

• silent : silent installation, 1-> enable ; 0 -> disable

• [WebFXScan2]

• start_after_install : Start WebScan2.exe immediately after installation, 1 -> active; 0 -> disable
• start_on_boot : Automatically start WebScan2.exe when booting, 1 -> active; 0 -> disable

3. Run setup.exe

1.2 Windows Desktop SDK 2.0

The LibFXScan SDK provides a friendly integrated development environment for programmers.  It is available in C++, C#, VB and Java interfaces, with a demo application and corresponding source codes individually for each interface. Please refer to the following steps to demonstrate demo application flow:

1) Run SDK package LDSetup.exe to install WebFXScan server agent and SDK.

2) Connect to the scanner and run LibWFXDemo.exe. 

1.3 Web Based SDK 2.0

The WebFXScan uses the WebSocket to connect with Plustek scanners. Please refer to the following steps to demonstrate demo application flow:

1) Run SDK package LDSetup.exe to install WebFXScan server agent and SDK.

2) Connect to the scanner and run WebScan2.exe.

3) From the Web Client demo folder, open the index.html with Google Chrome or Microsoft Edge browser.

1.4 Supported Scanners

Plustek SDK supports various types of scanners such as ADF, flatbed, document, photo, card, passport scanner, etc. For more information on the supported scanner list, please open IssueDetector tool and then select DeviceList tab > ProductName.dat tab to check for it.

Please note that our SDK does not support switching between two SecureScan scanners.

1.5 Official Website Reference

For more online technical information please visit www.adview.com.tw and watch the introduction video on AVI Youtube.

2. LibFXScan SDK 2.0

2.1 Basic Knowledge

1. Download the scanner driver from Plustek official website.

The scanner drivers of SecureScan X Series (except X200) are already included in the SDK Package. Please do NOT download and install.

For X200, RFID module driver:

https://plustek.com/us/products/customized-scan-modules/securescan-x200/support.php          

For Plustek Other Scanner driver:  

https://plustek.com/us/support/drivers-and-downloads.php

For VTM 300, please download the latest version V.4.0.1.X (or later).

https://plustek.com/us/products/customized-scan-modules/vtm300/support.php

2. Install OCR engine package (Non-compulsory, according to the needs of recognize type)

3. Download & install Microsoft Visual C++ Redistributable for Visual Studio 2015.

Microsoft Download Center:

https://support.microsoft.com/en-us/topic/the-latest-supported-visual-c-downloads-2647da03-1eea-4433-9aff-95f26a218cc0

or

For x86:

https://aka.ms/vs/16/release/vc_redist.x86.exe

For x64:

https://aka.ms/vs/16/release/vc_redist.x64.exe

4. License Register (Please refer to Chapter 4.4 Register)

* LibFXScan SDK introduction video on AVI Youtube

2.2 Demo UI Introduction

Please build “LibWFXDemo.sln” and run the corresponding platform demo application.  

Java Demo execute command: (Only support in SDK 1.0)

2.2.1 Set and Scan

Starting from v1.1.17.22273, the demo program supports two operation methods (Dual Mode): synchronous operation and asynchronous operation. You can set the switching method in LibWebFxScan.ini. For the changes to take effect, you need to restart the LibWFXDemo.exe.

LibWebFxScan.ini Path :

• C:\Program Files\Plustek\WebFXScan2
• C:\Program Files (x86)\Plustek\WebFXScan2

If the version is earlier than v1.1.17.22273, the demo program only supports the asynchronous operation.

1. Asynchronous Operation:

The callback event needs to be registered.  The asynchronous method is used to wait for the event to be reported from the bottom layer.

Please check the command string before clicking the Set button. If the set property is successful, you can see “Device Ready!” in the log message box.  

Make sure you wait for the set property success message to show up before you select the Scan button.

2. Synchronous Operation:

Each scan is regarded as an independent single action, and the relevant information is obtained immediately after the scan completes.

After you click the Scan button, the scan will be immediately executed and the image file path, recognition result, exception error information and event error information are returned.

2.2.2 Refresh

To ensure the scanner is connected properly, please DO click the Refresh button every time when you have changed the scanner or re-plugging the scanner cable. The demo application will automatically record the last SET successful command in different scanners for each computer.

2.2.3 Command and Edit

If the scanner hasn't been set with the command before, the application will automatically set the default command for Set property; otherwise, the command will be set as the record of “the last set success”.

For the more detailed Command table definitions, please refer to  Chapter 2.5 Command Introduction.

Command.txt will save up to 5 commands which are set successfully. You can find Command.txt in : C:\ProgramData\Plustek\Modul_ID\Command.txt

ex: X-Cube = A65

The SDK demo comes with a Command Editor which can help you avoid manual typing errors.  You can use this editor interface to automatically generate commands with great ease and convenience. (Two Tabs: Normal and Other)

2.2.4 FileList

List all files under the path of the default temporary folder. %USERPROFILE%\AppData\Local\Temp\WebFXScan

2.2.5 RemoveFile

Remove file under the path of the default temporary folder.

2.2.6 Calibration

This SDK supports the calibration of SecureScan X-Mini and SecureScan X-Cube only.

Note:

1. When running Calibrate, the Command cannot be set to uv or ir or other image related settings.
2. Do remove the protective film on the calibration sheet before you execute the scanner calibration, as shown in the picture below; otherwise, the film will result in the calibration error.

3. The calibration sheet  needs to be oriented with the lettering facing up, as shown in the picture below:

4. The calibration process is only necessary when running the program on a new computer for the first time. It only needs to be calibrated once, and after that, no further calibration is required.

Steps:

1. Place the calibration sheet on the scanner.
2. Select Set and then select Calibrate (Asynchronous Mode) or select Calibrate (Synchronous Mode)
3. If the calibration successfully completes, the message “Status:[WFX_Calibare Success]” will show up.

(ShadingG.SHD will be saved in C:\ProgramData\Plustek\Model_ID\)

2.2.7 ECO

Enter the time (minutes) to configure the device when to enter sleep mode. Enter the number 0 (zero) to turn off sleep mode.

Steps:

1. Select the Set button. Proceed to Step 2 after the message “Device Ready!” shows up.
2. Select ECO.
3. Enter ECO time in the box and select Set.

Note:

Starting from v1.1.18.22495, the sleep mode is turned off by default.

To modify the default value of sleep mode, please go to the LibWebFxScan.ini under the release folder.

2.2.8 PaperReady

If the paper is detected, the message "Paper is ready!" appears; otherwise, the message "Paper is NOT ready" appears.

Steps:

1. Select the Set button.  Proceed to Step 2 after the message “Device Ready!” shows up.
2. Select PaperReady.

2.2.9 EjectPaper

Only applicable to VTM 300. VTM 300 will hold the paper in place when it finishes scanning until you choose the eject direction. Select the EjectPaper button to eject paper.

Steps:

1. Select the Set button. Proceed to Step 2 after the message “Device Ready!” shows up.
2. Select EjectPaper. The Back checkbox is unticked by default, and the scanned paper will be sent forward and then ejected out of the scanner. (If you want to return the paper back to you after it is scanned, please tick the Back checkbox. The paper will be moved backward to you after it is scanned.)

2.2.10 PaperStatus

Steps:

1. Select “Set” button when it success
2. Select PaperStatus

2.3 Non-UI Introduction

Non-UI mode is an extended version based on UI mode. It is mainly provided for customers who do not need UI to operate, and it is done by commands directly.

The dll required for Non-UI mode is nearly the same as UI mode, except that the settings of WebScan.exe and LibWebFxScan.ini, those are added to support server-side operation.

There is AviScanCMD.exe in the release folder. The operation is the same as LibWFXDemo.exe, which can be used to duplicate the command and make sure the command function is normal.

2.3.1 ini File Setting

There is LibWebFxScan.ini in the release folder which is only for Non-UI mode.

2.3.2 Scan

Steps:

1. Open WebScan.exe

2. Open AviScanCMD.exe and copy default command

path： C:\Program Files (x86)\Plustek\WebFXScan\AviScanCMD.exe

3. Search ”cmd”, select “Command Prompt”

4. Enter command as follows

cd  exe file folder path

ex：cd C:\Program Files (x86)\Plustek\WebFXScan\

5. Enter command as follows

exe file name  copied command(need to add \ in front of “)  log saving path

ex： AviScanCMD.exe {\"device-name\":\"A64\",\"source\":\"Camera\",\"recognize-type\":\"barcode\",\"barcode-type\":true}  D:\\123.txt

PS：Not support “autoscan”

6.  Open the txt file to see the result

2.3.3 Calibrate

This SDK supports the calibration of SecureScan X-Mini and SecureScan X-Cube only.

Steps:

      1 ~ 4 Please refer to section 2.3.2 Scan.

5. Enter command as follows:

exe file name  copied command(need to add \ in front of “)  log saving path

ex：AviScanCMD.exe{\"device-name\":\"A64\",\"source\":\"Camera\",\”calibrate\”:true}  D:\\123.txt

6.  Open the txt file to see the result

2.3.4 VTM300

The following commands support only VTM300 with SDK v1.1.14.22074 and later versions. 

2.4 API Introduction

This chapter will introduce SDK API definition and provide corresponding examples. To use the SDK, please ensure the following process flow:

2.4.1 Lib API

We will use C# to introduce the following section. If the developing program is in other languages please refer to …\Inc\LibWebFXScan\ LibWebFXScan.h (C/C++) or DeviceWrapper.cs in other language folders.

LibWFX_InitEx(ENUM_LIBWFX_INIT_MODE enInitMode)

The parameter ENUM_LIBWFX_INIT_MODE has two types, LIBWFX_INIT_MODE_NORMAL (use OCR) and LIBWFX_INIT_MODE_NOOCR (not

use OCR).

If you want to trace code on VS, you need to select  LIBWFX_INIT_MODE_NOOCR or use the Attach to Process  method to trace when the setting parameter is LIBWFX_INIT_MODE_NORMAL.

Example

DeviceWrapper.LibWFX_InitEx(ENUM_LIBWFX_INIT_MODE.LIBWFX_INIT_MODE_NORMAL);

LibWFX_GetDeviesList(out IntPtr szDevicesListOut)

Get the list of module names of the connected scanners.

Example 

IntPtr pstr;

List<String> m_szlistDevice;

DeviceWrapper.LibWFX_GetDeviesList(out pstr);

String json = Marshal.PtrToStringUni(pstr);

M_szlistDevice = JsonConvert.DeserializeObject<List<string>>(json);

LibWFX_GetFileList(out IntPtr szFileListOut)

Get all the file names under the temporary storage folder.

Example

IntPtr pstr;

DeviceWrapper.LibWFX_GetFileList(out pstr);

String json = Marshal.PtrToStringUni(pstr);

LibWFX_GetDeviesListWithSerial(out IntPtr szDevicesListOut, out IntPtr szSerialListOut)

Return the module name and serial number of the current connected machine.

Example

IntPtr pstr1, pstr2;

m_enErrCode = DeviceWrapper.LibWFX_GetDeviesListWithSerial(out pstr1, out pstr2);

List<String> m_szlistDevice, m_szSerialNum;

String json1 = Marshal.PtrToStringUni(pstr1);

string json2 = Marshal.PtrToStringUni(pstr2);

M_szlistDevice = JsonConvert.DeserializeObject<List<string>>(json1);

m_szSerialNum = JsonConvert.DeserializeObject<List<string>>(json2);

LibWFX_RemoveFile(String szFileNameIn)

Remove specific files in the temporary folder.

Example  

DeviceWrapper.LibWFX_RemoveFile("IMG_347111453_00001.jpg");

LibWFX_SetProperty(String szRequestCmdIn, [MarshalAs(UnmanagedType.FunctionPtr)] LIBWFXEVENTCB pfnLibWFXEVENTCBIn, IntPtr pUserDefIn)

Setting the command to the kernel layer to configure, most operations need to set this item. It only needs to be set once if the command is not changed.

Example 

ENUM_LIBWFX_ERRCODE m_enErrCode;

string command = "{\"device-name\":\"A61\", \"source\":\"Camera\",\"autoscan\":true}";

Static DeviceWrapper.LIBWFXEVENTCB m_CBEvent;

m_enErrCode = LibWFX_SetProperty(command, m_CBEvent, this.Handle);

LibWFX_StartScan([MarshalAs(UnmanagedType.FunctionPtr)] LIBWFXCB pfnLibWFXCBIn, IntPtr pUserDefIn)

Perform a scan.

Example

static DeviceWrapper.LIBWFXCB m_CBNotify;

ENUM_LIBWFX_ERRCODE m_enErrCode;

m_enErrCode = DeviceWrapper.LibWFX_StartScan(m_CBNotify, this.Handle);

LibWFX_Calibrate()

Execute the calibration function, only supports X-mini and x-cube .

Example

ENUM_LIBWFX_ERRCODE m_enErrCode;

m_enErrCode = DeviceWrapper.LibWFX_Calibrate();

LibWFX_ECOControl(out uint pulTime, int nSetIn)

Set how long the machine will enter to standby mode, the setting unit is minute.

Example

ENUM_LIBWFX_ERRCODE m_enErrCode;

unit ulTime = 5; //minute

m_enErrCode = DeviceWrapper.LibWFX_ECOControl(out ulTime, 1);

LibWFX_PaperReady()

Read the paper status.

Example

m_enErrCode = DeviceWrapper.LibWFX_PaperReady();

if (m_enErrCode == ENUM_LIBWFX_ERRCODE.LIBWFX_ERRCODE_SUCCESS)

{

//Paper is ready!

}

else if (m_enErrCode == ENUM_LIBWFX_ERRCODE.LIBWFX_ERRCODE_PAPER_NOT_READY)

{

//Paper is NOT ready!

}

else

{

//LibWFX_PaperReady() Fail!

}

LibWFX_EjectPaperControl(ENUM_LIBWFX_EJECT_DIRECTION enEjectDirectIn)

Only applicable to VTM300, which will hold the paper in place after scanning, and then the paper eject will be executed.

The parameters are LIBWFX_EJECT_FORWARDING (front side ejection) and LIBWFX_EJECT_BACKWARDING (rear side ejection).

It is recommended to use LibWFX_EjectPaperControlWithMsg() to get the machine status when ejecting paper.

Example

ENUM_LIBWFX_ERRCODE m_enErrCode;

m_enErrCode = DeviceWrapper.LibWFX_EjectPaperControl(ENUM_LIBWFX_EJECT_DIRECTION.LIBWFX_EJECT_FORWARDING);

LibWFX_EjectPaperControlWithMsg(ENUM_LIBWFX_EJECT_DIRECTION enEjectDirectIn, out IntPtr szErrorMsg)

Only applicable to VTM300, which will hold the paper in place after scanning, and then the paper eject will be executed.

The parameters are LIBWFX_EJECT_FORWARDING (front side ejection) and LIBWFX_EJECT_BACKWARDING (rear side ejection).

The szErrorMsg parameter will return the current machine status when eject paper, if it is normal, it will return an empty string, if not, it will display the corresponding error message:

LIBWFX_EVENT_DEVICE_OFFLINE: The machine lost connection

LIBWFX_EVENT_NO_PAPER: No paper detected

LIBWFX_EVENT_PAPER_JAM: paper jam

LIBWFX_EVENT_FEEDING_ERROR: Paper feed error

LIBWFX_EVENT_COVER_OPEN: The cover of the machine is not closed properly

LIBWFX_EVENT_MULTIFEED: Feed multiple sheets of paper at the same time

LIBWFX_EVENT_WRONG_HANDLER: AP cannot recognize

LIBWFX_EVENT_UNKNOWN_SCANNER: Unrecognized machine

LIBWFX_EVENT_STATUS_SCANNING: still in the SCAN process

Example

IntPtr pstr;

ENUM_LIBWFX_ERRCODE m_enErrCode;

m_enErrCode = DeviceWrapper.LibWFX_EjectPaperControl(ENUM_LIBWFX_EJECT_DIRECTION.LIBWFX_EJECT_FORWARDING, out pstr);

string szErrorMsg = Marshal.PtrToStringUni(pstr);

if (szErrorMsg.Length> 0)

WriteLog(szErrorMsg);

else if (m_enErrCode == ENUM_LIBWFX_ERRCODE.LIBWFX_ERRCODE_SUCCESS)

WriteLog(@"Status:[LibWFX_EjectPaperControl Success]");

else

              WriteLog(@"Status:[LibWFX_EjectPaperControl Fail [" + ((int)m_enErrCode).ToString() + "]]");

LibWFX_IsWindowExist(String szWindowNameIn)

Determine whether the SecureScan software has been launched on or not. An error message will show up if it has been launched.

This API is not used any more, starting from v1.1.17.22315.  Instead, settings and modifications are all set by ini.

LibWFX_GetLastErrorCode(ENUM_LIBWFX_ERRCODE enErrorCode, out IntPtr szErrorMsg)

Obtain the details of the error message for the current error code.

Example

IntPtr pstr;

m_enErrCode = DeviceWrapper.LibWFX_SetProperty(COMBO_COMMAND.Text, m_CBEvent, this.Handle);

DeviceWrapper.LibWFX_GetLastErrorCode(m_enErrCode, out pstr);

string szErrorMsg = Marshal.PtrToStringUni(pstr);

WriteLog(@"Status:[LibWFX_SetProperty Fail [" + ((int)m_enErrCode).ToString() + "]] "+ szErrorMsg.ToString());

LibWFX_GetPaperStatus(out ENUM_LIBWFX_EVENT_CODE penStatusOut)

To obtain the paper status.

Example

ENUM_LIBWFX_EVENT_CODE enPaperStatus;

m_enErrCode = DeviceWrapper.LibWFX_GetPaperStatus(out enPaperStatus);

if (m_enErrCode == ENUM_LIBWFX_ERRCODE.LIBWFX_ERRCODE_SUCCESS)

{

// LibWFX_GetPaperStatus() Success

}

else

{

// LibWFX_GetPaperStatus() Fail

}

The return value please refer to the table below:

(If the result does not show in the table below, please check 2.2.10 PaperStatus to get more error code messages.)

LibWFX_MergeToPdf(String szFileListIn)

Combine multiple images into a pdf file.

Example

string strImgList = @"d:\pic.jpg*d:\pic2.jpg";

m_enErrCode = DeviceWrapper.LibWFX_MergeToPdf(strImgList);

LibWFX_IsOCRVerMatch()

Determine whether the installed OCR version matches with the current program version.

If you use x86 SDK to do integration, the installed OCR will be x86.

Example:

if (DeviceWrapper.LibWFX_IsOCRVerMatch() == false)

 MessageBox.Show("OCR Version Mismatch!!", "Warning");

LibWFX_CloseDevice()

Close the connection with the machine, usually executed at the end of the program.

Example

LibWFX_CloseDevice();

LibWFX_DeInit()

Used when ending the program.

Example

DeviceWrapper.LibWFX_DeInit( );

LIBWFX_SynchronizeScan(String szRequestCmdIn, out IntPtr szScanImageList, out IntPtr szOCRResultList, out IntPtr szExceptionRet, out IntPtr szEventRet)

Perform scanning and return the image file path, identification result, exception error information, and event error information.

Example

IntPtr pScanImageList, pOCRResultList, pExceptionRet, pEventRet;

string Command = "{\"device-name\":\"A64\",\"source\":\"Camera\"}";

m_enErrCode = DeviceWrapper.LibWFX_SynchronizeScan(Command, out pScanImageList, out pOCRResultList, out pExceptionRet, out pEventRet);

string szExceptionRet = Marshal.PtrToStringUni(pExceptionRet);

string szEventRet = Marshal.PtrToStringUni(pEventRet);

if (m_enErrCode! = ENUM_LIBWFX_ERRCODE.LIBWFX_ERRCODE_SUCCESS && m_enErrCode! = ENUM_LIBWFX_ERRCODE.LIBWFX_ERRCODE_COMMAND_KEY_MISMATCH)

{

// SynchronizeScan Fail

}

else if (szExceptionRet.Length > 1)

{

// exception  happen

}

else if (szEventRet.Length > 1)

{

// event  happen

}

else

{

string szScanImageList = Marshal.PtrToStringUni(pScanImageList);

string szOCRResultList = Marshal.PtrToStringUni(pOCRResultList);

string[] ScanImageWords = szScanImageList.Split(']');

string[] OCRResultWords = szOCRResultList.Split(']');

for (int idx = 0; idx < ScanImageWords.Length - 1; idx++)

{

System.Console.Write(ScanImageWords[idx].Trim());  //get each image path

                   System.Console.Write(OCRResultWords[idx].Trim());  //get each OCR result

}

 }

LibWFX_GetCertificatePermission(out IntPtr szPermissionTypeList, ENUM_PERMISSION_DATA_TYPE enDataType)

Output current registration information.

Example

IntPtr pstr;

ENUM_LIBWFX_ERRCODE enErrCode = DeviceWrapper.LibWFX_GetCertificatePermission(out pstr, ENUM_PERMISSION_DATA_TYPE.LIBWFX_DATA_TYPE_REGINFO);

if (enErrCode == ENUM_LIBWFX_ERRCODE.LIBWFX_ERRCODE_SUCCESS)

{

string szPermission = Marshal.PtrToStringUni(pstr);

if (szPermission != "")

WriteLog("License: "+ szPermission);

else

WriteLog("License: none");}

else  

{

WriteLog("Status:[LibWFX_GetCertificatePermission Fail [" + ((int)enErrCode).ToString() + "]]");

}

}

2.4.2 CallBack Function

Relevant information is returned from the SDK callback, including: image file path, OCR data, exception information and scan end information, etc.

LibWFXEVENTCB()

Event callback, mainly return the status information on the machine, including:

LIBWFX_EVENT_PAPER_DETECTED

LIBWFX_EVENT_NO_PAPER

LIBWFX_EVENT_PAPER_JAM

LIBWFX_EVENT_MULTIFEED

LIBWFX_EVENT_NO_CALIBRATION_DATA

LIBWFX_EVENT_WARMUP_COUNTDOWN

LIBWFX_EVENT_SCAN_PROGRESS

LIBWFX_EVENT_BUTTON_DETECTED

LIBWFX_EVENT_SCANNING

LIBWFX_EVENT_PAPER_FEEDING_ERROR

LIBWFX_EVENT_COVER_OPEN

LIBWFX_EVENT_LEFT_SENSOR_DETECTED

LIBWFX_EVENT_RIGHT_SENSOR_DETECTED

LIBWFX_EVENT_ALL_SENSOR_DETECTED

LIBWFX_EVENT_UVSECURITY_DETECTED

LIBWFX_EVENT_PLUG_UNPLUG

LIBWFX_EVENT_OVER_TIME_SCAN

LIBWFX_EVENT_CANCEL_SCAN

LIBWFX_EVENT_CAMERA_RGB_DISLOCATION

LIBWFX_EVENT_CAMERA_TIMEOUT

More detailed definition please refer to 4.3.2 LibFXScan Event table.

LibWFXCB ()

Notify callback, mainly returns the status message of the scan process, including:

LIBWFX_NOTIFY_IMAGE_DONE

The main return image file related content (pParam1), OCR data (pParam2)

Determine if there is a raw data command, if so, execute DrawImage () to display the returned image structure on the window, if not, execute ShowImage () to display the image file path, and display the image file on the window.

LIBWFX_NOTIFY_SHOWPATHONLY

If the set property command includes "photo":true, this callback will be returned. Only show the path of the photo.

LIBWFX_NOTIFY_END

The ending message returned by Scan at the end indicates that all actions have been completed.

LIBWFX_NOTIFY_EXCEPTION

The error message returned by the image processing will appear when performing recognition. The received message will be displayed directly on the window. The format of the error message: error:something's wrong(%d). For more details, please refer to the Image Processing Error code Table.

LIBWFX_EVENT_CAMERA_TIMEOUT

This can only happen with Camera models. When this event callback occurs, it means there is a problem with the machine firmware. Please contact us as soon as possible.

2.4.3 AutoCaptureDemo

Our common standard scan: LibWFX_StartScan(asynchronous) is a callback API, If need to use without callback scan API, please use LIBWFX_SynchronizeScan which is not support autoscan command, so we provide AutoCaptureDemo() to achieve the auto scan function.

1) Firstly, edit the .bat file., In this section, we will use C#   (AutoCaptureDemo-CSharp.bat) as an example.

     The format : ExeFileName command.

     Example command:

     "{\"device-name\":\"A64\",\"source\":\"Camera\",\"recognize-type\":\"passport\"}";

2) Select the .bat file to run AutoCaptureDemo-CSharp.exe according to the input command.

2.4.4 Helpful Tips

1) When using C# or VB to write an application, please make sure the version of Newtonsoft.Json in the development environment Build is aligned with the version of Newtonsoft.Json.dll in the SDK package; otherwise, error will happen when you run the .exe executable file.

2.5 Command Introduction

This chapter describes the complete command settings in detail. Please follow the JSON format when configuring the commands.

2.5.1 Key and Value

Format: {"device-name":"A61","source":"Camera“,….}  ( Case sensitive, json format )

2.5.2 Recognize Type

Listed as follows are the identity documents and forms we currently support. If you can not find what you need in this table or need a license to apply / install extra OCR, please contact our sales representatives for customization project evaluation.

3. WebFXScan SDK 2.0

3.1 Basic Knowledge

1. Download scanner driver from Plustek official website.

The scanner drivers of SecureScan X Series (except X200) are already included in the SDK Package. Please do NOT download and install.

For X200, RFID module driver:

https://plustek.com/us/products/customized-scan-modules/securescan-x200/support.php          

For Plustek Other Scanner driver:  

https://plustek.com/us/support/drivers-and-downloads.php

2. Install OCR engine package (Non-compulsory, according to the needs of recognize type)

3. Download & install Microsoft Visual C++ Redistributable for Visual Studio 2015.

Microsoft Download Center:

https://support.microsoft.com/en-us/topic/the-latest-supported-visual-c-downloads-2647da03-1eea-4433-9aff-95f26a218cc0

or

For x86:

https://aka.ms/vs/16/release/vc_redist.x86.exe

For x64:

https://aka.ms/vs/16/release/vc_redist.x64.exe

4. Installation WebFXScan SDK 2.0 Package LDSetup.exe.

After the installation is completed, the dll and related files required by the server will be decompressed to a specific location, and the server can be started by running :  

• C:\Program Files\Plustek\WebFXScan2\WebScan2.exe
• C:\Program Files (x86)\Plustek\WebFXScan2\WebScan2.exe

5. From the WebFXScan Client demo folder, open the index.html WebFXScan.html with Google Chrome or Microsoft Edge browser.

6. License Register (Please refer to Chapter 4.4 Register)

* WebFXScan SDK introduction video on AVI Youtube.

      7）Enable startup settings for WebScan2

        (Support from SDK Version 24344 and After)

During the installation process, you can choose whether to enable WebScan2 at startup. After installation, you can also change your settings in Windows -> Settings -> Apps -> Startup, or by right-clicking the WebScan2 icon in the bottom-right corner and selecting the Open menu to modify your settings.

3.2 Demo UI Introduction

The Client package includes the following:

main.js

All the demo codes that reference the server-side API are here as an example, which provide the API required by the demo page.

scan.js

Set the initial options corresponding

to the web language and machine. If you want to add a new machine, you need to add the corresponding content here.

index.html

Support web control menu.

3.2.1 Scan Page

Device Name

Display the machines connected to this computer

Recognizer Type 

Recognition type,including:passport, barcode and fulltext, etc.

Auto Crop

Crop automatically, check the box means to crop automatically; Uncheck means not to crop automatically.

Auto Deskew

Automatic skew correction, check the box means dynamic skew correction, unchecked means not to automatically do skew correction.

Click recognize button to get the recognize data

3.2.2 ini File Setting

There is LibWebFxScan.ini in the release folder from the server-package.

LibWebFxScan.ini Path :

• C:\Program Files\Plustek\WebFXScan2
• C:\Program Files (x86)\Plustek\WebFXScan2

EnableLog

1: A log file will be generated under the release folder  0: Not generated

The default is 0

EnableOrig

1: Generate original image file  0: Do not generate  

The default is 0

SavePath

Set the storage location of the image file.

The default Path %USERPROFILE%\AppData\Local\Temp\WebFXScan

LogPath

Set the storage location of the Log file.

The default Path %USERPROFILE%\AppData\Local\Plustek\LibWFXScan

The support for environment variables SavePath = “<APPDATA>\test\“ is added to SDK v1.1.13 and later versions.

Please refer to CSIDL Table for more information on < APPDATA > .

SSL

Certificate , Password and WSS are for HTTPS settings.

WebSetting

Default WebSocket port is 17778, could be modified if needed.

3.2.3 Change Command

In Demo UI want to change command need to change in main.js

Please refer to 3.4 Command Introduction for more information on command.

 3.3 API Introduction

This chapter will introduce the definition of SDK API and provide corresponding examples.

If port 17778 is already occupied, it could be supported by other ports.
Relevant ini files should also be modified, please check 3.2.2 ini File Setting [WebSetting].

3.3.1 Web API

WebFXScan JS Library (aviswpm.github.io)

3.3.2 Calibration

To do calibration for SecureScan X-Mini and X-Cube, you can also use the Calibration Tool application, in addition to DoCalibrate API.  This Calibration Tool application is available in Web Web SDK v1.1.13 or later versions.

Please follow the steps as follows:

1. Open the Web SDK installation folder path and run the CalibrationTool.exe or go to the installation folder, run Webscan2.exe and right click the Webscan icon and click “calibrate”.
   

• C:\Program Files\Plustek\WebFXScan2\
• C:\Program Files (x86)\Plustek\WebFXScan2\

3. Place the calibration sheet on the scanner.
4. Click the Calibration button.  If the calibration successfully completes, the corresponding message will show up.

3.4 Command Introduction

Please refer to WebFXScan JS Library (aviswpm.github.io) -> Scan Params Section.

If you want to change Command need to change in main.js

3.5 Http/Https demo using IIS

For more detailed operations please refer to the introduction video on AVI Youtube.

3.5.1 IIS Installation & Setting

1.  Open “Programs and Features” and then select “Turn Windows features on or off”

2. Select the setting as follows and then select OK to begin installation.

3. After the installation, you will see the directory as follows. Put the client files under this directory.

4. Open “Internet Information Services (IIS) Manager and then select

Application Pools > DefaultAppPool > Advanced Settings..  >

General > Enable 32-Bit Applications : “True”

5. Select the  “Default Web Site” > “ASP” >

Enable Parent Paths : “True”

Send Errors To Browser : “True”

3.5.2 Save Path Setting

1. Right-click the“Default Web Site” > Add Virtual Directory >

Alias : “SavePath”(for example)

Physical path :  “C:\Users\SaveDir”(for example)

2. Select “DESKTOP-…” > “Authentication”

3. Select “Anonymous Authentication” > “Edit” > “Application pool identity” > OK

4. Setting SaveDirectory，Right-click your Save Directory

(ie. SaveDir)  > Properties  > Security > Everyone  > Full control  > Apply

4. Support Reference

4.1  Basic Knowledge

If problems occur during the development integration phase, regardless of the development version and language of the SDK under development, use our standard demo application to verify whether the same problems occur (e.g.,  LibWFXDemo.exe). If the demo application is working properly, this means it is an integration problem. An additional consulting fee for debugging may be charged after evaluation.

4.1.1 General FAQ

1. How to get a version of SDK ?

After Installation SDK Package

Check with LDSetup.exe version

• AviScanProcess

Setting -> Applications -> search AviScanProcess

• WebFXScan2

Setting -> Applications -> search WebFXScan2

2. How to enable the Log ?

The default storage path for both Lib and Web SDK is: %USERPROFILE%\AppData\Local\plustek\LibWFXScan\

 - Method 1

Set Command add “log”:true

Be sure to reset the SET property until it succeeds. (The Device Ready! message is displayed.)

Method 1 Only could record the actions after Set Property. If the error occurs in the init stage, please use method 2 to enable Log:

         - Method 2

                LibWebFxScan.ini default Path :

• C:\Program Files\Plustek\WebFXScan2
• C:\Program Files (x86)\Plustek\WebFXScan2

Open LibWebFxScan.ini file, and then add the following content into the file :

After modify the LibWebFxScan.ini

• Lib SDK -> Be sure to restart Lib demo.exe
• Web SDK -> Be sure to restart WebScan2.exe

3. How to get a raw image for RD debug ? (Analyze unrecognizable images)

GET THE RECOGNIZE IMAGE

 - AVIRecognize.ini default Path :

• C:\Program Files\Plustek\AviScanProcess
• C:\Program Files (x86)\Plustek\AviScanProcess

Open AVIRecognize.ini file, and then add the following content to the file :

(It only works when recognize-type is set)

After modify the AVIRecognize.ini

• Lib SDK -> Be sure to restart Lib demo.exe
• Web SDK -> Be sure to restart WebScan2.exe

Please provide us with “AVIRecognize” folders.

The folder path : %USERPROFILE%\Documents\Plustek\AVIRecognize

GET THE ORIG IMAGE

 - Method 1

Set Command add “orig”:true

         - Method 2

LibWebFxScan.ini default Path :

• C:\Program Files\Plustek\WebFXScan2
• C:\Program Files (x86)\Plustek\WebFXScan2

Open LibWebFxScan.ini file, and then add the following content to the file :

After modify the LibWebFxScan.ini

• Lib SDK -> Be sure to restart Lib demo.exe
• Web SDK -> Be sure to restart WebScan2.exe

Please provide us “ORIG”  and “ORIG_PUSHQUEUE” folders.

The folder path : %USERPROFILE%\AppData\Local\Temp\WebFXScan\

4. Where is the scan image default save path ? How to change it ?

Lib and Web SDK both default stored path is:

%USERPROFILE%\AppData\Local\Temp\WebFXScan\

If you need to change the default path to D:\\test folder, please follow the instruction below:

        - Method 1

Set Command add "savepath":"d:\\test"

The support for environment variables "savepath":“<APPDATA>\\test“ is added to SDK v1.1.15 and later versions. Please refer to the CSIDL Table for more information on < APPDATA > .

         - Method 2

LibWebFxScan.ini default Path :

• C:\Program Files\Plustek\WebFXScan2
• C:\Program Files (x86)\Plustek\WebFXScan2

Open LibWebFxScan.ini file, and then add the following content to the file :

The support for environment variables SavePath = “<APPDATA>\test\“ is added to SDK v1.1.13 and later versions.    Please refer to CSIDL Table for more information on < APPDATA > .

After modify the LibWebFxScan.ini

• Lib SDK -> Be sure to restart Lib demo.exe
• Web SDK -> Be sure to restart WebScan2.exe

5. How to scan an image without saving ?

Set Command add "rawdata":true

The default is false.

true : not save the image, false : save the image.

6. How to correctly place the ID/Passport on the SecureScan scanner for recognition? How to set the recognize command?

Set Command : "recognize-type":”xxxx”

Be sure to confirm that you have the corresponding xxxx key permission.

For more recognize-type details, please refer to 2.5.2 Recognize Type.

7. How to scan a full screen image with SecureScan Scanner ?

 (full image DO NOT Support Recognize)

Set Command : {"device-name":"AXX","source":"Camera","autoscan":false,"paper-size":"A6"}

8. I use SecureScan scanner to scan documents/cards which are 105mm * 75mm in size and are correctly aligned on the upper left corner of the scanner. Why can't I get complete images?  A part of the images is always cut off.

The default crop size of SDK is TD1. If the scan target is TD2 size of identity documents, you need to add an additional command "td2": true.

Set Command : "td2":true

9. Why can’t I find the SET button in the Lib demo application?

You can set the switching method in LibWebFxScan.ini

UseModeBlock=1 to 0 (Asynchronous mode)

Please refer to 2.2.1 Set and Scan and 2.4 API Introduction for more information.

10. How to get the json file of the recognized results ?

Lib and Web SDK both default stored path is:

%USERPROFILE%\AppData\Local\Temp\WebFXScan\

Open LibWebFxScan.ini file, and then add the following content to the file:

After modify the LibWebFxScan.ini

• Lib SDK -> Be sure to restart Lib demo.exe
• Web SDK -> Be sure to restart WebScan2.exe

4.1.2 IssueDetector Tool

Please remember to exit webscan2.exe and then open IssueDetector Tool, if you want to use the SDK demo,  please make sure to close IssueDetector Tool first. It provides the OCR installation status, the Visual C++ Redistributable package installation status, the OCR file reading test, and the connected machine status (PID/VID/Module name/Serial Number).

1. OCR Engine

Display the installed OCR package.

2. Redistributable  Package

Display the 2008/2010/2012/2013/2015 X86/X64 installation status.

3. Test Tool

Open the Test Tool page, the connected machine will be automatically read. Select  Recognize, and the sample picture will be read and recognized. If it is successful, ReadImageAndIPProcess [Success] and the recognition result will be displayed.

[Para_0] Test123456.

4. DeviceList

DiscoverDevice: Display the status of all connected modules.

ProductName.dat List: Display all items in the current ProductName.dat. You can use this to check whether the module is registered or not.

5. Port Check

Port: Enter the port number to be queried, then select Check. You can see the status inside the Status column or select "Kill Process" to force terminate the process (not recommended).

4.2 Common Issue

Please confirm whether the dll or other files in the release folder have been changed. It is recommended to re-download an integral SDK package to verify the issue.

4.2.1 Init Fail

Generally speaking, the related environment settings might be the main reason to cause init failure.

Please check whether the Redistributable is correctly installed:

(IssueDetector.exe could check installed Redistributable.)

Note: The OCR installation package includes relevant Redistributable.If OCR is installed, you don’t have to install Redistributable again. There’s X86/X64 OCR, make sure you’ve installed the correct bit of Redistributable.

4.2.2 Connection Error

Connection Error only appears on WebFXScan SDK, it means Connect with Server agent failed.

Please check WebScan.exe is executed, If not please execute it.

the default installation path is:

C:\Program Files (x86)\Plustek\WebFXScan (Regular version)

C:\Program Files (x86)\WebFXScan (Special version)

4.2.3 No Device

1. Check Device Manager, make sure the computer is already connected with the scanner(also Not in the sleep/standby mode) and can be recognized.

-Camera scanner could use webcamtests.com to check if the function is working properly.

-Other scanners : please install the corresponding driver from Plustek official website.

Check Properties to view more information about the scanner.

2. If the device manager could recognize the scanner device, but the LibFXScan SDK shows  NOT_YET_OPEN_DEVICE, please check no other application occupied device.

(securescan, docaction, webscan... cannot be work at the same time)

3. If device manager could recognize scanner device, but WebFXScan SDK still can’t get device, please check the followings:

1. Firstly, please check if the installed antivirus is blocking then see if the current .exe file has been included in the Windows Virus & Threat Protection list. If the driver is installed correctly, open the scanner’s bundle application to check if the basic function is working properly.

For example: PS286’s bundle application is DocAction..

Enable Webscan.exe in the ransomware protection control list:

Select "Start" > "Settings" > "Update and Security" > "Windows Security" > "Virus and Threat Protection".

Select Manage ransomware protection:

Select Allow an app through Controlled folder access:

Add an allowed app > Browse all apps:

Select the WebScan.exe file:

2. In the latest Windows 10 update, there are adjustments to the default options of the camera device, which will disable the camera's reading permission, please follow the steps below to enable it.

Select Start button > Settings > Privacy > Camera

Turn on [Allow the apps to access your camera].

3. Check the scandata.js have corresponding machine contents in use at present. If not, confirm with RD to add.

(Also could use 4.1.2 IssueDetector Tool to check supports scanner)

4.2.4 OCR Mismatch

1. Please ignore this warning message if you only use the scanning function or the recognition engine is built in the SDK package.

(SDK built-in recognition type:  twid, insurance, passport, usdl…, check with AVI IP team for more information)

2. Check if you accidentally installed X64 AVI OCR on X86 program, make sure to install the right bit version of OCR on the corresponding program.

4.2.5 No Recognize Result

When there is no recognize result, please check with the following items:

1. You can use IssueDetector.exe to check whether OCR is installed.

2. The recognize-type in the command is correct, and the case sensitive must be the same as the command table.

3. The success of Set property is usually related to the permissions used.

Please contact our sales representatives to apply for a formal authorized Key.

4. If the log displays  "something wrong()" exception message, please check with the following:

Use IssueDetector.exe > Test Tool to check whether it is working normally. If SetRecognizeTool [ABBYY][Fail] message appears:

1. First go to C:\Program Files (x86)\Plustek\Software\AVIOCR\Bin to check if there is anything (dll files, etc.). If the path folder has files, meaning installation is complete, then go to

C:\Program Files (x86)\Plustek\Software\AVIOCR\Data to check if there is anything(dll files, etc.).

2. Check if the Redistributable package is correctly installed.

1. If OCR packages and Redistributable packages are installed correctly but the failure still occurs, please remove all the Redistributable packages and OCR files on the computer then reinstall OCR packages. (Sometimes the conflicts happened when too many versions of Redistributable packages are installed)

3. If all operations listed above and scanning other documents are normal, it might be the failure of image recognition. Please acquire scanning images from customers for the IP team to do further verification. ( Better provide more than one image)

IP team may require the original image, please add “orig”:true to the command to get the original file (have not been processed by IP), the original image files will be stored in the folder named “ORIG”.(Please refer to General FAQ: How to get a raw image for RD debug)

4.2.6 Visual Studio Debug

1. DllNotFoundException

SDK only puts the DLL in bin/Release, if a customer needs build code in the debug folder, please make sure to copy bin/Release all data to bin/Debug and rebuild.

2. Can’t Trace Code

If you want to trace code in Visual Studio, you need to modify the parameters of initEx() to LIBWFX_INIT_MODE_NOOCR; otherwise, PlustekOCR engine will bounce back the program and interrupt it during trace.

To use LIBWFX_INIT_MODE_NORMAL to trace, you can use the attach method:

Debug > Attach to Process > Select the name of the executable file and press Attach.

4.2.7 Can’t get RFID information of SecureScan X200

1. Please install RFID module driver:

https://plustek.com/us/products/customized-scan-modules/securescan-x200/support.php   

2. Set the command “recognize-type”: “passport” and scan for the RFID ID
3. The RFID information as follows will be shown :

4.3 Return Message

4.3.1 Error Code

Reminder: With the SDK version being updated from 1.0.74 to 1.0.75, the SDK error codes have also been adjusted. Please check the SDK version first and then its corresponding error codes table. To check the SDK version, please refer to 4.1.1 General FAQ .

For SDK Version 1.1.xx.23335 and After

4.3.2 Event Code

When asynchronous is used and any of the following commands is enabled, Lib event callback will be triggered. (Synchronous will not have event callback notification.)

• "autoscan" : true
• "apautoscan" : true

4.3.3 Web2.0 Error/Event Code

4.3.4 IP Code

For the convenience of description, IP is referred to as Image Processing below.

4.4 Register

You can choose either of the following to register:  

1. License Key Registration 

• The Mac and UUID of the computer will be bound in case of the License Key (xxx.lic) registration. If you want to change the computer, first you need to unbind the license key from the original computer, and then re-bind it on another computer.  
• Each License Key can only be used on one computer at the same time. There is no restriction on the scanner to be used with, as long as it is a Plustek scanner.

2. Register with Scanner Serial Number 

• The MAC and UUID of the computer are not bound if you register by machine serial number. When you change the computers, you only need to re-register for authorization.
• When using the SDK, please ensure the registered machine is properly connected to the computer, and only the machine that has been registered can be used.

If you have any problems about the Register key, please contact our local sales staff.

4.4.1 License Key Registration

The methods of registering License Key online (via the internet) for Lib SDK and Web SDK are different, but their methods are the same for offline registration.  Details will be explained as follows.

Please note the Mac and UUID of the computer will be bound in case of the License Key (xxx.lic) registration.  If you want to change the computer, you need to first unbind the license key from the original computer, and then re-bind it on another computer.

Each License Key can only be used on one computer at the same time.  There is no restriction on the scanner to be used with, as long as it is a Plustek scanner.

Please make sure that “Random hardware addresses” is turned off.

Otherwise, Lic registration may not be available.

Online Registration for Lib SDK

1. Run LibWFXDemo.exe and click the register icon on the upper right corner

2. Select License Key and click Register

3. Import license and select Register

Note：Each license can only be used on one computer. Please ensure to unregister from the original computer first, if you need to change the computer. To unregister the license, you need to do it on the same computer that was successfully registered. The system will check the UUID. If it is not the same UUID, the unregistered action will fail.

4. If the online registration is successful, you can check the license expiration date on this tool.

Online Registration for Web SDK

1. Starting from v1.1.16.22403, the Web SDK registration is available in two ways:

1. Go to the installation folder,

• C:\Program Files\Plustek\WebFXScan2\
• C:\Program Files (x86)\Plustek\WebFXScan2\

Right click the Webscan icon and click “activate”

2. Double click the StartRegister.bat.

2. Select License Key and click Register

3. Import the License file and click Register.

Note: Each license file can only be used on one computer. Please ensure to unregister from the original computer first, if you need to change the computer. To unregister the license, you need to do it on the same computer that was successfully registered. The system will check the UUID. If it is not the same, the unregistered operation will fail.

4. If the online registration is successful, you can check the license expiration date in this tool.

Online UnRegistration for Lib SDK

1. Run LibWFXDemo.exe and click the register icon on the upper right corner

2. Select License Key and click Register

3.  Click UnRegister

4. If the online unregister is successful, you can check the license expiration date in this tool.

Note:If you want to unregister, you need to do it on the same computer that was successfully registered. The system will check the UUID. If it is not the same UUID, the unregistered action will fail.

Offline Registration (For Lib SDK and Web SDK)

1. Copy the Plustek Offline Register Tool to a USB flash drive.

Please unplug the network cable directly to ensure that the device cannot be connected to the Internet.

2. Run Plustek Offline Register Tool on flash drive at an internet offline PC. This tool needs to "Save" the MAC Address , Host UUID and License for offline Register or UnRegister.

3. Move USB DISK to another network available PC and run Register Tool again.  

This step is to register for the offline PC.

Select the “Register” URL and when register is done will see the following windows. It means the register is OK.

4. Move the USB DISK back to the offline PC to install, then run the Plustek Offline Register Tool again. If this License is already registered, the Action will display UnRegister. The process of the Unregisgter and registration is the same, if you want to unregister please select the UnRegister..

Note: If you want to unregister, you need to do it on the same computer that was successfully registered. The system will check the UUID. If it is not the same UUID, the unregister action will fail.

5. Run the Offline Register Tool on offline PC see follow windows and select install   

to install the certificate.

6. See the message box “Action Completed”, the offline registration is done.

4.4.2 Register with Scanner Serial Number

Besides the aforementioned License Key registration method, the SDK also provides registration by machine serial number.  The MAC and UUID of the computer are not bound if you register by machine serial number. When you change the computers, you only need to re-register for authorization.

When using the SDK, please ensure the registered machine is properly connected to the computer, and only the machine that has been registered can be used.

Before using this method to register, please confirm with your Plustek account manager that the serial number of the machine must have been activated on the Plustek registration server.

Online Registration

Using Demo UI

1. Run LibWFXDemo.exe and click the register icon on the upper right corner

2. Select Serial Number and click Register

3. Click “Yes” to unregister the previous key(if any)

Using Command Line

1. Enter the command as follows:

cd LicenseRegister.exe file folder path

Example:  

• cd C:\Program Files\Plustek\WebFXScan2\
• cd C:\Program Files (x86)]\Plustek\WebFXScan2\

2. Enter the following command to start the registration:

LicenseRegister.exe AVISDK serial_number machine serial number

Example:  LicenseRegister.exe AVISDK serial_number 15A61A4000167

The machine Serial Number can be obtained by the following API:

• LibWFX_GetDeviesListWithSerial - Lib
• GetDevicesListWithSerial - Web

3. To check if the registration is successful or not, you can view the registration application program interface or API:

• LibWFX_GetCertificatePermission - Lib

Offline Registration

If you need to register offline, please contact us.

To query the serial number burned into the scanner, you can use the IssueDetector tool to view the scanner serial number(s) listed under DeviceList. If the INVALID_CERTICATE error occurs, it is usually because the machine has not been burned with the serial number.

For Lib SDK  v1.1.14.22074 and later versions, the Demo program has been added with the relevant information of the scanner serial number(s).  You can also query by this method.