Getting Started
This procedure describes how to set up your Control-M environment and start planning your workflows.
To convert existing workflows from your current scheduling tool to Control-M, see Conversion.
Begin
-
Log in to Control-M, as described in Logging in to Control-M.
-
Install the required Agents
, as described in Agent Installation.
Agents are Control-M components that are installed on the hosts where your jobs
run. Agents submit jobs for execution by the hosts, monitor jobs, perform post-processing analysis of completed jobs, and send the completion status and analysis results back to the server. For more information, see Agent Management.
-
Install the required plug-ins, as described in Plug-ins.
Plug-ins extend Control-M functionality to third-party applications like Hadoop or SAP, or add functionality like Control-M Managed File Transfer. For more information, see Plug-ins.
-
Define connection profiles, as described in Creating a Centralized Connection Profile.
For your installed plug-ins to work, you must define connection profiles that enable Control-M to connect to the required third-party application.
-
Define users and roles, as described in User and Role Authorizations.
Users are granted permissions based on their assigned role. Role definitions enable you to limit the Control-M features that a user is authorized to view or manage.
-
Create and run your first workflow, as described in Creating and Running Your First Workflow.
-
Analyze and troubleshoot the workflow, as described in Analyzing and Troubleshooting a Workflow.
-
Generate and view reports, as described in Reports.
The Reports feature enables you to create and generate ad hoc reports that provide information about definitions and operational issues in your Control-M environment.
Logging in to Control-MLink copied to clipboard
This procedure describes how to log in to Control-M.
Begin
-
From a web browser, type the URL provided to you.
-
If a warning message appears that states that this URL is not secure, verify that the server is trusted and proceed to the URL.
-
Do the following:
-
In the User field, type your username.
-
In the Password field, type your password.
-
-
Click Sign In.
-
Click Restore to restore any open tabs from your last session.
Creating and Running Your First WorkflowLink copied to clipboard
This procedure describes how to create and run your first workflow. In this procedure you create two jobs and combine them into a workflow.
Begin
-
Click Planning to verify that you are in the Planning domain.
-
Add another OS job to the SMART folder and define this job as you did the previous one, but instead of the command echo hello type echo bye.
-
Run the SMART folder, as described in Running a Workspace, Folders, or Jobs.
-
Do the following to view the workflow in the Monitoring domain:
-
Click Monitoring.
The Viewpoints pane appears in the Monitoring domain, as described in Viewpoints.
-
Click Add Viewpoint.
The Add Viewpoint dialog box appears.
-
In the Folder Name field, type the folder name that you defined.
-
Click Add Attribute and in the search field type Run Date, click Run Date, and then in the From field type the current date, and then click Open.
-
Analyzing and Troubleshooting a WorkflowLink copied to clipboard
This procedure describes how to analyze and troubleshoot a workflow. In this procedure, you create a workflow that fails, analyze why it fails, and then you fix it.
Begin
-
From the Planning domain, define the following two jobs, as described in Creating and Running Your First Workflow.
- Job 1, Command Eco: Define this job with the command eco hello—because eco is incorrect syntax, the job fails.
- Job 2, Command Echo: Define this job with the command echo bye.
-
Do the following to see a more detailed description of the job statuses:
-
Select the first job.
Status
Ended Not OK appears in the Run Information section, in the Summary tab of the job definitions pane.
-
Select the second job.
Status
Wait for Event appears in the Run Information section.
-
-
Select the first job and click the Log
tab in the job definitions pane.
Resetting Your PasswordLink copied to clipboard
This procedure describes how to reset your password if you want to change it or your password expired. If the password expires, you must delete the existing user and recreate the user.
If you log in to Control-M with an Identity Provider, contact your System Administrator to reset your password.
Begin
-
Navigate to the login page, as described in Logging in to Control-M.
-
Click Forgot Your Password? and follow the instructions until you have a new password.
Setting User PreferencesLink copied to clipboard
This procedure describes how to set user preferences, which enable you to customize items such as your preferred views.
Begin
-
Click the top right username icon, and from the drop-down list click Preferences.
The Preferences window appears.
-
Set your preferences, as described in User Preferences.
-
Click Save.
Your user preferences are saved.
User PreferencesLink copied to clipboard
The following tables describe the user preferences that you can define:
General PreferencesLink copied to clipboard
The following table lists the general user preferences.
Preference |
Description |
---|---|
Language |
Determines one of the following user interface languages:
|
User Views |
Determines which user view to apply, as described in User Views. |
Confirmation Messages |
Determines whether all confirmation messages reappear if you have previously selected the Don't show this message again. checkbox. |
Tab Ellipsis Position |
Determines where to place the ellipsis to truncate the name of a workspace that appears on a tab. Valid Values:
Default:end |
Automatically Reconnect to Server |
Automatically reconnects to Control-M/Server. |
Max Connection Retries |
Determines the number of times to attempt to automatically reconnect to before you are logged out. Valid Values: 1–20 Default: 20 |
Time Between Retries |
Determines how many seconds to wait between each reconnection attempt. Valid Values: 1–20 Default: 20 |
Planning PreferencesLink copied to clipboard
The following table lists the user preferences for the Planning domain.
Preference |
Description |
---|---|
Auto Save |
Determines whether to automatically save workspaces. |
Default View |
Determines whether workspaces appear in Tile or List view by default. |
E-mail Notification Address |
Defines the email address where notifications are sent. You can define more than one email address with , (comma) separators. abc@company1.com,cde@company2.com |
Event Format |
Defines the default event format that creates job dependencies.
To customize and save additional event formats, replace the attributes in the { } (curly brackets) with other folder, job, or calendar attributes. |
Automatically Delete Event |
Determines whether to automatically delete an event after the successor job completes its execution. |
Make Event Name Unique |
Determines whether each event name is unique. If you select this checkbox, an extension is added to all existing event names. |
Fix Event Name on Value Changes |
Determines whether to automatically update the event name when the source or target property changes. This only works for new events. |
Inherit Wait for Events |
Determines whether successor jobs inherit wait for events from their deleted predecessor job, as described in Wait-for-Event Inheritance. |
Security |
Determines whether to require user confirmation to overwrite the Created By job attribute with the current username if this username is not the original job creator and the AuthorSecurity Control-M/EM system parameter is set to 2 or 3. Valid Values:
Default: Ask for user confirmation |
Monitoring PreferencesLink copied to clipboard
The following table lists the user preferences for the Monitoring domain.
Preference |
Description |
---|---|
Viewpoints Default View |
Determines whether the Viewpoints tab appears in Tile or List view by default. |
Services Default View |
Determines whether the Services tab appears in Tile or List view by default. |
Archive Search Maximum Results |
Determines the maximum number of search results. |
Default Direction |
Determines the default relationship of neighboring jobs to selected jobs.
|
Default Radius |
Determines the maximum number of jobs that branch out from the selected job, based on the Default Direction preference, above. |
Forecast PreferencesLink copied to clipboard
The following table lists the user preferences for the Forecast domain.
Preference |
Description |
---|---|
Start Day of Week | Determines the first day of the work week. |
Business Service Critical Path |
Valid Values:
|
Tile View PreferencesLink copied to clipboard
The following table lists the user preferences for Tile View.
Preference |
Description |
---|---|
Display jobs with no links in columns of |
Determines the number of jobs to show per column in a folder. If the number of jobs that appear exceed this amount, the rest of the jobs appear in an additional column in that folder. |
Width |
Determines the width of the job tiles in each domain. |
Default state |
Determines whether to expand or collapse the parent groups. |
Title |
Determines which of the following job attributes appears in the job title in Map view and in the Navigation pane:
Default: Job/Member name |
First Attribute |
Determines the property to display below the title. The attribute is displayed when the tile zoom scaling is set above 45%. |
Second Attribute |
Determines the property to display below the first attribute. The attribute is displayed when the tile zoom scaling is set above 100%. |
Time |
Determines whether to show or hide the estimated run time of the job. This option is available for viewpoint only. |
Ellipsis Position |
Determines where place the ellipsis to truncate the title. |
Tile Alignment |
Determines the alignment of the tiles. |
Show events |
Determines whether to show all events. |
Show events to delete |
Determines whether to show the job delete events. |
Show events created by If-Actions |
Determines whether to show events that are created by If-Actions. |
Event order |
Determines where to place the lines that connect between the jobs in an event. |
Optional events |
Determines how to show the connectors between jobs in an event. If you have two or more events configured in Wait for Events and at least one OR condition between them, you can configure either a solid or dotted line to represent the connection. |
Logging Out of Control-MLink copied to clipboard
This procedure describes how to log out of Control-M.
Begin
-
From the Home page in the upper right corner, from the username drop-down list, select Log Out.
You are now logged out of Control-M. To log in, see Logging in to Control-M.