Roster

Reports ::: report_roster
Maintained by Charles Fulton, Andrew Zito
This is a simple report which displays the user pictures for everyone enrolled in the given course.

Roster v3.6.3

Moodle 3.6, 3.7, 3.8, 3.9, 3.10
Released: Wednesday, July 22, 2020, 10:38 PM

Roster

Build Status

This is a simple report which displays the user pictures for everyone enrolled in the given course.

Requirements

  • Moodle 3.6 (build 2018120300 or later)

Installation

Copy the roster folder into your /report directory and visit your Admin Notification page to complete the installation.

Administration

There are several options available to the admin from the Roster Report settings page.

General

Profile fields to display: A newline separated list of profile fields to display. Note that custom profile fields must be entered as profile_field_{shortname}. The following special values are also supported:

  • fullname - displays fullname according to site settings.
  • currenttime - displays date/time in user's configured timezone (you can specify PHP strftime style formatting like so: currenttime %l:%M %p)

Display name: The display string used by the Roster Report on the front end. Will appear in the flat navigation (if enabled) and on the Roster Report page.

Flat Navigation

Display in flat navigation: If enabled, the plugin will attempt to display a link to the Roster Report in the Boost flat navigation menu (left sidebar).

Position in flat navigation: A newline separated list of flat navigation link identifiers. A link to the Roster Report will be added above the link at the top of this list. If not found, the next link down will be tried, and so on. The first word on each line is the link identifier; everything afterward is ignored (so that the identifiers can be labeled). The main course navigation nodes are included by default; the identifiers for additional nodes can be obtained by looking at the data-key property of the relevant <a>.

User Image Size

Any size set to 0 will not display in the drop-down on the report page. If there is only one non-zero size option, the drop-down will not be displayed.

On initial load of the report page, the report will attempt to use the size configured as default. If this size is 0, the report will fall back to the next highest size option. If all three size options are 0, the size will hard default to 100.

Default size: The default size of the user images in the Roster Report.

Size: Small: The size, in pixels, of the user images when the user has selected "Small".

Size: Medium: ...when the user has selected "Medium".

Size: Large: ... when the user has selected "Large".

Usage

Once the plugin is installed, you can access the functionality by going to Reports > Roster within the course, or by going to the URL /report/roster/index.php?id=.

There are several options available when viewing the Roster Report:

Learning mode turns the display of names on and off Group filtering to display only users in the selected group Role filtering to display only users with the selected role Size changes the display size of the user images based on levels configured in the admin settings (see above) Display mode which toggles between the regular web view and a version of the report suitable for printing

Author

Charles Fulton (fultonc@lafayette.edu)

Version information

Version build number
2020072200
Version release name
v3.6.3
Can be updated from
v3.6.0 (2020011000), v3.6.1 (2020011001), v3.6.2 (2020061500)
Can be updated to
v3.11.0 (2021051900)
Maturity
Stable version
MD5 Sum
643fd131e9ed442644cf20d78d0ad268
Supported software
Moodle 3.6, Moodle 3.7, Moodle 3.8, Moodle 3.9, Moodle 3.10
  • Latest release for Moodle 3.6
  • Latest release for Moodle 3.7
  • Latest release for Moodle 3.8
  • Latest release for Moodle 3.9
  • Latest release for Moodle 3.10

Version control information

Version control system (VCS)
GIT
VCS repository URL
VCS branch
main
VCS tag
v3.6.3

Default installation instructions for plugins of the type Reports

  1. Make sure you have all the required versions.
  2. Download and unpack the module.
  3. Place the folder (eg "myreport") in the "report" subdirectory.
  4. Visit http://yoursite.com/admin to finish the installation