Skip to main content
Kofax

ShareScan: Capture raw image files for troubleshooting

Information:

This article gives information on how to capture the raw image files from ShareScan when troubleshooting issues, such as image quality issues.

Why capture raw image files?

The files with the JBG extension are the raw image files captured from the input source, such as scanner.  These files, when compared with the resulting eCopy image files, can help troubleshoot scan quality issues. 

Despite the JBG extension, the files may be JBIG, TIFF, JPEG or another format.

   

For a ScanStation using a twain or ISIS driver, the JBG files have already been modified by the eCopy software.  The JBG files from a ScanStation are not raw images from the device and may not be as useful in troubleshooting scan quality issues on ScanStation implementations.

To capture raw files in ShareScan 6.1, 5.4 and 5.2 :

  1. Open the ShareScan Administration Console
  2. In the Ribbon, select the "Home" tab > "Settings" button
  3. In the Settings select the elipsis button next to the "Advanced ShareScan settings"
  4. Find the below items in the list and set them to True
    • DoNotRemoveTempFolder (preserves the temporary folder and contents after the end of session)
    • DumpJBIGFiles (preserves the raw image files in the temporary folder until the temporary folder is removed) 
  5. Save the changes to the Advanced settings and ensure that the services have been restarted
  6. If troubleshooting image quality issues, perform a test scan and confirm that the final output document exhibits the issue, and save this file

  7. Browse to the ScannedFiles folder:
    • <c:\programdata\nuance\sharescan\scannedfiles>
    • (Server 2008)   <c:\users\all>
    • (XP, 2003) <c:\documents>
  8. Save the contents of the ScannedFiles and the final output document and provide for analysis.
  9. Set the settings changed in step 4 above to False to avoid the harddrive from filling up.

To capture raw files in ShareScan 5.1:

  1. Open the ShareScan Administration Console
  2. In the Ribbon, select the "Home" tab > "Settings" button
  3. In the Settings select the elipsis button next to the "Advanced ShareScan settings"
  4. Find the below items in the list and set them to True
    • DoNotRemoveTempFolder (preserves the temporary folder and contents after the end of session)
    • DumpJBIGFiles (preserves the raw image files in the temporary folder until the temporary folder is removed)
    • DumpJobFiles (Preserves the output XML for the scan job)
  5. Save the changes to the Advanced settings and ensure that the services have been restarted
  6. If troubleshooting image quality issues, perform a test scan and confirm that the final output document exhibits the issue, and save this file

  7. Browse to the ScannedFiles folder:
    • (Win7, 2012) C:\ProgramData\Nuance\ShareScan\ScannedFiles
    • (Server 2008)   C:\Users\All Users\Application Data\Nuance\ShareScan\ScannedFiles
    • (XP, 2003) C:\Documents and Settings\All Users\Application Data\Nuance\ShareScan\ScannedFiles
  8. Save the contents of the ScannedFiles and the final output document and provide for analysis.
  9. Set the settings changed in step 4 above to False to avoid the harddrive from filling up.

To capture JBG files in ShareScan 5.0:

  1. Open windows services and stop the ShareScan Manager and ShareScan Agent services

  2. Go to Start > Run and type regedit to open the Windows Registry Editor

  3. Browse to the below registry key 

    32 bit OS: HKEY_LOCAL_MACHINE\SOFTWARE\Nuance\ShareScan\ShareScanManager

    or

    64 bit OS: HKEY_LOCAL_MACHINE\SOFTWARE\Wow6432Node\Nuance\ShareScan\ShareScanManager

  4. Create or set the below registry keys
    • Key name: DumpJBIGFiles (string), value: true

    • Key name: DoNotRemoveTempFolder (string), value: true

    • Key name: DumpJobFiles (string), value: true

  5. In Windows Services, start the ShareScan Manager & Agent services
  6. Perform a test scan and confirm that the final output document exhibits the issue, save this file for review
  7. Browse to C:\Documents and Settings\ (XP, 2003) OR C:\Users\ (Win 7, 2008)   All Users\Application Data\Nuance\ShareScan\ScannedFiles
  8. Save the contents of the ScannedFiles and the final output document and provide for review.
  9. Set the registry keys above to false to prevent the harddrive from filling up.

To capture JBG files in ShareScan 4.x:

  1. STOP the "eCopy ShareScan OP Manager" service within Windows services.
  2. To capture, browse to the following: HKEY_LOCAL_MACHINE\SOFTWARE\eCopy\ShareScanOPManager
  3. Create a string value in the registry with this name "DumpJBIGfiles" that is set to 1.  (The string is not case sensitive)
  4. Restart the "eCopy ShareScan OP Manager" service.
  5. Scan a page from the feeder
  6. Collect the files located at: C:\Program Files\eCopy\ShareScan OP\ShareScanOPManager\Bin\ShareScanOPTemp\Device_Name
  7. Collect the final output file from the scan operation. This file will be in the format selected within the connector workflow (PDF, TIF, JPG, CPY) and will be located in the destination specified within the connector settings.
  8. After collecting the files, set the registry key created in step 3 back to 0 to prevent filling the harddrive

The files generated from the device and given to eCopy is frequently named as follows: 

Black and White devices-

  • eCpyIncomingXXXX_X.JBG    Raw image 

  • eCpyXXXX_X.tif                  Processed Image

  • eCpyXXXX_X.jpg                 Thumbnail Image

Color devices-

  • eCpyIncomingXXXX_X.JPG    Raw image from 
  • eCpyXXXX_X_Color.jpg          Processed Image
  • eCpyXXXX_X.jpg.                   Thumbnail Image