On this page

Search

Configuring general settings

  1. Click Reports > General settings on the quick-access menu.
  2. Configure the settings to your preferences. 
  3. Click the Save changes button.

*Reports saved to the file system are saved in the name format Export file system root path/username/report.ext where username is an internal username of the user who owns the scheduled report, report' is the name of the scheduled report with non-alphanumeric characters removed, and ext is the appropriate export file name extension.

Settings 

SettingsDescriptionNotes
Format export optionsYou can decide which formats you wish to enable for exporting results from reports. See you in the Export options section.-
Export to file system Exporting to file system allows reports to be saved to a directory on the web server's file system, instead of only emailing the report to the user scheduling the report. This can be useful when the report needs to be accessed by an external system automation, and the report directory might have SFTP access enabled.Reports saved to the file system are saved as Export file system root path/username/report.ext where username is an internal username of a user who owns the scheduled report, report is the name of the scheduled report with non alpha-numeric characters removed, and ext is the appropriate export file name extension.
File export path

Absolute file system path to a writeable directory where reports can be exported and stored.

Setting executable and local paths need to be enabled first in config.php.

Make sure to configure a correct system path if you are going to export reports to file system.

Financial year startThis setting allows to set the start date of the financial year which is used in the reports content controls.-
Global restriction behaviour for users with no active restrictionsSpecifies what users will see when viewing a report with global restrictions enabled when they don't have any restrictions applied to them.-
Enable global restrictions in new user reportsIf checked all newly created user reports will have global report restrictions enabled.-

Global report restrictions number of records per page

Number of records per page allows you define how many records display on a report page.-
Allow reports to show total countWhen enabled Report Builder reports can be configured to show a total count of records, before filters have been applied. Please be aware that getting this count can be an expensive operation, and for performance reasons we recommend you leave this setting off.-
Restrict initial display in all report builder reports

This setting controls how the report is initially displayed and is recommended for larger reports where you will be filtering the results (e.g. sitelogs). It increases the speed of the report by allowing you to apply filters and display only the results instead of initially trying to display all the data.

When enabled, any embedded reports will not generate results until a filter is applied or an empty search is run. If it is disabled or there are no filters, results will display immediately. 

-
Minimum scheduled report frequency

When this is set to Weekly you will see another option Scheduled Reports appear.

-
Schedule reports

Allows you to set the minimum period a report can be run in, this is useful to prevent reports being run too frequently on larger sites and thus causing slowness for your system. If Minimum scheduled report frequency setting is set to:

  • Every X minutes: No changes, all options are available.
  • Every X hours: All options are available except Every X minutes option.
  • Daily: The Daily, Weekly, and Monthly options are available, Every X minutes and Every X hours are not available.
  • Weekly: Both the Weekly and Monthly options are available, Daily, Every X minutes, and Every X hours are not available.
  • Monthly: If this is set then the Monthly option is available, the other options are not available.

All options are available for users with the totara_reportbuilder:overridescheduledfrequency capability.

-
Scheduled report recipients

You can decide which recipient options will be available when scheduling reports:

  • Audience: Choose an audience to send report(s) to
  • System users: Browse or search a list of users
  • External users email: Enter external email address
  • Send to self: Tick the box to send a copy to yourself
-
Default result fetch method

An advanced option that allows you to fine tune how results for the report are fetched from the database when displaying a single page of the table.

By default the recommended approach for your database engine will be used. This is determined by the database engine itself.

In situations where you are experiencing poor performance for a report changing this setting may result in improved performance.

Setting this to use a standard record set will result in report pages executing two distinct queries. The first to get a single page of results, and the second to get the total count of results for the report.

Setting this to use counted recordset will result in a single query being made against the database that will return both a single page of results, and the total count of results.

Graph library

Choose the graphical library you wish to use for graphs:

When exporting to PDF Totara will always use SVGGraph. This may result in some visual differences when exporting a chart created with ChartJS.

Export options 

 If no options are selected, then the export option for reports will not be available. There are a number of export formats available from report builder, these are:

  • CSV export: Comma Separated Values (.csv)
  • CSV export (optimised for Excel): Comma Separated Values (.csv)
  • Excel export: Microsoft Excel spreadsheet (.xls)
  • ODS export: Open Office spreadsheet (.ods)
  • PDF landscape export: Portable Document Format (.pdf)

  • PDF portrait export: Portable Document Format (.pdf)
  • PDF landscape export (wkhtml2pdf): This only work if it has been enabled (see System paths) otherwise it has the prefix Disabled and cannot be used

  • PDF portrait export (wkhtml2pdf): This only work if it has been enabled (see System paths) otherwise it has the prefix Disabled and cannot be used

It is also helpful to note that where an RTL (right-to-left) language is used this will be supported. When RTL is used as part of an export, not only will the text itself be displayed correctly but so will the column orders. 

The only exception is CSV format, as this does not have capabilities to store text direction property. For those, requiring RTL, after importing this CSV in their office suite, they need to enable RTL mode manually. 

Totara Academy

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.

Provide feedback about this page using the link in the bottom right of this page. 

 Still have questions? 

Why not post them in the forums on the Totara Community?



  • No labels