Thanks for Downloading Dynamic Web TWAIN 30-Day Trial!

Your download will start shortly. If your download does not begin, click here to retry.

Document Saving

How to Deploy an Upload Server Using JSP

Dynamic Web TWAIN is a client-side JavaScript SDK. However, it does need to interact with the server when performing operations like uploading and downloading. This article introduces how to deploy an upload server using backend JSP code.

Please select your frontend language:

Javascript
Angular
React-Javascript
React-TypeScript
Vue-Javascript
Vue-Typescript

This article assumes that you have downloaded and unzipped this sample: DynamicWebTWAIN-JavaScript.zip. After unzipping it, the directory structure is shown in the image below.

Note: The "Sample" directory mentioned in the steps below refers to the "Sample" directory shown in the image.

Prerequisite:

Please ensure your web server that has the Java Development Kit (JDK) installed and supports Java Server Pages (JSP).

Steps:

Download the server-side JSP code, unzip it and copy the aforementioned "Upload" directory to the "Sample" directory. Under the "Upload" root folder, there is a file "SaveToFile.jsp". This is the backend page that accepts the uploaded data.
Modify the client-side upload function In {path}\Sample\Scripts\online_demo_operation.js, modify the "URL" parameter of HTTPUpload() to match the actual path of the upload server you deployed. The "URL" parameter accepts both absolute and relative paths.

Refer to the following code snippet:

function Upload() {
    if (DWTObject && DWTObject.HowManyImagesInBuffer > 0) {
      //Path to the server-side script. You can adjust it according to the actual path of the upload server you deployed.
      var strUrl = "http://{server-path}/Sample/Upload/SaveToFile.jsp";
      var imgAry = [DWTObject.CurrentImageIndexInBuffer];
      DWTObject.HTTPUpload(
        strUrl, 
        imgAry, 
        Dynamsoft.DWT.EnumDWT_ImageType.IT_PNG,
        Dynamsoft.DWT.EnumDWT_UploadDataFormat.Binary, 
        "WebTWAINImage.png", 
        onUploadSuccess, 
        onUploadFailure);
    } else {
      alert("There is no image in buffer.");
    }
}

function onUploadSuccess() {
  alert("Upload successful");
}

function onUploadFailure(errorCode, errorString, sHttpResponse) {
  alert(sHttpResponse.length > 0 ? sHttpResponse : errorString);
}

Copy the "Sample" directory to the web server. For example, if you are using Tomcat 10.1.16, copy it to "{Tomcat-installed-path}/webapps".
Restart the web server.
Navigate to http://{server-path}/Sample/index.html in your browser to access the sample.

This article assumes that you have downloaded and unzipped this sample: DynamicWebTWAIN-Angular.zip. After unzipping it, the directory structure is shown in the image below.

Note: The "Sample" directory mentioned in the steps below refers to the "Sample" directory shown in the image.

Prerequisite:

Please ensure that Node.js is installed. The recommended version is v20.13.1.
Please ensure your web server that has the Java Development Kit (JDK) installed and supports Java Server Pages (JSP).

Steps:

Download the server-side JSP code, unzip it and copy the "Upload" directory to the "Sample\src\public" directory. Under the "Upload" folder, there is a file "SaveToFile.jsp". This is the backend page that accepts the uploaded data.
Modify the client-side upload function In {path}\Sample\src\app\components\tools\dwtService.ts, modify the "URL" parameter of HTTPUpload() to match the actual path of the upload server you deployed. The "URL" parameter accepts both absolute and relative paths.

Refer to the following code snippet:

Upload(): Promise<any> {
  return new Promise((res, rej) => {
    if (this._dwtObject && this._dwtObject.HowManyImagesInBuffer > 0) {
      //Path to the server-side script. You can adjust it according to the actual path of the upload server you deployed.
      let strUrl = "http://{server-path}/dist/Upload/SaveToFile.jsp";
      let imgAry = [this._dwtObject.CurrentImageIndexInBuffer];
      this._dwtObject.HTTPUpload(
        strUrl, 
        imgAry, 
        Dynamsoft.DWT.EnumDWT_ImageType.IT_PNG,
        Dynamsoft.DWT.EnumDWT_UploadDataFormat.Binary, 
        "WebTWAINImage.png", 
        ()=>{
          res();
        }, (errCode, errString, responseStr) => {
          rej({
            code: errCode,
            message: errString
          });
        });
    } else {
      rej({
         code: -1,
         message: "There is no image in buffer."
      });
    }
  }
}

Build the client-side project

Open your terminal or Command Prompt and execute the following three commands to build the project:

1). Navigate to the Sample directory:
```
cd [path]/Sample
```
2). Install the dependencies:
```
npm install
```
3). Build the project:
```
npm run build
```
Copy the "Sample/dist" directory to the web server. For example, if you are using Tomcat 10.1.16, copy it to "{Tomcat-installed-path}/webapps".
Restart the web server.
Navigate to http://{server-path}/dist/index.html in your browser to access the sample.

This article assumes that you have downloaded and unzipped this sample: DynamicWebTWAIN-React-JavaScript.zip. After unzipping it, the directory structure is shown in the image below.

Note: The "Sample" directory mentioned in the steps below refers to the "Sample" directory shown in the image.

Prerequisite:

Please ensure that Node.js is installed. The recommended version is v20.13.1.
Please ensure your web server that has the Java Development Kit (JDK) installed and supports Java Server Pages (JSP).

Steps:

Download the server-side JSP code, unzip it and copy the "Upload" directory to the "Sample\public" directory. Under the "Upload" folder, there is a file "SaveToFile.jsp". This is the backend page that accepts the uploaded data.
Modify the client-side upload function In {path}\Sample\src\components\tools\dwtService.js, modify the "URL" parameter of HTTPUpload() to match the actual path of the upload server you deployed. The "URL" parameter accepts both absolute and relative paths.

Refer to the following code snippet:

Upload() {
  return new Promise((res, rej) => {
    if (this._dwtObject && this._dwtObject.HowManyImagesInBuffer > 0) {
      //Path to the server-side script. You can adjust it according to the actual path of the upload server you deployed.
      let strUrl = "http://{server-path}/dist/Upload/SaveToFile.jsp";
      let imgAry = [this._dwtObject.CurrentImageIndexInBuffer];
      this._dwtObject.HTTPUpload(
      strUrl, 
      imgAry, 
      Dynamsoft.DWT.EnumDWT_ImageType.IT_PNG,
      Dynamsoft.DWT.EnumDWT_UploadDataFormat.Binary, 
      "WebTWAINImage.png", 
      ()=>{
        res();
      }, (errCode, errString, responseStr) => { 
        rej({
           code: errCode,
           message: errString
        });
      });
    } else {
      rej({
        code: -1,
        message: "There is no image in buffer."
      });
    }
  }
}

Build the client-side project

Open your terminal or Command Prompt and execute the following three commands to build the project:

1). Navigate to the Sample directory:
```
cd [path]/Sample
```
2). Install the dependencies:
```
npm install
```
3). Build the project:
```
npm run build
```
Copy the "Sample/dist" directory to the web server. For example, if you are using Tomcat 10.1.16, copy it to "{Tomcat-installed-path}/webapps".
Restart the web server.
Navigate to http://{server-path}/dist/index.html in your browser to access the sample.

This article assumes that you have downloaded and unzipped this sample: DynamicWebTWAIN-React-TypeScript.zip. After unzipping it, the directory structure is shown in the image below.

Note: The "Sample" directory mentioned in the steps below refers to the "Sample" directory shown in the image.

Prerequisite:

Please ensure that Node.js is installed. The recommended version is v20.13.1.
Please ensure your web server that has the Java Development Kit (JDK) installed and supports Java Server Pages (JSP).

Steps:

Download the server-side JSP code, unzip it and copy the "Upload" directory to the "Sample\public" directory. Under the "Upload" folder, there is a file "SaveToFile.jsp". This is the backend page that accepts the uploaded data.
Modify the client-side upload function In {path}\Sample\src\components\tools\dwtService.ts, modify the "URL" parameter of HTTPUpload() to match the actual path of the upload server you deployed. The "URL" parameter accepts both absolute and relative paths.

Refer to the following code snippet:

Upload(): Promise<any> {
  return new Promise((res, rej) => {
    if (this._dwtObject && this._dwtObject.HowManyImagesInBuffer > 0) {
      //Path to the server-side script. You can adjust it according to the actual path of the upload server you deployed.
      let strUrl = "http://{server-path}/dist/Upload/SaveToFile.jsp";
      let imgAry = [this._dwtObject.CurrentImageIndexInBuffer];
      this._dwtObject.HTTPUpload(
      strUrl, 
      imgAry, 
      Dynamsoft.DWT.EnumDWT_ImageType.IT_PNG,
      Dynamsoft.DWT.EnumDWT_UploadDataFormat.Binary, 
      "WebTWAINImage.png", 
      ()=>{
        res();
      }, (errCode, errString, responseStr) => { 
        rej({
           code: errCode,
           message: errString
        });
      });
    } else {
      rej({
         code: -1,
         message: "There is no image in buffer."
      });
    }
  }
}

Build the client-side project

Open your terminal or Command Prompt and execute the following three commands to build the project:

1). Navigate to the Sample directory:
```
cd [path]/Sample
```
2). Install the dependencies:
```
npm install
```
3). Build the project:
```
npm run build
```
Copy the "Sample/dist" directory to the web server. For example, if you are using Tomcat 10.1.16, copy it to "{Tomcat-installed-path}/webapps".
Restart the web server.
Navigate to http://{server-path}/dist/index.html in your browser to access the sample.

This article assumes that you have downloaded and unzipped this sample: DynamicWebTWAIN-Vue-JavaScript.zip. After unzipping it, the directory structure is shown in the image below.

Note: The "Sample" directory mentioned in the steps below refers to the "Sample" directory shown in the image.

Prerequisite:

Please ensure that Node.js is installed. The recommended version is v20.13.1.
Please ensure your web server that has the Java Development Kit (JDK) installed and supports Java Server Pages (JSP).

Steps:

Download the server-side JSP code, unzip it and copy the "Upload" directory to the "Sample\public" directory. Under the "Upload" folder, there is a file "SaveToFile.jsp". This is the backend page that accepts the uploaded data.
Modify the client-side upload function In {path}\Sample\src\components\tools\dwtService.js, modify the "URL" parameter of HTTPUpload() to match the actual path of the upload server you deployed. The "URL" parameter accepts both absolute and relative paths.

Refer to the following code snippet:

Upload() {
  return new Promise((res, rej) => {
    if (this._dwtObject && this._dwtObject.HowManyImagesInBuffer > 0) {
      //Path to the server-side script. You can adjust it according to the actual path of the upload server you deployed.
      let strUrl = "http://{server-path}/dist/Upload/SaveToFile.jsp";
      let imgAry = [this._dwtObject.CurrentImageIndexInBuffer];
      this._dwtObject.HTTPUpload(
      strUrl, 
      imgAry, 
      Dynamsoft.DWT.EnumDWT_ImageType.IT_PNG,
      Dynamsoft.DWT.EnumDWT_UploadDataFormat.Binary, 
      "WebTWAINImage.png", 
      ()=>{
        res();
      }, (errCode, errString, responseStr) => { 
        rej({
          code: errCode,
          message: errString
        });
      });
    } else {
      rej({
        code: -1,
        message: "There is no image in buffer."
      });
    }
  }
}

Build the client-side project

Open your terminal or Command Prompt and execute the following three commands to build the project:

1). Navigate to the Sample directory:
```
cd [path]/Sample
```
2). Install the dependencies:
```
npm install
```
3). Build the project:
```
npm run build
```
Copy the "Sample/dist" directory to the web server. For example, if you are using Tomcat 10.1.16, copy it to "{Tomcat-installed-path}/webapps".
Restart the web server.
Navigate to http://{server-path}/dist/index.html in your browser to access the sample.

This article assumes that you have downloaded and unzipped this sample: DynamicWebTWAIN-Vue-TypeScript.zip. After unzipping it, the directory structure is shown in the image below.

Note: The "Sample" directory mentioned in the steps below refers to the "Sample" directory shown in the image.

Prerequisite:

Please ensure that Node.js is installed. The recommended version is v20.13.1.
Please ensure your web server that has the Java Development Kit (JDK) installed and supports Java Server Pages (JSP).

Steps:

Download the server-side JSP code, unzip it and copy the "Upload" directory to the "Sample\public" directory. Under the "Upload" folder, there is a file "SaveToFile.jsp". This is the backend page that accepts the uploaded data.
Modify the client-side upload function In {path}\Sample\src\components\tools\dwtService.ts, modify the "URL" parameter of HTTPUpload() to match the actual path of the upload server you deployed. The "URL" parameter accepts both absolute and relative paths.

Refer to the following code snippet:

Upload(): Promise<any> {
  return new Promise((res, rej) => {
    if (this._dwtObject && this._dwtObject.HowManyImagesInBuffer > 0) {
      //Path to the server-side script. You can adjust it according to the actual path of the upload server you deployed.
      let strUrl = "http://{server-path}/dist/Upload/SaveToFile.jsp";
      let imgAry = [this._dwtObject.CurrentImageIndexInBuffer];
      this._dwtObject.HTTPUpload(
      strUrl, 
      imgAry, 
      Dynamsoft.DWT.EnumDWT_ImageType.IT_PNG,
      Dynamsoft.DWT.EnumDWT_UploadDataFormat.Binary, 
      "WebTWAINImage.png", 
      ()=>{
        res();
      }, (errCode, errString, responseStr) => { 
        rej({
          code: errCode,
          message: errString
        });
      });
    } else {
      rej({
        code: -1,
        message: "There is no image in buffer."
      });
    }
  }
}

Build the client-side project

Open your terminal or Command Prompt and execute the following three commands to build the project:

1). Navigate to the Sample directory:
```
cd [path]/Sample
```
2). Install the dependencies:
```
npm install
```
3). Build the project:
```
npm run build
```
Copy the "Sample/dist" directory to the web server. For example, if you are using Tomcat 10.1.16, copy it to "{Tomcat-installed-path}/webapps".
Restart the web server.
Navigate to http://{server-path}/dist/index.html in your browser to access the sample.

Online Demo

https://demo.dynamsoft.com/web-twain/