Enabling Debug Logging in Windchill Workgroup Manager Client
When troubleshooting Windchill interaction issues, it can be advantageous to have additional debug logging enabled on the Windchill Workgroup Manager client. You can enable additional debug logging (e.g., in the uwgm.log, creation of an applog.log, bsc.log, etc.) by setting the client environment in Windows by navigating to > > > > > >
|
Enabling debug logging may degrade system performance.
|
Enable debug logging in the uwgm.log
Applies to Wildfire, Wildfire 2.0, Wildfire 3.0
Set the following environment:
UWGM_LOG_ACTIONS=t
UWGM_LOG_TASK_QUEUES=true
UWGM_LOG_DOWNLOAD=true
UWGM_PERSIST_LOG_DEBUG=yes
|
The UWGM_LOG_ACTIONS environment can in some cases cause Creo Parametric to exit prematurely. Do not set this environment if you are troubleshooting premature exits.
|
Enable creation of the uwgm.log and/or applog.log
Applies to Wildfire 4.0+, Arbortext Editor, Windchill Workgroup Manager
For normal debugging, create a logging.cfg.debug text file with the following environment:
verbose_level DEBUG
enable CIPSOAP DEBUG
enable UWGMCLNT_PDM_ACTIONS DEBUG
enable UWGMCLNT_CAD_ACTIONS DEBUG
enable PROWT_PDM_ACTIONS DEBUG
enable UWGM_COMM DEBUG
enable Communication DEBUG
enable ContentPlugin DEBUG
enable CurrentLogger DISABLED
enable DBObjectIBA DEBUG
enable Download DEBUG
enable HTTPDownload DEBUG
enable LocalCache DEBUG
enable Merge DISABLED
enable PartIBA DEBUG
enable Persistance DEBUG
enable Profile DEBUG
enable RefTable DISABLED
enable ServerCache DEBUG
enable ServerDownload DEBUG
enable IndexLogging DEBUG
enable ServerProfile DEBUG
enable ThreadQueue DEBUG
enable ToDo DISABLED
enable Upload DEBUG
enable WorkspaceCache DEBUG
enable Ipc DISABLED
enable WfImport DEBUG
enable DetailActionInfo DEBUG
enable Wildfire DEBUG
enable UWGMLIB_CONTENT_MANAGER DEBUG
enable UWGMLIB_PREFERENCES DEBUG
enable UWGMCLNT_PREFERENCES DEBUG
enable UWGM_CADADAPTER_TRL DEBUG
enable WWGM_ADAPTER_LOGGING DEBUG
enable WWGM_PREFERENCES DEBUG
enable PROWT_JSCB_LOG_AREA DEBUG
enable UWGM_ADAPTER DEBUG
enable WindchillRTA DEBUG
enable UWGMLIB_VFS DEBUG
enable UWGMCLNT_VFS DEBUG
enable UWGMLOCK DEBUG
enable WWGM_CLIENT_VERSION DEBUG
enable PROE_PROWT DEBUG
enable HTTP_INIT_AREA DEBUG
enable PROWT_PROP_AREA DEBUG
enable ConfigAssembly DEBUG
use_local_time yes
Set the following environment:
PTC_LOG_ACTIVATE=t
PTC_LOG_CONFIG=c:\logging.cfg.debug
Move the logging.cfg.debug file to the PTC_LOG_CONFIG environment location.
Note: If troubleshooting performance-related issues, use the following in logging.cfg.debug instead :
verbose_level INFO
enable CIPSOAP INFO
enable UWGMCLNT_PDM_ACTIONS ERROR
enable UWGMCLNT_CAD_ACTIONS ERROR
enable PROWT_PDM_ACTIONS ERROR
enable UWGM_COMM ERROR
enable Communication ERROR
enable ContentPlugin ERROR
enable CurrentLogger DISABLED
enable DBObjectIBA ERROR
enable Download ERROR
enable HTTPDownload ERROR
enable LocalCache ERROR
enable Merge ERROR
enable PartIBA ERROR
enable Persistance ERROR
enable Profile ERROR
enable RefTable ERROR
enable ServerCache ERROR
enable ServerDownload ERROR
enable ServerProfile ERROR
enable ThreadQueue ERROR
enable ToDo DISABLED
enable Upload ERROR
enable WorkspaceCache ERROR
enable UWGMLIB_CONTENT_MANAGER ERROR
enable UWGMLIB_PREFERENCES DISABLED
enable UWGMCLNT_PREFERENCES ERROR
enable UWGM_CADADAPTER_TRL ERROR
enable PROWT_JSCB_LOG_AREA ERROR
enable UWGM_ADAPTER INFO
enable WindchillRTA ERROR
enable ConfigAssembly ERROR
use_local_time yes
|
Full debug logging in logging.cfg.debug is preferred.
|
|
Beginning with Wildfire 4.0 M060, an applog.log and <start-in>\Log_<authoring_app>_<version>_<pid>_<date>_<time>_<session>\uwgm.log will be created in the start-in directory. The location of these files and directories can be controlled by adding a "log_dir_path <desired_path>" entry to logging.cfg.debug; for example:log_dir_path c:\temp.
|
Enable creation of the bsc.log
Applies to Wildfire - Wildfire 4.0 and Windchill Workgroup Manager 9.1 and earlier
Set the following in the client environment:
BSC_LOG_FILE_NAME=bsc.log
Enable creation of an applog.log.# with BSC information
Applies to Wildfire 5.0 with configuration option windows_browser_type=ie_in_process, or ie_in_sep_process; or with Windchill Workgroup Manager 10.0 and later
Set the following in the client environment:
BSC_LOG_ACTIVATE=t
Enable creation of request/response*.xml
When using all Wildfire releases, Arbortext Editor, Windchill Workgroup Manager
Set the following in the client environment:
UWGM_PRINT_XML_FILES=yes
|
Beginning with Wildfire 4.0 M060, these files will be placed in <start-in>\Log_<authoring_app>_<version>_<pid>_<date>_<time>_<session> when PTC_LOG_ACTIVATE=t is also enabled.
|
Enable creation of Adapter logs
When using Windchill Workgroup Manager
Set the following in the client environment:
VC_LOG_DIR=<path>
Redirect std.out, std.err to uwgm_client.out
When using Windchill Workgroup Manager
Set the following in the client environment:
PTC_WGM_STDFILES=t
Enable Java Script Bridge logging
When using all Wildfire releases and Windchill Workgroup Manager
Set the following in the client environment:
PTC_JS_COMMAND_LOG=t
For 10.0 ECAD Windchill Workgroup Manager Adapter logging
Add the following to the logging.cfg.debug file:
Regular Testing:
enable ECAD_ADAPTER_AREA TRACE
enable ECAD_HOOKABLE_AREA TRACE
enable ECAD_BOM_AREA TRACE
enable ECAD_CL_AD_SHARED_AREA TRACE
enable ECAD_JSCB_AREA TRACE
enable ECAD_CLIENT_AREA TRACE
enable ECAD_APP_AREA TRACE
Performance Testing:
enable ECAD_ADAPTER_AREA ERROR
enable ECAD_HOOKABLE_AREA ERROR
enable ECAD_BOM_AREA ERROR
enable ECAD_SHARED_AREA ERROR
enable ECAD_JSCB_AREA ERROR
enable ECAD_CLIENT_AREA ERROR
enable ECAD_APP_AREA ERROR
File location notes
In Wildfire - Wildfire 3.0 releases, the uwgm.log will be generated in the application startup directory.
In Wildfire 4.0 F000-M050 releases, the applog.log will be generated in the application startup directory.
In Wildfire 4.0 M070 and subsequent, and Windchill Workgroup Manager 9.1 M010 and subsequent, the applog will be generated in the application startup directory and the uwgm.log and other client logs are automatically created in a unique directory in the Start In directory. This change is to support cache sharing between multiple sessions of the CAD application