maintainDocumentStoreTrace command

Edit online
Draft comment:
This topic only applies to BAW, and is located in the BAW repository. Last updated on 2025-03-13 12:15
Use the maintainDocumentStoreTrace command to enable or disable tracing for an individual component or all components of the BPM document store.

If you configured IBM® Business Automation Workflow to use an external Enterprise Content Management server, then this command does not apply. The equivalent procedure in Content Cortex Platform is in the topic Troubleshooting External link opens a new window or tab.

The maintainDocumentStoreTrace command is run using the AdminTask object of the wsadmin scripting client.
Note: When you enable tracing, it causes additional file system input and output operations that may slow down your system. You should only enable tracing for problem determination.

Prerequisites

The following conditions must be met:

  • The command must be run on the deployment manager node.
  • One or more application cluster members must be running.
  • Run the command in connected mode. Do not specify the wsadmin -conntype none option.
  • You must connect to the deployment manager with a user ID that has WebSphere® Application Server operator privileges.

Before running this command, review Managing tracing for the BPM document store.

Location

Start the wsadmin scripting client from the profile_root/bin directory of the deployment manager profile. The maintainDocumentStoreTrace command does not write to a log file, but the wsadmin scripting client always writes a profile_root/logs/wsadmin.traceout log file where you will find exception stack traces and other information.

Syntax

maintainDocumentStoreTrace
-serverName server_name
-nodeName node_name
-clusterName cluster_name
-deName deployment_environment_name
-disable componentName|all
-enable componentName|all
-list

Parameters

-serverName server_name
A required parameter that specifies the server name of the document store. If you specify the -serverName parameter, you must also specify the -nodeName parameter.
-nodeName node_name
A required parameter that specifies the node name of the document store. If you specify the -nodeName parameter, you must also specify the -serverName parameter.
-clusterName cluster_name
A required parameter that specifies the cluster name of the document store.
-deName deployment_environment_name
A required parameter that specifies the deployment environment name of the document store.
-disable componentName|all
A required parameter that specifies the component of the document store for which tracing should be disabled. Specify all to disable tracing for all components.
-enable componentName|all
A required parameter that specifies the component of the document store for which tracing should be enabled. Specify all to enable tracing for all components.
Warning: Enabling all traces may cause your system to slow down tremendously.
-list
A required parameter that displays the current list of components that have tracing enabled in the document store.

You must specify the -clusterName parameter, or the -deName parameter, or both the -serverName and -nodeName parameters. As an alternative to specifying any parameters, you can invoke the command on a target object of type BPMDeploymentEnvironment, ServerCluster, or Server.

You must also specify one or more of the following parameters:

  • -disable
  • -enable
  • -list

Any changes are effective immediately and no additional save operation needs to be performed.

The following components are included in the BPM document store:

  • API
  • AsynchronousProcessing
  • AuditDisposition
  • CBR
  • CFSDaemon
  • CFSImportAgent
  • CodeModule
  • ContentCache
  • ContentStorage
  • Database
  • EJB
  • Engine
  • Error
  • Events
  • FixedContentProvider
  • GCD
  • Handler
  • Metadata
  • Publish
  • Replication
  • Search
  • Security
  • SSI
  • Sweep
  • ThumbnailGeneration
  • WSI

Examples

Note: The examples are for illustrative purposes only. They include variable values and are not meant to be reused as snippets of code.
The following Jython example uses the maintainDocumentStoreTrace command to display the current list of components that have tracing enabled in the document store for a specified node and server:
wsadmin -user admin -password admin -lang jython
wsadmin>AdminTask.maintainDocumentStoreTrace(['-nodeName', 'myNodeName', '-serverName', 'myServerName', '-list'])
The following Jython example uses the maintainDocumentStoreTrace command to specify either an individual component or all components for which tracing should be enabled in the document store for a specified node and server:
wsadmin -user admin -password admin -lang jython
wsadmin>AdminTask.maintainDocumentStoreTrace(['-nodeName', 'myNodeName', '-serverName', 'myServerName', '-enable', 'componentName' | 'all'])
The following Jython example uses the maintainDocumentStoreTrace command to specify either an individual component or all components for which tracing should be disabled in the document store for a specified node and server:
wsadmin -user admin -password admin -lang jython
wsadmin>AdminTask.maintainDocumentStoreTrace(['-nodeName', 'myNodeName', '-serverName', 'myServerName', '-disable', 'componentName' | 'all'])
The following Jython example uses the maintainDocumentStoreTrace command to display the current list of components that have tracing enabled in the document store for a specified cluster:
wsadmin -user admin -password admin -lang jython
wsadmin>AdminTask.maintainDocumentStoreTrace(['-clusterName', 'myClusterName', '-list'])
The following Jython example uses the maintainDocumentStoreTrace command to specify either an individual component or all components for which tracing should be enabled in the document store for a specified cluster:
wsadmin -user admin -password admin -lang jython
wsadmin>AdminTask.maintainDocumentStoreTrace(['-clusterName', 'myClusterName', '-enable', 'componentName' | 'all'])
The following Jython example uses the maintainDocumentStoreTrace command to specify either an individual component or all components for which tracing should be disabled in the document store for a specified cluster:
wsadmin -user admin -password admin -lang jython
wsadmin>AdminTask.maintainDocumentStoreTrace(['-clusterName', 'myClusterName', '-disable', 'componentName' | 'all'])
The following Jython example uses the maintainDocumentStoreTrace command to display the current list of components that have tracing enabled in the document store for a specified deployment environment:
wsadmin -user admin -password admin -lang jython
wsadmin>AdminTask.maintainDocumentStoreTrace(['-deName', 'myDeName', '-list'])
The following Jython example uses the maintainDocumentStoreTrace command to specify either an individual component or all components for which tracing should be enabled in the document store for a specified deployment environment:
wsadmin -user admin -password admin -lang jython
wsadmin>AdminTask.maintainDocumentStoreTrace(['-deName', 'myDeName', '-enable', 'componentName' | 'all'])
The following Jython example uses the maintainDocumentStoreTrace command to specify either an individual component or all components for which tracing should be disabled in the document store for a specified deployment environment:
wsadmin -user admin -password admin -lang jython
wsadmin>AdminTask.maintainDocumentStoreTrace(['-deName', 'myDeName', '-disable', 'componentName' | 'all'])
The following Jython example invokes the maintainDocumentStoreTrace command on a specified target object:
wsadmin -user admin -password admin -lang jython
wsadmin>server = AdminConfig.getid('/Cell:/Node:myNodeName/Server:myServerName')
wsadmin>AdminTask.maintainDocumentStoreTrace(server, ['-enable', 'componentName' | 'all'])
The following Jython example invokes the maintainDocumentStoreTrace command on a specified target object:
wsadmin -user admin -password admin -lang jython
wsadmin>cluster = AdminConfig.getid('/Cell:/ServerCluster:myClusterName')
wsadmin>AdminTask.maintainDocumentStoreTrace(cluster, ['-enable', 'myComponentName' | 'all'])
The following Jython example invokes the maintainDocumentStoreTrace command on a specified target object:
wsadmin -user admin -password admin -lang jython
wsadmin>de = AdminConfig.getid("/Cell:/BPMCellConfigExtension:/BPMDeploymentEnvironment:myDeName/")
wsadmin>AdminTask.maintainDocumentStoreTrace(de, ['-list'])