TABLE OF CONTENTS 1 About Guide...1 2 System Requirements...2 3 Package...3 3.1 For Windows... 3 3.2 For Linux... 3 3.3 Docker image... 4 4 Windows Installation...5 4.1 Installation... 5 4.1.1 Install in a stand-alone server... 5 4.1.2 Create a new cluster... 9 4.1.3 Installation folder directory and Services... 18 4.2 Run WebPDF Viewer... 22 4.3 Uninstallation... 23 5 Linux Installation... 26 5.1.1 Installation... 26 5.1.2 Run WebPDF Viewer... 28 5.1.3 Uninstallation... 29 6 Administrator Management... 30 6.1 Activation... 31 6.1.1 Authorization Control... 31 6.1.2 Node Activation Status... 33 6.2 Database... 33 6.3 Domain... 34 6.4 Node... 35
6.5 Common... 37 6.5.1 SR Cache Clean Setting... 38 6.5.2 Rendering Engine Setting... 38 6.5.3 IE version compatible... 39 6.5.4 Watermark Settings... 39 6.5.5 SR DPI settings... 40 6.5.6 SR Tiled Rendering Setting... 40 FAQ 42 Support... 44
1 About Guide From version 2.0, Foxit WebPDF Viewer supports distributed deployment, which enables installing the product into a cluster environment to better handle scaling up and down resources based on traffic demand. There are more configurations for product deployment, including installation, activation, database and the other environment configurations. So the two chapters of Developer Guide, including Get Started (about installation) and Database, have been extracted to create this deployment guide document. This document will guide you to deploy Foxit WebPDF Viewer into your environment. This document includes 8 chapters, which are About Guide: System Requirement: Package: Windows Installation: Linux Installation: Administrator management: FAQ: Support: introduces this guide. lists the system requirement for the product deployment. introduces the packages of the product. guides you to install the product in Windows. guides you to install the product in Linux. guides you to configure for the product deployment. lists the frequently asked questions and the answers. lists the Foxit support information. Page 1
2 System Requirements Windows: Item OS Processor Memory (RAM) Hard Disk Space Linux: Item Requirement 2008 and 2012 (64 bit) Minimum: 8 core @ 3.6 GHz Recommended: 32 core @ 2.0 GHz Minimum: 16 GB Recommended: 64 GB 600 MB for installation directory 10 GB for storage (include cache and PDF stream) directory Requirement OS Linux Centos 7.0 & 7.2 Processor Minimum: 8 core @ 3.6 GHz Recommended: 32 core @ 2.0 GHz Memory (RAM) Minimum: 16 GB Recommended: 64 GB Hard Disk Space 600 MB for installation directory 10 GB for storage (include cache and PDF stream) directory Page 2
3 Package 3.1 For Windows Download the Foxit WebPDF Viewer for Windows package (*.zip) and extract it to a new directory "foxitwebpdfviewer_2_2_windows_x64". The components of the release package are shown in Figure 3-1. docs: foxitwebpdfviewer_2_2_windows_x64: API references, developer guide The release package Figure 3-1 3.2 For Linux Download the Foxit WebPDF Viewer for Linux package and extract it to a new directory "foxitwebpdfviewer_2_2_linux_x64". The components of the release package are shown in Figure 3-2. docs: foxitwebpdfviewer_2_2_linux_x64: API references, developer guide The release package Figure 3-2 Page 3
3.3 Docker image WebPDF Viewer provides docker image (container) for customer. The container is already setup and configured so the customer can use it immediately. Please refer to the more details at https://hub.docker.com/r/foxitsoftware/webpdf/. Page 4
4 Windows Installation 4.1 Installation After downloading the package, extract it, and double-click the executable file. Then follow the steps below to install Foxit WebPDF Viewer. As Foxit WebPDF Viewer 2.1 supports distributed deployment, you could choose your desired install method (Install in a stand-alone server/create a new cluster) and configure the environment accordingly when installing. Regarding the database, it installs SQLite by default for a stand-alone server installation. It requires MySQL for a cluster deployment. 4.1.1 Install in a stand-alone server This mode installs Foxit WebPDF Viewer in a stand-alone server. Once installed successfully, the WebPDF Viewer will be automatically activated with the trial key found in the release package. a) Welcome page Read the guide and then click Next to continue. b) License Agreement page Please read the license terms and click I Agree to continue if you accept the terms and conditions of the License Agreement. Page 5
c) Choose Install Method page Choose Install in a stand-alone server and click Next to continue. d) Installation Configuration page Set the web service port and then click Next to continue. The web Service Port is used to access the WebPDF Viewer demo. It is set by default to 8080 but can be set to any desired value. Page 6
e) Choose Install Location page Choose the installation location and click Install to start the installation. f) Installing page Page 7
g) Finish page When the process is complete, click Finish and then Foxit WebPDF Viewer will be available to be launched. Now, you can run WebPDF Viewer to get a taste of the features it offers, without requiring activation and additional configuration. Please see section 4.2 "Run WebPDF Viewer". Note: If you want to access the Administrator console, you can click on the link http://localhost:9000/console in the above screen to visit it. Please note that "localhost" should be Page 8
replaced with the IP address of the server that has installed Foxit WebPDF Viewer if you are not using the local host. The console port is set to 9000 by default here. 4.1.2 Create a new cluster When installing Foxit WebPDF Viewer in a cluster environment, you can select between Create a new WebPDF Viewer domain and Extend current WebPDF Viewer domain. In a cluster environment, the domain is the center which organizes all nodes as well as coordinates the data transferring between the nodes. 4.1.2.1 Create a new WebPDF Viewer domain a) Welcome page Read the guide and then click Next to continue. b) License Agreement page Please read the license terms and click I Agree to continue if you accept the terms and conditions of the License Agreement. Page 9
c) Choose Install mode page Choose Create a new cluster and click Next to continue. Choose Create a new WebPDF Viewer domain and click Next to continue. Page 10
d) Installation Configuration page Set the four items for the domain, including Domain Port, Console Web Service Port, Control Port and Domain Address. Domain Address: input IP address of the domain controller. It is used for the cluster communication. Domain Address can't be the loopback address (127.0.0.1). Console Web Service port: used to access the administrator console. Control Port: used to establish a connection with another node in a cluster environment. Page 11
e) Choose Install Location page Choose the installation location and click Next. f) Installing page g) Finish page When the process is complete, click Finish and then Foxit WebPDF Viewer will be available to be launched. Page 12
Now, you need to access the administrator console by clicking the link http://localhost:9000/console in the above screen to activate and configure the WebPDF Viewer before running the demo viewer. For more details about activation and configuration, please refer to "Configuration File" and "Services" in section 4.1.3 and section 6 "Administrator Management". Note: "localhost" should be replaced with the IP address of the server that has installed Foxit WebPDF Viewer if you are not using the local host. The console port is set to 9000 by default here. 4.1.2.2 Extend current WebPDF Viewer domain a) Welcome page Read the guide and then click Next to continue. Page 13
b) License Agreement page Please read the license terms and click I Agree to continue if you accept the terms and conditions of the License Agreement. c) Choose Install Method page Choose Create a new cluster and click Next to continue. Page 14
Choose Extend current WebPDF Viewer domain and click Next to continue. d) Installation Configuration page To add the node to an existing domain, you need to input Domain Address and Domain Port of the existing domain to be able to connect to it. For more details about Domain Address and Domain Port, please refer to the 4th step of Create a new WebPDF Viewer installation. Page 15
Then configure for the node, including Node Console Web Service Port, Node Control Port and Node Address. Node Console Web Service port: used to access the administrator console. Node Control Port: used to connect with all other nodes in the cluster. Node Address: input the IP address of the node which will be added to the existing domain. e) Choose Install Location page Choose the installation location and click Next to continue. Page 16
f) Installing page g) Finish page When the process is complete, click Finish and then Foxit WebPDF Viewer will be available to run. Page 17
Now, you need to access the administrator console by clicking the link http://localhost:9000/console in the above screen to activate the added node and configure its roles in the cluster environment before running WebPDF Viewer. For more details about activation and configuration, please refer to "Configuration File" and "Services" in section 4.1.3 and section 6 "Administrator Management". Note: "localhost" should be replaced with the IP address of the server that has installed Foxit WebPDF Viewer if you are not using the local host. The console port is set to 9000 by default here. 4.1.3 Installation folder directory and Services 4.1.3.1 Folder directory After installing Foxit WebPDF Viewer successfully, the installation directory will be shown as follows. Page 18
Here is the purpose of each file/folder in the directory: assets: bin: config: console: sample: viewer: legal.txt: release_notes.txt: uninst.exe A folder containing module code related to WebPDF Viewer. A folder containing the libraries required for the WebPDF Viewer. A folder containing the configuration files for WebPDF Viewer, such as port and database configuration. A folder containing the Administrator console project. A folder containing a sample project which you can refer to when writing a REST API. A folder containing the front-end project for WebPDF Viewer, which can be used by developers to modify the user interface. Legal and copyright information. Release information. The uninstaller for WebPDF Viewer. There are also some important modules in the "assets" folder as follows: Page 19
convert: A folder containing the server components required for WebPDF Server Rendering, which is used for converting PDF files into images. couchdb: A folder for the couchdb database used for storing the orginal PDF files and the data generated by the "convert" module, such as images. java: A folder containing the Java tools and environment required for running WebPDF Viewer. zookeeper: A folder containing the components used for distributed management. Main changes to folder structure from version 2.1: Move the viewer folder to the root folder of the directory ( it was in../webpdf/modules) Change the folder name from webapp to console Change the folder name from modules to assets Move zookeeper folder into assets (it was named quorum and local at../webpdf) Move java folder into assets (it was in../webpdf) 4.1.3.2 Configuration File - webpdf.conf Go to Config folder and there is a configuration file "webpdf.conf". The file can help do specific configurations, including login account of administrator console, cache storage size of a stand-alone server installation, service port, as well as other configuration settings. Note: If you failed to get the configuration items mentioned below, please try to copy them from webpdf.sample.conf. webpdf.sample.conf is a configuration file sample in Config folder and it lists all the specific configuration items. Page 20
Cache Storage Size For a stand-alone server, the cache storage size can be set by "couchdb.a.capacity" item and "couchdb.b.capacity" item in webpdf.conf. It is measured by MB. "couchdb.a.capacity" item is the cache for PDF converting. "couchdb.b.capacity" item is the cache for PDF uploading from the local. For more details about cache storage size, please also refer to SR Cache Clean Setting and Role Settings of Node tab. Login Account of Administrator Console When installing, Foxit WebPDF Viewer provides a default user account for login in the administrator console. The user account can be reset by adding "admin.name" and "admin.password" items (see screenshot) in the webpdf.conf file. Please restart all the services after reset the properties. For more details about the administrator console, please refer to Administrator Management. 4.1.3.3 Service There will be some services installed with Foxit WebPDF Viewer. In Figure 4-1, there are four services of Foxit WebPDF Viewer listed for a stand-alone server installation. All the four services have been started automatically. Page 21
Figure 4-1 See Figure 4-2, there are five services of Foxit WebPDF Viewer listed for a cluster deployment and the two services have been started automatically. Please start the others three services manually once the corresponding servers have been started. For more details about the servers, please refer to Role Settings of Node tab. Figure 4-2 4.2 Run WebPDF Viewer After installing successfully, you can try Foxit WebPDF Viewer demo by visiting this link: http://{ip}:{port}. ip is the IP address of the server/node/domain that has installed Foxit WebPDF Viewer. For a stand-alone server installation, port is the web service port set during installation. For a cluster deployment, port is 8080 because the web service port is set to 8080 by default without changing during installation. Page 22
Figure 4-3 Then a web page (See Figure 4-3) will be opened. You can try the basic WebPDF Viewer features in this demo, such as annotating PDF files, signing with a signature and so on. Please refer to the User Guide for more information about how to use the DEMO. Before you open a file in the DEMO, you have to activate Foxit WebPDF Viewer. For more details, please refer to Activation. 4.3 Uninstallation For a stand-alone server installation, you can uninstall Foxit WebPDF Viewer from Control Panel. For a cluster deployment, you should check the status of the node and then uninstall Foxit WebPDF Viewer. Otherwise it may cause the cluster to not work properly. Generally, if you want to uninstall a node, it is recommended that the node should be inactivate and offline. In addition, the role of the node should be stopped. Please check the status in General tab and Node tab of administrator console. Open Control Panel and choose Foxit WebPDF Viewer 2.2 item and click Uninstall/Change. In the pop-up dialog box, click Yes to uninstall. Page 23
Then it starts uninstalling. In the pop-up dialog box, click Yes to delete all data of WebPDF. When the process is complete, click OK and Foxit WebPDF Viewer will be uninstalled successfully. Page 24
Page 25
5 Linux Installation In Linux, Foxit WebPDF Viewer can also be installed in a stand-alone server or a cluster environment. Regarding the database, SQLite is installed by default with a stand-alone server installation. It requires MySQL for a cluster deployment. 5.1.1 Installation After downloading the package, extract, and double-click the rpm file or use the command line to install the package: rpm -ivh foxitwebpdfviewer_2_2_linux_x64.rpm Please note that OpenSSL is required before the installation of Foxit WebPDF Viewer. In the beginning of the installation, it will list the install methods in the command line prompt, including Install in a stand-alone server/create a new cluster. You can choose and configure the corresponding environment there. Here are the options and their corresponding configurations for the installation in command-line prompt. 1 Install in a stand-alone server You should set the web service port. Figure 5-1 Page 26
2 Create a new cluster You can choose "Create a new domain of WebPDF Viewer" or "Add new node to an existing domain". In a cluster environment, the domain is the center which organizes all nodes as well as coordinates the data transferring between the nodes. 1) Create a new domain of WebPDF Viewer You should configure for the domain, including domain port (default 2181), console web service port (default 9000), control port (default 9001) and domain address. Figure 5-2 2) Add new node to an existing domain You should input the domain port and domain IP to connect to the existing domain. Then configure the node, including console web service port, control port and console address. Page 27
Figure 5-3 See Figure5-3, in the command line prompt, it installs Foxit WebPDF Viewer in a cluster environment and "create a new domain" is chosen. 5.1.2 Run WebPDF Viewer After installing successfully, you can try Foxit WebPDF Viewer demo by visiting this link: http://{ip}:{port}. ip is the IP address of the server/node/domain that has installed Foxit WebPDF Viewer. For a stand-alone server installation, port is the web service port set during installation. For a cluster deployment, port is 8080 because the web service port is set to 8080 by default without changing during installation. Page 28
Figure 5-4 Then a webpage (See Figure 5-44) will be opened. You can try basic WebPDF Viewer features in this demo, such as annotating PDF files, signing with a signature and so on. Please refer to the User Guide to learn more information about how to use the DEMO. Before you open a file in the DEMO, you have to activate Foxit WebPDF Viewer. For more details, please refer to Activation. 5.1.3 Uninstallation For a stand-alone server installation, you can uninstall Foxit WebPDF Viewer. For a cluster deployment, you should check the status of the node and then uninstall Foxit WebPDF Viewer. Otherwise it may cause the cluster not to work. Generally, if you want to uninstall a node, it is recommended that the node should be inactivate and offline. In addition, the role of the node should be stopped. Please check the status in General tab and Node tab of administrator console. Use the following command to uninstall Foxit WebPDF Viewer: rpm -e webpdf-2.2.0 Page 29
6 Administrator Management To better manage the product, Foxit WebPDF Viewer provides a set of configurations for the administrator. After installing, please access the administrator console by going to http://{ip}:{port}/console/. ip is the IP address of the server/node/domain that has installed Foxit WebPDF Viewer. For a stand-alone server, the port is 9000 because the console web service port is set to 9000 by default during installation. For a cluster deployment, the port is the console s web service port set during installation. See Figure 6-1. Please input user name and password to login on. Figure 6-1 When installing, Foxit WebPDF Viewer provides a default user account: admin, admin. It can be reset by using the "admin.name" item and "admin.password" item in the webpdf.conf file, which is located in the installation directory "C:\foxitsoftware\webpdf\config" (see Figure 6-2). Figure 6-2 This chapter will introduce the main configurations for Foxit WebPDF Viewer. For a stand-alone server installation, there will only two configuration tabs, including Activation and Common, in administrator console as shown in the Figure 6-3. Page 30
Figure 6-3 And for a cluster, there will be five configuration tabs, which are Activation, Database, Domain, Node and Common as shown in the Figure 6-4. Figure 6-4 Note: In a cluster environment, it is recommended to complete the domain configurations first to determine the domain. Database configurations should be done before initializing the database to start the web convert service. 6.1 Activation Activation tab includes Authorization Control and Note Activation Status. From version 2.1, the license mechanism of Foxit WebPDF Viewer is more flexible, especially for cluster deployment. 6.1.1 Authorization Control Authorization Control shows the product license status in the environment. Authorization Status: CPU usage status: Key File: Trial/Formal Account/License expired/activation failed License X CPUs, Used Y CPUs, No activation Z CPUs Apply the license key file/check Key Info Page 31
Authorization Status: Trials The Foxit WebPDF Viewer package includes a default 10-day free trial key. Once installing in a standalone server successfully, it will be activated with the trial mode. When deploying a cluster, you need to import the evaluation key file manually and then activate the node for further usage. The trial version has no difference from a licensed version except for the 10-day limitation set in the free trial along with trial watermarks in the generated pages. See Figure 6-5, it shows "Authorization Status: Trial" for the trial mode. Figure 6-5 Authorization Status: Formal Account The licenses grant users permission to release their applications based Foxit WebPDF Viewer. However, users are prohibited to distribute any documents, sample codes, or source codes in the released packages of Foxit WebPDF Viewer to any third party without the permission from Foxit Software Incorporated. See Figure 6-6. After receiving a license from Foxit, import the key file and apply it to activate Foxit WebPDF SDK. Once successful, Authorization Status will be changed to Formal Account. The trial watermark will disappear when the user opens files in Foxit WebPDF Viewer. Figure 6-6 CPU usage status From version 2.1, the license key of Foxit WebPDF Viewer is bundled with the purchased core quantity of CPU licenses. In a cluster deployment, the administrator can allocate the available CPU licenses to the Page 32
node and retrieve the CPU licenses by inactivating the node. If Formal license, CPU usage status shows the total CPU licenses included in the key file, the ones which are used and the ones which are available. See Figure 6-6. In this license, there are 16 CPU licenses totally and currently 8 licenses have been used and 8 licenses are available. 6.1.2 Node Activation Status Node Activation Status only appears for a cluster deployment. It lists the activation status of all the nodes in the cluster environment. Administrator can check the node status of the environment and can also choose to activate or inactivate the node according to the license. See Figure 6-7, there are two nodes in a cluster environment and they are both activated. Figure 6-7 6.2 Database Database tab only appears for a cluster deployment. SQLite is installed by default with a stand-alone server installation. It requires MySQL for a cluster deployment. And the administrator can configure the database here. Please add mysql-connector.jar, which is the official JDBC driver for MySQL, to all the nodes in the cluster environment. Do it as follows. To start a new added node, mysql-connector.jar is also needed. 1. mysql-connector.jar can be found: http://dev.mysql.com/downloads/connector/j/ 2. In the installation folder of Foxit WebPDF Viewer, create ext folder and copy mysql-connector.jar to ext folder. See Figure 6-8, Administrator can configure database for Foxit WebPDF Viewer, including Hostname/IP address, Database port, Database username and Database password. When configuring, you can use the Test connection/save/initialize options to complete deployment of the database for Foxit WebPDF Viewer. Page 33
Figure 6-8 Note: The maximum number of database connection which each Web Server/Convert Server can use is 30. Please update the maximum number of MySQL connection according to the services quality in the environment. 6.3 Domain Domain tab only appears for a cluster deployment. In a cluster environment, the domain is the center which organizes all nodes as well as coordinates the data transferring between the nodes. All the domains will be listed in Domain tab, including the online domain and the offline domain, which can be configured here like the Figure 6-9. Figure 6-9 Click Configure Domain button and go into the window shown in Figure 6-10. Administrator can add the node to the domain list or remove the node from the domain list. Page 34
Figure 6-10 6.4 Node Node tab only appears for a cluster deployment. All the servers in a cluster environment will be listed as nodes in the Node tab. See Figure 6-11. All the nodes of the cluster, with its IP, Roles and Status, will be displayed here. Administrator can set a node to have one or multiple roles and then update the role s status if needed. Figure 6-11 Page 35
IP IP can be the identifier of a node. Move the mouse to a node, and the Delete icon will be shown in the left of the IP. You can remove offline nodes. Roles Click the node IP, and go into the Role Setting window. There are three roles, which are Web server, Convert server and Couchdb server as shown in the Figure 6-12. Web server: Convert server: CouchDB server (storage): responds and process the http request from WebPDF Viewer. parses PDF and converts PDF to the one for the browser. stores cache for PDF parsing. Figure 6-12 To set a node to have one or multiple roles, the node or the node s component should be shown under Stop status. Or it will fail. When setting the node, it will allocate a port for each role by default, which can t be changed here. However, the web server port and the convert server port can be reset in webpdf.conf. For more details, please refer to Configuration files. Please make sure the port is available for the corresponding role (server). For Couchdb Server, administrator can set Cache storage size and Cache effective time. As a standalone server installation, cache storage of a cluster deployment is for PDF converting and uploading. Some data files (such as images, PDF text stream, etc.) will be created when viewing PDF files within Foxit WebPDF Viewer in the server. It will consume memory of server during data conversion. To reasonably reuse the data files as well as reduce memory consumption, Foxit WebPDF Viewer will save the images and other converted data files to the internal storage. When converting, Foxit WebPDF Viewer will extract the data files in the cache if the requested file information is stored internally. Page 36
Cache storage size The cache storage size (MB): The default size is 10 GB (10240 MB) in an individual server or server farm. Cache effective time The time it takes for the cache to be stored. Cache data will be deleted automatically after the effective time. The default value is 30 days. The min. value is 1. Note: The path for Storage is the installation folder of Foxit WebPDF Viewer. Please make sure there is enough disk space in the installation folder for Storage. Status Select the role(s) of a node and then you could update the status (Start/Stop). 6.5 Common Common tab includes SR Cache Clean Setting, Rendering Engine Setting, IE version compatible, Watermark Setting, SR DPI Setting and SR Tiled Rendering Setting as shown in the Figure 6-13. Figure 6-13 Page 37
6.5.1 SR Cache Clean Setting Administrator can clean the cache manually by the Clean exceed cache option or Clean all cache options here as shown in the Figure 6-14. Clean exceed cache In the settings of cache storage size, the administrator can clear the cache if it has exceeded its limits. For a stand-alone server, the cache storage size can be set by "couchdb.a.capacity" item and "couchdb.b.capacity" item in webpdf.conf (..\foxitsoftware\webpdf\config\ webpdf.conf). The measure unit is MB. "couchdb.a.capacity" item is the cache for PDF converting. "couchdb.b.capacity" item is the cache for PDF uploading from the local. For a cluster deployment, the cache storage size can be set with CouchDB server (storage) role. More detail, please refer to Role Setting of Node tab. Clean all cache Clean all the cache. Figure 6-14 6.5.2 Rendering Engine Setting From version 2.0, Foxit WebPDF Viewer adds JR as the rendering engine of desktop. JR (Java Script Rendering Engine) is faster than SR (Service Rendering Engine). But the document in the server must be downloaded into the browser memory. Desktop View: Mobile View: SR/JR. If choosing JR, you need to set the web fonts for the document rendering. (See Figure 6-15) China: http://fonts.foxitsoftware.cn/webfonts/ US & Europe: http://webpdf.foxitsoftware.com/webfonts/ Only SR is supported. Page 38
Figure 6-15 Note: If you will use Offline Mode function under SR in Desktop View, please also help to set the web fonts server to correct region of JR since Offline Mode using JR rendering engine instead. 6.5.3 IE version compatible From version 2.2, Foxit WebPDF Viewer provides an option to support IE8/9. If your system needs to support IE8/9, please check the option as shown in Figure 6-16. It will take one more second to open a document in average. Please note that this option does not work in JR rendering engine. Figure 6-16 6.5.4 Watermark Settings For security reasons or marking purposes, administrator may want to add a watermark on the file while using Foxit WebPDF Viewer. Foxit WebPDF Viewer supports fixed watermarks and dynamic watermarks. See Figure 6-17. Add Watermark: Check this option to add watermark while using Foxit WebPDF Viewer. Fixed: Check this option to choose fixed watermark and input the text of the watermark. Dynamic: Check this option to choose dynamic watermark. Then set the contents and format for the watermark. Page 39
Figure 6-17 All the PDF files will be added with the set watermark while opening Foxit WebPDF Viewer. 6.5.5 SR DPI settings Administrator can change the output image s DPI value in this setting (See Figure 6-18 6.5.6 SR Tiled Rendering Setting From version 2.2, Foxit WebPDF Viewer supports tiled rendering setting for SR rendering engine (See Figure 6-19). Tiled rendering is the process of subdividing a page (image) by a regular tile and rendering each section of the tile separately, which can greatly reduce the memory and bandwidth to speed up displaying the page contents. When using tiled rendering, WebPDF Viewer just needs to download the tiled images in the view area instead of the entire image of the page. The valid range of the tile size is from 200 to 1000, and the default is 400. The size of the tile will affect the page loading speed. If the tile size is too small, the more tile images will be rendered for each page and the http request of images will be increased, which will add burden to the server and affect the displaying speed of the front-end. On the contrary, if the tile size is too large, the tiled rendering will not live up to its original intention. In general, the best choice is to divide the entire page into 4~8 tile images. In your system, if most of the document pages are relatively large, then the tile size can be set larger, whereas smaller. Figure 6-19). If your program requires a high-definition document rendering, a higher value is recommended. But the higher the DPI, the larger an image will be, and the longer rendering will take. In Page 40
this case, you might need to upgrade the servers with more CPUs, more available memory, and/or higher bandwidth. Figure 6-18 6.5.7 SR Tiled Rendering Setting From version 2.2, Foxit WebPDF Viewer supports tiled rendering setting for SR rendering engine (See Figure 6-19). Tiled rendering is the process of subdividing a page (image) by a regular tile and rendering each section of the tile separately, which can greatly reduce the memory and bandwidth to speed up displaying the page contents. When using tiled rendering, WebPDF Viewer just needs to download the tiled images in the view area instead of the entire image of the page. The valid range of the tile size is from 200 to 1000, and the default is 400. The size of the tile will affect the page loading speed. If the tile size is too small, the more tile images will be rendered for each page and the http request of images will be increased, which will add burden to the server and affect the displaying speed of the front-end. On the contrary, if the tile size is too large, the tiled rendering will not live up to its original intention. In general, the best choice is to divide the entire page into 4~8 tile images. In your system, if most of the document pages are relatively large, then the tile size can be set larger, whereas smaller. Figure 6-19 Page 41
FAQ 1. How should I do if failing to change the role status of a node to Start in administrator console? Please make sure that the default port for the role is available. All the nodes in the environment can have one or multiple roles of the three available roles. When setting a node as a role, it will allocate a port for the role by default. 2. Can I configure the database in a stand-alone server installation? No, you can't. For a stand-alone server installation, SQLite will be installed and configured by default, and you cannot configure the database by yourself. Only in a cluster deployment can you configure the MySQL database as desired. 3. What should be ready before connecting to the database for a cluster deployment? For a cluster deployment, it requires MySQL. Please add mysql-connector.jar, which is the official JDBC driver for MySQL. 1) mysql-connector.jar can be found: http://dev.mysql.com/downloads/connector/j/ 2) In the installation folder of Foxit WebPDF Viewer, create ext folder and copy mysqlconnector.jar to ext folder. 4. Why did MySQL database set fail in a cluster deployment? For a cluster deployment, if you deploy the MySQL database and WebPDF in the same server, the IP address of the database should be set to 127.0.0.1 instead of the real IP address of the computer. Otherwise, the database cannot be connected successfully. In addition, if you deploy the MySQL database and WebPDF server on different computers, please make sure both of them have remote access permission. 5. Why is there still an evaluation watermark when opening a PDF after Foxit WebPDF Viewer has been activated by a purchased license successfully? To fix the error, please clean the cache: Administrator Console > Common tab > SR Cache Clean Setting > Clean all cache. In addition, you should clean the cache of the internet browser in the computer. 6. Why do I have to wait so long when opening PDF using JR as the rendering engine? I am from China. When using JR as the rendering engine to render the unembedded fonts, it will connect to Foxit server to download the font library for the text rendering. There are two Foxit servers providing Page 42
the font library. Please get the one for your region. The default one is for US & Europe, please set it to the one for China in Rendering Engine Setting. For US & Europe: http://webpdf.foxitsoftware.com/webfonts/ For China: http://fonts.foxitsoftware.cn/webfonts/ 7. Does WebPDF Viewer support HTTPS directly? No. WebPDF Viewer does not support HTTPS by default. If you want to support it, then it is possible, you need to set a HTTPS proxy for the server(s). Based on performance and efficiency considerations, it is recommended you use http in the intranet environment, and set up SSL on the load balancer or forward proxy, such as AWS ELB or Apache HTTP Server http://httpd.apache.org/docs/2.2/mod/mod_proxy.html. Page 43
Support Foxit Support: http://www.foxitsoftware.com/support/ Sales Contact: Phone: 1-866-680-3668 Email: sales@foxitsoftware.com Support & General: Phone: 1-866-MYFOXIT or 1-866-693-6948 Email: support@foxitsoftware.com Page 44