Configuring Calendars and Events
You can define calendars and events to associate with insights or predictions to improve the accuracy of the insights or predictions.
To use calendars and events with IPM Insights and Auto Predict:
- Define calendars. From the Home page, click IPM, then click Configure, and then click the Calendar tab. See Defining Calendars.
- Define events. From the Home page, click IPM, then click Configure and then click the Events tab. See Defining Events.
- When configuring an IPM Insights job or an Auto Predict prediction definition, associate a calendar with the insight or Auto Predict job. Events are an option for the Anomaly insight job type and Auto Predict. See Configuring IPM Insights and Creating Auto Predictions for Forecasts.
You can also define calendars and events from Auto Predict:
- From the Home page, click Application, then click Overview, and then from the Actions menu, select Auto Predict.
- From the Actions menu, select Calendar to define calendar or select Events to define events. See Defining Calendars and Defining Events.
Defining Calendars
A calendar defines the scope and range of the time series for selected cubes. For example, you can create a daily calendar, a weekly calendar, and an alternate calendar. You might want to create a calendar for a specific entity, because not all events are applicable to all entities. For example, Diwali applies to APAC and Thanksgiving applies to North America, so you can create an APAC calendar with its own events and a North America calendar with its own events.
You can use calendars on their own to quickly set up the time frame for insight and prediction definitions, or use calendars with events.
To define calendars:
- On the Calendar tab, click Add Calendar.
- Enter a name and description for the calendar.
- From the Cube column, select the cubes the calendar applies to.
- From the Dimensions column, select one or more dimensions (up to three) that store date-related information, for example, Year, Quarter, and Month. If you are selecting multiple dimensions, select the dimensions in order of granularity, with the highest granularity first. For example, select the dimension that stores years before the dimension that stores months.
-
From the Time column, specify the members from each dimension that define time for the start of the calendar. You can select specific members or use substitution variables.
-
From the Current column, specify the members from each dimension that define the start of the prediction period. The previous period is the end of historical data.
- Enter the Number of Historical Periods and
Number of Future Periods, and then click
Save
.
The number of historical periods and the number of future periods you enter must result in member selections that are within the range defined for calendar. For example, if the calendar range is defined as FY20 to FY25, Lev0Descendants(YearTotal), and the current period is defined as Jan->FY24, then the maximum number of historical periods you can enter is 48 periods (4 years). Any number higher than 48 results in an error. Similarly, the maximum number of future periods you can enter is 24 periods (2 years). Any number higher than 24 results in an error, because Jan FY26 or higher is not part of the calendar range.
Editing Calendars
To edit a calendar, from the Calendar list, double-click the
row with the calendar you want to edit to make the options editable. Make any
required changes, and then click Save
. To discard your changes, click Cancel
.
For example, you can change the Number of Historical Periods and Number of Future Periods.
Alternatively, click the Actions menu next to a calendar, and then select Edit or Delete.
To delete a calendar, from the Calendar list, click
Actions
next to the calendar you want to delete, and then click Delete
Calendar.
Defining Events
Events are associated with calendars.
To define events:
- On the Events tab, click Add Event.
- Enter a name and description for the event.
- From the Type column, select the type of event:
- One-off: An event you don’t expect to be repeated, but you want to include it in your data.
- Repeat: An event that is regularly repeated, where increases or decreases will also be repeated. For example, holidays such as Diwali or Thanksgiving are repeating events.
- Skip: Similar to a one-off event, it’s an event
you don't expect to be repeated, however, you don't want to include it
in your data. Data for Skip events is removed from the series.
Note:
If you define a Skip event that is shorter than your seasonality, it can affect the accuracy of the historical data. For example, you might define an event for Covid that is three months long, but your season is twelve months, so you have only nine months of data. You lose seasonality because the data is skewed. In these cases, it might be more effective to skip the entire season.
- From the Calendar column, select the calendar that the event applies to.
- From the Starts on column, specify the start date for the event.
- From the Duration column, enter the event duration (the number of periods the event is valid). For example, in a daily calendar, if duration is 4, the event occurred for 4 days continuously from the start of the event. In a weekly calendar, if duration is 1, the event occurred for a week.
- For regularly repeating events, from the Interval column,
enter the interval for the repeat. For regularly repeating events, the interval
should be a number that indicates after how many days, weeks, or months the
event repeats. For example, in a weekly calendar, Christmas repeats after 52
weeks.
You don't need to specify an interval for one-off or skip events.
- For custom repeating events, from the Occurrences column,
click
and enter specific details about when the event occurs. For example, US Thanksgiving occurs annually, but on a different date each year.
- Click Save
.
Events are automatically set in Active status (indicated by the check mark in the Active column). You can clear the check box to make an event inactive. Only active events are taken into consideration during predictions.
To edit an event, from the Events list, double-click the row
with the event you want to edit to make the options editable. Make any required
changes, and then click Save
. To discard your changes, click Cancel
.
To delete an event, from the Events list, click
Actions
next to the event you want to delete, and then click Delete
Event.
Importing and Exporting Events
You can export events to a .csv that you download, and then add or modify events. You can then import the events from the csv file. This process is a fast way to add many events, and can be valuable for auditing and troubleshooting event definitions.
To export events, on the Events tab of IPM Configure, from the Actions menu, select Export Events.
To import events, on the Events tab of IPM Configure, from the Actions menu, select Import Events, select the file and then click Import. You can then review the Import Events job. From the Home page, click Application, then click Jobs and then click the Import Events job that was run.
If you import an event with the same name as an existing event, the existing event is overwritten.