Launch Special: Pay once, use forever — Pro ($499) or Enterprise ($1,799) with all future updates included View Deals →

Adeptus Insights Documentation

Everything you need to install, configure, and use the plugin

Version: 1.0.0
Updated: January 2026
Moodle: 4.1+
PHP: 7.4+ (8.1+ recommended)

Overview

Adeptus Insights is an AI-powered reporting plugin for Moodle that enables administrators and teachers to generate custom reports using natural language queries. The plugin combines the power of artificial intelligence with Moodle's comprehensive data to deliver actionable insights without requiring SQL knowledge.

Key Benefits

No SQL Required Ask questions in plain English and get instant reports
Data Stays Secure All queries run locally - student data never leaves your server
Pre-built Templates 100+ ready-to-use report templates across 24 categories
Flexible Exports Export to PDF, CSV, or JSON formats

Installation & Setup

Prerequisites

  • Moodle 4.1 or higher
  • PHP 7.4 or higher (8.1+ recommended)
  • HTTPS enabled on your Moodle site
  • Administrator access to Moodle

Installation Steps

Method 1: Upload via Moodle Admin

  1. Download the plugin ZIP file from GitHub
  2. Log in to your Moodle site as an administrator
  3. Navigate to Site administration > Plugins > Install plugins
  4. Upload the ZIP file and click "Install plugin from the ZIP file"
  5. Follow the installation prompts

Method 2: Manual Installation

  1. Download and extract the plugin
  2. Copy the adeptus_insights folder to /path/to/moodle/report/
  3. Log in as administrator
  4. Navigate to Site administration > Notifications
  5. Follow the upgrade prompts

Initial Configuration

After installation, the plugin guides you through a simple setup process:

Stage 1: Plugin Registration

  • Navigate to Site administration > Reports > Adeptus Insights
  • Click Register Site
  • Enter your administrator details (name and email)
  • Your site is automatically registered with Adeptus 360

Stage 2: Choose Subscription

  • Select your preferred subscription plan
  • Free plan available for smaller sites
  • Premium plans unlock additional features and higher limits

Stage 3: Ready to Use

  • Access the plugin from Reports > Adeptus Insights
  • Start generating reports immediately

Note: The registration process handles all API configuration automatically - no manual API key entry required.

Plugin Features

Main Interface Tabs

Tab Description
AI Assistant Generate reports using natural language queries
Report Wizard Create reports using guided step-by-step interface
Generated Reports View, manage, and export saved reports
Subscription Manage your subscription plan and view usage

Feature Comparison by Plan

Feature Free Pro Enterprise
AI Assistant Basic Full Full
Report Wizard Limited templates All templates All templates
Monthly AI Tokens 20,000 300,000 5,000,000
Active Reports 5 50 200
PDF Export Yes Yes Yes
CSV Export No Yes Yes
JSON Export No No Yes
Support Response 72 hours 24 hours 8 hours

AI Assistant

The AI Assistant allows users to generate reports by describing what they need in plain English.

How It Works

  1. User enters a question: e.g., "Show me students who haven't logged in for 30 days"
  2. AI interprets the request: The backend AI service converts the question to SQL
  3. SQL runs locally: The generated query executes on YOUR Moodle database
  4. Results displayed: Data is shown in an interactive table with optional charts
  5. Save or export: Users can save reports for later or export immediately

Supported Query Types

The AI Assistant can generate reports for:

  • User Analytics: Active users, login tracking, enrollment counts
  • Course Reports: Completion rates, activity tracking, resource usage
  • Grade Reports: Student performance, grade distribution, trends
  • Attendance: Engagement metrics, participation rates
  • System Usage: Platform activity, resource consumption

Example Queries

"Show me all users who logged in this week" "List courses with completion rates below 50%" "Find students at risk of failing in course X" "Show the most active courses by enrolment" "List teachers who haven't logged in for 60 days"

Security Measures

  • Read-only queries only: INSERT, UPDATE, DELETE, DROP commands are blocked
  • SQL injection prevention: All queries use parameterised execution
  • Data sovereignty: Query results never leave your server

Report Wizard

The Report Wizard provides a guided, step-by-step interface for creating reports without typing queries.

4-Step Process

Step 1: Choose Category

Select from 24+ report categories including User & Enrollment, Course Reports, Grades & Assessment, System Usage, Attendance, Completion, Analytics, and more.

Step 2: Select Report

Browse pre-built report templates within your chosen category. Each template shows the report name, description, and whether it requires a premium plan.

Step 3: Configure Parameters

Customise the report with filters and parameters:

  • Date ranges (start/end dates)
  • Course selection
  • User filters
  • Custom thresholds
  • Sorting options

Step 4: View Results

  • Interactive data table with sorting and search
  • Chart visualisations (bar, line, pie, doughnut)
  • Export options
  • Save report for later

Pre-built Report Templates

Category Example Reports
User & Enrollment Student count per course, Users never accessed, Login statistics
Course Courses without teachers, Most active courses, Empty courses
Grades Grade distribution, Student performance, Assessment scores
Completion Course completion rates, Activity completion tracking
System Platform usage, Resource consumption, Activity logs

Generated Reports

The Generated Reports section allows users to manage their saved reports.

Features

  • Report List: View all saved reports with search and filtering
  • Report Preview: Interactive table and chart views
  • Category Organisation: Organise reports into colour-coded categories
  • Re-run Reports: Execute saved reports with updated data
  • Export Options: Export in multiple formats

Managing Reports

Viewing Reports

  1. Navigate to Generated Reports tab
  2. Click on any report in the list
  3. View data in table or chart format
  4. Use search and sort within results

Deleting Reports

  1. Select a report from the list
  2. Click the Delete button
  3. Confirm deletion

Note: Deleting reports frees up your report quota.

Export Functionality

Available Formats

Format Availability Best For
PDF All plans Professional presentations, printing
CSV Pro / Enterprise Spreadsheet analysis, data processing
JSON Enterprise API integration, programmatic processing

Export Limits

  • PDF row limit: 5,000 rows maximum
  • Other formats: 100,000 rows maximum
  • Chart images: Included in PDF exports

Export Process

  1. Generate or open a saved report
  2. Click the Export dropdown
  3. Select your preferred format
  4. File downloads automatically

Subscription Management

Accessing Subscription Settings

Navigate to Site administration > Reports > Adeptus Insights > Subscription

Subscription Information Display

The subscription page shows:

  • Current plan name and status
  • Billing cycle and next payment date
  • AI tokens remaining
  • Reports used vs. limit
  • Exports remaining (monthly)

Plan Management

Upgrading

  1. Click Upgrade Plan or select a higher tier
  2. Review pricing and features
  3. Complete payment via Stripe
  4. New features activate immediately

Downgrading

  1. Select a lower tier plan
  2. Review the warning about report limits
  3. Confirm the change

Important: When downgrading, reports exceeding the new plan's limit will be automatically deleted (oldest first). Ensure you export any important reports before downgrading.

Cancelling

  1. Click Cancel Subscription
  2. Confirm cancellation
  3. Access continues until the end of the billing period
  4. After expiry, account reverts to free plan limits

Payment

All payments and subscriptions are managed through Stripe. If payment fails, status shows "Past Due" and Stripe automatically retries over several days.

User Permissions

Capability: report/adeptus_insights:view

The plugin uses a single capability to control access:

Role Default Access
Manager Granted
Teacher Granted
Student Not granted
Guest Not granted

Modifying Access

To grant access to additional roles:

  1. Navigate to Site administration > Users > Permissions > Define roles
  2. Select the role to modify
  3. Find report/adeptus_insights:view
  4. Set to Allow
  5. Save changes

Privacy & Data Security

Data Sovereignty

Your data stays on your server. This is a core principle of Adeptus Insights.

Data Type Location Transmitted Externally?
Student data Your Moodle server Never
Course data Your Moodle server Never
Report results Your Moodle server Never
Grades Your Moodle server Never
AI queries (questions only) Processed by AI Yes (questions only, not results)
Admin registration Adeptus 360 Yes (email, name, site URL)

How AI Queries Work

  1. You type a question: "Show students at risk"
  2. The question text is sent to our AI service
  3. AI generates SQL instructions
  4. SQL runs locally on your Moodle database
  5. Results are displayed only to you

The AI never sees your actual data - only the question.

GDPR Compliance

The plugin fully implements Moodle's Privacy API:

  • Right to Access: Users can export their data
  • Right to Erasure: Users can request data deletion
  • Data Portability: Data exportable in standard formats

Admin Settings

Accessing Settings

Navigate to Site administration > Plugins > Reports > Adeptus Insights

Available Settings

Setting Description
Enable Email Notifications Toggle on/off (default: enabled)
Notification Email Email address for system alerts

Note: Internal configuration values (API key, installation ID) are managed automatically. Do not manually edit these.

Troubleshooting

Common Issues

AI Assistant Not Responding

Symptoms: Messages not sending, loading spinner stuck

Solutions:

  1. Check your subscription is active
  2. Verify you have remaining AI tokens
  3. Check internet connectivity
  4. Refresh the page and try again
  5. Raise a support ticket via the plugin if issue persists

Credit Limit Reached

Symptoms: "Credit limit reached" message, input disabled

Solutions:

  1. Wait for monthly credit reset (1st of month or billing date)
  2. Upgrade to a higher plan for more credits
  3. Delete unused saved reports to free quota

Export Not Working

Symptoms: Export button not responding, download fails

Solutions:

  1. Check if format is available on your plan (CSV requires Pro+, JSON requires Enterprise)
  2. For large datasets (>5000 rows), use CSV instead of PDF
  3. Check browser popup blocker settings
  4. Clear browser cache and retry

Error Messages

Error Meaning Action
"Invalid API Key" Authentication issue Contact Adeptus support
"Site URL Mismatch" Site moved/URL changed Re-register the plugin
"Subscription Inactive" Payment failed or cancelled Check subscription status
"Insufficient Credits" Monthly credits exhausted Wait for reset or upgrade

Support

Getting Help

  • Documentation: You're reading it!
  • Support Tickets: Raise tickets from the plugin at Reports > Adeptus Insights (button at page bottom)
  • Website: www.adeptus360.com

Note: All support requests are managed through our integrated ticketing system within the plugin. This ensures faster response times and better tracking of your issues.

Raising a Support Ticket

To raise a support ticket:

  1. Navigate to Reports > Adeptus Insights in your Moodle
  2. Scroll to the bottom of the page and click the Support button
  3. Fill in the ticket form with your issue details
  4. Submit the ticket - you'll receive updates via the system

Information to Include

When raising a ticket, please include:

  1. Error messages (screenshots if possible)
  2. Steps to reproduce the issue

Note: Your Moodle version, PHP version, and plugin version are automatically included with your ticket.

Quick Reference

Keyboard Shortcuts (AI Assistant)

Shortcut Action
Enter Send message
Shift+Enter New line in message

Need help? Raise a support ticket directly from the plugin.

Reports > Adeptus Insights (Support button at page bottom)