Skip to main content
Kofax

Log E-signature core module information via SPDEBUG

Summary

13269

Description

To gain further log output from the underlying E-signature core modules you can enable additional log output.

Steps to enable the E-signature core module logging via Command Line (here with SignDoc Desktop):

  1. Close SignDoc Desktop
  2. Open up commandline (in Windows Start Menu -> Run -> CMD)
  3. Set variable spdebug permanently for the logged on user to 5 by entering: "setx spdebug 5"
  4. Alternatively to set it system wide for all users: "setx /M spdebug 5" (requires a command line with Administrative rights)
  5. Set variable spdebugdir to a folder (has to exist) to which you have written permission: "setx spdebugdir c:\temp"
  6. Set variable splm2debug to 3: "setx splm2debug 3"
  7. Run SignDoc Desktop application
  8. Reproduce the steps in which the error occurs
  9. Close the application
  10. Send the log file (logfile.log) in the folder set above to Technical Support
  11. Do not forget to remove the environment variables after the issue has been resolved -> From the command line type: setx spdebug "" (repeat this step for the other two variables)

Steps to enable the E-signature core module logging via Command Line for a one time log file (here with SignDoc Desktop):

  1. Close SignDoc Desktop
  2. Open up commandline (in Windows Start Menu -> Run -> CMD)
  3. Set variable spdebug to 5 by entering: "set spdebug=5"
  4. Set variable spdebugdir to a folder (has to exist) to which you have written permission: "set spdebugdir=c:\temp"
  5. Set variable splm2debug to 3: "set splm2debug=3"
  6. Run SignDoc Desktop application from the commandline: C:\Program Files (x86)\Kofax\SignDocDesktop\SignDoc32.exe (or C:\Program Files (x86)\SOFTPRO\SignDoc\SignDoc32.exe)
  7. Reproduce the steps in which the error occurs
  8. Close the application
  9. Send the log file (logfile.log) in the folder set above to Technical Support

Steps to enable the E-signature core module logging via Windows User Interface (here with SignDoc for Adobe Reader):

  1. Close Adobe Reader
  2. Open up System Information panel
    • Windows 7: Windows Icon -> Right-click on Computer -> Properties
    • Windows 8 / 10: <Ctrl> + X -> System
  3. Advanced system settings (left hand side) -> Environment Variables... (button at bottom)
  4. In System variables section select New...
    Screen Shot 2018-07-19 at 1.00.55 PM.png
  5. Enter SPDEBUG variable and press OK
    • Variable name: SPDEBUG
    • Variable value: 5
      Screen Shot 2018-07-19 at 1.04.00 PM.png
  6. Enter a second variable by pressing New... again
  7. Enter SPDEBUGDIR variable and press OK
    • Variable name: SPDEBUGDIR
    • Variable value: c:\temp (folder has to exist and user has to be able to write to folder)
      Screen Shot 2018-07-19 at 1.12.44 PM.png
  8. Enter a third variable by pressing New... again
  9. Enter SPLM2DEBUG variable and press OK
    • Variable name: SPLM2DEBUG
    • Variable value: 3
      Screen Shot 2018-07-19 at 1.16.52 PM.png
  10. Run Adobe Reader and reproduce the steps in which the error occurs
  11. Close the application
  12. Send the log file (logfile.log) in the folder set above to Technical Support
  13. Do not forget to remove the environment variables after the issue has been resolved

Steps to enable the E-signature core module logging in a Linux environment (here with SignDoc Web):

  1. Stop SignDoc Web server e.g. "service tomcat stop"
  2. Open up the web application servers definition file e.g. /etc/default/tomcat
  3. Append the following lines to it (N.B.: the SPDEBUGDIR folder needs to exist and the user needs to have write permission to it):
    SPDEBUG=5
    SPDEBUGDIR=/tmp
    SPLM2DEBUG=3
  4. Start SignDoc Web server e.g. "service tomcat start"
  5. Reproduce the steps in which the error occurs
  6. Send the log file (logfile.log) in the folder set above to Technical Support
  7. Do not forget to remove the environment variables after the issue has been resolved

SPDEBUG Log Levels:

0: NO LOGGING
1: FATAL
2: ERROR
3: WARNING
4: DIAGNOSTIC
5: DEBUG
5T: DEBUG including reference to thread number

Applies to

  • All Kofax E-signature products

Keywords: SPDEBUG, Core, debug, logging, log, SDK, SignDoc