Preparing Moodle

joomdleThis article describes the procedure for preparing Moodle prior to installing Joomdle.


Moodle Web Services

Start by logging on to your Moodle site with an admin account.

  1. Go to Site administration > Plugins > Web Services > Overview.
  2. Click Enable Web Services, and tick the checkbox.
  3. Go to Site administration > Plugins > Web Services > Manage Protocols.
  4. Enable the XML-RPC protocol.

 

Moodle User

Joomdle needs a Moodle user account, with the right level of access permissions.  This user account should only be used by Joomdle, and should not be the main admin account.

  1. Go to Site administration > Users > Accounts > Add a new user.
  2. Enter Name: Joomdle Connector
  3. Username: jconnect
  4. Document the password.

 Now we have a Joomdle user account, we can check the Permissions.

  1. Go to Site administration > Users > Permissions > Check system permissions.
  2. Select the newly created Joomdle user account.
  3. Click Show this user's permissions.
  4. Filter for XML.
  5. Note the status of the Web service: XML-RPC protocol permission.

It will likely be not allowed, so we will create a role that allows this permission, and give our Joomdle user account the role.

  1. Go to Site administration > Users > Permissions > Define Roles.
  2. Click the Add a new role button.
  3. Use role or archetype: No role.
  4. Short name: XMLRPC
  5. Full name: Allow access to web service XML-RPC.
  6. Context: System.
  7. Allow the following permissions, and click Create this role.
Use XML-RPC Protocol
View discussions

Now we can assign the Joomdle user account to this role.

  1. Go to Site administration > Users > Permissions > Assign system roles.
  2. Select the newly created Role.
  3. Add the Joomdle user account.

Now you can check the permissions again, and you should see the two permissions enabled.

 

Add a Moodle Service

Now we can add a new Moodle service so that we can define what the Joomdle user account can do in Moodle.

  1. Go to Site administration > Plugins > Web services > External services.
  2. Click Add to create a new service.
  3. Name: Joomdle Web Service.
  4. Short name: Joomdle.
  5. Select Enabled and Authorised users only.

Note that we will be adding functions to this service later on.

Now we can add the Joomdle user account as an authorised user.

  1. Go to Site administration > Plugins > Web services > External services.
  2. Click Authorised users, for the newly created service.
  3. Add the jconnect user account.

 

Create a Token

The final step in preparing Moodle for a Joomdle installation, is to create a token.

  1. Go to Site administration > Plugins > Web services > Manage tokens.
  2. Click Add.
  3. User: Select the jconnect user account.
  4. Service: Select the Joomdle Service.
  5. Click Save changes.

You will now see a long alpha-numeric token that will be needed in Joomdle's configuration in Joomla.

 

Frame embedding

You will need to allow frame embedding, if you want to use a Joomdle wrapper

  1. Go to Site administration > Security > HTTP security.
  2. Enable the option to Allow frame embedding.

 

Thanks for visiting.