Difference between revisions of "4 4 3 Beefalo:Creating a Custom Calendar"

From SEPsesam
Jump to: navigation, search
(Updated as proposed by KAD.)
m
Line 64: Line 64:
 
<br clear=all>
 
<br clear=all>
 
<li>{{anchor|setting_calendar}}<translate><!--T:24--> In the ''Name'' field, enter the name for your custom calendar. You can either add calendar events by '''single-clicking''' on the days you want to include in your calendar or by '''double-clicking''' the desired date to open the ''Calendar event'' dialog. In the ''Calendar event'' dialog you can expand the date range to several days and choose the start and end time of the event. Optionally, you can write a date description in the ''Event'' field. Click '''OK''' to add the calendar event to the calendar.</translate></li>
 
<li>{{anchor|setting_calendar}}<translate><!--T:24--> In the ''Name'' field, enter the name for your custom calendar. You can either add calendar events by '''single-clicking''' on the days you want to include in your calendar or by '''double-clicking''' the desired date to open the ''Calendar event'' dialog. In the ''Calendar event'' dialog you can expand the date range to several days and choose the start and end time of the event. Optionally, you can write a date description in the ''Event'' field. Click '''OK''' to add the calendar event to the calendar.</translate></li>
<translate><!--T:25--> [[image:Custom_calendar_events_Beefalo_V2|500px|link=]]</translate>
+
<translate><!--T:25--> [[image:Calendar_event_Beefalo_V2.jpg|400px|link=]]</translate>
 
<br clear=all>
 
<br clear=all>
 
<li><translate><!--T:26--> After adding all calendar events needed for the calendar, save your custom calendar by clicking the '''Create Calendar''' button.</translate></li>
 
<li><translate><!--T:26--> After adding all calendar events needed for the calendar, save your custom calendar by clicking the '''Create Calendar''' button.</translate></li>

Revision as of 14:25, 16 January 2020

Draft.png WORK IN PROGRESS
This is a draft document for the SEP sesam upcoming 4.4.3 Beefalo V2 release. Note that the article is in the initial stage and may be updated, replaced or deleted at any time. It is inappropriate to use this document as reference material as it is a work in progress and should be treated as such.
Other languages:
Deutsch • ‎English

Copyright © SEP AG 1999-2020. All rights reserved.

Any form of reproduction of the contents or parts of this manual is allowed only with the express written permission from SEP AG. When compiling and designing user documentation SEP AG uses great diligence and attempts to deliver accurate and correct information. However, SEP AG cannot issue a guarantee for the contents of this manual.

Docs latest icon.png Welcome to the latest SEP sesam documentation version 4.4.3 Beefalo V2. For previous documentation version(s), check Creating Custom Calendar in previous versions.


Overview

SEP sesam provides flexible scheduling features to customize how and when your events are processed and how your calendar is set up. By using the User defined option, you can create a calendar that is customized according to your country- or company-specific requirements.

For example, you can define a calendar with specific days on which you want to perform special job executions, such as backup and migration. It also provides the ability to define specific dates on which the scheduled jobs are prevented from running, allowing you to set up a custom calendar of public holiday dates for each year and linking events with blocking date to it to stop scheduled jobs from running during holidays.

Schedule-user defined Beefalo V2.jpg

You can create as many custom calendars as you need. A custom calendar can be defined for a limited period of time, e.g., for one year if the holidays and other specific dates are entered only for the next year, for several years, or for an unlimited time.

When creating a calendar, you can change the month or year in a calendar by clicking the single arrow (at the top/right corner of the calendar) for selecting a month or the double arrow for selecting a year.

After entering a calendar name and saving a calendar, you can switch to a calendar table view by selecting the Table View option. This view provides an overview of all your events, i.e., event start/end date and whether the event is active or not. You can add a new event by clicking the Add Event button (below the Events table). You can also modify and delete an existing event by double-clicking it (or selecting it and clicking Change Event/Delete Event button).

Note that you can simply modify, import, export, and delete your custom calendar, as described in the section Managing custom calendars.

Setting up a custom calendar

To create a custom calendar with dates on which you want to run additional jobs or prevent scheduled jobs from running, proceed as follows:

  1. From Main Selection -> Scheduling -> Schedules, click New schedule. The New Schedule window appears.
  2. The Execution is enabled by default. If you select the Execution off option, all events that are linked to this schedule will be deactivated.
  3. Specify the start time for the schedule in the Start field. By default, the current date is already entered. In the next field, specify the start time, e.g., 18.30. The schedule will be activated after the specified date and time. If you want your schedule to be valid only for a limited period of time, use the Expiration date option.
  4. Custom calendar dialog 01 Beefalo V2.jpg

  5. In the table providing selection of different time parameters tabs (Once, Daily, Weekly, Monthly, Yearly, User Defined), click the User Defined tab and then click the New button below the Calendar name field. The New Calendar dialog is displayed.
  6. Custom calendar dialog 02 Beefalo V2.jpg

  7. In the Name field, enter the name for your custom calendar. You can either add calendar events by single-clicking on the days you want to include in your calendar or by double-clicking the desired date to open the Calendar event dialog. In the Calendar event dialog you can expand the date range to several days and choose the start and end time of the event. Optionally, you can write a date description in the Event field. Click OK to add the calendar event to the calendar.
  8. Calendar event Beefalo V2.jpg

  9. After adding all calendar events needed for the calendar, save your custom calendar by clicking the Create Calendar button.
  10. Under Advanced settings you can further refine your schedule.
    • To define the maximum allowed startup time (the amount of time an event can be in the queue), specify the startup time in days and/or hours in the Start time frame field. The actual event startup depends on the processor load of the system. At the starting time of the event, every event is forwarded into the queue, where it might wait until jobs with a higher priority are finished. For jobs with the same priority, the FIFO rule (first in, first out) applies. If the event cannot be executed within this specified time frame, it will not be executed at all.
    • You can also specify the time frame for the event to be repeated. Select the Repeat task check box and then specify the repetition cycle to repeat the event every n hours or minutes. Use the For a duration of field to specify the duration of the repeated event in days and/or hours.
    • To specify the time frame after which the scheduled event will be cancelled, select the check box in front of the option Stop task if runs longer than and set the amount of time (days and/or hours) after the event's scheduled start time at which the event will be cancelled.
    • Select the Expiration date check box if you want your schedule to be valid only for a limited period of time, e.g., until the end of the year. Then specify the date of schedule suspension. The schedule will be deleted after the Expiration date criterion is met. By default, this option is disabled and the schedule will be repeated in perpetuity.
  11. Click OK to save the schedule.

You can access all your configured schedules and events under Scheduling in the Main selection pane. Depending on the purpose of creating an event for a custom calendar, select one of the following procedures:

> Create an event for running additional jobs on specified dates

> Create an event to prevent scheduled jobs from running on specified dates

For general details on how to create the SEP sesam events, see Schedules Overview.

Create an event for running additional jobs on specified dates

You have to create the event(s) you want to run on the dates set by your newly created schedule:

  1. Select the schedule and right-click it. Then select the event type you want to add, for example backup, and click New Backup Event.
  2. Under Sequence control, set up the Priority of your event. SEPuler always executes the schedules with the highest priority first. The default priority level is 1, which is the lowest priority (the highest priority is 99). The only exception are schedules with priority 0, which override all other priorities and are always executed. For details, see event priorities.
  3. Under Object, select the task or task group to which you want to link this event. Then click OK to save the event.
  4. Add event to schedule 01.jpg

Create an event to prevent scheduled jobs from running on specified dates

You have to create the event(s) you want to prevent from running on the dates set by your newly created schedule:

  1. Select the schedule and right-click it. Then select the event type you want to add, for example backup, and click New Backup Event.
  2. Under Sequence control, set up the Priority of your exclude event. SEPuler always executes the schedules with the highest priority first. The default priority level is 1, which is the lowest priority (the highest priority is 99). The only exception are schedules with priority 0, which override all other priorities and are always executed. For details, see event priorities. Then select the Blocking date check box. Make sure that this option is used together with a high priority that prevails over priority of the event you want to block.
    Information sign.png Note
    A Blocking date option is used to prevent the activation of certain events on specific days (e.g., end of year, holidays) or to prevent the execution of other jobs related to the same object only within the specified hours. For details on the latter, see Special Schedules.
  3. Under Object, select the task or task group to which you want to link this event. Then click OK to save the event.
  4. Add event to schedule 02 Beefalo V2.jpg

Managing custom calendars

You can modify, import, export, and delete your SEP sesam calendar(s). You can only manage one calendar at the time.

  1. From Main Selection -> Scheduling -> Schedules, double-click the calendar-related schedule, e.g., bank_holidays.
  2. In the table providing selection of different time parameters tabs (Once, Daily, etc.), click the User Defined tab.
  3. From the Calendar Name drop-down list, select the target calendar. Depending on what you want to do with it, select one of the following options:
    • Change: Enables you to modify an existing calendar or change its specific events. The procedure is the same as when you create a new calendar, see above section Setting up a custom calendar.
    • Delete: Delete the calendar from the schedule.
    • Import: Enables you to add an existing online calendar (iCalendar) to your SEP sesam custom calendars by importing it. This way you can easily add country's or region's holidays (that are already defined in some other online calendar) to your list of calendars without having to manually create each holiday/event. To import the calendar, in the file browser select the .ics calendar file that contains the events you want to import and click Open. Note that it may take some time to load the imported calendar.
    • Export: Enables you to use the SEP sesam calendar by other applications, such as Google and Apple Calendar. To export the calendar, in the file browser select the directory where you want to save your exported calendar. Optionally, change the name of your exported file. By default, a calendar is exported as an .ics file. You can also copy all events from one SEP sesam calendar to another by exporting and then importing a calendar.
    • Custom calendar options.jpg