Skip to main content
Kofax

Explaining the 2:00 am ShareScan service restart

Is it okay to disable the 2:00 am ShareScan restart?

Information:

What is the 2:00 AM restart?

The 2:00 am service restart has been a feature of the eCopy ShareScan product since ShareScan 3.x.  In ShareScan 5.x this feature restarts the processes for ShareScanManager and the Apache Tomcat (if installed).  ShareScan Agent is not restarted. This is partly to mitigate against memory management and fragmentation issues which may occur if the ShareScan Manager service is run continuously. As ShareScan relies on and works with many third-party libraries, files, components and back end systems, memory management is not always within the control of Nuance software.  

Note: During this restart, ShareScan should not be used.  Some devices running ShareScan Embedded may be temporarily disconnected then reconnected to the ShareScan Manager.

When should the Automatic Restart be adjusted?

In most environments 2:00 AM is outside of office hours where scannning takes place. If scanning is occurring during this time or other processes such as a server backup are occurring, the 2:00 AM restart should be moved to a different time.

ShareScan 5.4 has an improved restart algorithm which works more reliably.

If using ShareScan 5.2 SP2, install  or later.

If using ShareScan 5.0 and 5.1, and the services are not properly restarting after the 2:00 am restart, there is a possibility that the services are taking longer to stop than expected by the system.  The script below may be used as an alternative to the built-in functions.  This script is not recommended for ShareScan 5.2 SP2 or 5.4.

If Apache Tomcat is not installed, refer to .

How to properly adjust the 2:00 AM restart (for ShareScan 5.0 and 5.1):

There are two parts to adjusting the restart. First, disable the ShareScan default restart. Second, create Windows scheduled tasks to perform the restart. As most environments have a conflict with the restart being too quick, providing ample time between the stop and start is important. In enterprise environments with large quantities of devices, more time may be required.

A. Disabling the default 2:00 AM Restart:

ShareScan 5.0 and 5.1

  1. Open the ShareScan Admin Console.
  2. In the ribbon select the "Advanced" tab.
  3. Click on "Timers".
  4. Under the "Auto Restart ShareScan Manager" group deselect the "enabled" checkbox.
  5. Click "Save".
  6. In the ribbon "Home" tab select "Restart" to restart the ShareScan manager.

ShareScan 4.x, 3.x:

  1. Close the admin console
  2. Open Windows Services
  3. Stop the ShareScan Manager and Agent services
  4. Click "Start > Run".
  5. Type "regedit" without the quotation marks and click "OK".
  6. Export a backup of the registry by clicking " File > Export".
  7. Save this file to the Windows Desktop and name the file "backup". (Keep "backup" for a few days and if there are no issues, then this file can be deleted.)
  8. Browse to following registry key:
    • HKEY_LOCAL_MACHINE\SOFTWARE\eCopy\ShareScanOPManager
  9. Right click and select "New > String Value".
  10. Rename the String "RestartTimer".
  11. Double click on the key and set the value to -1.
  12. Close the registry editor.
  13. Start the ShareScan Manager and agent services

Note:

B. Scheduling Windows tasks:

  1. For version 5.0 installations download the batch files attached to this article onto the admin console PC. Scripts for ShareScan 5.1 must be manually created. In versions 3.x and 4.x the batch files are included in the installation.
  2. Click "Start > Control Panel > Scheduled tasks > Add scheduled task".
  3. In the wizard click "Next" then "browse".
  4. Browse to the Stop batch file and select "Open".
    • Note: In ShareScan 3.x and ShareScan 4.x this is located in the "C:\Program Files\eCopy\ShareScan OP\ShareScanOPManager" folder by default. In ShareScan 5.x this is located where the files were saved in Step 1.
  5. Schedule the task for 2:00 AM or an appropriate time for the environment, Daily, and set the start date for the next day. Click "Next"
  6. Provide local admin credentials. Click "Next" then "Finish"
  7. Follow Steps 2-6 above selecting the start batch file and selecting a time 15 minutes after the stop task.

 

Attachments:

SS50-restart-batch-files.zip (475 bytes)