Skip to main content
Adaptive Insights
Knowledge and Support - Adaptive Insights

Time Administration

The Time Administration screen lets you see and configure the time strata currently defined for your model. It displays the full time tree for your strata —showing the days each time period spans and how those periods roll up to other time periods.

It also lets you:

  • Upload and download the spreadsheet used to configure time
  • Choose the default locale for your calendar
  • Add locales for your calendar
  • Upload and download spreadsheets containing time period labels and shortnames for locales
  • Extend the defined time of an instance without swapping it to a custom time configuration

Changing your time configuration in an instance deactivates all APIs older than version 15 which specify time periods. Once you have customized your time, any attempt to use old API versions which request a particular month of data (or similar API call) will return an error. You must upgrade all API clients to use the new version 15 API to specify the new time periods.

Permissions Required to Configure Time

Administrative permissions and the Admin Time permission to view the Time Administration screen. The additional Configure Calendar permission is required to import a calendar and clear data. 

Time Management UI

Navigation: Visit Modeling > Model Management and click Time

It contains three panels: 1 Time/Locale, 2 Time Tree, and 3 Strata Rollups.

Time Management

Time/Locale

This panel is for managing your locales, importing and exporting your calendar, and selecting a locale to display in the Time Tree panel. If a custom calendar is not configured, this panel can also be used to extend the defined time for your instance. 

The time panel toolbar has buttons for adding a Locale, importing a calendar, exporting the calendar, importing labels, exporting labels, and deleting the selected locale. It also includes a Clear data link to the right for erasing all data.

The Clear data action erases all data including versions, reports, sheet data, and other data. It cannot be undone.

The locale list lets you determine the default locale and add supported locales to your list. If you select a locale, the other panels dynamically update with that locale's information. Only one locale can be selected at a time.

If there are pending changes, the import calendar button will be disabled.

A calendar can only be uploaded for the default locale.

Time Tree

This area shows your time tree with its labels exactly as users will see it elsewhere in the Adaptive Suite for the selected locale. It applies to all sheets and all features in your instance. The name of the selected locale appears at the top.

All time periods receive a label whether you defined one or not. Just like the other tree controls in Planning, you can expand and collapse its nodes, or search using its Search tab.

Strata Rollups

This displays how your defined time strata roll up into each other, lowest time stratum to highest time stratum, with the default time stratum highlighted orange. The right side of the strata rollups contains a dropdown for setting your instance's default time stratum.

You can collapse the strata rollups pane by clicking the Hide Strata Rollups button on the far right.

Extending the Defined Time for an Instance

You can extend the defined time for an instance without converting it to a custom calendar by using the Extend buttons in the Time/Locale toolbar.

Time cannot be extended if a custom calendar has been configured.

Click Extend backward five years extendBackward.png to prepend five years to to the beginning of your defined time. Each click prepends five years.
Click Extend forward five years extendForward.png to append five years to the end of your defined time. Each click appends five years.

Importing a Calendar

The ultimate goal of configuring time is to make sure your instance knows where each day fits in your time structure.

If you want to shift from one calendar type to another — Monthly to Weekly, Weekly to Daily, Monthly to 13 Period — create a sandbox instance and perform testing there. Swapping leaf strata from one type to another is destructive to the data in the calendar.

Time is configured by uploading a spreadsheet in a format commonly used by accounting systems. All of the days in a year appear in the far left column. Additional columns come in triplets of Code, Label, and Short Name. These columns identify which time periods a date falls into for each stratum of an instance's time tree.

Column Possible Values Description
Date* Excel Date format.  e.g. mm/dd/yyyy Date is required in the first Column.  It must be in an Excel date format.
Code* Any unique Code used to describe the stratum of this date. 
 e.g. M1_FY16
Code is a unique identifier for the stratum and is used in formula references.  It cannot be translated, contain no spaces, dashes or other special characters are allowed. Code(s) listed on the Second Row of the import Template define the Strata,  Row Three and below define the Time Periods
Label* Any Text used to describe the stratum of this date. 
 e.g. Month1 2016
Label is for display purposes only (on sheets, and in reports).  Can be localized per locale.
Short Name Optional field can be left blank. Any Text used to describe the stratum of this date. 
 e.g. M1 -16
Short Name can be used to abbreviate long labels and is for display purposes only (on sheets, and in reports).   Can be localized per locale.  
* indicates a required column

The triple columns of Code, Label, and Short Name must be ordered from the lowest time stratum on the left (like Week) to highest time stratum on the right (like Year).

Below is a weekly calendar example, where week is the leaf stratum.

time-structure-xlsx.png

Time Structure Configuration Options

When configuring a time structure, you have three options:

  • Update Structure: This option allows you to make changes such as providing a different label for an existing stratum. It can also be used to add new strata. This option does not change existing data.
  • Append Structure: This option allows you to add new time periods. It does not allow you to modify the strata. You cannot add or delete a stratum, but you can add time periods. There cannot be any gaps in the dates, and the existing time periods cannot be modified.
  • Reload Entire Structure: This option clears all existing data. Only use it to make significant changes to the time structure such as swapping an instance from monthly planning to weekly planning.

Steps to Import a Custom Calendar

  1. Navigate to Modeling > Model Management
  2. Click on Time.
  3. Select the default locale.
  4. If you plan to use the Update option, click Export Calendar exportCalendar.png to download the existing time structure.
  5. Click Import Calendar importCalendar.png in the toolbar. This pops up a window for time structure import with the following options
  • Import Operation - select Update, Append, or Reload entire structure (Reload clears all existing data)
  • Download Template link - click to download an empty template for the Append or Reload entire structure options
  • Upload and Cancel buttons
  1. Click the link to download the import template.
  2. For Append or Reload, populate the import template with the desired entries you want to add.
  3. For Update, make changes to the exported calendar spreadsheet you downloaded in step 4.
  4. Save the import template or exported calendar to a convenient location on your machine.
  5. In the structure import popup window, click the Choose File button to locate and select the import file.
  6. Click Upload.

Creating New Time Strata

  1. Navigate to Model > Model Management
  2. Click Time.
  3. Select the default locale.
  4. Click Export calendar exportCalendar.png in the toolbar to download the spreadsheet containing your configured time.
  5. Insert a Code*, Label*, and Short Name column, in that order, to the left of the stratum it rolls up to.
  6. Fill in all of the cells for the new Code and Label columns you added. Optionally, fill in the Short Name column cells. Save the spreadsheet.
  7. Click Import Calendar importCalendar.png in the toolbar.
  8. Select Append in the Import Time Structure dialog and click Choose File to navigate to your locally saved spreadsheet.
  9. Click Upload.

Adding a New Locale

  1. Navigate to Model > Model Management
  2. Click Time.
  3. Click New Locale newLocale.png in the toolbar.
  4. Select a locale and click Add.

Updating Labels for a Non-default Locale

These steps work for any locale that is not set as the default.

There is a restriction for label import for all locales. If a time period has a short name, then its corresponding stratum must also have a short name.

  1. Navigate to Model > Model Management
  2. Click Time.
  3. Select the non-default locale you want to update labels for in the Time/Locale panel.
  4. Click Export labels exportLabels.png to download the TimeLabels.xlsx file.
  5. Fill in the Label and Short Name columns of the spreadsheet and save it locally. Do not edit the Code column.
  6. Make sure the locale you want to update is still selected in the Time/Locale panel.
  7. Click Import labels importLabels.png in the toolbar.
  8. Click Choose File in the Import Labels dialog, and upload your TimeLabels.xlsx file.

Updating Labels for the Default Locale

  1. Navigate to Model > Model Management
  2. Click Time.
  3. Click Export labels exportLabels.png to download the TimeStructure.xlsx file.
  4. Change the labels in the *Labels column and save the spreadsheet.
  5. Click Import labels importLabels.png in the toolbar.
  6. Select the Update Structure option in the Import Time Structure dialog and click Choose File to navigate to your locally saved spreadsheet.
  7. Click Choose File in the Import Labels dialog, and upload your TimeLabels.xlsx file.

Deleting a Locale

Deleting a locale cannot be undone.

  1. Navigate to Model > Model Management
  2. Click Time.
  3. Click the locale you want to delete. You can not delete the default locale.
  4. Click Delete TrashIcon.png in the toolbar.

Changing the Default Locale

  1. Navigate to Model > Model Management
  2. Click Time.
  3. Follow the steps for Updating Labels for a Locale and upload a completed TimeLabels.xlsx file for the locale that needs to become the default.
  4. Click the Default radio button for this locale.

Default Time Stratum

You can choose the default time stratum all new standard, cube, or model sheets inherit from your configured time. This facilitates model dependent time, which allows different areas of your model to use different time strata. For example, your instance may have a configured calendar that rolls up Week > Month > Quarter > Half Year > Year. The core of your model may only need a time stratum of Month. Specific modeled and cube sheets can be configured to use Week for their time stratum.

Set the Default Time Stratum

The default time stratum for an instance cannot be changed unless all of the data in its standard accounts and standard sheets is erased.

  1. Navigate to Model > Model Management.
  2. Click Time
  3. Erase all of the standard data by clicking the dropdown icon to the right of delete TrashIcon.png deleteEraseStandardData.png in the toolbar and selecting Erase Standard Data.
  4. Confirm that you acknowledge you are erasing all of your standard data and click Yes.

Erasing standard data cannot be undone.

  1. Click the dropdown in the Strata Rollups bar to select a different default.
  2. Click Set.
  3. The default time stratum you select highlights in orange. 
  • Was this article helpful?