pelog

Use the pelog tool to prune event log records and tracker work items from the workflow system event logs.

If the workflow system runtime option Enable CBE adapter for WebSphere® Business Monitor or Case Analyzer is enabled, then only the event records that were processed by the BPM Common Base Event adapter and Case Analyzer are pruned. Incompletely processed records are not deleted. However, this restriction can be overridden with the -P option. The -P option causes the specified event log records to be pruned regardless if the BPM Common Base Event adapter and Case Analyzer had finished processing the records.

You must be a member of the workflow system administration group to run the pelog tool.

Important: Always back up the associated object store data and legacy workflow system stores after events are pruned from the workflow event log.

Important: Always back up the associated object store data, legacy workflow system, and Case Analyzer stores after events are pruned from the workflow event log.

Syntax

pelog connection_point option

Parameters

Table 1. Options and description for the pelog tool
Parameters	Use
connection point	Specify the connection point of the isolated region of a workflow system database. Important: The connection point is required with the pelog command.
-h -H	The-h option displays the help menu for the pelog options. The -H option displays the help menu for the enhanced legacy pruning options. Legacy pruning options cannot be combined with the current pelog pruning options. Read the Technical Notice in the Related information link for information about the enhanced legacy options.
-v	The -v option outputs detailed pruning progress information and a running summary during the pruning process. A summary of the pruning results is displayed at the conclusion of the pruning process. If the -v option is not specified, then a reduced amount of progress information is displayed during the pruning process. A summary of the pruning results is displayed when the pruning process completes.
-t `event log name`	Specify the name of the event log to process. The default value is DefaultEventLog.
-Terminated `number of days`	Prunes event log records of completed workflows and prunes tracker items that are associated with completed workflows. The specified number of days indicate the number of days of event log records to keep. The day count includes the day that you begin the pruning process. There is no default number of days. Entering 0 (zero) for the number of days processes the entire event log. Terminated workflows are workflows that completed normally. Event log records of incomplete or abnormally terminated workflows are not pruned with pelog.
-TimeOnly `number of days`	Prunes all event log records that are specified by the day range regardless whether the workflows have completed or not. Tracker items that are associated with completed workflows in the specified day range are also pruned. The specified number of days indicate the number of days of event log records to keep. The day count includes the day that you begin the pruning process. There is no default number of days. Entering 0 (zero) for the number of days processes the entire event log.
-b	Specifies the batch size, which is the number of records that are processed per transaction. The minimum batch size is 1000 records. The default batch size is 10,000 records.
-P	Forces the pruning of event log records regardless if Case Analyzer or BPM Common Base Event adapter is configured.
-Y `user_name` + `password`	Specifies your user name and password in the format `user_name` + `password`. You must be a member of the workflow system administration group. You are prompted for a user name and password if you do not specify them with the -Y option.
-N `tenant_domain_name`	The tenant domain, if multiple domains are set up. If you specify this parameter, you must be a member of the workflow administration master group. This group is in the master domain directory service provider and has permission to run workflow system administrative tools in the tenant domain in which the group is designated a master group. If you run this tool against a workflow system in a tenant domain, you must use the -N parameter.

Examples

The following examples show the use of pelog command options:

pelog connection_point  -Terminated 90 -b 50000

The pelog command and options prune event log records and tracker records that are older than 90 days and for completed workflows only. A batch size of 50,000 event log records is processed in this transaction.

pelog connection_point  -Terminated 0 -b 50000

The pelog command and options prune all of the event log records and tracker records for completed workflows only. A batch size of 50,000 event log records is processed in this transaction.

pelog connection_point  -TimeOnly 30 -b 50000

The pelog command and options prune event log records that are older than 30 days regardless if the workflow has completed. Tracker records for completed workflows only and that are older than 30 days are pruned. A batch size of 50,000 event log records is processed in this transaction.

pelog connection_point  -Terminated 0 -b 50000 -P

The pelog command and options prune all event log records and tracker records for completed workflows only. A batch size of 50,000 event log records is processed in this transaction. The -P option causes pelog to prune records regardless of whether BPM Common Base Event adapter or Case Analyzer is enabled and completed processing these records.