Introduction

This topic covers troubleshooting tips for PrizmDoc. Note that this topic does not cover issues related to custom web-tier implementations.

The Viewer isn’t Working (Check the PrizmDoc Server)

The following section contains basic troubleshooting steps limited to the PrizmDoc Server.

1. Verify that the PrizmDoc Server is running:

   

2. Verify that the PrizmDoc Application Service (PAS) is running (if your application is using PAS):

   

3. Verify that the "Log On As" user for the PrizmDoc Server has not recently had a password change. Right-click Properties and re-enter the user password:

   

4. Navigate to C:\ProgramData\Accusoft and make sure that the user from Step 2 above has full permissions to the folders under Prizm:

   a. Right-click the Prizm folder and select Properties.

   b. Navigate to the Security Tab.

   c. Select Advanced.

   d. Select Change permissions (if required).

   e. Make sure that the user from Step 2 above has Full Control.

   f. Be sure to select Replace all child object permission entries with inheritable permission entries from this object to avoid discrepancy.

   g. Apply any changes that were made.

5. Open the Internet Information Services (IIS) Manager.

6. Check that the PrizmDoc Service Web Site is running with its application pool.

   a. The actions menu on the right-hand side will show if it is running.

   b. Click on Basic Settings in the action menu to see the application pool set.

   c. After verifying the pool name, go to Application Pools.

   d. Verify that the application pool is started.

   e. If the Application pool identity is a user, and that user is different from the one checked for the Windows PrizmDoc Service, verify that the password and permissions are set in the same way as Step 3 above.

   f. Open the Windows Features and check that .NET Framework 4.5 Advanced Series is currently installed.

7. Also, check that the ASP.NET4.5 Application development features are enabled under Internet Information Services:

   

8. Test a file outside of the Samples. Open a browser and navigate to:

   http://localhost:18681/PCCIS/V1/Static/Viewer/Test
   Where localhost is a hostname that points to the PrizmDoc Server.

   Attempt to open a known, good file using the Viewer. If the file works, then PrizmDoc is currently functioning. If not, continue troubleshooting.

9. Check the health of the PrizmDoc Server.

   If you are using PCC v10.x or later, this can be found at:

   http://localhost:18681/admin

   Your license status will be displayed at the top:

   

   If you are using PCC v9.x, this can be found at:

   http://localhost:18681/PCCIS/V1/Service/Current/Info

   The health of the services will be displayed (which will display the same data in JSON format).

10. If you find that some of the services are unhealthy (and you have checked permissions, login and password of the service user, and are using a known valid license), there are two primary reasons for this:

System has Limited Resources

The system resources for a machine running PrizmDoc are described in Sizing Servers. Please note that PrizmDoc will require at least a few gigabytes free while running and no conversions are taking place. If your system has PrizmDoc installed and idles with 1-2GB free RAM, then the services will run into stability issues.

The Cache is Corrupted or Inaccessible

Step 3 above is the most common issue for this, however clearing the cache is good practice. To clear the cache manually, use the following steps:

1. Stop the Windows PrizmDoc Server.
2. Delete the contents of C:\Prizm\Cache.
3. Start up the Windows PrizmDoc Server, and restart IIS.

If Steps 1 through 9 above have been checked and the Admin page shows that PrizmDoc is unlicensed, then the license key will need to be verified by Accusoft Support at support@accusoft.com. You can find the current license key in C:/Prizm/prizm-services-config.yml:

Your license key will be everything after the equal sign on Line 6. Copy and send your full key to Accusoft Support.

Check that PAS is able to Connect to PrizmDoc Server

Example

GET http://localhost:3000/servicesConnection

Returns the status of PAS connectivity to the PrizmDoc Server, whether local or configured through Accusoft Services.

Successful Response

Example

200 OK

OK

This response shows that the connection to PrizmDoc Server is successful, but does not take into account whether or not those services are healthy. If you need to check the health of the services, please make a call to them directly.

Error Responses

Example

580

The response shows that PAS is not properly configured to communicate with PrizmDoc Server.

If everything seems to be functioning, and a file is still not displayed in the Viewer, there may be an issue with the conversion of the specific file. If this is the case, send the file to support@accusoft.com for evaluation and submission to our engineering team.

My Documents are Loading Slowly

Question

Why are my documents loading slowly in the Viewer when PrizmDoc Server is installed on a Windows 2016 server?

Answer

When Windows Defender is enabled for Real-Time scanning, this may impact performance. If you disable Windows Defender Real-Time scanning, the performance issue should resolve immediately.