Calendars

Control-M calendars are user-defined timetables, which enable you to apply scheduling limitations to one or more job and SMART folder definitions. This eliminates the need to manually define scheduling definitions for every job and SMART folder in your Workspace.

You can define the following types of calendars:

The following video describes Control-M calendars:

Creating a Regular Calendar

This procedure describes how to create a Regular calendar, which schedules jobs to run on specific month days and weekdays in a selected year.

Begin

  1. From the Tools drop-down list, select Calendars.

    The Calendars page appears.

  2. Click Add Calendar.

    The Add a Regular Calendar pane appears.

  3. From the Calendar Type drop-down list, select Regular.

  4. From the Control-M Server drop-down list, select the Server to sync the calendar, or select All.

    All refers to all Servers. The calendar name must meet the calendar validation criteria.

  5. In the Calendar Name field, type a calendar name.

  6. In the Description field, type a calendar description, and then click Add.

    An empty Regular calendar appears.

  7. From the top-left drop-down list select a year, and then select the required dates.

    The dates that your select appear in the Calendar Summary in the right pane.

  8. If you have dates that occur every month, select the recurring dates across the calendar, as follows:

    1. From the Calendar toolbar, click Recurrence.

    2. From Apply From and To drop-down list, select a month and year time range.

    3. In Apply On, in Month Days select the specific dates of the month, and in Week Days select the specific days of the week.

    4. Click Apply.

      The defined dates appear in the calendar.

  9. From the Calendar toolbar click Save, and then click Publish.

    The calendar appears in the Calendars page with a published status and editing enabled.

Periodic Calender

Periodic calendars schedule jobs to run over periods that can span weeks, months, or years, such as the division of a year into four quarters. You can define nonconsecutive periods of varying lengths of time. However, you cannot define a period that exceeds 255 days.

You can create a period that is more than one year. For example, Period A can include November 2019 through February 2020. Scheduling a job via Periodic calendars, enables you to select the periods that the job runs in, and then add additional scheduling criteria.

Creating a Periodic Calendar

This procedure describes how to create a Periodic calendar that schedules jobs to run according to time periods other than months and days.

Begin

  1. From the Tools drop-down list, select Calendars.

    The Calendars page appears.

  2. From the calendar toolbar, click Add Calendar.

    The Add a Regular Calendar pane appears.

  3. From the Calendar Type drop-down list, select Periodic.

  4. From the Control-M Server drop-down list, select the Server that the calender is synchronized to, or select All.

    All refers to all Servers. The calendar name must meet the calendar validation criteria.

  5. In the Calendar Name field, type a calendar name.

  6. In the Description field, provide a description of the calendar.

  7. Click Add.

    An empty Periodic calendar appears.

  8. Define your periods, as follows:

    1. From the Period drop-down in the left pane, do one of the following:

      • Select a letter or number from 0–9, such as A.

      • For dates that you want to select in all periods, select Period *.

    2. From the year drop-down list, select the year.

    3. Mark the dates of the calendar that you want in this period.

      The dates that your select for the period appear in the Calendar Summary on the right pane.

  9. For dates that occur every month mark the recurring dates across the calendar, as follows:

    1. From the Calendar toolbar, click Recurrence.

    2. From Apply From and To, select a month and year time range.

    3. In Apply On, select the specific dates of the month, and specific days of the week.

    4. Click Apply.

      The dates appear in the calendar.

  10. From the Calendar toolbar click Save, and then click Publish.

    The calendar appears in the Calendars page with a published status and editing enabled.

Rule-Based Calendar

A Rule-Based Calendar (RBC) is a user-defined calendar that enables you to define and apply a schedule of working daysClosed The dates selected in a Regular, Periodic, or Rule-Based calendar. to SMART folders, sub-folders, and jobs. RBCs enable you to define schedules with values that cannot be specified as absolute values, such as specific days or dates, and requires more complex scheduling criteria.

You can define the following types of RBCs:

  • Specific Dates: Defines scheduling criteria based specific dates, independent of a calendar year, for up to 12 months.

  • Week Days: Defines scheduling criteria based on specific weekdays, or on specific weekdays in specific weeks, which can also be based on a calendar.

  • Month Days: Defines scheduling criteria based on specific month days, which can also be based on a calendar.

  • Advanced: Defines scheduling criteria based on a combination of scheduling options that includes months, weekdays, and days of the month.

Creating a Rule-Based Calendar

This procedure describes how to create a Rule-Based calendar (RBC), that schedules jobs to run using specific rules.

Begin

  1. From the Tools drop-down list, select Calendars.

    The Calendars page appears.

  2. Click Add Calendar.

    The Add a Regular calendar pane appears.

  3. From the Calendar Type drop-down, select Rule-Based.

  4. From the Control-M Server drop-down list, select the Control-M/Server to sync the calendar, or select All.

    All refers to all Servers. The calendar name must meet the calendar validation criteria.

  5. In the Calendar Name field, type a calendar name.

  6. Click Add.

    An empty RBC appears.

  7. To define the RBC based on specific dates, independent of a calendar year, for up to 12 months, do the following:

    1. From the top-left drop-down list, select Specific Dates.

      A yearly calendar appears.

    1. Select the dates that you want the job to run on.

  8. To define an RBC based on weekdays, month days, or week or month days, do one of the following:
  9. Define Advanced Options, as described in Rule-Based Calendar Advanced Options Parameters.

  10. From the Calendar toolbar click Save, and then click Publish.

    The calendar appears in the Calendars page with a published status and editing enabled.

Scheduling an RBC on Week Days

This procedure describes how schedule an RBC based on specific weekdays, or on specific weekdays in specific weeks of the month.

Begin

  1. From the top-left drop-down list, select Week Days.

    The Run on Week Days and Run on Months areas appear.

  2. In the Run on Week Days area, do one of the following:

    • To run the job on a specific weekday, in the Run tab, select the weekday.

    • To run the job on a specific day in a specific week of the month, in the Start of week tab, select the weekdays.

      You can select to schedule jobs in more than one week, for example in W1 Monday and Tuesday, and W2 Monday and Thursday.

  3. In the Run on months area, select the months when you want the job to run.

Scheduling an RBC on Month Days

This procedure describes how to schedule an RBC based on month days.

Begin

  1. From the top-left drop-down list, select Month Days.

    The Run on Month Days and Run on Months areas appear.

  2. In the Run on Month Days area, do one of the following:

    • From the Run tab, select the day of the month when you want the job to run.

    • From the End of month tab, do one of the following:

      • To run the job on the same number of working day or days before the end of the month, select the number of days, and then select the On day from end of month option.

        If you select L1, the job runs one day before the end of the month. If the month is 30 days, the job runs on the 29th.

      • To run the job on all days in the month except the same number of working day or days before the end of the month, select the number of days, and then select the On all days except on selected day from end of month option.

        If you select -L1, the job does not run one day before the end of the month. If the month is 30 days, the job runs on all days of the month except the 29th.

  3. In the Run on Months area, select the months when you want the job to run.

Scheduling an RBC on Week or Month Days Based on a Calendar

This procedure describes how to schedule an RBC based on week or month days.

Begin

  1. From the top-left drop-down list, select Week Days or Month Days.

    The Run on Week Days or Run on Months area appear.

  2. In the Run on Week Days or Run on Months area, from the Based on calendar drop-down list, select a calendar.

  3. Do one or more of the following, based on your scheduling requirements:

    From the Run tab, select the day of the week or month.

    If you select a Periodic Calender then select the days where the job should not run. If you select Regular Calendars, then from the Run Job dialog box, select one of the following:

    • Run Also on Non-working Days: Runs the jobs on the selected day, even if the job is not a working day in the base calendar.

    • Select Working Day: Runs the jobs on the selected day, only if the day is a working day in the base calendar.

    • All Working Days Except Selected Day: Runs the jobs on all other working days except the selected day, even if the day is a working day in the base calendar.

    Select one of the following:

    • Day or On Next Working Day (>): Runs the jobs on the selected day. If that day is not a working day in the base calender, the job is run on the next working day.

    • Day or On Previous Working Day (<): Runs the jobs on the selected day. If that day is not a working day in the base calendar, the job is run on the previous working day.

    From the Start of Week tab, select the week of the month and the week day, or on Start of Month select the month. From the Run Job dialog box, select one of the following:

    • On Day if Working Day (D): Runs the jobs on the selected day, if the day is a working day in the base calendar.

      If you select D1, the job runs on day 1 of every working week or month.

    • All Working Days Except Selected Day (-D): Runs the jobs on all other working days except the selected day, even if the day is a working day in the base calendar.

      If you select -D1, the job runs on all working days in calendar, except day 1 of every working week or month.

    Week Days:

    • If you select a Regular calendar, you can select days from the start of the week for each week in the month. For example, D3W2 schedules the job in the second week of the month, on the 3rd day of that week.

    • If you select a Periodic calendar, you can select days from the start of the week for each week in the period. For example, D3PA schedules the job on the third day of the week throughout Period A.

    Month Days: You cannot select the week in the month or the period.

    From the End of Week or End of Month tab, select the day of the week or month. From the Run Job dialog box, select as follows:

    • On Day from End of Week (L): Runs the job on the selected day from the end of the week.

      If you select L1, the job runs one day from the end of the week or month.

    • On All Days Except on Selected Day from End of Week (-L): Runs the jobs on all other working days except the selected day from the end of the week.

      If you select -L1, the job does not run one day from the end of the week or month.

    Week Days: If you select a Periodic calendar, you can select the days from the end of the week for each week in the period. For example, L3PA schedules the job on the third day of the week throughout the A period.

    Month Days: You cannot select the period.

Rule-Based Calendar Advanced Options Parameters

The following table describes the RBC Advanced Options parameters:

Parameter

Description

Confirmation Calendar

Defines the confirmation calendarClosed A calendar that enables you to validate the days when jobs run, and that has a policy for non-working days. that is used to confirm the scheduling dates of the calendar. Jobs that are scheduled on a specific day are checked against the confirmation calendar.

Calendar

Defines the confirmation calendar, that can be a Regular or Periodic calendar that has already been published.

Exception Policy

Determines one of following scheduling changes to apply when a job is scheduled to run on a non-working day in the confirmation calendar.

  • Disable Run: Prevents the job from running.

  • Run on Next Confirmed Day: Runs the job on the next working day in the confirmation calendar.

  • Run on Previous Confirmed Day: Runs the job on the previous working day in the confirmation calendar.

  • Run (Ignore Confirmation Calendar): Runs the job on the currently scheduled working day.

Shift by

Determines the number of working days to shift all scheduled job runs.

Valid Values:

  • 0: Does not shift the scheduled job runs by any number of days.

  • 1 to 62: Shifts all scheduled job runs forward by 1–62 working days.

  • -1 to -62: Shifts all scheduled job runs backward by 1–62 working days.

Activity Period

Pauses the job from running for a period of time without the need to change its job definitionClosed The set of parameters that defines what the job does, when it runs, its prerequisites, and the post-processing actions that Control-M performs after the job completes execution. or calendar, as follows:

  • Always: Job is not restricted by an Activity period.

  • Active: Activates the job between the From and To dates that you define.

  • Not Active: Deactivates the job between the From and To dates that you define.

Active Environment Retention

Defines the Keep Active policy.

Keep Active

Determines the number of additional days after the defined run date that the SMART folder remains active and awaits execution, if it fails to execute at the originally defined time. Sub-folders and jobs in a SMART folder remain active according to the Keep Active value defined in the SMART folder.

  • The job status for waiting jobs changes to Ended OK on the following day.

  • All jobs are kept in the SMART folder until it is removed.

Valid Values:

  • For: Keeps the SMART folder active, where it awaits execution for the number of extra days that you define, as follows:

    • 0: SMART folder executes only on the run date.

    • 1–98: SMART folder awaits execution for the number of extra days that you define.

  • Forever: Keeps the SMART folder active, where it awaits execution indefinitely.

Copying a Calendar Year

This procedure describes how to copy selected dates from one year to another year in your schedule.

Begin

  1. From icon on the calendar ribbon, select Copy Year.

  2. From the Copy From drop-down list, select the year with the dates you want to copy.

  3. From the Copy To drop-down list, select the years where you want to copy the dates.

    If you want to clear the dates from a year, select the icon on the calendar ribbon, and select Clear Year.