timeFrameScaleMode

This parameter is used in addition to timeFrames and timeFramesScale to determine how the total time spent is estimated. Possible values are lastActivity, lastActivityCumulative or timeSpent

timeSpent will only report on time the learner has spent learning within the specified time frame.
lastActivity will report the total time the learner has spent learning if the last access date is within the specified time frame.
lastActivityCumulative will report the total (sum) time spent by a learner for timeSpentCBT, timeSpentDigital & timespent, ignoring the restriction with the timeFrame.

Here is the list of all possible values for timeFramesScale:

less_than_n_days
less_than_n_months
less_than_n_full_months
less_than_n_years
less_than_n_full_years

Important: As this parameter is based on the learner’s activity, it should not be used together with the withoutLaunchTime option. Using both at the same time will prevent from retrieving the data without activity (as they will be excluded by the timeFrames activity filter).

Warning: The timeFrameScaleMode parameters less_than_n_full_months and less_than_n_full_years work differently.

For a timeFrames with a value N:
- less_than_n_full_months will return data for N full months + the current month.
- less_than_n_full_years will return data for N last years, including the current year.

For exemple, if timeFrames = 3, and the extract happens on February 24th 2021:
- less_than_n_full_months will return all data for November 2020, December 2020, January 2021, and data only from February 2021, 1st to 24th
- less_than_n_full_years will return all data for 2019, 2020, and for 2021, only data from January 1st to February 24th.

Example when used for Tracking provider

1. Hugo watched C1 in T1 on January 2^nd 2021, spent 50 sec and has status = incomplete.
2. Hugo watched C1 in T1 on February 25^th 2021, spent 300 sec and has status = completed.
3. Hugo watched C1 in T1 on April 5^th 2021, spent 50 sec and has status = completed.

The tracking report has been generated on 28^th May. timeFramesScale was set to n_full_months

Scenario 1: timeFrames = 0. Reporting time frame is 1^st to 28^th May.
Whether lastActivity or timeSpent mode is used, no data row in the report will included, because Hugo did not access the content during the reported time frame.

Scenario 2: timeFrames = 1. Reporting time frame is 1^st April to 28^th May.
If lastActivity mode is used, the data in the report will show Hugo; T1; C1; 400 sec; 100%; Completed, because he accessed it within the specified time frame and the total time spent of the content is included.
If timeSpent mode is used, the data will show Hugo; T1; C1; 50 sec; 100%; Completed, because Hugo only spent 50 sec on the content within the specified time frame

Scenario 3: timeFrames = 3. Reporting time frame is 1^st February to 28^th May.
If lastActivity mode is used, the data in the report will show Hugo; T1; C1; 400 sec; 100%; Completed, because same as in scenario 2 he accessed it within the specified time frame and the total time spent of the content is included.
If timeSpent mode is used, the data will show Hugo; T1; C1; 350 sec; 100%; Completed, because out of total 400 sec Hugo spent on the content, the 50 sec spent on January 2^nd are outside of the specified time frame.

<parameters>
    <timeFrames>2</timeFrames>
    <timeFramesScale>less_than_n_full_months</timeFramesScale>
	<timeFrameScaleMode>timeSpent</timeFrameScaleMode>
</parameters>