Collect troubleshooting data for IBM Process Designer problems in IBM Business Process Manager (BPM)

Technote (troubleshooting)


Problem(Abstract)

You are having a problem with the IBM Process Designer tool, which is part of the IBM Business Process Manager products. 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

Application design questions are beyond the scope of the support team. For those questions, we recommend the following options:

Overview of IBM Process Designer diagnostic information


Gather the following information and files:

General diagnostic information

  • Problem description
  • Environment description
  • Log files and configuration information:
    • ae.log file
    • orb* files
    • eclipse.ini file
    • /properties directory
    • /workspace directory
    • Process center profile /logs directory

As needed diagnostic information
  • Process Designer tracing
  • SSL tracing
  • Javacores™ and garbage collection (GC) logging for hangs, performance, and memory issues


Detailed steps to gather diagnostic information

  • Problem and environment description
    Provide a detailed description of the problem that you are having. Be detailed about the steps that lead up to the issue and include screen shots whenever possible.


    The description needs to answer the following questions:
    • Was there any changes prior to the issue occurring?
    • Is the issue intermittent or re-creatable? If the problem is intermittent, how often does it occur?
    • How does the issue impact your business?
    • Are there any deadlines that are affected by this problem?
    • Is the related Process Center clustered?
    • Are you connecting directly to a Process center or through a web server?

  • Log and configuration files
    Gather the following files from the Process Designer root directory for the affected client:
    • ae.log file
    • eclipse.ini file
    • /workspace directory
    • /properties directory
    • orb* files - Any files that start with "orb" under the Process Designer root directory that were modified during the time frame of the issue.

    Gather the Process Center /logs directory from the process center profile that Process Designer is connected to at the time of the issue. For example: <Profile root>/logs


    Note: If you are using custom paths for your server log or trace, then provide all of the files that normally exist in this directory. If possible, use the default logging paths.

  • Process Designer tracing
    Depending on your version use one of the following methods:
    • For IBM Business Process Manager V8.0.1.x and 8.5.x, see the Enabling error logging in Process Designer topic in the product documentation.
    • For IBM Business Process Manager V7.5.x and 8.0.0.x, complete the following steps:
      1. Locate the <ProcessDesignerInstallDirectory>\teamworks\eclipse\plugins\teamworks.appserver.websphere_<version>.jar file.
      2. Unpack that file to the <ProcessDesignerInstallationDirectory>\teamworks\eclipse\plugins\teamworks.appserver.websphere_<version> directory.
      3. Navigate to the resources\log4j.xml file to make the following changes.
        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>
      4. 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.

  • SSL tracing (for SSL/ORB connection issues)
    For Secure Sockets Layer (SSL) or ORB issues in the Process Designer, like SSLHandshakeExceptions, you can enable a specific trace, which helps to log more details about the problem. Follow these steps:
    • For SSL tracing, edit the eclipse.ini file by adding:
      -Djavax.net.debug=true
    • For ORB tracing, edit the eclipse.ini file by adding:
      -Dcom.ibm.CORBA.Debug=true -Dcom.ibm.CORBA.CommTrace=true -Dcom.ibm.CORBA.Debug.Output=client.log
      1. Restart the Process Designer using the following command to send the console output to a file:
      <ProcessDesignerDirectory>\eclipse.exe > logfile_name 2>&1
      Note: The logfile_name variable is the file name that will contain the SSL trace. You can only capture this information to a file when you use javaw. When you use java.exe to get javacores, the output goes to the console window.
      2. Recreate the issue.
      3. Provide the following files and directories from the Process Designer client:
      • SSL log file
      • client.log file
      • /etc directory
      • /resources directory
      4. Disable the trace when finished as it can affect performance of the client.

  • Javacores and garbage collection (GC) data for hang, performance, and memory issues
    For performance, hang, and JVM memory issues, Javacores, heap dumps and gc logging are needed. Complete the following steps to gather this information:
    1. Edit the eclipse.ini file and add the following lines:
      -verbose:gc
      -Xverbosegclog:
      <absolute path to the verbosegc.log file>


      Note: This path is the location of the gc log file that needs to be provided.
    2. Edit the eclipse.ini file and replace javaw.exe with java.exe.
    3. Restart the Process Designer and ensure you do not close the extra command window that is opened.
    4. Recreate the issue or wait for a reoccurrence.
    5. Generate a Javacore and heapdump by selecting the Process Designer command window to bring focus to the window and then hold down the <CTRL> + <BREAK> keys to generate the dump.


      Note: The verbose gc log file shows the location and time when dumps are generated.
    6. Gather 3-4 Javacores 30-60 seconds apart or evenly spaced out over the hang time frame during the hang or performance issue.
    7. Provide the following files from the IBM Process Designer client:
      • Verbose gc log file
      • Javacore files
      • Heap dump files if you are experiencing a JVM memory issue.
    The trace is pretty light weight but can be disabled by reversing steps 1 and 2.

What to do next

  1. Review the log files and traces at the time of the problem to try to determine the source of the problem.

  2. Use IBM Support Assistant to search for known problems in the information center, forums, and technotes.

  3. 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

Documentation - Debugging with the Inspector
A simplified Chinese translation is available

Cross reference information
Segment Product Component Platform Version Edition
Business Integration IBM Business Process Manager Express Process Designer Linux, Windows 8.5, 8.0.1, 8.0, 7.5.1, 7.5
Business Integration IBM Business Process Manager Standard Process Designer AIX, Linux, Solaris, Windows 8.5, 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
Business Integration IBM Business Process Manager Advanced Pattern on AIX Process Designer AIX 8.0.1

Product Alias/Synonym

BPM

Rate this page:

(0 users)Average rating

Document information


More support for:

IBM Business Process Manager Advanced
Process Designer

Software version:

7.5, 7.5.1, 8.0, 8.0.1, 8.5

Operating system(s):

AIX, Linux, Solaris, Windows

Reference #:

1611598

Modified date:

2014-04-10

Translate my page

Machine Translation

Content navigation