ScanToPDF Service

• Introduction

  Adding a run as service feature key turns ScanToPDF into a powerful, automated solution for processing files without any user intervention. This feature is obviously not suitable for use with a scanner because there is no user interface. 
  
  Existing customers can add the run as service feature key at any time to convert the system to run as service.
  
  PLEASE NOTE
  The service is a feature key only. There is no plugin for the service JUST an activation key.

• 1. Installation and Activation

  PLEASE NOTE
  The service is a feature key only. There is no plugin for the service JUST an activation key.
  
  Using the ScanToPDF Installer

  To install the software to run as a service simply add the command line switch /SERVICE when you run the installation executable scantopdfsetup.exe (using a desktop short-cut or a simple batch file) so that the executable is run as shown below.
  
  scantopdfsetup.exe /SERVICE
  

  Without Using the ScanToPDF Installer

  First install ScanToPDF.
  Start Windows explorer and open the ScanToPDF folder, by default
  C:\Program Files\O Imaging Corporation\ScanToPDF
  Locate the file ScanToPDFService.exe
  To install the service, make a shortcut to the executable with a target of
  ScanToPDFService.exe --install
  The shortcut must have the “Run this program as an administrator” option set on the Compatibility TAB

  Run the shortcut
  This will install the service
  Check the log files for further information.
  ScanToPDFService.InstallLog
  ScanToPDFService.InstallState
  To look at the service, use the windows service manager and look for the service named ScanToPDF Service
  
  The service will only run when an activation key for the feature has been added. Please click here for details about activation.
  
  We do provide temporary keys to enable evaluation of the service feature. Please click here and follow the instructions (Registration Required)

• 2. Configuration

  ScanToPDF Configuration

  To make changes to configuration or to activate ScanToPDF, use the ScanToPDF executable desktop application ScanToPDF.exe or ScanToPDFx64.exe. Once configuration is complete, close the desktop application
  

  Monitoring Multiple Import Folders With The Service

  The folder monitoring performed by the service is controlled using a simple macro script file called ScanToPDFService.scp in the ScanToPDF application folder. Create the file as a text file and edit the file using notepad, saving the file in the ScanToPDF application folder.
  
  Here are some example script commands
  
  Example 1 
  ProcessAllDocumentProfiles() 
  
  This would instruct the service to process each configured document profile in sequence 
  

  Example 2 

  DocumentProfileName='Accounts' 
  QueueCommand("scan") 
  
  This would instruct the service to process only the Accounts document profile 
  

  Example 3

  DocumentProfileName='Accounts' 
  QueueCommand("scan") 
  DocumentProfileName='Sales' 
  QueueCommand("scan") 
  
  This would instruct the service to process the Accounts document profile and then the Sales document profiles in turn

• 3. IMPORTANT - Mapped Drives and Folder Permissions

  Mapped Drives

  Mapped drives are not suitable for use in a windows service. If the ScanToPDF settings use mapped drives, then these should be changed to UNC paths prior to using the service.
  

  Folder & File Permissions

  All folders that require access by the service (input and output) will need to have the appropriate security permissions to allow reading and writing of folders and files. By default, a service runs as the local system account user, but this can be changed on the "Log On" TAB in the service properties. Either provide the correct permissions to the local system account or use another user (with the correct permissions) to run the service to avoid folder or file access problems.
  

• 4. Starting, operating and stopping the service

  Starting The Service

  Start the service called ScanToPDFService using the service control manager in Windows.
  
  When the service is running the desktop application does not need to run and should not be run
  

  Stopping The Service

  Stop the service called ScanToPDFService using the service control manager in Windows.
  
  

• 5. Monitoring The Service

  When running, the service writes simple status messages into the file ScanToPDFDispLog.txt in the folder C:\ProgramData\ScanToPDF_5\Logs (or the ScanToPDF application folder in earlier releases of version 5)
  
  Example lines below
  
  05 Jul 2016 10:22:21 - ProcessServiceCommand: QueueCommand("scan")
  05 Jul 2016 10:22:22 - 1 page(s) captured
  05 Jul 2016 10:22:22 - Start of save
  05 Jul 2016 10:22:22 - 'c:\Scanner\10186SDiffusioniCarlo\10186S_010-2016.pdf' saved
  

   

  To capture a service debug log please visit this page and follow the instructions in the article Capture A Service Debug Log provided.
  

• 6. Solutions that use the service

  PDF DataNet Barcode Service
  PDF DataNet Barcode Service Pro
  PDF DataNet OCR Service
  
  Existing customers can add the run as service feature key at any time to convert the system to run as service.

• 7. Advanced

   

  The service can process files in multiple input folders. It is possible to control the behavior using a script saved in the ScanToPDF application folder. This provides flexibility over which document profiles are processed and in which order.
  
  The script is a text file called ScanToPDFService.scp

  Example Script Commands

  Example 1

  ProcessAllDocumentProfiles()

  This would instruct the service to process each configured document profile in sequence

  Example 2

  DocumentProfileName='Accounts'
  QueueCommand("scan")

  This would instruct the service to process only the Accounts document profile

  Example 3

  DocumentProfileName='Accounts'
  QueueCommand("scan")
  Thread.Sleep(5000)
  DocumentProfileName='Sales'
  QueueCommand("scan")

  This would instruct the service to process the Accounts document profile, sleep for 5 seconds and then process the Sales document profiles in turn. It will then repeat the process