Moodle API Setup
The Moodle APIs Setup screen is used to set up integrations between Focus and Moodle. The Moodle integration allows for a seamless transfer of student and teacher enrollments to the corresponding courses and sections within the LMS, as well as teacher changes, student re-enrollments, enrollment activation, and inactivation using enrollment date, expiration date, extension date, and completion date.
After the initial Moodle integration set up established here, ensure the following scheduled job is set up for a successful integration via Setup > Scheduled Jobs: Transfer Moodle API Data.
The appropriate profile permissions are required to set up a Moodle integration, which can be enabled via Users > Profiles > Setup tab > Moodle API Setup view and edit permission.
1. In the Setup menu, click Moodle API Setup.
Any existing Moodle integrations that have been set up in Focus are displayed in the table.
2. Enter the Title in the provided text box, such as Moodle.
3. Select the applicable Moodle version from the Version from the pull-down.
4. Select the data that should be transfered from Moodle to Focus from the Transfer From Moodle pull-down.
5. Select the data that should be transfered from Focus to Moodle from the Transfer To Moodle pull-down.
6. Select the applicable Schools from the pull-down to determine the schools that have access to Moodle vis-a-vis the integration. Leave the pull-down blank to ensure all schools have access.
7. Enter the External API URL in the provided text box.
8. Enter the Service Name in the provided text box.
9. Enter the Authentication Token in the provided text box.
10. Select the User Auth Method from the pull-down to determine the authentication that Moodle will be using in order to login the users that are created.
Select OAuth 2 if your district already has another service setting up accounts to ensure that Moodle uses those oauth credentials instead of having its own password setup. The email should match the data used with that service.
Select Create Password if the API should create the user and email the user to setup a password.
11. Select the check box to Use Grade Posting End Date on Courses and Enrollments.
12. Enter the number of Days before school year's start date to allow teacher access in the provided text box.
13. Enter the number of Days before making period's start date to allow teacher access in the provided text box.
14. Select the Use Test Email check box for testing purposes. Instead of using an actual email address, you can use a test email address such as [email protected]. Otherwise, the system will send emails to the user's actual email address, which may be confusing when testing the API.
15. Press the Enter key to save the Moodle data.
16. Click Log in to Retrieve Token to test the integration.
a. In the pop-up window, enter your Username and Password in the provided text boxes to sign in.
b. Click Retrieve Token.
Focus will attempt to receive a token from the external API. A confirmation pop-up window is displayed indicating the results of the test. If the test was not successful, please communicate with Moodle that Focus is unable to receive a token with the external credentials provided.
17. Click the delete button (red minus sign) to delete the Moodle integration set up.
Data listed can be sorted by clicking on any of the headers. Click once for ascending results; click twice for descending results.
Click the Filters feature to further breakdown data.
a. To add more than one filter to a column, click on the green plus sign.
b. To delete an added filter, click on the red minus sign.
c. Select the gray arrow for more filtering options.
For more information, see Filters.
Click the Excel icon in the Export section to export the table of data to an Excel spreadsheet, which can then be saved to your computer.
Click the Printer icon to print the table of data.
The Page Size displays the total number of records displayed per page; the default is 25 records. To change the number of records displayed per page, enter the Page Size in the provided text box.
