PrizmDoc Viewer v13.18 Release - Updated
Troubleshooting / PrizmDoc Server Health Issues
In This Topic
    PrizmDoc Server Health Issues
    In This Topic

    Introduction

    This section outlines possible reasons why the PrizmDoc Server may not show as healthy.

    If you've checked the PrizmDoc Server health, and any of the services are unhealthy, try the following:

    • Check your permissions, login, and password of the service user
    • Verify that you are using a valid license

    If your services are still unhealthy, there are some common reasons for this:

    The 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. For more information, refer to the Memory Consumption Issues topic.

    Linux-specific Instructions

    The Cache is Corrupted or Inaccessible

    A common problem is not running or installing PrizmDoc Server as the root user, which is a requirement for running PrizmDoc on a Linux server. Correcting this will solve permission-related issues while accessing the cache. To clear a potentially corrupted cache manually, use the following steps:

    1. Run: /usr/share/prizm/scripts/pccis.sh stop
    2. Delete the contents of: /usr/share/prizm/cache/
    3. Start up PrizmDoc Server: /usr/share/prizm/scripts/pccis.sh start

    PAS or PrizmDoc Server is Not Running

    Another common issue is that either PrizmDoc Application Services (PAS) or PrizmDoc Server isn't running.

    To check that PAS is running:

    1. Navigate to: /usr/share/prizm/pas/pm2
    2. Run: ./pas.sh status

    To check that the PrizmDoc Server is running:

    1. Navigate to: /usr/share/prizm/scripts
    2. Run: ./pccis.sh status

    If the steps 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 /usr/share/prizm/prizm-services-config.yml:

    alt text

    In the example above, the license key is "2.0.E6Aorkh8..." To locate your license key, copy everything after "license.key:" and send your full license key to Accusoft Support.

    NOTE: Your solutionName and license key may differ from the example above.

    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.

    Windows-specific Instructions

    The Cache is Inaccessible or Corrupted

    You will need to clear the cache. 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 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:

    alt text

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

    PrizmDoc Server or PAS is Not Running

    If you've checked the PrizmDoc Server health, and any of the services are unhealthy, try the following:

    1. Verify that the PrizmDoc Server is running:

      alt text

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

      alt text

    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:

      alt text

    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 ASP.NET Framework 4.5+ is currently installed:

      alt text

    7. Also, open Server Roles and check that ASP.NET 4.5+ is enabled under Web Server (IIS):

      alt text

    8. Check the health of the PrizmDoc Server at:

      http://localhost:18681/admin

      Your license status will be displayed at the top.

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

    PAS is Not Connected to PrizmDoc Server

    To check that PAS can connect to PrizmDoc Server, this API call:

    GET http://localhost:3000/servicesConnection

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

    Successful Response

    `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

    `580`
    
    

    The response shows that PAS is not properly configured to communicate with PrizmDoc Server. For help with configuring PAS to communicate with PrizmDoc Server, please review Configuring the PrizmDoc Server Connection

    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.

    Related FAQs