Legacy Portal: Set Up Your Moodle Integration

Before You Begin

We require Moodle version 2.9 or above.

 

Procedures

Complete all of these procedures to set up the web services portion of the Moodle API integration. All of these features can be found under the Site Administration section of your Moodle instance with the appropriate admin-level permissions.

 

Enable the Service and Add the Functions

  1. In your Moodle instance, select Site Administration.
  2. Go to the Advanced Features section.
  3. Select the box next to Enable Web Services.
  4. Select Save Changes.

    rtaImage1.png

  5. Select the Server tab.
  6. Go to the Web Services section.
  7. Select Manage Protocols.

    rtaImage1.png

  8. Enable REST Protocol and save your changes.

    rtaImage1.png

  9. Go back to the Web Services page, and select External Services.

    rtaImage1.png

  10. Select Add a Custom Service.
  11. For the Name and the Short Name, enter: ExamSoft
  12. Select the Enabled checkbox.

    rtaImage1.png

  13. Select Save Changes.

    ExamSoft will now appear in the list of External Services.

  14. Select Functions.

    rtaImage1.png

  15. Select Add Functions.

    rtaImage1.png

  16. Add each of these functions:

    core_course_get_contents
    core_course_get_course_module
    core_course_get_courses
    core_course_get_courses_by_field
    core_course_search_courses
    core_enrol_get_enrolled_users
    core_grades_update_grades
    core_grading_get_definitions
    core_user_get_users
    core_user_get_users_by_field
    core_webservice_get_site_info
    gradereport_user_get_grade_items
    mod_assign_get_grades

  17. Return to the Web Services section, and choose Manage Tokens.

    rtaImage1.png

  18. Select Add.

    rtaImage1.png

  19. Enter the following information:

    rtaImage1.png

    • User: Select a Site Administrator User.
    • Service: Select the ExamSoft service defined in Step 4.

    Note: You can ignore the IP Restriction and Valid Until settings.

  20. Select Save Changes.

    Note: This token will be needed later. We recommend that you copy all information to a file for later use.

    rtaImage1.png

 

Configure the ExamSoft Tool

  1. Under the Plugins tab, find the Activity Modules section, and select External Tool.

    rtaImage1.png

  2. Select Configure a Tool Manually.

    rtaImage1.png

  3. Select Add External Tool Configuration.
  4. Provide the following values:
  5. For Consumer Key and Shared Secret, enter the values provided by your ExamSoft representative.
  6. For Default launch container, select New window.
  7. Under Privacy, set all controls to Always.
  8. Select the checkbox for Show tool type when creating tool instance.

    rtaImage1.png

  9. Save your changes. 

 

Add the ExamSoft Tool to a Course

  1. Inside any Moodle course (either a sandbox course or a dedicated ExamSoft course), switch to editing mode.

    rtaImage1.png

  2. Select the Add an Activity or Resource link, and then select External Tool.

    rtaImage1.png

  3. For Activity name, enter: ExamSoft Admin Panel
  4. For Preconfigured Tool, select the tool that you created in the previous steps.
  5. For Privacy, enable all privacy options.

    rtaImage1.png

    Launching the external tool will show the ExamSoft API Configuration.

 

Next Steps

  • To configure the API, see: Legacy Portal: Setup ExamSoft API
  • To schedule a sync to occur on a daily basis, follow the steps below.
    1. Log in to your ExamSoft Portal as the ExamSoft Key Administrator (only this account has the required permissions).
    2. Select the Admin tab, then Global Settings.
    3. On the global settings page, select LMS Settings.
    4. Select the time for the automatic sync to occur. 
    5. Save the settings.

 

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

Articles in this section