Debug Logging can be enabled using SmartPlant Client Debug Utility. When enabled, the debug files are saved to a specific folder in the %temp% folder. The folder location and folder name format is displayed at the bottom of the SmartPlant Client Debug Utility window. The folder name format is SPClient_yyyy_mm_dd_hhmmss. Each folder contains separate debug log files for modules that have debug logging on. Debug files have .dbg extension. The folder also contains error files that get created for modules with error logging on. The error files have a .txt extension.
Error and Debug Logging
Error logging can be turned on by selecting the check boxes for modules for which error logging is required. Error logging can be turned ON or OFF for each individual module depending on whether the corresponding check box for that module is selected or cleared.
Debug logging can be turned on in 2 stages:
-
Entry/Exit logging can be turned on for individual modules by selecting the check boxes for respective modules. To turn on entry/exit logging for all the modules, select the check box at the column header
-
If entry/exit logging is turned on, then error logging is turned on.
-
Event error logging can be turned on for individual modules by selecting the check boxes for respective modules. The errors, if any, are written to the Microsoft Event Viewer when event error logging is turned on.
-
Event error logging is turned on by default.
-
-
Comments logging can turned on for individual modules by selecting the check boxes for respective modules. To turn on comment logging for all modules, select the check box in column header.
If comment logging is turned on, then entry/exit and error logging are turned ON.
Error Messages
There can be instances for an error to be displayed in error dialog boxes. For more information, see SmartPlant Integration Error Messages.
The log settings for an error is stored in SmartPlantClientTrace.xml in the Temp folder. If the file does not exist, it is created when SmartPlant Client Test Tool is opened for the first time or when SmartPlant Client Debug Utility is started for the first time.
Status Bar Information
All SmartPlant CommonUI windows contain a status bar in the footer section. The status bar has the following four sections:
-
First section from left displays site information. This information is displayed as Server/Site: Plant_connected_to.
-
Second section displays the Integrator information. If you have has installed the SmartPlant Basic Integrator version, then status bar displays "SmartPlant Basic Integrator".
-
Third section displays file mode. If your session has file mode turned on, then this section displays File Mode.
-
Fourth section displays debug mode. The different debug modes are as follow:
-
Debug Off when debug is OFF.
-
Debug On (Partial) when partial logging is turned on.
-
Debug On when error, entry/exit and comment logging is turned on for all the modules.
-