today - script and chart function

Overview

The following example creates three variables using the today() function. Each variable uses one of the timer_mode options to demonstrate their effect.

For the variables to demonstrate their purpose, reload the script and then, after 24 hours, reload the script a second time. This will result in the today(0) and today(1) variables showing different values, thereby correctly demonstrating their purpose.

Load script

LET vPreviousDataLoad = today(0);
LET vCurrentDataLoad = today(1);
LET vApplicationOpened = today(2);

Results

Once the data has been loaded for a second time, create three textboxes using the directions below.

First, create a textbox for the data which has previously been loaded.

Do the following:

1. Using the Text & Image chart object, create a textbox.

2. Add the following measure to the object:

   =vPreviousDataLoad

3. Under Appearance, select Show titles and add the title 'Previous Reload Time' to the object.

Next, create a textbox for the data which is currently being loaded.

Do the following:

1. Using the Text & Image chart object, create a textbox.

2. Add the following measure to the object:

   =vCurrentDataLoad

3. Under Appearance, select Show titles and add the title 'Current Reload Time' to the object.

Create a final textbox to show when the user's session in the application was started.

Do the following:

1. Using the Text & Image chart object, create a textbox.

2. Add the following measure to the object:

   =vApplicationOpened

3. Under Appearance, select Show titles and add the title 'User Session Started' to the object.

The above image shows example values for each of the created variables. For example, the values could be as follows:

• Previous Reload Time: 06/22/2022

• Current Reload Time: 06/23/2022

• User Session Began: 06/23/2022

Overview

The following example creates three chart objects using the today() function. Each chart object uses one of the timer_mode options to demonstrate their effect.

There is no load script for this example.

Results

Once the data has been loaded for a second time, create three textboxes.

First, create a textbox for the latest data reload.

Do the following:

1. Using the Text & Image chart object, create a textbox.

2. Add the following measure.

   =today(0)

3. Under Appearance, select Show titles and add the title 'Latest Data Reload' to the object.

Next, create a textbox to show the current time.

Do the following:

1. Using the Text & Image chart object, create a textbox.

2. Add the following measure:

   =today(1)

3. Under Appearance, select Show titles and add the title 'Current Time' to the object.

Create a final textbox to show when the user's session in the application was started.

Do the following:

1. Using the Text & Image chart object, create a textbox.

2. Add the following measure:

   =today(2)

3. Under Appearance, select Show titles and add the title 'User Session Began' to the object.

The above image shows example values for each of the created objects. For example, the values could be as follows:

• Latest Data Reload: 06/23/2022

• Current Time: 06/23/2022

• User Session Began: 06/23/2022

The 'Latest Data Reload' chart object uses a timer_mode value of 0. This returns the timestamp for the last time the data was successfully reloaded.

The 'Current Time' chart object uses a timer_mode value of 1. This returns the current time according to the system clock. If the sheet or object is refreshed, this value will be updated.

The 'User Session Began' chart object uses a timer_mode value of 2. This returns the timestamp for when the application was opened, and the user’s session began.

Overview

Open the Data load editor and add the load script below to a new tab.

The load script contains:

• A dataset containing a set of loan balances, which is loaded into a table called Loans.

• Table data with fields for loan ID, balance at the start of the month, and the simple interest rate charged on each loan per annum.

The end user would like a chart object that displays, by loan ID, the current interest that has been accrued on each loan in the month to date. Although the application is only reloaded once per week, the user would like the results to be refreshed whenever the object or application is refreshed.

Load script

Loans:
Load
*
Inline 
[
loan_id,start_balance,rate
8188,$10000.00,0.024
8189,$15000.00,0.057
8190,$17500.00,0.024
8191,$21000.00,0.034
8192,$90000.00,0.084
];

Results

Do the following:

1. Load the data and open a sheet. Create a new table.

2. Add the following fields as dimensions.

   • loan_id

   • start_balance

3. Next, create a measure to calculate accumulated interest:

   =start_balance*(rate*(today(1)-monthstart(today(1)))/365)

4. Set the measure's Number formatting to Money.

The monthstart() function, using the today() function to return today’s date as its only argument, returns the start date of the current month. By subtracting that result from the current date, again using the today() function, the expression returns the number of days that have elapsed so far this month.

This value is then multiplied by the interest rate and divided by 365 to return the effective interest rate incurred for this period. The result is then multiplied by the starting balance of the loan to return the interest that has been accrued so far this month.

Because the value of 1 is used as the timer_mode argument in the today() functions inside the expression, each time the chart object is refreshed (by opening the application, refreshing the page, moving between sheets etc.), the date returned will be for the current date, and the results will be refreshed accordingly.