IBM Support

Collect troubleshooting data for IBM Business Automation Workflow Process Portal

Troubleshooting


Problem

This document describes the general information and diagnostic data needed to start troubleshooting issues related to IBM Business Automation Workflow Process Portal. Include the diagnostics retrieved from using this document when you open a case for problems related to Process Portal in IBM Business Automation Workflow.

Resolving The Problem


Overview of Process Portal diagnostic information

General diagnostic information
  • Business Impact
  • Problem description
  • Environment description
  • Configuration data
  • Server logs
  • Browser network trace data
  • Browser console logs
As needed diagnostic information
  • Component-specific data
  • JavaScript debugging browser trace data



Detailed diagnostic collection steps

These instructions are the detailed steps to gather different types of data for Process Portal.

1: Business Impact:
  • Does the problem occur in a development, test, or production environment?
  • Are any deadlines or go-live dates impacted by this issue? If yes, then provide details of the deadline or go-live.
  • Are any business-critical operations blocked by this issue?
2: Problem Description:
  • What symptoms do you see?
  • What component or application is involved?
  • Do you see any error messages?
  • What is the time stamp when the problem occurs?
  • Did the current scenario work previously? If yes, what was changed?
  • Is this issue reproducible at will? How often does this problem occur? Do you see any indicators on why this problem happens?
  • Provide screen captures or a recording that shows the problem.
  • If problem is browser-specific, then provide the name and version of the browser.

3: Environment Description:
  • IBM Business Automation Workflow product version
    • Run the versionInfo command from the bin directory of your IBM Business Automation Workflow product installation and redirect the output to a file.
      versionInfo -fixpacks -ifixes
  • Operating system and version
  • Database vendor and version
  • Environment type (Development, Test, Production)
  • Information about other involved software
  • If you are running in a cluster, describe the topology that you have in place. If you have a topology diagram, provide it including host names, ports, and so on.

4: Configuration data
Provide the following configuration files:
  • Send in the TeamWorksConfiguration.running.xml file from each application server:
    profile_root/config/cells/CELL_NAME/nodes/NODE_NAME/servers/SERVER_NAME/process-center/TeamWorksConfiguration.running.xml
  • The complete config directory
    install_​​root/​​profiles/profile​​_​​name/config
5: Server logs
Provide the following complete log directories:
install​​_​​root/​​profiles/profile​​_​​name​​/​​logs​​/server​​_​​name
install_​​root/​​profiles/profile​​_​​name/​logs​​/ffdc

6: Browser network trace data
Option #1: Use your browser developer tools to capture a network trace HAR file
  1. Open your browser and the browser developer tools (usually with the F12 key)
  2. Select the Network tab
  3. Log in to Process Portal
  4. Reproduce the issue
  5. Right-click the data in the network tab and select the option to export or save the content as a HAR file
Option #2: Use the Fiddler tool to capture a network trace SAZ file
7: Browser console logs
Capture the browser console logs from your browser developer tools.
  1. Open the browser and the browser developer tools (usually with the F12 key)
  2. Select the console tab
  3. Log in to Process Portal
  4. Reproduce the problem
  5. Right-click the console log data and export the data as a LOG or TXT file

Manually collect component-specific MustGather data

If your problem falls into one of the following categories, collect the following information in addition to the preceding general information. If the problem is reproducible, set the appropriate trace string before the problem is reproduced.
  • General Portal issues:
    • For Version 8.x and later releases, gather the following trace information:
      *=info: WLE.*=all: com.ibm.bpm.*=all
    • Client-side trace that captures network traffic and cookies by using the browser developer tools or Fiddler.
  • Process Portal performance issues:
    • For Version 8.x and later releases, gather the following trace information:
      *=info: WLE.*=all: com.ibm.bpm.*=all: WAS.clientinfopluslogging=all
    • Client-side trace that captures network traffic and cookies by using the browser developer tools or Fiddler.
  • Process Portal security or login issues:
    • For Version 8.x and later releases, gather the following trace information:
      *=info: WLE.*=all: com.ibm.bpm.*=all: WLE.wle_security=finest: com.ibm.ws.security.*=all
  • Process Portal dashboard issues:  
    • For Version 8.x and later releases, gather the following trace information:
      *=info: WLE.*=all: com.ibm.bpm.*=all: WAS.clientinfopluslogging=all
    • Client-side trace that captures network traffic and cookies by using the browser developer tools or Fiddler.
  • Process Portal social capability issues:
    • Gather the following trace information:
      *=info: WLE.*=all: com.ibm.bpm.socialbus.*=all
  • Process Portal issues with notifications and task updates
  • Gather the following trace information:
    *=info: WLE.*=all: com.ibm.bpm.server.webmessaging.*=all
  • Client-side trace that captures network traffic and cookies by using the browser developer tools or Fiddler.
  • Process Portal issues with saved search
    • Gather the following trace information:
      *=info: WLE.wle=all: WLE.wle_portal=all: WAS.clientinfopluslogging=all: com.ibm.bpm.rest.*=all
      • Screen capture of saved search results from Process Portal.
      • Export of the LSW_SAVED_SEARCHES table from the BPM database in Excel sheet format.
      • Client-side trace that captures network traffic and cookies by using the browser developer tools or Fiddler.
  • Portal Process quick search (index) issues
    • Screen capture of the search conditions from Process Portal.
    • Gather the following trace information:
      *=info: WLE.wle=all: com.ibm.bpm.search.*=all
    • Client-side trace that captures network traffic and cookies by using the browser developer tools or Fiddler.
    • Provide these queries results
      select count(1) from BPM_TASK_INDEX;
      select count(1) from BPM_TASK_INDEX where DELETED_DATETIME is not null;
      select count(1) from BPM_INSTANCE_INDEX;
      select count(1) from BPM_INSTANCE_INDEX where DELETED_DATETIME is not null;
    • Provide information about your cleanup maintenance policies for deleting completed process instances and closed tasks.
  • Process Portal customization issues:
    • Provide the name and version of the web-based Distributed Authoring and Versioning (WebDAV) client.
    • Gather the following trace information:
      *=info: com.ibm.mm.*=all

    • For Version 8.5.x and later releases, you might see the following warning message after you set the trace string in the WebSphere Application Server administrative console. You can ignore this warning message:
Capturing client (browser) side JavaScript debugging browser trace data:

In some cases, where the problem is on the client (browser) side, it becomes important to look at client-side traces to debug JavaScript problems. In such cases, follow this procedure:
  1. In WebSphere Admin Console, click Resources > Resource Environment > Resource Environment Provider.
  2. On the Resource environment providers page, click Mashups_ConfigService.
  3. Under Additional Properties, click Custom properties.
  4. The list of custom properties opens. Click isDebug, change the Value field to true, and then click OK.
  5. Save your changes to the master configuration.
  6. Restart the application server instance.
  7. A debugging console is displayed on page the next time you log in to Process Portal. If it does not open, open up developer tools in browser, and go to console tab.
  8. Re-create problem, select all from debugging console or console tab, copy and paste to a text file & send it to us.
 

 

 

Related information

See the Software Support Handbook for guidelines and references about IBM Support.

Visit the IBM Business Automation Workflow product documentation

[{"Line of Business":{"code":"LOB45","label":"Automation"},"Business Unit":{"code":"BU059","label":"IBM Software w\/o TPS"},"Product":{"code":"SS8JB4","label":"IBM Business Automation Workflow"},"ARM Category":[{"code":"a8m50000000CcWNAA0","label":"Process Portal"}],"Platform":[{"code":"PF025","label":"Platform Independent"}],"Version":"All Versions","Type":"MASTER"}]

Document Information

Modified date:
11 May 2023

UID

swg21656267