Page tree

Versions Compared


  • This line was added.
  • This line was removed.
  • Formatting was changed.

This will guide you how to install and start the Synap Document Viewer .

Installation preparation

Synap Document Viewer conversion server requires JRE 1.7 or higher. In addition, the server needs to be configured in the PATH to run JAVA.

Please check the following. The example below is based on the Linux system.

Code Block
titleJDK Version Check
#> export PATH=$JAVA_HOME/bin
#> java -version 
java version "1.7.0_80"
Java(TM) SE Runtime Environment (build 1.7.0_80-b15)
Java HotSpot(TM) 64-Bit Server VM (build 24.80-b11, mixed mode)

Install Synap Document Viewer Server Edition

To install Synap Document Viewer package, extract installation files in the installation directory.

Hereinafter the installation directory will be expressed as ${INSTALL_DIR}. The example below is based on the Linux server. 

Code Block
titleJDK Version Check
#> tar zxvf SynapDocViewServer-{Version}.tgz

Synap Document Viewer Server operation settings

Open ${INSTALL_DIR}/config-properties.xml and configure settings according to the operating environment with reference to the following.

Basic configuration

Configure basic settings using the setup file provided with the package.

Code Block
titleBasic Configuration
<?xml version="1.0" encoding="UTF-8" standalone="no"?> 
... Skipped ...
<entry key="convert.config.baseDir">base_linux</entry> 
<entry key="convert.config.downloadDir">down</entry> 
<entry key="convert.config.dpi.h">120</entry> 
<entry key="convert.config.dpi.l">18</entry> 
<entry key="convert.config.dpi.m">96</entry> 
<entry key="convert.config.maxWorker">1</entry> 
<entry key="convert.config.outputDir">out</entry> 
<entry key="convert.config.skinDir">skin</entry> 
<entry key="convert.config.workingDir">work</entry> 
... Skipped ...

You must configure settings for the following 5 directories before proceeding to the follow-up procedures. You can change the remaining settings on the administrator screen after the Synap document viewer is started properly. For the settings path, please refer to "237568162019 2. Installation Guide".

  • convert.config.baseDir : ${INSTALL_DIR}/baseDir

  • convert.config.downloadDir : ${INSTALL_DIR}/down

  • convert.config.outputDir : ${INSTALL_DIR}/out

  • convert.config.skinDir : ${INSTALL_DIR}/skin

  • convert.config.workingDir : ${INSTALL_DIR}/work

Configure the default values according to ${INSTALL_DIR}. You can set an absolute path to a desired directory other than the default directory if needed.

Skin settings

In ${convert.config.skinDir}/skin/common.js, set the lower section to "true".


.. Skipped ...

allowCopy : true,
allowResize : true,
isRenderServer : true, // conversion server use status

... Skipped ...

tomcat settings

Add settings to enable loading a configuration file at the time of starting tomcat. Using the ${INSTALL_DIR}/tomcat/bin/ file, configure settings as follows.

Default settings are identical to ${INSTALL_DIR}.

Code Block
titleconfig.dir.path Configuration
... Skipped ...
JAVA_OPTS="$JAVA_OPTS -Dconfig.dir.path='${INSTALL_DIR}'"
... Skipped ...