Skip to main content

Reports

The Reporting Framework Management Console Query Reports tab, showing the Export button and the Status, Title, Category, Description, Permissions, and Export columns.

The Reports tab displays all the reports that you are subscribed to and reports that are available for subscription. The Reporting Frameworks extension includes access to standard reports for general usage and any custom reports developed specifically for your institution. As clients request new reports, these may be added to the library, where you can subscribe to them.

Status

  • Subscribed - the report has been deployed to your system and is ready for use.

  • Unsubscribed - the report has not been selected for use on your system.

  • Custom - the report is only available to your institution.

Title

The name of the report.

Category

The category the report belongs to.

Description

A short description of the report.

Permissions

A link to edit which user roles have access to the report.

Export

A link to export the report definition as a JSON file.

Subscribe or unsubscribe

To subscribe to a report, choose Subscribe from the menu of a report you are not subscribed to. To unsubscribe from a report, choose Unsubscribe from the menu of a report you already subscribe to.

Permissions

By default, only users with a System Admin role can access the Reporting Framework reports. To allow access to reports by other users, you must grant permissions to the report.

  1. Click the pencil icon in the Permissions column for the report on the Reports tab.

  2. Select whether the report will be accessible from the System Tool, the Course Tool, or both. Then select the institution roles that will be allowed to run the report from each location. Any user with that institution role (either primary or secondary) will have that report in their list of reports.

Create a New Report

Select Create Report to create a new report.