Configuring Control-M/EM System Parameters
This procedure describes how to configure Control-M/EM system parameters
You can also define parameter values with Control-M Automation API, as described in Control-M/EM System Settings Configuration. Parameter names that differ in Control-M Automation API are indicated on this page where relevant.
Begin
-
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.
-
In the left pane, click Advanced.
-
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: Determines one of the following refresh types:
-
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 must recycle (stop and restart) the component, such as the Control-M/Server, for the change to take effect.
-
Manual: You must perform an action that refreshes the parameter value, but a recycle is unnecessary.
-
-
Last Updated
-
-
Double-click the required parameter.
The Control-M/EM - Update System Parameter dialog box appears.
-
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 host.
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
-
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.
-
In the left pane, click Audit and Annotation.
-
For each field, type the required value, as described in Audit and Annotation Parameters and Audit and Annotation User Categories.
-
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 and logout attempts and 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 one of the following component desired states in the CCM, as described in Component Status:
|
Configuration Management |
|
Control-M Security |
|
Database Maintenance |
Checks database space and extend databases, as described in Database Maintenance and Cleanup. |
High Availability |
See High Availability. |
Control-M Web Parameters
The following table describes Control-M Web parameters.
Parameter |
Description |
---|---|
Common |
|
EnabledVaultProviders |
Determines which Vault Providers are enabled. Default: all API Parameter Name: enabledVaultProviders |
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
|
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:
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:
|
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
-
Open the Control-M Configuration Manager.
-
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.
-
In the left pane, click Self Service.
-
For each field, type the required value, as described in Control-M Self Service Parameters and Control-M Web Parameters.
-
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
-
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.
-
In the left pane, click Control-M Workload Change Manager.
-
For each field, type the required value, as described in Control-M Workload Change Manager System Parameters and Control-M Web Parameters.
-
Click Activate Changes.
Configuring Control-M Workload Change Manager Email Notifications
This procedure describes how to enable Control-M Workload Change Manager to send email notifications from the Administrator.
Begin
-
From CCM, from the Home tab, click System Parameters.
The Control-M-EM - System Parameters window opens.
-
In the left pane, click the Advanced tab, navigate to the general type parameters and click the EmailServer parameter.
-
In the Value field, enter a valid email server and click Save.
-
In the left pane, click the Workload Change Manager tab, enter the Administrator email address in the E-mail Sender field, click Activate Changes and Close.
-
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:
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 Control-M. 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
-
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.
-
In the left pane, click Manage SSL.
-
For each field, type the required value, as described in Manage SSL System Parameters.
-
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
Parameter |
Description |
---|---|
act_chk_inpermitt_gcs_gui |
Do not modify this parameter unless requested by BMC Customer Support. Default: N |
ActivateApplications4NonAdmin |
Determines whether to activate applications for users who do not have administrator rights. Valid Values:
Default: 1 |
AlertsLimit |
Limits the number of alerts. If you set the value to 0, Control-M client shows unlimited number of alerts. |
Determines 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 |
|
Determines 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:
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:
Default: Permitted |
AllowLoginWithNonTrustedSSLCertificate |
Determines whether to enable users to log in to Control-M client 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:
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:
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:
Default: 1 API Parameter Name: auditCleanup |
AuditFullDefinitionChanges |
Determines whether to audit all changes to the job definition when it is updated. Valid Values:
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:
Default: 1 This parameter is used in the Control-M client 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 |
Determines the default bulk size for database bulk operation. Valid Values: 10–10,000 Default: 100 |
bulk_def_storage_len |
Defines the default value for storage length in bulk operation. Must be at least as long as the longest field involved in the bulk operation. Default: 264 |
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:
Default: 1 |
CheckLimitsSwitch |
Determines whether to check if OS resource limits are set appropriately. Valid Values:
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 event privileges. Valid Values: <String_Expression> Default: GCSERV |
ClientSSO |
Determines whether the Disable SSO Mode checkbox appears in the Control-M login window. Valid Values:
Default: Off |
CollectEMStatistics |
Determines whether the Control-M/EM Statistics collection mechanism is on or off. Valid Values: 0: Off 1: On Default: 1 |
CollectStatisticsByField |
Defines 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:
The information is saved in the Control-M/EM database. Valid Values:
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:
Default: 1 |
ControlM_EM_Version |
Specifies the Control-M/EM version. |
ControlResourceForSMARTTable |
Determines whether Control Resources can be defined for SMART folders and sub-folders in Control-M/Servers 7.0.00.200 and higher. Control-M/EM 7.0.00.300 and lower cannot log in to Control-M/EM. Valid Values:
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 the Control-M/Server to Control-M/EM and are not automatically uploaded from Control-M/EM to the 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 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 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 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 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 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:
Default: Y If this feature was disabled during the fix pack installation, you must change RBC names that start with ! and run the enable_exclude_rbc.pl perl script from the <scripts> directory. |
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 greater than or equal to 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:
Default: Off |
DirectoryServerChaseRef |
Determines if LDAP search action should chase referrals suggested by the server. Valid Values:
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 Control-M/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:
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:
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. Default: If no value is used, the parameter value is interpreted as blank. |
DirectoryServiceType |
Defines the LDAP directory type or vendor that is available to the enterprise, such as Active Directory, iPlanet, or Apache Directory. This definition points to the relevant parameter load section in the DirectoryServiceType.cfg configuration file in the ctm_em/etc directory—this parameter value must be listed in this file. Two default directory service types (Active Directory and iPlanet) are provided in the configuration file. Default: Active Directory. |
DirectoryServiceValidation |
Determines the validation level of Directory Service parameters when connecting to LDAP. Valid Values:
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:
Default: TCP |
DirectoryUsersSearchRoot |
Defines the starting point, such as the domain and country, in the directory tree structure. The domain name values in this field support both dot-separated or DN format.
You can define multiple starting leafs by separating them with :. The lookup order is from left to right, according to the domain list order. If the value of this parameter is NULL then a default value will be used, only if the DirectorySearchUserDN parameter is not blank. You can leave the DirectoryUsersSearchRoot parameter blank only if the DirectorySearchUserDN has a configured value. The default DirectoryUsersSearchRoot value is the domain of the search user. If the DirectorySearchUserDN parameter value is [email protected], 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 email server and port that is used to send notification emails to Control-M Workload Change Manager end users, in the following format: <Server_Host>[:<Port_Number>] If no port is defined, it defaults to 25. |
EmailRecipients |
Defines the email addresses that receive the high availability alerts. You must separate multiple email addresses with , (commas). |
EmdefValidationVersion |
Determines the validation version used by the emdef utilities. Valid Values:
Default: 2 |
EnableRemoteBrowsing |
Enables you to browse for a script in a file system on an Agent node from the job properties pane. Valid Values:
Default: Y |
Environment Title |
Defines the logical name for the Control-M/EM environment, which appears in the Control-M title bar. Valid Values: 1–255 characters of free text. API Parameter Name: environmentTitle |
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 event action (add or delete event). Valid Values:
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:
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 number or port range for each component instance, you need create additional HostPort system parameters, as described in Configuring Control-M/EM System Parameters. Format:
|
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:
|
IPV_MODE |
Determines whether to enable IPV6. Valid Values:
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 the Control-M/Server or Agent is installed on AIX, verify that the fix for APAR IV23320 is installed. 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:
Default: use_account_locale |
LimitGCDistribActivate |
Determines whether to enable or disable limitations on the distribution of global events using the Global Conditions Distribution facility. Valid Values:
Default: _1 |
LimitGCDistribExcludeDates |
Dates for which global events are distributed, regardless of limitations specified using the LimitGCSDistribMaxDays parameter. Dates are specified in mmdd format and are comma-separated. Default: STAT |
LimitGCDistribMaxDays |
Defines the range of days within which events 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 the GUI Server, which the Control-M Self Service Web server must connect to. 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 that asks 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 greater than or equal to 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:
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:
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:
|
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 If the value is 0, automatic account locking is disabled. To unlock a user, log in as an Admin user, and open the user properties from the Users window in the Configuration domain and clear the Lock Account checkbox. If the Admin user is locked, and there is no other Admin user that is authorized to unlock the account, run the following utility: - unlock_user -username <EM_Client_User> -U <DBOUser> -P <DBOPassword> |
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 must comply with complexity rules. If a Control-M administrator uses the Authorization facility to set a password, this parameter is ignored. Valid Values:
Default: 0 |
PasswordComplexityRules |
Defines one, some, or all of the following PasswordComplexityRules separated by a blank space. Multiple values are joined by AND Boolean logic. If a Control-M Administrator uses the Authorization facility to set a password, this parameter is ignored. Valid Values:
Default: PWD_DIGIT PWD_UPPER PWD_LOW PWD_NON_LETDIG |
PasswordEncode |
Determines how user passwords are transmitted by clients to the server. Valid Values:
Default: 2 |
PasswordExpirationOnOff |
Determines whether password expiration parameters should be checked. Valid Values:
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:
Default: 0 |
PasswordLifetimeDays |
Determines the number of days before the password expires. The set_pwd_def_lifetime script runs manually after you change this parameter, and affects all users, including emuser. You must recycle the GUI Server and CMS for this parameter to take effect. Valid Values: 1–365 Default: 60 |
PermitManualUnlock |
This parameter specifies whether non-Administrators can manually unlock their own tables, such as when tables are locked during an abnormal disconnect from the GUI Server. Non-administrators will not be able to unlock other user tables. Valid Values:
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 proxy server hostname and port number for all users who connect to the Newsfeed via a proxy server, as follows: <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:
Default: Y |
RFPGUseDeclareFetch |
Determines whether to enable the UseDeclareFetch option in Control-M Reports with PostgreSQL database. Valid Values:
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 pathname of the script that is activated when an alert is generated. This script is activated only if the value of SendSnmp is either 1 or 2. Valid Values: Full pathname of the script that is activated when an alert is generated. Default: script_name When you send Alert data as input to a script, the parameters are sent in the following format: Copy
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 higher. Test SNMP traps when enabling this parameter as follows.
On Windows, \\ (double back-slashes) are used as a delimiter. |
SendAlertNotesSnmp |
Specifies whether Alerts NOTES data field text should be sent to SNMP and script. Valid Values:
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:
Default: 0 |
SendRuntimeEstimations |
Specifies whether BIM runtime information updates are sent to the GUI. Valid Values:
Default: 0 |
SendSnmp |
Determines where Alert data is to be sent. Valid Values:
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 client. Valid Values:
Default: 1 |
SnmpHost |
Hostname or a list of hostnames—you must use ; as delimiters—to send the SNMP trap on an alert. You can use : to define specific ports. Valid Values: Valid hostname or IP address. Default: <No_Host> dhost1;jhost2;myhost3:2000 |
SnmpSendActive |
Determines whether SNMP messages for Active Alerts are generated. Valid Values:
Default: 0 |
SubApplicationFieldIsMandatory |
Enables you to set a mandatory Sub Application field for job definition. Valid Values:
Default: 0 |
UnsupportedClientVersions |
For BMC 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:
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:
Default: 0 API Parameter Name: userAuditAnnotation |
UserAuditOn |
Determines whether activities specified by UserAuditContext are recorded in the database. Valid Values:
Default: 1 API Parameter Name: userAudit |
UseAutoReconnect |
Defines the reconnection invocation method. Valid Values:
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 for z/OS. Valid Values:
Default: 0 |
ViewSysoutHeadSizeKB |
Displays the first KB of the output file. Valid Values:
Default: 0 |
ViewSysoutTailSizeKB |
Displays the last KB of the output file. Valid Values:
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 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:
BMC Software recommends that you not define a value greater than 30 because of possible performance degradation. To deactivate version history, set the parameter to 1 (keep current version only). Valid Values: Any whole number that is greater than or equal to 0. Default: 2 (current version, and one history version) Refresh Type: Manual API Parameter Name: numberJobVersionsToKeep |
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 login 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 the emThrift web app to retrieve servers. Valid Values:
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:
Default: 1 |
XAlertsEnableSending |
Determines whether the option to send exception alerts is enabled or disabled. Valid Values:
Default: 1 |
XCTMDoForceAudit |
Enables a XCTM Do Force Audit. Valid Values:
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 instead authenticated by the Control-M/Server. |
XCTMDoForceUser |
Defines the user with authorization to run the requested folder or 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:
Default: 1 API Parameter Name: alertOnJobFail |
AlertOnAbendTableEntity |
Determines whether to create an alert for a SMART folder that ended Not OK. Valid Values:
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:
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:
The information is saved in the Control-M/EM database. Valid Values:
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 greater than or equal to 1,000,000. Default: 50,000,000 |
CommEMBufferSize |
The number of bytes buffered in Gateway that are waiting to be sent to other Control-M/EM servers. If the number of bytes are exceeded in GUI Server or GCS components, communication with Control-M/Server is terminated. Valid Values: Any whole number that is greater than or equal to 1,000,000. Default: 50,000,000 |
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:
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 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:
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 greater than or equal to 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:
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:
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 |
Do not change this parameter unless instructed to do so by BMC 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 hostname 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:
Default: 0 |
HostPortList |
Listening port hostname and port number for Gateways. List the hostname and port number in the following format: <Hostname >:<Port_Number> 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 greater than or equal to 1. Valid Values: Do not change this parameter unless instructed to do so by BMC 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 greater than or equal to 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 greater than or equal to 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 parameter unless instructed to do so by BMC 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 for 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 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 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 Customer Support. Default: 100 |
RunInfoUpdCtx |
Configures the context in which run information is processed. Valid Values:
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 Customer Support. Default: 10 |
SSLRetries |
Determines the number of times that Control-M/EM attempts to establish communication with the Gateway before turning the SSL on or off. SSL can either be enabled or disabled when Control-M/EM initially tries to connect to the Gateway. After making the specified number of attempts, SSL is toggled on or off (as required). This parameter is relevant only when SSL Enabled communication is selected. It does not work when only TCP/IP is selected. Valid Values: Do not change this parameter unless instructed to do so by BMC Customer Support. Default: 2 |
SSLSyncTime |
Replaces the value of the Sync_Timeout parameter in the Defaults.rsc file, which determines the period of time between attempts to establish communication with the Gateway when changing the communication protocol to SSL Enabled. Valid Values: Do not change this parameter unless instructed to do so by BMC Customer Support. Default: 90 |
StatCollection4Distributed |
Determines which job definitions attribute 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 |
Determines the number of seconds between sending groups of events to a reconnecting data center. Valid Values: Do not change this parameter unless instructed to do so by BMC 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 Customer Support. Default: 1,000,000 |
CleanOldIntSecs |
Interval, in seconds, when the GCS deletes unused events from the database. These events may have no data center destinations. Valid Values: 601 seconds (10 minutes) Default: 900 (15 minutes) |
CleanOldTimeSecs |
Maximum time, in seconds, unused events wait in the database before they are removed. These events 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 events from memory and the database. Valid Values: Do not change this parameter unless instructed to do so by BMC Customer Support. Default: 120 |
GcDistributionPolicy |
Determines how to handle conflicting add or delete requests for global events when the requests are received within the interval specified in GcDoneWaitSecs. Valid Values:
Default: TOGGLE |
GcDoneWaitSecs |
Determines the minimum number of seconds that global events wait in memory, after they have been sent to all connected data centers, before they are removed. This waiting period prevents events from being sent again. Valid Values: Do not change this parameter unless instructed to do so by BMC Customer Support. Default: 120 |
GcMaxRetries |
Maximum number of retries to send events to a data center that had previously returned a temporary error. Valid Values : Do not change this parameter unless instructed to do so by BMC Customer Support. Default: 5 |
GcRetryIntSecs |
Determines the number of seconds between attempts to send events to a data center that had previously returned a temporary error. Valid Values: Do not change this parameter unless instructed to do so by BMC Customer Support. Default: 180 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 resending messages. BMC recommends that you change the value to 360 or higher, 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:
Default: 1 |
GcXAlertSending |
Determines whether to enable or disable sending XAlerts when a event is not sent. Valid Values:
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 Customer Support. Default: 10,000 |
SrvrsPollIntSecs |
Determines the number of seconds between attempts to communicate with a Gateway. Valid Values: Do not change this parameter unless instructed to do so by BMC Customer Support. Default: 60 |
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 Customer Support. Default: 60 |
Global Conditions Server (GCS) Logging Parameters
The following table lists Global Conditions Server (GCS) logging parameters.
Parameter |
Description |
---|---|
CondLogLvl |
Determines the information log level for event (condition) transfer activities. Information is displayed for events received (In), events sent (Out), transfer confirmation and rejection actions, and communication problems. Valid Values:
Default: 2 |
DbLogLvl |
Determines the information log level for messages related to database activities. Diagnostic information appears about event transfer requests inserted or deleted in the database or read from the database for recovery operations. Valid Values:
Default: 2 |
IntLogLvl |
Determines the information log level for messages related to internal GCS actions involving temporary problems and rebound situations. The information appears about GCS event handling activities. Valid Values:
Default: 1 |
LogSize |
Determines the maximum number of record lines in the GCS_LOG file. When the number of record lines in the currently open GCS_LOG file reaches the value specified in this parameter, the file is closed and a new GCS_LOG file is opened. Valid Values: Any whole number that is greater than or equal to 0. If the value is 0, the file never closes, because there is no maximum size. Default: 15,000 KB |
MaxLogs |
Determines the maximum number of log files that are cyclically managed. When the number of GCS_LOG files reaches the value specified in this parameter, the oldest file is deleted, in order for a new GCS_LOG file to be created. Valid Values: Any whole number that is greater than or equal to 0. Default: 5 |
ShowMsgIDLog |
Determines whether to display the new Message ID in the GCS Log. Valid Values:
Default: N |
Control-M Self Service Parameters
The following table describes the Control-M Self Service parameters.
You must stop and restart the Self Service Server component to implement the parameter changes.
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 hostname 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 event 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 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 events 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 |
ExtendedWebLanagues |
Determines whether to enable Simplified Chinese or Traditional Chinese as a supported language in Control-M Web. Valid Values:
Default: Empty |
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–13,1072 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
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 email Subject field that is sent to the end users after the request state changes. Valid Values:
Default: Your request <REQUEST_NAME> for Ticket ID <CHANGE_ID> has been <ACTION>. |
WCMLoginLogoPath |
Defines the location of your organization logo that is displayed in the Control-M Workload Change Manager login page. |
SiteLogoPath |
Defines the location of your organization logo that is displayed in the Control-M Workload Change Manager interface. c:\Control-M Workload Change Manager.jpg
|
SiteInterfaceLanguage |
Determines one of the following as the default language for the Control-M Workload Change Manager interface for all users:
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 folder Enforce validations 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:
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:
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 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:
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:
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:
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
The following table describes the GUI parameters.
You must stop and restart the GUI component to implement the parameter changes.
Parameter |
Description |
---|---|
CCMUserInactivityTimeout |
Determines the maximum number minutes of inactivity before the user is automatically logged out from the CCM. Valid Values:
Default: 30 |
ClientRestrictions |
Determines restrictions that prevent unnecessary job runs. Valid Values:
Separate values with a , (comma). |
GettingStartedCustomizedURL |
Defines the customized HTML page URL that is used for the Welcome window in Control-M client. |
OrbShutdownWait |
(For Customer Support use only) Control-M/EM and Control-M/Server wait for acknowledgment from the CORBA Object Request Broker (ORB) before shutting it down. Valid Values:
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 whether a user can change their own password. Valid Values:
Default: 1 |
allowCheckinWithValidationErrors |
Enables you to check in your Workspace with validation errors. Valid Values:
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. 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.
The following table describes the GUI Server parameters.
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:
Default: UPDATE_ACCESS |
AddJobsChunkSize |
Chunk size of jobs during Viewpoint 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:
Default: true API Parameter Name: allowReferencePath |
AuthenticationLevel |
Do not change this parameter unless requested to do so by BMC Software. Default: 2 |
AuthorSecurity |
Determines whether a lenient, strict, or very strict security policy is enforced when jobs are checked in. Control-M security uses the Created By (author) job attribute and the AuthorSecurity system parameter to ensure that only authorized users can check in jobs. If this parameter is modified, offline Control-M users must log on for the modified setting to sync to their account. Valid Values:
Default: 1 |
BIMCommLoopInterval |
Do not change this parameter unless instructed to do so by BMC Customer Support. |
BIMThreadPoolIdleTime |
Do not change this parameter unless instructed to do so by BMC Customer Support. |
BIMThreadPoolMaxSize |
Do not change this parameter unless instructed to do so by BMC Customer Support. |
BIMThreadPoolMinSize |
Do not change this parameter unless instructed to do so by BMC Customer Support. |
bulk_act_cond |
Determines the bulk size in bulk operation for retrieve events. 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 |
Determines the bulk size in bulk operation for retrieve tables. Valid Values: 10–10,000 Default: 100 |
bulk_act_job |
Determines the bulk size in bulk operation for retrieve jobs. Default: 250 |
bulk_act_res |
Determines the 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:
Default: false API Parameter Name: checkDoForceJobAuthorizations |
CloseOldDownloads |
Do not change this parameter unless instructed to do so by BMC Customer Support. |
ConcurrentCollections |
Determines the number of collections that can be read in parallel. If set to 1, collections are read serially. Increasing this number improves response time but may use more CPU resources. 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, such as 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 |
Determines the maximum number of control resources that can be loaded into memory from the Control-M/EM database at the same time. This parameter can help control memory usage. However, if this parameter is set to -1, there is no maximum limit. Default: -1 |
DelayBeforePinning |
Determines 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 |
Determines the number of jobs that appear to the user in the Deleted Jobs dialog box in the Control-M. Valid Values: 0 or any negative value Default: 2,000 |
EMAPIActiveJobsLoadLimit |
Determines the number of jobs in the Active Jobs database that are checked by the GUI Server when processing the request_act_retrieve_jobs request, and included in the request response. Valid Values: from 10 to -1 (unlimited) Default: 1,000 |
EMThreadPoolIdleTime |
Do not change this parameter unless instructed to do so by BMC Customer Support. |
EMThreadPoolMaxSize |
Do not change this parameter unless instructed to do so by BMC Customer Support. |
EMThreadPoolMinSize |
Do not change this parameter unless instructed to do so by BMC 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.
Valid Values:
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.
Valid Values:
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 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:
Default: 0 |
FailCheckDBTimeOut |
Determines the time, in seconds, until the GUI Server checks the communication status of the database server. If communication is still down, communication is considered to be disrupted and the action specified in StopIfDBConnectionFail is implemented. 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 |
Determines 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 Customer Support. |
MaxUserTimeoutSec |
Determines the time, in seconds, that a Control-M/EM API client user token can be valid. Afterwards, the GUI Server can invalidate the token. After modifying this parameter, stop and restart all GUI Server components for the change to take effect. Default: 10,800 |
MaxConcurrentUserSessions |
Determines the maximum number of concurrent sessions per user in Control-M client and Control-M Web.
|
NumberOfMyWorldJobs |
Determines the 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:
Default: 1 |
PrereqConditionsLoadLimit |
Determines the maximum number of prerequisite events 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 |
Determines the maximum number of quantitative resources that can be loaded into memory from the Control-M/EM database at the same time. This parameter helps control memory usage. When QuantResourceLoadLimit is -1, there is no maximum limit. Default: 1 |
QueriedCollection |
Determines the collection of jobs to include in the Network Neighborhood Collection. Valid Values:
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 Customer Support. Valid Values:
If the GUI Server prompts for confirmation, carefully consider the following factors before confirming the request:
Default: 0 |
SockRecrMaxAtmp |
Determines the 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 |
Determines the 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 |
Determines the 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:
Default: 1 |
ViewpointPolicy |
Determines which SMART Folders are passed to the Viewpoint. Valid Values:
Default: SELECT_JOBS API Parameter Name: viewpointSmartFolderPolicy |
ViewPointTimeoutForBIM |
Determines 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 |
Determines the default size of the updates queue for a Viewpoint. Default: 5,000 |
UpdatesQueueMaxLimit |
Determines the maximum possible size of the updates queue for a Viewpoint. Default:60,000 |
AlertsMapRefreshInterval |
Determines the frequency, in seconds, that Global Alerts updates its database about which Alerts were deleted and why. The update occurs only when both the specified time has passed and one or more alerts have been deleted. Default: 60 |
GatewayOutgoingQueueSize |
Determines the maximum number of bytes buffered in the GUI server waiting to be sent to Control-M/Server, such as a result of a Save JCL request. Warning: Do not change this parameter unless instructed to do so by BMC Customer Support. Default: 500,000 |
RemedyCloseTicketMode |
Determines how a Remedy ticket is closed, and what effect that has on the alert status. Valid Values:
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 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 greater than or equal to 20. |
CmsCommMode |
Determines how the Configuration Management Server connects to the Control-M/Server Configuration Agent. Valid Values:
Default: TCP |
CmsCtmNGRefreshInterval |
Determines the refresh interval, in seconds, for collecting host group data. Valid Values: 0–10,000 (0: Host Group data is not collected.) Default: 900 |
CmsCtmRefreshInterval |
Determines the number of seconds between each refresh episode. The Configuration Management Server (CMS) refreshes the status and topology of the Control-M/Servers on a regular basis. Valid Values: Any whole number that is greater than or equal to 30. Default: 60 |
CmsEmRefreshInterval |
Determines the number of seconds between each refresh episode. The CMS refreshes its internal image of Control-M/EM component status on a regular basis. Valid Values: Any whole number that is greater than or equal to 30. Default: 30 |
CmsGateAdditionalParams |
Do not change this parameter unless instructed to do so by BMC Customer Support. |
CmsHostSpecRetrieverInterval |
Determines the number of times every 24 hours to send internal requests to obtain host 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 |
Defines the hostname or IP address where the CMS is forced to receive XAlerts. Valid Values: Any valid hostname or IP address. If no value is entered for this parameter, the hostname on which the CMS is installed is used. Default: null |
CmsXAlertsPort |
Determines the port where 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:
This parameter is only valid when the XAlertsSendSnmp system parameter is set to 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 greater than or equal to 0. Default: 30 minutes |
IdenticalXAlertCompareDesc |
Determines whether the MESSAGE field is used to compare identical alerts. Valid Values:
Default: 0 |
IdenticalXAlertHandling |
Determines whether identical alerts are sent as an SNMP trap or to a script. Valid Values:
This parameter is only valid when the XAlertsSendSnmp system parameter is set to 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 greater than or equal to 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 greater than or equal to 2. Default: 7,300 |
ManageSSL_CertKeyLengthBits |
Determines the number of bits of the certificate key in the Manage SSL Generate Certificate Wizard. Valid Values:
Default: 1,024 |
MaxXAlerts2Send2Client |
Valid Values: Do not change this parameter unless instructed to do so by BMC Customer Support. Determines the maximum number of exception alerts sent from the CMS to the Exception Alerts window. Default: 2,000 |
RemoteCmdTimeout |
Determines the amount of time, in seconds, that the CMS waits for a reply to a remote request sent via the CMS to the Control-M/Server, Agent, and plug-ins, before it times out. An example of such a request is a ping agent request. Valid Values: Any whole number that is greater than or equal to 30. Default: 300 |
RunInfoStatsPurgeDays |
Determines the number of days to retain deleted statistics, after which the statistics will be deleted when automatic purge is performed. Valid Values: Any whole number that is greater than or equal to 1. Default: 100 |
RunInfoStatsPurgeInterval |
Determines the number of 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 greater than or equal to 1. Default: 30 |
UsageAlertsState |
Determines whether Usage Alerts are enabled. Valid Values:
Default: 0 |
UsageCollectionDisabled |
Determines whether to automatically activate the usage collection tool. Valid Values:
Default: 0 |
VMCleanupIntervalMinutes |
Determines the number of 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 greater than or equal to 30. Default: 30 |
VMMaxDaysRetainCurJobsHistory |
Determines the number of days after which the history of the current jobs is automatically deleted. A job version is deleted only when all of the following are true:
Valid Values: Any whole number that is greater than or equal to 0. Default: 180 |
VMNumDaysRetainDeletedJobs |
Determines the number of days to retain deleted jobs and their history. Deleted tables will also be deleted according to this value. Valid Values: Any whole number that is greater than or equal to 1. Default: 180 |
XAlertsSendSnmp |
Determines whether an alert will be sent as an SNMP trap, to a script, both, or neither. Valid Values:
Default: 0 |
XAlertsMaxAge |
Determines the number of days that XAlerts are saved before they are deleted by the Configuration Management Server. Valid Values: Any whole number that is greater than or equal to 0. Default: 180 days |
XAlertsMaxHandled |
Determines the maximum number of handled XAlerts that are displayed in the Exception Alerts window. Valid Values: Any whole number that is greater than or equal to 0. Default: 100 |
XAlertsSnmpHosts |
Defines the hostnames of the machines to which you want to send the SNMP trap. Valid Values: Any hostname or IP address. Separate multiple hosts with a semicolon. To add a specific port for each host, enter the hostname followed by a colon and the port number. XAlertsmachine:7000;SNMPmachine;Scriptsmachine:7001 Default: null |
XAlertsSend2Script |
Defines the pathname and filename of the script to be sent. This parameter is used only when the XAlertsSendSnmp system parameter is set to 2 or 3. Valid Values: Any pathname and filename. Default: null |
XAlertsDisableMsgIDs |
Defines the message IDs for which no XAlerts are sent. By default, no message IDs are listed. Use a comma to separate multiple message IDs. Default: none |
XAlertsMinSeverityFilter |
Determines the severity level filter. XAlerts with a value greater than or equal to the specified severity level are sent to the Exception Alerts window. Valid Values:
Default: Warning |
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 |
Determines whether you can add external or orphan events (conditions). Manual events 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:
Valid Values:
Default: 2 |
AddVirtualOrphanConditions |
Determines whether to ignore delete events if they are needed by other jobs and there are no other jobs that add them. Valid Values:
Default: 0 |
AlertConsolidationMode |
Determines whether the BMC Batch Impact Manager consolidates email alerts, BMC Remedy ITSM incidents, and shout messages. Valid Values:
Default: 1 |
AllowReportViewing |
Determines whether non-administrator-level users can view service reports Control-M Web. Valid Values: 0–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 or more GUI Servers, separated by , (commas). Valid Values: String expression. |
BIMUserName |
The username 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 events 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 greater than or equal to 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 events if it relates to an OR event. Valid Values:
Default: 1 |
EmailSender |
Valid Values: Email address from which alerts are being sent. Default: [email protected] |
EmailServer |
Defines the email 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:
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 greater than or equal to 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:
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 Service status. Valid Values: Any whole number greater than or equal to 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 greater than or equal to 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 must update this same parameter with type general. Valid Values: The number of days greater than or equal to 1. Default: 90 |
PrevDaysCyclicOnly |
Determines if the parameter PrevDaysOrphanConditions is for Cyclic jobs or for all jobs. Valid Values:
Default: 0 |
PrevDaysOrphanConditions |
Determines the number of previous ODATs not to raise Orphan events Valid Values:
Default: 0 |
SendMailCorrectionMessage |
Determines whether to send the correction message or not. Valid Values:
Default: 1 |
SupportWorkLoadResources |
Determines if load balancing of quantitative resources is supported. Valid Values:
Default: 1 |
UseDoCondition |
Determines whether to add events created by On Do Actions. Valid Values:
Default: 1 API Parameter Name: useDoCondition |
Control-M Forecast Parameters
Control-M/Forecast administrators can change the value of most of Control-M Forecast system parameters.
The following table describes the function of each Control-M Forecast system parameter
You must stop and restart the Forecast Server to implement the parameter changes.
Parameter |
Description |
---|---|
AddAllOrphanConditions |
Determines whether to add external or orphan events. These types of events do not exist when Control-M Forecast generates its forecast for one of the following reasons:
Valid Values:
Default: 2 API Parameter Name: addOrphanEvents |
AddVirtualOrphanConditions |
Determines whether to ignore delete events that other jobs require if no other jobs add them. Valid Values:
Default: 0 |
AllowQueryFieldValues |
Determines whether the drop-down lists of available values are displayed for fields in the What-If Scenario event definition dialog boxes. Valid Values:
Default: 1 |
DiscardOrphanConditions |
Ignores missing events if it relates to an OR event. Valid Values:
Default: 1 |
DisplayControlMTimeStartDay |
Determines the Control-M/Server start of day time in Control-M Forecast. 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:
Default: ctm_new_day This parameter is set to ctm_new_day, the New Day is set to 07:00, and the current time is 23:00. A job is scheduled to run from 06:00 to 06:30. In Forecast, it shows that it will run today at 06:00 because this is before the New Day. If the system parameter set to midnight then the job runs tomorrow and (+1)06:00 appears, because it is after midnight. |
ExecuteConfirmedJobs |
Enables you to execute jobs that are waiting for confirmation. Valid Values:
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 the Forecast Server can simulate for all Forecast requests. Valid Values: 1 or higher. Default: 200,000 This parameter affects Forecast in Control-M client and requests that are submitted via the Control-M/Forecast utility. |
MaxForecastRunningRequests |
Determines the maximum number of Forecast requests that can simultaneously process. Valid Values: 1 or higher. Default: 5 |
max_futureplan_cb_seq_size |
Determines the minimum chunk size for jobs when the forecast is generated. Valid Values: 1 or higher. Default: 1,000 |
MaxSimulationDays |
Determines the number of days to simulate the service runs to calculate estimated end times. Additional days require more CPU time. Valid Values: 1 or higher. 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 |
Determines the interval (in seconds) that the simulation advances its calculation of the estimated end time. Valid Values:
Default: 10 |
SockRecrMaxAtmp |
Determines the maximum number of times that the Configuration Agent can attempt to create a socket. Default: -1 (no limit) |
SockRecrWtIntr |
Determines the interval (in seconds) between successive attempts to create a socket. Valid Values: Any whole number higher than 0. Default: 10 |
SupportWorkLoadResources |
Determines whether to support the load balancing of Resource Pools. Valid Values: 0: Not supported. 1: Supported. Default: 1 |
UseDoCondition |
Determines whether to add events that are created by On Do Actions. Valid Values:
Default: 1 |
upd_progress_interval_sec |
Determines whether Forecast sends updates when a Forecast simulation loads. Valid Values:
Default: 1 |
UserDailyCmdRegexp |
Defines a regular expression that identifies OS-command-type jobs which run jobs via the ctmudly User Daily utility. If the command defined in the OS job Command field in a job matches this expression, Forecast assumes that the job relies on the ctmudly User Daily utility. Valid Values: <String_Expression> Default: ^.*ctmudly[^ ]* The regular expression ^.*ctmudly[^ ]* identifies jobs that call ctmudly, regardless of the specified pathname or file extension. |
UserDailyFileNameRegexp |
Defines a regular expression that identifies Job-type jobs that use a particular User Daily job (usually thectmudly utility) to order tables. If the name defined in the File Name job attribute matches this expression, Forecast assumes that the job relies on the ctmudly User Daily utility. Valid Values: <String_Expression> Default: ^.*ctmudly[^ ]* If you use this system parameter, you must also use the UserDailyParamNO system parameter to enable Forecast to access the User Daily name. |
UserDailyParamNO |
Defines the numeric suffix of the AutoEdit variable, %%PARAMn, which contains the User Daily name. If UserDailyParamNO is set to 2, Forecast reads the name of the user daily from %%PARAM2. Valid Values: Any whole number greater than or equal to 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 reads 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 |
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 |
Determines how many job and resource details the Gateway should load into memory at a time before saving the entities in the Control-M/EM database when performing a download from Control-M. A larger number causes the download to occur faster and more efficiently, at the expense of virtual memory. Valid Values: Any whole number that is greater than or equal to 10. Default: 100 |
continue_not_responding |
Determines how the new Gateway handles multiple Gateway instances for the same Control-M installation if all attempts to stop and kill the original Gateway are unsuccessful. Valid Values:
Default: N |
dal_rel_cache_size |
Do not change this parameter unless you are instructed to do so by BMC Customer 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 greater than or equal to 10. Defaults:
|
em_connect_method |
Determines how the Gateway opens communication connections. Valid Values:
|
gtw_send_ctl_timeout |
Determines the timeout period, in seconds, for determining if the original Gateway is responsive (up). Valid Values: Any whole number that is greater or equal to 20. Default: 45 |
kill_not_responding |
Determines whether a new Gateway stops or kills existing Gateway instances for the same Control-M installation. Valid Values:
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. Do not change this parameter unless you are instructed to do so by BMC Customer Support. Default: 40. This parameter is relevant only if the useNonBlock parameter is set to Y. |
useNonBlock |
Determines 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:
Default: N |
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
-
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.
-
In the left pane, click Advanced.
-
Click .
The Control-M/EM - New System Parameter window appears.
-
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.
-
-
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
-
Select a Control-M/EM component, and then click System Parameters.
The Control-M/EM System Parameters dialog box appears.
-
In the left pane, click Advanced.
-
In the Name column, type ForceWebServerOLH.
-
Double-click the parameter and in the Value field, type 1.
-
Click Save.
The Control-M Help is now accessed from the Control-M Web Server.