Loading...

How to Install and Configure Moodle Integration Plugins

Setting up your Moodle Integration should be a one time process. To reach the milestone of streamlined automation, some complex setup is required. Follow the steps below comprehensively.

Before you begin:

Required Knowledge: Moodle, Moodle Integration

Required Moodle Access: Admin

Recommended Moodle Version: 2.7+

1

Is Wisenet hosting Moodle for you?

As part of your Moodle hosting services, Wisenet has completed the plugin installation and you only need to now proceed with the Set Up steps below.

The following Pre-Steps are required to Install Plugins in Moodle before you can Set Up the Moodle Integration Plugins.

  1. Download the ZIP file (see required details below)
  2. Upload or copy it to your Moodle server.
  3. Unzip it in the right place for the plugin type.
  4. In your Moodle site (as admin) go to Site administration > Notifications (you should, for most plugin types, get a message saying the plugin is installed).
For Authentication Plugin
    • Download Zip File – auth_wisenetconnector.zip
    • Plugin Type = Authentication Method (Auth)
    For Enrolment Plugin
      • Download Zip File – enrol_wisenetconnector.zip
      • Plugin Type = Enrolment Method (Enrol)
      For Grade Plugin
        • Download Zip File – local_wisenetconnector.zip
        • Plugin Type = Local Plugin (Local)

        2

        Wisenet Moodle Connector URL

        Use the following url and replace the xxx with your account 3-letter code.

        Note

        xxx is the 3-letter code assigned to your account.  This is the same value used in the Client RefInternal field. E.g. A number like STZ00001R has a code of STZ. The url would be https://stz-api.wisenet.co

        3

        Plugins Settings

        Follow the instructions below:

        1. Log into your Moodle Site
        2. Go to Site Administration > Plugins > Authentication > Manage Authentication
        3. Find Wisenet Moodle Connector in the list.  Ensure that it is set to Enable by clicking on the eye icon
        4. Click Settings against the Wisenet Moodle Connector plugin
        5. Configure the plugin setting using the help information below. Always remember to Save Changes after any update.
        Settings for Details
        • Wisenet Moodle Connector URL – usually Wisenet will send you an email with URL to Wisenet Moodle Connector
        • Records per call – You can specify amount of records per one call to Wisenet Moodle Connector. Usually you do not need to change it. Don’t make this number too big, or it can cause performance issues
        • Last run time – Shows when synchronisation scheduled task was last run
        • Reset last run time – use this to resynchronise your records. You also need to click ‘save’ at the bottom of the page to make this happen
        • Hide passwords – we recommend you keep this set to ‘yes’ as a security measure. It prevents passwords from being saved inside Moodle
        • Username and Password – Use the username and password you set up for your Moodle Integration
        • Password-change URL – URL to Learner App where Learners can change their password. Replace xxx with your 3-letter code. https://learner.wisenet.co/xxx/Account/ChangePassword
          Settings for Cron synchronisation script
          • Remove ext user – you can specify what to do with user when the Learner record is removed or disabled in Wisenet
            • Keep Internal: this will retain the user account and continue to show as enabled access but learner will not be able to log in. Not recommended
            • Suspend Internal: this will retain the user account but will not permit login. The user will appear greyed out in any courses. If the same client record later becomes eligible to access elearning again, the Moodle user account will be automatically revived
            • Full delete internal: all information about this Moodle user account will be permanently deleted. Not recommended.
          • Email Address for error alerts – you can specify an email address (or list of email addresses separated by “,”) for alerts. The system will send email to this address if it can’t connect to Wisenet Moodle Connector.
            Settings for Data mapping
            • These fields are optional. You can choose to pre-fill some Moodle user fields with information from the Wisenet Moodle Connector fields that you specify here
              • Update local: If enabled, the field will be updated from Wisenet. Choose whether this happens
                • a) only when the Moodle user account is first created OR
                • b) every time the user logs in or there is a user synchronization. Fields set to update locally should be locked.
              • Lock value: If enabled, will prevent Moodle users and admins from editing the field directly. Use this option if you want Wisenet to be the source of truth for Moodle user accounts
            • First name – firstname
            • Surname – lastname
            • Email address – emailaddress
            • City/town – postaladdress_addressline3
            • ID number – refinternal
            • Phone 1 – phone
            • Phone 2 – mobile phone
            • Address – postaladdress_addressline1

              Or, watch the following video

              Follow the instructions below:

              1. Log into your Moodle Site
              2. Go to Site Administration > Plugins > Manage Enrol plugins
              3. Find Wisenet Moodle Connector in the list.  Ensure that it is set to Enable by clicking on the eye icon
              4. Click Settings against the Wisenet Moodle Connector plugin
              5. Configure the plugin setting using the help information below. Always remember to Save Changes after any update.
              Options for Wisenet Moodle Connector connection
                • Wisenet Moodle Connector URL – usually Wisenet will send you an email with URL to Wisenet Moodle Connector
                • Records per call – You can specify amount of records per one call to Wisenet Moodle Connector. Usually you do not need to change it. Don’t make this number too big, or it can cause performance issues
                • Last run time – Shows when synchronisation scheduled task was last run
                • Reset last run time – use this to resynchronise your records. You also need to click ‘save’ at the bottom of the page to make this happen
                • Hide passwords – we recommend you keep this set to yes as a security measure. It prevents passwords from being saved inside Moodle
                • Username and Password – Use the username and password you set up for your Moodle connector
                • Password-change URL – URL to Learner App where students can change their password. Replace xxx with your 3-letter code. https://learner.wisenet.co/xxx/Account/ChangePassword
                Options for Local field mapping
                  • You can’t change these settings: they are there for your information in case you need to know what Moodle fields these are pointing to. These are the fields the connector uses for mapping from Wisenet into Moodle.
                    • Local user field
                    • Local role field
                  Options for Remote enrolment sync

                    • Remote course field – this field in Wisenet will be matched to pull enrolments into your Moodle courses. You can choose from four (4) options:
                      1. CourseCode
                      2. UnitCode
                      3. CourseOfferCode
                      4. UnitOfferCode
                    • Dates and Outcomes. Optionally, choose when your Learners can access their Moodle courses relative to their unit enrolment dates.
                        • Days before/after unit start date
                        • Days before/after unit end date
                        • Filter by Outcome
                        • Country
                        • Outcomes list
                    • Email Address for error alerts – you can specify you can specify email address (or list of email addresses separated by “,”) for alerts. The system will send email to this address if it can’t connect to Wisenet Moodle Connector.
                    • Default role – This is the role the student will be given in the Moodle course. Default: student. You can change this here. You can override this for each course.
                    • External unenrol action – Select action to carry out when user enrolment disappears from Wisenet. Default: Disable course enrolment.
                      • If you choose ‘unenrol from course’, then please note that some user data and settings are purged from the student’s Moodle course enrolment record during course unenrolment. If there is an accidental deletion in Wisenet, you may lose data in Moodle
                    • Add instance to new courses – Choose yes to make sure this enrolment method is always available in new Moodle courses by default.
                    • Enable Wisenet Moodle Connector enrolments – let this plugin create and manage enrolments. This should be kept enabled in most cases. Default: Yes

                  Or, watch the following video

                  Warning

                  If you choose unenrol from course in the External Unenrol Action section, then please note that some user data and settings are purged from the student’s Moodle course enrolment record during course unenrolment. If there is an accidental deletion in Wisenet, you may lose data in Moodle.

                  Follow the instructions below:

                  1. Log into your Moodle site
                  2. Go to Site Administration > Plugins > Local Plugins > Manage local plugins
                  3. Find Wisenet Moodle Connector in the list.  Ensure that it is set to Enable by clicking on the eye icon
                  4. Configure the plugin setting using the help information below.  Always remember to Save Changes after any update.
                  • URL – Follow URL instructions above
                  • Username and Password – Use the username and password you set up for your Moodle connector
                  • Enabled – switch this plugin off using this checkbox.

                  Or, watch the following video

                  Note

                  Most of what’s needed for this plugin to work is individual item setup in Moodle courses. See the detailed instructions: How to Set Up Grade Integration in Wisenet and Moodle

                  Was this Resource helpful?