Introduction

This section covers everything you need to install PrizmDoc Server. If you have questions about requirements before installing, refer to the System Requirements & Supported Environments topic. If you have questions about licensing options, refer to the Licensing topic.

Disable Windows Search

The Windows Indexing Service can potentially lock PrizmDoc log and cache files randomly. This may cause the service to hang. To avoid this issue, we recommend that you disable the Windows Search service.

For example, use the following PowerShell command to check if the Windows Search service is enabled:

PS C:\> Get-Service WSearch

stop and disable it, if running:

PS C:\> Stop-Service WSearch -Force
PS C:\> Set-Service WSearch -StartupType "Disable"

If you have concerns about disabling search service, please add Prizm logs and cache folders to search "exclude" list using "Windows Search Settings". These locations can be found in the Central Configuration file. The Central Configuration file path is C:\Prizm\prizm-services-config.yml for default installation directory "C:\Prizm".

Registry Changes

The installer may make changes to the registry and require a reboot, if the registry is not pre-configured. For more information about this, see Registry Changes for more detailed information.

Cloud Deployment

Before saving an image of a system, onto which a future non-interactive installation of PrizmDoc Server will occur, perform the Before Installation steps (below) and configure the registry manually.

Before Installation

These actions must be taken before PrizmDoc Server is installed, regardless of whether the installation is interactive or non-interactive.

IMPORTANT: Make sure you back up your configuration files before upgrading from any previous versions of PrizmDoc.

NOTE: If you have an updated license, you must re-start PAS and PrizmDoc Server in order to use the new license.

All the required components listed below must be installed and manually configured prior to installation.

Configure Rendering With Microsoft Office

If your license includes the MSO Conversion feature, which allows the server to render Microsoft Office documents natively with Microsoft Office, follow the pre-installation steps to Natively Render Microsoft Office Documents.

Installation

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

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.

3. 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).

4. 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.

5. 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.

6. Specify the database connection string to the central database that will be used by PrizmDoc Server.

7. Specify the login account (account name and password) that PrizmDoc Server will run under. Please note that the "login account" should have enough privileges to start Windows Service - it should have Log on as a service user rights. 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. Please consider the cases below for the "login account" and the Microsoft Office installation account:

   • The "login account" is the same administrative account that has been used for the installation of Microsoft Office on the system - no additional steps are required.
   • The "login account" is not the same administrative account that has been used for the installation of Microsoft Office on the system. Before installing PrizmDoc, make sure to log into the "login account" and run Microsoft Word, Excel, and PowerPoint applications once so that the corresponding registry keys for Microsoft Office are created for the "login account".

8. 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.

9. Part way through the installation, the installer will launch the PrizmDoc Licensing Utility, a tool which allows you to either install a paid license or configure the product for evaluation.

   • If you are evaluating the product, simply select I want to evaluate the product.
   • If you have a paid license, select I have purchased a license and follow the instructions on the following screens to install your license.

10. Once you have finished installing your license or configuring the product for evaluation, click the Exit button to close the PrizmDoc Licensing Utility and return to the installation process.

11. Once complete, the Installation Complete dialog is displayed. If a reboot is necessary to finalize the installation, a Restart Now checkbox will be present. By default this option will be checked, indicating the installer will automatically restart your machine when you click finish (if you would prefer to delay this restart and perform it yourself, you can uncheck the Restart Now option before clicking finish, but you MUST restart the machine before using PrizmDoc Server). Click finish to exit the installer.

IMPORTANT: By default, PrizmDoc may send requests for external content when rendering specific types of documents, such as HTML, email, or Microsoft Office documents. For your production servers, make sure to follow the recommendations in the Security Guidance topic to avoid introducing security risks.

NOTE: For a production installation of PrizmDoc on Windows, you can improve your performance by enabling Gzip compression.

NOTE: The Windows installer will start the PrizmDoc service at the end of the installation process, but it will not wait for the PrizmDoc service to start successfully. If PrizmDoc is not able to start successfully after installation, one possible reason is that it cannot connect to the MySql database. Please refer to central configuration to make sure the database.connectionString is correct.