Installing the Credentium® Integration Plugin for Moodle

This guide walks you through installing and setting up the Credentium® Integration plugin for Moodle.

Before You Begin

Prerequisites

1. Moodle 4.5 or higher installed and running
2. PHP 7.4 or higher (PHP 8.0+ recommended)
3. Site administrator access to your Moodle installation
4. Credentium accountwith:
   • API URL (e.g., https://issuer.credentium.com/api)
   • API Key (format: cred_xxxxx.yyyyy)
   • At least one active credential template

Verify Requirements

1. Check your Moodle version: Site Administration > Notifications
2. Check PHP version: Site Administration > Server > PHP info
3. Ensure cron is running: Site Administration > Server > Scheduled tasks

Download the Plugin

From GitHub Releases

1. Go to GitHub Releases
2. Download the latest local_credentium-X.Y.Z.zip file
3. Verify the download using provided checksums (SHA256/MD5)

Installation Methods

Method 1: Web Interface Installation

1. Log in to Moodle as a site administrator
2. Go to Site Administration > Plugins > Install plugins
3. Drag and drop the ZIP file, or click Choose a file to select it
4. Click Install plugin from the ZIP file
5. Review the plugin validation results
6. Click Continue to proceed with installation
7. Review the database upgrade information
8. Click Upgrade Moodle database now
9. After upgrade completes, click Continue

Method 2: Command Line Installation

# Navigate to your Moodle installation
cd /path/to/moodle

# Extract the plugin to the local directory
unzip local_credentium-X.Y.Z.zip -d local/

# Run the upgrade script
php admin/cli/upgrade.php

Method 3: Manual Installation

1. Extract the ZIP file contents
2. Upload the credentium folder to {moodle}/local/
3. Ensure the folder structure is: {moodle}/local/credentium/version.php
4. Log in as administrator
5. Go to Site Administration > Notifications
6. Follow the upgrade prompts

Post-Installation Configuration

After installation, you'll be redirected to the plugin settings page.

Step 1: Enable the Plugin

1. Go to Site Administration > Plugins > Local plugins > Credentium® Integration
2. Check Enable Credentium Integration to activate the plugin

Step 2: Enter API Credentials

1. Enter your API URL (e.g., https://issuer.credentium.com/api)
2. Enter your API Key (the full key including the dot)
3. Click Save changes

Step 3: Test the Connection

1. Click the Test Connection button
2. A new window opens showing connection results
3. Verify you see "Connection successful" and your templates listed

Step 4: Configure Optional Settings

• Enable category mode - Turn on to allow separate API credentials for different course categories. This enables multi-tenant deployments where different departments or programs can use their own Credentium organization accounts.
• Enable debug logging - Turn on temporarily for troubleshooting

Verify Installation

Check Plugin Status

1. Go to Site Administration > Plugins > Plugins overview
2. Search for "Credentium® Integration"
3. Verify the plugin shows as installed with correct version

Check Database Tables

The following tables should exist after installation:

• mdl_local_credentium_issuances
• mdl_local_credentium_course_config
• mdl_local_credentium_category_config
• mdl_local_credentium_templates_cache

Check Scheduled Tasks

1. Go to Site Administration > Server > Scheduled tasks
2. Search for "Credentium® Integration"
3. Verify "Process pending credentials" task is registered

Configure Course Completion

The plugin requires course completion tracking to work.

Enable Completion Tracking Site-Wide

1. Go to Site Administration > Advanced features
2. Check Enable completion tracking
3. Click Save changes

Enable Completion for a Course

1. Go to the course settings
2. Under Completion tracking, select Yes
3. Set completion criteria (activity completion, grade, etc.)
4. Save changes

Next Steps

After installation:

1. Configure global settings
2. Set up your first course
3. Test credential issuance

Upgrading the Plugin

Before Upgrading

1. Backup your Moodle database
2. Check release notes for breaking changes
3. Verify new version compatibility with your Moodle version

Upgrade Process

1. Download the new version from GitHub Releases
2. Replace the existing local/credentium folder with the new version
3. Go to Site Administration > Notifications
4. Follow the database upgrade prompts
5. Verify settings are preserved
6. Test connection with Credentium API

Uninstalling the Plugin

Before Uninstalling

• All issuance history will be deleted
• Course configurations will be removed
• This cannot be undone

Uninstall Process

1. Go to Site Administration > Plugins > Plugins overview
2. Search for "Credentium® Integration"
3. Click Uninstall
4. Confirm the uninstallation
5. Review what will be deleted
6. Click Continue

Troubleshooting Installation

"Plugin is missing from disk"

Cause: Files not in correct location

Solution:

• Verify folder structure is local/credentium/version.php
• Check file permissions (web server must be able to read)

"Requires Moodle 4.5 or higher"

Cause: Moodle version is too old

Solution:

• Upgrade Moodle to 4.5 or higher
• Or use an older plugin version compatible with your Moodle

"Plugin validation failed"

Cause: Corrupted download or incomplete extraction

Solution:

• Re-download the plugin
• Verify checksum matches
• Extract again ensuring no errors

Database upgrade fails

Cause: Database permissions or conflicts

Solution:

• Check database user has ALTER TABLE permissions
• Review Moodle error logs for details
• Try running upgrade from command line with --verbose

Need Help?

If you encounter installation issues, please contact:

Credentium Support Email: support@credentium.com

Include:

• Moodle version
• PHP version
• Error messages
• Steps you've already tried

Last updated: January 2026