Installing Joomdle in Joomla

From Joomdle
Jump to: navigation, search

This document applies to Joomdle Release 0.9.

Contents

Preparing Joomla! for Joomdle

Before you install Joomdle ensure that Joomla is installed and running correctly.

  • Install and configure any third party extensions that you wish to integrate with Joomdle such as CB, Jomsocial, Tienda, Virtuemart, XMAP. For Integration instructions with third party extensions please refer to 3rd Party Integration
  • Complete any Prerequisites required for Joomdle


.

Joomla 1.5.x only

In addition, you will need to:

  • Activate Joomla's web services through Site -> Global System Configuration, System Tab, System Configuration.

joomla_webservices.jpg

Installing Joomdle for Joomla!

The Joomdle for Joomla! extension consists of a Component and many modules and plugins. Refer to the end of this article to see the full list. To install Joomdle for Joomla!, use Joomla!'s Extension Manager and select the Joomdle package called "joomdle-joomla-package.zip". The component, plugins and modules will all be installed as one package simplifying the installation for you.

Note: It also enables all the plugins and creates the modules although they are not published.

To use the rest of plugins and components, not included in the main package, you will need to install them separately. They are located in the independent_joomla_packages folder.


.

Configuring Joomdle for Joomla!

Joomdle Component

Configuring Joomdle for Joomla! is done through the Configuration screen which can be found by choosing Configuration option in the Joomdle Component menu, or through the Joomdle dashboard. There are several sections that you can configure, however, only the first is mandatory.

joomla_component_config.jpg

Section Description
General config
  • Moodle URL
    • Enter the full URL and path of your Moodle installation - this is likely to be http: //www.mydomain.com/moodle assuming you have installed Moodle in a directory called moodle off the Joomla! root.

Remember to add http:// in front of your URL.

  • Moodle Version
    • Select your Moodle version.
  • Moodle 2.0 auth token (Moodle 2.0 only)
    • Enter the auth token you obtained when you configured Moodle web services.
  • Connection method
    • Available options are: file_get_contents and cURL. Select the one available on your server.
  • Use redirectless SSO
    • This option only works with cURL and both Moodle and Joomla on the same domain. It makes Joomdle do Single Sign On without redirecting the user back and forward. This is mostly useful for shops, so the purchase process is not broken on user logging.
  • Use redirectless logout
    • This option only works when both Moodle and Joomla are on the same domain. It makes Joomdle do Single log out without redirecting the user back and forward.
  • Moodle Cookie Path
    • This option is only needed for redirect-less SSO. You will need to copy here the value that you can find in the Cookie path setting in Moodle->Site Administration->Server->Session Handling.
  • Auto create Moodle users.
    • Set this to "Yes" if you want Joomdle to automatically create new users in Moodle when they register in Joomla!.
  • Auto delete Moodle users.
    • Set this to "Yes" if you want Joomdle to automatically delete users in Moodle when they are deleted in Joomla!.
  • Auto login users at registration
    • Set this to "Yes" if you want Joomdle to automatically log in users when they register in Joomla!.
Action buttons
  • Show button for free courses
      • Enrol into course
      • Go to course
      • Request enrolment
  • Show button for paid courses
      • Buy course: takes user to the e-commerce extension product page
      • Paypal: shows Paypal button to sell course via Moodle's Paypal

If the user is already enroled in the course, "Go to course" button will be shown regardless of these settings. Also, buttons will only show if course/shop configuration allows it: - Enrol button will only be shown when course is available for self-enrol - Buy course button will only be shown if course if on sell on shop

  • Go to course button
      • Moodle: takes user to Moodle, as configured in next section
      • Course view: uses Joomdle course view to display Moodle course contents


Links behaviour
  • Open Moodle links in
    • The parameter tells Joomdle how to respond when you click on any of the Joomdle links. This is a Global Joomdle setting and can be over written by setting the same parameters in the individual Joomdle Menu Views.
      • Open in the same window
      • Open in new window
      • Open in wrapper

When you choose to open Moodle in a "Wrapper" you can choose the Wrapper dimensions. This is a Global Joomdle setting and can be over written by setting the same parameters in the individual Joomdle Menu Views.

If you have Moodle and Joomla on different domains (with auto height off), you may need to enable an option in Moodle configuration:

Site admin->Security->HTTP Security: Allow frame embedding

  • Wrapper scroll bars
  • Wrapper width
  • Wrapper height
  • Autoheight in wrapper

NOTE: this only works when both Joomla and Moodle are on the same domain.

  • Transparent wrapper
  • Default Itemid
    • This lets you specify a default itemid to be associated to all calls to the Moodle wrapper
  • Joomdle Itemid
    • This lets you specify a default itemid to be associated to all calls to the Joomdle component from Joomdle modules
  • Shop Itemid
    • This lets you specify a default itemid to be associated to all calls to the shop component from Joomdle
  • Course Itemid
    • Item ID for the course view, used for configuring course-related modules


Data source
  • Additional Data source
    • Select other component to provide additional user information to Joomdle
      • Jomsocial
      • Virtuemart
      • Tienda
      • Ambra
      • Community Builder
      • Hikashop
      • Joomla 1.6 user profiles

If you select Joomla 1.6 user profiles, and use a non-standard profile plugin, you can configure it in the next two fields. Otherwise, leave them blank.

      • 1.6+ User Profile Form Path
      • J1.6+ Profile plugin

More info on this feature can be found here: Field Data Mapping

Profile Types
  • Use Profile Types
    • Select a component to manage profile types
      • Jomsocial
      • Ambra
      • XIPT
  • Children Profile Type
    • If profile types integration is enabled, this lets you select a profile type to apply to users created via Joomdle children registration

More info on this feature can be found here: Profile Types

User points
  • User points integration
    • Select a component to manage user points
      • Jomsocial
      • Ambra
Mailing lists
  • Mailing lists integration
    • Select a component to manage mailing lists
      • Acymailing

More info on this feature can be found here: Acymailing

Course requests
  • Max number of requests
    • Max number of requests (pending and accepted) a user can have.

When using course requests, you can also configure Joomdle to ask for additional info:

  • Request motivation: No, Optional, Mandatory
  • Request experience No, Optional, Mandatory
Shop Integration

Use these parameters if you wish to integrate Joomdle with VirtueMart or Tienda.

  • Category ID: The Product Category ID that you wish Moodle Courses to appear under.
  • Buy courses for children. Enable this option if you are using the Features for parents. If not, set it to No.
  • Subject of email: Enter the subject of the email sent when successfully purchasing a Moodle course.
  • Body of email: Enter the body of the email sent when successfully purchasing a Moodle course.

For more detailed information regarding the Joomdle and Virtuemart integration see the VirtueMart page. For more detailed information regarding the Joomdle and Tienda integration see the Tienda page.

  • Send bundle emails . Send course welcome emails for all courses in bundles.
Joomla User groups

If you want to use the Usergroups feature, here you can configure the parent groups:

  • Teachers group
  • Students group


Detail view These options control which info and links should be displayed by default on course details view.
  • Show category
  • Show course summary
  • Show language
  • Show start date
  • Show enrol dates
  • Show enrol period
  • Show number of topics
  • Show cost
  • Show Topics link
  • Show Grading system link
  • Show Teachers link
  • Show Contents link


Topics view These options control which info and links should be displayed by default on course topics view.
  • Show numbers: show topics numbers
Course category view These options control which info and links should be displayed by default on course category view.
  • Show category info
  • Show action buttons


Course view
  • Show number of topics: show section headers containing section number.
  • Show topics summary: show section summary.
  • Use page view: use Joomdle page view to show resources of type Page
  • Use Kunena forums
Courses ABC view
  • Show action buttons
Show Back links
  • Show back links: show back links in course pages (detail, course, topics, grading system)

Joomdle Plugins

The Joomdle plugins do not require any configuration. They are all enabled by default at install time.

Joomdle Modules

During installation of Joomdle for Joomla!, eight new Modules will be installed: mod_joomdle_courses, mod_joomdle_my_courses, mod_joomdle_calendar, mod_joomdle_my_grades, mod_joomdle_mentees, mod_joomdle_abc, mod_joomdle_coursemates, mod_joomdle_coursenavigation. These modules will automatically be installed and you are required to enable them before they appear on your website.

There are also more modules you can install in the independent_joomla_packages folder.

To know more about modules features and configuration options, check the Modules page.


.

System Health Check

Once you have installed and configure Joomdle, please visit the System Health Check tab to ensure all items have been configured correctly.

Refer to System health check for details with possible issues and associated resolutions.


.

Package Contents

Joomdle package contains:

  • joomdle-for-joomla package
  • moodle packages
  • other Joomla packages

The Joomdle for Joomla! package consists of the following:

Component: com_joomdle

6 Plugins:

  • plg_joomdle
  • plg_joomdlehooks
  • plg_search_courses
  • plg_search_coursetopics
  • plg_search_coursecategories
  • plg_system_joomdlesession
  • plg_system_joomdletienda

6 Modules:

  • mod_joomdle_courses
  • mod_joomdle_my_courses
  • mod_joomdle_calendar
  • mod_joomdle_my_grades
  • mod_joomdle_mentees
  • mod_joomdle_abc
  • mod_joomdle_coursemates
  • mod_joomdle_coursenavigation

Also, other separate packages are included:

  • xmap-joomdle-plugin
  • plg_community_jsbar
  • plug_joomdlehookscommunitybuilder
  • AEC micro integration
  • My certificates module
  • Acymailing plugins
  • Jomsocial and CB profile plugins
  • Content plugin
  • Teachers module
  • Categories module
Personal tools