What is a History Modifier?
History modifiers offset formula results when formulas are added to a widget (on dashboards, in reports, or wherever formulas are used).
What can it be used for?
This feature is useful if you want to add two formulas to the same widget where:
one shows the current KPI and
the other is offset with a history modifier and shows a past KPI, even though the time period on the widget is one and the same (for example, Current month).
This way, you can compare your current KPI to, for example, the previous five days, two weeks before the beginning of this month, the past two years, and so on.
How to use it?
The history modifier belongs to the Data function component in the formula editor.
To use it, create a Data function component, fill out the required fields and click Done. Then, you will be able to add a history modifier to the component.
Available time periods and combinations
The history modifier allows you to offset the formula by: Days, Weeks, Months, Years.
Example
⭐️ We have a formula that calculates the number of sales deals, offset by 5 days.
Let's break down how a dashboard widget would display data from the formula above if different time periods are selected.
Today – The widget will display data from five days back, starting from yesterday. For example, if today is June 10, it will show data from the 5th until the 9th of June (both days included).
Current week – The widget will display data from five days back, starting from the last day of the previous week. For example, if today is June 10 and the week starts on June 7, the widget will show data from the 2nd until the 6th of June (both days included).
Current month – The widget will display data from five days back, starting from the last day of the previous month. For example, if today is June 10, it will show data from the 27th until the 31st of May (both days included).
Current year – The widget will display data from five days back, starting from the last day of the previous year. For example, if the current year is 2022, the widget will show data from the 27th until the 31st of December 2021 (both days included).
History modifier in the Advanced formula editor
The available history modifiers in the Advanced editor are: Day, Week, Month, Year.
Here are some examples:
.History(2,day).History(3,week).History(10,month).History(3,year)
( |