Calendars

The calendar feature is an advanced feature in Decision Insight. You need to purchase a license with the calendar option to use this feature.

This section explains how to use the Axway Decision Insight (DI) calendars. You must have a license with the calendar feature or still be in the calendar trial period on a standard license to work with this feature. 

Definition

What is a calendar?

A calendar defines a list of periods that define custom and specific activities like:

  • Active/inactive
  • Maintenance
  • Low/Normal/High activity
  • Etc …

Each of these periods can match:

  • A date (ex: December 24th)
  • A day of the week (ex: every Sunday)
  • A time period (ex: 12h-13h)
  • A combination of the previous examples.

What is the benefit of using calendars?

Some time periods have activities/volumes that are so different that certain days must be segregated from others in order to ensure accurate evaluations.

In this context, Calendars allows to define these different period types and then apply different evaluations, rules & processes to each of them.

For example:

  • the activity of an ice cream seller depends mostly on the season; lots of sales in summer and practically none in winter.
  • for a supermarket closed on Sunday, it is normal to process a certain amount of transactions from Monday to Saturday and none on Sunday.
  • for a fast-food restaurant, the number of clients is very low between meals whereas, during the rush hours, this number is very high.

In each of these brief examples, the model of the business keeps being the same, only the profile of the data changes over time. They can have very different characteristics from one time-period to another.

And so the best way to monitor them should take into account this variation of the activity levels.

Using calendars

The following diagram provides a quick overview of how to set up and use calendars. 


Defining a calendar

In the calendar definition screen, you can create or edit a calendar. See Define a calendar for more details on this screen.

At creation, you must link your calendar to at least one entity. The linked entity will hold the calendar configuration attribute while each instance of the linked entity will hold a calendar configuration.

Then, you can define the period types you need. A period type is a time frame that represents a kind of business, human or processing activity.

Default period type

A pre-defined Default period always exists by default. When evaluating the current period, if no user-defined period matches the configuration, then this default period is used.


Once your calendar is saved, the model is updated and the following elements are created:

Element Description
A read-only entity for the calendar period types For example, if the Calendar is named Activity, the entity is named Period types of Activity
The period types of the calendar are saved as instances of this entity, including the default period.
calendar configuration attribute For each entity linked to the calendar.
This attribute is named the same as the calendar (Activity in our example). 
It will hold the configuration.

Creating and using calendar based attributes

Once you have saved the new calendar, a link is visible in the right panel of the calendar screen that invites you to create calendar attributes.

When you click that link, you will create two attributes:

Attribute Description
configuration attribute Defined as a multi-dimensional attribute between the Period type entity and the linked entity(s) 
Use it to set or absorb values for each period types and each instances of the linked entity(s).
runtime attribute

Owned by the linked entity(s) only.
Use it to read the value of the current Period type. It can be displayed in dashboards or used as computing input.
It can be easily identified by the small calendar icon () next to the attribute name.

Once these two attributes are created, they are easily identifiable:

the first is the runtime attribute

the second is the configuration attribute

Configuring a calendar

The calendar configuration defines the schedule of the period types. The scheduling is expressed using ICS events.

Use data integration to inject the calendar configuration for each instances of the linked entity(s).

For more information, see Configure a calendar.

Activating the calendar feature

If you have several nodes in your deployment, install the license on every node.

Note that you can use the feature for free during the 30-day trial period.

When the calendar feature expires

The calendar feature may expire for one of these reasons:

  • The 30-day trial period is over.
  • Your calendar license has expired.
  • You install a newer license (without calendar option) on top of the old one (with calendar option).

However, the calendar feature will stay active until next node restart.

Then, all dashboards and all computing having a calendar-based input continue to work in a disabled mode: they only use the values carried by the default period .

You continue to have the ability to create a calendar, periods, create and update calendar-based attributes, etc. But the current period type will be always the default one.

When the calendar feature re-enables

If your calendar option expired and you install a newer license with calendar option, the calendar feature re-enables immediately.

To get calendar-based values back: 

  • In a dashboard: just refresh the dashboard..
  • In computing: the next computations will take all the periods into account. Recompute the calendar attributes over the interval when the feature was disabled.

Related Links