Commit eb387189 authored by Kristina Hoeppner's avatar Kristina Hoeppner
Browse files

admin/reports: Add portfolio completion reports

parent dc9574a2
......@@ -36,10 +36,10 @@ The structure of all reports is similar, and they can all be configured to show
#. 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.
#. Click the *Download* button |download report| 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.
Click any column heading that is a link, and you can sort the table according to that column in ascending or descending order.
.. _report_configuration:
......@@ -82,6 +82,10 @@ All reports can be configured via the *Configure* button on the *Reports* page.
#. **Columns**: Click the *Uncollapse* icon |retracted| to show the columns that you can select or deselect to tailor the report for this session. The *Collapse* icon |retractable| is displayed when the panel is open.
#. Tick the checkbox next to an item that you want to display as additional column in your report.
#. You can't deselect certain columns as they display the minimum information for the selected report.
.. note::
Selecting or deselecting columns only influences the on-screen display. The CSV file always contains all columns and all results from the report.
#. Click the *Submit* button to display results for your report, or click *Cancel* to abort any changes to your report.
#. 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.
......@@ -123,7 +127,7 @@ The content report displays information about modifications to artefacts and blo
#. 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.
#. Click the *Download* button |download report| to download the report as CSV file.
.. index::
pair: Reports; Objectionable content report
......@@ -165,7 +169,7 @@ The objectionable content report shows all portfolios that currently have object
#. **Date**: The date that the reviewer looked at the portfolio.
#. **Status**: Next action item.
#. Total number of results.
#. Click the *Download* icon |download icon| to download the report as CSV file.
#. Click the *Download* button |download report| to download the report as CSV file.
.. _groups_reports:
......@@ -224,7 +228,7 @@ The group report provides information about the groups that are on the site. For
#. 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.
#. Click the *Download* button |download report| 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.
......@@ -264,7 +268,7 @@ The submissions report provides information about submissions made to groups. Fo
#. **Release date**: Date and time when the portfolio was released.
#. **Released by**: Name of the person who released the portfolio.
#. **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.
#. Click the *Download* button |download report| to download the report as CSV file.
.. index::
pair: Reports; Institution reports
......@@ -318,7 +322,7 @@ The institution comparison report provides an overview of all institutions on th
#. 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.
#. Click the *Download* button |download report| to download the report as CSV file.
.. note::
This report is currently only updated once a week at the end of the week.
......@@ -355,7 +359,7 @@ The logins report provides details for:
#. 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.
#. Click the *Download* button |download report| to download the report as CSV file.
.. index::
pair: Institution reports; Institution overview report
......@@ -422,10 +426,13 @@ There are numerous reports in this section:
* Account activity
* Account details
* Collaboration
* Completion and review
* Masquerading sessions
* Page activity
* People overview
* Portfolio access
* Portfolios with reviewers
* Reviewer summary
.. index::
pair: People reports; Account activity report
......@@ -492,7 +499,7 @@ The report shows the information for the selected accounts.
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.
#. Click the *Download* button |download report| to download the report as CSV file.
.. index::
pair: People reports; Account details report
......@@ -548,7 +555,7 @@ The report shows the information for the selected accounts.
#. **Last login**: Date and time when the account holder was in their account last.
#. **Probation**: The number of :ref:`probation point <config_variable_probationenabled>` the account holder has.
#. Total number of results.
#. Click the *Download* icon |download icon| to download the report as CSV file.
#. Click the *Download* button |download report| 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.
......@@ -599,7 +606,65 @@ The collaboration report shows the level of engagement and collaboration that is
#. 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.
#. Click the *Download* button |download report| to download the report as CSV file.
.. index::
pair: People reports; Completion and review report
.. _completion _report:
Completion and review report
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
The completion and review report provides overview information about portfolios using the portfolio completion functionality, sign-off and review blocks to track progress across portfolios:
* Personal information of the portfolio author
* Email address of portfolio author
* Portfolio title
* Portfolio creation date
* Template title with link to it
* Personal information of the reviewer
* Email address of the reviewer
* Date on which the reviewer received access to the portfolio
* Date on which the reviewer confirmed the primary statement on the portfolio
* Date on which the reviewer removed their access to the portfolio
* Date when the reviewer's access to the portfolio was removed by the system
* The percentage of completions per portfolio per individual
Additionally, you can decide whether you want to see results only for a particular template if you have some set up on the institution or site level and only see results where there is a reviewer assigned to a portfolio at the moment.
.. note::
This report shows all the instances that a reviewer was added or updated for a portfolio as that can't be distinguished. That means, if a portfolio author goes to the 'Manage access' page for their portfolio, doesn't perform any changes, but saves the page, a new record is inserted into the database and displayed here.
.. figure:: /images/administration/reports_completion_report.*
:alt: Completion and review report
Completion and review 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 report* button to change the report settings.
#. **First name**: First name of the portfolio author.
#. **Last name**: Last name of the portfolio author.
#. **Username**: Username of the portfolio author.
#. **Email**: Email address of the portfolio author.
#. **Portfolio**: Title of the portfolio that has the portfolio completion.
#. **Portfolio created**: The day when the portfolio was created.
.. note::
This is the date that is used to determine which portfolios to show in a particular time frame.
#. **Template**: Title of the template from which the portfolio was created, if any.
#. **Reviewer display name**: Display name of the person who is assigned the 'Reviewer' role for the portfolio. This role is set in the access permissions of the portfolio.
#. **Access revoked by author**: Date when access to the portfolio for the listed reviewer was revoked.
#. **Reviewer confirmed primary statement**: If the portfolio contains a 'Review' block with a primary statement, the date is shown here when it was ticked.
#. **Completion percentage**: Percentage for the 'Sign-off' and 'Verification' compared to the overall possible numbers.
#. **Results per page**: Change how many results you want to display per page.
#. Click the *Download* button |download report| to download the report as CSV file.
.. note::
It is possible to display more columns with additional information.
.. index::
pair: People reports; Legal consent report
......@@ -650,7 +715,7 @@ The report shows:
#. **Institution terms and conditions**: Version number and link to the institution terms and conditions that the account holder has agreed to.
#. **Institution**: Name of the institution in which the account holder is a member.
#. Total number of results.
#. Click the *Download* icon |download icon| to download the report as CSV file.
#. Click the *Download* button |download report| to download the report as CSV file.
.. note::
You can also display the dates when the site terms and conditions and the institution legal statements were consented to.
......@@ -721,7 +786,7 @@ The report shows the information for the selected accounts.
#. 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.
#. Click the *Download* button |download report| to download the report as CSV file.
.. index::
pair: People reports; Page activity report
......@@ -769,7 +834,7 @@ The page activity report gathers data about a page itself and its content:
#. 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.
#. Click the *Download* button |download report| to download the report as CSV file.
.. index::
pair: People reports; People overview report
......@@ -779,7 +844,7 @@ The page activity report gathers data about a page itself and its content:
People overview report
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
The people overview report gives an overview of activty of people on the site for a given day:
The people overview report gives an overview of activity of people on the site for a given day:
* Date
* Number of people who logged in
......@@ -802,7 +867,7 @@ The people overview report gives an overview of activty of people on the site fo
#. 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.
#. Click the *Download* button |download report| to download the report as CSV file.
.. index::
pair: People reports; Portfolio access report
......@@ -855,7 +920,78 @@ The report shows the information for the selected accounts.
#. 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.
#. Click the *Download* button |download report| 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; Portfolios with reviewers report
.. _reviewers_report:
Portfolios with reviewers report
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
The portfolios with reviewers report gives a weekly snapshot overview of the number of portfolios who have the 'Reviewer' role assigned to them:
* Date of the week commencing for time period
* Total number of portfolios with reviewers
* Total number of portfolios without reviewers
This report requires that the portfolio completion functionality is used and that at least one :ref:`'Portfolio review' block <portfolio_review_block>` is on that page. You can filter your results also according to a particular template if you have one or more on the site.
.. figure:: /images/administration/reports_reviewers_report.*
:alt: Portfolios with reviewers report
Portfolios with reviewers report
#. Title of the report.
#. Institution that was selected for the report.
.. note::
This report is only available on the institution level and is generated on a weekly basis, reporting over Monday through Sunday of the previous week.
#. Click the *Configure report* button to change the report settings.
#. **Date**: Each row represents a week (w.c. - week commencing).
#. **With reviewer**: Number of portfolios that have a reviewer.
#. **Without reviewer**: Number of portfolios that don't have a reviewer.
#. **Results per page**: Change how many results you want to display per page.
#. Click the *Download* button |download report| to download the report as CSV file.
.. index::
pair: People reports; Reviewer summary report
.. _reviewer_summary_report:
Reviewer summary report
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
The reviewer summary report gives a weekly overview of how many portfolios each reviewer has assigned:
* Date for time period per week
* Columns representing the number of reviewers per portfolio, i.e. a value of "3" in the "One" column represents three reviewers with access to one portfolio each.
.. figure:: /images/administration/reports_reviewer_summary_report.*
:alt: Reviewer summary report
Reviewer summary report
#. Title of the report.
#. Institution that was selected for the report.
.. note::
This report is only available on the institution level and is generated on a weekly basis, reporting over Monday through Sunday of the previous week.
#. Time frame over which is being reported.
#. Click the *Configure report* button to change the report settings.
#. **Date**: Each row represents a week (w.c. - week commencing).
#. **One**: Number of reviewers who are assigned one portfolio.
#. **Two**: Number of reviewers who are assigned two portfolios.
#. **Three**: Number of reviewers who are assigned three portfolios.
.. note::
More columns can be displayed for higher number of assigned portfolios.
#. **Results per page**: Change how many results you want to display per page.
#. Click the *Download* button |download report| to download the report as CSV file.
......@@ -187,6 +187,11 @@
<button class="btn btn-default btn-sm">
<i class="fas fa-download fa-lg"></i></button>
.. |download report| raw:: html
<button class="btn btn-default btn-sm">
<i class="fas fa-download fa-lg"></i> Download</button>
.. |delete| raw:: html
<button class="btn btn-default btn-sm">
......
Supports Markdown
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