Submission parameters

The following table describes Control-M/Agent Submission parameters.

Parameter

Description

APPLICATION_LOCALE

(CJK Encoding)

Determines the CJK encoding used by Control-M/Agent to run jobs. For more information, see Control-M Language Customization.

Valid values: UTF-8, JAPANESE EUC, JAPANESE SHIFT-JIS, KOREAN EUC, SIMPLIFIED CHINESE GBK, SIMPLIFIED CHINESE GB, TRADITIONAL CHINESE EUC, TRADITIONAL CHINESE BIG5

Default: UTF-8

Modifiable by ctmwincfg: Yes

Modifiable by ctmunixcfg: Yes

CTM_PARM_ENC

Character used to enclose job processing parameters passed to jobs by Control‑M/Server. Any character or string can be specified. A blank space (in single or double quotes) is valid.

Valid values: Any character or string can be specified. A blank space (in single or double quotes) is also valid.

Default: Double quotes

Modifiable by ctmunixcfg: No

ECHO_OUTPUT

(Echo Job Commands into Output)

Specifies whether to print commands in the OUTPUT of a job.

Valid values:

  • Y – Implements ECHO_ON, which prints commands in the job OUTPUT
  • N – Implements ECHO_OFF, which does not print commands in the job OUTPUT

Default: Y

Modifiable by ctmwincfg: Yes

I18N

(Foreign Language Support)

Determines Control-M mode of support for foreign languages.

Valid values: Latin-1, CJK

Default: Latin-1

JOB_WAIT

(Job children inside job object)

Flag that specifies if procedures invoked by a job can be run outside the Job Object. If so, this prevents a situation in which the original job remains in executing mode until the invoked procedure completes.

Valid values:

  • N – All procedures invoked by the job are run outside the job object.
  • Y – All procedures invoked by the job are run inside the job object.

Default: Y

Modifiable by ctmwincfg: Yes

OUTPUT_MODE

Octal value indicating file access mode of the OUTPUT file. 777 indicates the highest level of access.

Valid values: Valid values are 600 640 644 660 664 666

Default: 600

Modifiable by ctmunixcfg: No

OUTPUT_MODE_AS_USER

Octal value indicating file access mode of the OUTPUT file for non-root mode when the job owner is not the agent owner. 777 indicates the highest level of access.

Valid values: 660 664 666

Default: 660

Modifiable by ctmunixcfg: No

ONSTMT_CASE_SENSITIVE

Determines whether the output is case sensitive for on statement processing.

Default: Y

RUN_USER_LOGON_SCRIPT

(Run user 'Logon Script')

Indication if a user-defined logon script should be run by the Control-M/Agent before running the standard user logon script.

Valid values:

  • Y – The user-defined logon script is run, if it exists.
  • N – The user-defined logon script is not run.

Default: N

Modifiable by ctmwincfg: Yes

USE_JOB_VARIABLES

(Convert Job Variables to Environment variables)

Flag that indicates whether all variables will be set as environment variables in the script.

Valid values: Y (yes), N (no)

Default: Y

WRAP_PARAM_QUOTES

(Wrap parameters with double quotes)

Indication of how parameter values (%%PARMn....%%PARMx) are managed by Control-M/Agent for Microsoft Windows.

Valid values:

  • 1 – This parameter is no longer relevant.
  • 2 – Parameter values are always passed to the operating system without quotes. If quotes were specified in the job definition, they are removed before the parameter is passed onward by the agent. This option is compatible with the way that these parameters were managed in version 6.0.0x, or 6.1.01 with Fix Pack 1, 2, 3, or 4 installed. In this case, if a parameter value contains a blank, the operating system may consider each string as a separate parameter.
  • 3 – This parameter is no longer relevant.
  • 4 – Parameters are passed to the operating system in exactly the same way that they were specified in the job definition. No quotes are added or removed in this case. This option is compatible with the way that parameters were managed by version 2.24.0x.

Default: 2

Modifiable by ctmwincfg: Yes

CODE_PAGE

Determines the Code Page for job processing in Latin-1 mode

Values: 1252

Default: 1252

DELETE_BACKUP_FILES

Determines if backup files should be deleted when the job output file is moved or deleted.

Valid values: Y, N

Default: N

DISABLE_CM_ONSTMT

If set to Y, then the ON statement is processed by the Agent Tracker. If set to N, it's processed by Agent Monitor process.

Valid values: Y, N

Default: N

ENABLE_RECOVERY

Determines whether to enable jobs recovery when the agent monitoring process terminates unexpectedly.

Valid values: Y, N

Default: Y

KILL_EXIT_CODE

Defines the exit code to kill jobs.

Valid values: 1-9999

Default: N/A

MIN_FREE_SPACE

Defines the minimum free disk space in MB required for job submission.

Valid values: 1-100000

Default: 50

MIN_FREE_SPACE_WARN

Defines the free disk space threshold in MB before sending agent alerts.

Valid values: 1-100000

Default: 100

SLEEP_COUNT

Defines the number of retries before checking the disk space.

Valid values: 1-120

Default: 5

UTIL_REAL_EXIT_CODE

Determines whether to return the actual exit code from agent utiliities.

Valid values: Y, N

Default: N

Parent Topic

Control-M/Agent parameters