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):
- Close SignDoc Desktop
- Open up commandline (in Windows Start Menu -> Run -> CMD)
- Set variable spdebug permanently for the logged on user to 5 by entering: "setx spdebug 5"
- Alternatively to set it system wide for all users: "setx /M spdebug 5" (requires a command line with Administrative rights)
- Set variable spdebugdir to a folder (has to exist) to which you have written permission: "setx spdebugdir c:\temp"
- Set variable splm2debug to 3: "setx splm2debug 3"
- Run SignDoc Desktop application
- Reproduce the steps in which the error occurs
- Close the application
- Send the log file (logfile.log) in the folder set above to Technical Support
- 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):
- Close SignDoc Desktop
- Open up commandline (in Windows Start Menu -> Run -> CMD)
- Set variable spdebug to 5 by entering: "set spdebug=5"
- Set variable spdebugdir to a folder (has to exist) to which you have written permission: "set spdebugdir=c:\temp"
- Set variable splm2debug to 3: "set splm2debug=3"
- Run SignDoc Desktop application from the commandline: C:\Program Files (x86)\Kofax\SignDocDesktop\SignDoc32.exe (or C:\Program Files (x86)\SOFTPRO\SignDoc\SignDoc32.exe)
- Reproduce the steps in which the error occurs
- Close the application
- 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):
- Close Adobe Reader
- Open up System Information panel
- Windows 7: Windows Icon -> Right-click on Computer -> Properties
- Windows 8 / 10: <Ctrl> + X -> System
- Advanced system settings (left hand side) -> Environment Variables... (button at bottom)
- In System variables section select New...
- Enter SPDEBUG variable and press OK
- Variable name: SPDEBUG
- Variable value: 5
- Enter a second variable by pressing New... again
- 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)
- Enter a third variable by pressing New... again
- Enter SPLM2DEBUG variable and press OK
- Variable name: SPLM2DEBUG
- Variable value: 3
- Run Adobe Reader and reproduce the steps in which the error occurs
- Close the application
- Send the log file (logfile.log) in the folder set above to Technical Support
- 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):
- Stop SignDoc Web server e.g. "service tomcat stop"
- Open up the web application servers definition file e.g. /etc/default/tomcat
- 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 - Start SignDoc Web server e.g. "service tomcat start"
- Reproduce the steps in which the error occurs
- Send the log file (logfile.log) in the folder set above to Technical Support
- 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