The Time Range section
  • 13 Jun 2024
  • 4 Minutes to read
  • Contributors
  • Dark
    Light

The Time Range section

  • Dark
    Light

Article summary

This topic describes the Time Range section of a Board Data model and its specific properties.

From the Time Range section of a Data model, you can review and change settings related to Time Entities and their Relationship within the Data model.

When you created the Data model, you defined the time range of your data; this initial configuration usually reflects your existing data lifespan and extends for a few years into the future for planning purposes.

Sometimes, you may need to change or update the time range of your data. For example, you may decide to shift the time range to 2019–2023 to include budgeting for the year ahead, or you could shift to 2019–2022, removing one year of past data which is no longer relevant.

contents/assets/images/time range example.png

The minimum length of a time range is one year: in that case, the start year and the end year are the same.
The maximum extent of a time range is 110 years with the earliest being 1990 and the latest 2100.

Changing the Time range

You can always change an existing time range, but some modifications require additional data management activities.

The following modifications can be done at any moment and don‘t require a reload of data:

  • Increasing the end year value (extend future years)

  • Adding or removing Time Entities

The following modifications will clear all data in Cubes of the Data model, to ensure it is restructured in the most efficient way:

  • Changing the start year (extending or removing data relating to years)

  • Decreasing the end year (removing data for future years)

To preserve some or all of the data, the Data model should first be extracted and then reloaded once the modification is made.

Default Time Entities

For settings about the Day, Week, Quarter, and Fiscal Year Time Entities, please refer to this page.

Language

From this dropdown menu, you can change the language of the Time Entities' descriptions (names of the months, etc.).

All Board Data models are unicode-based, so they can support all double-byte languages such as Chinese, Japanese, and Korean.

Other options

Custom Time Entities

The "CUSTOM ENTITIES" button allows you to create up to four custom time Entities.

With custom Time Entities, you can add new units of time (or time intervals) to the standard calendar, for example "Season" or "Promotion".

To access the time Entity configuration page, click the corresponding button. In the time Entities page, you can see all existing time Entities for the Data model and their main information: the table is sortable and searchable using the interactive header fields. You can also show or hide columns to your liking, by clicking the Column chooser button in the upper right corner of the table.

To create a custom time Entity, locate one of the four Entities that is written as "_TimeN", where "N" is a number from 1 to 4, then edit the Entity properties and apply all necessary changes in the properties panel that appears on the right.

contents/assets/images/cubes.custom.time.entities.png

The "Custom Mask" property in the properties panel allows you to enable a custom calendar on which to apply the "Previous Year" and "Yearly Cumulated Value" functions.

A custom calendar can be the length of 1 year, consisting 13 custom time periods of which could each be an aggregation of a certain number of days, weeks, or months. It could even be a standalone Entity not related to the Board's standard Time Entities. With the custom calendar, you can create a custom calendar that follows the typical 4-4-5 weeks convention or other ad-hoc retail calendars. A custom calendar is defined by the corresponding custom Time Entity.

In order to enable this function, the custom Time Entity must contain the year as part of the code of its members.

For example, members of a custom Time Entity could have these kinds of codes: 2022/01, 2022/02, 2022/13, 2023/01, 2023/02, 2023/13, and so on.

To activate the custom calendar function, the part of the code that contains the year must be defined through a Custom Entity Mask. This Mask drives the code convention for that Entity: use the letter "Y" for each digit that represents the year and a "-" (hyphen) for other parts of the code.

The characters representing the year must be numerical. The rest of the code can be alphanumeric and can include separators and spaces.
The number of characters in the Entity Mask must match the code width value.

Examples of possible custom Entity Masks.

Mask

Description

Example

YYYY---

The first four characters represent the year, followed by 3 other characters that represent a period of that year

202201

----YY

The first 4 characters represent the period of the year. The year is represented by the last 2 characters

000122

--YY----

The year is represented by the 2 characters after the first 2 characters of the code

0122aabb

Once the Mask is created, the Entity will be shown in the calendar dropdown menu of the time functions, in the Layout editor. In the following example, the custom Time Entity is "Season":

contents/assets/images/time functions - layout.gif

Custom Time Entities are also supported by the "Current Date" option of the Dynamic Select function and the "Current Period", "Previous Period", and "Last Period" options of the Pager Object.

To learn how to edit an existing Entity and to add new Entity members, please refer to this page.

Custom Relationships

Once you have created one or more custom Time Entities, you have to define their Relationship with other existing Time Entities.

For example, if you want to add the "Season" custom Time Entity (where a "Season" is a group of months), after creating the custom Time Entity "Season", you must create a Relationship with the standard "Month" Entity and define which months belong to which seasons.

To do so, click on the "CUSTOM RELATIONSHIPS" button and, from the Relationship configuration page, drag and drop the standalone parent Time Entity onto the chosen child Time Entity. Unless you need to create a new Time Entities relationship tree, all indirect Relationships with other default Time Entities will be automatically defined by Board.

The ANALYZE action available in the top left corner of the Relationships page allows you to fix missing Relationships, at the member or Entity level.

To learn how to create a new Relationship and how to use the ANALYZE action, please refer to this page.


Was this article helpful?