PrizmDoc v13.2 - Updated
Windows Installation
Get Started! > 2 - Install PrizmDoc Server (Self-Hosted only) > Install on Windows > Windows Installation

To install PrizmDoc Server on your own server, follow these steps:

PrizmDoc requires a clean installation when migrating from a version earlier than v12.0. You must first uninstall any previous versions of PrizmDoc and reboot your system. Only then should you install PrizmDoc v12.0 or later. Make sure you back up your configuration files before uninstalling any previous versions of PrizmDoc. Once you have installed v12.0, you do not need to uninstall if you want to migrate to v12.1 or later.
Before downloading and installing PrizmDoc, you must activate ASP.NET and IIS on your system in order to view the samples.
  1. Download PrizmDoc Server from the website.
  2. Double-click on the PrizmDocServer-xx application file to launch the installer (where xx represents the version). Click Install PrizmDoc Server.
  1. Carefully read the information contained in the License Agreement form before making a decision to accept the terms of the License Agreement. Choose I accept the terms in the License Agreement to accept the conditions outlined in the License Agreement and then click the Next button to continue the installation (or click Cancel to exit the installation process). 
  2. If your machine does not meet the PrizmDoc Server minimum system requirements, a dialog displays indicating the requirements that are not met. (You may choose to continue installation, but may experience poor performance.) Click Next.
  1. The Installation Path dialog is displayed. Specify the destination directory where the PrizmDoc product should be installed or choose the default installation destination directory, then click Next
  1. Specify the login account (account name and password) that PrizmDoc Server will run under. If you are using the Microsoft Office Conversion (MSO) add-on, please make sure that the "login account" is a real user account with Administrator rights. Running PrizmDoc under the LocalSystem user or another Microsoft Windows integrated service account is not supported for this option. 
  1. Click Install to continue. The Installation dialog is displayed with a progress bar. While PrizmDoc Server is installing, you can click on the links to review the Release Notes, Online Demos or Code Examples.
  1. Part way through the installation, the installer will launch the PrizmDoc Licensing Utility. Select the I want to evaluate the product
  1. The Evaluation dialog is displayed. Enter your email address that you registered in the Customer Portal for your evaluation and click Request Evaluation
  1. The Evaluation Success dialog is displayed. Click Exit to return to the installation process.
  1. After the PrizmDoc Licensing Utility completes, the installer will continue setting up your system with PrizmDoc Server.
  2. Once the configuration is complete, the Installation Complete dialog is displayed. There will be an option to launch the PrizmDoc Documentation and Release Notes if you wish to view them directly after the installation. You will also have the option to restart your server. If you select the Restart Now checkbox, your system will restart. If you don't want to restart your server, click Finish to exit the Installer.   
  3. If you purchased PrizmDoc with the Microsoft Office Conversion service, continue to the next section below. If you did not purchase PrizmDoc with the Microsoft Office Conversion service, then your installation is complete.
Future planning: for a production installation of PrizmDoc on Windows, you can improve your performance by enabling Gzip compression. 

Additional Steps for Microsoft Office Conversion Service Only

Note that Steps 14-17 below are required if you purchased PrizmDoc with the Microsoft Office Conversion service.

  1. The Microsoft Office Conversion Service, that is bundled with PrizmDoc, requires a Windows Registry modification in order to work properly, such as:

Registry Key: HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Control\Session Manager\SubSystems
Value: Windows

That value is a complex, space separated set of system-wide settings. One of them is a "SharedSection" comma-separated sub-value with 3 values. Below is a default value for Windows 2008/2012 x64 systems:

SharedSection=1024,20480,768

The third value is a non-interactive desktop heap size in kilobytes. The installer will increase it (if there is a default value) in order to run MS Office in non-interactive mode properly.

  • A system reboot will be required in order for the change to have effect.
  • Due to a known issue with the installer, it might not ask for a reboot after the installation, so please make sure to reboot the system manually. This issue will be addressed in the future release.
  • If the non-interactive desktop heap size is not the default and meets PrizmDoc requirements, it won't be modified, and the system reboot won't be required. You can check installer's logs to see whether a system reboot was scheduled.

Upon an un-installation of the product, the original non-interactive desktop heap size will be restored, and a system reboot would be required again.

  1. The Microsoft Office Conversion Service requires the Microsoft XPS Document Writer printer driver to be installed for the best conversion performance and rendering fidelity of MS Excel documents. The PrizmDoc’s installation process sets the Microsoft XPS Document Writer to be the default printer driver on the system. Note that if you need to re-install Microsoft XPS Document Writer, follow the steps in the Microsoft XPS Document section below.
  2. Specifically for Windows Server systems, it is important to note that the Microsoft PowerPoint rendering support within Microsoft Office requires you to enable the "Ink and Handwriting Services" desktop experience feature from the Server Manager.
The installed copy of Microsoft Office must be activated in order for PrizmDoc's Microsoft Office Conversion Service to work properly. Not licensed, not activated, an expired or trial version of Microsoft Office will not work with PrizmDoc.

If you are running PrizmDoc in cluster mode, all servers in the Windows MSO cluster must use the same version of Microsoft Office.

  1. It is important to block specific Windows firewall ports to prevent SMB traffic from leaving the configured Windows instance. The following outbound ports should be blocked: TCP: 137, 138, 139, 445 and UDP: 137, 138. Please refer to the Microsoft guidelines for blocking specific firewall ports to prevent SMB traffic.

Microsoft XPS Document Writer Installation Steps

Please note that Microsoft XPS Document Writer comes pre-installed on most Windows systems. However, if the Microsoft XPS Document Writer is not installed on your system, or in case it was previously removed, it must be installed back on the system using the following steps:

  1. Click Start and select Devices and Printers.
  2. Click Add Printer.
  3. Choose Add a Local Printer.
  4. Select Use an Existing Port.
  5. Select XPS Port and click Next.
  6. In the manufacturer list, choose Microsoft.
  7. On the right side, choose the latest version of the XPS document writer and click Next.
  8. Choose "Use the driver that is currently installed", click Next.
  9. Select the option "Do Not Share Printer", then click Next.
  10. Check the box for "Set as the default printer", then click Finish.  

If the XPS Port is not available, perform the following steps:

  1. Click Add a Printer.
  2. Choose Add a Local Printer.
  3. Select Create a New Port.
  4. Select Local Port, then click Next.
  5. In the "Enter a Port Name" field, type in XPS Port, then click OK.
  6. In the Manufacturer list, choose Microsoft.
  7. On the right side, choose the latest version of the XPS Document Writer, then click Next.
  8. Choose "Use the driver that is currently installed", click Next.
  9. Printer name should be Microsoft XPS Document Writer, then click Next.
  10. Select the option "Do Not Share Printer", then click Next.
  11. Check the box for "Set as the default printer", then click Finish.
In order to achieve the best performance and fidelity, and avoid potential rendering issues with MS Excel documents, it is important to make sure the Microsoft XPS Document Writer is configured as the default printer for the user which is configured to run the PrizmDoc service.