Create a Report
Select Create Report on the Reports tab of the Reporting Framework Management Console.
Report settings
Title | The name of the report. |
Category | A category given to the report; this allows reports to be grouped together in the report selection interface for users. |
Description | A short description of the report. |
Available Queries | A list of available queries; choose one to associate with your report. |
Report parameters
Parameters provide a way to gather user input when running a report. The framework supports various parameter types, each with unique functions. Parameters are provided to your query in the format of a colon followed by the HTML ID value. For example, to add a text box that allows a user to input a portion of a course identifier, create a text box input with an HTML ID of “section,” then in the query, you would use “:section” as the input parameter for a condition in your WHERE clause.
Select the three dot icon in the action column of the parameter row to edit or delete a parameter. Choose the appropriate action. To add a new parameter, select the Add Parameter button.
Fill out the following fields to add or edit parameters.
HTML ID | The named parameter identifier to use in your query; this will be stored in all lowercase and cannot contain any spaces or special characters. |
Prompt | The text displayed for this parameter when running the report. |
Instructions | Additional text you can display to the user about the report parameter. |
Type | Select the desired input type for your parameter. |
Required | Select this toggle to make the parameter required. |
Input Width | Input width for parameters that have a width value; in most cases, this does not need a value because the default will suffice. |
For a list of all available parameter types, visit Anthology Support and log in. Search for article 89873 and download the Reporting Framework Extension Report Manager's User Guide.
Select Save to save your report when you are finished adding your desired parameters.