Enable Debug Logging - Integration - Update 44 - Help - Hexagon

SmartPlant Integration COM Help

Language
English
Product
Integration
Search by Category
Help
SmartPlant Foundation / SDx Version
10
Smart P&ID Version
9 (2019)
Smart Engineering Manager Version
10 (2019)

The SmartPlant Client Debug Utility dialog box enables or disables debug logging for the SmartPlant Integration components. For more information on logging functionality, see Debug and Error Logging in SmartPlant Integration for COM environments or Debug and Error Logging in SmartPlant Integration .NET for .NET environments.

For each SmartPlant Integration component, you can select debug options to control how much information is recorded to the log files. To set debug levels on all components, select Component check box. To set debug levels on individual components, select the component from the Component list. The debug levels control how much information is recorded to the log files. You can specify whether to record log files and events to the Error Log, Entry/Exit Log, and Comment Log files. You can also select or clear all options with the Components check box.

If you select an individual component and make changes to the debug level settings, the debug status is Debug On (Partial). If there are partial debug levels set, the check box is displayed with a square icon instead of a check mark.

The log file location is displayed in the Log Folder option. The format of the log file name is SPClient_yyyy_mm_dd_hhmmss. A specific log file folder is only displayed in this field if you open the SmartPlant Client Debug Utility from an error message window.

The lower-right corner displays whether or not debug logging is enabled, and to what level.

  • Debug Off - Debug logging is not enabled.

  • Debug On - Complete debug logging is enabled.

  • Debug On (Partial) - Limited debug logging is enabled. One or more of the components are disabled.

Enable through Start menu

  1. Click Start > All Programs > SmartPlant Foundation > SmartPlant Client > SmartPlant Debug Utility.

  2. Select a component from the Component drop-down menu. To make changes to all components, select All Components.

  3. Select debug level options from the Log Type section.

  4. Click Apply.

    SHARED Tip Select another component and make changes to the debug levels, and repeat as many times as necessary.

  5. Click Apply.

  6. Click OK.

    The SmartPlant Client Debug Utility dialog box displays the folder path that contains the debug logging files.

Enable through error message

  1. Click Debug Log on an error message dialog box.

  2. Follow steps 2-6 of the Enable through Start menu workflow.

    Debug logging begins immediately after you click OK.

See Also

Debug and Error Logging in SmartPlant Integration
SmartPlant Integration Error Messages