Technote (troubleshooting)
Problem(Abstract)
You are having a problem with the IBM Business Process Manager products that show up in IBM Process Designer. You would like to know what documentation you must collect (MustGather) so that the IBM Business Process Manager Support team can diagnose your problem. If you gather this documentation before contacting support it will expedite the troubleshooting process, and save you time.
Diagnosing the problem
Collect the troubleshooting information for IBM Process Designer in IBM Business Process Manager. Gathering this information before calling IBM support helps in understanding the problem and saves time when analyzing the data.
Application design questions are beyond the scope of the Support team. For those questions, we recommend the following options:
- Post your question to the IBM developerWorks IBM Business Process Manager forum
- Search the IBM BPM community wiki
- Get help from Professional Services (or our On Demand Consulting (ODC) - team). If you need assistance engaging ODC or Professional Services, contact your IBM account team.
If you run into specific error messages or problems when you are using IBM Process Designer that are not related to your business process definition (BPD) model, collect the general diagnostic information as well as:
- Screen shots of the problem or error message
- An explanation of what does not work and what is expected from the application or process
- The ae.log file from the IBM Process Designer installation directory.
Note: The following process only works in IBM Business Process Manager versions prior to 8.0.1 as the log4j.xml file was removed in the Version 8.0.1 release. As a workaround, you can copy the log4j.xml file from a previous version to your Version 8.0.1 environment.
- Close IBM Process Designer.
- Navigate to the <ProcessDesignerInstallationDirectory>\teamworks\eclipse\plugins\teamworks.appserver.websphere_<version>.jar file.
- Unpack that file to the <ProcessDesignerInstallationDirectory>\teamworks\eclipse\plugins\teamworks.appserver.websphere_<version> directory.
- In that subdirectory, navigate to the resources\log4j.xml file.
- Edit the file by changing the level value for the "com.lombardisoftware" logger from error to debug.
- Restart IBM Process Designer, recreate the problem, and note down the time stamp. The ae.log file should now contain the debug and error messages from the Process Designer.
The log4j.xml file should be changed from:
<logger name="com.lombardisoftware" additivity="false">
<level value="error" />
<appender-ref ref="TWConsoleAppender" />
<appender-ref ref="TWFileAppender" />
</logger>
to:
<logger name="com.lombardisoftware" additivity="false">
<level value="debug" />
<appender-ref ref="TWConsoleAppender" />
<appender-ref ref="TWFileAppender" />
</logger>
Note: Log4j is not supported as a primary mechanism for logging product error messages in IBM Business Process Manager. Instead, Java™ logging is used. However, you can use the previous procedure to enable additional logging for the IBM Process Designer part of IBM Business Process Manager. Also refer to this BPM Community Wiki to get more details on log4j.
| General diagnostic information |
Collect the general troubleshooting information as described in Collect troubleshooting data for the IBM Business Process Manager products document.
| What to do next |
- Review the log files and traces at the time of the problem to try to determine the source of the problem.
- Use IBM Support Assistant to search for known problems in the information center, forums, and technotes.
- If you cannot find related problems or cannot solve the problem, send the information you have collected to IBM by following the instructions in Exchanging Information with IBM Technical Support.
Related information
BPM infocenter - Debugging with the Inspector
A simplified Chinese translation is available
| Segment | Product | Component | Platform | Version | Edition |
|---|---|---|---|---|---|
| Business Integration | IBM Business Process Manager Express | Process Designer | Linux, Windows | 8.0.1, 8.0, 7.5.1, 7.5 | |
| Business Integration | IBM Business Process Manager Standard | Process Designer | AIX, Linux, Solaris, Windows | 8.0.1, 8.0, 7.5.1, 7.5 | |
| Business Integration | IBM BPM Advanced Pattern on Red Hat Enterprise Linux Server | Process Designer | Linux Red Hat - xSeries | 8.0.1, 8.0 |
Rate this page:
Copyright and trademark information
IBM, the IBM logo and ibm.com are trademarks of International Business Machines Corp., registered in many jurisdictions worldwide. Other product and service names might be trademarks of IBM or other companies. A current list of IBM trademarks is available on the Web at "Copyright and trademark information" at www.ibm.com/legal/copytrade.shtml.