IBM Support

Collect troubleshooting data for snapshot deployment and repository problems in IBM Business Automation Workflow (BAW)



You are having a snapshot deployment or other snapshot repository related problem with IBM Business Automation Workflow. You would like to know what documentation you must collect (MustGather) so that the IBM Business Automation Workflow 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

Overview of snapshot deployment and repository diagnostic information

Gather the following information and files:

General diagnostic information
  • Problem description
  • Environment description
  • Server log files - All of the files from the following directories:
    Workflow Server app member: <profile_root>/logs
    Workflow Center app member: <profile_root>/logs
  • TWX export of the related process application

As needed diagnostic information
  • Profile /config directory from the deployment manager
  • Snapshot related table exports
  • DB PO validation traces

Setting the trace string

The general trace string should be set on the involved App cluster members from the Workflow Center and or Workflow Server. Depending on the issue the other trace strings can be included with the general trace. The lightweight trace can be used for deployment, import and export if performance is a concern and only a high level trace is needed. Note, for offline deploy only the Workflow Server data is needed.
Trace string
General trace string *=info: WLE.*=all: WAS.clientinfopluslogging=all:*=all: ProcessApplicationLifecycle=all
Authorization issues Include:*=all
Connectivity issues Include:*=all:org.apache.commons.httpclient.*=all
Advanced content deployment issues See the Advanced Snapshot Deployment MustGather
Lightweight tracing WLE.wle_deploy=all:WLE.wle_expimp=all

For instructions on setting the trace, see Enabling trace on a running server. You may also need to increase the trace file size and number if the logs are rolling too fast. 20MB is a good starting point for the file size and you shouldn't increase it over 50MB.

Note: Enabling this trace might slow down your system. This delay can lead to transaction timeouts and errors. Disable this trace after capturing the problem to ensure the trace is not overwritten.

General diagnostic information

Collect the following diagnostic information:

1: Problem and environment description
  • Provide a detailed description of the problem that you are having. Try to be as detailed about the steps that lead up to the issue and include screen captures whenever possible. Include any error messages that you think are related. For example, include the answers to the following questions.
    • Is this a new environment?
    • Were there any changes before the issue occurring?
    • Is the issue intermittent or re-creatable? If intermittent, how often does it occur?
    • What type of environment is having the issue? (Test, QA, Production)
    • How does the issue impact your business?
    • Are there any deadlines that are affected by this issue that we should be aware of?
    Provide the output of this command:
    Profile_root/bin/versionInfo -maintenancePackages

2: App Cluster member Profile logs
The trace should be enabled on any involved application cluster members. For online deployment this should be both Workflow Center and Workflow Server. When providing the logs ensure the full logs directory including all servers and FFDCs on the node are included.
  1. Set the needed trace string on the related app cluster members.
  2. Re-create the issue. Take note of the time you trigger the issue and provide this with the logs.
  3. Turn off each of the enabled trace strings.
  4. Compress the profile_root/logs directory from each node profile. The directory contains the logs, trace, and ffdc files for each server.
    Note: If you have logs/trace going to custom locations then provide those locations in addition.
3: TWX export
If your issue is related to a particular application then provide a twx export of the involved snapshot.
4: Profile config directory
In certain situations we will need config information from the profiles if the issue is configuration related. If this is needed provide the profile_root/config directory from the DMgr profile.
5: Snapshot related table dumps
For most snapshot related issues it is helpful to have the following 3 snapshot related tables from the BPMDB. Depending on the issue there are various other tables that can provide useful data. When providing DB table data it is important to provide it in a CSV text format. Each row should be on one line of text with each column value separated by a comma or other special character separator.

6: DB PO validation traces
If database corruption is suspected we may need to get database validation run. To do this, you should run the /system/validate_database REST call while a trace string of is enabled. After the REST call is completed, collect both the REST call output along with the generated traces.

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 Business Automation Workflow documentation or the support site to search for known problems.
  3. Once you complete gathering all the needed information and diagnostics, you can add them to your case. Alternatively, you can upload files to ECURep. For more information, see Enhanced Customer Data Repository (ECURep) - Overview.

[{"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":"a8m50000000CcYxAAK","label":"Development Tools-\u003ERepository"}],"Platform":[{"code":"PF025","label":"Platform Independent"}],"Version":"All Versions","Type":"MASTER"},{"Type":"MASTER","Line of Business":{"code":"LOB45","label":"Automation"},"Business Unit":{"code":"BU059","label":"IBM Software w\/o TPS"},"Product":{"code":"SS3PUM","label":"IBM Business Process Manager"},"ARM Category":[{"code":"a8m50000000CcYxAAK","label":"Development Tools-\u003ERepository"}],"Platform":[{"code":"PF025","label":"Platform Independent"}],"Version":"All Versions"}]

Document Information

Modified date:
06 May 2022