You are having a coach problem with IBM Business Process Manager. 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. Read through the entire document before following any procedures.
Diagnosing The Problem
Problem Description :
- Describe the steps to recreate the issue. The description of the issue must include the type of user interface and the type of scenario leading to the issue. Please refer to the following categories :
- A) User Interface :
- Heritage Human Service :
- Client Side Human Service
- Authoring :
- Execution :
- Provide information on the user interface as follow :
- Heritage Coaches :
- Coaches and Coach Views :
- Responsive Coaches :
- - Heritage coaches
- Coaches ( including Coach Views )
B) Scenario :
- - Eclipse-based Process Designer for Heritage Human Services
- Web-based Process Designer for Client Side Human Services
- Both types of Human Services run in a browser via :
- Process Designer play back
- Process Portal
- Exposed URL
- - Indicate whether you are using coach XSL and CSS from system data or they have been customized.
- System Toolkit version
- Specify the type of Sections or Controls included in the Heritage Coach
- - Version of Coaches Toolkit
- Please identify whether you are using a BPM provided stock control (coach view) or your own custom coach view.
- If you are using the BPM provided stock controls, please specify the control name. See the list of controls here : http://www.ibm.com/support/knowledgecenter/SSFPJS_8.5.7/com.ibm.wbpm.ref.doc/topics/rstockcontrols.html?cp=SSFPJS_8.5.7&lang=en
- - Version of the Responsive Coaches Toolkit
- Specify the type of control used in the responsive coach; refer to this URL for the complete list of controls :
- Provide browser related information :
- Name and version number. Indicate whether the problem is isolated to a specific browser or version.
- While recreating the issue, collect :
- Web console logs (via F12 developer tools)
- Fiddler trace collected on the browser when the issue occurs.
Note2 : Please collect the server related traces ( see below ) simultaneously.
- The following complete log directories:
- Provide a simplified test case, by exporting it as a process app in .twx format.
For other types of Coaches use the following trace string:
- Run the following command to obtain the IBM Business Process Manager version:
1. Web debugging trace needs to be collected on the browser when the issue occurs.
The suggested web debugging tool is Fiddler. You must download and install Fiddler.
Refer to: http://www.telerik.com/download/fiddler
2. Before capturing the Fiddler trace, turn the Process Portal and Coach debug option ON.
Then, follow the instructions below:
- Navigate to http://
- Resources > Resource Environment > Resource Environment Providers
- Click "Mashups_ConfigService" in table
- Click "Custom properties" in the Additional Properties section
- Click the "Show filter function" button
- Type "isDebug" in the Search terms field and click Go
- Click "isDebug" in the table
- Change the value from "false" to "true"
- Click Apply and then Save the configuration
- Restart the server
3. Clear the browser cache
4. The Fiddler trace must be captured with the decrypted HTTPS traffic option. Follow these steps to capture the trace while working with Fiddler:
- Go to Tools > Fiddler Options > HTTPS
- Check the following boxes:
- Capture HTTPS CONNECTs
- Decrypt HTTPS traffic
- Ignore server certificate errors
Note : An alternative to SAZ (Fiddler) network trace are:
- HAR captured through Chrome Developer tools (F12) network tab or exported from HTTP watch
- XML network traffic captured via IE (F12) developer tools network tab.
This video from the IBM SupportTV YouTube channel demonstrates how to collect the debugging trace:
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 product documentation, 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.
15 June 2018