SYSPRO Workflow Services > SYSPRO Workflow Diagnostics

SYSPRO Workflow Diagnostics

SYSPRO Workflow Diagnostics is a utility that mimics the functionality of the workflow host service, displaying detailed output logging from the service which can be used to identify and resolve problems.

Service configuration file

Field Description
SWS Configuration file  
Use the configuration file for the SYSPRO Workflow Service currently installed in the machine Use the configuration file that is currently being used by the workflow service.
Select a custom configuration file for diagnostics Use a custom configuration file instead of the default configuration file.
Browse Browse for the custom configuration file.
SWS Templates folder  
Use the templates folder from the SYSPRO Workflow Service currently installed on the machine Save log files to the template folder used by the workflow service.
Select a custom templates folder for diagnostics Indicate your own template folder in which you want to save the log.
Browse Browse for the custom template folder.

SYSPRO SWS Diagnostics

Field Description
Start Diagnostics Create a log of all the service calls.
Stop Diagnostics Stop the log build.
Normal Mode Start diagnostics normally.
Safe Mode Start diagnostics with limited functionality. This is typically used to prevent workflows with errors from starting up.
View service calls log View all the calls made to the service.
Clear service calls log Clear the log details from the log file.
Export diagnostic results Export the diagnostics results log. The configuration file, events log and calls log are exported to the specified location.

Viewing the SYSPRO Workflow Services event log

  • Ensure that you have stopped the SYSPRO Workflow Service.

  1. Open the SYSPRO Workflow Diagnostics program SYSPRO menuWorkflow ServicesSYSPRO Workflow Diagnostics.

  2. Select the service configuration file that you want to use for diagnostic purposes.

  3. Select the Start Diagnostics icon.

  4. Review the messages log.

Viewing the SYSPRO Workflow Services calls log

  • Ensure that you have stopped the SYSPRO Workflow Service

  1. Open the SYSPRO Workflow Diagnostics program SYSPRO menuWorkflow ServicesSYSPRO Workflow Diagnostics.

  2. Select the service configuration file that you want to use for diagnostic purposes.

  3. Select the Start Diagnostics icon.

  4. Select the View service calls log icon from the toolbar.

  5. Review the calls log.

Clearing out the SYSPRO Workflow Service calls log

  • Ensure that you have stopped the SYSPRO Workflow Service.

You would typically use this procedure to clear out the log of all the calls made to the SYSPRO Workflow Service, preventing the log file from becoming excessively large and unmanageable.

  1. Open the SYSPRO Workflow Diagnostics program SYSPRO menuWorkflow ServicesSYSPRO Workflow Diagnostics.

  2. Select the service configuration file that you want to use for diagnostics purposes.

  3. Select the Start Diagnostics icon.

  4. Select the Clear service calls log icon from the toolbar.

Exporting the SYSPRO Workflow Services diagnostic logs

  • Ensure that you have stopped the SYSPRO Workflow Service

  1. Open the SYSPRO Workflow Diagnostics program SYSPRO menuWorkflow ServicesSYSPRO Workflow Diagnostics.

  2. Select the service configuration file that you want to use for diagnostics purposes.

  3. Select the Start Diagnostics icon.

  4. Select the Export diagnostic results icon from the toolbar.

  5. Indicate the destination folder to which you want to export the diagnostics results.

  6. Export the diagnostic results.

    The SWSDiagnosticCallsLog.txt, SWSDiagnosticsConfig.xml and SWSDiagnosticsEventsLog.xml files are saved to the destination folder.