Skip to content

Commit b46da95

Browse files
update to internal commit 19e172f4
1 parent 986751a commit b46da95

File tree

76 files changed

+3404
-2157
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

76 files changed

+3404
-2157
lines changed

_data/full_tree.yml

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -64,16 +64,16 @@ tree_list:
6464
path: /extended-usage/file-import.html
6565
- name: Configuring System Messages
6666
path: /extended-usage/system-message-configuration.html
67-
- name: Set Up the Dynamsoft Service
67+
- name: Set Up the Dynamic Web TWAIN Service
6868
path: /extended-usage/dynamsoft-service-configuration.html
6969
- name: UI Customization
7070
path: /extended-usage/ui-customization.html
71+
- name: Using the DWT RESTful API
72+
path: /extended-usage/restful-api.html
7173
- name: Barcode Recognition
7274
path: /extended-usage/barcode-processing.html
7375
- name: PDF Handling
7476
path: /extended-usage/pdf-processing.html
75-
#- name: PDF Compressor (Beta)
76-
# path: /extended-usage/pdf-compression.html
7777
- name: Buffer Caching
7878
path: /extended-usage/buffer-caching.html
7979
- name: Remote Scan
@@ -88,7 +88,7 @@ tree_list:
8888
# # path: /getstarted/helloworld.html
8989
# - name: License
9090
# path: /about/license.html
91-
# - name: Set up Dynamsoft Service
91+
# - name: Set up Dynamic Web TWAIN Service
9292
# path: /indepth/deployment/service.html
9393
# - name: Deploy to Server
9494
# path: /indepth/deployment/server.html

_includes/version-list.html

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
<span class="fullVersionHistory">
22
<ul class="fullVersionInfo">
3-
<li onclick="changeVersion(this)">Latest Version (18.5.1)</li>
3+
<li onclick="changeVersion(this)">Latest Version (19.0)</li>
4+
<li onclick="changeVersion(this)">Version 18.5.1</li>
45
<li onclick="changeVersion(this)">Version 18.4</li>
56
<li onclick="changeVersion(this)">Version 18.3</li>
67
<li onclick="changeVersion(this)">Version 18.1</li>

_layouts/default-layout-OLD.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -85,7 +85,7 @@
8585
</footer>
8686

8787
<script type="text/javascript">
88-
$(".currentVersion").text("latest version (18.5.1)");
88+
$(".currentVersion").text("latest version (19.0)");
8989
anchors.add();
9090
UrlReplace();
9191
FullTreeMenuList('{{page.needAutoGenerateSidebar}}', '{{page.needGenerateH3Content}}');

articles/extended-usage/advanced-initialization.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ permalink: /extended-usage/advanced-initialization.html
1414
1515
As presented in the standard [initialization guide]({{site.general-usage}}initialization.html), DWT instantiates a default `WebTwain` object in its default configuration. Here, we offer some alternative ways to instantiate `WebTwain` objects, as well as ways to alter the configuration of `WebTwain` objects.
1616

17-
> Note: jsDelivr currently has problems delivering the Dynamsoft Service installer (`https://cdn.jsdelivr.net/npm/dwt@latest/dist/dist/DynamsoftServiceSetup.msi`) due to [size restrictions](https://www.jsdelivr.com/documentation#id-configuring-a-default-file-in-packagejson); please consider hosting this particular resource file elsewhere. UKPKG is currently unaffected. For information about the Dynamsoft Service, learn more [here]({{site.extended-usage}}dynamsoft-service-configuration.html).
17+
> Note: jsDelivr currently has problems delivering the Dynamic Web TWAIN Service installer (`https://cdn.jsdelivr.net/npm/dwt@latest/dist/dist/DynamicWebTWAINServiceSetup.msi`) due to [size restrictions](https://www.jsdelivr.com/documentation#id-configuring-a-default-file-in-packagejson); please consider hosting this particular resource file elsewhere. UKPKG is currently unaffected. For information about the Dynamic Web TWAIN Service, learn more [here]({{site.extended-usage}}dynamsoft-service-configuration.html).
1818
1919
## Auto-Loading with CDN/Package Manager Resources
2020

@@ -77,7 +77,7 @@ APIs used:
7777

7878
Setting values for `Dynamsoft.DWT.AutoLoad` and `Dynamsoft.DWT.Containers` results in identical startup behavior for resources obtained from CDNs and package managers to resources obtained from the official SDK.
7979

80-
> Note: jsDelivr currently has problems delivering the Dynamsoft Service installer (`https://cdn.jsdelivr.net/npm/dwt@latest/dist/dist/DynamsoftServiceSetup.msi`) due to [size restrictions](https://www.jsdelivr.com/documentation#id-configuring-a-default-file-in-packagejson); please consider hosting this particular resource file elsewhere. UKPKG is currently unaffected. For information about the Dynamsoft Service, learn more [here]({{site.extended-usage}}dynamsoft-service-configuration.html).
80+
> Note: jsDelivr currently has problems delivering the Dynamic Web TWAIN Service installer (`https://cdn.jsdelivr.net/npm/dwt@latest/dist/dist/DynamicWebTWAINServiceSetup.msi`) due to [size restrictions](https://www.jsdelivr.com/documentation#id-configuring-a-default-file-in-packagejson); please consider hosting this particular resource file elsewhere. UKPKG is currently unaffected. For information about the Dynamic Web TWAIN Service, learn more [here]({{site.extended-usage}}dynamsoft-service-configuration.html).
8181
8282
## Configuring Default `WebTwain` Instances
8383

articles/extended-usage/buffer-caching.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -2,15 +2,15 @@
22
layout: default-layout
33
needAutoGenerateSidebar: true
44
title: Dynamic Web TWAIN SDK Guide - Buffer Caching
5-
keywords: Dynamic Web TWAIN, Documentation, Deployment, Dynamsoft Service, caching, buffer,
6-
breadcrumbText: Dynamsoft Service
7-
description: Dynamic Web TWAIN SDK Documentation Dynamsoft Service Page
5+
keywords: Dynamic Web TWAIN, Documentation, Deployment, Dynamic Web TWAIN Service, caching, buffer,
6+
breadcrumbText: Dynamic Web TWAIN Service
7+
description: Dynamic Web TWAIN SDK Documentation Dynamic Web TWAIN Service Page
88
permalink: /extended-usage/buffer-caching.html
99
---
1010

1111
# Buffer Caching
1212

13-
The DWT image buffer is controlled by the Dynamsoft Service. The Dynamsoft Service can run in either 32-bit mode or 64-bit mode. Before DWT version 15.0, the service ran in 32-bit mode by default. This meant it could not address more than 2GB of physical memory. <!--We introduced the 64-bit version of the service in DWT version 14.0. -->Starting in version 15.0, the Dynamsoft Service runs as 64-bit by default on 64-bit operating systems, which removes the 2GB memory limit. To limit memory usage, DWT can cache data to disk to free up memory.
13+
The DWT image buffer is controlled by the Dynamic Web TWAIN Service(formerly known as Dynamsoft Service). The Dynamic Web TWAIN Service can run in either 32-bit mode or 64-bit mode. Before DWT version 15.0, the service ran in 32-bit mode by default. This meant it could not address more than 2GB of physical memory. <!--We introduced the 64-bit version of the service in DWT version 14.0. -->Starting in version 15.0, the Dynamic Web TWAIN Service runs as 64-bit by default on 64-bit operating systems, which removes the 2GB memory limit. To limit memory usage, DWT can cache data to disk to free up memory.
1414

1515
## Disk Caching
1616

@@ -24,17 +24,17 @@ You can also set how much memory `Dynamic Web TWAIN` can use before images start
2424
2525
Although you can scan and load as many images as you like, you may want to handle them in smaller volumes when doing further processing. For example, when dealing with extremely large volumes, you should not try to upload or save the images all at once as that would be too time consuming and prone to errors.
2626

27-
## Save the encrypted image caches in local Dynamsoft Service folder
27+
## Save the encrypted image caches in local Dynamic Web TWAIN Service folder
2828

2929
In certain scenarios, there may be requirements to store encrypted image caches on a local disk for temporary data storage or backup purposes. For instance, when scanning a large batch of documents, accidentally closing the web page can result in the loss of scanned data, necessitating scanning the documents again. This issue can be mitigated by backing up the data before closing the page.
3030

31-
Starting from version 18.5, Dynamic Web TWAIN introduces a new feature that facilitates developers in securely storing image caches in encrypted form within the Dynamsoft Service folder. This feature offers several advantages:
31+
Starting from version 18.5, Dynamic Web TWAIN introduces a new feature that facilitates developers in securely storing image caches in encrypted form within the Dynamic Web TWAIN Service(formerly known as Dynamsoft Service) folder. This feature offers several advantages:
3232

3333
- Data is stored securely in encrypted form.
3434
- The speed of storing data locally and loading it back into the Dynamic Web TWAIN buffer is fast.
3535
- The stored data remains intact even when the `WebTwain` instance is destroyed.
3636

37-
> Note: Since the storage folder is located within the Dynamsoft Service directory, the stored data will be lost if Dynamsoft Service is uninstalled. Upgrading the Dynamsoft Service will not affect the storage folder.
37+
> Note: Since the storage folder is located within the Dynamic Web TWAIN Service directory, the stored data will be lost if Dynamic Web TWAIN Service is uninstalled. Upgrading the Dynamic Web TWAIN Service will not affect the storage folder.
3838
3939
### Create a storage folder
4040

@@ -50,9 +50,9 @@ var storageItemUid = await DWTObject.createLocalStorage(folderSettings);
5050
Please ensure to set a strong password to enhance data security, especially in multi-user login scenarios.
5151

5252
The local directory of the created storage folder is under
53-
- Windows: `C:\Windows\SysWOW64\Dynamsoft\DynamsoftServicex64_{versionnumber}\storage`
54-
- macOS: `Go > Applications > Dynamsoft > DynamsoftServicex64_{versionnumber} > {installed version No.} > storage`
55-
- Linux: `/opt/dynamsoft/DynamsoftService/storage`
53+
- Windows: `C:\Program Files (x86)\Dynamsoft\Dynamic Web TWAIN Service {versionnumber}\storage`(version 18.5.1 and earlier `C:\Windows\SysWOW64\Dynamsoft\DynamsoftServicex64_{versionnumber}\storage`)
54+
- macOS: `Go > Applications > Dynamsoft > Dynamic Web TWAIN Service {versionnumber} > storage`(version 18.5.1 and earlier `Go > Applications > Dynamsoft > DynamsoftServicex64_{versionnumber} > {installed version No.} > storage`)
55+
- Linux: `/opt/dynamsoft/Dynamic Web TWAIN Service {versionnumber}/storage`(version 18.5.1 and earlier `/opt/dynamsoft/DynamsoftService/storage`)
5656

5757
**Save image caches**
5858

articles/extended-usage/dynamsoft-service-configuration.md

Lines changed: 22 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -2,32 +2,32 @@
22
layout: default-layout
33
needAutoGenerateSidebar: true
44
noTitleIndex: true
5-
title: Dynamic Web TWAIN SDK Deployment - Dynamsoft Service
6-
keywords: Dynamic Web TWAIN, Documentation, Deployment, Dynamsoft Service
7-
breadcrumbText: Dynamsoft Service
8-
description: Dynamic Web TWAIN SDK Documentation Dynamsoft Service Page
5+
title: Dynamic Web TWAIN SDK Deployment - Dynamic Web TWAIN Service
6+
keywords: Dynamic Web TWAIN, Documentation, Deployment, Dynamic Web TWAIN Service
7+
breadcrumbText: Dynamic Web TWAIN Service
8+
description: Dynamic Web TWAIN SDK Documentation Dynamic Web TWAIN Service Page
99
permalink: /extended-usage/dynamsoft-service-configuration.html
1010
---
1111

12-
# Configuring the Dynamsoft Service
12+
# Configuring the Dynamic Web TWAIN Service
1313

1414
> This article is meant exclusively for the Desktop Service Edition of Dynamic Web TWAIN.
1515
16-
The Dynamsoft Service is the core piece of Dynamic Web TWAIN when running in Service mode. It handles the communication between hardware (scanner, webcam, etc.) and browser, manages the image buffer, and coordinates data between different modules.
16+
The Dynamic Web TWAIN Service is the core piece of Dynamic Web TWAIN when running in Service mode. It handles the communication between hardware (scanner, webcam, etc.) and browser, manages the image buffer, and coordinates data between different modules.
1717

1818
### IP and ports
1919

20-
The Dynamsoft Service uses `localhost` and `18622` `18625` ports for HTTP connection and `18623` `18626` ports for HTTPS connection.
20+
The Dynamic Web TWAIN Service uses `localhost` and `18622` `18625` ports for HTTP connection and `18623` `18626` ports for HTTPS connection.
2121
These ports can be configured in the `DSConfiguration.ini` file located in:
22-
- Windows: `C:\Windows\SysWOW64\Dynamsoft\DynamsoftServicex64_{versionnumber}`
23-
- macOS: `Go > Applications > Dynamsoft > DynamsoftServicex64_{versionnumber} > {installed version No.}`
24-
- Linux: `/opt/dynamsoft/DynamsoftService`
22+
- Windows: `C:\Program Files (x86)\Dynamsoft\Dynamic Web TWAIN Service {versionnumber}`(version 18.5.1 and earlier `C:\Windows\SysWOW64\Dynamsoft\DynamsoftServicex64_{versionnumber}`)
23+
- macOS: `Go > Applications > Dynamsoft > Dynamic Web TWAIN Service {versionnumber}`(version 18.5.1 and earlier `Go > Applications > Dynamsoft > DynamsoftServicex64_{versionnumber} > {installed version No.}`)
24+
- Linux: `/opt/dynamsoft/Dynamic Web TWAIN Service {versionnumber}`(version 18.5.1 and earlier `/opt/dynamsoft/DynamsoftService`)
2525

2626
### Access-Control-Allow-Origin
2727

28-
For security purposes, you may want the Dynamsoft Service to only respond to requests from specified origins. Starting from Dynamic Web TWAIN version 18.5, this can be achieved by adding `Access-Control-Allow-Origin` in the `DSConfiguration.ini` file.
28+
For security purposes, you may want the Dynamic Web TWAIN Service to only respond to requests from specified origins. Starting from Dynamic Web TWAIN version 18.5, this can be achieved by adding `Access-Control-Allow-Origin` in the `DSConfiguration.ini` file.
2929

30-
By default, the `Access-Control-Allow-Origin` setting is not configured in the ini file. This means that the Dynamsoft Service can respond to requests from any origin.
30+
By default, the `Access-Control-Allow-Origin` setting is not configured in the ini file. This means that the Dynamic Web TWAIN Service can respond to requests from any origin.
3131

3232
You can set multiple origins by using commas as the separator, and `http://` or `https://` needs to be specified before each origin. If there is a port for the origin, please remember to specify it. If not specified, the default port is 80.
3333

@@ -59,9 +59,9 @@ When a request comes from a different origin, a CORS error message will be displ
5959

6060
![CORS-error-console]({{site.assets}}imgs/CORS-error-console.png)
6161

62-
## Installation of Dynamsoft Service
62+
## Installation of Dynamic Web TWAIN Service
6363

64-
On a desktop, when a new user accesses a web page using Dynamic Web TWAIN SDK for the first time, he will be prompted to install the Dynamsoft Service. This is a built-in behaviour of the library. The prompt will display the download link. Once the installer is downloaded, the installation process will take just a few seconds.
64+
On a desktop, when a new user accesses a web page using Dynamic Web TWAIN SDK for the first time, he will be prompted to install the Dynamic Web TWAIN Service. This is a built-in behaviour of the library. The prompt will display the download link. Once the installer is downloaded, the installation process will take just a few seconds.
6565

6666
The prompt comes up when you try to [create a WebTwain instance]({{site.indepth}}features/initialize.html#creating-the-webtwain-instance) in Service mode.
6767

@@ -74,26 +74,26 @@ On **Linux**, instead of double clicking, the downloaded installer needs to be r
7474
- Debian / Ubuntu
7575

7676
```bash
77-
sudo dpkg -i DynamsoftServiceSetup.deb
77+
sudo dpkg -i DynamicWebTWAINServiceSetup.deb
7878
```
7979

8080
- Fedora
8181

8282
```bash
83-
sudo rpm -ivh DynamsoftServiceSetup.rpm
83+
sudo rpm -ivh DynamicWebTWAINServiceSetup.rpm
8484
```
8585

8686
Once the installation is done, the users can click the orange sentence 'click here to verify completion' or refresh the page to start using Dynamic Web TWAIN.
8787

8888
![Initialization]({{site.assets}}imgs/Initialization-2.png)
8989

90-
### Msg: Dynamsoft service is not installed / Dynamic Web TWAIN is not installed
90+
### Msg: Dynamic Web TWAIN Service is not installed / Dynamic Web TWAIN is not installed
9191

92-
If Dynamsoft Service is not installed, users may receive the error 'The Dynamic Web TWAIN module is not installed' when accessing an application that uses Dynamic Web TWAIN.
92+
If Dynamic Web TWAIN Service is not installed, users may receive the error 'The Dynamic Web TWAIN module is not installed' when accessing an application that uses Dynamic Web TWAIN.
9393

9494
## Related Resources:
9595

96-
* <a href="{{site.faq}}what-does-dynamsoft-service-do-on-end-user-machine.html" target="_blank">What does Dynamsoft Service do?</a>
97-
* <a href="{{site.faq}}service-prompting-to-install-repeatedly.html" target="_blank">I have installed the Dynamsoft Service on an end-user machine but still got asked to install it repeatedly. Why?</a>
98-
* <a href="{{site.faq}}how-to-uninstall-dynamsoft-service.html" target="_blank">How to uninstall Dynamsoft Service?</a>
99-
* <a href="{{site.faq}}can-i-install-dynamsoft-service-silently.html" target="_blank">Can I install Dynamsoft Service silently?</a>
96+
* <a href="{{site.faq}}what-does-dynamsoft-service-do-on-end-user-machine.html" target="_blank">What does Dynamic Web TWAIN Service do?</a>
97+
* <a href="{{site.faq}}service-prompting-to-install-repeatedly.html" target="_blank">I have installed the Dynamic Web TWAIN Service on an end-user machine but still got asked to install it repeatedly. Why?</a>
98+
* <a href="{{site.faq}}how-to-uninstall-dynamsoft-service.html" target="_blank">How to uninstall Dynamic Web TWAIN Service?</a>
99+
* <a href="{{site.faq}}can-i-install-dynamsoft-service-silently.html" target="_blank">Can I install Dynamic Web TWAIN Service silently?</a>

articles/extended-usage/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ This set of guides builds on the fundamental features covered in the standard us
1717

1818
- [Advanced DWT Initialization]({{site.extended-usage}}advanced-initialization.html)
1919
- [Configuring System Messages]({{site.extended-usage}}system-message-configuration.html)
20-
- [Set Up the Dynamsoft Service]({{site.extended-usage}}dynamsoft-service-configuration.html)
20+
- [Set Up the Dynamic Web TWAIN Service]({{site.extended-usage}}dynamsoft-service-configuration.html)
2121
- [UI Customization]({{site.extended-usage}}ui-customization.html)
2222
- [Barcode Recognition]({{site.extended-usage}}barcode-processing.html)
2323
- [PDF Handling]({{site.extended-usage}}pdf-processing.html)
Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
---
2+
layout: default-layout
3+
needAutoGenerateSidebar: true
4+
title: Using the RESTful API
5+
keywords: Dynamic Web TWAIN, extended guide, advanced, RESTful API, REST, REST service, RESTful service, webtwain, Dynamic Web TWAIN Service, RESTful integration
6+
breadcrumbText: RESTful API
7+
description: RESTful API
8+
permalink: /extended-usage/restful-api.html
9+
---
10+
11+
# Using the RESTful API
12+
13+
By default, Dynamic Web TWAIN consists of the Dynamic Web TWAIN Service installed and running on a system, connected to a web application which integrates the Dynamic Web TWAIN SDK. To use DWT to access scanners on other platforms and using other programming languages, you can use the [DWT Service RESTful API]({{ site.api }}restful.html). This allows desktop, mobile, and server-side applications to access the DWT Service installed on the scanner host (local or server) in a simple, stateless, and standardized manner.
14+
15+
The RESTful API simply returns scanned documents as streams of image files to the client, and **does not use the DWT Viewer**. This is because **the RESTful API functions entirely using the DWT Service**, and is viewer-agnostic. You may choose to feed the scanned images to any viewer, including a DWT Viewer in your application that you instantiate separately, if desired.
16+
17+
Here is a collection of tutorials on creating sample applications that use the DWT RESTful API in various platforms and languages.
18+
19+
- [Node.js](https://www.dynamsoft.com/codepool/rest-api-node-document-scanning.html)
20+
- [Flutter](https://www.dynamsoft.com/codepool/flutter-twain-scanner-digitize-document.html)
21+
- [Java](https://www.dynamsoft.com/codepool/java-twain-document-scanning.html)
22+
- [Python](https://www.dynamsoft.com/codepool/python-twain-wia-sane-document-scanner.html)
23+
- [.NET](https://www.dynamsoft.com/codepool/dotnet-twain-wia-sane-document-scanner.html)

0 commit comments

Comments
 (0)