Calendars (Magic xpi 4.13)

« Go Back


Created BySalesforce Service User
Approval Process StatusPublished

Calendars (Magic xpi 4.13)

The Scheduler service can be configured to run the scheduler at a defined periodic interval. The interval can be Daily, Weekly, Monthly which can be defined on the Scheduler service configuration.

In addition to that, there is a provision to stop the scheduler from running for given date(s) of the year. For example, you may choose national holiday(s) or any other day(s) on which the scheduler need not run. To define these dates for which the Scheduler service should not run, the exclusion calendar can be used.

The Calendars section in the Settings dialog box provides you with a central location to define this exclusion/Holiday calendar. These calendars definitions are saved in an XML file (Calendars.xml) in your <project name> folder. Any changes done to the Calendars are effective immediate, for all running projects. For example, the user can use the Studio or the External Environment Settings to update the Calendars while the project is still running and the next scheduled event within the project will be evaluated based on the changes to the Holiday calendar.

The calendar dates will always be stored in YYYY-MM-DD format in the Calendars.xml file.

To define the calendar:

  1. From the Project menu, select Settings to open the Settings dialog box.

  2. In the left-hand pane of the Settings dialog box, park on Calendars.

  3. Click Add. Your new calendar now appears in the Settings dialog box's Calendars section.

  4. Next, enter the calendar’s parameters.

  5. To add more entries to a calendar, park on the name of the calendar and click Add.

If you right-click a calendar, the context menu opens. Here you can choose to Rename or Delete the calendar entry.

Calendars Type contain the following parameters:




The name field can be used to give a name to the Date. The name can be national holiday or scheduled shutdown on which the scheduler should not run.


Select the exclusion date using the Date picker. The value is defined in the mm/dd/yyyy format.

(Since version: 4.13)

Related Topics