Help Center>Foundation Help

Applies to:

  • Winshuttle Foundation

Enabling and viewing Winshuttle Workflow logs

Back to

Winshuttle Workflow Central Administration Diagnostics contains operations for diagnosing problems that can occur on your server. There are two primary options:

  • Logging — allows you to turn on or off the different types and levels of logging on your server.
  • Log File Viewer — allows you see all or part of your current log file on your server.

On this page

Log file locations

Back to top
  • The default location for log files is C:\Program Files\ShareVis\logs
  • If the installation location is changed from the default, the log files will be placed in the <install folder>\ShareVis\logs

Within the Logs folder, separate log files are stored depending upon the type of logging you enable: 

  • Core – sharevis.log
  • SVService – sharevis_svservice.log
  • Timer – sharevis_timer.log
  • SVAdm – sharevis_svadm.log
  • Central Admin – sharevis_ca.log

How to enable Winshuttle Workflow logging

Back to top
  1. From the Winshuttle Workflow Central Administration Web site, in the Diagnostics section, click Logging.
  2. Specify the type of logging you want to use by selecting one or more of the following checkboxes:
    • Core — The most detailed logging level. Core logging logs the internal workings of the product that runs in the context of SharePoint. It also requires the most processing power and causes the largest performance degradation of your Winshuttle SharePoint environment.
    • SVService — logs errors related to SVService including email, auto approvals, and email approvals.
    • Timer — logs timer marks within the core product, which can be useful if there are performance problems.
    • SVAdm — SVAdm logging logs the running of Workflow Admin command line tools.
    • Central Admin — Central Admin logging logs the running of Workflow Central Administration Site

    Note: Events for each logging type are saved in a separate file.

  3. Specify the level of logging by selecting one of the following options:
    • Debug — The most detailed logging level. This includes variable data, so string composition is done extensively, which can trigger more frequent garbage collections, etc. Errors, Warnings, and Informational messages are also included in this level.
    • Info — General tracing messages throughout the code. No string composition is done at this level, so no variable data is written at this level. Errors and Warnings are also included in this level.
    • Warn — This level is used whenever something is detected that is wrong, but not necessarily fatal. Errors are also included in this level.
    • Error — Typically logged whenever a serious exception is thrown. This level of logging affects performance the least.

    The impact of logging on performance corresponds to the amount of data written to the log file and how the strings are composed. In most circumstances, using Error or Warn level logging will have no noticeable impact on performance because under normal circumstances very little would be written to the log at these levels. The Info and Debug levels of logging will have a greater impact on performance.

  4. To delete existing log files before starting the new log, select the Delete Logs check box.
  5. To include a stack trace at each logging statement, select the Stack Trace check box.

    Note: To increase system performance by writing the log in a separate thread of execution, select the Asynchronous Logging check box.

  6. Click Save Changes.

Using the Winshuttle Workflow log file viewer

Back to top
  1. From the Winshuttle Workflow Central Administration Web site, click Log File Viewer in the Diagnostics section to open the Log File Viewer page:

  2. From the Select Log list, select the type of logging you want to view. Events for each logging type are saved in a separate file.
  3. To view only events of a particular level, select a logging level from the Filter list.
  4. To display all events, click None from the Filter list. In the log file, Errors display in red, and Warnings display in yellow.
  5. If you specified a logging level using the Filter list, you can specify whether to include additional lines in the log file both before and after the event. To do so, select a number of lines from the Context list.
  6. To indicate how much of the log file you want to view, make a selection from the Display list.
  7. Select a size for the log file; this will display the most recent portion of the log file, up to the file size you have specified. To display the entire log file, select All.
  8. Click the Retrieve button to display the log file based on your selections.