Différences

Ci-dessous, les différences entre deux révisions de la page.

--- blocks:usestats:technique:settings [2017/06/11 16:49] – [Bloc Use Stats (Mesure d'activité)] admin
+++ blocks:usestats:technique:settings [2026/01/13 08:03] (Version actuelle) – modification externe 127.0.0.1
@@ Ligne 1: / Ligne 1: @@
-===== Site wide configuration =====
+<html><!-- nomoodle --></html>{{ :logo-apl.png?nolink |}} <html><!-- /nomoodle --></html>
-===== Bloc Use Stats (User time tracking) =====
-From version 2016020600 upwards, a greater flexibility is achieved using additional settings:
-==== Réglages de l'affichage =====
+===== Bloc Use Stats (User time tracking) : Global settings=====
-Ces réglages concernent ce qui est affiché dans l'espace du bloc lorsqu'il est inséré dans un écran de Moodle.
-{{::block_use_stats:settings_fr_display.png|}}
+==== Add a block ====
-**1. Période de compilation :** Afin de ne pas trop surcharger la page par une epxloration de nombreuses traces à chaque affichage, la période de compilation par défaut est réglée à 90 jours. Vous pouvez la réduire pour des sites à très forte activité, et laisser les utilisateurs l'augmenter ponctuellement pendant une session s'ils en ont besoin. Notez que les temps affichés ne calculent bien évidemment que les temps compris dans la période de complation. Ce réglage est spécifié en "jours passés" à partir de la date courante.
+The Use Stats block can be added anywhere in Moodle, provided you have the standard ability to add the block (> M2.4).
-**2. Masquer les temps inférieurs à :** en desosus de ce temps (en secondes), les cours ne sont plus mentionnés dans l'affichage. Cela permet de clarifier l'affichage de la statistique. Un petit signal en bas de l'interface vous signalera que tous les cours et leurs temps ne sont pas complètement affichés.
+Turn Moodle in edit mode, and use the 'Add block' menu. Then choose the block "Use Stats (User time tracking)"
-**3. Afficher le temps hors cours :** S'il est actif, le temps passé dans les pages d'accueil, les pages générales du site, ou d'autres espaces qui ne sont pas assimilables à des cours seront affichés. sinon, ces temps sont extraits du calcul.
+{{ :blocks:usestats:usestat.jpg?nolink |}}
-**4. Temps de référence :** Etant donné la variabilité réglementaire en matière de validation des temps, vous pouvez ici choisir quel sera le temps de référence pour l'affichage :
+==== Block in standard mode ====
-   - Le temps complet du cours : Ce temps comprend toutes les traces et temps intercalaires du cours.
-   - Le temps des activcités : Ce temps ignore les temps intercalaires du cours qui ne sont pas explictement affectable à des modules d'activités formels de Moodle. Il est donc important de bien réfléchir à la conception des cours afin que des apprentissages effectifs ne se voient pas ignorés parce qu'il n'ont pas de contexte d'activité désigné.
-==== Réglages de l'analyseur de traces ====
+The Use Stats block, in standard mode, will only show you your own statistics.
-{{::block_use_stats:settings_fr_logtrack.png|}}
+==== Block in administrator mode ====
-**5. Seuil de détection des déconnexions :** Ce temps détermine en secondes, le temps d'inactivité au dessus duquel l'analyseur va conclure à une interruption potentielle de la session de travail et simuler une déconnexion. Par défaut, ce temps est de 10 minutes (600 secondes). Ce temps doit être ajusté avec attention et est très dépendant de la stratégie de publication pédagogique dans Moodle. si vous découpez fortement le contenu en très petits grains qui nécessitent de nombreux rechargement de pages, vous pouvez alors le réduire, en diminuant le "biais" de mesure. Si au contraire, vous découpez grossièrement votre contenu pédagogique ou publiez des gros documents qui induisent des temps de travail non interactifs de longue durée, vous devrez l'augmenter, mais augmenterez aussi l'incertitude sur la mesure.
+In administrator mode, you can view the statistics of other users.
-**6. Crédit temps de déconnexion :** Lorsqu'une déconnexion est simulée, l'analyseur de trace ne peut pas savoir combien de temps l'utilisateur a continué à travailler ou être présent sur la dernière page visitée. Sanctionner une fin de session apparente par un temps nul pourrait dans certains cas défavoriser le calcul de temps de l'étudiant. Ce paramètre permet d'accorder un crédit temps correctif sur ces évenements. L'expérience montre qu'il ne faut pas accorder un crédit temps trop important, car les statistiques calculées pourraient paraitre très au dessus de la perception réelle du temps de travail. En général, on s'accorde sur quelques minutes.
-==== Réglage du tracking multidimensionnel ====
+==== General Settings (Site wide configuration) =====
-L'extraction multidimensionnelle est un dispositif optionnel destiné à faciliter l'extraction et l'exploitation des traces par des outils d'analyse de données tiers. Des outils externes de reporting permettent de générer des rapports d'autant plus utiles que les données sont qualifiées et peuvent être affichées de manière intelligibles par les exploitants. A cette fin, ce dispositif permet d'ajouter aux enregistrements d'historiques des "valeurs explicites", comme par exmple le titre du'ne catégorie, le nom d'un cours, le login de l'utilisateur, là où les traces standard de Moodle n'enregistrent que des identifiants internes (id numériques).
-Attention, l'activation du tracking multidimensionnel ne doit être faite que pour répondre à une vrai nécessité d'analyse. La masse de données générées par la qualification des historiques peut être très importante et diminuer les performances générales de Moodle pour des sites à fréquentation très élevée.
+===Some information on the block settings in central administration===
-{{::block_use_stats:settings_fr_etl1.png|}}
+All info in the [[blocks:usestats:technique|technical documentation]]
-**7. Activation du tracking multidimensionnel :** Si vous activez cette option, une tache programmée de Moodle va qualifier tous les historiques entrants depuis le dernier passage du cron. Notez que l'activiation de cette fonction sur un site ayant déjà une forte antériorité d'exploitation peut conduire à une période très longue de rattrapage. (Voir RoadMap)
+===Since block_use_stats | fromwhen===
-**8. alimentation des qualifieurs :** vous pouvez définir ici jusqu'à 6 qualifieurs qui seront renseignés par vos propres requêtes. Pour chaque historique traité, chaque requête de qualifieur exprimée sera exécutée et son résultat sera stocké dans la table multidimensionnelle.
-Pour des raisons d'optimisation, les qualifieurs on été prédéfinis à une certaine longueur :
+Compilation period Possible values: 5, 15, 30, 60, 90, 180, 365 Warning if value entered in free entry field not listed, this will take into account 5 days, ie the default value.
-   - 20 caractères pour les 3 premiers qualifieurs
-   - 128 caractères pour les 3 derniers qualifieurs
-Pour être valide, la requête écrite ne doit retourner qu'une seule valeur unique par ligne. La requête peut contenir quelques emplacements de variables contextuelles qui seront remplacées avant l'exécution :
+===Filter times below (formerly session)===
-   * <nowiki><%%LOGID%%></nowiki> : L'identifiant numérique de l'historique
+block_use_stats | filterdisplayunder Value in second of the time below which the time is taken into account but not displayed in the usestat block: If a session lasts less than one minute (60 seconds), it is considered as not significant, and it does not appear not in the block.
-   * <nowiki><%%USERID%%></nowiki> : L'identifiant d'utilisateur assigné à cet historique
-   * <nowiki><%%%%COURSEID%%></nowiki> : L'identifiant de cours contexte de cet historique
-   * <nowiki><%%CMID%%></nowiki> : L'éventuel identifiant de module d'activité si cet historique est dans un contexte de module.
-{{::block_use_stats:settings_fr_etl2.png|}}
+===Reference time to display===
-**9. Dernière date de compilation multidimensionnelle :** Le processus de qualification est différentiel : il ne calcule que les lignes nouvelles depuis son dernier passage. Lors de l'accès au formulaire de configuration, ce champ vous indiquera la date du dernier historique qualifié. vous pouvez alors altérer cette date pour demander à la tâche programmée de recommencer les calculs à la date voulue.
+block_use_stats | displayactivitytimeonly The block displays either the time spent in activities or the time spent in the History Analyzer Settings class.
-==== Tracking actif de session ====
+===Threshold===
-Cette fonctionnalité vise à fournir une alternative à la détection heuristique de fin de sessions, dont on sait qu'elle introduit nécessairement un biais d'analyse qui peut être plus ou moins corrigé par des méthodes non exactes.
+Credit time assigned by default to the work session in case of accidental termination of session. (Or without going through the menu "Disconnect")
-Le tracking actif va obliger la page de l'utilisateur d'envoyer un signal actif à Moodle tant qu'elle n'est pas refermée. La sécurisation des sessions par tracking "actif" ne présume pas de l'activité de l'utilisateur derrière son écran. De plus la version actuelle du tracking actif ne prend pas en compte des navigations parallèles du même utilisateur dans des fenêtres différentes.
+Example: Set to 60 min: If a learner has a period of inactivity in a session longer than 60 min, ie 1h, it is considered disconnected.
-{{::block_use_stats:settings_fr_keepalive.png|}}
+===Overtime credit on the last ping===
-**10. Période d'émission du tracking actif :** Par défaut l'émission est préréglée à 10 minutes (600 secondes).
+ping block_use_stats | lastpingcredit Additional credit time in minutes in case of no formal logout trace 15mn is the default
-**11. Règle pour la fourniture de l'émetteur :** Tous les utilisateurs de Moodle ne sont pas nécessairement concernés par le tracing. Afin d'optimiser les performances de fonctionnement de la plate-forme, il est souhaitable de ne restreindre l'obligation de suivi qu'aux utilisateurs concernés. Ce réglage permet de définir une règle discriminante pour inclure ou exclure certains types d'utilisateurs du tracking :
-   * Activer pour tous les utilisateurs
+===Show "outside course" times===
-   * Activer pour ceux qui respectent la règle
-   * Activer SAUF pour ceux qui respectent la règle
+{{ :blocks:usestats:technique:usestat-tps-hors-cours.jpg?nolink |}}
+block_use_stats | displayothertime : Uncheck the box to hide on the interface of the block, the time spent outside the course (in the other spaces on the platform)
+===Reference time to display===
+block_use_stats | displayactivitytimeonly We display in the block either the time spent in the activities, or the time spent in the course (as for example on his personal file space, in forums, etc.).
+**One session per course**
+block_use_stats | onesessionpercourse If the check mark is enabled, then the parser will start a new session each time the trace changes course. Otherwise, a session may represent a work session that overlaps with several courses. (this setting is activated on our demo moodle platform)
+====Other useful elements====
+===To change the label "Other class time" :===
+Go to the language files / block / settings.php configdisplayother time.
+===To hide the batch tab of the training session to teachers :===
+batch reports: remove the ability to the role to hide batch tab to the teacher role.
+===Check role permissions :===
+Course Admin / users / permissions / filter on report / trainingsessions: batch
+But going through platform roles at the system level is better not to generate a local override of the rights on the relevant course.
+===To hide "show details" from the UseStats block to a learner:===
+block / use_stats: seeowndetails
+set up to "undefined"
+{{::block_use_stats:settings_fr_display.png|}}
+**1. Compilation default period:** Use Stats will calculate time results for each display. In order NOT to load too heavily moodle whith this block, the compilation period defaults to 90 days. You may set it lower for heavy duty moodle sites with a lot of activity, and let some users push it up during a working session if desired. Note that all times refered to in display are calculated within the compilation period. This setting tells how many days back from the current date the compilation will seek.
+**2. Hide duration lower to:** below this amount of time (in secs), the corresponding courses will not be shown in the display. This may help to focus on most important items. A little warning signal reminds you that everything is not displayed, so do not try to sum all times and get the total match !.
+**3. Display extra time:** If enabled, time spent in site, in general screesn, or any other screen outside the scope of any course will be summed to the displayed time, otherwise the displayed time calculates only durations that can be directly be bound to the courses context (or subcontexts).
+**4. Official time:** there is a lot of variability in the way schools and institutions will agree the time measurement, so you may choose here which time will be the official reference for the display:
+   - Full course time: Will sum all time spent in course global screens and all subcontexts.
+   - Activities: This choice will only count time that is spent in real activity modules of Moodle. This implies the course design must take care of no diverting out of calculation scope some actions of the users.
+==== Log analyser settings ====
+{{::block_use_stats:settings_fr_logtrack.png|}}
+**5. Session break detection threshold:** This time tells from which gap size the log analyser will decide the user is very likely to have deconnected from the current working session. the default is 10 minutes (600 seconds). This threshold may have strong impact on the time calculation by adding time bonus to the user track when he disconnects. It is significantly related to the course content publication strategy. If your content is cut into small pieces needing the user browse often to reload material, then it can be reduced, and the "implicit disconnection bias" will be reduced either. If conversely, you post big documents or asking for long non interactive working sequences, you may raise the value, but also will you raise the interpretation error of the implicit disconnections.
+**6. Time bonus for disconnection:** When an implicit disconnection is detected, the log analyser cannot know how much time the student might have worked on the last opened page. cutting the session on the last log abruptly giving no working time gap could be harsh for some students, f.e. if some resources such as video do not track anything. This parameter lets give an extra standard credit time in such events. Experience shows that this credit time granted to students should not be too generous, or the calculated time might present important and unrealistic overestimations of the real student's work. In general, the workable range for this value is around 10 minutes.
+==== data cubing on moodle logs using Use Stats ====
+the cubing feature of the use_stars block is a provisional feature for those who want use data mining and ETL queries on a Moodle. External reporting suites are efficient if the source of the data can be sufficiently qualified. More over, reports are clearer when the data is qualified using readable labels and values, rather than internal ids or cryptic codes. qualifying the data at query time can lead to a huge processor and memory duty and dramatically lowers moodle performances.
+Thus this feature will prepare the qualification of the logs of Moodle on the fly, making this process continous and low overhead. Logs information can be enriched with up to 6 cubing dimensions where you can feed a course or category name, user name or any significant information for reports. this will complete the standard log table that only stores internal numeric identifiers.
+Warning! activating the cubing feature must be done to comply with a REAL NEED of data analysis. the amount of data stored into the complementary log table of use stats can grow a lot and should be anticipated in server storage size.
+{{::block_use_stats:settings_fr_etl1.png|}}
+**7. Enabling data cubing:** When enabling this feature, a Moodle programmed task will track and follow any new log entries to add qualifier to each record. Be carefull if you enable this feature on an old site that already has a ton of old logs, as the task will try to requalify the entire log base. (See RoadMap)
+**8. Qualifier definition:** Up to 6 qualifiers can be added to the standard log record. Each will be fed with  a custimized query you can define. A getch query will be played for each record and each qualifier to feed the additional log table (mdl_block_use_stats_log).
+for storage optimization reasons, qualifiers have beed restricted to a defined length:
+   - 20 chars length for the 3 former
+   - 128 chars length for the latter
+A valid cubing query MUST be written so it gives back a single value. some usefull placeholders will be replaced before query execution:
+   * <nowiki><%%LOGID%%></nowiki> : The corresponding log record id
+   * <nowiki><%%USERID%%></nowiki> : the id of the log record owner userid
+   * <nowiki><%%%%COURSEID%%></nowiki> : the course identifier as context of this log
+   * <nowiki><%%CMID%%></nowiki> : The course module id if the log is an activity logging record.
+{{::block_use_stats:settings_fr_etl2.png|}}
+**9. Last cubing date reached:** the qualification process is differential: It will only aggregate new records from the last processing date. You may know through this field the last occurrence of a qualification runtime, and may change it to run back the qualification from a given date.
-**12. Méthode :** La méthode pour l'application de la règle. vous pouvez établir une règle sur "capacité" (la règle est accomplie si la capacité est disponible sur le contexte système), ou sur la présence d'une valuer 'vraie' (non vide ou non nulle) d'un champ de profil.
+==== Active session tracking ====
-**13. Item de contrôle :** La capacité, ou la désignation du champ de profil sur lequel la règle s'appuie.
+This feature has been removed.
-[[:blocks:usestats:Technique|Revenir à l'index du guide technique]]
+---------------
+[[:start|Back to home]] - [[:plugins|Back to plugin list order by type]] - [[:Blocks:UseStats|Back to the component index]] - [[:Blocks:UseStats:UserGuide|User guide]] - [[blocks:usestats:technique|Technical index]]