Difference between revisions of "Report builder"

Jump to: navigation, search
(Initial draft adapted from transcript of video)
(Flesh out Report Builder page.)
Line 1: Line 1:
 
{{Workplace}}
 
{{Workplace}}
 
= Overview =
 
= Overview =
Moodle Workplace provides a graphical custom reporting tool. Moodle Workplace system reports are built using the report builder interface, optimizing the customization options available to administrators. System reports are used in every listing in workplace: Dashboard, Programs, Certifications, Dynamic rules, and even in the Report builder itself.  
+
Moodle Workplace provides a graphical custom reporting tool. Moodle Workplace custom reports are built using the report builder interface, which provides advanced customization options to administrators. System reports are used in every listing in Workplace: Dashboard, Programs, Certifications, Dynamic rules, and even in the Report builder itself.  
  
 
{{MediaPlayer | url = https://youtu.be/gvQ6WqFYGns | desc = Moodle Workplace | Training | Report Builder}}
 
{{MediaPlayer | url = https://youtu.be/gvQ6WqFYGns | desc = Moodle Workplace | Training | Report Builder}}
  
 
= Accessing the report builder =
 
= Accessing the report builder =
The report builder can be made available to all users, and is accessed from the Workplace launcher.  
+
The report builder can be made available to all users, and is accessed from the Workplace launcher. Users with system capabilities to view and manage reports can view data on all site users. Users with job assignments which have the capability to view reports will see data on users within their own teams only.
  
= Sending report results ==
+
= Creating a custom report =
Custom reports can be created and scheduled to be sent out to specific audiences. Here, the administrator clicks the plus to create a new report: a list of users.  
+
To create a new custom report, the administrator clicks the plus icon on the reports tab. Reports can use any data from their data sources, including data from the Workplace Datastore that contains historical information and snapshots of past events. After selecting a data source for the new report, we can click on a column or drag it into the table to add it to the report. To use aggregation on any column, we just need to click on the "Select an aggregation for the column" icon and then we can select the kind of aggregation depending on the column data type.
 
 
= Data sources =
 
Reports can use any data from their data sources, including data in the internal learning record data store that contains historical information and snapshots of past events. We can click on a column or drag it into the table to add it to the report. To use aggregation on any column, we just need to use the section on each header and then we can select the kind of aggregation depending on the column data type.
 
  
 
= Conditions and Filters =
 
= Conditions and Filters =
Clicking in the Settings icon on the right will expand the right panel that we can use to define conditions and filters and set the default sorting order. Using conditions, we can pre-filter the report for the users. Conditions cannot be changed in the viewing mode. In the filters tab, we can define filters and we can define the default sorting order using the last tab just by selecting and rearranging the available options.  
+
Clicking in the "Show/hide filters sidebar" icon on the right will expand the right panel that we can use to define conditions and filters and set the default sorting order. Using conditions, we can pre-filter the report for the users. Conditions cannot be changed in the viewing mode. In the filters tab, we can define filters and we can define the default sorting order using the last tab just by selecting and rearranging the available options.  
  
 
= Preview report =
 
= Preview report =
Finally the report can be previewed by clicking the eye icon, and it displays as it would for the person receiving the report, including any filters defined. Filters can be reset using the icon on each filter or all at once.
+
Finally the report can be previewed by clicking the "Switch to preview view" icon, and it displays as it would for the person viewing the report, including any conditions defined. Filters can be reset using the icon on each filter or all at once.
 +
 
 +
= Sending report results =
 +
Custom reports can be created and scheduled to be sent out to specific audiences. From the manage custom reports page, navigate to the schedules tab. Here, the administrator clicks the plus to create a new schedule and selects which report they would like to be sent. Various report formats are available to use for attached report data (CSV, Excel Spreadsheet, HTML, JSON, ODS, PDF), as well as recurrence options (send every weekday, month, etc). The administrator can also select which user should be used when sending the scheduled report. This allows the report to be sent to the audience as if it were being viewed by that user.
 +
 
 +
The audience options allow the administrator to to select which users should receive the report. In addition to selecting which position and department within an organisation should be included, it is also possible to manually select individual users and/or e-mail addresses.
 +
 
 +
Finally, the message subject and content can be configured.

Revision as of 13:12, 2 September 2019

workplacelogo.png This feature is part of Moodle Workplace, which is available through Moodle Partners.

Overview

Moodle Workplace provides a graphical custom reporting tool. Moodle Workplace custom reports are built using the report builder interface, which provides advanced customization options to administrators. System reports are used in every listing in Workplace: Dashboard, Programs, Certifications, Dynamic rules, and even in the Report builder itself.

Moodle Workplace

Accessing the report builder

The report builder can be made available to all users, and is accessed from the Workplace launcher. Users with system capabilities to view and manage reports can view data on all site users. Users with job assignments which have the capability to view reports will see data on users within their own teams only.

Creating a custom report

To create a new custom report, the administrator clicks the plus icon on the reports tab. Reports can use any data from their data sources, including data from the Workplace Datastore that contains historical information and snapshots of past events. After selecting a data source for the new report, we can click on a column or drag it into the table to add it to the report. To use aggregation on any column, we just need to click on the "Select an aggregation for the column" icon and then we can select the kind of aggregation depending on the column data type.

Conditions and Filters

Clicking in the "Show/hide filters sidebar" icon on the right will expand the right panel that we can use to define conditions and filters and set the default sorting order. Using conditions, we can pre-filter the report for the users. Conditions cannot be changed in the viewing mode. In the filters tab, we can define filters and we can define the default sorting order using the last tab just by selecting and rearranging the available options.

Preview report

Finally the report can be previewed by clicking the "Switch to preview view" icon, and it displays as it would for the person viewing the report, including any conditions defined. Filters can be reset using the icon on each filter or all at once.

Sending report results

Custom reports can be created and scheduled to be sent out to specific audiences. From the manage custom reports page, navigate to the schedules tab. Here, the administrator clicks the plus to create a new schedule and selects which report they would like to be sent. Various report formats are available to use for attached report data (CSV, Excel Spreadsheet, HTML, JSON, ODS, PDF), as well as recurrence options (send every weekday, month, etc). The administrator can also select which user should be used when sending the scheduled report. This allows the report to be sent to the audience as if it were being viewed by that user.

The audience options allow the administrator to to select which users should receive the report. In addition to selecting which position and department within an organisation should be included, it is also possible to manually select individual users and/or e-mail addresses.

Finally, the message subject and content can be configured.