===== Technical guide =====
===== Training time report (TrainingSessions) =====
===== Output columns list =====

The columns of the summary report (//Summary per participant// screen, Excel, CSV and PDF exports of the summary reports) are defined in the //Output columns in the summary report// option of the plugin settings. They can be overridden for a given course by the //report_trainingsessions_summarycolumns// custom course field.

==== Writing the list ====

One column per line, in the form ''key,format''. The suffix determines the data format in Excel outputs:

^ Suffix ^ Data format ^
| ,n | Numeric |
| ,a | Text format |
| ,t | Date format |
| ,d | Duration format |

   * A line starting with ''#'' is ignored: this is the way to disable a column without deleting it.
   * Columns are produced in the order of the list.
   * Empty lines are ignored.
   * In a course custom field, the value ''**default**'' (or an empty field) falls back to the global list.

==== Available columns ====

The last column tells whether the column is active in the list delivered by default.

=== Identity and profile ===

^ Key ^ Format ^ Content ^ Default ^
| ''id'' | n | Moodle user identifier | yes |
| ''idnumber'' | a | identification number | yes |
| ''firstname'' | a | first name | yes |
| ''lastname'' | a | last name | yes |
| ''email'' | a | email address | yes |
| ''institution'' | a | institution | no |
| ''department'' | a | department | no |
| ''groups'' | a | user's groups in the course | no |

=== Access and enrolment dates ===

^ Key ^ Format ^ Content ^ Default ^
| ''lastlogin'' | t | last login to the platform | no |
| ''firstaccess'' | t | first access to the platform | no |
| ''lastcourseaccess'' | t | last access to the course | yes |
| ''enrolstartdate'' | t | start of enrolment in the course | no |
| ''enrolenddate'' | t | end of enrolment in the course | no |

The enrolment dates used are those of the last active, widest enrolment period that starts before the end of the report period. Future and earlier periods are discarded.

=== Time ===

Times are durations (format ''d''). The notions of course time, time assigned to no course and complementary times are explained in the [[:report:trainingsessions:technique|technical guide]].

^ Key ^ Format ^ Content ^ Default ^
| ''activitytime'' | d | time spent in the course activities (alias ''activityelapsed'') | yes |
| ''coursetime'' | d | time spent in the course outside activities: course home, reports, blocks (alias ''courseelapsed'') | no |
| ''othertime'' | d | time assigned to no course (course 0): login and logout screens (alias ''otherelapsed'') | no |
| ''elapsed'' | d | total time in the course | yes |
| ''elapsedoutofstructure'' | d | total time in the course, plus the time assigned to no course | yes |
| ''extelapsed'' | d | extended time: total time in the course, plus the time assigned to no course, plus the time on the site home page | no |
| ''extotherelapsed'' | d | complementary times: time assigned to no course, plus the time on the site home page | yes |
| ''elapsedlastweek'' | d | total time in the course over the last week of the period | no |
| ''extelapsedlastweek'' | d | extended time over the last week of the period | no |
| ''extotherelapsedlastweek'' | d | complementary times over the last week of the period | no |
| ''uploadtime'' | d | file upload time. This column is only filled if Use Stats provides an upload aggregate, which the current version of Use Stats does not: the value stays at 0. | no |

=== Items and sessions ===

^ Key ^ Format ^ Content ^ Default ^
| ''items'' | n | number of items in the course structure | no |
| ''visiteditems'' | n | number of visited items | no |
| ''workingsessions'' | n | number of working sessions linked to the course (alias ''sessions'') | yes |

=== Events (hits) ===

These columns count trace events rather than durations. **They are only filled for site administrators.**

^ Key ^ Format ^ Content ^ Default ^
| ''hits'' | n | course events and out-of-course events | no |
| ''exthits'' | n | events in the course, out of course and on the site home page | no |
| ''extotherhits'' | n | out-of-course events and site home page events | no |
| ''hitslastweek'' | n | events in the course over the last week | no |
| ''exthitslastweek'' | n | extended events over the last week | no |

==== Other usable keys ====

These keys are not in the list delivered by default, but can be added to it:

   * ''city'' (a): user's city;
   * ''firstcourseaccess'' (t): first access to the course;
   * ''firstip'' (a): IP address of the first access to the course;
   * ''profile_field_//shortname//'': value of a custom profile field, for example ''profile_field_service,a'';
   * ''extrauserinfo1'' and ''extrauserinfo2'' (a): profile fields designated in the plugin settings, //Additional user information// option (legacy method, prefer ''profile_field_'');
   * With the [[:mod:learningtimecheck|Learning Time Check]] module, when the course has pedagogical contract tracking: ''ltcprogressinitems'' and ''ltcprogressinmandatoryitems'' (progress percentage on all items, or on mandatory items only), ''ltcitems'' and ''ltcdone'' (items and completed items), ''ltcmandatoryitems'' and ''ltcmandatorydone'' (same on mandatory items).

==== List delivered by default ====

<code>
id,n
idnumber,a
firstname,a
lastname,a
email,a
#institution,a
#department,a
#groups,a
#lastlogin,t
#firstaccess,t
lastcourseaccess,t
activitytime,d
#othertime,d
#coursetime,d
#uploadtime,d
elapsedoutofstructure,d
elapsed,d
#extelapsed,d
extotherelapsed,d
#items,n
#hits,n
#exthits,n
#extotherhits,n
#visiteditems,n
#elapsedlastweek,d
#extelapsedlastweek,d
#extotherelapsedlastweek,d
#hitslastweek,n
#exthitslastweek,n
#enrolstartdate,t
#enrolenddate,t
workingsessions,n
</code>

<html><!-- nomoodle --></html>

-----

 [[:report:trainingsessions:technique|Component technical section index]] - [[:Plugins|Back to the plugin index]] - [[:start|Back to the catalog]]
<html><!-- /nomoodle --></html>