Skip to content

Commit

Permalink
Merge pull request #5431 from benjaoming/user-log-docs
Browse files Browse the repository at this point in the history
User log docs
  • Loading branch information
benjaoming committed Apr 6, 2017
2 parents 4d3336c + fef4adf commit b5f7bf9
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions docs/usermanual/userman_admin.rst
Original file line number Diff line number Diff line change
Expand Up @@ -670,13 +670,13 @@ _________________
* ``RESTRICTED_TEACHER_PERMISSIONS = <True or False> (default = False)``
Restricts teachers from editing student accounts. Useful especially at larger
institutions where permissions should be reserved for admins.
* ``USER_LOG_MAX_RECORDS_PER_USER = <max user log records per user> (default = 0 [disabled], -1=unlimited logs)``
In order to keep local data in the ``UserLog`` model, detailing usage, you can choose the number of ``UserLog`` objects that you wish to retain. These objects are not sync'ed.


Online Synchronization
______________________

* ``USER_LOG_MAX_RECORDS = <desired maxium for user log records> (default = 0)``
When this is set to any non-zero number, we will record (and sync for online tracking) user login activity, summarized for every month (which is configurable, see below). Default is set to 0, for efficiency purposes--but if you want to record this, setting to 1 is enough! The # of records kept are not "summary" records, but raw records of every login. These "raw" data are not synced, but are kept on your local machine only--there's too many of them. Currently, we have no specific report to view these data (though we may have for v0.10.1)
* ``USER_LOG_SUMMARY_FREQUENCY = <desired frequency (number, amount of time)>``
``(default = (1, "months")``
This determines the granularity of how we summarize and store user log data. One database row is kept for each student, on each KA Lite installation, for the defined time period. Acceptable values are:
Expand Down

0 comments on commit b5f7bf9

Please sign in to comment.