- 03 Feb 2022
- 5 Minutes to read
What are reports?
- Updated on 03 Feb 2022
- 5 Minutes to read
Within Totara there are site reports, which can only be accessed by Site Administrators and are not customisable, and then there are reports created and managed using the report builder. Most reports fall under the latter, so we will focus on reports using the report builder.
You can also find more about reporting on our website.
Whether you use your Totara site to deliver learning and training, as a space for users to collaborate and discuss, or for managing your teams' performance with check-ups and appraisals, reports can provide insight into how your users use Totara's functionality.
Totara's report builder allows Site Administrators to create custom site-wide reports that are then distributed to users so that they can review and manage how their teams use the site.
Benefits of using Totara report builder
The report builder sources data from many features in Totara to provide reporting on such areas as course completion 9Totara Learn) and workspace engagement (Totara Engage), and can also be used to validate data imported using HR import.
Completion and competencies
Depending on the Totara products you have, users can complete various activities, courses, programs, certifications, and competencies. Reports built to display completion and competency information can inform staff managers of the work that a user has yet to complete and can also be used to find users who are competent in particular areas. This information can be used to source talent within your company for internal promotion and for filling temporary knowledge gaps within your organisation.
HR import allows Site Administrators to import data from HR systems (or other systems) to automatically populate user accounts, organisation and position hierarchies. Custom-built reports can be used to allow an HR representative or staff managers to review the data that has been imported to verify it for accuracy, without requiring that they have access to edit or view user accounts directly.
How report builder works
Creating custom reports
Totara contains user roles that are granted permissions to perform parts of the process of creating and viewing custom-built reports. A report can be built by a Site Administrator and made available to other users based on the role that they have been assigned on the system.
Building a report allows Site Administrators to select:
- The columns of data that will be available
- The filters a user can use to search with
- Content controls that restrict the records that are available when a report is viewed
- The user role(s) that will be given permission to access the report
- Performance settings such as restricting reports to run with search criteria entered and caching versions of the report
Report builder caching will not function if you have multitenancy enabled on your site.
If you have selected a report source, you will need to configure the report so that you can adjust it to suit your needs. It is therefore recommended that when using a report source (rather than a report template) you select Create and edit.
When creating new reports, you can use report templates to quickly build useful reports. These provide a starting point which you can edit to fit your exact requirements. Note that when creating and editing a report from a template you will not be editing the template itself.
These report templates can start giving you useful information right away. For example, the Admin site activity overview report template shows the number of log entries for the site over time, without any need to configure additional settings.
Different templates are aimed at different roles. The following templates are currently available for these roles:
- Admin site activity overview
- Learner certification completion status overview
- Learner course completion status overview
- Learner goal status overview
- Learner program completion status overview
- Manager certification completion status overview
- Manager course completion status overview
- Manager goal status overview
- Manager program completion status overview
As with reports created from a report source, each report created from a template can be fully customised by selecting Edit this report. You can add or remove columns, change the order of columns, display a graph, add filters, and more.
When using a report, users can determine which columns are shown by selecting Show/Hide Columns. In this pop-up window report users can decide which columns to show (ticked) and which columns will be hidden (unticked) in the report. Select Ok to confirm your selections.
Running custom reports
Users granted access to reports will see the My reports menu option in the navigation menu. Users can run a report, add search criteria to filter for particular records, and export data into files. Reports that need to be run regularly can be scheduled so that they are automatically run and sent as file attachments to users.
Based on the content controls that have been setup, the report may be pre-filtered to only display records for staff at or below a user's position, within or under a user's organisation, or other details depending on the report source that was chosen.
Developing custom report sources
A report source defines the primary type of data that will be used in a report. Each report can have one report source. The set of default report sources includes data like user profile information, time and date details. Additional report sources can be created by your Totara partner. This process is described in detail in the developer documentation.
Within Totara there are two types of reports:
- Embedded reports: System-generated reports
- User reports: Created by Site Administrators and made available to other users
Every installation of Totara comes with a set of embedded reports (a list of which can be found on the report sources page). These can be edited and managed by a Site Administrator and anyone who has been given the totara/reportbuilder:manageembeddedreport capability.
Embedded reports are used throughout the system, for example the Browse list of users page is actually an embedded report, and can therefore be customised to suit your organisation. It is possible to duplicate an embedded report and then edit the copy to better suit your requirements without changing the default report. If you do decide to edit an embedded report then this will cause changes for everyone across the site accessing that report.
If you want to repurpose any embedded reports it is strongly recommended that you do not edit the embedded reports themselves, as these are typically used in multiple places across the system and editing these reports can have unintended consequences. Instead, you should duplicate the embedded report if you want to use it for another purpose.
User reports are the reports that Site Administrators and Site Managers create and make available to other users. Once a report has been created, it can be viewed in two places. Firstly, you can view created reports in the Reports tab (in the top navigation bar). From the reports page you can click on a report to select it, then select Edit this report. In the report manager page (Quick-access menu > Reports) you can view a report by clicking on its title or view link. You can update a report by clicking the cog icon () under the Actions column or remove it using the cross icon ().
Get involved in the conversation about Reporting on the Totara Community.
The Totara Academy has a whole course dedicated to using Reports in Totara. Here you can learn more on how to use reports, see best practice, and give it a go yourself.
© Copyright 2022 Totara Learning Solutions. All rights reserved.