Windchill ESI Logging
Message logs can be viewed from the Windchill ESI services components as well as from Windchill EAI components.
Windchill ESI services log various kinds of messages by using Windchill's log4j based logging capabilities.
To enable Windchill ESI services to write messages to the Windchill MethodServer logs, use the following procedure:
1. Navigate to and modify the following file:
<wt_home>/codebase/WEB-INF/log4jMethodServer.properties
2. To enable logging of debug messages for all classes of ESI services add the following entry:
logger.esi.name=com.ptc.windchill.esi
logger.esi.level=DEBUG
To enable logging for all types of messages for all classes of ESI services add the following entry file:
logger.esi.name=com.ptc.windchill.esi
logger.esi.level=ALL
Logs can also be enabled for specific packages or classes. For example, to enable logging for debug messages for all classes in the package com.ptc.windchill.esi.txn you would enter the following:
logger.txn.name=com.ptc.windchill.esi.txn
logger.txn.level=DEBUG
To enable logging of all types of messages (for example, Debug, Info, Warn, Trace) for the class com.ptc.windchill.esi.svc.StandardESIService you would enter the following:
logger.StandardESIService.name=com.ptc.windchill.esi.svc.StandardESIService
logger.StandardESIService.level=ALL
|
To turn off logging completely set the relevant property to OFF. For example, to do this for all classes in the package com.ptc.windchill.esi.txn, you would enter the following:
logger.txn.name=com.ptc.windchill.esi.txn logger.txn.level=OFF
|
To enable or disable logging in a running method server instance use the following procedure:
• From a Windchill shell run the following commands:
◦ To enable: windchill wt.util.jmx.SetLogLevel -ms com.ptc.windchill.esi DEBUG
◦ To disable: windchill wt.util.jmx.SetLogLevel -ms com.ptc.windchill.esi
Enabling Windchill ESI Middleware to Write Messages to Debug Logs
|
This section applies to SAP systems only.
|
Message logs can be viewed from the Windchill ESI middleware components.
The following log4j based loggers are available:
◦ com.ptc.esi.middleware
◦ com.ptc.esi.middleware.Part
◦ com.ptc.esi.middleware.BOM
◦ com.ptc.esi.middleware.ChangeNotice
◦ com.ptc.esi.middleware.Document
◦ com.ptc.esi.middleware.ProcessPlan
◦ com.ptc.esi.middleware.Tooling
◦ com.ptc.esi.middleware.ProcessMaterial
◦ com.ptc.esi.middleware.ControlCharacteristic
◦ com.ptc.esi.middleware.Option
◦ com.ptc.esi.middleware.OptionSet
◦ com.ptc.esi.middleware.Dependency
To enable Windchill ESI middleware to write messages to the logs, use the following procedure:
1. Navigate to and modify the following file:
<wt_home>/codebase/WEB-INF/log4jMethodServer.properties
2. From a Windchill shell run the following commands:
◦ To enable logs:
windchill wt.util.jmx.SetLogLevel -ms com.ptc.esi.middleware ALL
◦ To disable logs:
windchill wt.util.jmx.SetLogLevel -ms com.ptc.esi.middleware
3. Navigate to > and open the Preference Management utility.
4. Navigate to the Client Customization preference and set it to Yes.
5. Navigate to the newly created Customization tab, and select Tools. Then select log4j.
6. Select the Method Server option, enter the logger as com.ptc.esi.middleware and select DEBUG.