Configuring System Settings

This procedure describes how to configure system settings in Control-M SaaS, including environment display, IdP configuration, annotations, and Site StandardsClosed A set of rules that are relevant to your organization, are applied on the folder level, and determine how users must define folders and jobs..

Alternatively, you can define these settings and many additional parameters using API commands. For more information, see System Settings Configuration in the Control-M Automation API documentation.

Before You Begin

  • You must have Advanced Admin Authorizations to define system settings, as described in Role Authorizations. You must set the Configuration access level to Full (through Configuration > Admin Management > Configuration, on the General tab).

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:

  4. Click Save.

General Settings

The following table describes general settings for Control-M SaaS applications and domains.

Attribute

Description

User Inactivity Timeout

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

Valid Values: 10–720

API Parameter Name: userInactivityTimeoutMinutes

Default Run Method

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

  • None

  • Automatic

  • Specific: You must define a specific user daily.

API Parameter Name: defaultRunMethod

Workflows Retention Period

Determines the number of days to keep Workflows in the History area of the Monitoring domain.

Valid Values: 1-14 days

Privacy Notice URL

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

Send Alerts to External Event Management System

Determines whether to send alerts to external event management tools.

Alert Type

Determines one of the following alert types that an external event management tool sends:

  • Alerts: Alerts related to job processing.

  • System Alerts: System alerts (also known as exception alerts or xAlerts) for system failures in Control-M components and communication network. This option is especially useful if you have self-hosted Control-M/Servers connected to Control-M SaaS.

To stream alerts from Control-M SaaS and listen for alerts on your client, use API commands, as described in Setting Up External Alerts and External Alert Management.

After you enable external alerts, a status message appears with alert streaming status and alert listening status.

For this status message to appear, your role must have the Alerts authorization set to Browse access. For further External Alert Management actions through Automation API, your role must have the Alerts authorization set to Update access. For more information, see Role Authorizations and Control-M Automation API Authorizations.

Audit and Annotation Settings

The following table describes audit and annotation settings for user categories in Helix Control-M.

Attribute

Description

Enable Annotation

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

Audit Information Retention Period

Determines the number of days to retain audit information before automatically deleting it from Helix Control-M.

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

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 Helix Control-M 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.

Site Interface Language

Determines the language that appears on Control-M SaaS.

Valid Values:

  • English

  • German

  • Spanish

  • French

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

Site Standard Settings

The following table describes Control-M SaaS Site Standard system settings.

Attribute

Description

Allow Only Admins to Update the Folder Strictness Level

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

If this setting is toggled on, the toggle is disabled for other users and you must define the New Folder Default Strictness Level attribute as Strict.

API Parameter Name: enforceSiteStandardAdminOnly

New Folder Default Strictness Level

Determines whether to validateClosed The check that Control-M performs when you check-in jobs and SMART folders, which checks for errors in the job definitions. new folders when you check them in, as follows:

  • Strict: Enforces successful new folder validation when you check in a workspace or selection of jobs or folders. If validation fails, an error appears in the Validation pane, you cannot check in until the error is addressed, and the Enforce Site Standards Selection attribute is toggled on.

  • Non-Strict: Does not enforce successful new folder validation when you check in a workspace or selection of jobs or folders. If validation fails, an warning appears in the Validation pane, you can still check in, and the Enforce Site Standards Selection attribute is toggled off.

Enforce Site Standards Selection

Determines whether to enforce the assignment of a Site Standard to a job flow, which prevents users from creating a job flow without a Site Standard assigned.