Configuration parameters

The following table describes the parameters in the Control‑M/Server configuration parameter file (<controlm_owner>/ctm_server/data/config.dat on the server computer).

Parameter

Description

AGENTS_CLEANUP_IN_NEWDAY

Specifies whether the New Day procedure sends a request to Control-M/Agents to remove OUTPUT files and exit status files that are no longer needed.

Valid values: Y, N

  • Y—The New Day procedure sends a request to Control-M/Agents to remove OUTPUT files and exit status files that are no longer needed.
  • N —The New Day procedure does not send a request to the Control-M/Agents to remove OUTPUT files and exit status files that are no longer needed.

    NOTE: You can speed up the New Day procedure by specifying N for this parameter and running the ctmagcln utility. For more information, see Control‑M Utilities.

Default: Y

Refresh Type: Recycle

ALARM_DEST

Logical name of the Shout destination for critical Alert messages.

Valid values:

  • EM—Control-M/EM GUI
  • IOALOG—Control-M IOALOG files
  • CONSOLE—Server console

Default: EM

Refresh Type: Manual

CTM_ADJUST_COND_SCOPE

For jobs in the SMART Folder, determines conditions of which unscheduled predecessor jobs to ignore.

Valid values:

  • AJF – Ignore predecessor jobs in the Active Jobs level. When selected, jobs in the SMART Folder ignore conditions set by jobs in Active Jobs that are not scheduled.
  • GROUP – Ignore predecessor jobs in the group level. When selected, jobs in the SMART Folder ignore conditions set by jobs in the SMART Folder that are not scheduled. Default.

    NOTE: This parameter is relevant only when ADJUST_COND is set to Y. For more information, see ADJUST_COND in Control-M Parameter.

Default: GROUP

Refresh Type: Manual

CTM_VARIABLE_ALLOW_HYPHEN

Enables user-defined variables to contain the - (hyphen) character.

Valid values: N, Y

Default: N

Refresh Type: Manual

NOTE: If a job has an variable that includes a hyphen in the variable name, it will fail when submitted to an agent that is running on UNIX.

CTM_CONFIG_AGENT_AGENT_UNAVAIL_THRESHOLD

The Control-M/Server Configuration Agent issues the following message when the number of unavailable agents is equal to or greater than the threshold:

Some of the Control-M/Agents are unavailable.

Valid values: 1–2^31

Default: 1

Refresh Type: Manual

CTM_CONFIG_AGENT_DEBUG_LEVEL

Specifies the Control-M/Server Configuration Agent debug level.

Valid values: 0 –5 (where 0 means only critical messages are displayed)

Default: 0

How / where to set: In the Control-M Main Menu, choose Troubleshooting => Set Diagnostics Level.

Refresh Type: Automatic

CTM_CONFIG_AGENT_GET_HOSTNAME_INTERVAL

Frequency, in hours, with which Control-M/Server will retrieve operating system, platform, and Agent version information from Control-M/Agents and remote hosts so that the updated information is available to the end user from the CCM.

Default: 24 (hours)

CTM_CONFIG_AGENT_INITIAL_GET_HOSTNAME_INTERVAL

For Control-M/Agents and remote hosts for which Control-M/Server has not previously identified the operating system and Agent version, the frequency, in seconds, with which Control-M/Server will try to retrieve that information so that it is available to the end user via CCM.

Default: 5 (seconds)

CTM_CONFIG_AGENT_MODE

Determines the mode of the Control-M/Server Configuration Agent.

Valid values:

  • 0 (OFF_MODE): Disable Configuration Agent process, no communication with CMS is allowed.
  • 1 (READ_MODE): Only life check and information requests are honored, any modifying request is rejected.
  • 2 (ALL_MODE) Any CMS request is honored.

Default: 2

Refresh Type: Recycle

CTM_CONFIG_AGENT_MODULE_LEVEL

Specifies the Control-M/Server Configuration Agent module level.

Valid values:

  • 0—All components.
  • 1—Common functionality flow. Default.
  • 2—Event manager.
  • 3—Database layer.

Default: 1

How / where to set: In the Control-M Main Menu, choose Troubleshooting => Set Diagnostics Level.

Refresh Type: Automatic

CTM_CONFIG_AGENT_PORT_NUMBER

The Control-M/Server Configuration Agent listening port number.

Valid values: 1025–32767

Default: 2369

How / where to set: In the Control-M Main Menu, choose Parameter Customization => Basic Communication and Operational Parameters => Configuration agent Port.

Refresh Type: Recycle

CTM_DB_TIMEOUT

Timeout value for long New Day database transactions.

Valid values: 300–3600 (seconds)

Default: 300 (seconds)

Refresh Type: Recycle

CTM_GD_FORWARD

Indicates if job with a time zone specified should be ordered according to the current Odate, or tomorrow’s Odate.

Valid values:

  • Y – During the New Day Procedure, jobs with a specified time zone are ordered only if they are scheduled for tomorrow’s Odate.
  • N – During the New Day Procedure, jobs with a specified time zone are ordered only if they are scheduled for the current Odate.

Default: Y

Refresh Type: Recycle

CTM_GROUP_RECHECK

Indicates if group conditions should be checked for each job in a Group Scheduling folder after the groups conditions have been satisfied.

Valid values:

  • N—group conditions are ignored when ordering specific jobs in a group.
  • Y—group conditions are checked for each job in the group (in addition to conditions specified for the job).

    NOTE: If N is specified for this parameter, groups are activated when the necessary conditions exist, and remain active regardless of whether or not any of those conditions are deleted.

Default: N

Refresh Type: Manual

CTM_MULTIP_LIB_REPLACE

Indicates if AutoEdit variable %%MEMLIB overrides the MEMLIB value for all jobs in a folder with a command such as:

ctmorder -schedtab test2...-jobname "*" -autoedit %%MEMLIB d:/testdir

If you use the same command for a specific jobname, this parameter is ignored.

Valid values: Y, N

Default: N

Refresh Type: Manual

CTM_SLP_SUSPEND

During New Day or Download of Active Jobs to Control-M/EM, the ctmcreate, ctmudly, ctmorder utilities and ctmac and CS processes are suspended (when trying to order). They stay suspended until the Download or New Day is completed. This parameter indicates the maximum number of times to wait, where each time is configured, in seconds, by the parameter CTM_SUS_SLEEP_TIME.

Valid values: 1–120 (times)

Default: 30

Refresh Type: Manual

CTM_SNMP_SEND_FORMAT

Indicates whether Single (S) or Multiple (M) variable format is used for SNMP traps. For more information, see the description of the ctm2snmp utility in Control‑M Utilities.

Valid values: S, M

Default: S

Refresh Type: Automatic

CTM_SUS_SLEEP_TIME

During New Day or Download of Active Jobs to Control-M/EM, the ctmcreate, ctmudly, and ctmorder utilities and the ctmac and CS processes are suspended (when trying to order). They stay suspended until the Download or New Day is complete. This parameter indicates the specified number of seconds to wait before initiating a download or the New Day procedure.

See also CTM_SLP_SUSPEND.

Valid values: 1–180 (seconds)

Default: 60 (seconds)

Refresh Type: Manual

CTM_SUS_UTILS_SLP

After all processes are suspended, the CD process waits the specified number of seconds before initiating a download or the New Day procedure.

CTM_FOLDER_ADJUST_DUMMY

Controls creation of dummy jobs that run in place of unscheduled prerequisite jobs.

Valid values:

  • Y—A dummy job waits for the prerequisite conditions expected by the job it is replacing, and performs the post processing of the job. When a SMART Folder is ordered, jobs in the folder that should not be ordered at this time are ordered as DUMMY jobs. This functionality is useful for data centers that require identical job flow regardless of whether certain jobs in a folder are ordered for a specific instance of the folder.
  • N—Out conditions of the jobs that were not ordered are ignored by the ordered jobs in the SMART Folder.

    NOTE: This parameter is relevant only when ADJUST_COND is set to Y. For more information, see ADJUST_COND in Control-M Workload Automation Parameters

Default: N

Refresh Type: Manual

CTM_FOLDER_RECHECK

Indicates if SMART Folder or Sub-folder conditions should be checked for each job in a SMART Folder or Sub-folder after the SMART Folder or Sub-folder conditions have been satisfied.

Valid values:

  • N— SMART Folder or Sub-folder conditions are ignored when ordering specific jobs in a folder.
  • Y— SMART Folder or Sub-folder conditions are checked for each job in the folder (in addition to conditions specified for the job).

    NOTE: If N is specified for this parameter, SMART Folders or Sub-folders are activated when the necessary conditions exist, and remain active regardless of whether or not any of those conditions are deleted.

Default: N

Refresh Type: Manual

CTM_TIMEZONE_DISPLAY

Indicates if job run time is adjusted to time zone.

Valid values:

  • N – the Next Run time of a job is in local computer time, not adjusted to time zone.
  • Y – the Next Run time of a job is adjusted to the correct time zone.

Default: N

Refresh Type: Manual

CTM_WD_ENABLE

{YES, NO}
[UNIX only] When CTM_WD_ENABLE is set to YES, the utility init_prflag creates a prflag file for the WD process.

Valid values: YES, NO

Default: YES

How / where to set:

Refresh Type:

CTM_WRITE_CONSOLE

If this parameter is set, critical alerts are sent to the console of the server in addition to being sent as Shout messages to Control‑M/EM.

Valid values: YES, NO

Default: NO

Refresh Type: Recycle

CTMLOG_DEL_CHK

When set to Y, the use of the ctmlog utility for delete operation to Control‑M is restricted. Administrator only.

Valid values: Y, N

Default: N

Refresh Type: Automatic

CTMORDER_FORCE

The default action of the utility is to order, not force, jobs in Active Jobs. This action can be modified by adding keyword Force to the command that invokes the utility. To change the default to force, set this parameter to Y.

Valid values: Y, N

Default: N

Refresh Type: Automatic

CYCLIC_MAXWAIT

Indicates when cyclic jobs, that have previously executed at least once, are removed from Active Jobs by the New Day procedure.

Valid values:

  • KEEP – each job is removed when MAXWAIT days have passed regardless of whether it ended OK.
  • NOT_KEEP – each job (non-cyclic and cyclic) is removed from Active Jobs at the next run of the New Day procedure. Cyclic jobs are not removed if they are executing when the New Day procedure begins. Instead, they are removed at the run of the following New Day procedure.

Default: KEEP

Refresh Type: Recycle

CYCLIC_RERUN

If a cyclic job ends NOTOK and this parameter is set to OK, the cyclic job will be rerun. If set to NOTOK, the job will not be rerun.

Valid values: OK, NOTOK

Default: OK

Refresh Type: Manual

DO_NOT_COPY_LOG_TO_MIRROR

This parameter improves the performance of initialize mirroring. When set to YES, the Control-M/Server log is truncated on the secondary database when mirroring is initialized. When restoring from the mirror, the log is truncated in the primary database. Control-M/Server log is not copied during initializing or restoring from mirroring.

Valid values: YES, NO

Default: NO

Refresh Type: Automatic

NEW_DAY_JOB_MSG

Determines the kind of message to be inserted into the CMR_IOALOG folder during the New Day procedure, if any. Valid values are:

  • 1 – Deleted job messages only.
  • 2 – Carried job messages only. Insert a message upon every job that is carried on to the next day. Since fewer jobs are carried on, fewer records will be inserted into the IOALOG.
  • 3 – Both types of messages.
  • 4 – Nothing at all. (Default).

NEW_DAY_ASYNC_SP_EXECUTION

Improves the performance of initialize mirroring.

Valid values:

  • Y–the cleanup is performed in an asynchronous way.
  • N–the cleanup is performed sequentially.

Default: Y

This parameter needs to be in .cshrc file.

NOT_ORDERED_JOB_ALERT

Type of Alert message to send to Control‑M/EM when a job is not ordered due to scheduling criteria.

Valid values:

  • 0 – One General Alert per User Daily: ONE OR MORE JOBS IN DAILY <daily_name> WERE NOT ORDERED
  • 1 – One Alert message per job: DAILY <daily_name> FAILED TO ORDER JOBNAME <jobname>
  • 2 – Do not issue Alert messages

Default: 0

Refresh Type: Recycle

OUTPUT_HANDLING_SEVERITY

Indicates how the OUTPUT for a job will be handled. Valid values are:

  • None (default)
  • Regular
  • Urgent
  • Very Urgent

OUTPUT_LIMIT_SIZE

Maximum OUTPUT size that can be viewed by the output command from Control‑M/Server and Control‑M/EM. The value is set in Kilobytes.

If a OUTPUT file exceeds the value specified by the OUTPUT_LIMIT_SIZE configuration parameter, it cannot be viewed from Control‑M/Server or Control‑M/EM, and the following message is displayed:

OUTPUT FILE EXCEEDED LIMIT SIZE (CAN BE VIEWED FROM FILE SYSTEM)

Valid values: 0–2^31

Default: 0 (unlimited)

Refresh Type: Manual

OUTPUT_WINDOW_SIZE

Specifies the maximum number of characters for a OUTPUT file line.

Valid values: 80–132 characters

Default: 80

Refresh Type: Manual

RUNINF_CUTOFF_NUMBER

Affects the statistics cleanup algorithm that is performed during New Day when the RUNINF_PURGE_MODE is set to 0 (default). If the number of records to be deleted from the table is less than the value of this parameter, then records are deleted directly from the statistics table. Otherwise a temporary table is used to delete the records.

Valid values: 0 - 65K

Default: 2000

Refresh Type: Recycle

RUNINF_CUTOFF_RATIO

Affects the statistics cleanup algorithm that is performed during New Day when the RUNINF_PURGE_MODE is set to 0. If the ratio between the number of records to be deleted and the number of records in the table is less than the value of this parameter, then records are deleted directly from the statistics table. Otherwise a temporary table is used to delete the records.

Valid values: decimal fraction between 0–1

Default: 0.33

Refresh Type: Recycle

RUNINF_PURGE_LIMIT

Number of Run Information records to keep for a given MemName/MemLib/HostID. If RUNINF_PURGE_MODE is 0, the New Day Procedure deletes all Run Information records for each unique name except the last n records, where n is the value of this parameter.

Valid values: 1–2^31

Default: 20

Refresh Type: Recycle

RUNINF_PURGE_MODE

Valid values: 0, 1

0 – Performs -PURGE cleanup. Statistics records per job are kept according to the specified Statistics Mode (either MEMNAME or JOBNAME). Default: 20 records of each MEMNAME or JOBNAME are kept.

If the RUNINF_PURGE_LIMIT in the config.dat is specified, the number of records that are kept is determined by this parameter.

1 – Performs -DELETE cleanup. Only the amount of days that are specified are kept. Default: The number of days kept is specified by the How Many Days to Retain ioalog parameter.

If the RUNINF_PURGE_LIMIT in the config.dat is specified, the number of days that are kept is determined by this parameter.

Default: 0

Refresh Type: Recycle

SCHED_NON_EXIST_DAY

When DAYS is >n, or <n, should we order the job on the next (>n), or previous (<n) working day, if n is a non-existing day for the specific month? If the parameter is set to Y, then we should order the job.

Valid values: N, Y

Default: N

Refresh Type: Manual

STATIST

Determines whether Control-M/Server collects job statistics

Valid Values:

  • Y
  • N

Default: Y

See Also: ctmruninf, ctmstats

STATISALG

Specifies mode used to collect summary statistics by ctmjsa. In addition it is used for actions on statistics such as average and deletion.

Valid values:

  • JOBNAME – compiles statistics for each Control-M Job Name/Table and Host ID where the job was submitted
  • MEMNAME – compiles statistics for each Control-M Mem Name/Mem Lib and Host ID

Default: MEMNAME

Refresh Type: Recycle

See Also: ctmruninf, ctmstats

STATISTICS_CLEANUP_IN_NEWDAY

Specifies whether the statistics cleanup action is executed during the New Day procedure.

Valid values:

  • Y—The statistics cleanup action is executed during New Day procedure.
  • N—The statistics cleanup action is not executed during New Day procedure.

Note: You can speed up the New Day procedure by specifying N for this parameter and running ctmruninf -PURGE.

Default: Y

Refresh Type: Recycle

STATS_TIME

For statistics calculation, indicates how the START TIME and END TIME for a job should be set.

Valid values:

  • SERVER – START TIME and END TIME are set by Control‑M/Server.
  • AGENT – START TIME and END TIME are set using information received from the Control‑M/Agent.

Default: SERVER

Refresh Type: Manual

STOP_SUBMISSION_BEFORE_NEWDAY

Specifies the number of seconds preceding launch of the NewDay procedure during which jobs are not submitted.

Valid values: 0–3600 (seconds)

Default: 2 (seconds)

Refresh Type: Manual

UDLY_PARTCOPY_ERR

Error code returned by ctmudly utility if one or more jobs in a folder are not ordered by a User Daily job (due to scheduling criteria or security settings).

Valid values:

  • 0 – User Daily job ends with an exit code of 0 even if not all jobs are ordered.
  • 1 – User Daily job ends with an exit code of 14 if not all jobs are ordered.

Default: 0

Refresh Type: Automatic

UTILITIES_DB_TIMEOUT

{300 – 14400}
Timeout value (in seconds) for long database transactions performed by utilities. Currently this parameter is implemented for the ctmldnrs utility. Default: 300

VARIABLE_INC_SEC

Indicates which variables are sent to the agent for each submitted job.

Valid values:

  • SYSTEM—All the variables for each submitted job are sent to the agent. These include System, Global, Group, and Local variables.
  • GLOBAL—Global, Group, and Local variables are sent to the agent for each submitted job. System variables are not sent.
  • GROUP—Group and Local variables are sent to the agent for each submitted job. System and Global variables are not sent.
  • LOCAL—Only Local variables are sent to the agent.

Default: LOCAL

Refresh Type: Manual

WHEN_JOB_HAS_NO_PREV

Determines how to notify the user when a condition contains PREV that can't be calculated and is calculated as ODAT -1:

Valid values:

  • DO_NOTHING: A notification is not sent to the user.
  • WARN: A warning is logged in the CMR_IOALOG table and an alert is sent to Control-M/EM.
  • WARN_AND_CONFIRM: A warning is logged in the CMR_IOALOG table, an alert is sent to Control-M/EM, and the job state changes to Wait confirmation.

Default: WARN_AND_CONFIRM

Parent Topic

Control-M/Server parameters