Configuring Control-M/EM System Parameters

Determines the time, in seconds, for the Auto Deploy automatic refresh.

Default: 60

Determines whether to activate applications for users who do not have administrator rights.

Valid Values:

• 1: On

• 0: Off

Default: 1

Determines the number of days to keep external event data.

Default: 4

Limits the number of alerts.

Determines whether to allow more than one job to have the same name.

Exported *.JSON Workspace files with multiple jobs that share the same name are defined in an array, as described in Folders and Flows.

Valid Values:

• true

• false

Default: true

API Parameter Name: allowDuplicateJobNames

Determines whether to allow a Resource Pool and Lock Resource to have the same name in Control-M Automation API job definitions.

If this parameter is set to true, the *.JSON-formatted job definitions are defined in an array, as described in Resources.

Valid Values:

• true

• false

Default: false

API Parameter Name: allowDuplicateResourceNames

Determines whether users can view a list of usernames in the Control-M for AFT configuration plug-in.

Valid Values:

• 0: Not permitted.

• 1: Permitted.

Default: Permitted

Determines whether to enable users to log in to the Control-M client and CLI utilities when the SSL certificate is not trusted.

Valid Values:

• 1: Disabled

• 0: Enabled

Default: 1

Determines which of the following activities require user annotations:

• ALL: All of the activities listed below.

• NONE: None of the activities listed below.

• AUTH: Authentication (logon tries, logouts, password actions).

• SCHED: Scheduling definition activities.

• J_CONT: Active network activities (control requests).

• J_INFO: Active job information activities (order, force, hold ...).

• RES: Resource pool and lock resource activities.

• ALERT: Alerts.

• ACCOUNT: Account management activities.

• OPER: Start and stop components using the Control-M Configuration Manager.

• CONFIG: Configuration operations from Control-M Configuration Manager.

• CTMSEC: Control-M/Server security interface using Control-M Configuration Manager

• DB_MAINT: Database maintenance operations using Control-M Configuration Manager

Default: AUTH SCHED J_CONT J_INFO RES ALERT ACCOUNT OPER CONFIG CTMSEC DB_MAINT

API Parameter Name: annotations

Determines the default value that is used when an annotation description is missing.

Default: Utility

API Parameter Name: annotationDefaultCategory

Determines the default value that is used when an annotation note is missing.

Default: Command line utility invocation.

API Parameter Name: annotationDefaultNote

Determines whether the make the Application job attribute mandatory.

Valid Values:

0: Not mandatory.

1: Mandatory.

Default: 0

When cleanup of audit information from the Control-M/EM database is automatic, this parameter defines the interval (in minutes) at which the GUI Server performs its cleanup operations.

Valid Values: 60 and above.

Default: 360

Determines whether to audit all changes to the job definition when it is updated.

Valid Values:

• 0

• 1

Default: 1 (Audits all changes when job definition is updated).

API Parameter Name: auditAllDefinitionChanges

Specifies whether cleanup of audit information from the Control-M/EM database occurs automatically.

Valid Values:

• 0: Cleanup is performed manually by the user as necessary.

• 1: Cleanup is automatic.

Default: 1

API Parameter Name: auditCleanup

When cleanup of audit information from the Control-M/EM database is automatic, this parameter specifies the number of days that audit information is retained before being cleaned from the Control-M/EM database.

Minimum Values: 1

Default: 7

API Parameter Name: auditHistoryDays

Determines whether to apply external IDP authentication.

Valid Values:

• On

• Off

Default: Off

Name of the external authentication plug-in.

Default: null (for internal Control-M/EM authentication).

Determines whether the default for folders that are created by Order Method is automatic or manual.

Valid Values:

• 1: Automatic Order Method (Daily).

• 0: None (Manual Order).

Default: 1

Determines whether SLA Manager (BIM) service authorization is only according to service name or also according to SLA Manager (BIM) job authorization.

Valid Values:

• 0: Authorize only according to service name.

• 1: Authorize according to service name and SLA Manager (BIM) job authorization.

Default: 1

Determines the default method for CTLs to bind if there is no HostPort setting. all means bind on all interface, host means bind on hostname.

Valid Values:

• All: Bind on the entire interface.

• Host: Bind on the hostname.

Default: All

Excludes folders from automatic synchronization (upload/download/delete) by the Gateway where the synchronization mode is set to No Synchronization.

You can set this parameter for each Control-M/Server separately or for all (*).

Valid Values: A valid regular expression (see Pattern-Matching Strings).

Default: Empty (no exceptions).

If you modify the value, you must recycle the GUI Server and the Gateway components.

Determines the rate at which the Centralized Connection Profiles table is refreshed.

Default: 60

Determines the limit of possible results in the Centralized Connection Profiles table in the web configuration.

Default: 1000

Defines a network location where the installation packages for Agent Deployment are saved.

You must define this parameter if you want to upgrade Agents from a network location, as described in Upgrading Control-M/Agents.

Default: Empty

Time interval in seconds after the server issues a request and receives a response from the client. If a response is not received during this interval, the server sends a FAILURE message and terminates the communication.

Default: 60

Determines whether the component with the same name should be checked on other machines when registering in the Database.

Valid Values:

• 1: The component is checked.

• 0: The component is not checked.

Default: 1

Determines whether to check if OS resource limits are set appropriately.

Valid Values:

• 1: On

• 0: Off

Default: 1

Determines whether the Disable SSO Mode checkbox appears in the Control-M login window.

Valid Values:

• On

• Off

Default: Off

Determines if Control-M/EM is installed in a clustered environment.

Valid Values:

• 0

• 1

Default: 0

Determines whether the Control-M/EM Statistics collection mechanism is on or off.

Valid Values:

• 0: Off

• 1: On

Default: 1

Defines the job field by which statistics are collected for distributed jobs.

Valid Values: Control-M job definition fields.

Default: Jobname

Specifies whether the Gateway automatically requests updates from Control-M for z/OS for the following information:

• Ordered jobs.

• Table list.

• User Daily list.

The information is saved in the Control-M/EM database.

Valid Values:

• 0: No requests are sent.

• 1: Requests are sent.

Default: 1

Specifies whether the ordering job and table keys (used when sending job ordering information from Control-M for z/OS to the Gateway) includes dataset names. Typically, the dataset name is changed for each job order.

Valid Values:

• 0: Do not include the dataset name

• 1: Include the dataset name

Default: 1

Specifies the Control-M/EM version.

Determines whether Control Resources can be defined for SMART folders and sub-folders in Control-M/Servers 7.0.00.200 and higher.

Control-M/EM 7.0.00.300 and lower cannot log in to Control-M/EM.

Valid Values:

• 1: On

• 0: Off

Default: 0

Specifies the data segment size limit in GB.

Default: 2

Amount of time between database availability checks by certain server components.

Valid Values: Do not change this parameter unless instructed to do so by BMC Customer Support.

Default: 10

Determines the maximum number of connections to the database retained in the connection pool of each server component.

Valid Values: Do not change this parameter unless instructed to do so by BMC Customer Support.

Default: 5

The maximum number of attempts by a server component to perform certain actions with the database.

Valid Values: Do not change this parameter unless instructed to do so by BMC Customer Support.

Default: 10

The amount of time between the attempts set in DatabaseRetries.

Valid Values: Do not change this parameter unless instructed to do so by BMC Customer Support.

Default: 10

Determines the number of days Control-M/Servers keep all deleted global events and send them during download, when the Global events Timestamp is activated.

Valid Values: 1-14

Default: 2

Determines the default average run time for jobs with no statistics.

Valid Values: Any valid time in MM:SS format.

Default: 00:05

API Parameter Name: DefaultAverageTimeJobWithoutStatistics

Determines excluded Rule-based calendar (RBC) support in a newly defined Control-M/Server. The value is overridden by the value set in the Control-M/Server system parameter EXCLUDE_RBC_ENABLED.

Valid Values:

• Y: Supports Excluded RBC in a defined Control-M/Server.

• N: Does not support Excluded RBC in a defined Control-M/Server.

Default: Y

If this feature was disabled during the fix pack installation, you must change RBC names that start with ! and run the enable_exclude_rbc.pl perl script from the <scripts> directory.

Maximum number of rows to be deleted by a single SQL statement, used by purge_runinfo and erase_audit_data scripts.

Default: 10,000

Valid Values: A whole number greater than or equal to 1.

Determines the number of files for the diagnostic stack snapshot of a component.

Default: 0

Determines the interval, in seconds, to print the diagnostic stack snapshot of a component.

Default: 0

Determines the amount of time, in minutes, between LDAP group cache collection.

Default: 240

Specifies the time interval, in seconds, passed from last refresh, after which EM refreshes LDAP connection during authentication.

Valid Values: 1–60

Default: 45

Determines if LDAP avoids the collection of nested groups.

Valid Values:

• 0

• 1

Default: 0

Stores the LDAP Domain Name (DN) credentials for a special user who has read access to the directory. This parameter is mandatory if the value of the DirectoryServiceType parameter is Active Directory, otherwise it is optional.

If no value is used, the parameter value is interpreted as an anonymous user (Default).

Valid Values:

• URL-notated definition of the user ID.

• User DN.

Stores the LDAP password for the search user defined in the DirectorySearchUserDN parameter who has read access to the directory. Optional if the value of the DirectorySearchUserID parameter is empty or anonymous.

Valid Values: The value is an encrypted password string. which is entered into the parameter value field as regular text and is then converted to an encrypted string before being stored in the database. Thereafter, the displayed value is the encrypted string whenever the parameter is accessed in the System Parameters window.

Default: If no value is used, the parameter value is interpreted as blank.

Determines if LDAP search action should chase referrals suggested by the server.

Valid Values:

• 1:On

• 0:Off

Default: 0

Specifies the maximum unsuccessful connection attempts allowed to the LDAP server.

Default: 3

Specifies the connection network timeout to LDAP server in seconds.

Valid Values: 5–120

Default: 20

Determines the list of characters considered to be special in LDAP.

Default: \()

Determines the time interval in seconds for which Control-M/EM waits for LDAP actions return.

Valid Values: 1–60

Default:10

Defines the LDAP directory type or vendor that is available to the enterprise, such as Active Directory, iPlanet, or Apache Directory.

This definition points to the relevant parameter load section in the DirectoryServiceType.cfg configuration file in the ctm_em/etc directory—this parameter value must be listed in this file.

Two default directory service types (Active Directory and iPlanet) are provided in the configuration file.

Default: Active Directory.

Determines if the escape character should be overridden in Directory Service when sending the search string.

Valid Values:

• 1: On

• 0: Off

Default: 1

The full domain name of the host on which the LDAP server is installed and the port on which to communicate with the LDAP server, in the following format" <Full_Domain_Name>:<Port_Number>.

Default: <null>

Determines the security level of communication with the Directory Server.

Valid Values:

• TCP

• SSL

Default: TCP

Determines the validation level of Directory Service parameters when connecting to LDAP.

Valid Values:

• 0: Specifies that validation is not performed.

• 1: Specifies that only the fields defined in the LDAP configuration window should be validated for existence.

  When LDAP authentication is applied directly on users defined in Control-M/EM Authorizations, LDAP Directory Search User and LDAP Directory Search Base parameters are optional. In all other cases, at least one of these parameters must be used.

• 2: Specifies that all the fields defined in the LDAP configuration window and the parameters defined in the DirectoryServiceType.cfg file should be validated for successful LDAP access and implementation.

Default: 1

Refresh Type: manual

The best configuration duration time can be achieved by setting this parameter to bypass validation actions during Control-M/EM startup or LDAP activation. This can be done after validating your configuration at least once to ascertain that all the configuration values are valid.

Determines whether LDAP group cache runs in the background.

Valid Values:

• 0

• 1

Default: 0

Defines the starting point, such as the domain and country, in the directory tree structure. The domain name values in this field support both dot-separated or DN format.

You can define multiple starting leafs by separating them with :. The lookup order is from left to right, according to the domain list order.

If the value of this parameter is NULL then a default value will be used, only if the DirectorySearchUserDN parameter is not blank. You can leave the DirectoryUsersSearchRoot parameter blank only if the DirectorySearchUserDN has a configured value. The default DirectoryUsersSearchRoot value is the domain of the search user.

Determines whether Control-M/EM servers support Thrift incoming requests.

Default: noncompatible

Describes the Contol-M/EM environment displayed in the clients.

Defines additional parameters for a Control-M/EM JVM container.

Determines the maximum memory size for a Control-M/EM JVM container.

Default: 256

Defines a list of trusted hosts.

The list must be space separated.

Defines the email addresses that receive the high availability alerts.

You must separate multiple email addresses with , (commas).

Defines the email address that issues the High Availability alert.

Defines the email server and port that is used to send notification emails to Control-M Workload Change Manager end users, in the following format:

<Server_Host>[:<Port_Number>]

If no port is defined, it defaults to 25.

Defines the email server JAVAMAIL properties file in the directory.

Default: mail.properties

Determines the validation version used by the emdef utilities.

Valid Values:

• 1: Validation version 1.

• 2: Validation version 2

Default: 2

Determines whether to enable the system to send alert data to an external event management system.

Default: false

Determines whether to enable an idle timer.

Valid Values:

• 0: Disable Idle time timer.

• 1: Automatically shut down only history Viewpoints.

• 2: Automatically shut down only active Viewpoints.

• 3: Automatically shut down active and history Viewpoints.

Default: 0

Determines whether to allows the ability to define a Load Balancer Router from Control-M for Web.

Default: false

Enables you to browse for a script in a file system on an Agent node from the job properties pane.

Valid Values:

• Y

• N

Default: Y

Determines whether to enable the REST Server to serve requests.

Default: Yes

Describes the environment.

Defines the logical name for the Control-M/EM environment, which appears in the Control-M title bar.

Valid Values: 1–255 characters of free text.

API Parameter Name: environmentTitle

Determines the alert types that are externally supported.

This parameter is supported only when the EnableExternalAlerts parameter value is set to true.

Valid Values:

• Alert

• XAlert

Default: Alert

Determine the maximum number of open file descriptors.

Default: 2048

Determines whether to use only array structures for jobs, folders, sub-folders, and resources in JSON code when you export from Control-M or when you use the deploy jobs::get API command, as well as to enforce the use of array structures in all deployments performed by Control-M Automation API.

Valid Values: true | false

Default: false

API Parameter Name: ForceArrayFormat

Determines whether the online help loads from the local web server or the BMC web site.

Valid Values:

• 0: Loads from the BMC web site.

• 1: Loads from the local web server.

Default: 0

Defines the ID that GCS uses to identify itself to Control-M. This user must be defined in the Control-M/Server with Add or Delete permissions.

Default: GCSERV

Sends a timestamp with every global event action (add or delete event).

Valid Values:

• 0: Disables the feature.

• 1: Enables the feature.

Default: 0

Determines how to handle alerts when a job is rerun.

Valid Values:

• 0: Alerts for this job that are in the Alerts window before the job is rerun are not automatically changed to HANDLED. If the rerun fails, a new alert is displayed in the Alerts window.

• 1: Alerts for this job that are in the Alerts window before the job is rerun are automatically changed to HANDLED.

Default: 0

API Parameter Name: handleAlertsOnRerun

Defines the hostname and port number or a port range for all components.

Format:

• Port: <hostname>:<port number> (CTMhost1:1530)

• Port Range: <hostname>:<fromPort-toPort> (CTMhost1:1520-1540)

Determines whether the system is configured for CJK languages or Latin1 languages.

For more information, see Control-M Installation.

Valid Values:

• cjk

• latin1

Determines whether to enable IPV6.

Valid Values:

• IPV4

• DUAL: (Enables IPV6)

Default: IPV4

How / Where To Set: In the config.dat file of Control-M/Server and the CONFIG.dat file of the Agent, set the IPV_MODE parameter to DUAL and then restart both Control-M/Server and the Agent.

Determines idle time out, in minutes.

Default: 15

Determines the API clients call for Run.

Valid Values:

• true: GSR

• false: ctm request service

Default: false

Determines the number of seconds before the user is logged out while there is no network activity between Control-M Web and the server.

Default: 600

Defines the License Manager address.

Determines the language for the Control-M/EM application. These values are not case-sensitive.

Valid Values:

• use_account_locale: Language set for the account and host us_english.

• english

• german

• french

• spanish

Default: use_account_locale

Determines whether to enable or disable limitations on the distribution of global events (conditions) using the Global Conditions Distribution facility.

Valid Values:

• _ 1: The Global Conditions Distribution facility distributes global events according to limitations defined using the LimitGCSDistribMaxDays and LimitGCSDistribExcludeDates parameters.

• _ 0: The Global Conditions Distribution facility imposes no limitations on the distribution of global events.

Default: _1

Dates for which global events (conditions) are distributed, regardless of limitations specified using the LimitGCSDistribMaxDays parameter. Dates are specified in mmdd format and are comma-separated.

Default: STAT

Defines the range of days within which conditions can be distributed.

Valid Values: 1–28

Default: 7

Defines the time interval, in minutes, after which an account that was automatically locked is automatically unlocked. (Accounts locked by an administrator are not unlocked automatically.)

If set to 0, the account is not automatically unlocked, but an administrator can manually unlock it.

Valid Values:Positive integer values

Default: 0

(Deprecated in version 9.0.21.200) Determines the units that appear in the Bit Rate tab in the Active Connections area.

Valid Values:

• B

• KB

• MB

• GB

Default: KB

Determines the maximum number of bars to display on the Active Connections widget.

Default: 10

Determines the clean up interval time, in minutes.

Default: 390

Determines the number of days to keep records in MFT table.

Default: 30

Determines the maximum number of records in the MFT table.

Default: 7000000

(Deprecated in version 9.0.21.200) Determines the number of seconds between each refresh in the MFT dashboard.

Default: 60

Determines the units that appear in the Volume tab in the Traffic Load area.

Valid Values:

• B: Bytes

• KB: Kilobytes

• MB: Megabytes

• GB: Gigabytes

• AUTO: Automatically and dynamically determined, based on the largest measurement.

Default: AUTO

Determines the maximum number of bars to display on the Traffic Load widget.

Default: 10

Determines the logical name context of the GUI Server, which the Control-M Self Service Web server must connect to.

Valid Values: GUI Server logical name.

Default: Empty

When cleanup of audit information from the Control-M/EM database is automatic, this parameter specifies the maximum number of audit records to delete during each automatic cleanup operation. If the number of audit records to clean is higher than this number, no records are deleted and a message is issued to the GUI Server diagnostic log that asks you to clean audit records manually using the erase_audit_data script.

Valid Values: Positive integer values.

Default: 2,000

Defines the number of days the alert is retained in the database.

Default: 30

Determines the maximum number of jobs that can be shown in one View Scheduling request.

Default: 1500

The maximum number of characters for user passwords.

Valid Values: Any value between the MinPasswordLength and 32 (inclusive).

Default: 32

Defines the number of recent items in any list.

Default: 40

The maximum number of jobs in the table to be audited.

Valid Values: Any whole number that is greater than or equal to 1.

Default: 1,000

Defines the number of days to keep collected metrics data.

Default: 90

Determine the requested memory size limit, in GB.

Default: 2

The minimum number of characters for user passwords.

Valid Values: Any value between 1 and the MaxPasswordLength (inclusive).

Default: 6

Determines whether to disable editing of the Command line and Node ID Group fields for all non-admin users in the Monitoring domain.

Valid Values:

• CMD_LINE

• NODE_ID

The maximum number of handled alerts saved in the database (in addition to not-yet-handled alerts).

Valid Values: Positive integer values.

Default: 2,000

API Parameter Name: numberHandledAlarms

Defines the number of connection attempts between the client and the GUI Server for connection recovery.

Default: 5

Defines the maximum number of estimated run times sent from Control-M/EM server to the client for one cyclic job.

Default: 50

Determines the number of sequential failed logins before an account is locked.

Valid Values: 0–100

Default: 5

If the value is 0, automatic account locking is disabled.

The number of password changes that must occur before a password can be reused, if PasswordHistoryOnOff is set to 1.

Valid Values: 1–20

Default: 10

Defines the maximum number of past run times sent from Control-M/EM server to the client for one cyclic job.

Default: 50

Determines the number of days to keep report data in the database for generating reports about services.

Valid Values: 2 and higher.

Default: 90

Determines the number of days to keep history report data in the database for generating history of services.

Valid Values: 2 and higher.

Default: 90

Determines the size of output data that Control-M loads automatically. If the output data size exceeds the threshold, then the user is prompted to save the output data in a separate temporary file.

Default: 10,000,000

Determines if passwords must comply with complexity rules.

Valid Values:

• 0: No (off).

• 1: Yes (on).

Default: 0

Defines one, some, or all of the following PasswordComplexityRules separated by a blank space. Multiple values are joined by AND Boolean logic.

Valid Values:

• PWD_DIGIT: Using digits is mandatory.

• PWD_UPPER: Using letters in upper case is mandatory.

• PWD_LOW: Using letters in lower case is mandatory.

• PWD_NON_LETDIG: Non-alphanumeric characters are mandatory.

• PWD_DIGIT PWD_UPPER PWD_LOW PWD_NON_LETDIG: All of these rules to be followed.

Default: PWD_DIGIT PWD_UPPER PWD_LOW PWD_NON_LETDIG

Determines how user passwords are transmitted by clients to the server.

Valid Values:

• 0: Two-way encryption (encoded). Often used with External Authentication.

• When using the AES algorithm, you can use the default hard-coded string, or the string in the aes_key.txt file, if it exists in the etc directory.

• 2: One way encryption.EM local authentication.

Default: 2

Determines whether password expiration parameters should be checked.

Valid Values:

• 0: Off—password expiration is not checked.

  When set to 0, other password expiration parameters can be edited but are ignored.

• 1: On—password expiration is checked.

Default: 0

Determines whether password history is recorded.

Valid Values:

• 0: No—new passwords are not checked against previous passwords.

• 1: Yes.

Default: 0

Determines the number of days before the password expires.

The set_pwd_def_lifetime script runs manually after you change this parameter, and affects all users, including emuser.

Valid Values: 1–365

Default: 60

This parameter specifies whether non-Administrators can manually unlock their own tables, such as when tables are locked during an abnormal disconnect from the GUI Server.

Valid Values:

• 1: Users can unlock their own tables.

• 0: Only administrators can unlock the table.

Default: 1

Defines the URL that links to the Privacy Notice from all Control-M clients, which outlines the privacy policy and compliance guidelines.

API Parameter Name: privacyNoticeURL

Determines the proxy server hostname and port number for all users who connect to the Newsfeed via a proxy server, as follows:

<host>:<port>

Default: Empty

Determines whether to allow users with job level authorizations to generate reports from Control-M Reports.

Valid Values:

• Y

• N

Default: Y

Determines whether to enable the UseDeclareFetch option in Control-M Reports with PostgreSQL database.

Valid Values:

• 0: Not enabled

• 1: Enabled

Default: 1

Defines the maximum number of days recent items are retained in the database.

Default: 60

Determines the maximum number of objects (files-directories) that are allowed for a Remote Browsing request.

Valid Values: Any whole integer.

Default: 1,000

Determines the maximum number of rows in the database of historical data to be deleted, each time a deletion is performed.

Valid Values: Positive integer values.

Default: 25,000

Interval in seconds between the deletion of historical records.

Valid Values: Positive integer values.

Default: 21,600

Determines the number of days that RunInfo History information, which records every job execution in the RUNINFO_HISTORY table, is retained in the Control-M/EM database.

Default: 90

Determines whether to activate single sign-on login mode.

Default: Off

Determines the single sign-on HTTP header value to determine which user performed login.

Default: em-user

Determines whether to disable sending metrics in Helix Control-M.

Default: N

Defines the time interval in seconds between connection attempts.

Default: 5

Full pathname of the script that is activated when an alert is generated.

This script is activated only if the value of SendSnmp is either 1 or 2.

Valid Values: Full pathname of the script that is activated when an alert is generated.

Default: script_name

When you send Alert data as input to a script, the parameters are sent in the following format:

call_type: "<call_type>" alert_id: "<alert_id> "
data_center: "<data_center> " memname: "<memname> "
order_id: "<order_id>" severity: "<severity>" status:
"<status> " send_time: "<send_time>" last_user:
"<last_user> " last_time: "<last_time> " message:
"<message>" run_as: "<run_as>" sub_application: "<sub_application> "
application: "<application> " job_name: "<job_name> "
host_id: "<host_id> " alert_type: "<alert_type>"
closed_from_em: "<closed_from_em> " ticket_number:
"<ticket_number> " run_counter: "<run_counter> "
notes: “<notes>”

Specifies whether Alerts NOTES data field text should be sent to SNMP and script.

Valid Values:

• 0: Field is not sent to SNMP and script.

• 1: Field is sent to SNMP and script.

Default: 0

Enables you to set alert field names and to send alarm exit scripts written before version 8.0.00.

Valid Values:

• 0: Does not enable you to set alert field names and alarm exit scripts written before version 8.0.00.

• 1: Enables you to set alert field names and alarm exit scripts written before version 8.0.00

Default: 0

Specifies whether BIM runtime information updates are sent to the GUI.

Valid Values:

• 0: Disables the Show/Hide Time field from the View tab in the Montoring domain.

• 1: Enables the Show/Hide Time field from the View tab in the Monitoring domain.

Default: 0

Determines where Alert data is to be sent.

Valid Values:

• 0: SNMP only

• 1: User-defined script only.

• 2: SNMP and user-defined script.

Default: 0

Determines whether to display Member Field for all jobs.

This requires the user to login again.

Valid Values

• 0: Hide the file name and file path.

• 1: Display the file name and file path fields in the General tab of Command.

Default: 0

Determines whether the Newsfeed domain appears in Control-M client.

Valid Values:

• 0: Hide

• 1: Show

Default: 1

Hostname or a list of hostnames—you must use ; as delimiters—to send the SNMP trap on an alert. You can use : to define specific ports.

Valid Values: Valid hostname or IP address.

Default: <No_Host>

Determines whether SNMP messages for Active Alerts are generated.

Valid Values:

• 0: Does not generate SNMP messages for Active alerts.

• 1: Generates SNMP messages for Active alerts.

Default: 0

Enables you to set a mandatory Sub Application field for job definition.

Valid Values:

• 0: Not mandatory

• 1: Mandatory

Default: 0

Determines whether to connect to Control-M/Server that is lower than version 9.0.22 in a Control-M/EM manage timezone file.

Default: N

For BMC Customer Support use only.

Valid Values: List of releases separated by semicolons:

Default: 0

Defines the reconnection invocation method.

Valid Values:

• 1: Automatic

• 0: Manual

Default: 1

Determines whether to enable LDAP user creation options.

Valid Values:

• Yes: Disable LDAP user creation options without the need to recycle.

• No: Enable LDAP user creation options.

Default: No

Determines the number of folders that are equal to or less than the configured value.

emdef deffolder uses a folder filter. If a value is not defines, the system does not apply a filter.

Default: 10

Determines the user request timeout, in seconds.

Default: 300

Enables the to user to override the GMT value and ignore the value sent by Control-M/Server. Relevant to Control-M for z/OS.

Valid Values:

• 1: Overrides values.

• 0: Cannot override values.

Default: 0

Additional job related key fields to be defined by a user.

BMC Software recommends that you not use the same job name (or mem name, in Control-M for z/OS) for multiple jobs. If you use the same name for multiple jobs, use this field to identify additional key fields that Control-M/EM can use to distinguish between different jobs with the same name/mem name, so as not to confuse or switch their job histories.

Use space as a delimiter between key field values, as follows:

HOST_ID OWNER CMD_LINE

Recommended Values: DESCRIPTION, MEM_LIB, HOST_ID, OWNER, DAYS_CAL, WEEKS_CAL, CONF_CAL, CMD_LINE, FROM_TIME, TO_TIME, ACTIVE_FROM, ACTIVE_TILL

Valid Values: Do not change this parameter unless instructed to do so by BMC Customer Support.

Default: <empty>

Refresh Type: Manual

Determines the number of versions of the job to keep, including the current version.

BMC Software recommends that you not define a value greater than 30 because of possible performance degradation. To deactivate version history, set the parameter to 1 (keep current version only).

Valid Values: Any whole number that is greater than or equal to 0.

Default: 2 (current version, and one history version)

Refresh Type: Manual

API Parameter Name: numberJobVersionsToKeep

Defines the Viewpoint callback data serialization protocol.

Default: Binary

Displays the first KB of the output file.

Valid Values:

• 1: First KB of the output file

• 0: Whole file

Default: 0

Displays the last KB of the output file.

Valid Values:

• 1: Last KB of the output file

• 0: Whole file

Default: 0

Number of days prior to password expiration during which a warning message is generated when certain utilities or scripts are run or a successful login occurs.

Valid Values: 0–90

Default: 0 (no warning is generated)

Number of days prior to certificate expiration during which the GUI Server generates a warning message in the Control-M Web.

Valid Values: 1–365

Default: 60

Determines whether to prevent all web applications from residing inside an IFrame control.

Default: On

Determines which activities are audited and recorded.

Valid Values:

• ALL: All of the activities listed below.

• NONE: None of the activities listed below.

• AUTH: Authentication (login attempts, logouts, password actions).

• SCHED: Scheduling definition activities.

• J_CONT: Active network activities (control requests).

• J_INFO: Active job information activities (order, force, hold ...).

• RES: Resource pool and lock resource activities.

• ALERT: Alerts.

• ACCOUNT: Account management activities.

• OPER: Start and stop components using the Control-M Configuration Manager.

• CONFIG: Configuration operations from Control-M Configuration Manager.

• CTMSEC: Control-M/Server security interface using Control-M Configuration Manager.

• DB_MAINT: Database maintenance operations using Control-M Configuration Manager.

• HIGH_AVAIL: High Availability operations.

Default: All values.

API Parameter Name: userAuditContext

Determines whether the user will be required to enter details about the type of operation being performed and the reason for its performance, which will be saved as an annotation to the audit report, before completing the operation.

Valid Values:

• 0: Annotations are not required.

• 1: Annotations are required.

Default: 0

API Parameter Name: userAuditAnnotation

Determines whether activities specified by UserAuditContext are recorded in the database.

Valid Values:

• 0: Not recorded.

• 1: Recorded

Default: 1

API Parameter Name: userAudit

Enables Web Server load balance by allowing the emThrift web app to retrieve servers.

Valid Values:

• 0: Disables Web Server load balance

• 1: Enables Web Server load balance

Default: 0

Determines the number of months to retain Workflow Insights data.

Default: 16

Defines the location to retain Workflow Insights data snapshots.

Defines the Maximum number of workload versions in the database.

Default: 100

Determines the interval to refresh Workload Monitor data.

Default: 20

Enables users to view a Workspace owned by other users.

Valid Values:

• 0: Disables users to view a Workspace owned by other users.

• 1: Enables users to view a Workspace owned by other users.

Default: 1

Determines whether the option to send exception alerts is enabled or disabled.

Valid Values:

• 1: Enable

• 0: Disable

Default: 1

Enables a XCTM Do Force Audit.

Valid Values:

• Yes: Enables Cross Control-M Job Order audit.

• No: Disables Cross Control-M Job Order audit.

Default: No

Determines which component checks the authorization for running the folder/jobs. The component must have the authorization to perform the run according to the user that is defined in XCTMDoForceUser.

Default: EM

Defines the number of seconds that Control-M/EM waits in case of temporary failure, before trying to perform the force request.

Default: 300

Defines the number of minutes in which Control-M/EM tries to perform a force request.

Default: 1,440

Defines the user with authorization to run the requested folder or jobs.

Default: use_job_owner

Determines the default bulk size for database bulk operation.

Valid Values: 10–10,000

Default: 100

Defines the default value for storage length in bulk operation. Must be at least as long as the longest field involved in the bulk operation.

Default: 264

Determines whether alerts are sent for jobs that end Not OK.

Valid Values:

• 0: Alerts are not created.

• 1: Alerts are created.

Default: 1

API Parameter Name: alertOnJobFail

Determines whether to create an alert for a SMART folder that ended Not OK.

Valid Values:

• N: Alerts are not created.

• Y: Alerts are created.

Default: N

API Parameter Name: alertOnSmartFolderFail

Determines the urgency level for Gateway alerts for jobs that end with the status Ended Not OK.

Valid Values:

• Regular

• Urgent

• Very Urgent

Default: Very Urgent

API Parameter Name: alertOnJobFailUrgency

Determine the number of seconds between for each automatic synchronization interval per Control-M.

Default: 1,800

The number of bytes buffered in Gateway that are waiting to be sent to the Control-M/Server. If the number of bytes are exceeded, communication with Control-M/Server is terminated.

Valid Values: Any whole number that is greater than or equal to 1,000,000.

Default: 50,000,000

The number of bytes buffered in Gateway that are waiting to be sent to other Control-M/EM servers. If the number of bytes are exceeded in GUI Server or GCS components, communication with Control-M/Server is terminated.

Valid Values: Any whole number that is greater than or equal to 1,000,000.

Default: 50,000,000

Specifies whether the Gateway automatically requests updates from Control-M for z/OS for the following information:

• Ordered jobs.

• Table list .

• User daily list .

The information is saved in the Control-M/EM database.

Valid Values:

• 0: No requests are sent.

• 1: Requests are sent

Default: 1

Specifies whether the ordering job and table keys (used when sending job ordering information from Control-M for z/OS to the Gateway) includes dataset names. Typically, the dataset name is changed for each job order. Valid Values:

• 0: Does not include the dataset name.

• 1: Include the dataset name.

Default: 1

Determines whether to automatically delete folders or calendars that no longer exist in the Control-M/Server from the Control-M/EM database when Control-M performs an automatic synchronization.

Valid Values:

• 0: Do not automatically delete

• 1: Automatically delete

Default: 0

Age, in minutes, for a net to be considered valid for distribution of Global Conditions.

Valid Values: Any whole number that is greater than or equal to 300.

Default: 2,160

Flag that indicates whether to send alerts for downloaded jobs that end Not OK when they are run.

AlertOnAbend must be set to 1 for DownCreAlert to be operational. Valid Values:

• 0: Alerts are not sent.

• 1: Alerts are sent.

Default: 1

API Parameter Name: alertOnDownloadJobFail

For MVS Data Centers: This parameter defines the EBCDIC code page to which ASCII data is translated.

Valid Values:

• 0: Instructs the Gateway to use the translation table that was used by the previous version.

• 1047: English (USA)

• 285: English (British)

• 273: German

• 297: French

• 284: Spanish

Default: 0

Enables you to set command line trace options for multiple Gateways.

Valid Values: All Gateway trace option parameters.

Default: <empty>

Do not change this parameter unless instructed to do so by BMC Customer Support.

Default: CTM5050 CTM5301 CTM5311 CTM5312 CTM5323

Only available if GtwParallelProcessingMode is on (see below).

The number of threads in the multi-thread processing mode is indicated by the value of this parameter.

Valid Values: 2-16

Default: 2

Enables multi-threading processing mode. The value off indicates single-thread processing.

Valid Values:

• on

• off

Default: 0

Listening port hostname and port number for Gateways.

List the hostname and port number in the following format:

<Hostname >:<Port_Number>

Default: null

Number of times that the Gateway attempts to insert an alert into Control-M/EM. The number includes the initial attempt and can be any whole number greater than or equal to 1.

Valid Values: Do not change this parameter unless instructed to do so by BMC Customer Support.

Default: 10

Defines the number of runs per day the Gateway will keep in the history table for each job.

Valid Values: Any whole number greater than or equal to 1.

Default: 1 (No limit)

Number of days that the list of downloads is saved. This list contains abbreviated information about each download, such as date and time, net name, and number of downloaded jobs and resources.

Valid Values: Any whole number that is greater than or equal to 0.

Default: 100

Valid Values:Do not change this parameter unless instructed to do so by BMC Customer Support.

Default: 60,000

For Customer Support use only.

Default: 60,000

Determines what MultiByte code page Gateway uses to translate when sending data to a Control-M for z/OS.

Valid Values: Any valid CJK EBCDIC code page

Downloads are kept in the Control-M/EM database for not more than the number of days specified in this parameter.

Valid Values: Any whole number that is greater than 0.

Default: 2

API Parameter Name: historyRetentionDays

Determines the number of downloads that can be stored in a Control-M/EM database. If this number is exceeded, the oldest download is deleted.

Valid Values: Any number that is greater than 0.

Default: 4

API Parameter Name: historyRetentionMax

Valid Values: Do not change this parameter unless instructed to do so by BMC Customer Support.

Default: 0

Indicates the maximum and minimum length of elapsed run time between calculation discards.

Valid Values: Do not change this parameter unless instructed to do so by BMC Customer Support.

Default: 2

Indicates the maximum number of run samples to be kept per job.

Valid Values: Do not change this parameter unless instructed to do so by BMC Customer Support.

Default: 20

Maximum number of run detail records processed in one loop.

Valid Values: Do not change this parameter unless instructed to do so by BMC Customer Support.

Default: 100

Configures the context in which run information is processed.

Valid Values:

• 0: Gateway main thread

• 1: Separate thread

Default: 1

Interval in seconds between processing of run details in the Gateway.

Valid Values: Do not change this parameter unless instructed to do so by BMC Customer Support.

Default: 10

Determines the number of times that Control-M/EM attempts to establish communication with the Gateway before turning the SSL on or off. SSL can either be enabled or disabled when Control-M/EM initially tries to connect to the Gateway.

After making the specified number of attempts, SSL is toggled on or off (as required). This parameter is relevant only when SSL Enabled communication is selected. It does not work when only TCP/IP is selected.

Valid Values: Do not change this parameter unless instructed to do so by BMC Customer Support.

Default: 2

Replaces the value of the Sync_Timeout parameter in the Defaults.rsc file, which determines the period of time between attempts to establish communication with the Gateway when changing the communication protocol to SSL Enabled.

Valid Values: Do not change this parameter unless instructed to do so by BMC Customer Support.

Default: 90

Determines the number of seconds between sending groups of conditions to a reconnecting data center.

Valid Values: Do not change this parameter unless instructed to do so by BMC Customer Support.

Default: 0

Maximum number of messages to send in a group to a reconnected data center.

Valid Values: Do not change this parameter unless requested to do so by BMC Customer Support.

Default: 1,000,000

Interval, in seconds, when the GCS deletes unused conditions from the database. These conditions may have no data center destinations.

Valid Values: 601 seconds (10 minutes)

Default: 900 (15 minutes)

Maximum time, in seconds, unused conditions wait in the database before they are removed. These conditions may have no data center destinations.

Valid Values: 601 or higher.

Default: 86,400 (24 hours)

Determines the information log level for event (condition) transfer activities. Information is displayed for events received (In), events sent (Out), transfer confirmation and rejection actions, and communication problems.

Valid Values:

• 0: No diagnostics.

• 1: Event transfer, problem, and information received.

• 2: Event transfer, problem, and information sent.

• 3: Value 1 + Value 2.

Default: 2

Determines the information log level for messages related to database activities. Diagnostic information appears about condition transfer requests inserted or deleted in the database or read from the database for recovery operations.

Valid Values:

• 0: No diagnostics.

• 1: Messages about database writing (insert, update, delete).

• 2: Value 1 plus database reading (recovery operations) activity.

Default: 2

Determines the number of threads dispatching updates to destinations.

Default: 1

Determines the number of seconds before GCS cleans already handled conditions from memory and the database.

Valid Values: Do not change this parameter unless instructed to do so by BMC Customer Support.

Default: 120

Determines how to handle conflicting add or delete requests for global conditions when the requests are received within the interval specified in GcDoneWaitSecs.

Valid Values:

• ALL: Handle all requests, in the order they arrived, until they are sent to all destinations.

• TOGGLE: Each time a new request conflicts with the current request, stop processing the current request and start processing the new request.

• NO_TOGGLING: Continue processing the current request and ignore all conflicting requests.

Default: TOGGLE

Determines the minimum number of seconds that global conditions wait in memory, after they have been sent to all connected data centers, before they are removed. This waiting period prevents conditions from being sent again.

Valid Values: Do not change this parameter unless instructed to do so by BMC Customer Support.

Default: 120

Maximum number of retries to send conditions to a data center that had previously returned a temporary error.

Valid Values : Do not change this parameter unless instructed to do so by BMC Customer Support.

Default: 5

Determines the number of seconds between attempts to send conditions to a data center that had previously returned a temporary error.

Valid Values: Do not change this parameter unless instructed to do so by BMC Customer Support.

Default: 180

Refresh type: Manual

Indicates whether to activate toggling policies for identical operations (like COND X ADD after COND X ADD).

Valid Values:

• 1: All operations.

• 0: For different operations (COND X DELETE after COND X ADD).

Default: 1

Determines whether to enable or disable sending XAlerts when a condition is not sent.

Valid Values:

• ON

• OFF

Default: ON

Determines the information log level for messages related to internal GCS actions involving temporary problems and rebound situations. The information appears about GCS condition handling activities.

Valid Values:

• 0: No diagnostics

• 1: Condition actions based on conflict handling policies

Default: 1

Determines the maximum number of record lines in the GCS_LOG file. When the number of record lines in the currently open GCS_LOG file reaches the value specified in this parameter, the file is closed and a new GCS_LOG file is opened.

Valid Values: Any whole number that is greater than or equal to 0. If the value is 0, the file never closes, because there is no maximum size.

Default: 15,000 KB

Determines the size of GCS maintenance thread pool.

Default: 1

Determines the maximum number of log files that are cyclically managed. When the number of GCS_LOG files reaches the value specified in this parameter, the oldest file is deleted, in order for a new GCS_LOG file to be created.

Valid Values: Any whole number that is greater than or equal to 0.

Default: 5

Default port where GCS waits for requests from clients (such as ctl commands or life check messages). This value is used only if a port has not been defined using the HostPort system parameter. Furthermore, this port is used only if it is not busy; otherwise GCS selects a free port at random.

Valid Values: Do not change this parameter unless instructed to do so by BMC Customer Support.

Default: 10,000

Determines whether to display the new Message ID in the GCS Log.

Valid Values:

• Y

• N

Default: N

Determines the number of seconds between attempts to communicate with a Gateway.

Valid Values: Do not change this parameter unless instructed to do so by BMC Customer Support.

Default: 60

Determines the size of main GCS thread pool.

Default: 2

Determines the client logger buffer size.

Default: 10

Determines the interval, in seconds, of the client logger.

Default: 3

Defines the URL of Control-D/WebAccess Server.

Valid Values: URL in the following format:

protocol://<Control-D/WebAccess Server Virtual Directory>/Control-M.html EXAMPLE: https://vw-tlv-ctm-dv22/wa/ControlM.html

Defines the Control-M Web default workspace name prefix.

You can to the workspace name an additional keyword that indicates owner name, for example Workspace_{owner}.

Default: Workspace

Determines if a flow in a folder is ordered uniquely.

A unique suffix is added to every condition name. Order as independent flow checkbox appears in the Service Ordering window. Not applicable to sub-folders.

Valid Values: Checkbox

Default: No

Determines the number of seconds before a timeout for an MFT search request.

Default: 60

Determines the number of milliseconds for long time-out calls.

Default: 180000

Defines the service rule review source.

Default: Definition,Active

For Internal Use Only

Determines the site background color.

Default: SolidBlue

Determines the values of the site background colors.

Default: SolidBlue,SolidGray,SolidBrown,SolidOrange,PatternBlue,PatternGray,PatternBrown,PatternOrange

Determines the values of site actions that are enabled.

Default: Hold Release Confirm Rerun Restart Kill Bypass ForceOK Update ArchiveSearch

Defines the site help location.

Defines the language of the site interface.

Default: English

Defines the language options of the site interface.

Vaild Values:

• English

• German

• Spanish

• French

Determines the maximum idle time, in minutes, of the web client before automatic logout.

Default: 30

Determines the interval for recalculating the status of a service.

Valid Values: Time in the format of HH:MM:SS

Default: 00:01:00

Determines the order of GSRs to connect.

Valid Values:

• 1: Connect only the GSR defined in SLA Manager command line.

• ,2: Connect the GSR defined in SLA Manager command line and the GSR defined as the backup.

• 3: Connect the GSR defined in SLA Manager command line and the GSR on the same SLA Manger host.

• 4: Connect the GSR defined in SLA Manager command line and other GSRs.

Default: 4

Determines the maximum number of records that are retrieved when you search in Changes History. To retrieve all records, use a value of 0.

Default: 10,000

Determines the maximum number of prerequisite events that are retrieved by Control-M/EM server.

Default: 10,000

Determines the maximum number of jobs which rely on a Lock Resources that are retrieved by Control-M/EM server.

Default: 100

Determines the maximum number of Lock Resources that are retrieved by Control-M/EM server.

Default: 2,000

Determines whether make the Data Assurance add-on available to Control-M users.

Determines whether to enable Simplified or Traditional Chinese as a Control-M Web language.

Valid Values:

• Simplified Chinese.

• Traditional Chinese.

Default: Empty

Determines the maximum number of folders that are retrieved by Control-M/EM server.

Default: 10,000

Determines the maximum percentage consumption of the browser memory to allow opening tabs in the application.

Default: 80

Determines the maximum number of characters in a password for login to web by LDAP users.

Default: 127

Determines the minimum number of minutes to wait for a file transfer before it is declared a long-running file transfer and added to the Long Running Transfers section in the MFT Dashboard.

Valid Values: 5–2880

Default: 15

API Parameter Name: longFileTransfersMinimumMinutes

Determines the minimum number of seconds to wait for a file transfer before it is declared a slow-running file transfer and added to the Slow Running Transfers section in the MFT Dashboard.

Default: 10

Determines a minimum file transfer speed, in kilobytes per second, under which a file transfer is declared a slow-running file transfer and added to the Slow Running Transfers section in the MFT Dashboard.

Valid Values: 5–13,1072

Default: 500

API Parameter Name: slowFileTransfersThresholdInKbps

Determines the maximum number of concurrent job action requests sent by the web client in one user execution.

Default: 100

Determines the maximum number of database field values to retrieve.

Default: 100,000

Determines the maximum time, in milliseconds, to wait for a job action response in a Viewpoint.

Default: 20000

Determines the maximum number of scheduling entities (SMART folders, subfolders, and jobs) in a workspace.

Default: 10,000

Determines the maximum number of folders in the Planning domain.

Default: 10,000

Determines the maximum number of user views.

Default: 10,000

Determines the maximum number of workspaces to maintain in the Planning domain.

Default: 10,000

Determines the maximum number of order variables retrieved by the server.

Default: 1,000

Determines the maximum number of jobs that use a quantitative resource retrieved by the server.

Default: 100

Determines the maximum number of quantitative resources retrieved by the server.

Default: 2,000

Determines the maximum number of entities in the run report that will have a link that allows the user to open a Viewpoint with this entity and its child entities.

Default: 1,000 entities.

Determines the maximum number of shared variables retrieved by the server.

Default: 2,000 variables.

Determines the Start Day of the Week when there are Control-M/Servers with different definitions of this parameter.

Default: 2 (Monday).

Defines the URL to BMC Support Central. If left empty, the Support Central option is hidden in Control-M Web.

Value: https://www.bmc.com/support/support-central.html#/dashboard

Defines the URL to BMC Support Search. The SearchValue in this URL is replaced with the real search value from the input. If left empty, the Support Search option is hidden in Control-M Web.

Value: https://www.bmc.com/support/resources/support-search.html/#q=SearchValue

Determines the maximum number of scheduling entities to load into a Viewpoint that is opened from the Workload Policies Monitor.

Default: 20,000

Determines whether to display dependencies raised by On Do actions.

Default: true

Determines the number of days to keep approved requests data in the Control-M/EM database.

Valid Values: 0–28 days.

Default: 14 days.

API Parameter Name: approvedRequestsRetentionTimeDays

Determines the site background color.

Default: SolidBlue

Determines the site background color values.

Default: SolidBlue,SolidGray,SolidBrown,SolidOrange,PatternBlue,PatternGray,PatternBrown,PatternOrange

Defines the time allowed for an inactive session on the WCM UI before the server denies the connection and login is required.

Default: 10

Determines the maximum number of seconds for a job flow to check-in or synchronize before connection timeout. The following error message is displayed:

Connection timeout, please check your request status in the Home page.

Default: 60 seconds

Defines the location of your organization logo that is displayed in the Control-M Workload Change Manager login page.

Enables the Control-M Workload Change Manager web user to check-in a job flow without having to submit a request to the Control-M Scheduler. If enabled, a Check In button appears in the Control-M Workload Change Manager web application.

Defines the template for the email Subject field that is sent to the end users after the request state changes.

Valid Values:

• Returned

• Approved

Default: Your request <REQUEST_NAME> for Ticket ID <CHANGE_ID> has been <ACTION>.

Defines the location of your organization logo that is displayed in the Control-M Workload Change Manager interface.

Determines one of the following as the default language for the Control-M Workload Change Manager interface for all users:

• English

• German

• French

Default: English

API Parameter Name: siteInterfaceLanguage

Determines the number of retries to terminate the Web server defined in the TimeWindowTerminatingWebserver setting.

Default: 1

Determines whether to avoid ldap.conf file synchronization between primary and distributed Control-M/EM environments.

Default: 0

Some Control-M/EM components, such as the GUI Server, the Gateways, and the Global Conditions Server, operate hidden from the user. These components can be displayed in command prompt windows by setting this parameter to 1, stopping the Configuration Agent, and restarting the agent.

Valid Values:

• 0

• 1

Default: 0

Determines the number of consecutive failed activations before the component commreg record is deleted.

Default: 6

Determines the default size limit in KB that is read from the output file

Default: 100

Determines maximum size in KB that you can set forDiagOutputBufferSizeDefaultKB.

Default: 100

Determines the number of minutes to wait for a manual Failover or Fallback before a timeout.

Default: 5

Determines the number of consecutive life check requests to the database server without getting a response.

Default: 3

(PostgreSQL only) Determines the number of unsuccessful attempts that Configuration Agent tries to start up the database server.

Default: 20

(PostgreSQL only) Determines the number of seconds to wait after the Configuration Agent started up the database server.

Default:10

Determines the number of consecutive failed life check requests between the Configuration Agent and the Control-M/EM components before the Configuration Agent tries to start it up.

Default: 3

Determines the number of unsuccessful attempts that the Configuration Agent tries to start up a component and then crashes.

Default: 50

Determines the number of seconds to wait between sending life check requests to the primary Configuration Agent.

Default: 15

Determines the number of seconds to wait after the Configuration Agent started up a component.

Default: 180

Interval, in minutes, between LogReg log cleaning operations by the Configuration Agent.

Valid Values: Any whole number greater than 0.

Default: 360

Amount of detail the clean operation erases from the LogReg log.

Valid Values:

• 0: No deletion.

• 1: Cleans only the Agent log messages.

• 2: Cleans all log messages.

Default: 1

Number of days that log entries are retained before they can be cleaned from the log.

Valid Values: Minimum of 0.

Default: 1

Level of detail in LogReg log entries recorded by the Configuration Agent.

Valid Values:

• 0: No entry.

• 1: Configuration Agent-related messages.

• 2: Brief component and agent related messages.

• 3: Detailed component and agent related messages.

Default: 2

Valid Values: Maximum number of times that the Configuration Agent can attempt to create a socket.

Default: -1 (no limit).

Interval, in seconds between successive attempts to create a socket.

Valid Values: Any whole number greater than 0.

Default: 10

Level of detail in standard output messages reported by the Configuration Agent.

Valid Values:

• 0: No entry.

• 1: Configuration Agent-related messages.

• 2: Brief component and Agent-related messages.

• 3: Detailed component and Agent-related messages.

Default: 2

Time, in seconds, that a component is given to shut down following a Stop command. When this time is exceeded, the Configuration Agent again tries to stop the component. If the number of retries specified by the StopTries parameter is exceeded, the agent kills the component.

Valid Values: Any whole number greater than 0.

Default: 45

Number of times that the Configuration Agent tries to stop the component using the Stop command before performing a kill operation.

Valid Values: Minimum of 1.

Default: 2

Determines the number of seconds for the Configuration Agent to wait between each check action of a configuration file for changes to update in the database.

Default: 3,600

Determines restrictions that prevent unnecessary job runs.

Valid Values:

• Default_Selected_jobs: Sets the Selected Jobs as the default value in the Jobs field in the Order dialog box.

• Order_confirmation: Displays a confirmation window when you run a job.

• Perceive_scheduling_Criteria: Changes the default behavior of the Ignore Scheduling Criteria checkbox to not selected. (Deprecated)

• Default_Run_Scheduling_Criteria: Clears the Ignore Scheduling Criteria checkbox, by default, in the Run Workspace and Run Selected Jobs/Folders dialog boxes when you run a job or Workspace.

• Force_Run_with_Hold: Selects the Hold - Put the Folder/Job on Hold checkbox, by default, in the Run Workspace and Run Selected Jobs/Folders dialog boxes when you run a job or Workspace.

  This setting overrides the OrderForceWithHoldAlwaysOn parameter.

(For Customer Support use only) Control-M/EM and Control-M/Server wait for acknowledgment from the CORBA Object Request Broker (ORB) before shutting it down.

Valid Values:

• 0 (No): Control-M/EM and Control-M/Server do not wait for confirmation that the ORB was shut down.

• 1 (Yes): Control-M/EM and Control-M/Server wait for confirmation that the ORB was shut down.

Default: 1

Sets the Hold option in the Order/Force window to always selected and ignores the last user selection.

Default: 0

(For Customer Support use only) Number of GUI Server commands that Control-M/EM can process at a time for each Viewpoint. These commands include submitting, adding, and updating jobs, and making refresh requests.

Default: 1

(For Customer Support use only) Number of GUI Server commands Control-M/EM can process at a time. These commands are not related to specific Viewpoints and include displaying pop-up windows and task bar messages in the Control-M window.

Default: 10

(For Customer Support use only) Number of GUI Server commands Control-M/EM can process at a time for all Viewpoints. These commands include submitting jobs, adding jobs, updating jobs, and refresh requests.

Default: 10

Determines whether to show a host or host group for dummy jobs.

Default: 0

Determines whether a user can change their own password.

Valid Values:

• 0: Only users who have Full or Update permissions to modify security definitions can change their own password.

• 1: All users can change their own password.

Default: 1

Enables you to check in your Workspace with validation errors.

Valid Values:

• Y

• N

Default: N

Determines the number of days to retain the report on the Control-M/EM server.

Default: 10

Determines the number of rows that appear in the preview report.

Default: 25

Indicates if users with Browse access can order or force jobs.

Valid Values:

• UPDATE_ACCESS: Only users with Update access can order or force a job.

• BROWSE_ACCESS: Users with Browse access or Update access can order and force jobs.

Default: UPDATE_ACCESS

Chunk size of jobs during Viewpoint opening.

Default: 1,000

Determines if the GUI Server exposes the Alerts management interface.

Default: 1

Determines the frequency, in seconds, that Global Alerts updates its database about which Alerts were deleted and why. The update occurs only when both the specified time has passed and one or more alerts have been deleted.

Default: 60

Determines the maximum number of alerts that are loaded into memory.

Default: 300000

Indicates whether Available Values options are displayed for certain fields in the Properties Pane.

Default: 1 (On)

Determines whether to allow or prevent users from creating and modifying reference sub-folders.

Valid Values:

• true: Allow creation or modification of reference sub-folders.

• false: Do not allow creation or modification of reference sub-folders.

Default: true

API Parameter Name: allowReferencePath

Default: 2

Determines whether a lenient, strict, or very strict security policy is enforced when jobs are checked in. Control-M security uses the Created By (author) job attribute and the AuthorSecurity system parameter to ensure that only authorized users can check in jobs.

Valid Values:

• 1 (Lenient): The value of the Created By job attribute is automatically set to the current username, and no system confirmation messages appear.

• 2 (Strict): The user is given a choice whether to change the Created By job attribute from the original username to the current username.

• 3 (Very Strict): The value of the Created By (author) job attribute must be set to the current username in order to check in. A prompt appears warning the user that they must make this change to check in unless prompts have been disabled.

Default: 1

Determines the bulk size in bulk operation for retrieve conditions.

Valid Values: 10–10,000

Default: 250

Determines the bulk size in bulk operation for retrieve tables.

Valid Values: 10–10,000

Default: 100

Determines the bulk size in bulk operation for retrieve jobs.

Default: 250

Determines the bulk size in bulk operation to retrieve control or quantitative resources.

Valid Values: 10–10000

Default: 50

Determines the bulk size in bulk operation to retrieve SLA Manager (BIM) services for a job.

Default: 100

Determines whether to apply an order authorizations check on Do Force job statements when creating or modifying a job definition.

Valid Values:

• true

• false

Default: false

API Parameter Name: checkDoForceJobAuthorizations

Determines the number of collections that can be read in parallel.

If set to 1, collections are read serially. Increasing this number improves response time but may use more CPU resources.

After modifying this parameter, stop and restart all GUI Server components for the change to take effect.

Valid Values: 1–10

Default: 4

Determines the maximum number of control resources that can be loaded into memory from the Control-M/EM database at the same time. This parameter can help control memory usage. However, if this parameter is set to -1, there is no maximum limit.

Default: -1

Determines the number of seconds before the GUI Server begins processing the pin_collection.ini file.

Default: 10

Determines the number of jobs in the Active Jobs database that are checked by the GUI Server when processing the request_act_retrieve_jobs request, and included in the request response.

Valid Values: from 10 to -1 (unlimited)

Default: 1,000

Determines the Java memory size for GSA.

Default: 0 (calculates the size automatically)

Determines whether control resources are (0) or are not (1) downloaded from the database when retrieving collections. If unneeded control resources are not downloaded, memory requirements are reduced and response time is improved.

Valid Values:

• 0: Do not exclude control resources.

• 1: Exclude control resources.

Default: 0

Determines whether quantitative resources are downloaded from the database when retrieving collections. If unneeded quantitative resources are not downloaded, memory requirements are reduced and response time is improved.

Control-M users cannot perform a find or query on excluded quantitative resources. After modifying this parameter, stop and restart all GUI Server components for the change to take effect.

Valid Values:

• 0: Do not exclude quantitative resources.

• 1: Exclude quantitative resources.

Default: 0

Identifies fields (database columns) that should not be downloaded from the database when retrieving collections, thereby decreasing memory load and improving response time.

Any or all of the following fields can be excluded. Use spaces, commas, colons, or semicolons to separate multiple entries.

Valid Values:

• Database Column: Description

• MAX_WAIT: Maximum Wait

• ODATE: Order date

• OWNER: Owner

• DESCRIPTION: Description

• CPU_ID: Host ID

Default: null (no fields are excluded)

Determines the time, in seconds, until the GUI Server checks the communication status of the database server. If communication is still down, communication is considered to be disrupted and the action specified in StopIfDBConnectionFail is implemented.

Valid Values: 1–60

Default: 5

Determines the maximum number of bytes buffered in the GUI server waiting to be sent to Control-M/Server, such as a result of a Save JCL request.

Warning: Do not change this parameter unless instructed to do so by BMC Customer Support.

Default: 500,000

Determines the maximum number of archive jobs in memory per GUI Server.

Default: 40,000

Determines the queue size limit to playback the archive net.

Default: 60000

Determines the default number of days for an MFT search.

Each day is 24 hours

Default: 1

Determines the number of threads that execute MFT requests.

Default: 30

Determines the maximum number of File Transfer records returned for an MFT search.

Default: 1000

Determines the mode for an MFT search.

Valid Values:

• CACHE: Perform an MFT search in the memory.

• SQL: Perform an MFT search in the database.

Default: CACHE

Determines the maximum number of alerts sent to a client in a single call.

Default: 2000

Determines the time, in seconds, that a Control-M/EM API client user token can be valid. Afterwards, the GUI Server can invalidate the token.

Default: 10,800

Determines the maximum number of concurrent sessions per user in Control-M client and Control-M Web.

Determines the total number of job hosts that are displayed when Local View is used. For information about Local View, see Alerts Monitor.

Valid Values: 2-30,000

Default: 100

Defines a script that runs when a promotion request is checked in.

Determines whether data other than All Jobs are created from memory or collected from the database.

Valid Values:

• 0: Collect from the database.

• 1: Create from memory.

Default: 1

Determines whether the All Jobs collection is loaded and pinned when the GUI Server starts up.

Valid Values:

• 0: The All Jobs collection is not loaded and pinned when the GUI Server starts up.

• 1: The All Jobs collection is loaded and pinned when the GUI Server starts up.

Default: 1

Determines the maximum number of prerequisite events (conditions) that can be loaded into memory from the Control-M/EM database at the same time. This parameter helps control memory usage. When PrereqConditionsLoadLimit is -1, there is no maximum limit.

Default: 1

Determines the maximum number of quantitative resources that can be loaded into memory from the Control-M/EM database at the same time. This parameter helps control memory usage. When QuantResourceLoadLimit is -1, there is no maximum limit.

Default: 1

Determines the collection of jobs to include in the Network Neighborhood Collection.

Valid Values:

• CURRENT: The collection of jobs in the Viewpoint from which the user opened the Network Neighborhood.

• All Jobs: The collection includes all jobs, not only the jobs in the current Viewpoint.

Default: CURRENT

Determines how a Remedy ticket is closed, and what effect that has on the alert status.

Valid Values:

• HANDLE_ON_CLOSE: The alert status is updated to Handled automatically when the ticket is closed.

• CLOSE_ON_HANDLE: When the alert status is Handled, the ticket is automatically closed.

• BIDIRECTION_CLOSE_HANDLE: Either an alert becoming Handled closes a ticket, or closing a ticket causes the alert status to be Handled.

• SEPERATE_CLOSE_HANDLE: Close and Handle are two separate actions that do not affect each other.

Default: HANDLE_ON_CLOSE

Determines the maximum number of parts in the SQL criteria.

Default: 30

Determines if the GUI Server is in Secure mode. If the GUI Server is in Secure mode, user requests to view or modify fields that are included in the Security filter of a Viewpoint are rejected.

Warning: BMC Software recommends that you not exclude data (change the value of this parameter to 1) without first consulting BMC Customer Support.

Valid Values:

• 0: The GUI Server is not in Secure mode; it prompts the user for confirmation whether to continue processing the request.

• 1: The GUI Server is in Secure mode; it denies the request because opening any Viewpoint might involve a security breach. The user cannot open any Viewpoint until the Authorization Filter for the user is changed by the system administrator so that it no longer contains excluded fields.

If the GUI Server prompts for confirmation, carefully consider the following factors before confirming the request:

• If a Viewpoint hierarchy definition contains an excluded field, the Viewpoint groups the jobs as if they all have the same empty value ("") and the hierarchy is incorrect.

• If a Collection, Filter, or User Authorization filter contains criteria that match excluded fields, a match is assumed for those filtering criteria, yielding unwanted filtering results.

• If a User Authorization filter includes only jobs for which the user is the owner, but Owner is an excluded field, then a match on Owner is assumed for every job in the Active Jobs database. This could cause every job in the Active Jobs database to be loaded (if there are no other exclusion criteria).

Default: 0

Defines a script that runs when a promotion request is checked in.

Determines the BSM Service cache refresh interval.

Default: 15

Determines the maximum number of times that the GUI Server can attempt to create a socket.

Default: -1 (no limit)

Determines the interval, in seconds between successive attempts to create a socket.

Default: 10

Determines the interval, in seconds, between attempts by the Global Alerts Server to confirm that communication with the database server is not disrupted.

Default: 60

Determines the action to take if communication between the GUI Server and the database server is disrupted.

Valid Values:

0: The GUI Server is shut down until communication with the database server is restored. When communication is restored, the Configuration Agent restarts the GUI Server.

1: The GUI Server remains operational. However, its status is Warning (as displayed in the Control-M Web) and it may not function.

Default: 0

Determines the cache refresh interval for the Control-M/EM server topology.

Determines the default size of the updates queue for a Viewpoint.

Default: 5,000

Determines the maximum possible size of the updates queue for a Viewpoint.

Default:60,000

Determines the collection of jobs to be searched when performing a find from within a Viewpoint screen.

Valid Values:

• 1 (Yes) : When performing a find from within a Viewpoint, limit the search to jobs that satisfy the QueriedCollection system parameter.

• 0 (No) : Perform the search using all jobs.

Default: 1

Determines the ViewPoint Search method.

Valid Values:

• 0: Scan collection

• 1:Scan VB content

• 2: Scan a copy of VB content

Default: 1

Determines the number of milliseconds when the Control-M/EM GUI Server receive a reply from the SLA Manager after it sends a request.

Default: 600,000

Determines which SMART Folders are passed to the Viewpoint.

Valid Values:

• SELECT_JOBS: Filtering criteria are applied only to the jobs. Only jobs satisfying the filtering criteria, and only SMART Folders containing at least one such job, are passed and displayed. (No empty folders are passed.)

• SELECT_JOBS_AND_SG: Filtering criteria are applied both to jobs and SMART Folders. In addition to passing the same jobs and SMART Folders that are passed for the SELECT_JOBS value, the Server also passes any SMART Folders that match the filtering criteria (and pass the security criteria) even if they are empty.

Default: SELECT_JOBS

API Parameter Name: viewpointSmartFolderPolicy

Determines the Viewpoint handler buffer cache size.

Default: 30

Determines the weight limit of the queue size to pull Viewpoints.

Default: 30000

Determines the size of the data to send over a single pull call for a Viewpoint.

Default: 2000

Determines the weight limit to push a Viewpoint queue before it is flushed.

Default: 10

Valid Values: Any whole number that is greater than or equal to 20.

Determines the refresh interval, in seconds, for collecting host group data.

Valid Values: 0–10,000 (0: Host Group data is not collected.)

Default: 900

Determines the number of seconds between each refresh episode.

The Configuration Management Server (CMS) refreshes the status and topology of the Control-M/Servers on a regular basis.

Valid Values: Any whole number that is greater than or equal to 30.

Default: 60

Determines the number of seconds between each refresh episode.

The CMS refreshes its internal image of Control-M/EM component status on a regular basis.

Valid Values: Any whole number that is greater than or equal to 30.

Default: 30

Determines how the Configuration Management Server connects to the Control-M/Server Configuration Agent.

Valid Values:

• TCP: A non-secure connection is established.

• SSL: Connect using SSL only.

• Auto: The system automatically detects the type of connection that is established.

Default: TCP

Determines the number of times every 24 hours to send internal requests to obtain host specification (used for MANAGED Servers report).

Default: 60

Determines the maximum size in KB of stdout and stderr that is read from the pluggable request .

Default: 100

Defines the hostname or IP address where the CMS is forced to receive XAlerts.

Valid Values: Any valid hostname or IP address.

Default: null

Determines the port where XAlerts are received.

Valid Values: Any valid port.

Default: 0

Determines the number of seconds to wait to before checking the database space usage.

Default: 36,000

Determines the maximum percentage of allowed database space use.

Default: 90

Determines the chunk size of centralized connection profile records to update in a single command during a long synchronization process.

Default: 100

Determines the number of centralized connection profiles to be sent in one chunk to Control-M/Server.

Default: 50

Determines the maximum number of tries to send a centralized connection profile to Control-M/Server.

Default: 3

Determines the wait time interval, in seconds, before a centralized connection profile is resent to Control-M/Server.

Default: 15

Determines the interval, in seconds, before unsynchronized centralized connection profiles are periodically synchronized with Control-M/Server.

Default: 900

Determines the interval, in minutes, before all centralized connection profiles are periodically synchronized with Control-M/Server.

Default: 0

Determines the time-out interval, in seconds, to wait for a chunk response before the next chunk of centralized connection profiles are sent to Control-M/Server.

Default: 30

Determines the number of seconds to wait for a response from the Agent before a timeout occurs for the Get_diag_output request

Default: 30

Determines the number of seconds that the failover or fallback progress information is available after the process completes.

Default: 604,800

Determines whether handled alerts are sent as an SNMP trap or to a script.

Valid Values:

• 1: Handled alerts are sent as an SNMP trap and to a script.

• 0: Handled alerts are not sent as an SNMP trap and to a script.

Default: 0

Determines whether the MESSAGE field is used to compare identical alerts.

Valid Values:

• 1: Compare the MESSAGE field.

• 0: Do not compare the MESSAGE field.

Default: 0

Determines whether identical alerts are sent as an SNMP trap or to a script.

Valid Values:

• 1: Identical alerts are sent as an SNMP trap and to a script.

• 0: Identical alerts are not sent as an SNMP trap and to a script.

Default: 0

Determines the interval, in minutes, within which an alert is defined as identical to a previous matching alert.

Valid Values: Any whole number that is greater than or equal to 0.

Default: 30 minutes

Determines the maximum number of exception alerts sent from the CMS to the Exception Alerts window.

Default: 2,000

Determines the interval, in minutes, to check JVM memory alerts.

Default: 2

Determines whether JVM memory alerts are enabled.

Valid Values:

• 0: Disabled

• 1: Enabled

Default: 1

Determines the database maintenance interval, in minutes.

Default: 60

Determines whether to periodically perform database maintenance.

Valid Values:

• 0: Disabled

• 1: Enabled

Default: 1

Determines the amount of time, in seconds, that the CMS waits for a reply to a remote request sent via the CMS to the Control-M/Server, Agent, and plug-ins, before it times out.

An example of such a request is a ping agent request.

Valid Values: Any whole number that is greater than or equal to 30.

Default: 300

Determines the number of days to retain deleted statistics, after which the statistics will be deleted when automatic purge is performed.

Valid Values: Any whole number that is greater than or equal to 1.

Default: 100

Determines the number of minutes between activations of automatic purging of periodic statistics by the CMS.

Valid Values: Any whole number that is greater than or equal to 1.

Default: 30

Determines whether Usage Alerts are enabled.

Valid Values:

• 0: Disabled

• 1: Enabled

Default: 0

Determines whether to automatically activate the usage collection tool.

Valid Values:

• 0: Enabled

• 1: Disabled

Default: 0

Determines the number of minutes between activations of automatic job history cleanup by the CMS.

Valid Values: Any whole number that is greater than or equal to 30.

Default: 30

Determines the number of days after which the history of the current jobs is automatically deleted.

Valid Values: Any whole number that is greater than or equal to 0.

Default: 180

Determines the number of days to retain deleted jobs and their history. Deleted tables will also be deleted according to this value.

Valid Values: Any whole number that is greater than or equal to 1.

Default: 180

Defines the message IDs for which no XAlerts are sent. By default, no message IDs are listed. Use a comma to separate multiple message IDs.

Default: none

Determines the number of days that XAlerts are saved before they are deleted by the Configuration Management Server.

Valid Values: Any whole number that is greater than or equal to 0.

Default: 180 days

Determines the maximum number of handled XAlerts that are displayed in the Exception Alerts window.

Valid Values: Any whole number that is greater than or equal to 0.

Default: 100

Determines the severity level filter. XAlerts with a value greater than or equal to the specified severity level are sent to the Exception Alerts window.

Valid Values:

• Warning

• Error

• Severe

Default: Warning

Defines the pathname and filename of the script to be sent. This parameter is used only when the XAlertsSendSnmp system parameter is set to 2 or 3.

Valid Values: Any pathname and filename.

Default: null

Defines the hostnames of the machines to which you want to send the SNMP trap.

Valid Values: Any hostname or IP address. Separate multiple hosts with a semicolon. To add a specific port for each host, enter the hostname followed by a colon and the port number.

Default: null

Determines whether you can add external or orphan events.

Manual events are specified as In Conditions for jobs but do not exist at the time SLA Manager estimates the completion time of the services and jobs. This may be because:

• The job relies on an event from a previous day.

• The job relies on an event that must be manually added.

Valid Values:

• 0: Does not add events.

• 1: Add events at New Day.

• 2: Add events at the average start time of the first job waiting for the event.

Default: 2

Determines whether to ignore delete events if they are needed by other jobs and there are no other jobs that add them.

Valid Values:

• 0: All delete events are performed.

• 1: Delete events are not performed if there are no jobs in the same Control-M.

• 2: Delete events are not performed if there are no jobs in all Control-M/Servers.

• 4: Almost all delete events are ignored.

Default: 0

Determines whether the SLA Manager consolidates email alerts, BMC Remedy ITSM incidents, and shout messages.

Valid Values:

• 0: Disables consolidation.

• 1: Alerts are consolidated in one line with some exceptions regarding alerts recorded in separated lines and or with added spaces.

• 2: Alerts are consolidated with a space between the message text for each service.

Default: 1

Determines whether non-administrator-level users can view service reports Control-M Web.

Valid Values: 0–1

Default: 0

The username that SLA Manager uses when connecting to Control-M/EM.

Valid Values: bimuser

Default: bimuser

GUI Servers to use in case there is a problem with the primary GUI Server (as indicated in the Control-M Configuration Manager). The value of this parameter can be one or more GUI Servers, separated by commas.

Valid Values: String expression.

Defines the number of days of active conditions that SLA Manager loads for service calculations.

Valid Values: Any integer, 1 or greater.

Default: 7 days

The delay, in seconds, SLA Manager waits before reconnecting to the Control-M/EM GUI Server, if the connection has failed.

Valid Values: Any whole number greater than or equal to 1.

Default: 30

Determines the format for dates displayed in SLA Manager alert messages.

Valid Values: DD/MM and MM/DD.

Default: DD/MM

API Parameter Name: dateFormat

Average run time for jobs with no statistics. In the format HH:MM. This value is often used if no statistics are available.

Valid Values: Time in the format of HH:MM.

Default: 00:05

Interval at which SLA Manager checks for problems in the service.

Valid Values: Time in the format of HH:MM:SS.

Default: 00:01:00

Ignores missing events if related to an OR event.

Valid Values:

• 0: Add all events.

• 1: Ignore OR events if missing.

Default: 1

Valid Values: Email address that sends alerts.

Default: bim@bmc.com

Defines the email server and port that sends alert notification emails.

This value must be set after installation.

Format: <server host>[:<port number>]

Default: mail

If the port is not specified, the default is 25.

Defines the email server JAVAMAIL properties file.

Default: mail.properties

Enables you to execute jobs that are waiting for confirmation.

Valid Values:

• 0: Do not execute jobs.

• 1: Execute at New Day.

• 2: Execute at the average start time of the job.

Default: 0

Determines the maximum number of times the SLA Manager Server should reconnect to the Control-M/EM GUI Server, if this connection repeatedly fails.

This parameter is reset by the FailoverMinUptime parameter.

Valid Values: Any whole number greater than or equal to 1.

Default: 10

Determines the amount of time that the SLA Manager Server must be connected to the Control-M/EM GUI Server, before the counter used by the FailoverMaxRetry parameter is reset to zero. For example, if this value is 30 minutes and the connection is maintained for more than 30 minutes, the counter is reset.

Valid Values: Time in the format of HH:MM:SS

Default: 00:30:00

Determines the order of GSRs to connect.

Valid Values:

• 1: Only include the GSR defined in the SLA Manager command line.

• 2: Include GSR defined as a backup.

• 3: Include GSR on the same host of the SLA Manager.

• 4: Include other GSRs.

Default: 4

Determines the field to identify a job in Control-M.

SLA Manager uses this parameter when it processes the PROBLEMATIC-JOBS auto-edit variable.

Valid Values:

• JOBNAME/MEMNAME: Search according to the name of the job or the member.

• JOBNAME: Search according to the name of the job.

• MEMNAME: Search according to the name of the member.

Default: JOBNAME/MEMNAME

Defines the correction message of a problematic service that has become OK.

Valid Values: String expression.

Maximum number of threads for recalculating the Service status.

Valid Values: Any whole number greater than or equal to 1.

Default: 2

Determines the maximum number of Analysis Viewpoints with What-If scenarios that can be opened simultaneously.

Default: 3

Determines the number of days to simulate services runs to calculate estimated end times.

Each additional day takes more CPU time during the calculation process.

Valid Values: Any whole number greater than or equal to 1.

Default: 2

Determines the minimum interval, in seconds, between jobs reported as the gap.

Default: 60

Determines the interval at which SLA Manager checks if new jobs are added to the critical service.

Valid Values: Time in the format HH:MM:SS.

Default: 00:01:00

Determines the number of days to keep report data in the database to generate reports about services.

Valid Values: The number of days greater than or equal to 1.

Default: 90

Determines whether the parameter PrevDaysOrphanConditions is for cyclic jobs or for all jobs.

Valid Values:

• 0: All jobs are affected by PrevDaysOrphanConditions.

• 1: Only cyclic jobs are affected by PrevDaysOrphanConditions.

Default: 0

Determines the number of previous ODATs not to raise Orphan events.

Valid Values:

• 0: All jobs from all ODATs are submitted in the Simulation by SLA Manager.

• 1: All Orphan events, that the jobs waiting for this event are of an ODAT that is 1 day or more prior to the Control-M/Server ODAT, will not be raised. The jobs waiting for this event will not run.

Default: 0

Determines whether to send the correction message or not.

Valid Values:

• 0: Do not send

• 1: Send

Default: 1

Determines whether to ignore the process to change cyclic jobs to regular jobs during simulation.

Valid Values:

• 0: Do not activate.

• 1: Change all cyclic jobs to regular jobs, as if all cyclic jobs have a On Do Stop Cyclic.

Default: 0

Determines the number of seconds for a SLA Manager simulation step.

Valid Values:

• 10

• 20

• 30

• 60

Default: 10

Determines whether load balancing of quantitative resources is supported.

Valid Values:

• 0: Not supported

• 1: Supported

Default: 1

Determines whether to add external or orphan conditions (events).

Such conditions are conditions that are specified as in conditions for jobs but will not exist at the time Control-M Forecast generates its forecast. This may be because:

• The job relies on a condition from a previous day. (Forecasts are only generated for a specific day.)

• The job relies on a condition that has to be manually added or removed.

Valid Values:

• 0: Do not add conditions

• 1: Add conditions at New Day.

• 2: Conditions are added at the average start time of the first job waiting for the condition.

Default: 2

API Parameter Name: addOrphanEvents

Ignores delete conditions if needed by other jobs and there are no other jobs that add them.

Valid Values:

• 0: All delete conditions are performed.

• 1: Delete conditions are not performed if there are no jobs in the same Control-M.

• 2: Delete conditions are not performed if there are no jobs in all Control-M/Servers.

• 4: Almost all delete conditions are ignored.

Default: 0

Determines whether the drop-down lists of available values are displayed for fields in the What-If event definition dialog boxes.

Valid Values:

• 0: Drop-down lists are not displayed.

• 1: Drop-down lists are displayed.

Default: 1

Ignores missing conditions if it relates to an OR condition.

Valid Values:

• 0: Add all conditions

• 1: Ignore OR conditions if missing.

Default: 1

Determines the Control-M/Server start of day time in the Control-M Forecast domain. This parameter is relevant for all jobs that do not have From time defined and are scheduled to run when they are ordered.

Valid Values:

• ctm_new_day

• midnight (00:00)

Default: ctm_new_day

Enables you to execute jobs that are waiting for confirmation.

Valid Values:

• 0: Do not execute jobs.

• 1: Execute at New Day.

• 2: Execute at the job’s average start time.

Default: 0

API Parameter Name: executeConfirmedJobs

Determines the maximum number of jobs that can be simulated by the Forecast Server for all requests.

Valid Values: 1 or higher.

Default: 200,000

Maximum number of Forecast requests that can run simultaneously.

Valid Values: The number of forecasts requested greater than or equal to 1.

Default: 5

Number of days to simulate the running of the services to calculate estimated end times. Each additional day takes more CPU time during the calculation process.

Valid Values: The number of days greater than or equal to 1.

Default: 2

Determines the minimum number of jobs in the Control-M/EM definition database for the PerformanceFilter parameter and for a confirmation message in the client.

Default: 100000

Determines whether to forecast only Control-M/Servers in the filter.

Valid Values:

• 0: Disable

• 1: Forecast only Control-M/Servers that are included if the filter is for folders

• 2: Forecast only Control-M/Servers that are included in any filter

• 3 : Forecast only Control-M/Servers that are included in any filter if the flag of ignoreGlobalConditions is checked.

  Options 1, 2, and 3 are activated only if number of jobs in definition is larger than the MinDefSizeForConfirmMsg parameter. Global events are based on statistics.

Default: 2

Maximum size (in KB) of the XML files that hold forecast What-If scenarios.

Valid Values: The number of KB greater than 1.

Default: 64

Determines whether to ignore cyclic jobs during simulation.

Valid Values:

• 0: Deactivate.

• 1: Change all cyclic jobs to regular jobs as if all cyclic jobs have an On Do Stop Cyclic.

Default: 0

Interval, in seconds, the simulation advances its calculation of the estimated end time.

Valid Values:

• 1: Improves accuracy

• 10: Default:

• 60: Improves performance

Valid Values: Maximum number of times that the Configuration Agent can attempt to create a socket.

Default: -1 (no limit)

Interval, in seconds between successive attempts to create a socket.

Valid Values: Any whole number greater than 0.

Default: 10

Determines if load balancing of quantitative resources is supported.

Valid Values:

0: Not supported

1: Supported

Default: 1

Add conditions created by On Do Actions.

Valid Values:

• 0: Do not add conditions

• 1: Add only added conditions

• 2: Add added and deleted conditions

Default: 1

Regular expression that identifies Command-type jobs that use the ctmudly user daily job to order tables. If the command specified in the Command field in a job editing form matches the expression, Control-M/Forecast assumes that the job uses ctmudly.

Valid Values: <string expression>

Default: ^.*ctmudly[^ ]*

Regular expression that identifies Job-type jobs that use a particular user daily job (usually ctmudly) to order tables. If the name specified in the File Name field in a job editing form matches the expression, Control-M/Forecast assumes that the job uses the user daily.

Valid Values: <string expression>

Default: ^.*ctmudly.*

Numeric suffix of the AutoEdit variable, %%PARAMn, which contains the name of the user daily. For example, if this system parameter is set to 2, Control-M Forecast reads the name of the user daily from %%PARAM2.

Valid Values: Any whole number greater than or equal to 1.

Default: 1

Sets the minimum chunk size for jobs when generating the forecast.

Valid Values: The number of jobs greater than or equal to 1.

Default: 1,000

Determines the last time the Workload Archiving Server read data from Control-M/EM.

Determines the number of days to keep Archive data on the Workload Archiving Server before it is removed.

Default: 30

Sets the maximum number of jobs to return in response to an archive search.

Default: 10,000

Valid Values: 1–10,000

Defines the name of the Archive user that connects from the Workload Archiving Server to Control-M/EM.

Default: arcuser

Determines how many job and resource details the Gateway should load into memory at a time before saving the entities in the Control-M/EM database when performing a download from Control-M. A larger number causes the download to occur faster and more efficiently, at the expense of virtual memory.

Valid Values: Any whole number that is greater than or equal to 10.

Default: 100

Determines how the new Gateway handles multiple Gateway instances for the same Control-M installation if all attempts to stop and kill the original Gateway are unsuccessful.

Valid Values:

• Y: Both Gateway occurrences are allowed to run concurrently. This is not recommended.

• N: The original Gateway continues in its "hung" state. The new Gateway stops running.

Default: N

These parameters indicate the bulk size being used by the database access layer during bulk insert and choose SQL operation. Larger numbers cause the insert and choose SQL operations to occur faster and more efficiently, at the expense of virtual memory.

Valid Values: Any whole number that is greater than or equal to 10.

Defaults:

• dal_select_min_bulksize: 10

• dal_select_max_bulksize:

• Oracle: 50

• MSSQL: 20

• dal_insert_min_bulksize: 10

• dal_insert_max_bulksize:

• Oracle: 100

• MSSQL: 10

Determines how the Gateway opens communication connections.

Valid Values:

• 1: The Gateway establishes connections in blocking mode.

• 2: The Gateway establishes connections in non-blocking mode.

Determines the timeout period, in seconds, for determining if the original Gateway is responsive (up).

Valid Values: Any whole number that is greater or equal to 20.

Default: 45

Determines whether a new Gateway stops or kills existing Gateway instances for the same Control-M installation.

Valid Values:

• Y: The new Gateway tries to kill the original Gateway and, if successful, continues to run. If the original Gateway cannot be killed, the new Gateway handles the original Gateway according to the continue_not_responding parameter.

• N: The new Gateway tries to stop the original Gateway (using the ctl utility) and, if successful, continues to run. If the original Gateway is not stopped after 3 attempts, the new Gateway handles the original Gateway according to the continue_not_responding parameter.

Default: N

If a Gateway is in non-block mode and part of a message is not received during the number of seconds specified in this parameter, the Gateway assumes communication is down.

Default: 40. This parameter is relevant only if the useNonBlock parameter is set to Y.