Configuring System Settings

This procedure describes how to configure system settings in Helix Control-M, 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. In particular, 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 pane appears.

  3. From the General drop-down list, do the following:

    1. In the Viewpoint History area, from the Workflows Retention Period field, select the number of days to keep Viewpoints in the History area of the Monitoring domain.

      You can retain them up to 14 days.

    2. In the Privacy Notice area, from Privacy Notice URL field, define the URL that links to the Privacy Notice from Helix Control-M, which outlines the privacy policy and compliance guidelines.

    3. In the External Alerts area, select Send Alerts to External Event Management System if you want to enable sending alerts to external event management tools, and select one or both of the following alert types:

      • Alerts: Alerts that relate 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 Helix Control-M.

      To stream alerts from Helix Control-M 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.

  4. From the Environment Display drop-down list, do one of the following:

    • Select a Banner Color for your Control-M environment, enter a Title and a Description such as, Dev, Test, or Production. These preferences help you differentiate between environments.

    • From the Site Interface Language drop-down list, select the default display language for new users:

      • English

      • German

      • Spanish

      • French

        • After you change the Site Interface Language, users that are already logged in are not affected.

        • All users can change their personal site interface language. For more information, see Setting User Preferences.

        • The following appears in English only:

          • Login and logout pages

          • Control-M Application Integrator

          • Control-M Reports

          • Job logs

          • All messages sent by the Server

  5. Configure an Identity Provider (IdP), as described in Configuring Authentication with an IdP.

  6. From the Annotation drop-down, in the Activities that require user annotation field, select or search for Control-M activities that you want to require annotation, as described in Annotation User Categories.

  7. From the Site Standard drop-down, select the Site Standard enforcement level, as follows:

  8. Configure LDAP authentication, as described in Authentication.

  9. Select one or more of the following external vault integrations to use in centralized connection profiles:

    • CyberArk Vault

    • CyberArk Vault - Query Based

    By default, all supported vault integrations are available when you want to retrieve secrets for password-type fields in connection profiles. Use this setting to hide any integrations that are not relevant to you from appearing in the user interface. For more information, see CyberArk Vault Integration.

  10. Click Save.

Annotation User Categories

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

Category

Configured Objects

Account Management

User and Role Authorizations

Active Job Information

LogClosed The activity log of a job, which lists every job status change, such as job execution start and completion times, and how the job ended., outputClosed A tab in the job properties pane of the Monitoring domain where the job output appears that indicates whether a job ended OK, and is used, for example, with jobs that check file location., and statistics

Active Job Operations

Job Management

Active Job Prerequisites

EventsClosed An conditional entity that creates a sequential relationship between jobs by enabling the successor job to execute after the predecessor job has executed., Lock ResourcesClosed A type of prerequisite that controls the flow of the workflow, which represents a physical or logical device that folders, sub-folders, or jobs can exclusively access or share., and Resource PoolsClosed A type of quantifiable resource, which represents the total amount of resources from a physical or logical device that a job can access.

Alerts Handling

Alerts

Authentication

Login/logout attempts, password actions

Component Operations

Recycles the AgentClosed A Control-M component installed on a host (computer) that runs and monitors the jobs on the host.

Configuration Management

Configuring System Settings

Scheduling Definitions

Scheduling

Security

Creating a Centralized Connection Profile