Connection: Moodle, Moodle Workplace, OpenLMS and Open LMS Work (Part 1 of 2)

The individual configuring the IntelliBoard connection must be a Site Administrator of Moodle with the ability to enable web services, change web protocols, and create Moodle tokens.

Before you get started...

  • You must have an IntelliBoard account and have the IntelliData plugin installed. 
  • Additional details on the migration step can be found here.
  • IntelliBoard is a web-based service. If your LMS is behind a firewall, a port will need to be configured for the IntelliBoard service to connect. Contact helpdesk@intelliboard.net for additional details.
  • The IntelliData plugin will only migrate data from Moodle plugins that use XMLDB.  Additional information maybe found here.

General Overview

IntelliBoard Pro leverages a standard Moodle Plugin to create a table structure that then processes Moodle data on a regular schedule into IntelliBoard Pro's unified and dynamic tables.  Before a the LMS data can be processed automatically by the connection, the must go through an initial migration. 

While the data within the different LMSes may be different, the connection process for Moodle, Moodle Workplace, Open LMS, Open LMS Work, and Totara are the same.

 

Where can I find the IntelliBoard Pro Plugin? Is it the same as Lite?

The IntelliBoard Pro plugin is called IntelliData and is found on GitHub
Direct Link: https://github.com/intelliboard/intellidata

This is a different plugin than IntelliBoard Lite.  Both may be installed. 

 

What versions Moodle, Moodle Workplace, Open LMS and Totara are supported?

IntelliBoard maintains support for the versions supported by the individual LMSes.  Please find versioning information on GitHub. 

Making the Initial Connection

Step 1: Integrations > Select Your LMS Type

Direct Link: https://next.intelliboard.net/connections/integrations

Note: While the data within the different LMSes may be different, the connection process for Moodle, Moodle Workplace, Open LMS, Open LMS Work, and Totara are the same.

  • Click Integrations.
  • Under desired connection, click "+ Connect".


Step 2: Add Connection Details

Enter the following information:

  LMS Name   Text Box; Required Field; Name the connection for identification purposes.
  URL   Text Box; Required Field; Copy and Paste the URL of your Moodle Based LMS  Note: Include HTTPS:// and do not include any additional pathways
  Token   Text Box; Required Field; Created inside Moodle.  Note the additional steps below.
  Category   Drop Down; Required Field; Select a Category for your Connection.  Note the additional steps below.
  Active   Check Box; Check on to enable the connection.  Connections must be active to process.
  Dynamic tables   Check Box; Dynamic tables are for LMS native tables (eg. Competency, Program, Feedback, etc.)
  Process at Hour   Drop Down; Required Field; Select the hour to process your data daily. Note additional steps below.

 

Creating a Token

Moodle Version 3.10+: Site Administration > Server > Web Services > Manage Tokens

Moodle 3.9: Site Administration > Plugins > Web Services > Manage Tokens

  • Add a new token
  • Add Username or User ID; Note: This must be a Site Administrator.
  • Select Service: IntelliData Service
  • Click Save 
  • Copy and Paste Token into IntelliBoard

Creating a Connection Category

IntelliBoard allows you to create categories for your connections.  For additional information click here.


Select a time for Daily Processing
IntelliBoard allows you to select a time to process your data.  We recommend choosing an 'off hour' to have the freshest data for the next day.

 

Step 2: Validate the LMS Settings 

Enable Web Services

Site Administration > Advanced Features

  • Find Enable Web Service and click enable.
  • Click Save Changes

Enable REST Protocol

Moodle Version 3.10+: Site Administration > Server > Web Services > Manage Protocols

Moodle 3.9: Site Administration > Plugins > Web Services > Manage Protocols

  • Find REST aned enable (open eye)
  • Click Save Changes

Verify Authorized Users through External Services

Moodle Version 3.10+: Site Administration > Server > Web Services > External Services

Moodle 3.9: Site Administration > Plugins > Web Services > External Services

  • Find IntelliData Service, it should show All Users. 
  • If it does not say All Users, please edit to allow All Users or add the Authorized Users who have Site Admin privileges.

 

Step 3: Review IntelliData Settings + Add Encryption Settings

Administration > Plugins > Local Plugins > IntelliData
Pathway: /admin/settings.php?section=local_intellidata


 

  Enabled Check Box; Leave enabled
  Tracking Storage Drop Down; Note the additional details below.
  API Key Unique Key; Masked; To be saved under "Encryption Key" in IntelliBoard
  API Identifier Unique Key; Masked; To be saved under "Client Identifier in IntelliBoard

 

Tracking Storage
This setting determines where IntelliBoard Time Tracking is stored and has three options: 1) File, 2) Cache, and 3) Database.  Defaults to File, which is the only option for Open LMS users.  Cache can be used for smaller LMS enviroments.  File and Cache both use cron settings to store data to push to the user tracking tables.  Database selection saves the information directly to the database and bypasses cron settings.

API Key and API Identifier: 

Unmask keys, copy and paste keys into IntelliBoard Pro.

  • Copy Encryption Key from IntelliBoard (previous step) to Moodle in field API Key.I
  • Copy Client Identifier from IntelliBoard (previous step) to Moodle in field API Identifier.
  • Click Save.

Step 4: Click Continue

Upon clicking Continue, you'll see 4 green check marks on URL, Token, Encryption Key, and Client Identifier if the connection is successful and be directed to the LMS Filter Settings page.  If unsuccessful, please review the steps above to adjust settings.  For additional assistance, please contact Helpdesk@intelliboard.net 

 

Step 5: Review Filter Settings 

From within IntelliBoard, review the following Filter Settings, make selections, and save. 


Note: These filters may be changed and edited, but a Migration must be run to pick up additional datasets.  Please see here for additional details on Migration.

 


  User Filters   Drop Down; Required; See details below for options.
  Course Filters > Course    Drop Down; Required; See details below for options.
  Course Filters > Category   Drop Down; Required; See details below for options.


User Filters: 
1) All Users - All Users in the System 

2) Active Users - All unhidden/unsuspended users in the System

Course Filters > Course:

1) All Courses - All Courses in the System 

2) Active Courses- All unhidden/inactive courses in the System

 

Course Filters > Categories:

1) All Categories - All Categories in the System, including newly added Categories

2) Partial Categories - Partial Categories; select certain categories within your system to bring into IntelliBoard

 

Step 6: Review Role Settings

From within IntelliBoard, review the following Role Settings, make selections, and save.  Each section is populated with all roles inside your LMS.  

Map your LMS roles to IntelliBoard Roles.  This is important for role clarity within the Builder, IB Users, and the LTI. 

When complete, please click save. 

Roles may be edited to match needs and do not require an additional migration.

 

  Instructor Roles   Drop Down; Required
  Learner Roles    Drop Down; Required
  Admin Roles   Drop Down
  Course Admin Roles   Drop Down

 

Step 7: Complete First Time Migration: Click here for required next steps.

IntelliBoard Pro leverages a standard Moodle Plugin to create a table structure that then processes Moodle data on a regular schedule into IntelliBoard Pro's unified and dynamic tables.  Before the LMS data can be processed automatically by the connection, they must go through an initial migration. 

When should I complete the migration process? 

  • Initial Connection:  The migration must be complete after you make the initial connection and before your first processing. 
  • Plugin Update: Restart the migration process each time you update the IntelliData plugin.
  • Filter Changes: When you change or add data through additional filters, restart the migration process.

How long does the Migration process take? 

Initial migrations may take between 1 - 3 days depending on the size of your LMS database.  LMS databases that have more than 200 GB of data may take up to 7 days with the default settings.   The number of rows to be migrated and the cron schedule may be updated to speed up the migration process.

 

Step 8: Only after Migration is Complete - Process Data

NOTE: This step has to be done only when the migration is finished.

Direct Link: https://next.intelliboard.net/connections

  • From Manage my IntelliBoard Account, click My Connections
  • Click the name of the URL or Edit, to open the connection.
  • Click on Process Data

For additional assistance, please email helpdesk@IntelliBoard.net.

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