Max Report Builder: Build by SQL - Moodle LMS

IntelliBoard's Report Builder, know as Max, allows you, the IntelliBoard Admin (main subscriber), to build reports on your own, on the fly, answering questions to all your LMS questions.

Before you get started... 

  • The Report Builder functionality begins with a Level 7 IntelliBoard subscription; please review access and number of accounts here.
  • The Report Builder functionality feature is only available for Main Subscribers; SubAccount/IB users do not have the ability to use the Report Builder for permission and protection of the LMS server. 
  • The Report Builder is comprised of two options: 1) Build by SQL or 2) Build Visually

NOTE: Clients utilizing SQL must know how to utilize SQL code. Clients who are uncomfortable with SQL should make reports through LISA, Feature Requests or Build Visually. 

Additional Details on the Build Visually can be found  here. 

Step 1: Build by SQL 

  • After logging on to IntelliBoard with the main subscription email, click Build with SQL. 
  • In the top right corner, click Create SQL Report through Report Builder.

Max_Step_1.png

Step 2: Write Your Report

1: Report Name - Name your report!

2: Status - Select "Active" or "Inactive" which makes the report listed in the IntelliBoard Report Listing. Active Reports will be found under Reports > Extras > Built by SQL.

NOTE:  Before the report can display data inside IntelliBoard, the report must also be activated in Moodle.

3: Pagination - Enable (blue) or disable (grey) pagination. See below for additional screenshots for pagination.

4: Assigned Connections - Select which connection(s) for use.

5: SQL Code - Write your report!

NOTE: IntelliBoard's SQL Builder uses Moodle DB API which requires a unique ID for each row. For SQL Builder reports to populate, you must include code which populates a unique ID for each row.

6: Filter - Insert filtering, as desired. See below for additional screenshots for filtering.

7: Sorting - Insert sorting, as desired. See below for additional screenshots for sorting.

NOTE: If you are utilizing an alias make sure that: alias are consistently used; alias does not have any spaces (they can use and underscore “_” as spaces instead), "HAVING id > 0" is utilized before :filter :sorting.

8: Save - Save your report!

 

Max__Step_2.png

 

PAGINATION

Max_Pagination.png

FILTER

Max_Filter.png


SORTING  

Max_Sort.png

Step 3: Activate your Report in Moodle 

NOTE:  Before the report can display data inside IntelliBoard, the report must also be activated in Moodle.

To activate your report in Moodle, follow these steps: 

  • Log on to Moodle as Site Administrator 
  • Ensure your IntelliBoard Subscription Email is listed under Site Administration > Plugins > Local Plugins > IntelliBoard > IntelliBoard; update and save if needed 
  • Go to Site Administration > Plugins > Local Plugins > IntelliBoard > SQL reports to find newly created report. 
  • Click Edit next to newly created report.

Max__Step_3.png

Step 4: Activate your Report in Moodle, cont. 

NOTE:  Before the report can display data inside IntelliBoard, the report must also be activated in Moodle.

After clicking Edit, change drop down to "Activated" and click saveMax__Step_5.png

Step 5: Confirm Activation & Clear Cache

Return to IntelliBoard > Build by SQL to confirm you've saved your report. You may need to refresh your page or go back to the newly created report and edit it. Once the report has been activated in the Moodle system, you will see the Activation Date under Assigned Connections. 

Return to Settings + Options > Clear Cache. 

Max_Step_6.png

Step 6: Run Your Report!

Navigate to Reports > Extras > Built by SQL and find and run your report! 

Reports can be edited at any time through the SQL Builder. For security purposes, each time the code is edited the report will need to be re-activated in Moodle. 

Max_Step_7.png

Step 7: Work With Your Report!

Export and/or Share your data as well as any report!

For additional assistance, please email helpdesk@IntelliBoard.net

Was this article helpful?
2 out of 2 found this helpful