Commit 44dd0e1e authored by Kristina Hoeppner's avatar Kristina Hoeppner
Browse files

admin/reports: Add additional reports and screenshots

parent 1ff96a41
......@@ -36,6 +36,9 @@ The structure of all reports is similar, and they can all be configured to show
#. **Results per page**: Change how many results you want to display per page.
#. Click the *Download* icon |download icon| to download the report as CSV file.
.. note::
Click any column heading and you can sort the table according to that column in ascending or descending order.
.. _report_configuration:
Report configuration
......@@ -74,12 +77,12 @@ All reports can be configured via the *Configure* button on the *Reports* page.
#. You can also click the *Close* icon |close| in the top left-hand corner of the modal window to cancel your action without saving any changes.
.. index::
pair: Reports; Content reports
pair: Reports; Content report
.. _content_reports:
.. _content_report:
Content reports
~~~~~~~~~~~~~~~~~~~~~~
Content report
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
The content report displays information about modifications to artefacts and blocks. The available columns are:
......@@ -89,12 +92,36 @@ The content report displays information about modifications to artefacts and blo
* Number of unique users who made the modifications
* Number of unique users over the total
.. note::
This report combines the pre-17.10 content and historical data statistics because the time frame can be chosen now via the time selectors in the report configuration.
.. figure:: /images/administration/reports_content_report.*
:alt: Content overview report
Content overview report
#. Title of the report.
#. Institution that was selected for the report. If it says "All institutions", then the report is over the entire site.
#. Time frame over which is being reported.
#. Click the *Configure* button to change the report settings.
#. **Name**: Name of the artefact or blocktype.
.. note::
When you report over "All institutions", you do not see blocktypes displayed. Currently, these are only available when you report over an institution.
#. **Modified**: Number of creations or modifications of this content item during the selected time frame.
#. **Total**: Number of total items of this content item during the selected time frame.
#. Paginator to jump to additional results.
#. Total number of results.
#. **Results per page**: Change how many results you want to display per page.
#. Click the *Download* icon |download icon| to download the report as CSV file.
.. index::
pair: Reports; Group reports
pair: Reports; Groups report
.. _group_reports:
.. _groups_reports:
Group reports
Groups report
~~~~~~~~~~~~~~~~~~~~~~
.. note::
......@@ -111,6 +138,32 @@ The group report provides information about the groups that are on the site. For
* Number of forums
* Number of forum posts
.. note::
This report requires :ref:`event logging <logging_settings>` to be turned on for the entire site. Since events cannot be put into the database in retrospect, correct data is only collected from the time the full event logging has been turned on.
.. figure:: /images/administration/reports_group_report.*
:alt: Groups overview report
Groups overview report
#. Title of the report.
#. Institution that was selected for the report. If it says "All institutions", then the report is over the entire site.
#. Time frame over which is being reported.
#. Click the *Configure* button to change the report settings.
#. **Group**: Title of the group.
#. **Members**: Number of members in the group.
#. **Pages**: Number of pages in the group.
#. **Group page comments**: Number of comments on group pages.
#. **Shared pages**: Number of pages that have been shared with the group.
#. **Shared page comments**: Number of comments on pages shared with the group.
#. **Forums**: Number of forums in the group.
#. **Posts**: Number of forum posts in the group.
#. Total number of results.
#. Click the *Download* icon |download icon| to download the report as CSV file.
.. note::
"N/A" (not available) in any of the columns indicates that there is no data available yet. This is an indicator that the information was not yet recorded via the event logging.
.. index::
pair: Reports; Institution reports
......@@ -119,6 +172,92 @@ The group report provides information about the groups that are on the site. For
Institution reports
~~~~~~~~~~~~~~~~~~~~~~
There are three institution reports available:
* Institution comparison
* Logins
* Overview
.. index::
pair: Institution reports; Institution comparison report
.. _institution_comparison_report:
Institution comparison report
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
The institution comparison report provides an overview of all institutions on the site:
* Institution
* Number of members
* Number of pages
* Number of blocks
* Number of artefacts
* Number of forum posts by institution members
.. note::
This report is only available on the site level when "All institutions" is chosen in the institution selector during the report configuration.
.. figure:: /images/administration/reports_institution_comparison_report.*
:alt: Institution comparison report
Institution comparison report
#. Title of the report.
#. Institution that was selected for the report. If it says "All institutions", then the report is over the entire site.
#. Time frame over which is being reported.
#. Click the *Configure* button to change the report settings.
#. **Institution**: Title of the institution.
#. **Members**: Number of members in the institution.
#. **Pages**: Number of pages in the institution that were created by institution members.
#. **Blocks**: Number of blocks used in pages in the institution.
#. **Artefacts**: Number of artefacts in the institution.
#. **Posts**: Number of comments on pages shared with the group.
#. **Forums**: Number of forums in the group.
#. **Posts**: Number of forum posts by institution members.
#. Total number of results.
#. Click the *Download* icon |download icon| to download the report as CSV file.
.. index::
pair: Institution reports; Logins report
.. _logins_report:
Logins report
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
The logins report provides details for:
* Institution
* Number of logins no matter the user
* Number of active users
.. note::
This report is only available on the site level when "All institutions" is chosen in the institution selector during the report configuration.
.. figure:: /images/administration/reports_login_report.*
:alt: Logins report
Logins report
#. Title of the report.
#. Institution that was selected for the report. If it says "All institutions", then the report is over the entire site.
#. Time frame over which is being reported.
#. Click the *Configure* button to change the report settings.
#. **Institution**: Title of the institution.
#. **Logins**: Total number of logins to the site, no matter which institution member it was.
#. **Active users**: Total number of distinct institution members who logged into the site during the given time frame.
#. Total number of results.
#. Click the *Download* icon |download icon| to download the report as CSV file.
.. index::
pair: Institution reports; Institution overview report
.. _institution_overview_report:
Overview report
^^^^^^^^^^^^^^^^^^^^^^^^
The institution report contains statistical information about each institution:
* Creation date
......@@ -132,6 +271,37 @@ The institution report contains statistical information about each institution:
* Mahara version
* Information on the running of cron
.. figure:: /images/administration/reports_institution_overview_report.*
:alt: Institution overview report
Institution overview report
#. Title of the report.
#. Institution that was selected for the report. If it says "All institutions", then the report is over the entire site.
#. Click the *Configure* button to change the report settings.
#. **Overview**: Some information about the site or institution:
* **Site installed / Institution created**: Installation date of your site. If you view this report for an institution, the institution creation date is shown, i.e. the first time a member was added to the institution.
* **Users**: Number of
* registered users, i.e. everybody who has an account
* active users, i.e. users that have at least logged in once and have done something
* **Groups**: Number of groups and average group membership of a user. This is only available for "All institutions".
* **Pages**: Number of pages and average pages per user with pages.
* **Database size**: Size of your database on the server. This is only available for "All institutions".
* **Disk usage**: The amount of disk space your Mahara installation or institution uses.
* **Mahara version**: Version number of Mahara and the latest stable release. This is only available for "All institutions".
* **Cron**: Information on whether cron is running or not. If it says "Cron is not running", please check it. It may be running partially. This is only available for "All institutions".
#. Additional information and graphs are available for:
* Average user in terms of friends, pages, group membership, and use of space.
* Users by institution. This is only available for "All institutions".
* Pages overview: Most frequently used blocks and types of pages.
* Groups overview: Number of groups by group type and access type. This is only available for "All institutions".
* Growth trend: Graphical representation of all users and pages over time.
.. index::
pair: Reports; People reports
......@@ -149,3 +319,345 @@ There are numerous reports in this section:
* Portfolio access
* User activity
* User details
.. index::
single: New in Mahara 17.10; Collaboration report
pair: People reports; Collaboration report
.. _collaboration_report:
|new in Mahara 17.10| Collaboration report
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
The collaboration report shows the level of engagement and collaboration that is happening on Mahara in regard to personal portfolio pages and collections:
* Number of comments
* Number of annotation feedback
* Number of portfolios (pages or collections) shared with individual users
* Number of portfolios shared with groups
* Number of portfolios shared with an institution
* Number of portfolios shared with all registered users
* Number of portfolios shared publicly
* Number of portfolios shared via secret URLs
* Number of portfolios shared with friends
.. note::
This report requires :ref:`event logging <logging_settings>` to be turned on for the entire site. Since events cannot be put into the database in retrospect, correct data is only collected from the time the full event logging has been turned on.
.. figure:: /images/administration/reports_collaboration_report.*
:alt: Collaboration report
Collaboration report
#. Title of the report.
#. Institution that was selected for the report. If it says "All institutions", then the report is over the entire site.
#. Time frame over which is being reported.
#. Click the *Configure* button to change the report settings.
#. **Date**: Each row represents a week (w.c. - week commencing).
#. **Comments**: Number of comments made on pages.
#. **Users**: Number of portfolios (pages and collections) shared with individual users.
#. **Groups**: Number of portfolios (pages and collections) shared with groups.
#. **Institutions**: Number of portfolios (pages and collections) shared with an institution.
#. **Registered**: Number of portfolios (pages and collections) shared with registered users.
#. **Public**: Number of portfolios (pages and collections) shared with the public.
#. **Secret URLs**: Number of portfolios (pages and collections) shared via secret URLs.
#. **Friends**: Number of portfolios (pages and collections) shared with friends.
#. Paginator to jump to additional results.
#. Total number of results.
#. **Results per page**: Change how many results you want to display per page.
#. Click the *Download* icon |download icon| to download the report as CSV file.
.. index::
pair: People reports; Masquerading sessions report
.. _masquerading_report:
Masquerading sessions report
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
When the site administrator :ref:`turned on the logging of masquerading sessions <logging_settings>`, they are reported in this report. If full event logging is turned on, masquerading sessions are recorded as well.
The report shows:
* Name and username
* Reason for the masquerading session
* Administrator who masqueraded
* Start time of the masquerading session
You can display masquerading sessions for all people on the site or your chosen institution. Alternatively, you can select people on *Administration → User search* and report only over them:
#. On the :ref:`User search <user_search>` page, select the people for whom you wish to see the masquerading sesions report and click the *Get reports for selected users* button. You are taken into the *Reports* section.
#. Click the *Configure report* button.
#. **Report type**: Select "Masquerading sessions".
#. **From**: Choose your start date.
#. **To**: Choose your end date or leave it at today's date.
#. **Columns**: Select the columns that you wish to display in the report.
#. Click the *Submit* button.
The report shows the information for the selected users.
.. figure:: /images/administration/reports_masquerading_report.*
:alt: Masquerading sessions report
Masquerading sessions report
#. Title of the report.
#. Institution that was selected for the report. If it says "All institutions", then the report is over the entire site.
#. Time frame over which is being reported.
#. Number of selected users for the report if it is not over an entire institution. Click the *Remove filter* button to report over all people in the chosen institution.
#. Click the *Configure* button to change the report settings.
#. **User**: Person who has been masqueraded as.
#. **Reason**: Reason for the masquerading. This is only displayed if the administrator was :ref:`required to provide one <masquerading_reason_setting>`.
#. **Masquerading administrator**: The administrator who initiated the masquerading session.
#. **Start of masquerading**: Date and time when the administrator started to masquerade as the user.
#. Paginator to jump to additional results.
#. Total number of results.
#. **Results per page**: Change how many results you want to display per page.
#. Click the *Download* icon |download icon| to download the report as CSV file.
.. index::
single: New in Mahara 17.10; Page activity report
pair: People reports; Page activity report
.. _page_activity_report:
|new in Mahara 17.10| Page activity report
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
The page activity report gathers data about a page itself and its content:
* Page title
* Title of the collection to which the page belongs (if any)
* Page owner
* Creation date
* Last modification date
* Date, when the page was last viewed
* Number of blocks included in the page
* Number of visits to the page
* Number of comments on the page
.. figure:: /images/administration/reports_page_activity_report.*
:alt: Page activity report
Page activity report
#. Title of the report.
#. Institution that was selected for the report. If it says "All institutions", then the report is over the entire site.
#. Time frame over which is being reported.
#. Click the *Configure* button to change the report settings.
#. **Page**: Title of the page.
#. **Collection**: Title of the collection if the page is part of one.
#. **Owner**: Name of the person who authored the page.
#. **Created**: Date and time of the creation of the page.
#. **Last modified**: Date and time when the page was last edited.
#. **Last visited**: Date and time when the page was last viewed.
#. **Blocks**: Number of blocks included in the page.
#. **Visits**: Number of visits to the page.
#. **Comments**: Number of comments on the page.
#. Paginator to jump to additional results.
#. Total number of results.
#. **Results per page**: Change how many results you want to display per page.
#. Click the *Download* icon |download icon| to download the report as CSV file.
.. index::
pair: People reports; People overview report
.. _people_overview_report:
People overview report
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
The people overview report gives an overview of activty of people on the site for a given day:
* Date
* Number of people who logged in
* Number of accounts created
* Total number of people in the selected institution
.. figure:: /images/administration/reports_people_overview_report.*
:alt: People overview report
People overview report
#. Title of the report.
#. Institution that was selected for the report. If it says "All institutions", then the report is over the entire site.
#. Time frame over which is being reported.
#. Click the *Configure* button to change the report settings.
#. **Date**: Date of the login.
#. **Logged in**: Number of people who logged in on that day.
#. **Created**: Number of user accounts created on that day.
#. **Total**: Total number of people in the selected institution on that day.
#. Total number of results.
#. Click the *Download* icon |download icon| to download the report as CSV file.
.. index::
pair: People reports; Portfolio access report
.. _portfolio_access_report:
Portfolio access report
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
You can view all the portfolios that have been created by people on the site or in a particular institution and with whom they have been shared. This facilitates troubleshooting when people cannot view pages of others and the administrator would otherwise have to log in to the user account to check page permissions.
The report displays:
* Portfolio owner
* Title of the portfolio
* Number of pages in the portfolio
* Access list, i.e. who has permission to view the portfolio
You can display the portfolio access for all people on the site or your chosen institution. Alternatively, you can select people on *Administration → User search* and report only over them:
#. On the :ref:`User search <user_search>` page, select the people for whom you wish to see the portfolio access report and click the *Get reports for selected users* button. You are taken into the *Reports* section.
#. Click the *Configure report* button.
#. **Report type**: Select "Portfolio access".
#. **From**: Choose your start date.
#. **To**: Choose your end date or leave it at today's date.
#. Click the *Submit* button.
The report shows the information for the selected users.
.. figure:: /images/administration/reports_portfolio_access_report.*
:alt: Portfolio access report
Portfolio access report
#. Title of the report.
#. Institution that was selected for the report. If it says "All institutions", then the report is over the entire site.
#. Time frame over which is being reported.
#. Number of selected users for the report if it is not over an entire institution. Click the *Remove filter* button to report over all people in the chosen institution.
#. Click the *Configure* button to change the report settings.
#. **Owner**: Person who is the owner of the portfolio.
#. **Page / collection**: Title of the portfolio.
#. **Pages**: Number of pages within a collection.
#. **Access list**: Listed are who has access to the portfolio.
#. If a portfolio has been shared with only a certain role within a group, that is stated.
#. Number of secret URLs created for the portfolio.
#. Paginator to jump to additional results.
#. Total number of results.
#. **Results per page**: Change how many results you want to display per page.
#. Click the *Download* icon |download icon| to download the report as CSV file.
.. note::
Though all pages, collections and groups are linked, you may not have direct access to them if you are not on the access list or a member of the group yourself.
.. index::
pair: People reports; User activity report
single: New in Mahara 17.10; User activity report
.. _user_activity_report:
|new in Mahara 17.10| User activity report
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
This report displays information about a user and their level of activity on the site during the selected time frame:
* User information
* Number of artefacts
* Number of pages
* Number of collections
* Number of groups
* Number of logins
* Number of actions (create and modify an artefact, forum post, personal pages and collection, group pages and collections, comments, page views)
* Last login
* Last activity
.. note::
This report requires :ref:`event logging <logging_settings>` to be turned on for the entire site. Since events cannot be put into the database in retrospect, correct data is only collected from the time the full event logging has been turned on.
You can display the user activity for all people on the site or your chosen institution. Alternatively, you can select people on *Administration → User search* and report only over them:
#. On the :ref:`User search <user_search>` page, select the people for whom you wish to see the user activity report and click the *Get reports for selected users* button. You are taken into the *Reports* section.
#. Click the *Configure report* button.
#. **Report type**: Select "User activity".
#. **From**: Choose your start date.
#. **To**: Choose your end date or leave it at today's date.
#. Click the *Submit* button.
The report shows the information for the selected users.
.. figure:: /images/administration/reports_user_activity_report.*
:alt: User activity report
User activity report
#. Title of the report.
#. Institution that was selected for the report. If it says "All institutions", then the report is over the entire site.
#. Time frame over which is being reported.
#. Number of selected users for the report if it is not over an entire institution. Click the *Remove filter* button to report over all people in the chosen institution.
#. Click the *Configure* button to change the report settings.
#. **First name**: First name of the user.
#. **Last name**: Last name of the user.
#. **Display name**: If the user chose to set a display name, it is displayed here.
#. **Username**: Username of the user.
#. **Artefacts**: Number of artefacts in the user's account.
#. **Pages**: Number of pages that the user created.
#. **Collections**: Number of collections the user has in their account.
#. **Groups**: Number of groups in which the user is a member.
#. **Logins**: Number of total logins on the site.
#. **Actions**: Number of actions the user has taken on the site, i.e. created and modified an artefact, wrote a forum post, created and modified personal pages and collection, created and modified group pages and collections, wrote comments, viwed pages.
#. **Last login**: Date and time when the user was in their account last.
#. **Last activity**: Last activity in the user's account.
.. note::
Masquerading sessions are listed as activity. They do not count as a last login though.
#. Total number of results.
#. Click the *Download* icon |download icon| to download the report as CSV file.
.. index::
pair: People reports; User details report
.. _user_details_report:
User details report
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
The user details report provides basic account information about a person and is well suited for exports if you want to update accounts via a CSV file:
* Username
* Email address
* First name
* Last name
* ID number
* Display name
* Remote username
* Last login
* Number of probation points
You can display the user details for all people on the site or your chosen institution. Alternatively, you can select people on *Administration → User search* and report only over them:
#. On the :ref:`User search <user_search>` page, select the people for whom you wish to see account details and click the *Get reports for selected users* button. You are taken into the *Reports* section.
#. Click the *Configure report* button.
#. **Report type**: Select "User details".
#. **From**: Choose your start date.
#. **To**: Choose your end date or leave it at today's date.
#. **Columns**: Select additional columns to display more information if you wish.
#. Click the *Submit* button.
The report shows the information for the selected users.
.. figure:: /images/administration/reports_user_details_report.*
:alt: User details report
User details report
#. Title of the report.
#. Institution that was selected for the report. If it says "All institutions", then the report is over the entire site.
#. Time frame over which is being reported.
#. Number of selected users for the report if it is not over an entire institution. Click the *Remove filter* button to report over all people in the chosen institution.
#. Click the *Configure* button to change the report settings.
#. **First name**: First name of the user.
#. **Last name**: Last name of the user.
#. **Email**: Email address of the user.
#. **ID number**: ID number of the user if one was given.
#. **Display name**: If the user chose to set a display name, it is displayed here.
#. **Username**: Username of the user.
#. **Remote username**: If the user has an authentication method that requires a remote username, it is listed here.
#. **Last login**: Date and time when the user was in their account last.
#. Total number of results.
#. Click the *Download* icon |download icon| to download the report as CSV file.
.. note::
If the site has :ref:`spam probation points enabled <config_variable_probationenabled>`, these can be displayed in the table as well.
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment