User exit parameters

The following table lists the Control‑M/Server user exit parameters.

Parameter

Description

CTM_PRM_ENABLE_UE

Indicates whether Control‑M user exits and Watchdog process exits are enabled.

Valid values: Y, N

Default: Y

Refresh Type: Recycle

CTM_PRM_ENABLE_UExxx (101-106)

Indicates whether the associated UExxx user exit is enabled.

Valid values: Y, N

Default: N

CTM_PRM_SCRIPT_UExxx (101–106)

Name of the UExxx user exit script. These scripts must reside in the ~<controlm_owner>/ctm_server/ue_exit directory.

Valid values: 1024 characters

Default:

  • UE101 Job Ordering User Exit—ctm_exit101.sh
  • UE102 Job Submission User Exit—ctm_exit102.sh
  • UE103 Before New Day Procedure User Exit—ctm_exit103.sh
  • UE104 After New Day Procedure User Exit—ctm_exit104.sh
  • UE105 Before User Daily User Exit—Ctm_exit105.sh
  • UE106 After User Daily User Exit —Ctm_exit106.sh

Refresh Type:

  • UE101 Job Ordering User Exit—Manual
  • UE102 Job Submission User Exit—Manual
  • UE103 Before New Day Procedure User Exit—Recycle
  • UE104 After New Day Procedure User Exit—Recycle
  • UE105 Before User Daily User Exit—Manual
  • UE106 After User Daily User Exit —Manual

CTM_PRM_TIMEOUT_UExxx (101–106)

Time to wait for a user exit script to run before it is terminated.

For UNIX: Time is measured in units of seconds

For Windows: Time is measured in units of milliseconds

Valid values: 20–2^31

Default: 20

Refresh Type:

  • UE101 Job Ordering User Exit—Manual
  • UE102 Job Submission User Exit—Manual
  • UE103 Before New Day Procedure User Exit—Recycle
  • UE104 After New Day Procedure User Exit—Recycle
  • UE105 Before User Daily User Exit—Manual
  • UE106 After User Daily User Exit —Manual

WD_CTMEXIT_NUMBER

Total number of Control-M/Server system exits to run.

Valid values: Any whole number.

Default: 0 (set to 2 during installation)

NOTE: Do not change the initial value unless instructed to do so by BMC Software Customer Support.

WD_USEREXIT_NUMBER

Total number of user exits to run.

Valid values: 0–2^31

Default: 0

Refresh Type: Recycle

Parent Topic

Control-M/Server parameters