Configuring System Settings

This procedure describes how to configure system settings in Control-M, including environment display, LDAP and IdP configuration, and audit and annotations.

Begin

  1. From the icon, select Configuration.

    The Configuration domain opens.

  2. From the drop-down list, select System Settings.

    The System Settings dialog box appears.

  3. In the System Settings dialog box, click one of the following tabs to define the relevant settings:

    • Active Directory (LDAP) : Configure authentication with LDAP for Control-M users stored in Active Directory, as described in Configuring Authentication with LDAP.

    • Audit and Annotation: Configure user categories that are audited in the Control-M/EM database each time an audit action occurs, as described in Audit and Annotation Settings.

    • Control-M Web: Configure Control-M applications and domains with customized settings, such as language interface and the number of jobs in a Viewport, as described in Control-M Web Settings.

    • Environment Display: Configure the display settings, such as banner color and title, as described in Environment Display Settings.

    • External Vault Integration: Configure vault integrations for centralized connection profiles, as described in External Vault Integration Settings.

    • Identity Provider (IdP): Configure authentication with IdP for Control-M/EM users, as described in Configuring Authentication with an IdP.

    • Workload Change Manager: Configure Control-M Workload Change Manager (WCM) system settings to change business workflows and define standards for folders and job definitions, as described in Workload Change Manager Settings.

  4. Click Save.

Audit and Annotation Settings

The following table describes audit and annotation settings for user categories in the Control-M/EM database.

Attribute

Description

Enable Audit

Determines whether to enable auditing for Audit and Annotation User Categories.

Enable Annotation

Determines whether to enable annotation for Control-M for Web categories.

Enable Automatic Cleanup

Determines whether to automatically delete audit information.

Audit Information Retention Period

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

Valid Values: 1-90 days

Audit and Annotation User Categories

The following table describes categories that you can require users to apply annotation.

Category

Configured Objects

Authentication

Login/logout attempts, password actions

Scheduling Definitions

Scheduling

Active Job Operations

Job Management

Active Job Information

Job Details

Active Job Prerequisites

Resource activities (add, delete, or update resources and global prefixes)

Alerts Handling

Alerts

Account Management

User and Role Authorizations

Component Operations

State of components set to Up, Down, Ignore, or Recycle

Configuration Management

Configuring System Settings

Control-M Security

Control-M/Server Security

Database Maintenance

Database Operation and Maintenance

High Availability

High Availability

Control-M Web Settings

The following table describes Control-M Web settings.

Attribute

Description

Site Logo Path

Defines the location of the company logo to display in the Control-M Self Service site.

Rules:

  • The maximum size must be 100w × 20h pixels.

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

D:\images\logos\SLS_Custom_Logo.png

Site Login Logo Path

Defines the path to the site login logo.

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 the login page.

Support/Helpdesk Info

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

End User Site Portal URL

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

Maximum Number of Jobs in Workspace

Determines the maximum number of jobs to load into a Workspace.

If this number is exceeded, the job view automatically changes into list view.

Default Run Method

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

  • Automatic

  • None

  • Specific: You must define a specific user daily.

API Parameter Name: defaultRunMethod

Automatic Save Interval

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

Maximum Number of Viewpoints

Determines the maximum number of Viewpoints a user can define.

Maximum Number of Jobs in Viewpoints

Determines the maximum number of jobs that appear in a Viewpoint.

If there are more jobs in the service than the number defined here, you might experience low performance. When the number of jobs exceeds 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

Web Job Refresh Rate

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

Unused Viewpoint Retention Period

Determines the number of days to keep unused Viewpoints.

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 exceeds its limitation, a warning message appears, and the user is prompted to select List view.

Services Refresh Rate

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

Title Tile

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

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

Maximum Results in Job Search

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

API Parameter Name: maxResultsInJobSearch

Environment Display Settings

The following table describes the display settings.

Attribute

Description

Banner Color

Determines the color of the banner.

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

Description

Describes the environment of the Control-M client applications.

External Vault Integration Settings

The following table describes the external vault integration settings.

Attribute

Description

Vault Integrations

Determines which vault integrations to utilize for centralized connection profiles.

Valid Values:

  • CyberArk Vault

  • CyberArk Vault - Query Based

API Parameter Name: enabledVaultProviders

Workload Change Manager Settings

The following table describes Control-M Workload Change Manager (WCM) system settings.

Attribute Description

E-Mail Sender

Defines the sender email address that sends notifications to WCM end users.

New Folder Default Strictness Level

Determines whether to enforce validation on a new folder.

API Parameter Name: strictnesslevel

Enforce Site Standards Selection

Determines whether a Control-M Administrator can set the Enforce Validations checkbox for a Site Standard in Folders.

If this setting is configured, the checkbox is disabled for other users. You must also set the New Folder Default Strictness Level parameter to Strict.

API Parameter Name: enforceSiteStandardAdminOnly

Enhanced Change Management Integration

Determines whether to enable the integration between WCM and a third-party change management system.

If disabled, it does not affect the other WCM system parameters.

REST Service URL

Defines one of the following:

  • The URL of the change management system if you integrate directly with the change management system.

  • The URL of the dedicated REST server if you integrate with the change management system through a REST server.

For more information, see WCM Integration with a Change Management System.

For secure communication, see Configuring Secure Communication between WCM and a Change Manager System.

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

REST Service Timeout

Determines the number of seconds for the REST Service invocation to be considered not responsive when connecting WCM to the REST service.

Change Management Status 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 the Change Ticket field in WCM and Control-M can be edited.