trace

The trace command displays and sets tracing options for all servers in a farm or specified servers. You can trace various server activity, such as remote procedure calls or log manager processes.

The Content Platform Engine uses the Administration Console for Content Platform Engine (ACCE) workflow trace logging by default.

To utilize the vwtool trace command and the trace options file mechanism instead of the server trace logging mechanism, set the configuration parameter skipPETLC to true. For example, you can add -DskipPETLC=true to the startup command for the application server JVM hosting the Content Platform Engine. A CPE restart is needed for the JVM option to take effect. For more information, see topic Server logging.

You can set tracing options interactively or through a trace options file that is accessed at server startup. To start tracing at system startup, set tracing options in the TraceOptions file. To create the TraceOptions file, do the following steps:
  1. Make a copy of the TraceOptions.sample file.

    The TraceOptions.sample file can be found in ..\cpetools-win\peclient\samples or the ..\cpetools-linux\peclient\samples relative to the directory where the peclient.zip file was extracted from the CPETools package. For more information about downloading and extracting the peclient.zip file, see the topic Installing FileNet Process Designer.

  2. Save the copy of the TraceOptions.sample file without the file extension .sample to the folder specified by the application server user.dir system property. For example, 
    C:\Program Files\IBM\WebSphere\AppServer\profiles\AppSrv01\traceOptions
  3. Uncomment the trace options in the TraceOptions file that you want applied and save the file.

    The TraceOptions file is accessed when the server is restarted or reloaded through vwtool trace.

  4. To cause the Process Engine services to utilize the TraceOptions file instead of the settings made via ACCE, add to the CPE deployment the configuration parameter skipPETLC to true, for example by adding -DskipPETLC=true to the startup command for the application server JVM hosting the Content Platform Engine.

When the trace command is run on a single server, the current trace settings are listed and the trace options that were selected for the server are marked with a double asterisk (**).

For information on viewing log files, see Viewing the Content Cortex logs.

Syntax

In interactive mode, you are required to set all of the trace options.

trace [server] [change_tracing_options] [turn_off_all_tracing] [from_traceOptions_file] [trace_options]

Parameters

Table 1. Parameters and description for the trace command
Parameter Description
server Enter s for the trace to be performed on a single server. You are prompted for the name of the server.

Enter a for the trace to be performed on all of the servers.
change_tracing_options Enter yes to change any of the displayed settings, or no to leave them as they are currently set.
from_traceOptions_file Enter yes if you want the selected trace options from the traceOptions file. Enter no to leave them as they are currently set.
turn_off_all_tracing Enter y to turn tracing off.
trace_options Specify a number for each trace option for which you want to toggle selection. You can specify one or multiple trace options.

The trace options appear in the order that is indicated in the trace options parameters table. For example, if you want to toggle selection for the first three trace options parameters, enter the value as 1 2 3 separated by space.

Trace_options parameters

Table 2. Table of trace_option parameters and description
Vwtool parameter traceOptions file flag Description
Application space TRACE_APP_SPACE Trace application space changes such as configuration changes or API calls from client applications.
Archiver TRACE_ARCHIVER Trace archiving.
Asynchronous RPC TRACE_ASYNC_RPC Trace asynchronous RPCs. Used for long-running RPCs, such as configuration transfer, peverify, and pelog.
Asynchronous tools TRACE_ASYNC_TOOLS Trace the tools that use asynchronous communication to the workflow system such as pelog.
Case Synchronization TRACE_CASE_SYNC Trace synchronization of case data. Used with IBM® Case Manager.
Case Analyzer publishing TRACE_CA_PUBLISHING Trace the Case Analyzer event publishing process.
Case Analyzer collection TRACE_CA_COLLECTION Trace the event collection process that queries the event logs.
Case Analyzer database TRACE_CA_DATABASE Trace the database query statements that are run by Case Analyzer.
Case Analyzer RPC TRACE_CA_RPC Trace the remote procedure calls from the Administration Console for Content Platform Engine.
Case Analyzer upgrade TRACE_CA_UPGRADE Trace the Case Analyzer upgrade operation.
Case Analyzer OLAP TRACE_CA_OLAP Trace the interaction with the OLAP database that is conducted through the OLAP connector.
Case History Publishing TRACE_CH_PUBLISHING Trace the Case History event publishing process.
Case History Collect TRACE_CH_COLLECTION Trace the event collection process that queries the event logs for Case History.
Case History Database TRACE_CH_DATABASE Trace the database query statements that are run by Case History.
Case History RPC TRACE_CH_RPC Trace the remote procedure calls from the Case History client.
Case History Performance TRACE_CH_PERFORMANCE Trace the Case History event processing performance.
Case History Upgrade TRACE_CH_UPGRADE Trace the Case History upgrade.
Component Manager TRACE_CM Trace Component Manager.

Returns detailed logging information about Component Manager.
RDB Objects TRACE_RDB Trace RDB database access, which is related to isolated region tablespaces.
Database access TRACE_DBI_MSGS Trace database access.

This option outputs the SQL statements that are used by workflow system, along with the values of the substitution variables. Setting this option automatically sets the database time option.
Database outputs TRACE_DBI_OUT Trace the field values and outputs of database statements, such as SELECT, UPDATE, and so on.
Database time TRACE_RDB_TIME Trace database timings.

This prompt appears only if you answer no to the database access prompt.
Database transaction TRACE_DBI_TRAN Trace an entire database transaction from beginning to end.
Environment cache TRACE_ENV Trace workflow system interactions with its environment record cache where it keeps track of workflow system user and group membership information.
Event exporter TRACE_EVENT_EXPORTER Trace the core framework for Case Analyzer and Case History, which drives the publishing and collection processes.
Exceptions TRACE_EXCEPTION Trace exceptions occurring within the server.
Expression Parsing TRACE_EXPR Trace expression parsing.
External RPCs TRACE_EXTERNAL Trace external remote procedure calls (RPCs). Traces calls within the Content Platform Engine server.
Farming TRACE_FARMING Trace activities that are related to a farmed system.
Heartbeat TRACE_VWSVRTIME Trace the heartbeat task activities.
Instruction Sheet Interpreter TRACE_ISI Trace Instruction Sheet Interpreter (ISI) process.
J2EE TRACE_J2EE Trace calls that are related to Java Platform, Enterprise Edition.
Log Manager TRACE_LOG Trace log manager process.
Email Notification TRACE_NOTIFY Trace email notifications.
Object Service RPCs TRACE_OBJSVC Trace Object Service usage.
API RPC TRACE_RPC Trace communication RPCs between the API client and workflow server.
API RPC input TRACE_RPC_IN_PARAMS Trace API input parameters to workflow system RPCs.
API RPC output TRACE_RPC_OUT_PARAMS Trace API output parameters to workflow system RPCs.
Rules TRACE_RULES Trace workflow system interactions with the Rules Engine and rules processing.
Security calls TRACE_SEC Trace security calls.
Stored Procedure Calls TRACE_STORED_PROC Trace the execution of database instruction stored procedure calls.
Workflow Termination TRACE_WFTERM Trace calls made to the workflow termination process (vwdone).
Transfer TRACE_TRANSFER Trace transfer processes.
Vwtime TRACE_VWTIME Trace the processing of the timer task.
Web Services TRACE_WEBSERVICES Trace workflow system interactions with applications that use the Web Services protocol.
XML Parser TRACE_XMLPARSER Trace parsing of XML.
Dynamic Task TRACE_DYN_TASK Trace dynamic tasks. (Dynamic tasks are synonymous with IBM Case Manager ad hoc tasks.)