About the Calendar app

The Calendar app provides a centralized administration UI for defining reusable calendar schedules that other ITRS Analytics applications can bind to. A calendar schedule is a named configuration consisting of one or more time periods evaluated in a chosen timezone. Calendars can also link to other saved calendars to compose more complex schedules.

When you save a calendar, the app synchronizes it to the platform configuration service. This makes it available for consuming ITRS Analytics applications that support calendar binding, such as the Capacity app.

Tip

Watch this product demo tour in full screen to explore the main UI elements and learn what actions you can take within the app. This guided overview allows you to explore the app’s capabilities and understand its features.

Use cases Copied

The Calendar app is primarily for administrators and operators who need shared, timezone-aware schedules that multiple ITRS Analytics applications can reference.

Create a reusable business hours calendar Copied

Use this workflow to centralize a weekly schedule that other applications can bind to.

Sample business hours calendar

  1. Click the New calendar button.
  2. Enter a name such as Business Hours. Select a Timezone and optionally add a Description.
  3. Add an active time period. Set a Start time and End time (for example, 08:00 and 17:00), and set a Start date.
  4. Set recurrence to Weekly and select Monday through Friday.
  5. Select Create calendar.

The new calendar is Enabled by default and appears on the schedule list. Expand the card to review time periods under Active Periods.

Build a composite schedule with linked calendars Copied

Use this workflow when one calendar should layer its own time periods on top of reusable base calendars. Every calendar must include at least one time period before you can save it. A composed calendar is active only when its own time periods and every linked calendar are active.

Sample holidays calendar

  1. Create a weekly active period calendar (Monday through Friday, for example 08:00 to 17:00).
  2. Create a calendar with inactive period time periods for dates or yearly recurrences that should suppress the composed schedule.
  3. Click New calendar, name it Production Operations, and select a Timezone.
  4. Add time periods that apply only to this composed calendar. For example, add an Inactive period time periods for production-specific maintenance windows (for example, the first Sunday of each month from 14:00 to 16:00).
  5. Use Link to calendar to add related calendars.
  6. Click Create calendar.

Expand the card to review the parent time periods together with each linked calendar and its Enabled or Disabled status.

Prerequisites Copied

Access to the Calendar app is controlled by your organization’s IAM configuration. To use the app, you must have an ITRS Analytics user account with an admin role. For information about configuring access, see IAM configuration.

Calendar app interface Copied

To access the Calendar app:

  1. Log in to the Web Console.
  2. From the side panel, click Admin.
  3. Click the Calendar tab.

Calendar interface

The Calendar app has a single screen that displays all available calendar schedules. When there are no calendars, the page shows No calendars available with an option to create a new calendar.

View calendar schedules Copied

Each schedule card summarizes the calendar name, timezone, time period count, linked calendars, linked applications, and enabled state. Use the schedule list to:

Filter and sort calendar schedules Copied

Filters and sort options are available for you to find calendars quickly.

Configuration and setup Copied

Create a calendar Copied

  1. Click New calendar.
  2. Enter a unique Name. A maximum of 100 characters is allowed.
  3. By default, the timezone is set to the configured platform timezone. You can modify this by selecting a different option from the Timezone dropdown menu.
  4. Optionally add a description to provide more context about the calendar.
  5. Add at least one time period. Time periods define the time windows inside a calendar.

    Important

    A calendar configuration cannot be created without a time period. If no time periods exist in a calendar, the app shows No time periods added yet and prompts you to add one.
    • Use the Active period/Inactive period switch to set the period type. New periods are set to active by default.
      • Active period — the time window is treated as active when the calendar is evaluated.
      • Inactive period — the time window is treated as inactive when the calendar is evaluated.
    • Set the Start time and End time.
    • Set the Start date.
    • Select a recurrence:
      • Does not repeat
      • Daily
      • Weekly — select one or more days of the week.
      • Monthly — select a day of the month (for example, every 15th) or a day of the week (for example, the third Wednesday). For months with fewer than 29, 30, or 31 days, the schedule runs on the last day of the month.
      • Yearly — set a specific date (for example, 1 May) or a day of the week (for example, the third Wednesday of June). For months with fewer than 29, 30, or 31 days, the schedule runs on the last day of the month.
  6. Link the calendar to other calendars as needed.
  7. Click Create calendar.

After creation, the app shows a success notification. New calendars are Enabled by default.

Linking connects one calendar to others you have already created. Instead of copying the same time periods in multiple calendars, you can define schedules such as business hours or public holidays once, then combine them in a single calendar for your applications to use.

To link calendars:

  1. Open the create or edit calendar drawer.
  2. Navigate to the Link to calendar option.
  3. Search for an existing calendar. From the results, you can view whether each calendar is tagged as enabled or disabled.
  4. Select one or more calendars to link.
  5. Save the calendar.

Linked calendars appear in the parent calendar’s details when you expand its schedule card or open the edit drawer.

Note

The parent calendar is active only when its own time periods and every linked calendar are active.

Edit a calendar Copied

  1. Open a calendar from the schedule list.
  2. Update the timezone, description, time periods, or linked calendars.
  3. Click Save.

The calendar name cannot be edited. To rename a calendar, create a new one with the required name and delete the old calendar if it is no longer referenced.

Enable or disable a calendar Copied

Toggle the Enabled/Disabled switch on the calendar schedule card to enable or disable a calendar. When a calendar is enabled, applications that use it apply its schedule. When it is disabled, the schedule is no longer applied.

Clone a calendar Copied

  1. On the schedule card for the calendar you want to duplicate, select the Clone action (copy icon).
  2. This opens the Create calendar drawer with the source calendar’s timezone, description, time periods, and linked calendars copied. The name defaults to Copy of <original name> or Copy of <original name> (1) if that name already exists.
  3. Edit the name, time periods, or linked calendars if needed.
  4. Click Create calendar.

Linked applications are not copied, and the new calendar is unbound until you configure them in each app.

Delete a calendar Copied

  1. Click the delete action from the schedule card or edit drawer. If the calendar is linked to another calendar, the app shows Cannot delete parent calendar and lists the calendars that reference it. Remove those links first, then retry the delete.
  2. Click Delete Calendar to confirm deletion.

To delete a time period inside a calendar, use the time period delete action and click Delete time period to confirm. Deleted calendars and time periods can no longer be recovered.

Using calendars in other ITRS Analytics applications Copied

Calendars you create in the Calendar app are available to other ITRS Analytics applications that support calendar binding. Created calendars become available in each application’s configuration sections and apply the schedule according to that app’s rules.

Use the Enabled / Disabled switch on the schedule card to control whether bound applications apply the calendar. When disabled, applications stop applying the schedule, but the calendar settings and bindings are kept so you can turn it on again without re-selecting it in each app.

To use a calendar in another application:

  1. In the Calendar app, create a calendar with at least one time period. Ensure the calendar is enabled.
  2. Open an application that supports calendar binding (for example, Capacity).
  3. In that application’s configuration screen, select the calendar and complete any app-specific options. In Capacity, select available calendars from the Calendar dropdown when you create or edit a capacity configuration.

Troubleshooting Copied

Symptom What to check
No calendars appear in the list No calendars exist, or your user does not have access to any saved calendars.
A specific calendar does not appear in the list Clear filters, check name/description search, date range, timezone, calendar type, linked application, and upcoming time period limit.
Cannot save the drawer Check required fields such as name, timezone, start time, end time, start date, and recurrence-specific fields.
Cannot delete a calendar The calendar may be a parent calendar. Remove it from any calendars listed in the delete confirmation dialog.
No linked applications are shown No returned calendar is currently referenced by an application.
Linked calendar search has no results The current search text does not match any linkable calendar, or there are no other calendars available.
["ITRS Analytics"] ["ITRS Analytics > Calendar"] ["User Guide"]

Was this topic helpful?