The BmEvents configuration file

About this task

The BmEvents configuration file is named TWA_DATA_DIR/BmEvents.conf. Use it to configure HCL Workload Automation production processes on each workstation that has an agent installed. Its contents are described below.

# comment

A comment line.

OPTIONS=MASTER|OFF

If the value is set to MASTER then all job scheduling events gathered by that workstation are reported. If that workstation is the master domain manager or the backup master domain manager with full status on, then all scheduling events from the scheduling environment are reported. If the value is set to OFF, no job scheduling events are reported from that workstation. If commented, it defaults to MASTER on the master domain manager workstation, while it allows to report all job scheduling events regarding that workstation only on a workstation different from the master domain manager.

LOGGING=ALL|KEY

Disables or enables the key flag filter mechanism. Possible values are:

ALL

If set to this value, all events from all jobs and job streams are logged.

KEY

If set to this value, the event logging is enabled only for those jobs and job streams that are marked as key. The key flag is used to identify the most critical jobs or job streams. To set it in the job or job stream properties use:

The keywords KEYSCHED (for job streams) and KEYJOB (for jobs) from the HCL Workload Automation command-line interface.
The job Monitored check box and job stream Monitored check box from the Dynamic Workload Console.

The TEPConfig script sets the value of this parameter to KEY.

SYMEVNTS=YES|NO

It determines whether events concerning jobs and job streams are to be reported immediately after a plan creation.

YES: If set to this value, it tells the production process, batchman, to report the jobs and job streams status events immediately after having generated the new production day plan. For the integration with Tivoli Enterprise Portal, this value will cause a bulk discovery to be automatically performed after each new plan creation.
NO: Set to NO if report is not required.

The default value is NO.

CHSCHED=HIGH|LOW

When set to HIGH, batchman sends an event for any schedule status transaction. When set to LOW, batchman only tracks the initial schedule status transactions. For the lifetime of schedule jobs no change of status is reported until the final state is reached. When a job has more than one final state, an event is sent for each. For example, a schedule completes with an ABEND state and event 151 is sent (schedule abended). The job is then rerun and completes successfully. The schedule is completed with a SUCC state and event 154 is sent (schedule completed). The default is HIGH. Table Events filtered by CHSCHED lists the events that are filtered by CHSCHED when it is set to LOW.

Table 1. Events filtered by CHSCHED
Event	Description	Filtered on LOW
151	Schedule abended	NO
152	Schedule is stuck	NO
153 Note: This event is not logged for Workstation Master.	Schedule started	YES
154	Schedule ended	NO
155	Until time expired onuntil = suppr	NO
156	Schedule submitted	YES
157	Schedule cancelled	NO
158	Schedule ready	YES
159	Schedule hold	YES
160	Schedule extrn	YES
161	Schedule is cancel pending	NO
162	Schedule properties changed	YES
163	Schedule is late	NO
164	Until time expired onuntil = continue	NO
165	Until time expired onuntil = cancel	NO

EVENT= n [ n ...]

The list of events to be reported. Event numbers must be separated by at least one space. If omitted, the events reported by default are:

51 101 102 105 151 152 155 201 202 203 204 251 252

Event 51 causes mailman and batchman to report the fact that they were restarted. Events 1, 52, and 53 are not valid in this file .

If the EVENT parameter is included, it completely overrides the defaults. To remove only event 102 from the list, for example, you must enter the following:

EVENT=51 101 105 151 152 155 201 202 203 204 251 252

PIPE=filename

If set, job scheduling events are written to a FIFO file. To have events sent to the IBM Workload Scheduler/NetView agent, the setting must be:

PIPE=MAGENT.P

PIPE=filename

Used for communicating with a Unison Fifo file in UTF-8 format. The format of this file is a 4-byte string followed by the messages.

PIPE_NO_UTF8=filename

Used for communicating with a Unison Fifo file in local language. The format of this file is a 4-byte string followed by the messages.

FILE=filename

Path and file name of an ASCII log file where job scheduling events are written in UTF-8 format. This file is truncated whenever the batchman and mailman processes are restarted, for example at the end of each production day.

FILE_NO_UTF8=filename

Path and file name of an ASCII log file where job scheduling events are written in local language. This file is truncated whenever the batchman and mailman processes are restarted, for example at the end of each production day.

JSON=filename

Used for appending the log at the end of a file in .json format in UTF-8 format. Files in json format can be processed by third-party monitoring tools, such as Splunk and Fluentd. This file is truncated whenever the batchman and mailman processes are restarted, for example at the end of each production day.

JSON_NO_UTF8=filename

Used for appending the log at the end of a file in .json format in local language. Files in json format can be processed by third-party monitoring tools, such as Splunk and Fluentd. This file is truncated whenever the batchman and mailman processes are restarted, for example at the end of each production day.

MSG=filename

Used for communicating with a Unison Message file in local language.

MSG_NO_UTF8=filename

Used for communicating with a Unison Message file in UTF-8 format.