Configuring Control-M/EM System Parameters

This procedure describes how to define Control-M/EM system parameters in the CCM.

You can also set parameter values using Control-M Automation API, as described in Control-M/EM System Settings Configuration. Parameter names that differ in the API are indicated on this page where relevant.

Begin

  1. From the Components Tree pane, select the Control-M/EM component and from the Home tab, in the Definitions group, click System Parameters.

    The Control-M/EM System Parameters dialog box appears.

  2. In the left pane, click Advanced.

  3. From the system parameters table, filter for the required parameter from one of the following column headings:

    • Type

    • Name

    • Description

    • Value

    • Default Value

    • Refresh Type

      • Automatic: Automatically refreshes the component. In general, an Automatic parameter is called by a utility, which accesses the current value each time it runs.

      • Recycle: You need to recycle (stop and restart) the component (for example, Control-M/Server) for the change to take effect.

      • Manual: You need to perform an action that refreshes the parameter value (with no need for recycling the component).

    • Last Updated

  4. Double-click the required parameter.

    The Control-M/EM - Update System Parameter dialog box appears.

  5. In the Value field, change the value of the parameter, as required, and then click Save.

    You can use the Type, Name, and Host fields for specific components running on a specific computer.

    BIM Name:BIM1 Host:HH12

    The Control-M/EM system parameter is defined.

Defining Audit and Annotation Parameters

This procedure describes how to define Audit and Annotation parameters, which determines the user categories that are audited in the Control-M/EM database each time an audited action occurs. For each audited action, you can define whether to prompt the user to provide an annotation to justify the user action.

Begin

  1. From the Components Tree pane, select the Control-M/EM component and from the Home tab, in the Definitions group, click System Parameters.

  2. The Control-M/EM System Parameters dialog box appears.

  3. In the left pane, click Audit and Annotation.

  4. For each field, type the required value, as described in Audit and Annotation Parameters and Audit and Annotation User Categories.

  5. Click Activate Changes.

Audit and Annotation Parameters

The following table describes audit and annotation parameters, which determine the user categories that will be audited in the Control-M/EM database each time an audited action occurs, as described in Defining Audit and Annotation Parameters.

Field

Description

Enable audit

Determines whether to enable auditing for the CCM categories.

Enable annotation

Determines whether to enable annotation for CCM categories.

Enable automatic cleanup

Determines whether to automatically delete audit information in the Control-M/EM server database.

Days to retain audit information

Determines the number of days to retain audit information before automatically deleting it from the Control-M/EM server database.

Audit and Annotation User Categories

The following table describes the user categories that can be audited or annotated in the Control-M/EM database.

Category

Description

Authentication

Determines Login/logout attempts, password actions.

Scheduling definitions

See Scheduling

Active network

See Job Management such as holding and rerunning.

AJF get job information

Defines Active job information such as log, output, and statistics.

Independent AJF entities

Determines resource activities (add, delete, or update resources) and defines global prefixes.

Alerts handling

See Alerts

Account management

Determines Control-M/EM user and group authorizations.

Component operations

Determines the Desired State of components in the CCM to Up, Down, Ignore, or Recycle, as described in Component Status.

Configuration management

  • Defines system parameters (see System Configuration).

  • Determines Control-M Application Integrator.

Control-M security

  • Defines Control-M/Server user permissions, as described in Control-M/Server security .

  • Determines Connection profiles for Application Plug-ins.

Database maintenance

Checks database space and extend databases, as described in Database management.

High availability

See High availability

Control-M Web Parameters

The following table describes Control-M Web parameters.

Parameter

Description

Common

Site Logo Path

Defines the location of your organization’s logo that is displayed in the Control-M Self Service site.

D:\images\logos\SLS_Custom_Logo.png

  • The maximum size is 100w X 20h pixels.

  • The logo file must be in png or jpg format.

Site Login Logo Path

Defines the Login Logo path, where the site login logo is located.

Site Interface Language

Determines the language of the Control-M Self Service site.

User Inactivity Timeout

Determines the number of minutes that Control-M Web remains idle before the user is automatically logged out.

Valid Values: 10–720

API Parameter Name: userInactivityTimeoutMinutes

Administrator Mail

Defines the Control-M Self service administrator email address that appears in login page.

Support/Helpdesk Info

Defines general support information, such as help desk phone number and administrator extension that appears in the Control-M Self Service login page.

End User's Site Portal URL (myhomepage)

Defines a URL for a site portal that is referenced by Control-M Workload Change Manager end users.

Planning

Maximum Number of Jobs in Flow Diagram View

Determines the maximum number of jobs to load into a flow diagram view. If this number is exceeded, job view automatically changes into list view.

Order Method Default Settings

Determines whether jobs in Control-M Web are ordered according to the following:

  • Automatic

  • None

  • Specific: You must define a specific user daily

API Parameter Name: defaultRunMethod

Automatic Save Interval

Determines the number of seconds between each workspace save when the Auto Save preference is checked.

Monitoring

Jobs view refresh rate

Defines the number of seconds to wait before automatically refreshing the jobs.

Services view refresh rate

Defines the number of seconds to wait before automatically refreshing the services.

Maximum jobs in jobs view

Determines the maximum number of jobs that can appear in the Jobs view.

If there are more jobs in the service than the number defined here, you might experience low performance. When the number of jobs exceed its limitation, a warning message appears and the user is prompted to select Simple Tile view.

Valid Values: 1-40,000

Default: 20,000

API Parameter Name: maxJobsInViewpoint

Maximum number of services

Determines the maximum number of services that can appear in the Map view of the Services view.

If there are more services than the number defined, you might experience low performance. When the number of services exceed its limitation, a warning message appears and the user is prompted to select List view.

Output file automatic load limit

Determines the size of the output (in bytes) that determines whether Control-M Self Service sends an output download confirmation message to the user.

This occurs when the user attempts to download an output.

API Parameter Name: outputAutomaticLoadLimitBytes

Job Primary Field

Determines whether the JobName or MemName is displayed as the title of the job.

If JobNameMemName is selected, then Control-M Self Service displays JobName for Distributed jobs and MemName for Control-M for z/OS jobs.

API Parameter Name: jobPrimaryFieldInMonitoring

Maximum results in job search

Determines the number of jobs that appear in a search result.

API Parameter Name: maxResultsInJobSearch

Maximum viewpoints a user can define

Determines the maximum number of viewpoints a user can define.

Days to keep unused viewpoints

Determines the number of days to keep unused viewpoints.

Enabled Job Actions

Determines whether the following job actions are enabled in the Control-M Self Service site:

  • Hold

  • Release

  • Confirm

  • Rerun

  • Restart

  • Kill

  • Order Now

  • Set to OK

  • Update

  • Archive Search

Defining Control-M Self Service Parameters

This procedure describes how to define Control-M Self Service system parameters, such as site language, color, and logo path.

Begin

  1. Open the Control-M Configuration Manager.

  2. From the Components Tree pane, select the Control-M/EM component and from the Home tab, in the Definitions group, click System Parameters.

    The Control-M/EM System Parameters dialog box appears.

  3. In the left pane, click Self Service.

  4. For each field, type the required value, as described in Control-M Self Service Parameters and Control-M Web Parameters.

  5. Click Activate Changes.

Defining Control-M Workload Change Manager System Parameters

This procedure describes how to define Control-M Workload Change Manager system parameters.

Begin

  1. From the Components Tree pane, select the Control-M/EM component and from the Home tab, in the Definitions group, click System Parameters. The Control-M/EM System Parameters dialog box appears.

  2. In the left pane, click Control-M Workload Change Manager.

  3. For each field, type the required value, as described in Control-M Workload Change Manager System Parameters and Control-M Web Parameters.

  4. Click Activate Changes.

Configuring Control-M Workload Change Manager E-mail Notifications

This procedure describes how to enable Control-M Workload Change Manager to send e-mail notifications from the administrator.

Begin

  1. From CCM, from the Home tab, click System Parameters.

    The Control-M-EM - System Parameters window opens.

  2. In the left pane, click the Advanced tab, navigate to the general type parameters and click the EmailServer parameter.

  3. In the Value field, enter a valid email server and click Save.

  4. In the left pane, click the Workload Change Manager tab, enter the administrator e-mail address in the E-mail Sender field, click Activate Changes and Close.

  5. Set the Desired State of CMS to Recycle.

Control-M Workload Change Manager System Parameters

The following table describes Control-M Workload Change Manager (WCM) system parameters. To define these parameters, see Defining Control-M Workload Change Manager System Parameters.

Parameter Description

E-Mail Sender

Defines the sender email address that is used to send notifications to WCM end users.

New Folder Default Strictness Level

Determines whether to enforce validation on a new folder or not.

API Parameter Name: strictnesslevel

Enable Site Standard Admin Mode

Determines whether a Control-M Administrator can set the Enforce Validations checkbox for a Site Standard in Folders. If this parameter is selected, the checkbox is disabled for other users. You must also set the New Folder Default Strictness Level parameter to Strict.

API Parameter Name: enforceSiteStandardAdminOnly

Enable Change Management Integration

Enables the integration between WCM and a third party change management system. If disabled, it does not affect the other WCM system parameters.

REST Service URL

Defines one of the following: The URL of the change management system if you integrate directly with the change management system. The URL of the dedicated REST server if you integrate with the change management system by way of a REST server. For more information, see WCM Integration with a Change Management System. For secure communication, see Configuring Secure Communication between WCM and a Change Manager System .

To use a secure URL, you must configure the Web server to work with HTTPS.

REST Service Timeout

Determines the time, in seconds, for the REST Service invocation to be considered not responsive when connecting WCM to the REST service.

Change Management Status Button

Button Determines whether the Change Management Status button is visible or hidden in the Control-M application. If enabled, users can click the button to view the status of a request in the change management system.

Change Ticket Field Editable

Determines whether or not the Change Ticket field in WCM and in Control-M can be edited.

Defining Manage SSL System Parameters

This procedure describes how to define Manage SSL system parameters, which affect the generated certificates.

Begin

  1. From the Components Tree pane, select the Control-M/EM component and from the Home tab, in the Definitions group, click System Parameters.

  2. The Control-M/EM System Parameters dialog box appears.

  3. In the left pane, click Manage SSL.

  4. For each field, type the required value, as described in Manage SSL System Parameters.

  5. Click Activate Changes.

Manage SSL System Parameters

The following table describes Manage SSL system parameters.

Parameter

Description

SSL CA Certificate expiration duration in days

Determines the expiration duration of a site CA in the Manage SSL Generate Certificate Wizard.

Default: 7,300

SSL certificate expiration in days

Determines the expiration duration of a certificate in the Manage SSL Generate Certificate Wizard.

Default: 7,300

SSL Certificate key length

Determines the number of bits of the certificate key in the Manage SSL Generate Certificate Wizard.

Default: 2,048

Control-M/EM General Parameters

The following table describes Control-M/EM general system parameters in the Advanced section of the CCM.

Parameter

Description

act_chk_inpermitt_gcs_gui

Do not modify this parameter unless requested by BMC Software Customer Support.

Default: N

ActivateApplications4NonAdmin

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

Valid Values:

  • 1: On

  • 0: Off

Default: 1

AlertsLimit

Limits the number of alerts.

If you set the value to 0, Control-M Desktop shows unlimited number of alerts.

AllowDuplicateJobNames

Whether to allow more than one job to bear the same name.

When you have multiple jobs with the same name, exported job definitions in the JSON code are structured as an array. For examples of the job array structure, see the examples in Folders and Flows in the Control-M Automation API documentation.

Valid Values: true|false

Default: true

API Parameter Name: allowDuplicateJobNames

AllowDuplicateResourceNames

Whether to allow a resource pool and lock resource to have the same name in job definitions in Control-M Automation API. For such duplicate names, resources are structured as an array in the JSON code. See Resources in the Control-M Automation API documentation.

Valid Values: true | false

Default: false

API Parameter Name: allowDuplicateResourceNames

AllowListEMUserNames

Determines whether users can view a list of user names (used by Control-M for AFT configuration plug-in).

Valid Values:

  • 0: Not permitted

  • 1: Permitted

Default: Permitted

AllowLoginWithNonTrustedSSLCertificate

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

This parameter does not affect the CCM. If the SSL certificate is not trusted, a warning message appears but the login process continues.

Valid Values:

  • 1: Disabled

  • 0: Enabled

Default: 1

AnnotationDefaultCategory

Determines the default value when an annotation description is missing.

Default: Utility

API Parameter Name: annotationDefaultCategory

AnnotationDefaultNote

Determines the default value when an annotation note is missing.

Default: Command line utility invocation.

API Parameter Name: annotationDefaultNote

ApplicationFieldIsMandatory

Determines whether the Application field is mandatory for job definition.

Valid Values:

0: Not mandatory

1: Mandatory

Default: 0

ApplyAnnotationForAuditContext

Specifies the activities that require user annotations.

Valid Values:

  • 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

AuditCleanupIntervalMinutes

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

AuditCleanupOn

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

When automatic cleanup of audit information is activated, the GUI Server first waits the specified number of minutes (as specified in the AuditCleanupIntervalMinutes system parameter) before cleaning the auditing table the first time.

Valid Values:

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

1: Cleanup is automatic.

Default: 1

API Parameter Name: auditCleanup

AuditFullDefinitionChanges

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

AuditHistoryDays

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

AuthenticationMethod

Name of the external authentication plug-in.

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

AutomaticOrderMethodByDefault

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

This parameter is used in the Control-M Desktop only. For the equivalent parameter in Control-M Web, see the Order Method Default Settings system parameter, as described in Control-M Web Parameters.

bulk_def_size

Default bulk size for database bulk operation.

Valid Values: 10-10,000

Default: 100

bulk_def_storage_len

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

CentralDeployLocation

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.

After you defined the value for this parameter, restart the Control-M/EM Configuration Agent.

Default: Empty

ChallengeResponseTimeout

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

CheckDifferentHosts

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

CheckLimitsSwitch

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

Valid Values:

1: On

0:Off

Default: 1

CGSCommUserIGd

Defines the ID that GCS uses to identify itself to Control-M. This user must be defined in the Control-M with Add or delete condition privileges.

Valid Values: <String expression>.

Default: GCSERV

ClientSSO

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

Default: Off

Valid Values:

  • On

  • Off

CollectEMStatistics

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

Valid Values:

0: Off

1: On

Default: 1

CollectStatisticsByField

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

Valid Values: Control-M job definition fields

Default: Jobname

CollectzOSUserDaily

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

ConsiderDSN

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

ControlM_EM_Version

Specifies the Control-M/Enterprise Manager version.

ControlResourceForSMARTTable

Enables definition of Control Resources for SMART and Sub folders in Control-M Servers from release 7.0.00.200, however Control-M/EM clients of versions lower than 7.0.00.300, can not login to the Control-M/Enterprise Manager.

Valid Values:

  • 1: On

  • 0: Off

Default: 0

CTMSyncExceptions

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

If the Control-M synchronization mode is set to Update Control-M/Server and Control-M/EM and this parameter is defined

as "A*,B*", folders that start with A or B are not downloaded automatically from Control-M/Server to Control-M/EM and are

not uploaded automatically from Control-M/EM to Control-M/Server.

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.

DatabaseCheckInterval

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 Software Customer Support.

Default: 10

DatabasePoolSize

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 Software Customer Support.

Default: 5

DatabaseRetries

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 Software Customer Support.

Default: 10

DatabaseRetryInterval

The amount of time between the attempts set in DatabaseRetries.

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

Default: 10

DataSegmentLimitGB

Specifies the data segment size limit in GB.

Default: 2

DefaultAverageTime

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

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

Default: 00:05

API Parameter Name: DefaultAverageTimeJobWithoutStatistics

DefaultCTMExcludeRBC

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 need to change RBC names that start with ! and run the enable_exclude_rbc.pl perl script from the <scripts> directory.

DeleteChunkSize

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 equal to or greater than 1.

DirectoryConnRefreshTime

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

Valid Values: 1-60

Default: 45

DirectoryDefaultDomain

Specifies the default LDAP directory domain name for user authentication.

DirectoryServiceAuth

Determines the Directory Service mode for authentication purposes.

Valid Values:

  • On: LDAP authentication is used

  • Off: Control-M/EM authentication is used

Default: Off

DirectoryServerChaseRef

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

Valid Values:

  • 1:On

  • 0:Off

Default: 0

DirectoryServerConnAttempts

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

Default: 3

DirectoryServerConnNetworkTimeout

Specifies the connection network timeout to LDAP server in seconds.

Valid Values: 5-120

Default: 20

DirectoryServerHostPort

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>.

CTMhost1.DOMAIN1.level1:389

Default: <null>

Multiple LDAP servers can be defined. This enables Control-M/EM to perform authentication against backup LDAP servers when the primary server is unavailable.

DirectoryServiceSpecialChar

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

Default: \()

DirectoryServiceTimeout

Determines the time interval in seconds for which EM waits for LDAP actions return.

Valid Values: 1-60

Default:10

DirectoryServiceUseEscChar

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

Valid Values:

  • 1: On

  • 0: Off

Default: 1

DirectorySearchUserDN

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

jsmith@PRODUCTION.bmc.com

cn=Schemp Anderson, o=family, c=US, dc=hotmail, dc=com

DirectorySearchUserPwd

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. If no value is used, the parameter value is interpreted as blank (Default).

DirectoryServiceType

Defines the LDAP directory type or vendor that is available to the enterprise, for example, Active Directory, iPlanet, Apache Directory. This definition points to the relevant parameter load section in the DirectoryServiceType.cfg configuration file in the ctm_em/etc. The value of this parameter should be listed in this file. By default, two default directory service types (Active Directory and iPlanet) are provided in the configuration file. The default value of this parameter is Active Directory.

DirectoryServiceValidation

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 CCM 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 CCM 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.

DirectoryServerProtocol

Determines the security level of communication with the Directory Server.

Valid Values:

  • TCP

  • SSL

Default: TCP

DirectoryUsersSearchRoot

Defines the starting point (domain, country, and so on) in the directory tree structure. The domain name values in this field support both dot separated or DN format, For example, PRODUCTION.bmc.com or c=us, o=acme, dc=root. You can define multiple starting leafs by separating them with colons (:). 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. The DirectoryUsersSearchRoot parameter can only be left blank if the DirectorySearchUserDN has a configured value. The default value of DirectoryUsersSearchRoot is the domain of the search user. For example, if the DirectorySearchUserDN parameter value is jsmith@PRODUCTION.bmc.com, then the default value of DirectoryUsersSearchRoot parameter would be PRODUCTION.bmc.com.

EmailSender

Defines the email address that issues the high availability alert.

EmailServer

Defines the E-mail 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 the port is not specified, the default is 25.

EmailRecipients

Defines the email addresses that receive the high availability alerts.

The email addresses must be separated by a comma.

EmdefValidationVersion

Determines the validation version used by the emdef utilities.

Valid Values:

1: Validation version 1.

2: Validation version 2 (default).

EnableLoadBalancerRouter

Enables you to define a third party Network Load Balancer Router, which sends the jobs to specific Agents according to its own load balancing definitions.

Valid Values:

  • True

  • False

Default: False

EnableRemoteBrowsing

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

Environment Title

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

Valid Values: Free Text field. Maximum of 255 characters.

API Parameter Name: environmentTitle

GCSCommUserId

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

GlobalCondsTimestampActivation

Sends a Timestamp with every Global condition action (Add or Delete condition).

Valid Values:

0: Disables the feature.

1: Enables the feature.

Default: 0

You should only enable the feature if is supported by Control-M/Server.

HandleAlertsOnRerun

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

HostPort

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

If you want to define a different host and port/port range for each component instance, you need create additional HostPort system parameters, as described in

Configuring Control-M/EM System Parameters.

Format:

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

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

I18N

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

Warning: This parameter is automatically set during installation, according to the specified choices, and must not be changed manually.

For more information, see Control-M Installation.

Valid Values:

  • cjk

  • latin1

Default: latin1 or cjk

IPV_MODE

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.

If Control-M/Server and/or Agent are installed on AIX, verify that the fix for APAR IV23320 is installed.

If you want to enable IPV6 before installation, see Setting Environment Variables in UNIX.

KeepAliveTimeout

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

Language

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 computer us_english.

  • english

  • german

  • french

  • spanish

Default: use_account_locale

LimitGCDistribActivate

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

Valid Values:

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

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

Default: _1

LimitGCDistribExcludeDates

Dates for which global conditions are distributed, regardless of limitations specified using the LimitGCSDistribMaxDays parameter. Dates are specified in mmdd format and separated with commas.

Default: STAT

LimitGCDistribMaxDays

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

Valid Values: 1-28

Default: 7

LMGUI_Communication_Cfg

Defines the License Manager address. Not yet implemented.

Default: null

LockAccountForMinutes

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

MainEMServiceContext

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

Valid Values: GUI Server logical name.

Default: Empty

MaxAuditsToDelete

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 asking you to clean audit records manually using the erase_audit_data script.

Valid Values: Positive integer values.

Default: 2,000

MaxDaysAlertRetained

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

Default: 30

MaxRecentItemsInList

Defines the number of recent items in any list.

Default: 40

MaxPasswordLength

The maximum number of characters for user passwords.

If a Control-M administrator uses the Control-M/EM Authorization to set a password, this parameter is ignored.

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

Default: 32

MaxTableJobsToAudit

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

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

Default: 1,000

MeasurementDaysToKeep

Defines the number of days to keep collected metrics data.

Default: 90

MFTActiveConnectionsChartUnits

(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

MFTLongRunningMinMinutes

Determines the minimum file transfer duration, in minutes, for a file transfer to be included in the count of long-running file transfers in the MFT Dashboard.

Valid Values: 5–2,880 (2 days)

Default: 15

MFTRefreshRate

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

Default: 60

MFTSlowTransfersMinDurationSeconds

Determines the minimum file transfer duration, in seconds, for a file transfer to be included in the count of slow transfers in the MFT Dashboard (provided that the measured bitrate is also too low, as described in the next parameter).

Valid Values: 5–172,800 (2 days)

Default: 10

API Parameter Name: slowFileTransfersMinimumDurationSeconds

MFTSlowTransfersThresholdInKbps

Determines the bitrate threshold, in kilobytes per second, below which a file transfer is included in the count of slow transfers in the MFT Dashboard (provided that the transfer duration is also too high, as described in the previous parameter).

Valid Values: 0–131,072 (128 megabytes per second).

Default: 500

MFTTrafficLoadChartUnits

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

MinPasswordLength

The minimum number of characters for user passwords.

If a Control-M administrator uses the Control-M/EM Authorization window to set a password, this parameter is ignored.

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

Default: 6

ModifyJobFieldsBlock

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

NrHandledAlarms

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

When set to 0, there is no maximum number of handled alerts, and they will be deleted if they pass the threshold defined in MaxDaysAlertRetained parameter value.

API Parameter Name: numberHandledAlarms

NumberofConnectionAttempts

Defines the number of connection attempts between the client (CCM or Control-M) and the GUI Server for connection recovery.

Default: 5

NumberOfEstimationRunTime

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

Default: 50

NumberOfPastRunTimes

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

Default: 50

NumberOfFailedLogins

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

Valid Values: 0-100

Default: 5

NumberOfPasswordReplacements

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

If a Control-M administrator uses the Authorization facility to set a password, this parameter is ignored.

Valid Values: 1-20

Default: 10

NumberOfReportDays

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

Valid Values: 2 and higher

Default: 90

NumberOfReportDaysHistory

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

OutputAutoLoadLimit

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

PasswordComplexityOnOff

Determines if passwords need to comply with complexity rules.

If a Control-M administrator uses the Authorization facility to set a password, this parameter is ignored.

Valid Values:

  • 0: no = off.

  • 1: yes = on.

Default: 0

PasswordComplexityRules

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

If a Control-M administrator uses the Authorization facility to set a password, this parameter is ignored.

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

PasswordEncode

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

PasswordExpirationOnOff

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

PasswordHistoryOnOff

Determines whether password history is recorded.

If a Control-M administrator uses the Authorization facility to set a password, this parameter is ignored.

Valid Values:

  • 0: no. If set to 0, new passwords are not checked against previous passwords.

  • 1: yes.

Default: 0

PasswordLifetimeDays

Determines the number of days before the password expires. Used in the password expiration date computation by the set_pwd_def_lifetime script.

Valid Values: 1–365

Default: 60

PermitManualUnlock

This parameter specifies whether non-administrators can manually unlock their own tables (for example, if tables are locked during an abnormal disconnect from the GUI Server).

Non-administrators will not be able to unlock other users’ tables.

Valid Values:

  • 1: Users can unlock their own tables.

  • 0: Only administrators can unlock the table.

Default: 1

PrivacyNoticeURL

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

ProxyNewsfeedHostPort

Determines the host and port of the proxy server for all users connecting to the Newsfeed through a proxy server.

Valid Values: <host>:<port>

Venus:13888

Default: Empty

RecentItemsRetainDays

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

Default: 60

RemoteBrowseEntriesMaxLimit

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

Valid Values: Any whole integer.

Default: 1,000

RFAllowReportForJobLevelAuth

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

Valid Values:

  • Y

  • N

Default: Y

RFPGUseDeclareFetch

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

Valid Values:

  • 0: Not enabled

  • 1: Enabled

Default: 1

RunTimeDeleteHistChunkSize

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

This system parameter is relevant only if Control-M/Forecast is installed.

RunTimeDeleteHistInterval

Interval in seconds between the deletion of historical records.

Valid Values: Positive integer values.

Default: 21,600

This system parameter is relevant only if Control-M/Forecast is installed.

RunTimeHistoryDays

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

SecondsBetweenConnAttempts

Defines the time interval in seconds between connection attempts.

Default: 5

SendAlarmToScript

Full path name 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 path name 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:

Copy
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>”

The last data field is visible only if the SendAlertNotesSnmp parameter is set to 1, and in Control-M/EM 7.0.00 fix pack 2 and later.

Test SNMP traps when enabling this parameter as follows.

  • On UNIX:

    #!/bin/sh

    echo $* > /tmp/snmptest.out

  • On Windows:

    echo %* > c:\snmptest.out

On Windows, double back-slashes should be used as a delimiter.

SendAlertNotesSnmp

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

The SendAlertNotesSnmp parameter is available for Control-M/EM 7.0.00 fix pack 2 and later.

SendPre800NamesAlarmScript

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

SendRuntimeEstimations

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

SendSnmp

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

Alert data is sent to SNMP (values 0 or 2) only if the value of the SnmpSendActive parameter is set to 1.

ShowNewsfeedDomain

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

Valid Values:

  • 0: Hide

  • 1: Show

Default: 1

SnmpHost

Host name or list of host names (if a list, using semi-colons (;) as delimiters) to send the SNMP trap on an alert. Specific ports can be set using a colon (:) as a delimiter.

Valid Values:Valid hostname or ip address.

Default: <no_host>

dhost1;jhost2;myhost3:2000

SnmpSendActive

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

SubApplicationFieldIsMandatory

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

Valid Values:

  • 0: Not mandatory

  • 1: Mandatory

Default: 0

UnsupportedClientVersions

For BMC Software Customer Support use only.

Valid Values: List of releases separated by semicolons:

7.0.00.100;7.0.00.200

Default: 0

UserAuditContext

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 (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

  • HIGH_AVAIL: High Availability operations

Default: All values

API Parameter Name: userAuditContext

UserAuditAnnotationOn

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

UserAuditOn

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

Valid Values:

  • 0: Not recorded

  • 1: Recorded

Default: 1

API Parameter Name: userAudit

UseAutoReconnect

Defines the reconnection invocation method.

Valid Values:

  • 1: Automatic

  • 0: Manual

Default: 1

UsezOSTimeZone

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

Valid Values:

  • 1: Overrides values.

  • 0: Cannot override values.

Default: 0

ViewSysoutHeadSizeKB

Displays the first KB of the output file.

Valid Values:

  • 1: First KB of the output file

  • 0: Whole file

Default: 0

ViewSysoutTailSizeKB

Displays the last KB of the output file.

Valid Values:

  • 1: Last KB of the output file

  • 0: Whole file

Default: 0

VMAdditionalJobsRelateFields

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 Software Customer Support.

Default: <empty>

Refresh Type: Manual

VMVersionsNumberToKeep

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

A job version is deleted only when all of the following are true:

  • The version exceeds VMVersionsNumberToKeep.

  • The version exceeds VMMaxDaysRetainCurJobsHistory.

  • Automatic cleanup has run, as determined by VMCleanupIntervalMinutes.

BMC Software recommends not to set 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 equal to or greater than 0.

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

Refresh Type: Manual

API Parameter Name: numberJobVersionsToKeep

WarningPasswordExpirationDays

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

Valid Values: 0-90

Default: 0 (no warning is generated)

WarningSSLExpirationDays

Number of days prior to certificate expiration during which the GUI server generates a warning message in the CCM.

Valid Values: 1-365

Default: 60

WebServersLoadBalanceEnabled

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

Valid Values:

  • 0: Disables Web Server load balance

  • 1: Enables Web Server load balance

Default: 0

WorkloadHistoryMaximumNum

Defines the Maximum number of workload versions in the database.

Default: 100

WorkspaceSharing

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

XAlertsEnableSending

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

Valid Values:

  • 1: Enable

  • 0: Disable

Default: 1

XCTMDoForceAudit

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

XCTMDoForceRetryIntSeconds

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

Default: 300

XCTMDoForceRetryTimeoutMinuts

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

Default: 1,440

XCTMDoForceAuth

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

If the value is set to CTM, Control-M/EM does not authenticate the request and it is authenticated by the Control-M/Server.

 

XCTMDoForceUser

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

Default: use_job_owner

Gateway Parameters

The following table lists the Gateway parameters.

Parameter

Description

AlertOnAbend

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

AlertOnAbendTableEntity

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

AlertOnAbendUrgency

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

Valid Values:

  • Regular

  • Urgent

  • Very Urgent

Recycle the gateway for new settings to take effect .

Default: Very Urgent

API Parameter Name: alertOnJobFailUrgency

CollectzOSUserDaily

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

CommCtmBufferSize

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 equal to or greater than 1,000,000.

Default: 50,000,000

CommEMBufferSize

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

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

Default: 50,000,000

ConsiderDSN

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

CTMSyncInterval

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

Default: 1,800

CTMSyncLocalDelete

Determines whether to automatically delete folders and/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

DeltaMaxActMinutes

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

Valid Values: Any whole number that is equal to or greater than 300. Default: 2,160

DownCreAlerts

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

Note: 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

EBCDIC_cp

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

GatewayDefaultTraceOptions

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

If a gateway already has a trace option specified, the GatewayDefaultTraceOptions parameter value is ignored.

Valid Values: All Gateway trace option parameters.

Default: <empty>

GtwCondDispatchErr

Valid Values:

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

Default: CTM5050 CTM5301 CTM5311 CTM5312 CTM5323

HostPortList

List of logical names of CONTROL‑M data centers that are connected to Control‑M/EM.

Valid Values: The host name and port number, entered in the following format:<host>:<port>.

Default: null

GtwNumUpdateThreads

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

GtwParallelProcessingMode

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

Valid Values:

  • on

  • off

Default: 0

HostPortList

Listening port host name and port number for gateways.

Valid Values: The host name and port number, entered in the following Format:<host>:<port>.

Default: null

InsertAlertTries

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 equal to or greater than 1.

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

Default: 10

MaxDownHistDays

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 equal to or greater than 0.

Default: 100

MaxDailyRerunInfo

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

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

Default: 1 (No limit)

MaxOldDay

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

The number of downloads stored in the database is never more than the smaller of the MaxOldDay value and the MaxOldTotal value.

API Parameter Name: historyRetentionDays

MaxOldTotal

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

MaxUploadBufferMPM

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

Default: 60,000

MaxUploadBufferMVS

For Customer Support use only.

Default: 60,000

MultiByte_cp

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

Valid Values: Any valid CJK EBCDIC code page

RunInfoErrorLevel

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

Default: 0

RunInfoIgnoreDevCnt

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 Software Customer Support.

Default: 2

RunInfoMaxSamples

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

RunInfoProcRecords

Maximum number of run detail records processed in one loop.

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

Default: 100

RunInfoUpdCtx

Configures the context in which run information is processed.

Valid Values:

  • 0: Gateway main thread

  • 1: Separate thread

Default: 1

RunInfoWaitInterval

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 Software Customer Support.

Default: 10

SSLRetries

Number of times Control‑M/EM attempts to establish communication with the gateway before turning 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 Software Customer Support.

Default: 2

SSLSyncTime

Replaces the value of the Sync_Timeout parameter (in the Defaults.rsc file) that 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 Software Customer Support.

Default: 90

StatCollection4Distributed

Determines which job properties field is used to collect statistics for distributed jobs.

Default: JOBNAME

Global Conditions Server Administration Parameters

The following table refers to Global Conditions Server administration parameters.

Parameter

Description

BulkSendIntSecs

Interval (in 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 Software Customer Support

Default: 0

BulkSendMax

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 Software Customer Support.

Default: 1,000,000

CleanOldIntSecs

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)

CleanOldTimeSecs

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)

DispatchThreadsNum

Determines the number of threads dispatching updates to destinations. Default: 1

DoneGcDelIntSecs

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 Software Customer Support.

Default: 120

GcDistributionPolicy

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

GcDoneWaitSecs

Minimum time (in seconds) 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 Software Customer Support.

Default: 120

GcMaxRetries

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 Software Customer Support.

Default: 5

GcRetryIntSecs

Interval (in 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 Software Customer Support.

Default: 180

In Control-M/EM environments with high workloads, the Global Conditions server might not respond to life check requests because it is busy communicating with gateways and re-sending messages. It is reccomended to change the value to 360 or more to avoid overloading the Global Conditions server and help it respond to the Maintenance Agent.

Refresh type: Manual

GcTogglingForSameOperation

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

GcXAlertSending

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

Valid Values:

  • ON

  • OFF

Default: ON

MaintThreadPoolSize

Determines the size of GCS maintenance thread pool.

Default: 1

PortNum

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 Software Customer Support.

Default: 10,000

SrvrsPollIntSecs

Interval (in seconds) between attempts to communicate with a gateway.

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

Default: 60

ThreadPoolSize

Determines the size of main GCS thread pool.

Default: 2

UpdCommIntSecs

Interval (in seconds) between readings of the Communication Table in the Control‑M/EM database for new data centers.

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

Default: 60

Global Conditions Server (GCS) Logging Parameters

The following table lists Global Conditions Server (GCS) logging parameters.

Parameter

Description

CondLogLvl

Logging information level for condition transfer activities. Information is displayed for conditions received (In), conditions sent (Out), transfer confirmation and rejection actions, and communication problems.

Valid Values:

  • 0: No diagnostics

  • 1: Condition transfer, problem, and information received

  • 2: Condition transfer, problem, and information sent

  • 3: Value 1 + value 2

Default: 2

DbLogLvl

Logging information level for messages related to database activities. Diagnostic information is displayed 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

IntLogLvl

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

Valid Values:

0: No diagnostics

1: Condition actions based on conflict handling policies

Default: 1

LogSize

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 equal to or greater than 0. If the value is 0, the file never closes, because there is no maximum size.

Default: 15,000 KB

MaxLogs

Maximum number of log files to be managed cyclically. 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 equal to or greater than 0.

Default: 5

ShowMsgIDLog

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

Valid Values:

  • Y

  • N

Default: N

Control-M Self Service Parameters

After modifying Control-M Self Service parameters, stop and restart the Self Service Server component for the changes to take effect.

For a description of all other Control-M Self Service system parameters, see Defining Control-M Self Service Parameters.

Parameter

Description

DetectInterval

Determines the interval for recalculating the status of a service.

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

Default: 00:01:00

MftSearchResponseTimeout

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

Default: 60

SLSUserName

Defines the username of the Control-M Self Service server when it connects to the GUI server.

Valid Values: String expression.

Default: slsuser

ControlDRepository

Defines the host name of Control-D/WebAccess Server where reports are stored.

ControlDWaURL

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

https://vw-tlv-ctm-dv22/wa/ControlM.html

DisplayOrderAsIndependentFlow

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

Control-M Web Advanced System Parameters

The following table describes Control-M Web system parameters from the Control-M/EM system parameters Advanced window. For a description of all other Control-M Web system parameters, see Control-M Web Parameters.

Parameter

Description

ChangesHistorySearchLimit

Limits the number of records to retrieve when searching in the Changes History. To retrieve all records, use a value of 0.

Default: 10,000

ConditionLimitation

Determines the maximum number of prerequisite conditions retrieved by the server.

Default: 10,000

ControlResourceJobsLimitation

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

Default: 100

ControlResourceLimitation

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

Default: 2,000

FolderLimitation

Determines the maximum number of folders retrieved by the server.

Default: 10,000

LimitWebTabByMemory

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

Default: 80

LoginMaxPasswordLengthLDAP

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

Default: 127

MFTLongRunningMinMinutes

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

MFTSlowTransfersMinDurationSeconds

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

MFTSlowTransfersThresholdInKbps

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–131072

Default: 500

API Parameter Name: slowFileTransfersThresholdInKbps

MaxDBFieldValues

Determines the maximum number of database field values to retrieve.

Default: 100,000

MaxItemsInWorkspace

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

Default: 10,000

MaxJobsToOrder

Determines the maximum number of jobs to order. By default, there is no maximum limit.

MaxNumberOfFoldersInPlanning

Determines the maximum number of folders in the Planning domain.

Default: 10,000

MaxUserViews

Determines the maximum number of user views.

Default: 10,000

MaxWorkspaces

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

Default: 10,000

OrderVariableLimitation

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

Default: 1,000

QuantitativeResourceJobsLimitation

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

Default: 100

QuantitativeResourceLimitation

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

Default: 2,000

RunReportLinksLimitation

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

SharedVariableLimitation

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

Default: 2,000 variables

StartDayOfTheWeek

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

Default: 2 (Monday)

SupportCentralURL

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

SupportSearchURL

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

WorkloadViewpointJobsLimitation

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

Default: 20,000

WorkspaceFolderDefaultType

Determines the default folder type while creating a new workspace or folder, either SMART or REGULAR.

Default: SMART

Control-M Workload Change Manager Advanced System Parameters

The following table describes Control-M Workload Change Manager system parameters from the Control-M/EM system parameters Advanced window. For a description of all other Control-M Workload Change Manager system parameters, see Defining Control-M Workload Change Manager System Parameters .

Parameter

Description

NumDaysKeepApprovedReqs

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

SiteBackgroundColor

Determines the site background color.

Default: SolidBlue

SiteBackgroundColorsValues

Determines the site background color values.

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

PatternBrown,PatternOrange

WCMEmailSubjectTemplate

Defines the template for the e-mail’s 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>

WCMLoginLogoPath

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

SiteLogoPath

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

c:\Control-M Workload Change Manager.jpg

  • The maximum size is 100w X 20h pixels.

  • The logo file must be in png or jpg format.

SiteInterfaceLanguage

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

SiteInterfaceLanguageValues

Enables you to add other possible languages as options.

WCMCallbackResponseTimeout

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

WCMEnforceSiteStandard

Enables you to enforce the assignment of a Site Standard to a job flow, which prevents Control-M Workload Change Manager web users from creating a job flow without a site standard assigned.

You must set the New Folder Default Strictness Level to Strict to enable Site Standard enforcement for a new job flow. The Enforce validations of a folder must be set to true to enable Site Standard enforcement on existing folders.

API Parameter Name: enforceSiteStandards

WcmCheckInEnabled

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.

Maintenance Parameters

The following table describes Maintenance parameters.

Parameter

Description

CheckHAinDistribuitedEM

Enables the Configuration Agent to automatically recycle components in a Distributed environment when a Failover or a Fallback has occurred.

Valid Values:

  • 0: On

  • 1: Off

Default: 1

ComponentShowState

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

DelCommregAfterActivateTries

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

Default: 6

DiagOutputBufferSizeDefaultKB

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

Default: 100

DiagOutputBufferSizeMaxKB

Determines maximum size in KB that you can set

forDiagOutputBufferSizeDefaultKB.

Default: 100

FOTimeOutMinutes

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

Default: 5

HADBLifeCheckTries

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

Default: 3

HADBMaxStartupTries

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

Default: 20

HATimeBetweenLifeCheck

Determines the number of seconds to wait between sending life check requests to the database server.

Default: 5

HADBTimeToWaitAfterStartUp

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

Default:10

HALifeCheckTries

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

Default: 3

HAMaxStartupTries

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

Default: 50

HATimeBetweenLifeCheck

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

Default: 15

HATimeToWaitAfterStartup

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

Default: 180

LogCleanInterval

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

The Configuration Agent cleans the LogReg log every time it is activated.

Valid Values: Any whole number greater than 0

Default: 360

LogCleanLevel

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

Valid Values:

  • 0: No deletion

  • 1: Cleans only the agent’s own log messages

  • 2: Cleans all log messages

Default: 1

LogHistoryDays

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

Valid Values: Minimum of 0

Default: 1

LogInfoLevel

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

SockRecrMaxAtmp

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

Default: ‑1 (no limit)

SockRecrWtIntr

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

Valid Values: Any whole number greater than 0.

Default: 10

StdoutLogInfoLevel

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

StopGracePeriodSec

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

StopTries

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

SyncCFGFilesCycleInterval

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

GUI Parameters

After modifying GUI parameters, stop and restart the relevant GUI components for the changes to take effect.

Parameter

Description

CCMUserInactivityTimeout

Determines the maximum number minutes of inactivity before the user is automatically logged out from the CCM.

Valid Values:

  • 10 or higher

  • -1: Disables automatic log out.

Default: 30

ClientRestrictions

Applies restriction rules to prevent ordering unnecessary jobs.

Valid Values:

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

  • Order_confirmation: Displays a confirmation window when ordering job

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

Separate values with a comma.

GettingStartedCustomizedURL

Defines the URL of the customized HTML page that is used for the Welcome window in Control-M Desktop. For more information, see Customizing the Welcome window.

OrbShutdownWait

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

Valid Values:

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

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

Default: 1

OrderForceWithHoldAlwaysOn

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

Default: 0

ProcessCommandsPerVP

(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

ProcessMFCommands

(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

ProcessVPsCommands

(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

UserChangePassword

Determines if a user can change his or her own password.

Valid Values:

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

  • 1: All users can change their own password.

Default: 1

allowCheckinWithValidationErrors

Enables you to check in your Workspace with validation errors.

Valid Values:

  • Y

  • N

Default: N

Report Parameters

The following table describes the Report parameters.

Parameter

Description

GeneratedReportRetention

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

Default: 10

MaxResourcesAvailable

Determines the maximum number of concurrent reports that can generate.

Default: 5

PreviewRowsNumber

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

Default: 25

ResourceMaxWaitTime

Determines the number of seconds to wait before sending a notification that the report is not generating.

Default: 60,000

GUI Server Parameters

If a Control-M/EM administrator uses the Authorization facility to set a password, the password complexity, length, and history requirements are ignored.

Parameter

Description

Action_OrderForce_AuthLevel

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

This parameter is available only in Compatibility Mode, after upgrading from a previous version of Control-M/EM.

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

AddJobsChunkSize

Chunk size of jobs during View Point opening.

Do not change this parameter unless requested to do so by BMC Software.

Default: 1,000

AllowQueryDBFieldValues

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

Default: 1 (On)

AllowReferencePath

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

AuthenticationLevel

Do not change this parameter unless requested to do so by BMC Software.

Default: 2

AuthorSecurity

Indicates whether a very strict (restrictive), strict, or lenient (permissive) security policy is enforced for submitting jobs during New Day processing. The Control-M security mechanism uses the Created By parameter and the AuthorSecurity system parameter to ensure that only authorized users can submit jobs during New Day processing. In all modes, the administrator is authorized to change the author.

If this parameter is modified, Control-M users who are offline must log on to become synchronized with the new setting.

Valid Values:

  • 1: (Permissive mode): Editing the author is enabled. Users can retain the original Author when running utilities or performing a Write to Control-M/EM, or, alternatively, change the author to another user.

  • 2: (Restrictive mode): Author is the user currently performing a Write to Control-M/EM. However, the original author can be retained for existing job processing definitions (whose associated tables are locked).

  • 3: (Very restrictive mode): The author is set to the user currently performing a Write to Control-M/EM for all job processing definitions.

Default: 1

BIMCommLoopInterval

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

BIMThreadPoolIdleTime

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

BIMThreadPoolMaxSize

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

BIMThreadPoolMinSize

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

bulk_act_cond

Bulk size in bulk operation for retrieve conditions.

Do not change any of the four bulk_act_xxx parameters unless requested to do so by BMC Software.

Valid Values: 10–10,000

Default: 250

bulk_act_grp

Bulk size in bulk operation for retrieve tables.

Valid Values: 10- 10,000

Default: 100

bulk_act_job

Bulk size in bulk operation for retrieve jobs.

Default: 250

bulk_act_res

Bulk size in bulk operation for retrieving control or quantitative resources.

Valid Values: 10–10000

Default: 50

CheckDoForceJobAuthorizations

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

CloseOldDownloads

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

ConcurrentCollections

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.

If you increase the value of this parameter, monitor the system for several days, especially during periods of heavy usage, to ensure that performance is not degraded. You may want to increase the value of this parameter gradually (for example, by one or two at a time), to avoid CPU bottlenecks.

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

Valid Values: 1-10

Default: 4

ControlResourceLoadLimit

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

DelayBeforePinning

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

Do not change this parameter unless requested to do so by BMC Software.

Default: 10

DeletedJobsLoadLimit

The number of jobs displayed to the user in the "Deleted Jobs" dialog box in the Control-M.

Valid Values: 0 or any negative value

Default: 2,000

EMAPIActiveJobsLoadLimit

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

EMThreadPoolIdleTime

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

EMThreadPoolMaxSize

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

EMThreadPoolMinSize

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

ExcludedJobFields

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.

Warning: BMC Software recommends that you not exclude data (change the value of this parameter to 1) without first consulting BMC Software Customer Support. If you do change the value to 1, be sure to modify job processing definitions do that they do no contain excluded data.

Control-M Workload Authorization users cannot perform a find or query on excluded fields. You can modify fields to exclude by adding or removing fields in this parameter. After modifying this parameter, stop and restart all GUI Server components for the change to take effect.

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)

ExcludeJobControlRes

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.

Warning: BMC Software recommends that you not exclude data (change the value of this parameter to 1) without first consulting BMC Software Customer Support. If you do change the value to 1, be sure to modify job processing definitions do that they do no contain excluded data.

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

Valid Values:

  • 0: Do not exclude control resources.

  • 1: Exclude control resources.

Default: 0

ExcludeJobQuantRes

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.

Warning: BMC Software recommends that you not exclude data (change the value of this parameter to 1) without first consulting BMC Software Customer Support. If you do change the value to 1, be sure to modify job processing definitions do that they do no contain excluded data.

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

FailCheckDBTimeOut

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.

This parameter is relevant only after the GUI Server determines that communication with the database server is disrupted. After modifying this parameter, stop and restart all GUI Server components for the change to take effect.

Valid Values: 1-60

Default: 5

LimitArchiveJobsInMem

The maximum number of archive jobs in memory per GUI Server.

Default: 40,000

MaxObsoleteJobs

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

MaxUserTimeoutSec

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

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

Default: 10,800

MaxConcurrentUserSessions

Limits the maximum number of concurrent sessions per user in Control-M Desktop and Control-M Web.

You must define this parameter for each GUI Server.

You must define this parameter manually, as described in Configuring Control-M/EM System Parameters.

NumberOfMyWorldJobs

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

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

Valid Values: 2-30,000

Default: 100

PinAllJobsCollection

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

PrereqConditionsLoadLimit

The maximum number of prerequisite 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

QuantResourceLoadLimit

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

QueriedCollection

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

SecuredExcludedFields

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 Software 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

SockRecrMaxAtmp

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

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

Default: -1 (no limit)

SockRecrWtIntr

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

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

Default: 10

StopIFDBConnectionFail

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

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

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 CCM) and it may not function.

Default: 0

UseQueriedCollectionForFind

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

ViewpointPolicy

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

ViewPointTimeoutForBIM

The number of milliseconds within which the Control-M/EM GUI Server should receive a reply from the BMC Batch Impact Manager after sending a request.

Default: 600,000

UpdatesQueueLimit

Default size of the updates queue for a ViewPoint.

Default: 5,000

UpdatesQueueMaxLimit

The maximum possible size of the updates queue for a ViewPoint.

Default:60,000

AlertsMapRefreshInterval

Frequency, in seconds, at which the 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

GatewayOutgoingQueueSize

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

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

Default: 500,000

RemedyCloseTicketMode

Indicates in which mode 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

SockRecrWtIntr

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

Default: 10

CMS Parameters

The following table lists the CMS parameters.

Parameter

Description

AdminRequestTimeout

Do not change this parameter unless instructed to do so by BMC Software Customer Support. If you are instructed to change this parameter, you must restart the CMS for the change to take effect.

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

CmsCommMode

The mode with which 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

CmsCtmNGRefreshInterval

Sets the refresh interval in seconds for collecting host group data.

Valid Values: 0-10,000 (0 -host group data is not collected)

Default: 900

CmsCtmRefreshInterval

The Configuration Management Server (CMS) refreshes the status and topology of the Control-M/Servers on a regular basis. This system parameter governs the length of time in seconds between each refresh episode.

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

Default: 60

CmsEmRefreshInterval

The CMS refreshes its internal image of Control‑M/EM component status on a regular basis. This system parameter governs the length of time in seconds between each refresh episode.

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

Default: 30

CmsGateAdditionalParams

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

CmsHostSpecRetrieverInterval

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

Default: 60

CmsMaxPluggableOutput

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

Default: 100

CmsXAlertsHost

Specify the host or IP address on which the CMS is forced to receive XAlerts.

Valid Values: Any valid host name or IP address.

If no value is entered for this parameter, the host name on which the CMS is installed is used.

Default: null

CmsXAlertsPort

Specify the port through which the XAlerts are received.

Valid Values: Any valid port.

Default: 0

The default value 0 means that any random port is used.

DBCheckSpaceIntervalSeconds

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

Default: 36,000

DBCheckSpaceWarningPct

Determines the maximum percentage of allowed database space use.

An Xalert is issued if the threshold is exceeded.

Default: 90

DiagOutputTimeout

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

HAProgressDataRetentionInterval

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

Default: 604,800

HandledXAlertHandling

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.

This parameter is only valid when the XAlertsSendSnmp system parameter has a value of 1, 2, or 3.

Default: 0

IdenticalXAlertTimeDelta

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 equal to or greater than 0.

Default: 30 minutes

IdenticalXAlertCompareDesc

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

IdenticalXAlertHandling

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.

This parameter is only valid when the XAlertsSendSnmp system parameter has a value of 1, 2, or 3.

Default: 0

ManageSSL_CertExpirDays

Determines the expiration duration of a certificate in the Manage SSL Generate Certificate Wizard.

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

Default: 7,300

ManageSSL_CACertExpirDays

Determines the expiration duration of a site CA in the Manage SSL Generate Certificate Wizard.

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

Default: 7,300

ManageSSL_CertKeyLengthBits

Determines the number of bits of the certificate key in the Manage SSL Generate Certificate Wizard.

Valid Values: 1024, 2048, 3072, 4096

Default: 1,024

MaxXAlerts2Send2Client

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

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

Default: 2,000

RemoteCmdTimeout

The amount of time, in seconds, that the CMS will wait for a reply to a remote request sent through the Configuration Management Server to Control-M/Server, Control-M/Agent, and Application Plug-Ins, before timing out.

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

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

Default: 300

RunInfoStatsPurgeDays

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 equal to or greater than 1.

Default: 100

RunInfoStatsPurgeInterval

Interval, in minutes, between activations of automatic purging of periodic statistics by the CMS.

To disable automatic purging, set the value to 0.

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

Default: 30

UsageAlertsState

Determines whether Usage Alerts are enabled.

Valid Values:

  • 0: Disabled

  • 1: Enabled

Default: 0

UsageCollectionDisabled

Determines whether to automatically activate the usage collection tool.

Valid Values:

  • 0: Enabled

  • 1: Disabled

Default: 0

VMCleanupIntervalMinutes

Interval, in minutes, between activations of automatic job history cleanup by the CMS.

To disable automatic cleanup, set the value to 0.

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

Default: 30

VMMaxDaysRetainCurJobsHistory

The number of days after which the history of the current jobs should be deleted automatically.

A job version is deleted only when all of the following are true:

  • The version exceeds VMVersionsNumberToKeep.

  • The version exceeds VMMaxDaysRetainCurJobsHistory.

  • Automatic cleanup has run, as determined by VMCleanupIntervalMinutes.

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

Default: 180

VMNumDaysRetainDeletedJobs

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 equal to or greater than 1.

Default: 180

XAlertsSendSnmp

Determines whether an alert will be sent as an SNMP trap, to a script, both, or neither.

Valid Values:

  • 0: Not active.

  • 1: Sent as an SNMP trap.

  • 2: Sent to a script.

  • 3 Sent as an SNMP trap and to a script.

Default: 0

XAlertsMaxAge

Determines, in days, how long XAlerts are saved before they are deleted by the Configuration Management Server.

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

Default: 180 days

XAlertsMaxHandled

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

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

Default: 100

XAlertsSnmpHosts

Specifies the host names of the machines to which you want to send the SNMP trap.

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

XAlertsmachine:7000;SNMPmachine;Scriptsmachine:7001

Default: null

XAlertsSend2Script

Specify the full path and filename of the script to be sent. This parameter is used only when the XAlertsSendSnmp system parameter is set to either 2 or 3.

Valid Values: Any full path and filename.

Default: null

XAlertsDisableMsgIDs

Specify 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

XAlertsMinSeverityFilter

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

Valid Values:

  • Warning

  • Error

  • Severe

Default: Warning

Control-M/EM Parameters in the Defaults.rsc File

The following table lists the parameters located in the Defaults.rsc file.

Parameter

Description

bulk_batch_size

Indicates 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 equal to or greater than 10.

Default: 100

continue_not_responding

Indicates 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

dal_rel_cache_size

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

dal_select_min_bulksize

dal_select_max_bulksize

dal_insert_min_bulksize

dal_insert_max_bulksize

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 equal to or greater than 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

em_connect_method

Indicates in which mode the gateway opens communication connections.

Valid Values:

  • 1: The gateway establishes connections in blocking mode.

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

gtw_send_ctl_timeout

Timeout period, in seconds, for determining if the original gateway is responsive (up).

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

Default: 45

kill_not_responding

Indicates 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

nonBlockTimeout

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.

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

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

useNonBlock

Indicates whether the gateway operates in blocking mode or non-blocking mode. This mode determines whether the gateway receives entire messages or parts of messages.

Valid Values:

  • N: The gateway waits and receives for the entire message to arrive in blocking mode, regardless of length of time.

  • Y: The gateway receives parts of messages (non-blocking mode). Communication is assumed to be down if part of a message is not received within the time interval specified in the nonBlockTimeout field.

Default: N

Batch Impact Manager Parameters

System variables influence the behavior of Batch Impact Manager components and features. The following table describes the function of each Batch Impact Manager-related system parameter and lists its default, if one exists.

Batch Impact Manager administrators can change the value of most of these system parameters. If, however, a system parameter is to be modified only upon instruction of Customer Support, this is noted in the description of that system parameter.

After modifying any of these system parameters, you must stop and restart the Batch Impact Manager Server.

Parameter

Description

AddAllOrphanConditions

Enables you to add external or orphan conditions.

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

  • The job relies on a condition from a previous day.

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

Valid Values:

  • 0: Do not add conditions.

  • 1: At conditions at New Day.

  • 2: Add conditions at the average start time of the first job waiting for the condition.

Default: 2

AddVirtualOrphanConditions

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

AlertConsolidationMode

Determines whether the BMC Batch Impact 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

AllowReportViewing

Allows service report viewing from web for users that are not administrators.

Valid Values: The number 1

Default: 0

BackupGUIServers

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 GUI Server or list of GUI Servers separated by commas (,).

Valid Values: String expression.

BIMUserName

The user name that Batch Impact Manager uses when connecting to Control-M/EM.

Valid Values: bimuser

Default: bimuser

Before changing this value, ensure that the new user name value already exists in Control-M/EM (If it does not exist, create it before changing the value). The Batch Impact Manager user name is a hidden user, so if a new user name is indicated here it will also become hidden.

ConditionDaysToLoad

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

Valid Values: Any integer, 1 or greater

Default: 7 days

API Parameter Name: loadOldEventsDays

ConnectToGsrRetryDelay

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

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

Default: 30

DateFormat

Determines the format for dates displayed in BIM alert messages.

Valid Values: DD/MM and MM/DD.

Default: DD/MM

API Parameter Name: dateFormat

DefaultAverageTime

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

DetectProblemsInterval

Interval at which Batch Impact Manager checks for problems in the service.

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

Default: 00:01:00

DiscardOrphanConditions

Ignores missing conditions if it relates to an OR condition.

Valid Values:

  • 0: Add all conditions

  • 1: Ignore OR conditions if missing.

Default: 1

EmailSender

Valid Values: E-mail address from which alerts are being sent.

Default: bim@bmc.com

EmailServer

Defines the E-mail server and port that is used to send 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.

ExecuteConfirmedJobs

Enables you to execute jobs that are waiting confirmation.

Valid Values:

  • 0: Do not execute jobs.

  • 1: Execute at New Day.

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

Default: 0

FailoverMaxRetry

Maximum number of times the Batch Impact 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 equal to or greater than 1.

Default: 10

FailoverMinUptime

The amount of time that the Batch Impact 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 has been maintained for more than 30 minutes, the counter is reset.

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

Default: 00:30:00

JobNameMode

The field is used to identify a job in Control-M. Batch Impact Manager uses this parameter when processing the PROBLEMATIC‑JOBS auto edit variable.

Valid Values:

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

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

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

Default: JOBNAME/MEMNAME

MailCorrectionMessage

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

Valid Values: String expression.

MaxNumDetectThreads

Maximum number of threads for recalculating the status of the service.

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

Default: 2

MaxNumOfVpsWithScenario

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

Default: 3

MaxSimulationDays

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: Any whole number equal to or greater than 1.

Default: 2

MinGapToJobParents

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

Default: 60

NewJobsInterval

Interval at which Batch Impact Manager will check to see if new jobs have been added to the critical service.

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

Default: 00:01:00

NumberOfReportDays

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

If you update this parameter, you need to update this same parameter with type general.

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

Default: 90

PrevDaysCyclicOnly

Determines if 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

PrevDaysOrphanConditions

Determines the number of previous ODATs not to raise Orphan conditions

Valid Values:

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

  • 1: All Orphan conditions, that the jobs waiting for this condition are of an ODAT that is 1 day or more prior to the CTM Server ODATwill not be raised, so the jobs waiting for this condition, will not run.

Default: 0

SendMailCorrectionMessage

Determines whether to send the correction message or not.

Valid Values:

  • 0: Do not send

  • 1: Send

Default: 1 (send)

SupportWorkLoadResources

Determines if load balancing of quantitative resources is supported.

Valid Values:

  • 0: Not supported

  • 1: Supported

Default: 1

UseDoCondition

Determines whether to 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

API Parameter Name: useDoCondition

Control-M Forecast Parameters

System variables influence the behavior of Control‑M/Forecast components and features. The table describes the function of each Control‑M/Forecast -related system parameter and lists its default, if one exists.

Control‑M/Forecast administrators can change the value of most of these system parameters. If, however, a system parameter is to be modified only upon instruction of Customer Support, this is noted in the description of that system parameter.

After modifying any of these system parameters, you must stop and restart the Forecast server.

Parameter

Description

AddAllOrphanConditions

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

AddVirtualOrphanConditions

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

AllowQueryFieldValues

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

DiscardOrphanConditions

Ignores missing conditions if it relates to an OR condition.

Valid Values:

  • 0: Add all conditions

  • 1: Ignore OR conditions if missing.

Default: 1

DisplayControlMTimeStartDay

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

This parameter is set to ctm_new_day and the new day is at 07:00 and the time is 23:00.There is a job that needs to run from 06:00 to 06:30. In Forecast, it shows that it will run today at 06:00 (because it's before the new day). If the system parameter set to midnight then it will run tomorrow (+1)06:00 because it's after midnight.

ExecuteConfirmedJobs

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

IgnoreDeviationSampleCount

Defines how many exceptional historical samples should be ignored when calculating the average runtime for reporting purposes.

Default: 2

MaxForecastJobsInMem

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

This parameter affects the Forecast domain in Control-M Desktop and requests submitted via the Control-M/Forecast utility.

MaxForecastRunningRequests

Maximum number of Forecast requests that can run simultaneously.

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

Default: 5

max_futureplan_cb_seq_size

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

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

Default: 1,000

MaxSimulationDays

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 equal to or greater than 1.

Default: 2

ScenarioMaxSize

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

SimulatorEngineStep

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

Valid Values:

  • 1: Improves accuracy

  • 10: Default:

  • 60: Improves performance

SockRecrMaxAtmp

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

Default: ‑1 (no limit)

SockRecrWtIntr

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

Valid Values: Any whole number greater than 0.

Default: 10

SupportWorkLoadResources

Determines if load balancing of quantitative resources is supported.

Valid Values:

0: Not supported

1: Supported

Default: 1

UseDoCondition

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

upd_progress_interval_sec

If Control‑M/Forecast should send updates when loading a forecast.

Valid Values:

  • 0: No

  • 1: Yes

Default: 1

UserDailyCmdRegexp

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[^ ]*

The regular expression, ^.*ctmudly[^ ]*, identifies jobs that call ctmudly, regardless of the specified path or file extension.

UserDailyFileNameRegexp

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.*

If you use this system parameter, you must also use the UserDailyParamNO system parameter so that Control‑M/Forecast can access the name of the user daily.

UserDailyParamNO

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 equal to or greater than 1.

Default: 1

Control-M Workload Archiving Parameters

The following table describes the Control-M Workload Archiving parameters.

Parameter

Description

ArchiveLastRead

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

ArchiveRetentionPeriod

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

If the value of today's date is bigger than value of ArchiveLastRead and the number defined for this parameter, then jobs are not archived and an Xalert is sent.

Default: 30

ArchiveUserName

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

Default: arcuser

ArchiveSearchRequestJobsLimit

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

Default: 10,000

Valid Values: 1–10,000

Changing the Gateway user

This procedure describes how to change the Gateway user from the default CTMSYNC. This user is used to synchronize scheduling definitions between Control-M/EM and Control-M for z/OS or Control-M/Server.

Begin

  1. From the Components Tree pane, select the Control-M/EM component and from the Home tab, in the Definitions group, click System Parameters.

    The Control-M/EM System Parameters dialog box appears.

  2. In the left pane, click Advanced.

  3. Click .

    The Control-M/EM - New System Parameter window appears.

  4. Do the following:

    • In the Type field, type gtw.

    • In the Name field, type CTMSyncUser.

    • In the Value field, type the user that you want to use to override CTMSyncUser.

    • In the Component area, from the Type drop-down list, select Gateway.

    • In the Name field, type the user that you want to use to override CTMSyncUser.

    • If you want to apply this parameter to specific Control-M/Servers, in the Host field, type the name(s) of the Control-M/Server(s).

    • Click Save.

  5. Recycle the Gateway, as described in Recycling a component.

Enabling Control-D/WebAccess Server Output in Control-M Web

This procedure describes how to enable Control-D/WebAccess Server output in Control-M Web, which allows you to view Control-D/WebAccess reports from the Monitoring domain in Control-M Web.

Relevant for Control-M for z/OS only.

Before you begin

Ensure that you do the following:

  • Compile the IOAX016E user exit and create the member EMREQUSR in the IOA PARM library.

    Comments in the source of the User exit IOAX016E contain a description of the member’s EMREQUSR structure.

    For more information, see Exits and Running the ICE Automatic Exit Installation Tool in the INCONTROL for z/OS Administrator Guide.

  • In Control-D/WebAccess Server, add the Verify user and user token parameters, as described in Automatic Login in Control-D/Desktop for Control-D/WebAccess Server Administrator Guide.

Begin

  • In the CCM, add the following Control-M/EM system parameters:

    • ControlDWaURL

    • ControlDRepository

For more information, about the parameters, see Control-M Self Service Parameters.

You are now able to view Control-D/WebAccess Server output in Control-M Web. For more information, see Viewing Job Output. in the Control-M Web documentation.

Mapping the Control-M Help to the Control-M Web Server

This procedure describes how to map the location of the Control-M Help from documents.bmc.com to the Control-M Web Server. This allows users to access the Control-M Help within your organization without providing access to the Internet.

Begin

  1. Select a Control-M/EM component,and then click System Parameters.

    The Control-M/EM System Parameters dialog box appears.

  2. In the left pane, click Advanced.

  3. In the Name column, type ForceWebServerOLH.

  4. Double-click the parameter and in the Value field, type 1.

  5. Click Save.

The Control-M Help is now accessed from the Control-M Web Server.