Install & Upgrade

Upgrade From Trial or an Old Version

To upgrade Dynamic Web TWAIN from trial or an old version to the latest full version, please follow the steps below.

NOTE

If you are upgrading from a very old version (at least 2 major versions apart like from v12 to v14), more steps may be needed, feel free to contact Dynamsoft Support Team for more information.

For the developer
Basic Steps
  • Step 1 Update Resources on the Development machine

    • a) Uninstall the trial/old version

      Windows: Search Dynamic Web TWAIN in Control Panel -> Programs and Features, and remove all the relevant components there.

      macOS: Execute Applications > Dynamsoft > Dynamic Web TWAIN SDK {Version Number} > Uninstall.pkg

    • b) Install the latest full version

      The download link of the full version can be found in the purchasing email that was sent to the registered email/purchaser’s email. If you purchased the SDK but lost the download link of the full version, please request the download again.

    • c) Replace the whole Resources folder of Dynamic Web TWAIN in your application with the Resources folder of the full version. Typically, you can find it at the following path

      Windows: C:\Program Files (x86)\Dynamsoft\Dynamic Web TWAIN SDK {Version Number}

      macOS: Applications > Dynamsoft > Dynamic Web TWAIN SDK {Version Number}

  • Step 2 Update the License

    • a) Replace the product key In the file dynamsoft.webtwain.config.js, search for Dynamsoft.WebTwainEnv.ProductKey. Input the ProductKeys you received.

      Dynamsoft.WebTwainEnv.Containers = [{ContainerId:'dwtcontrolContainer', Width:270, Height:350}];
      // Please note that the license key is not the same thing as the Product Key.
      // You need to use your license keys to generate a Product Key.
      // For more info about how to generate a product key, please check the reference below.
      Dynamsoft.WebTwainEnv.ProductKey = '88FFAA09C42D5DE******;t0076lQAAAGNcO61He******';
      
    • b) Set Dynamsoft.WebTwainEnv.Trial to false if it's true

      In the file dynamsoft.webtwain.config.js, search for Dynamsoft.WebTwainEnv.Trial, and set it to false manually.

  • Step 3 Deploy the full version to the server

    After you have finished the testing on your dev machines, you can update your application on the server accordingly.

For silent upgrade

For version 14.2 and above, if you'd like the upgrade to be silent for the end users. The following extra steps are needed before you deploy your application to the server

NOTE: if you have the barcode reader add-on or the webcam capture add-on, silent upgrade is not an option, use normal upgrade instead

  • a) Download the following files and put them in the correct directory (create the directory if it doesn't exist)

For Windows users, put the files of the target version under /Resources/dist/win/

Version DWT DLL PDFR DLL
14.3.1 DWT-14.3.1.0115 PDFR-10.3.0.0712
14.3 DWT-14.2.0.1025 PDFR-10.3.0.0712
14.2 DWT-14.1.0.0828 PDFR-10.3.0.0712

For macOS users, put the files of the target version under /Resources/dist/mac/

Version DWT DLL PDFR DLL
14.3.1 DWT-14.1.0.0828 PDFR-10.3.0.0712
14.3 DWT-14.1.0.0828 PDFR-10.3.0.0712
14.2 DWT-14.1.0.0828 PDFR-10.3.0.0712

For Linux users, put the files of the target version under /Resources/dist/linux/

Version DWT DLL PDFR DLL
14.3.1 DWT-14.1.0.0828 PDFR-10.3.0.0712
14.3 DWT-14.1.0.0828 PDFR-10.3.0.0712
14.2 DWT-14.1.0.0828 PDFR-10.3.0.0712
  • b) Add the configuration Dynamsoft.WebTwainEnv.IfInstallDWTModuleWithZIP = true in the file dynamsoft.webtwain.config.js
Upgrade the Barcode Reader or Webcam Capture Add-on

As the barcode reader and the webcam capture addons were redesigned by Dynamsoft. The upgrade of these add-ons could take a bit more time. Consult Dynamsoft Support Team or check out the latest samples.

For the end users

If you are prompted to download and install a new version, follow the instructions to complete the upgrade. Then refresh or restart your browser.

For silent upgrade, the end users don't need to do anything.


Install on the Client Machines

Dynamic Web TWAIN is a 100% client-side SDK, every client machine needs to install its components in order to use the SDK. Over the years, Dynamsoft has made many efforts to make the process as smooth as possible. Here we'll talk about how the installation is done in version 14.3 (latest as of November, 2018).

HTML5 editions
  • Install Dynamsoft Service

    When the client first visit the web page which has Dynamic Web TWAIN implemented, the automatic initialization of the SDK which is built in its JavaScript library will try to establish connection with the Dynamsoft Service which is expected to be installed locally.

    NOTE: the initialization happens after the DOMContentLoaded event has been fired.

    The connection will be attempted twice for each of three pre-defined ports. Depending on whether the protocol is HTTP or HTTPS, the ports are 18625, 18993, 18627 or 18626, 18994, 18628.

    Should the connection fails, it means the service is not installed and the following prompt will come up and ask the end user to download and install the service.

    KB-InstallUpgrade-1

    NOTE: the same prompt will appear no matter whether the client OS is Windows, macOS or Linux. But the file you download differs on different Systems. On Windows and macOS, the users can double click the downloaded installer to install the SDK. On Linux, however, the users will need to run either one of the following command to install it

    Debian / Ubuntu

    dpkg -i DynamsoftServiceSetup.deb
    

    Fedora

    rpm -ivh DynamsoftServiceSetup.rpm
    
  • Install Dynamic Web TWAIN

    In version 14.2 and above, Dynamic Web TWAIN and its PDF Rasterizer add-on are installed together with the Dynamsoft Service. But in versions 13.0 ~ 14.1, Dynamic Web TWAIN is installed separately. In these versions, once the Service is installed, the JavaScript library will continue to check whether the library file for Dynamic Web TWAIN is installed (.dll/.bundle/.so for Windows/macOS/Linux). The pre-defined ports for Dynamic Web TWAIN are 18622/18995/18620 (HTTP) or 18623/18996/18621 (HTTPS). If the library isn't found, the service will attempt to download the file (a .zip file that contains the library) and put it in place. No user-interaction needed for this step.

    NOTE: On Windows, should the downloading or installing of the .zip file fails, an extra prompt will come up to allow the user to download and install the library manually.

    KB-InstallUpgrade-2

ActiveX Edition

For IE 6~9 on Windows, ActiveX is used. In v14.1 and v14.2, if it's not installed, the following message will appear where the component is expected to be on the page to allow the user to download and install the ActiveX.

KB-InstallUpgrade-3

For v14.3 and above, the prompt will be the same as the HTML5 edition

KB-InstallUpgrade-1

NOTE In v14.2 and above, the ActiveX edition is installed together with the Dynamsoft Service and the HTML5 edition.

For more information about the installation files in version 14.1. Check out About the Distribution Files


Install/Uninstall Silently

To silently install Dynamsoft Service via Command Line, you need to first have the file DynamsoftServiceSetup.msi which can be found in the installation folder of Dynamic Web TWAIN which is typically located at

C:\Program Files (x86)\Dynamsoft\Dynamic Web TWAIN SDK {Version No.} {Trial}\Resources\dist\win

Please run the CMD as administrator, and enter the following line of code with the relevant .msi name.

C:\Users\{User}\{DWT Path}>msiexec /i DynamsoftServiceSetup.msi /quiet

To silently uninstall Dynamic Web TWAIN, you can replace the /i parameter with /x.

C:\Users\{User}\{DWT Path}>msiexec /x DynamsoftServiceSetup.msi /quiet

If you want to create an install/uninstall log, you can use a command line which looks like this:

C:\Users\{User}\{DWT Path}>msiexec /x DynamsoftServiceSetup.msi /quiet /L*V "C:\log\example.log"

If you can't find the .msi, feel free to contact Dynamsoft Support Team.

Note: if you are a system administrator, you can also use the .msi to remotely install the software to all the end-user machines through Group Policy. Check out the article from Microsoft.


Uninstall on the Client Machines

The step one is always to close the browsers to make sure the SDK is not in use.

On Windows
ActiveX
  1. Uninstall the DynamicWebTWAINActiveX through Control Panel. The names for the program are Dynamic Web TWAIN Trial x86 & Dynamic Web TWAIN Trial x64
  2. Remove it by using the tool called DWTICSActiveXClearTool.exe
HTML5
  1. Remove the Dynamsoft Service through Control Panel. The name is Dynamsoft Service.
  2. Remove the folder C:\Windows\SysWOW64\Dynamsoft\DynamsoftService and all files under it
On macOS

Run the file Uninstall.pkg to uninstall it. The file can be found in Go > Applications > Dynamsoft > WebTwain > {installed version No.} >

On Linux

Run the file uninstall.sh to uninstall it. The file can be found in opt/dynamsoft/DynmasoftService

results matching ""

    No results matching ""

    results matching ""

      No results matching ""