SS&E LMS Integration: Test Connection

Overview

Depending on the LMS System being used, if the LMS system type or LMS connection details change post-implementation, the new connection details will need to be updated within SS&E on the LMS Integration Configuration Administration page, found https://yourinstitution.avisoapp.com/aviso/app/admin/lmsIntegration.

Note: Replace yourInstitution in the above link with your SSE/Aviso domain as displayed in a working URL. For more details, click Support Articles include Broken Links with 'yourInstitution'.

Test Connection

From the LMS Integration Configuration page, an SS&E System Administrator can use the Test Connection button to confirm that the connection is configured correctly.

• If "Test Connection" fails for any reason, this indicates a broken connection. Until the underlying issue is resolved and the connection is successful, LMS will not sync any data with SS&E.
• To change the LMS System Type - Use the pencil icon in Edit mode and select Ok on the Confirmation message.
• For Moodle this is N/A, as we are unable to test Moodle LMS Integration connectivity within SS&E. Please refer to the below steps to Test Connection for Moodle

Successful LMS Connection

Success: If valid data is returned, the connection is successful. Example success messages:

Note: Test Connection is only supported for the Moodle plugin version 2024102101 or later. This will fail if using an older version. Go to the Manual API Calls page to test the Moodle connection OR upgrade to the latest plugin version by following the SS&E LMS Integration: Moodle Plugin Installation Guide.

LMS Connection Errors

Errors: If an error message is returned, verify the configurations and permissions are correct following the relevant LMS Setup Guide. Example error messages:

• Blackboard
  • "Unable to connect" confirm the user has the correct role and permissions.
  • "404 - this page does not exist" confirm the domain and appId.
• Brightspace
  • "Cannot invoke method render() on null object" - Verify that appId, appKey, userId and userKey are correct
  • ""success": false" - Verify that the fullD2lUrl and host are correct

    

• Canvas
  • "Unable to connect. Status Code: 404 -- That page doesn't exist."
  • "Unable to connect. Status Code: 401 -- Unauthorized - invalid credentials."
• Moodle
  • If a blank screen or error message is returned, verify the configurations and permissions above are correct.

Testing Moodle Connection via Manual API Calls

For Moodle plugin versions earlier than 2024102101, test connection via the Manual API Calls page.

1. Navigate to SS&E Admin > LMS Integration > Manual API Calls.
2. Click Course Sections button in the Course Sections box:

   

Error: "Invalid token - token not found. No data was returned."

Confirm that the token is correct in SS&E. Follow the instructions in the "In Student Success & Engagement" section from the Moodle Setup Guide to update the token.

Note: If the SSE Admin user has been deactivated within the LMS, the connection test may still be successful. Complete the following steps for additional testing.

• Confirm that data is returned from the Course Sections call on Manual API Calls page.
• Navigate to LMS Integration > Manual API Calls and locate the Course Sections box.
• Click Course Sections to trigger the API call to confirm that the connection is configured correctly.
• If an error message is returned, verify the configurations and permissions above are correct. Example error message:
• "Error getting course sections: Cannot get property 'PagingInfo' on null object" - confirm the SSE Admin user is active with correct permissions.
• If valid course section data is returned, the connection is successful and the setup is complete. Note that this pulls all course sections, so a large amount of data is being queried.”