Calendar Events

Calendar Events are sets of rules that result in selecting certain days in the Calendars to which they are assigned. You create a Calendar Event from within a Calendar object. This Calendar Event is then available for reuse when you create more Calendars. The following types of Calendar Events are available: Non-Recurring, Weekly, Monthly, Yearly, Group, and Offset. A Calendar Event can be assigned to as many Calendars as you need. There is also no restriction as to how many Calendar Events can be assigned to a Calendar.

As an administrator user, you define and maintain company-wide Calendar Events.  As a developer and object designer, you assign Calendar Events to executable objects and tasks to apply Calendar conditions to their executions.

Tip: The combo boxes for selecting Calendar Events can contain many entries. Hover your mouse over an entry to display a tooltip with information that helps you identify the Calendar Event. The tooltip shows the name and the title of the Calendar in which it is included. For information about the functions that are available for Calendar Events listed in combo boxes, see Combo Boxes.

This page includes the following:

Best Practices

Easier Maintenance of Calendar Events

Reduce maintenance efforts by creating dynamic Calendar Events rather than Non-Recurring ones. Non-Recurring Calendar Events are easy to create but must be maintained manually. Calendar Events that are based on calculation logic or algorithms need no further maintenance.

Flexible Search for Calendar Events

Large installations probably need multiple Calendars and Calendar Events to manage start dates across regions and time zones. Flexible search capabilities help you find dates or tasks that are affected by Calendar Events. For more information, see Searching for Calendar Events.

Defining Calendar Events

You define Calendar Events from within Calendars.

  1. In the Process Assembly perspective, click Add Object and select Calendar.

    Define the general settings as described in Adding Objects.

  2. On the Calendar page, the days of the year that lie in the past are dimmed. The difference in color is a mere visual help. Any Calendar Event that you define here also affects past dates.
  3. Select the Add Event button.

  4. From the drop-down list, select the type of Calendar Event that you want to define. For more information about how to set up each type see:

  5. Select Apply & Close to add the event to the Calendar.

    A button with the name of the Calendar Event is now displayed in the Calendar Events pane.

  6. Select Save.

Searching for Calendar Events

You search for Calendar Events using the Advanced Search.

The advanced search returns the Calendars that contain Calendar Events that match the search criteria you entered.

  1. Put your cursor in the Global Search box without entering anything.
  2. Select Advanced Search on the pop-up that is displayed. The search list with the Filter pane is displayed.

  3. Select Add Filter Criteria > Calendar Events.

    The following filter criteria are available:

    • Calendar Events

      Enter the name or part of the name of the Calendar Event. If you enter *, the list displays all Calendars available in this Client.

    • Calendar Event Type

    • Maintained

      Relevant for Non-Recurring Calendar Events only because they have a maintenance period.

      Use these options to search for Calendars containing Calendar Events that have already expired or that will expire soon. You can also restrict the list to Calendar Events that expire within the time frame that you define here.

    • Include Calendar Events occurring

      Restricts the results to Calendar Events that select dates within the time frame that you enter here. You have the following options:

      • Enter dates in both From and To to specify a period.
      • Enter the same date in both fields to filter Calendar Events that contain a specific day.
      • Enter a date in either field to filter Calendar Events with dates from or until a specific date.

  4. Click Filter at the bottom of the pane.

Note: You must populate at least one of the fields, otherwise the search yields no results.

From the resulting list of Calendar objects you can do the following:

For more information, see Searching for Calendar Events.

Searching for Objects that are Affected by a Calendar Event

This search provides a list of all the Calendars and objects in which a Calendar Event is used.

  1. Search for the Calendar Event as previously described.
  2. In the list of results open one of the Calendars in which it is being used.
  3. On the Calendar Events pane, right-click the event and select Search for Use.

The list of results provides basic information about the objects in which the Calendar Event is used. For example, name, title, type of object, and so on. In Workflows and Schedules, the Used in column provides important information. For example:

Task(3)/Properties/Calendar

Note: The search for use function for Calendar Events is also available from the Calendar Events pane on the Calendar page

Maintaining Calendar Events

You maintain Calendar Events from within the Calendars in which they are defined. 

  1. Open the Calendar.

    Note: You can open Calendars from within the list displayed by Combo Boxes that serve to select objects. Many important Calendars are probably stored in Client 0 because they apply system-wide. You can also open those Calendars. They are in read-only mode.

  2. The events that are contained in this Calendar are visible on the Calendar Events pane in the form of buttons. Right-click a Calendar Event to display the functions that are available to it.

Important!

See also: