This topic applies only to the IBM Business Automation Workflow Advanced configuration.This topic applies only to the IBM Business Process Manager Standard configuration.

setStateObserver.py administrative script

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 setStateObserver.py administrative script to enable or disable Dynamic Event Framework (DEF), audit events for Business Process Choreographer, or the task history log for the Human Task Manager. In addition, for federated environments that include Process Federation Server, you can enable or disable change logging for BPEL indexes.

Location

Draft comment: Kateryna
Needs the Prerequisite section with role information.
The setStateObserver.py administrative script is in the Business Process Choreographer admin directory.
For Windows operating systeminstall_root\ProcessChoreographer\admin
For Linux operating systemFor UNIX operating systeminstall_root/ProcessChoreographer/admin

Syntax

For Linux operating systemFor UNIX operating systeminstall_root/bin/wsadmin.sh 
For Windows operating systeminstall_root\bin\wsadmin

-f setStateObserver.py 
     -bfm 
     -cluster clusterName
     -conntype NONE
     -enable {DEF | AuditLog | TaskHistory | IndexerLog}
     -disable {DEF | AuditLog | TaskHistory | IndexerLog}
     -htm 
     -profileName profileName

Parameters

-f
This parameter specifies the script file to run.
-bfm
Optionally specifies that the enabling or disabling applies only to the Business Flow Manager of Business Process Choreographer, which runs BPEL processes. By default, when you specify neither -bfm nor -htm, the enabling or disabling applies to both the Business Flow Manager and the Human Task Manager.
-cluster clusterName
The name of the cluster where Business Process Choreographer is configured. In a multicluster setup, you must specify the application cluster because that is where Business Process Choreographer is configured.
-conntype NONE
Include this option only if the deployment manager is not running.
-enable DEF | AuditLog | TaskHistory | IndexerLog
Optionally specifies whether to enable DEF logging, audit logging, the Human Task Manager task history, or change logging for BPEL indexes. To specify more than one, use a semi-colon as a separator, for example, to enable DEF and audit logging, use -enable "DEF;AuditLog". The value TaskHistory is not valid if -bfm is specified.
-disable DEF | AuditLog | TaskHistory | IndexerLog
Optionally specifies whether to disable DEF logging, audit logging, the Human Task Manager task history, or change logging for BPEL indexes.
-htm
Optionally specifies that the enabling or disabling applies only to the Business Process Choreographer's Human Task Manager, which runs human tasks. By default, when you specify neither -bfm nor -htm, the enabling or disabling applies to both the Business Flow Manager and the Human Task Manager.
-profileName profileName
Where profileName is the name of the profile to use.

Examples

The following example shows how to enable DEF logging for BPEL process events on myCluster:

For Linux operating systemFor UNIX operating systemEnter the following command:

wsadmin.sh -f setStateObserver.py -cluster myCluster -enable DEF -bfm

For Windows operating systemEnter the following command:

wsadmin -f setStateObserver.py -cluster myCluster -enable DEF -bfm