Calendar Maintenance

Calendars can form the basis for schedules defined for jobs and job networks. An Entire Operations calendar distinguishes between workdays (working days) and holidays (non-working days) as defined by the user (weekends, national holidays, personal vacations).

If a schedule depends on a calendar, calendar-dependent definitions can be made in the schedule. If a schedule is not linked to a calendar, the schedule assumes that all days are workdays.

Calendars are identified by owner, name and year, and can belong to an owner or be used system-wide. You can specify a system calendar or a calendar belonging to your owner for a schedule table, but you can only modify calendars belonging to your owner. System calendars can be modified by authorized users only.

Any number of calendars can be defined to the system.

Calendars can be modified to change, include or delete holidays (system-wide calendars can only be modified by the system administrator). Modifications to calendars can affect the associated job network schedule(s).

This section covers the following topics:


General Rules and Restrictions

This section covers the following topics:

How Calendars Work

Entire Operations calendars include workdays and holidays (non-workdays).

Entire Operations does not activate any networks on a day defined as a holiday.

For example, a job network is scheduled to run on every first day of a month and the schedule is based on a calendar in which Saturdays and Sundays are defined as non-workdays:

If the first day of a month is a Saturday or Sunday, Entire Operations does not start the network on these days, but either delays activation until the next workday following the holidays or brings activation forward to the last workday previous to the holidays, depending on the schedule definition.

Calendar Types

There are two types of calendars in Entire Operations:

  • System-wide calendars
    System calendars can be modified by authorized users only.

  • Owner-specific calendars
    When you define a calendar, it is automatically associated with your owner. You can modify only those calendars that belong to your owner.

You can specify a calendar belonging to your owner for a schedule, but you can also select a system calendar.

Calendar Names

A calendar can be valid for several years, so you are not forced to change the name of the calendar at the end of the year. Just define the calendar for the next year. For this reason, you should use calendar names independent of the year.

You must define a calendar separately for each year you want to use it. Networks cannot be started if a calendar is missing for the year for which it is needed. To be notified about such cases, select the Calendar undefined for year option in Global Messages for Events (see the Administration documentation). In November and December, the Entire Operations Monitor writes warning messages to the log if a calendar currently used is not defined for the next year.

Reserved Calendar Names

Calendar names must not begin with the prefix =EOR=.

This prefix is reserved for special usage in symbol functions (see the section Symbol Table and Symbol Maintenance).

Available Functions: Calendar

Start of instruction setTo list all functions available for a Calendar node

Start of instruction setTo list all available functions for a Calendar instance

Listing Calendars

Start of instruction setTo list calendars

  1. In the object workspace, select the Calendar node of the required owner

  2. From the context menu, choose List, or press F8.

    All calendars defined for the selected owner are listed in the Calendar List window as shown in the following example:

    graphics/calendar_list.png

The list of calendars contains system-wide calendars and calendars belonging to the selected owner (here: SAGTEST).

A calendar is identified uniquely by its owner name and year.

This section covers the following topics:

    Displaying, Modifying or Adding a Calendar Definition

    Start of instruction setTo display, modify or add a calendar definition

    1. From the Calendar node in the object workspace, select the calendar you want to view or modify and choose Display or Open, respectively, from the context menu. Alternatively, you can press CRTL+D or CRTL+O, respectively.

      Or:
      Select a Calendar node and choose New from the context menu, or press CRTL+N.

      Depending on the function performed, a Display Calendar, Maintenance Calendar or Create new Calendar window opens:

      graphics/open_calendar.png

      If the calendar is for the current year, the window displays six month from the current month of the specified calendar year by default.

      For other years, the first six month are displayed initially.

      Click on the right arrow button graphics/right_arrow_button.png to scroll right in the calendar and view the next months, or click on the left arrow button graphics/left_arrow_button.png to scroll left and view the previous months.

      The current date is indicated by a red square, holidays are highlighted in red.

      The fields in the upper section of the window are explained in Fields: Calendar Definition.

    2. If defined for the calendar, you can select another year from the Year drop-down list box.

      When modifying or adding a calendar, you add another year by replacing the current entry in the Year field.

    3. When modifying or adding a calendar, define the required holidays as described in Defining Workdays and Holidays.

    4. Choose OK to save your calendar definition.

      The calendar is saved and you can use it for scheduling network and jobs.

    This section covers the following topics:

    Fields: Calendar Definition

    The fields contained in the upper section of the Display Calendar, Maintenance Calendar and Create new Calendar window are described in the following table:

    Field Description
    Calendar Calendar name.
    Year Calendar year.

    The current year is entered by default.

    Description A short description of the calendar.

    Defining Workdays and Holidays

    Defining a calendar consists of defining workdays and holidays (non-workdays). This is done in two steps:

    1. Define weekly holidays. These are the non-workdays in every week, such as weekends.

    2. Define special holidays or personal vacations.

    Note:
    A network schedule can override workdays marked on a calendar, because a network runs on a day specified in a calendar, only if this day is also specified in the schedule.

    Start of instruction setTo define or remove weekly holidays

    1. In the Set weekly holidays section of the Maintenance Calendar or Create new Calendar window, open the drop-down list box, select the weekday you want to define as a holiday and choose Set Holidays.

      Or:
      In the Set weekly holidays section of the Maintenance Calendar or Create new Calendar window, open the drop-down list window and select the defined holiday you want to change to a weekday and choose Reset Holidays.

      Or:
      Choose Remove All Holidays.

      Caution:
      This function removes both all weekly and all special holidays for the year currently selected and shown in the Maintenance Calendar window.

    2. Choose OK to save your calendar definition.

      Weekdays defined as holidays are now highlighted in red.

    Start of instruction setTo define or remove special holidays

    1. In the Selection section of the Maintenance Calendar or Create new Calendar window, click on single or multiple (SHIFT-click) dates and choose Set Holidays.

      The selected dates are highlighted in red.

      Or:
      In the Selection section of the Maintenance Calendar or Create new Calendar window, click on single or multiple (SHIFT-click) highlighted (defined) dates and choose Reset Holidays.

      Or:
      Choose Remove All Holidays.

      Caution:
      This function removes both all weekly and all special holidays for the year currently selected and shown in the Maintenance Calendar window.

    2. Choose OK to save your calendar definition.

      Weekdays defined as holidays are now highlighted in red.

    Where Used - Listing Schedules Using a Calendar

    Start of instruction set To list schedules using a calendar

    1. In the object workspace, select the required calendar from the Calendar node and choose Where used from the context menu.

      A Where used window similar to the example below opens:

      graphics/calendar_where_used.png

      The window indicates the name of the selected calendar (here: EXAMPLECAL) and its owner (here: EXAMPLE) and lists all schedules (and their owners) associated with the calendar.

    2. You can modify a listed schedule by selecting the required table row and choosing Open from the context menu.

      A Maintenance Schedule window opens where you can change or remove the name of the calendar entered for the schedule.

    Deleting a Calendar Definition

    Start of instruction setTo delete a calendar definition

    1. In the object workspace, select the calendar you want to delete from the Calendar node.

    2. From the context menu, choose Delete.

      Or:
      Press DELETE.

      A dialog opens where you have to confirm the deletion.

    You cannot delete a calendar if it is specified for at least one schedule. If you wish to delete a calendar which is still used by a defined schedule, Entire Operations notifies you with an appropriate message. Use the Where used function to find out which schedule(s) are associated with the calendar (see Where Used - Listing Schedules Using a Calendar). In this case, you cannot delete the calendar until you have done either of the following:

    • Specified another calendar for the relevant network schedule(s).

      Or:

    • Deleted the network for which the calendar is specified.

    You can delete only the calendars you are permitted to delete.