Access Keys:
Skip to content (Access Key - 0)

Administrator Manual

Table of Contents

1. Activities

1.1. eFolio

1.1.1. Overview

The eFolio Assignment type is an assignment that allows a student to submit an eFolio page as a response to an assignment. That eFolio page can contain any of the eFolio content types a student can add to eFolio, including HTML entries, files, images and/or videos. An eFolio page can contain multiple eFolio content items, which makes this assignment type extremely versatile. The assignment provides read access to the eFolio item automatically to allow the teacher to review the entry and grade it.

1.1.2. Benefits

The benefits of the eFolio assignment type are:

  1. Versatile assignment type allowing for submissions with multiple content types
  2. Students can use assignment responses in multiple courses
  3. Students can keep the assignment response as part of their portfolio after leaving the institution
  4. Students can publicly display responses, allowing for public demonstrations of work

1.1.3. User Documentation

1.1.3.1. Submit an eFolio Assignment

The eFolio assignment only allows a user to submit an eFolio site or page as a response to the assignment. This means that a student must first create a page in eFolio and attach any materials they want to submit to the page. To create a page, the student navigates to the institution's eFolio site via the eFolio block's Go to eFolio link. Once in eFolio, the student can create a page by selecting an existing site or page and clicking the green plus sign button or by clicking the green plus sign button below the currently selected site to create a new site.

A student can then drag an existing content item under the My Content menu on the left-hand side.

If the student wants to dress up or alter the look of the page being submitted to the assignment, they simply click on the Design tab in the upper right-hand corner.

Submitting a response to an eFolio assignment starts by clicking on the assignment's link in the course. Once in the assignment, click on the Edit Submission button. On the next page, you will be given a selection of sites in your eFolio account to choose from. Clicking on the site link will reload the page and display a list of all the pages and sub pages within the site.

To submit a site or page link for review, click the Submit: <Page or Site Title> button. The student can click the Cancel button to cancel their submission.

1.1.4. Teacher Documentation

1.1.4.1. Create eFolio Assignment

Creating an eFolio assignment is the same as any other core Moodle assignment. The instructor adds the assignment via the Turn editing on button and selects Assignment > efolio in the Add Activity drop-down menu of a course.

The instructor is presented with the eFolio add assignment screen (shown below):

1.1.4.2. Activity Settings

1.1.4.2.1. General

  • Assignment Name: The name of the assignment that will be displayed in the course listing
  • Description: A paragraph or more of text describing the activity and informing the student what they are to submit. This will be displayed to the student when they submit the assignment.
  • Grade: The maximum grade value for this activity that a student can receive
  • Available From: The date and time that this assignment is displayed to the student, which is also when they can first submit the assignment. If disabled, the assignment will always show and a student can always submit a response.
  • Due Date: The date when the assignment no longer shows to the student and will not allow a response to be submitted
  • Prevent Late Submissions: Don't allow students to submit a response after the due date
1.1.4.2.2. eFolio

  • Allow resubmitting: Allow the student to submit an assignment even after it has been graded.
  • E-mail alerts to teachers: E-mail the teacher when a submission has been given by a student.
1.1.4.2.3. Common Module Settings

  • Group Mode: This setting determines the display properties to users within groups.
    • No Groups: All users see the same activities and responses to activities.
    • Separate Groups: Users can only respond to and view responses of users who are in their group
    • Visible Groups: Users can view all users' responses but can only respond to responses of users in their group.
  • Visibility: Determines if the activity is displayed to students or not within the course.
  • ID Number: Setting this provides an identifier for calculations within the grade book.
  • Grade Category: Setting this will group this activity's grade in the gradebook with other activities in the same category, allowing for category calculations.

1.1.4.3. Viewing an eFolio Submission

Viewing an eFolio assignment submission is the same as viewing any of the core Moodle assignment types. The teacher clicks on the link to the assignment in the course and then on the View X submitted assignments link in the upper right-hand corner of the page. A page like below will be displayed:

From here, the teacher clicks on the View submitted eFolio page... link to the right of the submission they would like to view.

Open in new window
It is recommended that that the teacher open this in a new window if they want to grade the submission at the same time.

The teacher will be signed into the institution's eFolio site and provided a view of the page that the student has created in response to this assignment. HTML and images will be displayed inline while files will have links for the teacher to download the file.

1.1.4.4. Grading an eFolio Assignment

Viewing an eFolio assignment submission is the same as viewing any of the core Moodle assignment types. The teacher clicks on the link to the assignment in the course and then on the View X submitted assignments link in the upper right-hand corner of the page. A page like below will be displayed:

From the View Submission page, the teacher clicks on the Grade link to the right of the submission that they would like to grade.

The grade page has three core components:

  • Grade: The grade or scale value that you are assigning to this submission
  • Final Grade: Depending on the grade type, this is what the final grade is based on (how the grade is calculated for the assignment)
  • Comment: In the comment box, you can add any comments on the submission to assist the student in understanding why they were given the grade they were given

Outcomes that are applied to the assignment will display below the Final grade. Some assignments will include an upload field where the teacher can upload a response file with comments. This is for upload assignment types.

1.2. Page Menu

1.2.1. Overview

The Page Menu activity is used only in the Flexpage course format to display navigational elements either in the drop-down header at the top of the page or within a block on the page. The Page Menu activity is very flexible and highly useful for helping teachers create different course structures with easy navigation within a Flexpage course.

1.2.1.1. Related Features

Flexpage Course Format Manual
Trouble Ticket Block Manual

1.2.2. Teacher Documentation

1.2.2.1. Create a Page Menu

To create a Page Menu activity, perform the following steps:

  1. Click the Turn editing on button.
  2. Click the Manage activities tab.
  3. Select "Page menu" from the Add an activity... drop-down menu.
    Course Add activity with page menu selected
  4. Fill in the general settings.
  5. Click the Save and display button.

1.2.2.2. Activity Settings

1.2.2.2.1. General

  • Name: The name of the page menu that will be displayed when editing is turned on and in the Manage Activities tab
  • Menu display style: This setting determines how the page menu will be displayed when added to a page.
    • List - Each link is displayed as a line like a left-hand navigation block. Sub menus are displayed indented to the right and below the parent page with an arrow pointing down to the sub menus.
    • Drop down - Each link in the menu is displayed as a drop-down list. Selecting an item in the list brings the user to that link. Sub pages are displayed as a second drop-down list below the first one.
  • Display name: This setting determines if the activity's name is displayed when added to a Flexpage.
  • Use as tab: If enabled, the page menu will display in the top tab bar for the Flexpage course.
  • Tab order: This determines the order in which this page menu is displayed when multiple page menus are used. The farthest left is 0. This does not work with the order for top menu tabs.
1.2.2.2.2. Common Module Settings

  • Group Mode: This setting determines the display properties to users within groups.
    • No Groups: All users see the same activities and responses to activities.
    • Separate Groups: Users can only respond to and view responses of users who are in their group
    • Visible Groups: Users can view all users' responses but can only respond to responses of users in their group.
  • Visibility: Determines if the activity is displayed to students or not within the course.
  • ID Number: Setting this provides an identifier for calculations within the grade book.
  • Grade Category: Setting this will group this activity's grade in the gradebook with other activities in the same category, allowing for category calculations.

1.2.2.3. Adding Menu Items

When viewing a Page Menu activity after initially creating it, you will see the screen below, which informs you that page menu is empty.

Page menu activities initial edit page.

Click the Edit tab in order to add, update or delete links from the page menu. The Edit tab displays all existing links in the menu. Initially, there are no links, with a "Link type" column displaying the type of link, an "Actions" column that enables moving, updating and deleting links, and a "Rendered" column that displays what that specific menu will look like when displayed.

Edit page menu items page

Below the visual representation of the current menu, there are four areas that allow the addition of four different types of menu links:

  1. Link to a URL
  2. Link to module/activity
  3. Link to a Flexpage
  4. Link to a trouble ticket

This interface allows one of each type of link to be added to a menu at one time. Fill out each area and click the Add link button to add the links.

1.2.2.3.1. Link Menu Item

A page menu allows the teacher to add static links to any URL (HTTP, HTTPS, FTP, mailto, etc.) that can be added to an HTML page. To add a link, enter the information for the Link name and Link URL fields.

create new link interface

  • Link Name: The name displayed in the page menu for the URL
  • Link URL: The URL the user is sent to after clicking on the link. This follows the rules of a normal HTML link. Use the full URL and mailto to have the link open an e-mail composition window to allow the user to send an e-mail to an external e-mail address.
1.2.2.3.2. Module Menu Item

The page menu allows a teacher to link a menu to an activity. This is most useful for surveys, forums and wikis where the instructor is looking to get feedback on a regular basis.

create new link to an activity in the course interface

  • Add Module: This list is the same as the list in Manage Activities and will create a link to the activity. The name of the link will be the name of that activity.
1.2.2.3.3. Format Page Item

The most common link added to a page menu is a format page, or Flexpage. The Page Menu activity was designed to easily create a navigational interface for the student to access the various pages in a Flexpage course. Adding a page with sub pages will display the sub pages in the page menu when the user is accessing the parent page or one of the sub pages. Only sub pages that have the page setting Publish set to "yes" and Display in Page menu set to "yes" will display in the page menu.

create a new link to a flexpage interface

  • Add Format Page: Select one of the pages from the list of pages displayed in the drop-down menu. Only pages that have the page setting Publish set to "yes" and Display in Page menu set to "yes" will display in the drop-down menu.
1.2.2.3.4. Trouble Ticket Menu Item

The page menu allows a teacher to create a menu link that links to a new trouble ticket submission form with a specific subject. All of the settings for the trouble ticket, except the subject, are taken from the site default settings. This is generally the most useful when creating a generic support trouble ticket, or a "Contact Us" trouble ticket.

create a new link to a trouble ticket interface

  • Trouble Ticket Link Name: The name of the link that appears in the page menu for the trouble ticket
  • Trouble Ticket Subject: The subject of the trouble ticket. This pre-populates the subject field of a trouble ticket.

1.2.2.4. View a Menu

1.2.2.5. Page Menu as Tabs

When a page menu is displayed as a tab, the menu links are displayed in an AJAX drop-down menu format with sub pages being fly-out menus to the right. Each page menu is a tab at the top bar.

Example page menu in a top tab in a flex page course

Express allows page menus that are displayed as tabs to be displayed in a location other than the top of the page. For this reason, disregard the word "top" in the page menu interface when referring to tabs.

The site administrator determines if Express's menus override page menus as the tabs for the course. If your page menus are not displaying for the course, please contact your site administrator to verify Express's settings.

1.2.2.6. Page Menu as a List in a Flexpage

To display a menu as a list on the Flexpage, add the Page Menu activity to the page using the Add Existing Activity drop-down menu. The menu links will then display as rows in the block with sub pages displaying below the parent page.

Example page menu as a list in a block on a flex page course

1.2.2.7. Page Menu as a Drop-down in a Flexpage

To display a menu as a drop-down menu on the Flexpage, add the Page Menu activity to the page using the Add Existing Activity drop-down menu. The menu links will then display as options in a drop-down menu in the block. Sub pages will display as options in a separate drop-down menu below the first, with each set of sub pages getting their own drop-down menu. Selecting a link from any of the displayed drop-down menus will cause the page to refresh and the menu link to load.

Example page menu as a series of drop-downs in a block on a flex page course

1.2.2.8. Page Menus and Flexpage Locking

Page menus work with Flexpage's page locking feature. Pages that have a page lock on them will display with a lock icon to the left of them.

Example page menu with a locked page menu item

If a page had a lock but the user has met the requirements for the lock to be removed, then the link will display without a lock icon. This means that pages that have been unlocked will display the same way as pages that never had a lock. When a student clicks on a page menu link that is locked, then the page lock message will appear informing the user of what steps they need to take to unlock the page.

Example message viewed when clicking on a locked link

1.2.3. Permissions

  • Manage menus: This permission allows the user to manage the page menu, and create, update and delete menu links.
    • Default Permissions
      Role Not Set Allow Prevent Prohibit
      Administrator   X    
      Course Creator   X    
      Teacher   X    
      Non-Editing Teacher   X    
      Student X      
      Guest X      
      Authenticated User X      
  • View menu: This permission allows the user to view the page menu.
    • Default Permissions
      Role Not Set Allow Prevent Prohibit
      Administrator   X    
      Course Creator   X    
      Teacher   X    
      Non-Editing Teacher   X    
      Student   X    
      Guest   X    
      Authenticated User   X    

2. Blocks

2.1. Alfresco Repository

2.1.1. Overview

The Alfresco repository block provides instant access to Alfresco from within Joule via a single sign-on integration. The block also reminds the user what credentials to use if they need to access Alfresco directly.

The Alfresco repository block was originally developed by Moodle Partner Remote-Learner and has been modified by Moodlerooms to work within Joule and the Dell hosting environment.

2.1.1.1. Related Features

2.1.2. User Documentation

The Alfresco Repository block allows each user to access their personal space within Alfresco by clicking on the link within the block.

Alfresco Repository block

Clicking the link will sign the user into Alfresco and display the My Alfresco page.

My Alfresco within Alfresco

2.1.3. Global Settings

  • Link to Embedded WebDAV Client: If not empty, this link will be displayed in the block to allow users to access a custom Web-based WebDAV client.
  • Link to Help Documents: If not empty, this link will be displayed in the block to allow linking to custom help files.

2.2. Collect Block

2.2.1. Overview

The Collect block is used to gather data within a course based on the collectors and data points that the site administrator has set to be collected. These data points are then displayed within the Joule reports block.

2.2.1.1. Site Interface

At the site level, the Collect block displays a link to the settings for the block. However, Moodlerooms recommends that the block is not added to the site level.

2.2.1.2. Course Interface

At the course level, the administrator can see the following links:

  • Collect course data: Clicking this link will execute the data collection cron for the course based on the collectors and data points set in the global settings
  • Global settings: Clicking this link will bring the user back to the site's global settings to enable and disable collectors and data points

2.2.2. Global Settings

The Collect block's administrative settings are used to turn on or off collectors and collection data points. All collectors have two settings in common:

  • Enabled: Turn this data collector on or off. Enabling the collector enables data collection for all courses with the collect block in it.
  • Run data collection every: Set the time interval for when this data collection routine should run. The collector must also be enabled and have at least one data collection point enabled before it will run.

You can also force all collectors to run by clicking on the Force data collection cron to run now link above the General settings section.

2.2.2.1. General Settings

  • Exclude hidden courses: Do not collect data on courses that are not visible. The course itself must be set to hidden and not just its category or parent category.

2.2.2.2. Course

This data collector collects data about courses. Available data points currently include:

  • Grade: Collect the overall course grade information from the course's grade book.

2.2.2.3. Course/User

This data collector collects data about users and their enrolled courses. The users who are included are those with a graded role (these are set and listed in Site Administration block > Grades > General Settings) whose enrolled course(s) have the Collect block added to them. Available data points include:

  • Enrollment end: Record the time when a user is unenrolled from a course. This is collected upon the "role unassigned" event.
  • Enrollment start: Record the time when a user is enrolled into a course. This is collected upon the "role assigned" event.
  • Course grade: Record a user's course grade. This is collected on the cron.
  • Course completion: Record a user's completion percent of a course and the date of completion. This is collected on the cron. The percent complete is based on the number of graded quizzes and assignments in the course. An activity is considered complete when there is a grade in the grade book for a user for that particular activity.
  • View: Record the number of times a user has viewed the course and the date of their last view. This data is based on the Moodle log table.

2.2.2.4. Activity

This data collector collects data about activities within a course. Available data points include:

  • Grade: Collects activity grade information
  • Name: Collects the activity name
  • Sort order: Collects the activity's sort order in a course, which is based on the activity's placement in sections

2.2.2.5. Activity/User

This data collector collects data about users' interactions with course activities. The users included are those with a graded role whose enrolled course(s) have the Collect block added to them. Available data points include:

  • Attempt: Record the number of attempts, graded attempts and the last attempt date for a user in an activity. This is collected on the cron.
  • Grade: Record a user's activity grade information. This is collected on the cron.
  • Post: Record the number of times a user has posted in an activity and the date of their last post. This data is based on the Moodle log table.
  • View: Record the number of times a user has viewed an activity and the date of their last view. This data is based on the Moodle log table.

2.2.2.6. SCORM/Track

The SCORM activity places tracking data in one table with a record for each interaction of an attempt. This data collector normalizes SCORM tracking data for SCORM activities in the course creating on collector record for each attempt on the SCORM activity. Available data points include:

  • Track: Normalizes SCORM tracking data into one table with one record per attempt instead of one per interaction.
Removing the Collect block from a course does not remove its data from the collect tables. Deleting a course, activity or enrollment will remove the data from the Collect tables for the Joule reports.

2.2.3. Permissions

  • Can run course collection: This permission allows the user to execute the collection cron for the course.
    • Default Permissions
      Role Not Set Allow Prevent Prohibit
      Administrator   X    
      Course Creator X      
      Teacher X      
      Student X      
      Guest X      
      Authenticated User X      

2.3. Conduit Block

2.3.1. Managing Conduit Tables

Conduit's data is stored in five tables that can be accessed by the Conduit Edit tab. Under this tab are five sub-tabs:

  • Conduit User: user information
  • Conduit Course: course information
  • Conduit Enroll: enrollment information
  • Conduit Groups: group information
  • Conduit Group Members: group member information

For each sub-tab, one can do the following actions:

  • Add a New Row of Data. Just click on the Add new Conduit User/Course/Enroll buttons, fill out the subsequent form and click on the Save changes button.
  • Edit a Row of Data. Just click on the Edit widget in the row that you wish to edit. Modify the subsequent form and click on the Save changes button.
  • Inline Editing of a Row of Data. If AJAX is enabled, then you can double click a table cell, which will pop up the inline editing box. Make the change and then click the Save button.
  • Delete a Single Row of Data. Just click on the Delete widget in the row that you wish to delete. A confirmation screen will appear to confirm the action.
  • Delete Multiple Rows. Click on the checkbox in the rows you wish to delete. Then, at the bottom of the page, click on the With selected... drop-down and select "Delete." A confirmation screen will appear to confirm the action.
  • Search the Table's Data. Fill out any of the Filter search boxes and click on the Filter button to search the table. Use the Filter's Reset button to clear the filter and view all of the table rows.

2.3.1.1. Filter Conduit Records

Conduit provides filters for all mapped fields in the Conduit Tables tab. These filters are located above the listing of records in the table. Below is a listing of sample filters for the Conduit User table for a site.

To filter the records displayed for the Conduit table, you can perform the following:

  1. Enter a string value for the field to filter on (Ex. enter "conduit1" in the username field)
  2. Click the Filter button

Conduit will then only display records with the value set. Multiple filters can be used to reduce the number of records shown.

2.3.1.2. Add a Record to Conduit

As of Conduit 1.3, administrators can add records to any Conduit table via the Add new Conduit User, Add new Conduit Course, or Add new Conduit Enroll buttons. When adding a record, Conduit only displays the mapped fields as values that can be entered for the new record, similar to the image below:

To add a new record to any Conduit table, follow the steps below:

  1. Click on the Add new button
  2. Enter the information for each field
    Note
    If you leave a field blank, Conduit will use the default value for that field
  3. Click the Save Changes button.

2.3.1.3. Edit a Conduit Record

When editing a Conduit record, you will only see the fields for the record that are mapped in your mapping settings.

To Edit a Conduit Record perform the following steps:

  1. Find the row you wish to edit. You can sort the list of fields by clicking on the header name (in the example below, you could sort by ID, user name, last name or any of the gray heading links). You may also use the filters to filter the records. See Filter Conduit Records for more information.
  2. Click the edit icon.
  3. Edit any of the data columns as necessary. Identifier fields for the table will not be editable, except for the user table.
  4. Click Save Changes to commit the changes back to the external database, or click Cancel to cancel all changes.

Conduit also provides the ability to directly edit cells in a report when using the AJAX view. To directly edit a record in a table, you can perform the following steps:

  1. Double click on the cell you want to edit
  2. Edit the text within
  3. Click the Save button
As of Conduit 1.5 a Site administrator can manual edit the value in the user key field (username, email, idnumber). The changes to this fields value will be propagated through out the system.

2.3.1.4. Delete a Database Row

You can completely remove data from the external database via two methods: deleting individually or in bulk.

WARNING
There will be no confirmation for either of these delete methods, so be absolutely sure you wish to delete these records before clicking.

To Delete Individual Rows:

  1. Locate the row you wish to delete
  2. Click on the red X icon (this is the delete button)
  3. Confirm Yes to delete. After a successful deletion, you will see a green message saying "Rows deleted successfully."

To Bulk Delete:

  1. Check the checkbox(es) next to each record you wish to delete or click the Select All link.
  2. From the With selected... drop down menu, choose "Delete."
  3. Confirm Yes to delete. After a successful deletion, you will see a green message saying "Rows deleted successfully."

2.3.2. Conduit Reports

2.3.2.1. Report View Types

Conduit reports, as well as the Conduit table views, come in two different views: basic and standard (AJAX). By default, Conduit uses the standard view to provide the quickest response and most features. However, if the standard view is causing problems, a user can always switch to the basic view and the problem should be alleviated.

2.3.2.1.1. Standard (AJAX) View

The standard view of a report or table renders the data using AJAX. For Conduit table views, this allows direct editing of the information from within the cell by double clicking on the cell. Furthermore, sorting will load data into the report without reloading the page.

2.3.2.1.2. Basic HTML View

The basic HTML view displays all data in an HTML table for processing. Sorting will cause the page to refresh in this view type. It is recommended that the basic HTML view is used when using a screen reader.

2.3.2.1.3. Changing Views

To change your report view, click on the Basic HTML or Standard links at the bottom of the reports as in the image below:

Once you have clicked the desired link, the page will refresh and all reports will display in this view for the rest of your session.

2.3.2.2. Log Report

Conduit produces reports that display the processing details of every action requested of Conduit and any errors that occur. A transaction log is recorded for each manual modification, and file or Web services request that Conduit has processed for each Conduit service:

  1. user
  2. course
  3. enroll
  4. group
  5. group members
2.3.2.2.1. Accessing the Logs
  1. First, log in with an administrator account.
  2. Go to the Conduit block on the site homepage and click the Reports link.
  3. You are now on the transaction overview page, where each transaction lists the transaction details shown in the image below.
    You can filter the results by the transaction name (e.g. course.csv, user.csv), and by date. Turn on the advanced settings to filter by the transaction start time or completed time.

    Further, each detail heading can be clicked to sort the transactions according to that item. For example, you can sort the list by "Status" so that all of the "failed" transactions appear at the top.

    • View Logs Icon: Magnifying glass icon to view transaction log details
    • Transactions: The number of transactions processed by Conduit for Conduit's tables and Moodle for this request
    • Transaction Name: CSV file processed by Conduit
    • Transaction Type: Type of plug-in processed (e.g. "file/csv" or "webservice/soap")
    • Status: Status of processing the file – either "Ok" or "Failed"
    • Time Started: The time the data source (file/csv) was consumed
    • Time Completed: The time the data source (file/csv) was completed

2.3.2.2.2. Viewing Log Transactions

To access greater information about the actual actions taken for each transaction in Conduit and in Moodle, you will need to view the detailed record for the transaction. To view the transaction log, follow these steps:

  1. Click the magnifying glass icon next to the desired transaction to view the logs.
  2. This takes you to a screen that lists each action processed by the Conduit with the following populated fields:
    • Severity: Severity of any error during processing individual record
    • Log Message: Short message of the action taken and information on any error that occurred when importing the file to Conduit
    • Time Created: Time the action was completed
  3. Click the Back button to return to the "View All Transactions" overview. Here you can delete older log records in order to keep your overview organized.
2.3.2.2.3. Filtering Transaction Report/Log

Transaction and transaction log filtering works much the same as the other filter in Conduit. In the filter area of the screen, select the values you wish to filter by and then click the Filter button. The records listed will then be filtered by the values entered or selected.

You can filter by the following fields in the transactions report:

  • Transaction Name
  • Transaction Type
  • Exclude Empty Transactions
  • Time Started
  • Time Completed

You can filter by the following fields in the transaction logs report:

  • Log Message
  • Severity
  • Source

2.3.2.2.4. Deleting Transaction logs

In order to reduce the number of log records kept in the system, it is recommended that you delete older logs. To delete old log records manually, follow the these steps:

  1. Select the checkboxes next to the transactions you wish to delete or alternatively click Select All.
  2. Choose "Delete" from the With Selected... drop down menu.
  3. A message will appear asking you to confirm that you want to delete these transaction logs. Click Yes.
2.3.2.2.5. Transaction Error Messages

Each section below documents the errors for that area of Conduit. Variable information is denoted by < > and will be replaced with the value of that information at the time the error is logged. Some variables will be determined by the Conduit settings for the course, user and enrollment identifiers.

2.3.2.2.5.1. General
Error Description
Moodle Conduit cron cannot run now because Conduit cron is currently running, trying again next cron interval The Moodle administrative cron that runs Conduit sync every 45 minutes has failed because Conduit is processing a file already.
Conduit cron cannot run now because the Moodle cron is currently running, trying again next cron interval Conduit was unable to process the files at this time because the Moodle administrative Conduit cron is already syncing the information in the Conduit tables with Moodle.
The file <location to the file> is empty Conduit thinks that the file uploaded is blank, either there are no mapped fields or the sftp failed and the file hand no records.
2.3.2.2.5.2. Course
Error Description
Could not create new course <idnumber or shortname> = <value for idnumber or shortname> Conduit could not create a course with the id number, usually this is a database error.
Failed to update course with id = <record_id> Conduit could not update a course with the id number, usually this is a database error.
Failed to delete course (<idnumber or shortname> = <value for idnumber or shortname>) Conduit could not delete a course with the id number, usually this is a database error.
Parent (<idnumber or shortname> = <value for idnumber or shortname>) is not a metacourse, assignment failed The parent course is not a metacourse and as such the assignment of a course as a child to it failed.
Failed to assigned parent (<idnumber or shortname> = <value for idnumber or shortname>) to course (<idnumber or shortname> = <value for idnumber or shortname>) Conduit failed to assign the parent to the course being created, this is usually a database error.
Failed to assign parents (<idnumber or shortname> = <value for idnumber or shortname>). Parents do not exist. Conduit failed to assign parents to the course because the parent courses do not exist.
Failed to removed parent (<idnumber or shortname> = <value for idnumber or shortname>) from course (<idnumber or shortname> = <value for idnumber or shortname>) Conduit failed to remove the parent from a child course, this is usually a database error.
Could not create the new category: <category name> Conduit could not create the new category, usually this is a database error.
Failed to restore course with id: <fromcourse_id> into course with id <tocourse_id> because backup has failed once already. Conduit uses one backup for a source course in course templating. If that backup file reports and error once then Conduit uses this error to report that it will not repeat using a backup that fails to restore.
Failed to restore course with id = <fromcourse_id> into course with id = <tocourse_id> because import failed. Error string: Moodle reported a restore error when restoring a course from a nother course using course templating
Failed to backup course with id = <courseid>. Error string returned from backup: Moodle reported a backup error when Conduit attempted to backup the course
Failed to create auto-archive directory (SITEFILES/backupdata/autoarchive) for course (<idnumber or shortname>= <value for idnumber or shortname>). Skipping deletion! Conduit failed to create the directory stucture for the backup of the course before deletion when auto archive is on. This means it will skip deleting the course.
Failed to auto-archive course (<idnumber or shortname>= <value for idnumber or shortname>). Skipping deletion! Conduit failed to backup the course before deletion when auto archive is set and it is skipping deleting the course.
Failed to move archive of course (<idnumber or shortname>= <value for idnumber or shortname>). Skipping deletion! Conduit failed to move the backup of the course to the correct directory and will skip deleting the course because there is no viable backup file.
2.3.2.2.5.3. User
Error Description
Failed to revived count accounts Conduit failed to retrieve a count of the user accoutns, usually this is a datbase error
Failed to insert user with username = <username> Conduit was unable to insert the user with the username
Failed to update user with username = <username><userid> and id = Conduit was unable to update the user with username and id
Failed to deleted user with username = <username><userid> and id = Conduit was unable to deelte the user with the username
Failed to suspended user with username = <username> and id = <userid> Conduit was unable to suspend the user with the username
Failed to update custom profile data (field shortname = <profile_fieldname> and username = <username>) Conduit was unable to update the user's customer profile field, the profile field may have been deleted or changed names.
Failed to insert custom profile data (field shortname = <profile_fieldname> and username = <username>) Conduit was unable to insert the custopm profile value for the user, the profile field may have been deleted or changed names.
Moodle user could not be found, but should already exist for Conduit user with username = '<username>' This happens on Moodle cron, user sync. Generally, this occurs when MySQL thinks the Conduit and Moodle user names are equal but PHP does not. Ensure that the two user names are exactly the same. Common errors are changes in case or extra white spaces around the user name
The username can only contain alphabetical letters or numbers: <username> The admin variable extendedusernamechars is turned off, which disallows special characters in user names
Missing username, user creation ignored! When adding a user, the user name must be set
2.3.2.2.5.4. Enrollment
Error Description
Failed to assigned role (<shortname or fullname> = <value for shortname or fullname>) to user (<username, idnumber, or email> = <value for username, idnumber, or email>) in course (<shortname, idnumber, or fullname> = <value for shortname, idnumber, or fullname>) The user was not enrolled into the course.
Failed to remove role (<shortname or fullname> = <value for shortname or fullname>) from user (<username, idnumber, or email> = <value for username, idnumber, or email>) in course (<shortname, idnumber, or fullname> = <value for shortname, idnumber, or fullname>) The user was not unenrolled from the course.
Failed to assigned role (<shortname or fullname> = <value for shortname or fullname>) to user (<username, idnumber, or email> = <value for username, idnumber, or email>) in user (<username, idnumber, or email> = <value for username, idnumber, or email>) The user was not enrolled as a parent role for the user.
Failed to remove role (<shortname or fullname> = <value for shortname or fullname>) from user (<username, idnumber, or email> = <value for username, idnumber, or email>) in user (<username, idnumber, or email> = <value for username, idnumber, or email>) The user was not unenrolled from the courseas a parent role for the user
2.3.2.2.5.5. Groups
Error Description
Failed to create new group name = <group_name> and course ID = <courseid> the group was not created for the course
Failed to update group name = <group_name> and course ID = <courseid> The group was not updated for the course
Failed to delete group name = <group_name> and course ID = <courseid> The group was not deleted from the course
2.3.2.2.5.6. Group Members
Error Description
Failed to add new group member course <shortname, idnumber, or fullname> = <value for shortname, idnumber, or fullname> user <username, idnumber, or email> = <value for username, idnumber, or email> group name = <group_name> Conduit failed to add the user to the group as a member.
Failed to remove group member course <shortname, idnumber, or fullname> = <value for shortname, idnumber, or fullname> user <username, idnumber, or email> = <value for username, idnumber, or email> group name = <group_name> Conduit failed to remove the user to the group as a member.
2.3.2.2.6. Transaction Warning Messages

Each section below documents the warnings for that area of Conduit. Variable information is denoted by < > and will be replaced with the value of that information at the time the warning is logged. Some variables will be determined by the Conduit settings for the course, user and enrollment identifiers.

2.3.2.2.6.1. Course
Warning Description
Category passed was a number and it does not match with any category records in Moodle's database: <category_name> The category that was sent to conduit was a number and not a name, and the id doesn't exist in the Joule database of categories.
Failed to delete enrollments for deleted course (<idnumber or shortname>= <value for idnumber or shortname>) Conduit was unable to delete the user enrollments for a course that was deleted.
Failed to delete groups for deleted course (<idnumber or shortname>= <value for idnumber or shortname>) Conduit was unable to delete the groups for a course that was deleted.
2.3.2.2.6.2. User
Warning Description
Failed to delete enrollments for deleted user with username = <username> and id = <user_id> Conduit failed to delete the user's enrollments in a course for the user with the user name with the id
Failed to delete group memberships for deleted user with username = <username> and id = <user_id> The user was not deleted from all of the groups for course.
2.3.2.2.6.3. Enrollment
Warning Description
Invalid enrollment (id = $invalid->id, user = <invalid_user>, course = <invalid_course>, role = <invalid_role>) The enrollment was invalid due to the course, user or role not existing.
2.3.2.2.6.4. Groups
Warning Description
Failed to delete group members for group name = <group_name> and course ID = <courseid> The group member was not deleted from the group in the course

2.3.2.3. Related Logs

The related log is designed to assist administrators in finding all transactions for a given user, course, enrollment, group or group member. This provides administrators with a view into all of the Conduit actions that have been processed on the given user, course, enrollment, group or group member along with what date the transaction was processed.

2.3.2.3.1. Filter Related Logs

Filtering fields for related logs depend on the Conduit table selected. The common fields are:

  • Log Message
  • Severity
  • Source
  • Time created

The Conduit table-specific fields are:

  • username (user, enroll, group members tables)
  • shortname (course, enroll, group, group members tables)
  • moodleid (enroll table)

2.3.2.3.2. Exporting Related logs

The Related logs report can be exported in CSV and Excel formats. This report will export data that matches the filter settings. To export the reports, click on the Export drop down and select the file format you want to export to. A save dialog will then appear based on your browser.

2.3.2.4. Grades Report

The grades report is designed to display course total, manual, category and manual grades (depending on the grade's Web services settings) for all users (in Conduit enrollments or another method) in all courses with the Collect block in it. The grade report can be accessed through the Conduit Reports tab > Grades sub-tab.

Note
The Grades report doesn't display data in a column if the data is the same as the previous record. However, when the grade book report is downloaded, the data will be in the record.
Note
The Grades report requires that the Collect block be configured to collect grade data and that the block is added to all courses that grade data is to be collected for. For more information about the Collect block, review [Collect Block Manual].
2.3.2.4.1. Filtering Grades Report

The Grades report can be filtered on the following fields:

  • User
  • Course
  • Grade item type
  • Time modified

The user and course fields have typeahead filters, which show a list of possible matches as a user types - they can even search multiple fields, such as a user's name and e-mail address, at the same time.

2.3.2.4.2. Exporting Grades Reports

The Grades report can also be exported in CSV, Excel, ODS and Text formats. The Grades report will export data that matches the filter settings. To export the reports, click on the Export drop down and select the format you want to download. A save dialog will then appear based on your browser.

2.3.3. Installation

In order for Conduit to fully function, configuration must first take place.

Conduit currently functions with the following file formats and services:

  • Uploaded CSV or XML files
  • RESTful Web Services XML files

To set up Conduit, you must:

  1. Configure the Conduit General Settings for users, courses and enrollments
  2. Map your CSV or XML column headings/data fields to the Conduit fields in the Settings > Mappings tab. Optionally you can download the example files as a template in this location too.
  3. If using file upload, you will define the name and location of your files in the Settings > Files tab.
  4. If using RESTful Web Services, define your password, whether or not you're using HTTPS, any IP restrictions and what grade data is captured in the Settings > Web services tab.

To configure Conduit, you must first add the Conduit block to your site page. To do this, follow these steps:

  1. Log in to your Moodle instance with a site-level admin account.
  2. Go to the site homepage and click the Turn Editing On button.
  3. Add the Conduit block via the Add block drop down. This will display the Conduit site-level administrator block.
  4. Click on the Settings link in the Conduit block.

2.3.4. Global Settings

2.3.4.1. General Settings

2.3.4.1.1. Database Settings

The Database area of the general settings configures the database location and connection that Conduit uses to create its tables. This is usually configured by a Moodlerooms employee and uses the Moodle database.

  • Use Moodle's Database: Conduit uses the Moodle database settings instead of the settings below
  • DB Host: provided by Moodlerooms
  • DB Username: provided by Moodlerooms
  • DB Password: provided by Moodlerooms
  • DB Name: provided by Moodlerooms
2.3.4.1.2. Cron Settings
  • Cron Enabled: This setting determines if the Conduit block should run during Moodle's cron or not. If enabled, the cron will perform a full synchronization of the Conduit's external tables to Moodle's tables.
  • Hide lock message: This option will suppress the logging of cron lock error messages. Example error: "Moodle UIB cron cannot run now because the UIB cron is currently running."
  • Remove logs: This configuration helps to manage the size of the Conduit logs. Set whether to delete or archive the logs and then how old the log should be before it is deleted or archived.
2.3.4.1.3. E-mail Settings

This group of options controls Conduit e-mail notifications of incoming transactions. You can configure what types of transactions to be notified about, which admins are e-mailed and if you would like to add an attachment to the e-mail of all the transaction logs.

  • Transactions: This setting determines what types of transactions cause an e-mail to be sent to the e-mail addresses in the Sent to setting. Options are:
    • None - No transactions are e-mailed
    • File and Web services - Only file and Web services transactions are e-mailed -- the administrative cron transactions are ignored
    • Non-empty - Only transactions where there is a transaction are sent for file, Web services and administrative cron
    • Errors and Warning - transactions that have warnings and errors are e-mailed
    • Errors Only - Only transactions with errors are e-mailed
    • All - All transaction files are sent to the e-mail addresses including files, Web services, and administrative cron, regardless of state
  • Send to: What users and e-mail addresses transactions should be e-mailed to
  • Attachment: The transaction records will be attached as a file instead of in the body of the message if this is set. Options are:
    • None - No file is attached to the e-mails sent
    • CSV - Attach the transaction report as a CSV file
    • Excel - Attach the transaction report as an XLS file
2.3.4.1.4. User Settings
  • User ID: The mapping field to use to link the user's record between Conduit and Moodle. The options are:
    • username
    • idnumber
    • email
  • When external is removed: Specify if you want to "Keep," "Suspend," or completely "Delete" the Moodle account when you use the "Remove" action for a user. Only suspended users are automatically revived if they reappear in your submitted CSV, XML or Web services files.
  • Password hash: This setting informs Conduit what type of password to expect in the CSV or XML files or the Web services request. The options are:
    • MD5 hash
    • Plain text
  • Create password: If the password type is set to internal, then this setting determines if a unique password is created and e-mailed to the user's e-mail address in the external database.
  • Create password if it is: Adding a value to this field causes Moodle to only create a password for those users that have their password set to the value. For example: "changeme" will cause all users with the password "changeme" to have a unique password created and e-mailed to them. Leave this blank if you want to change all users' passwords when their account is first created.
  • Force password change: This setting determines if the user is forced to change their password upon their first log in.
  • Update all user accounts: If set to "Yes," Conduit will update all users regardless of the authentication type set.
2.3.4.1.5. Course Settings
  • Course ID: short name or ID number - The name of the field to use as the course ID in the external table and in Moodle's
  • Auto-Create: Leave this set to "Yes" to have Conduit create your courses in Moodle
  • Auto-Update: If set to "Yes," Moodle will automatically update any settings that exist in Conduit that are set differently inside Moodle
  • Auto-Delete: If set to "Yes," Moodle will automatically delete any courses that you associate with the "Remove" action in Conduit
  • Auto-Archive: If setting is "Yes," then:
    • When a course is deleted by Conduit, the course will be automatically backed up prior to deletion
    • Course is backed up and the backup is moved to SITEFILES/backupdata/autoarchive/
    • All errors are logged and, upon error, course is not deleted
    • Backup output is logged
    • The archive is logged
  • Default category: The default category for auto-created courses that don't have a defined category
  • Auto-create category: If courses are automatically created and they belong to a category that doesn't yet exist in Moodle, those categories can be created automatically if you select "Yes"
  • Category Separator: Leave this empty if you don't want to use subcategories in your external database. Otherwise, specify the character you are using as the category separator. You need to specify the "path" of the subcategory in the category field as the names of the categories that are separated by the category separator. For example, if we use '/' as the separator, we should have something like category1/category2 (i.e. category2 is inside category1, which is a top level category)
  • Parent Separator: If a course has multiple parent courses, then add a separator value here. For example, if you enter '/', then you can use parent1/parent2 to assign two parents to a course
  • Default template: Auto-created courses can copy their settings from a template course. Enter the shortname of the template course here.
  • Restore: This setting determines if Conduit course templating feature is being used. Options are:
    • No
    • Restore from backup - Set this to use the course files backupdata/template directory to store a copy of the course. If a backup, using the default backup file name, is stored in the backupdata/template directory, the content in this course will be used for the course restore for the "Restore template" setting. If no backup is found in the backupdata/template directory, then a new backup will automatically be generated and permanently stored there. The backup file can be manually created using the backup process and then moving the file to backupdata/template directory.
    • Restore current version - Set this if you want to back up and then restore the live or current version of the course that matches either the default template or a course's mapped template into auto-created courses.
2.3.4.1.6. Enrollment Settings
  • Moodle ID Course field: Select the field to use for identifying the target course for course enrollments. You can choose from "shortname" or "idnumber."
  • Moodle ID User field: Select the field to use for identifying the target user for user enrollments. You can choose from "username," "idnumber" or "email."
  • User field: Select the field to use for identifying the user for enrollment. You can choose from "username," "idnumber" or "email."
  • Role field: The name of the field used for identifying the role for enrollment. Choose "shortname" or "name."
  • Enroll into hidden courses: Allow enrollments into courses that are not visible to students
  • Allow unenroll: If you select "Yes" to enable, then users can be unenrolled from courses. Most common reason for an unenrollment would be if a user's enrollment entry was removed from the external table.
2.3.4.1.7. Groups Settings
  • Course field: Select the field to use for identifying the course for enrollment. You can choose from the "shortname" or "idnumber."
  • Auto-create groups: This option will automatically create course groups that do not exist in Moodle, but are present in the Conduit group table. Otherwise, new Conduit group records will be ignored.
  • Auto-update groups: This option will automatically update course groups in Moodle that match updated records in Conduit's group table. Otherwise, updated Conduit group records will be ignored.
  • Auto-delete groups: This option will delete matching groups in Moodle if the group record in Conduit is marked to be deleted. Otherwise, the groups deleted in Conduit will be ignored.
2.3.4.1.8. Group Members Settings
  • Course field: Select the field to use for identifying the course for enrollment. You can choose from "shortname" or "idnumber."
  • User field: Select the field to use for identifying the user for enrollment. You can choose from "username," "idnumber" or "email."
  • Auto-assign members: This option will automatically create course group members that do not exist in Moodle, but are present in the Conduit group members table. Otherwise, new Conduit group member records will be ignored.
  • Auto-remove members: This option will delete matching group members in Moodle if the group member record in Conduit is marked to be deleted. Otherwise, group member deletes in Conduit will be ignored.

2.3.4.2. Mapping Data Fields

The next step is to configure the data field mappings between your CSV or XML files and Conduit. You "map" a field in Moodle by telling it what sort of nomenclature your CSV file is using for column headers (or XML tags for the Web services).

For instance, if you use the term "User" instead of "Username," then you would define this for the Username field. Moodle can then map the action in the export file to the corresponding field in Moodle. It is important for action headings to be in lowercase.

To Map the Export Data Fields:

  1. Click on the Mappings link under the Conduit Settings tab.
  2. Define the mappings between your export and Moodle's Conduit.
  3. If you are starting out with a blank CSV or XML file, get a head start by downloading the template based on these mappings in the "Download example mappings" option.
  4. Don't forget to click the Save changes button when you have finished mapping your fields.

Each area on the settings page is associated with three different functions in Moodle. For CSV files, the mappings you provide are your column headings. For XML files, these are your tags. Each of the fields marked with an asterisk * are required for Conduit to work. All of the others are completely optional and will vary according to your SIS/CRM/HR/etc. system and/or organizational needs.

If your export does not have specific fields defined already, Moodlerooms recommends that you use the same value as the field name on the settings page. For example, the Username field would have the value "username."

However, if you do have specific fields defined as the column headers in your CSV file or the tags in your XML, you'll want to enter those. For example, if your CSV file contains the heading "account name" for the user name you want created in Moodle, then enter "account name" in the Username field in the "User table mappings" section of the form.

2.3.4.2.1. User Table Mapping

The user table mappings affect the auth.csv or auth.xml file by determining what the column headings or mapping tag value atribute should be.

There are three options here for updating user profile information, depending on if you'd like to use Moodle or Conduit as the primary place for changes made to the profile field:

  • Default: Several of the field mappings now have a default field. When Conduit adds a new user to Moodle and does not have a value for a field, it will use the entered default value.
  • Update Moodle Every Sync: This will update the user's Moodle profile based on changes made in Conduit. Updates will be made anytime the cron is run or your file is uploaded.
  • Update Conduit: This will take changes made using Moodle's edit profile interface and update Conduit with those changes.

The following are the mappable fields with their descriptions and accepted values:

  • Username: This is a required field
  • Auth: This is the type of authentication that the user is expected to use when they log in. This is typically used if you are planning to use another authentication plug-in other than external database, such as LDAP. The possible values for this field include: cas, db, email, fc, imap, ldap, manual, mnet, nntp, nologin, none, pam, pop3, radius, shibboleth or upload. If you have a custom authentication plug-in, this could be in the list of values. External database is used by default if no value is passed.
  • Mnethostid: Moodle network host ID – usually not set unless you know your site will be using Moodle networking. If you are, refer to the Moodle networking documentation.
  • Password: This is the user's password. Set this to "changeme" if you want an external database to generate a password for the user and e-mail it to them. Otherwise, this can be a plain text, MD5 hash or SHA hash.
  • Idnumber: The ID number for the user, such as student ID, SSN number (not recommended) or any other value your organization uses to track unique users
  • Firstname: User's first name
  • Lastname: User's last name
  • Email: The user's e-mail address, used by the external database to e-mail a new password
  • Emailstop: This is whether the e-mail is enabled or disabled. The values are 0 for enabled and 1 for disabled.
  • Icq: The user's ICQ number
  • Skype: The user's Skype account name
  • Yahoo: The user's Yahoo account name
  • Aim: The user's AIM account name
  • Msn: The user's MSN account name
  • Phone1: The user's main phone number
  • Phone2: The user's secondary (i.e. mobile phone) number
  • Institution: The institution the user attends – can be used for other things as desired
  • Department: The department the user is a part of
  • Address: The street address for the user
  • City: City the user lives in
  • Country: These are the same values used when determining the country in a user's profile using the Conduit Mapping User Table.
    Conduit Value Country
    AX Åland Islands
    AF Afghanistan
    AL Albania
    DZ Algeria
    AS American Samoa
    AD Andorra
    AO Angola
    AI Anguilla
    AQ Antarctica
    AG Antigua And Barbuda
    AR Argentina
    AM Armenia
    AW Aruba
    AU Australia
    AT Austria
    AZ Azerbaijan
    BS Bahamas
    BH Bahrain
    BD Bangladesh
    BB Barbados
    BY Belarus
    BE Belgium
    BZ Belize
    BJ Benin
    BM Bermuda
    BT Bhutan
    BO Bolivia
    BA Bosnia And Herzegovina
    BW Botswana
    BV Bouvet Island
    BR Brazil
    IO British Indian Ocean Territory
    BN Brunei Darussalam
    BG Bulgaria
    BF Burkina Faso
    BI Burundi
    CI Côte D'Ivoirev
    KH Cambodia
    CM Cameroon
    CA Canada
    CV Cape Verde
    KY Cayman Islands
    CF Central African Republic
    TD Chad
    CL Chile
    CN China
    CX Christmas Island
    CC Cocos (Keeling) Islands
    CO Colombia
    KM Comoros
    CG Congo
    CD Congo, The Democratic Republic Of The
    CK Cook Islands
    CR Costa Rica
    HR Croatia
    CU Cuba
    CY Cyprus
    CZ Czech Republic
    DK Denmark
    DJ Djibouti
    DM Dominica
    DO Dominican Republic
    EC Ecuador
    EG Egypt
    SV El Salvador
    GQ Equatorial Guinea
    ER Eritrea
    EE Estonia
    ET Ethiopia
    FK Falkland Islands (Malvinas)
    FO Faroe Islands
    FJ Fiji
    FI Finland
    FR France
    GF French Guiana
    PF French Polynesia
    TF French Southern Territories
    GA Gabon
    GM Gambia
    GE Georgia
    DE Germany
    GH Ghana
    GI Gibraltar
    GR Greece
    GL Greenland
    GD Grenada
    GP Guadeloupe
    GU Guam
    GT Guatemala
    GG Guernsey
    GN Guinea
    GW Guinea-Bissau
    GY Guyana
    HT Haiti
    HM Heard Island And Mcdonald Islands
    VA Holy See (Vatican City State)
    HN Honduras
    HK Hong Kong
    HU Hungary
    IS Iceland
    IN India
    ID Indonesia
    IR Iran, Islamic Republic Of
    IQ Iraq
    IE Ireland
    IM Isle Of Man
    IL Israel
    IT Italy
    JM Jamaica
    JP Japan
    JE Jersey
    JO Jordan
    KZ Kazakhstan
    KE Kenya
    KI Kiribati
    KP Korea, Democratic People's Republic Of
    KR Korea, Republic Of
    KW Kuwait
    KG Kyrgyzstan
    LA Lao People's Democratic Republic
    LV Latvia
    LB Lebanon
    LS Lesotho
    LR Liberia
    LY Libyan Arab Jamahiriya
    LI Liechtenstein
    LT Lithuania
    LU Luxembourg
    MO Macao
    MK Macedonia, The Former Yugoslav Republic Of
    MG Madagascar
    MW Malawi
    MY Malaysia
    MV Maldives
    ML Mali
    MT Malta
    MH Marshall Islands
    MQ Martinique
    MR Mauritania
    MU Mauritius
    YT Mayotte
    MX Mexico
    FM Micronesia, Federated States Of
    MD Moldova, Republic Of
    MC Monaco
    MN Mongolia
    ME Montenegro
    MS Montserrat
    MA Morocco
    MZ Mozambique
    MM Myanmar
    NA Namibia
    NR Nauru
    NP Nepal
    NL Netherlands
    AN Netherlands Antilles
    NC New Caledonia
    NZ New Zealand
    NI Nicaragua
    NE Niger
    NG Nigeria
    NU Niue
    NF Norfolk Island
    MP Northern Mariana Islands
    NO Norway
    OM Oman
    PK Pakistan
    PW Palau
    PS Palestinian Territory, Occupied
    PA Panama
    PG Papua New Guinea
    PY Paraguay
    PE Peru
    PH Philippines
    PN Pitcairn
    PL Poland
    PT Portugal
    PR Puerto Rico
    QA Qatar
    RE Réunion
    RO Romania
    RU Russian Federation
    RW Rwanda
    BL Saint Barthélemy
    SH Saint Helena
    KN Saint Kitts And Nevis
    LC Saint Lucia
    MF Saint Martin
    PM Saint Pierre And Miquelon
    VC Saint Vincent And The Grenadines
    WS Samoa
    SM San Marino
    ST Sao Tome And Principe
    SA Saudi Arabia
    SN Senegal
    RS Serbia
    SC Seychelles
    SL Sierra Leone
    SG Singapore
    SK Slovakia
    SI Slovenia
    SB Solomon Islands
    SO Somalia
    ZA South Africa
    GS South Georgia And The South Sandwich Islands
    ES Spain
    LK Sri Lanka
    SD Sudan
    SR Suriname
    SJ Svalbard And Jan Mayen
    SZ Swaziland
    SE Sweden
    CH Switzerland
    SY Syrian Arab Republic
    TW Taiwan, Province Of China
    TJ Tajikistan
    TZ Tanzania, United Republic Of
    TH Thailand
    TL Timor-Leste
    TG Togo
    TK Tokelau
    TO Tonga
    TT Trinidad And Tobago
    TN Tunisia
    TR Turkey
    TM Turkmenistan
    TC Turks And Caicos Islands
    TV Tuvalu
    UG Uganda
    UA Ukraine
    AE United Arab Emirates
    GB United Kingdom
    US United States
    UM United States Minor Outlying Islands
    UY Uruguay
    UZ Uzbekistan
    VU Vanuatu
    VE Venezuela
    VN Viet Nam
    VG Virgin Islands, British
    VI Virgin Islands, U.S.
    WF Wallis And Futuna
    EH Western Sahara
    YE Yemen
    ZM Zambia
    ZW Zimbabwe
  • Lang: The user's language to display Moodle string in. This is associated with the language installed on the site, which is usually a language code. If a language pack is installed on the site, these are the acceptable language codes to use.
    Conduit Value Language
    af_utf8 Afrikaans (af)
    ar_utf8 arabic (ar)
    be_utf8 Belarusian (be)
    bg_utf8 Bulgarian (bg)
    bn_utf8 Bengali (bn)
    bs_utf8 Bosnian (bs)
    ca_utf8 Catalan (ca)
    cs_utf8 Czech (cs)
    cy_utf8 Welsh (cy)
    da_utf8 Danish (da)
    de_du_utf8 German - Du (de_du)
    de_utf8 German (de)
    el_utf8 Greek (el)
    en_us_utf8 English (en_us)
    en_utf8 English (en)
    es_ar_utf8 Spanish - Argentina (es_ar)
    es_es_utf8 Spanish - España (es_es)
    es_mx_utf8 Spanish - Mexico (es_mx)
    es_utf8 Spanish - Internacional (es)
    et_utf8 Estonian (et)
    eu_utf8 Basque (eu)
    fa_utf8 Persian (fa)
    fil_utf8 Filipino (fil)
    fi_utf8 Finnish (fi)
    fr_ca_utf8 French - Canada (fr_ca)
    fr_utf8 French (fr)
    ga_utf8 Gaelic (ga)
    gl_utf8 Gallego (gl)
    gu_utf8 Gujarati (gu)
    he_utf8 Hebrew (he)
    hi_utf8 Hindi (hi)
    hr_utf8 Croatian (hr)
    hu_utf8 Hungarian (hu)
    hy_utf8 Armenian (hy)
    id_utf8 Indonesian (id)
    is_utf8 Icelandic (is)
    it_utf8 Italian (it)
    ja_utf8 Japanese (ja)
    ka_utf8 Georgian (ka)
    kk_utf8 Kaeakwa (kk)
    km_utf8 Khmer (km)
    kn_utf8 Kannada (kn)
    ko_utf8 Korean (ko)
    la_utf8 Latin (la)
    lo_utf8 Lao (lo)
    lt_utf8 Lithuanian (lt)
    lv_utf8 Latvian (lv)
    mi_tn_utf8 Maori - Tainui (mi_tn)
    mi_wwow_utf8 Maori - Waikato (mi_wwow)
    mk_utf8 Macedonian (mk)
    ml_utf8 Malayalam (ml)
    mn_utf8 Mongolian (mn)
    ms_utf8 Malaysian (ms)
    nl_utf8 Dutch (nl)
    nn_utf8 Nynorsk (nn)
    no_gr_utf8 Norwegian (no_gr)
    no_utf8 Norwegian(no)
    pl_utf8 Polish (pl)
    pt_br_utf8 Portuguese - Brasil (pt_br)
    pt_utf8 Portuguese - Portugal (pt)
    ro_utf8 Romanian (ro)
    ru_utf8 Russian (ru)
    si_utf8 Sinhala (si)
    sk_utf8 Slovak (sk)
    sl_utf8 Slovenian (sl)
    sm_utf8 Samoan (sm)
    so_utf8 Somali (so)
    sq_utf8 Albanian (sq)
    sr_cr_bo_utf8 Serbian (sr_cr_bo)
    sr_cr_utf8 Serbian(sr_cr)
    sr_lt_utf8 Serbian (sr_lt)
    sv_utf8 Swedish (sv)
    ta_lk_utf8 Tamil - Sri Lanka (ta_lk)
    ta_utf8 Tamil (ta)
    th_utf8 Thai (th)
    tl_utf8 Tagalog (tl)
    to_utf8 Tongan (to)
    tr_utf8 Turkish(tr)
    uk_utf8 Ukrainian (uk)
    uz_utf8 Uzbek (uz)
    vi_utf8 Vietnamese (vi)
    zh_cn_utf8 Chinese (zh_cn)
    zh_tw_utf8 Chinese (zh_tw)
  • Theme: This is the short name of the theme that the user will use. This is only used if you allow user themes in the site administration.
  • Timezone: This is the user's time zone code. These are the same values used when determining the time zone in a user's profile when using the Conduit Mapping User Table.
    Conduit Value Timezone Name
    -13.0 UTC-13
    -12.5 UTC-12.5
    -12.0 UTC-12
    -11.5 UTC-11.5
    -11.0 UTC-11
    -10.5 UTC-10.5
    -10.0 UTC-10
    -9.5 UTC-9.5
    -9.0 UTC-9
    -8.5 UTC-8.5
    -8.0 UTC-8
    -7.5 UTC-7.5
    -7.0 UTC-7
    -6.5 UTC-6.5
    -6.0 UTC-6
    -5.5 UTC-5.5
    -5.0 UTC-5
    -4.5 UTC-4.5
    -4.0 UTC-4
    -3.5 UTC-3.5
    -3.0 UTC-3
    -2.5 UTC-2.5
    -2.0 UTC-2
    -1.5 UTC-1.5
    -1.0 UTC-1
    -0.5 UTC-0.5
    0.0 UTC
    0.5 UTC+0.5
    1.0 UTC+1
    1.5 UTC+1.5
    2.0 UTC+2
    2.5 UTC+2.5
    3.0 UTC+3
    3.5 UTC+3.5
    4.0 UTC+4
    4.5 UTC+4.5
    5.0 UTC+5
    5.5 UTC+5.5
    6.0 UTC+6
    6.5 UTC+6.5
    7.0 UTC+7
    7.5 UTC+7.5
    8.0 UTC+8
    8.5 UTC+8.5
    9.0 UTC+9
    9.5 UTC+9.5
    10.0 UTC+10
    10.5 UTC+10.5
    11.0 UTC+11
    11.5 UTC+11.5
    12.0 UTC+12
    12.5 UTC+12.5
    13.0 UTC+13
    99 server time zone
  • Picture: The image used for the user
  • Url: A URL that the user wants to be seen in their profile
  • Description: A description of the user – this can include HTML
  • Mailformat: This is how the user chooses to receive e-mails. The valid values are:
    Conduit Value Mail Format
    0 Plain text
    1 HTML
  • Maildigest: This determines if the user receives e-mails in the form of digests from forums. The valid values are:
    Conduit Value Mail Digest
    0 No digest (single e-mail per forum post)
    1 Complete (daily e-mail with full posts)
    2 Subjects (daily e-mail with subjects only)
  • Maildisplay: This is whether the user's e-mail is displayed or not. The valid values are:
    Conduit Value Mail Display
    0 Hide my e-mail address from everyone
    1 Allow everyone to see my e-mail address
    2 Allow only other course members to see my e-mail address
  • Htmleditor: This is whether the user uses the HTML editor when adding text to text areas. The valid values are:
    Conduit Value Editor Value
    0 Use standard Web forms
    1 Use HTML editor
  • Ajax: This is whether the user uses advanced JavaScript options on pages or not. The valid values are:
    Conduit Value Course Format
    0 No (use basic Web features)
    1 Yes (use advanced Web features)
  • Autosubscribe: This is if the user is automatically subscribed to a forum. The valid values are:
    Conduit Value Subscription Options
    1 Yes (when I post, subscribe to that forum)
    0 No (don't automatically subscribe to forums)
  • Trackforums: This is whether the user tracks the number of unread and read forum posts when viewing the forum. The valid values are:
    Conduit Value Forum Track
    0 No (don't keep track of unread posts)
    1 Yes (highlight new posts)
  • Imagealt: The alt text to describe the user's picture
  • Screenreader: This is whether the user uses a screen reader or not. The valid values are 0 for no and 1 for yes.
TIP: Download Example Mappings
Use this to get a template to base your CSV or XML files on. It will populate the file for you with all your appropriate custom headings.
2.3.4.2.1.1. Custom profile fields

Conduit allows for the creation and update of Moodle's custom profile fields. When a custom profile is created in Moodle, it will be displayed at the bottom of the "User Mapping" area under the Screenreader field.

Custom profile fields have all the extra information that a profile field will have except that you cannot specify a default value. You will need to instead use the Moodle default value in the profile field interface that Moodle provides.

2.3.4.2.2. Course Table Mapping

The course table mappings affect the course.csv or course.xml file by determining what the column headings or mapping tag value atribute should be. There are three options here for updating course information, depending on if you'd like to use Moodle or Conduit as the primary source of authority.

  • Default: Several of the field mappings now have a default field. When Conduit adds a new course to Moodle and does not have a value for a field, it will use the entered default value.
  • Update Moodle every sync: This will update the course settings based on changes made in Conduit. Updates will be made anytime the cron is run or your file is uploaded.
  • Update Conduit: This will take changes made using Moodle's course settings interface and update Conduit with those changes.

The following are the mappable fields with their descriptions and accepted values:

  • Shortname: The short name for the course – this must be unique for each course and is a required field
  • Parent: This is the short name of the parent course in a child-parent relationship. This field is required if you would like to create courses that are children of a meta course.
  • Category: The category(s) that the course is in. These should have the same separator as the external database configuration in the next section and not be a comma.
  • Password: The password for the course to allow a user to self enroll in a course
  • Fullname: The course's full name
  • Idnumber: The ID number for the course
  • Summary: The summary for the course. This can be in HTML.
  • Format: The format for the course. The valid values are below plus any custom course formats your site is using:
    Conduit Value Course Format
    lams LAMS Format
    page Page format
    scorm SCORM format
    social Social format
    topics Topics format
    weeks Weekly format
    weekscss Weekly format - CSS/No tables
    topcol Topic Collapsible format
  • Showgrades: Whether to show the grades to the users or not. Valid values are 0 for no or 1 for yes.
  • Newsitems: The number of news items displayed. This is an integer value between 1 and 10.
  • Teacher: The legacy role of teacher. This usually doesn't have to be mapped.
  • Teachers: The legacy role of teachers. This usually doesn't have to be mapped.
  • Student: The legacy role of student. This usually doesn't have to be mapped.
  • Students: The legacy role of students. This usually doesn't have to be mapped.
  • Guest: Whether guests are allowed to access the course. Valid Values are:
    Conduit Value Guest Access
    0 Not Available to guests
    1 Available to guests without an enrollment key
    2 Available to guests with an enrollment key
  • Startdate: The UNIX time stamp for when the course will start
  • Enrolperiod: The number of days that a student is enrolled in the course. A valid value is 0 or the number of days in seconds. For example, 1 day would be 86400 seconds.
  • Numsections: The number of sections in the topics or weeks format – valid values are between 1 and 52.
  • Marker: Marks the current section that is visible to the student. Used mostly in topics and weeks course format and can be no higher than the number of sections.
  • Maxbytes: The maximum number of bytes a user can upload to a forum in the course. Valid values are:
    Conduit Value Maximum Bytes
    524288000 500MB
    104857600 100MB
    52428800 50MB
    20971520 20MB
    10485760 10MB
    5242880 5MB
    2097152 2MB
    1048576 1MB
    512000 500KB
    102400 100KB
    51200 50KB
    10240 10KB
    0 0 bytes
  • Showreports: Whether or not activity reports are available for each participant that show their activity in the current course.
  • Visible: Whether the course is visible to students or not. You will use 0 for not available to students and 1 for available.
  • Hiddensections: This determines if sections that are hidden are shown collapsed or completely hidden. Valid values are 0 for shown collapsed and 1 for hidden completely.
  • Groupmode: This determines if groups are to be used in the course. Valid values are:
    Conduit Value Moodle Group Mode
    0 No groups
    1 Separate groups
    2 Visible groups
  • Groupmodeforce: This determines if groups are forced in the course. Values are 0 for no and 1 for yes.
  • Defaultgroupingid: Default group that a user is assigned to if the course has groups set up.
  • Lang: This determines if the language for the course is forced. This follows the same languages as the user table mapping and depends on what language packs are installed on the site.
    Conduit Value Language
    af_utf8 Afrikaans (af)
    ar_utf8 arabic (ar)
    be_utf8 Belarusian (be)
    bg_utf8 Bulgarian (bg)
    bn_utf8 Bengali (bn)
    bs_utf8 Bosnian (bs)
    ca_utf8 Catalan (ca)
    cs_utf8 Czech (cs)
    cy_utf8 Welsh (cy)
    da_utf8 Danish (da)
    de_du_utf8 German - Du (de_du)
    de_utf8 German (de)
    el_utf8 Greek (el)
    en_us_utf8 English (en_us)
    en_utf8 English (en)
    es_ar_utf8 Spanish - Argentina (es_ar)
    es_es_utf8 Spanish - España (es_es)
    es_mx_utf8 Spanish - Mexico (es_mx)
    es_utf8 Spanish - Internacional (es)
    et_utf8 Estonian (et)
    eu_utf8 Basque (eu)
    fa_utf8 Persian (fa)
    fil_utf8 Filipino (fil)
    fi_utf8 Finnish (fi)
    fr_ca_utf8 French - Canada (fr_ca)
    fr_utf8 French (fr)
    ga_utf8 Gaelic (ga)
    gl_utf8 Gallego (gl)
    gu_utf8 Gujarati (gu)
    he_utf8 Hebrew (he)
    hi_utf8 Hindi (hi)
    hr_utf8 Croatian (hr)
    hu_utf8 Hungarian (hu)
    hy_utf8 Armenian (hy)
    id_utf8 Indonesian (id)
    is_utf8 Icelandic (is)
    it_utf8 Italian (it)
    ja_utf8 Japanese (ja)
    ka_utf8 Georgian (ka)
    kk_utf8 Kaeakwa (kk)
    km_utf8 Khmer (km)
    kn_utf8 Kannada (kn)
    ko_utf8 Korean (ko)
    la_utf8 Latin (la)
    lo_utf8 Lao (lo)
    lt_utf8 Lithuanian (lt)
    lv_utf8 Latvian (lv)
    mi_tn_utf8 Maori - Tainui (mi_tn)
    mi_wwow_utf8 Maori - Waikato (mi_wwow)
    mk_utf8 Macedonian (mk)
    ml_utf8 Malayalam (ml)
    mn_utf8 Mongolian (mn)
    ms_utf8 Malaysian (ms)
    nl_utf8 Dutch (nl)
    nn_utf8 Nynorsk (nn)
    no_gr_utf8 Norwegian (no_gr)
    no_utf8 Norwegian(no)
    pl_utf8 Polish (pl)
    pt_br_utf8 Portuguese - Brasil (pt_br)
    pt_utf8 Portuguese - Portugal (pt)
    ro_utf8 Romanian (ro)
    ru_utf8 Russian (ru)
    si_utf8 Sinhala (si)
    sk_utf8 Slovak (sk)
    sl_utf8 Slovenian (sl)
    sm_utf8 Samoan (sm)
    so_utf8 Somali (so)
    sq_utf8 Albanian (sq)
    sr_cr_bo_utf8 Serbian (sr_cr_bo)
    sr_cr_utf8 Serbian(sr_cr)
    sr_lt_utf8 Serbian (sr_lt)
    sv_utf8 Swedish (sv)
    ta_lk_utf8 Tamil - Sri Lanka (ta_lk)
    ta_utf8 Tamil (ta)
    th_utf8 Thai (th)
    tl_utf8 Tagalog (tl)
    to_utf8 Tongan (to)
    tr_utf8 Turkish(tr)
    uk_utf8 Ukrainian (uk)
    uz_utf8 Uzbek (uz)
    vi_utf8 Vietnamese (vi)
    zh_cn_utf8 Chinese (zh_cn)
    zh_tw_utf8 Chinese (zh_tw)
  • Theme: This determines if a theme is forced for the course. It follows the same valid values as the user mapping theme and is dependent on the themes installed on the site.
  • Cost: The cost of the course. This is only used if enrol is set to an enrollment plug-in that uses cost.
  • Metacourse: This determines if the course to be created is a meta course or not. Valid values are 0 for no and 1 for yes.
  • Currency: The currency for the cost of the course. These values are used when mapping the Currency field in the "Course Table Mapping" area of your Conduit configuration.
    Conduit Value Currency
    AFA Afghanistan Afghani
    ALL Albanian Lek
    DZD Algerian Dinar
    AON Angolan New Kwanza
    ARA Argentinian Nuevo Peso
    AWG Aruban Florin
    AUD Australian Dollar
    BSD Bahamian Dollar
    BHD Bahraini Dinar
    BDT Bangladeshi Taka
    BBD Barbados Dollar
    BZD Belize Dollar
    BMD Bermudian Dollar
    BTN Bhutan Ngultrum
    BOB Bolivian Boliviano
    BWP Botswanian Pula
    BRR Brazilian Cruzeiro Real
    GBP British Pound
    BND Brunei Dollar
    BGL Bulgarian Lev
    BIF Burundi Franc
    KHR Cambodian Riel
    CAD Canadian Dollar
    KYD Cayman Islands Dollar
    CLP Chilean Peso
    CLF Chilean Unidades de Fomento
    COP Colombian Peso
    KMF Comoros Franc
    CRC Costa Rican Colon
    CUP Cuban Peso
    CYP Cyprus Pound
    CZK Czech Koruna
    DKK Danish Krone
    DJF Djibouti Franc
    DOP Dominican Peso
    TPE East Timor Escudo
    EGP Egyptian Pound
    SVC El Salvador Colon
    CVE Escudo Caboverdiano
    ETB Ethiopian Birr
    EUR Euro
    FKP Falkland Islands Pound
    FJD Fiji Dollar
    GMD Gambian Dalasi
    GHC Ghanaian Cedi
    GIP Gibraltar Pound
    GTQ Guatemalan Quetzal
    GNF Guinea Franc
    GWP Guinea-Bissau Peso
    GYD Guyanan Dollar
    HTG Haitian Gourde
    HNL Honduran Lempira
    HKD Hong Kong Dollar
    HUF Hungarian Forint
    ISK Iceland Krona
    INR Indian Rupee
    IDR Indonesian Rupiah
    IRR Iranian Rial
    IQD Iraqi Dinar
    ILS Israeli Shekel
    JMD Jamaican Dollar
    JPY Japanese Yen
    JOD Jordanian Dinar
    KES Kenyan Schilling
    KWD Kuwaiti Dinar
    LAK Lao Kip
    LBP Lebanese Pound
    LSL Lesotho Loti
    LRD Liberian Dollar
    LYD Libyan Dinar
    MOP Macau Pataca
    MGF Malagasy Franc
    MWK Malawi Kwacha
    MYR Malaysian Ringgit
    MVR Maldive Rufiyaa
    MTL Maltese Lira
    MRO Mauritanian Ouguiya
    MUR Mauritius Rupee
    MXN Mexican Peso
    MNT Mongolian Tugrik
    MAD Moroccan Dirham
    MZM Mozambique Metical
    BUK Myanmar Kyat
    NPR Nepalese Rupee
    ANG Netherlands Antillian Guilder
    NZD New Zealand Dollar
    NIO Nicaraguan Cordoba
    NGN Nigerian Naira
    KPW North Korean Won
    NOK Norwegian Kroner
    PEN Nuevo Sol
    OMR Omani Rial
    PKR Pakistan Rupee
    PAB Panamanian Balboa
    PGK Papua New Guinea Kina
    PYG Paraguay Guarani
    PHP Philippine Peso
    PLN Polish New Zloty
    QAR Qatari Rial
    ROL Romanian Leu
    RWF Rwanda Franc
    WST Samoan Tala
    STD Sao Tome and Principe Dobra
    SAR Saudi Arabian Riyal
    CSD Serbian Dinar
    SCR Seychelles Rupee
    SLL Sierra Leone Leone
    SGD Singapore Dollar
    SKK Slovak Koruna
    SBD Solomon Islands Dollar
    SOS Somali Schilling
    ZAR South African Rand
    KRW South Korean Won
    LKR Sri Lanka Rupee
    SHP St. Helena Pound
    SDP Sudanese Pound
    SRG Suriname Guilder
    SZL Swaziland Lilangeni
    SEK Swedish Krona
    CHF Swiss Franc
    SYP Syrian Potmd
    TWD Taiwan Dollar
    TZS Tanzanian Schilling
    THB Thai Bhat
    TOP Tongan Pa'anga
    TTD Trinidad and Tobago Dollar
    TND Tunisian Dinar
    TRL Turkish Lira
    USD US Dollar
    SUR USSR Rouble
    UGS Uganda Shilling
    AED United Arab Emirates Dirham
    UYU Uruguayan New Peso
    VUV Vanuatu Vatu
    VEB Venezualan Bolivar
    VND Vietnamese Dong
    YER Yemeni Riyal
    CNY Yuan (Chinese) Renminbi
    CDZ Zaire New Zaire
    ZMK Zambian Kwacha
    ZWD Zimbabwe Dollar
  • Requested: Whether the course was requested by a student or teacher rather than created by an administrator. Valid values are 0 for no or 1 for yes
  • Restrictmodules: Turns on or off the restriction of modules within the course. Valid values are 0 for restriction off or 1 for restriction on.
  • Expirynotify: Whether to notify students when their enrollment is about to expire. This assumes that the course has an enrollment duration set. Valid values are 0 for no and 1 for yes.
  • Expirythreshold: The number of days before the enrollment ends that the user is notified. This assumes that expirynotify is set to yes or 1.
  • Notifystudents: If set to 1 and expiry notify is set as well, students will receive enrollment expiration notifications. Valid values are 0 for no or 1 for yes.
  • Enrollable: If the course allows self enrollment in the course. Valid values are:
    Conduit Value Moodle Role
    0 No
    1 Yes
    2 Date Range
  • Enrolstartdate: Date when users are allowed to start enrolling in the course. This assumes that the course is enrollable and set to date range. This is a UNIX time stamp.
  • Enrolenddate: Date when the users can no longer enroll themselves in the course. This assumes that the course is enrollable and set to date range. This is a UNIX time stamp.
  • Enrol: The enrollment plug-in that the course is using. By default, this is set to the site default. The valid values for this field depend on the enrollment plug-ins turned on and the order of those plug-ins. 0 is always the site default.
  • Defaultrole: The default role a user has when being added to the course. The default valid values are:
    Conduit Value Moodle Role
    0 Site Default (Student)
    1 Administrator
    2 Course creator
    3 Teacher
    4 Non-editing teacher
    5 Student
    6 Guest
  • Coursetemplate: This field is where you add the short name for the master course. The new course will be created from a backup of this master course
2.3.4.2.3. Enrol Table Mapping

The enrol table mappings affect the enrol.csv or enrol.xml file by determining what the column headings or mapping tag value atribute should be.

The following are the mappable fields with their descriptions and accepted values:

  • Type: This is mapped to identify the type of enrollment coming in. This mapping is optional and if left blank, then it will default to course enrollments. Valid incoming values are "user" and "course" only.
  • Moodleid: This is mapped to the primary identification of the course or user in Moodle. If the type is set to "course", then this is either the short name or the ID number of the course. If the type is set to "user," then this is either the user name, e-mail or ID number of the user.
  • User: This is mapped to the primary identification of the user in Conduit. Usually this is either the user name or the ID number for the user.
  • Role: The short name for the role of the user being enrolled in the course. This field in the export should have a value of the short name for any of the roles on the site. The default role short names are:
    Conduit Value Moodle Fullname
    admin Administrator
    coursecreator Course Creator
    editingteacher Teacher
    teacher Non-Editing Teacher
    student Student
    guest Guest
    user Authenticated User
  • Timestart: A UNIX time stamp for the date and time when the user should be added to the given role
  • Timeend: A UNIX time stamp for the date and time when the user should be removed from the given role
Note
You can map multiple fields in Conduit to one data field in your export. For example, if you want the e-mail and user name to be the same, you could use "e-mail" as the mapping for both fields.
2.3.4.2.4. Groups Table Mappings

The groups table mappings affect the groups.csv or groups.xml file by determining what the column headings or mapping tag value atribute should be.

The following are the mappable fields with their descriptions and accepted values:

  • Course: This is mapped to the primary identification of the course in Conduit. Usually this is either the short name or the ID number of the course.
  • Name: This is mapped to the name of the group
  • Newname: This is used to replace the name column with the new name as the name of the group in Conduit and Moodle
  • Description: This is mapped to the description of the group
  • Enrolmentkey: Enrollment keys allow users to enroll themselves into a course. Usually there is one key for the whole course defined in the course settings. However, if you define a group enrollment key, then not only will entering that key let the user into the course, but it will also automatically make them a member of the specific group.
  • Hidepicture: This determines if the group picture is hidden. Valid values are 0 for visible or 1 for hidden.
2.3.4.2.5. Group Members Table Mappings

The group members table mappings affect the group_members.csv or group_members.xml file by determining what the column headings or mapping tag value atribute should be.

The following are the mappable fields with their descriptions and accepted values:

  • Course: This is mapped to the primary identification of the course in Conduit. Usually this is either the short name or the ID number of the course.
  • User: This is mapped to the primary identification of the user in Conduit. Usually this is either the user name or the ID number for the user.
  • Groupname: This is the name of the group the user is being created in

2.3.4.3. File Location and Names

The File area is where you define the location of your CSV files and optionally customize the names of your CSV files.

  1. Click the File link under the Settings tab.
  2. Enter the absolute file path to the directory that you will SFTP the CSV files to. This should be provided to you by a Moodlerooms employee and will look like "/clients/yoursitename/conduit" - this path may be different according to your customization.
  3. If your CSV files use a different naming structure than the Conduit default (auth.csv, course.csv, enroll.csv), type in the file names you use here.
  4. Lastly, be sure to click Save Changes.
  • File Location: The SFTP directory that Conduit cron looks at for the CSV or XML files to process
  • User file name: The file name that Conduit looks at for user processing
  • Course file name: The file name that Conduit looks at for course processing
  • Enrolment file name: The file name that Conduit looks at for enrollments processing
  • Groups file name: The file name that Conduit looks at for groups processing
  • Group members file name: The file name that Conduit looks at for group members processing

2.4. Course Converter

2.4.1. Overview

The Course Converter block was developed to assist clients in migrating course content from other learning management systems to Moodle and speed up the transition process. The converter currently supports courses from the following learning management systems:

  • Blackboard (versions 6, 7, 8, 9 and 9.1)
  • ANGEL (versions 7.2, 7.3 and 7.4)
  • Desire2Learn
  • WebCT (versions 4 and 6)

2.4.2. How to Export Courses from Your LMS

2.4.2.1. ANGEL

2.4.2.1.1. What Will a Migrated Course Look Like

Angel lessons are converted as Topics formatted courses with sections.

2.4.2.1.2. Content Items Are Converted To
Angel Moodle
Drop Box Advanced Upload Assignment
Assessment Quiz
Form Questionnaire
SCORM SCORM
Folder Label
HTML Label
File Resources (files, links, etc)
Page Resources (files, links, etc)
Link Resources (files, links, etc)
Syllabus Resources (files, links, etc)
Toollink Resources (files, links, etc)
Discussion Forum Forum
Blog Forum
Wiki Wiki
2.4.2.1.3. Question Types Are Converted To
Angel Moodle
Essay Essay
Matching Matching
Multiple Choice Multiple Choice
Multiple Select Multiple Choice
Fill in the bank Embedded Answers (Cloze)
Short Answer Essay
True/False True/False
Algorithmic Calculated
2.4.2.1.4. What Is Not Converted
2.4.2.1.5. How to Export a Course for Conversion
2.4.2.1.5.1. ANGEL 7.2 and 7.3

Use the ANGEL Export Wizard to export the course as an ANGEL Archive.

  1. Log in to ANGEL
  2. Navigate to the course home page
  3. Click on the Manage tab
  4. Click on the Export Wizard link under the Data Management block
  5. Click the Angel Archive link
  6. Click the Export button
  7. Download the export once finished
2.4.2.1.5.2. ANGEL 7.4

Use the ANGEL Export Wizard to export the course as an ANGEL Archive.

  1. Log in to ANGEL
  2. Navigate to the course home page
  3. Click on the Manage tab
  4. Click on the Export Console link under the Data Management block
  5. Click the Angel Format link
  6. Click the Export button
  7. Download the export once finished

2.4.2.2. Blackboard

2.4.2.2.1. What a Migrated Course Will Look Like

Blackboard courses can be converted to a Topics formatted course in Moodle. Blackboard exports organize content into folders, and Moodlerooms converts these folders into a section and label for each folder. The top folder is converted to a Moodle topic.

2.4.2.2.2. Content Items Are Converted To
Blackboard Moodle
Assessment Quiz
Folder Label
Question bank Question bank
File Resources (files, links, etc)
External Link Resources (files, links, etc)
Page Resources (files, links, etc)
Staff Info Resources (files, links, etc)
Discussion Board Forum
Calendar item Event (course)
Drop Box Assignment
Most activities' visibility statuses (hidden or visible) are converted and assigned properly in Moodle.
2.4.2.2.3. Question Types Are Converted To
Blackboard Moodle
Numeric Numerical
Essay Essay
Short Response Essay
Matching Matching
Multiple Answer Multiple Choice (multiple answers allowed)
Multiple Choice Multiple Choice (one answer allowed)
Fill in the bank Short Answer
Fill in the bank Embedded Answers (Cloze)
True/False True/False
2.4.2.2.4. What Is Not Converted
  • File upload question type is not supported in Moodle. It is best if an instructor converts this to an Advanced Assignment.
2.4.2.2.5. How to Export a Course for Conversion
2.4.2.2.5.1. As a Blackboard Course Archive
  1. Log in to the Blackboard site
  2. Navigate to the course
  3. Under the My tab, click the Control Panel link
  4. Under the Course Options area, click the Archive Course link
  5. Click the Export button or download an already created export
  6. Under export, check the checkbox under the select course materials you want to export
  7. Click the submit button
  8. Click the Ok button
  9. Wait for the e-mail to arrive
  10. Click the link to the export
  11. Download the export
2.4.2.2.5.2. As a Blackboard Course Export
  1. Log in to the Blackboard site
  2. Navigate to the course
  3. Under the My tab, click the Control Panel link
  4. Under the Course Options, area click the Export Course link
  5. Click the Export button or download an already created export
  6. Under export, check the checkbox under the select course materials you want to export
  7. Click the Submit button
  8. Click Ok
  9. Wait for the e-mail to arrive
  10. Click the link to the export
  11. Download the export

2.4.2.3. Desire2Learn

2.4.2.3.1. What Will a Migrated Course Look Like

Desire2Learn content modules are converted as topics/sections, aka all Quizzes are under the topic Quizzes.

2.4.2.3.2. Content Items Are Converted to
Desire2Learn Moodle
Survey Quiz
Quiz Quiz
Question Bank Question Bank
Files or other content items Resources (files, links, etc)
Discussion Board Forum
Drop Box Advanced Upload Assignment
2.4.2.3.3. Question Types Are Converted to
Desire2Learn Moodle
Long Answer Essay
Matching Matching
Multiple Choice Multiple Choice
Multiple Select Multiple Choice
Fill in the bank Embedded Answers (Cloze)
Ordering Embedded Answers (Cloze)
Short Answer Embedded Answers (Cloze)
True/False True/False
2.4.2.3.4. What Is Not Converted
  • Question Type Likert
  • Question Type Arithmetic
  • Question Type Significant figures
  • Question Type Multiple Short Answer
2.4.2.3.5. How to Export a Course for Conversion
  1. Log in to the Desire2Learn site
  2. Navigate to the course you want to export
  3. Click the Edit Course button
  4. Click the Import / Export / Copy Components link under the Tools section of the page
  5. Select the Export Components option and check the Include course files in the export package checkbox.
  6. Click the Next button
  7. Check the Select All Components checkbox
  8. Click the Next button
  9. Click the Next button after verifying all settings
  10. The course will begin exporting at this time
  11. Once the export is finished, click the Done button
  12. Click the Click here to download the export ZIP package link
  13. Depending on your browser, select the location locally to download the ZIP file to.

2.4.2.4. WebCT 4

2.4.2.4.1. What Will a Migrated Course Look Like

WebCT 4 content modules are converted as topics/sections. Content module headers/footers are converted to labels and placed in the corresponding topics.

2.4.2.4.2. Content Items are Converted to
Web CT Moodle
Self Test Quiz
Quiz Quiz
Question Bank Question Bank
Image Database Database Activity
Glossary Glossary
Web content Resources (files, links, etc)
Discussion Forum
Calendar Events
Syllabus Resource
Assignment Assignment
Chat Chat
2.4.2.4.3. Question Types Are Converted to
Web CT Moodle
Numerical Calculated
Paragraph Essay
Matching Matching
Multiple Choice Multiple Choice
Short Answer Short Answer
2.4.2.4.4. What Is Not Converted
  • No user information is converted using the batch course conversion tool. For example, discussions and chats are converted, but no user posts (including the instructor’s posts) are converted.
  • Whiteboard does not convert
2.4.2.4.5. How to Export a Course for Conversion

The Moodlerooms WebCT converter expects WebCT courses to be exported via WebCT's "IMS Content Migration Utility" (CMU). This comes bundled with WebCT CE 4.1, and can only be used by an administrator. (For WebCT CE 4.0, the script was only available as a separate download, which is apparently no longer available.)

2.4.3. Administrator Documentation

The Course Converter block can only be added to the site level and can only be used by site administrators to convert course backup files from other learning management systems to Moodle 1.9. The block is separated into two areas:

  • Convert: Used to convert uploaded LMS course backup files to Moodle 1.9
  • Manage Files: Used to upload, download and delete the other LMS course backup files

Block view at the site level

2.4.3.1. Managing Uploaded LMS Backup Files

The Manage files area of the course converter block allows Site administrators to view, upload, download and delete LMS course backup files. The page is separated into two sections. The Upload a file for Converting area is used to upload a new LMS course backup file while the Uploaded files area allows the site administrator to view, download and delete the uploaded LMS course backup files. The Uploaded files area only displays .zip files – all other uploaded files will be ignored.

There are two ways to upload an LMS course backup file to the site. The first is through the Upload a file for converting upload interface. The second is to use an SFTP account from Moodlerooms, which is provided for clients to upload larger than 500 Mb course backups or to upload several course backups at once.

2.4.3.1.1. Uploading a Course Backup

To upload a single LMS course backup file through the Manage files tab of the course converter block, click on the Browse button.

Click the browse button in the upload a file for converting area

Select a file from your computer and click the Open button. Finally, click the Save changes button. The file will be added to the Uploaded files area in alphabetical order.

Clicking the Save changes button of the Manage files page saves all changes on the page. This means any file that is selected for deletion will be deleted, and any file in the File to upload box will be uploaded.
2.4.3.1.2. Upload Course Backups via SFTP

The LMS course backup files can be uploaded to your Joule site in batch or one at a time using your favorite FTP/SFTP program. The following are a few recommended SFTP programs:

First, connect to your SFTP account using the information provided by a Moodlerooms employee. You will initially be placed in a Clients directory. From here, navigate to the /clients/<yoursitename>/block_convert directory, replace the <yoursitename> string with the beginning of the URL for your site provided by Moodlerooms (for example branch.mrooms2.net would use clients/branch/block_convert). This is where you will upload all of your LMS course backup ZIP files and you will see a list of all the files you have uploaded via the Manage files tab's upload interface.

2.4.3.1.3. Downloading a Course Backup

To download a backup file you have already uploaded, click on the link with the name of the file you want to download. A new window will pop up and, depending on your browser settings, the file will start downloading or ask you where you want to save the file.

click the link to download the file

2.4.3.1.4. Deleting a Course Backup

To delete a backup file you have already uploaded, click the checkbox to the right of the file name that you want to delete. Next click the Save changes button.

Click the checkbox to delete the file

The page will reload and a message stating that the file was successfully deleted will appear.

No confirmation screen is shown when deleting a file, so make sure you have a local backup if you are not sure you want to completely delete the file or if you are concerned you will accidentally delete a file.

2.4.3.2. Converting Courses

Once LMS course backup files have been uploaded to the Manage files tab, the site administrator is ready to start converting the LMS course backups to Moodle 1.9 course backups. This is done within the Convert tab. The Convert tab is separated into the three questions that the site administrator needs to answer when determining how they want to convert files. These questions are:

  1. What LMS version are you converting to what Moodle course format? - This is the Select convert and format
  2. What LMS backup files are you converting?
  3. Do you need to intervene in the conversion process?

To answer the first question, select the LMS and version you are converting from in the first drop-down menu of the Convert/Format drop downs.

Select the LMS to be converted from

Based on this selection, you will then select the Moodle 1.9 course format to convert to, Weekly or Topics course format. Next you will move on to select which LMS course backup files to convert. Check the checkbox to the left of each of the LMS course backup files you wish to convert.

Select LMS course backup files to convert

For clients who are uploading files from several LMSs or different versions of an LMS, make sure that the LMS course backup files are named somehow to identify the LMS and version. The Convert tab only allows the selection of one LMS and version to convert from at a time, and the tool will try to convert any file selected, even if it is from a different LMS or an incompatible version.

Need to configure the general settings for the conversation. Below are the general settings for the conversion:

General conversion options

  • Restore into Individual Courses: This option determines if you will be selecting the course for each converted file to be restored into. These options become available in the next step in the conversion process and will disable the Auto-restore and Unattended operation checkboxes.
  • Auto-Restore: This option determines if the Moodle 1.9 course backup files are restored after they have been converted. The restored courses will use the course name based on the backup file name.
    • Into Category - If the Moodle 1.9 course backup files are to be restored, what category will they be restored into?
  • Unattended Operation: Do you want to watch the course conversions and manually click a continue button to start the next conversion, or if you want to have the block automatically start the next LMS backup file to convert, and you can review the logs once all files have been completed? Moodlerooms generally recommends Unattended operation be checked for large batches of courses and it be left unchecked with small batches or when you are retrying a conversion of a file.

Once the course and general options for the converter have been set, click the Convert button. The conversion process will then start, and you will view the progress of each file's conversion on screen. The logs will display differently depending on the LMS that the course backup file is from, but everything being converted will display on screen. Based on the general options chosen, you will progress through one of three scenarios:

2.4.3.2.1. Attended Operation

After a LMS course backup file is converted to a Moodle course backup file and if you didn't check the Auto-Restore option you will see a link to download the Moodle 1.9 course backup file. To the right of the link to the Moodle 1.9 course backup file will be a Restore link. The Restore link can be used to restore the Moodle course backup file to a Moodle course on the site. At the bottom there will be a link to download the log file of the LMS course conversion. Finally there will be a Continue button at the very botton of the page.

Tail end of the on screen display of a single file conversion

If you clicked Auto-Restore, then the course will be automatically restored and you will also see a link to the course that the backup file was restored into.

Final view of a single file after auto restored

Clicking on either file like will download the file locally. Click the Continue button to continue with the next file to be converted. After all files have been converted, a page will appear that displays a link to each Moodle 1.9 course backup with a link to restore the backup file, a link to the the Moodle course on the site the Moodle 1.9 course backup file was restored to, and a link to download the full conversion log for all LMS course backup files converted.

The final page of the process showing the converted files and the log for the entire conversion

Clicking on a link will download the file locally. It is recommended at this time that the site administrator review the log file for any warnings or errors. Clicking the Continue button will return you to the Convert tab to start the process again.

2.4.3.2.2. Restore into Individual Courses Process

After all files have been converted, a page will be displayed that shows a link to each Moodle 1.9 backup file that was created, a link to the right of the file to restore the Moodle 1.9 backup file into a new course (this will open a new window), a text field to enter a target course, and a link to the full log of each conversion.

Final screen after all files have been converted

If you changed your mind about restoring the individual course to specific courses, click the Done button. If you want to continue, type in an existing course full name in the Target Course field to the right of the files you want to restore. This field is an auto-complete field and will display a drop-down menu with a list of courses that match the text you are typing.

Auto complete for target course field

Once you have filled in all of the Target Course fields, click the Convert to Course button to start the restore process. Each course will be automatically restored into the course entered in the Target Course field. In between each restore, a screen will appear displaying the course that was restored and what course it was restored to. At the end of the restore process, a final report will display a page with a link to each Moodle 1.9 course backup, a link to restore the backup file, a link to the course that the file was restored to, and finally a link to download the full conversion log.

Final page of the restore to individual courses

Clicking the Continue button will return you to the Convert tab to start the process again.

2.4.3.2.3. Unattended

After all files have been converted, the restore process for all courses will start. Once all the course backup files have been restored, a page will display with links to each Moodle 1.9 course backup with a link to restore the backup file, a link to the course that the file was restored to, and a link to download the full conversion log.

The final page of the process showing the converted files and the log for the entire conversion

Clicking on the link with the Moodle 1.9 course backup file name will download the Moodle 1.9 course backup file to your local drive. It is recommended at this time that the site administrator review the log file for any warnings or errors. Clicking the Continue button will return you to the Convert tab to start the process again.

2.4.3.3. Managing Converted Files

All Moodle 1.9 backup files and conversion logs are stored in the site's Site files area (found at Site administration block > Front Page > Site files) under the backupdata directory), which is not a public directory.

Site files directory with course backups and conversion logs

From here, you can download a file by clicking on its name. You can restore any course backup here by clicking on the Restore link to the right of the file name. Finally, you can delete any of the files by clicking the checkbox to the left of the file icon for the filename and selecting Delete Completely from the With chosen files... drop-down menu.

2.5. Courses Available to You Block

2.5.1. Overview

The Courses Available to You block was designed to provide an alternative and more flexible solution to list courses within a category or that a student is enrolled in. It was designed to work with Moodlerooms' Flexpage format, where it could be placed in the center column and replace the core Moodle front page course listings. The Courses Available to You block can display courses within a specific category or the whole site, in an AJAX expandable tree format or a static nested list format.

2.5.2. Benefits

The benefits of the Courses Available to You block are:

  • Alternative display of courses and categories
  • Easy AJAX navigation to courses within Flexpage
  • Multiple views into the courses within multiple areas
  • Expanded display options allow the administrator or teacher to determine how they want course information displayed

2.5.3. Usage Scenarios

2.5.3.1. Navigation of Course in Flexpage Format

In this scenario, one block is placed on the page and allows the student or teacher to navigate to all courses they are enrolled in. Changing the title of the block and choosing to make it expandable or not is optional, depending on the site administrator's preference.

2.5.3.2. Display Multiple Course Categories/Programs on a Page

In this scenario, multiple instances of the block are added to a page. The Category Display Start setting is used only to display courses within a specific category or categories. Each block should have a different block title to differentiate the content of the blocks. These blocks can be expandable or not, depending on how the user wants the courses to be displayed.

2.5.4. Teacher Documentation

The Courses Available to You block is mostly used by site administrators to provide users with easy course navigation. This can be used for the same purposes by teachers or program directors. Each instance of the block has its own settings, and multiple blocks can be placed on a page. It is recommended that each block has a different title to help differentiate between the content. The Category Display Start setting for the block can be used to display courses in specific programs or degrees.

2.5.4.1. Block Views

The Use expandable categories setting for the block allows the block to be displayed in multiple views. These views provide flexibility in how the block is used in a course.

2.5.4.1.1. Expandable

The expandable view of the block provides a plus/minus icon for each category or sub category within the category selected. Expanding a category will display all courses within that category depending on the other settings for the block. This provides a quick view of the courses being used.

2.5.4.1.2. Not Expandable

The "not expandable" view of the block displays all categories, sub categories and courses in an expanded format. This provides an overall listing of courses and can be used with course descriptions to provide a course and category view of the courses the student is enrolled in.

2.5.4.2. Block Settings

  • Block Title: Title of the block displayed to the user Default: Courses Available To You
  • Category Display Start: The top category from which to start the display of courses Default: All Categories
  • All classes visible: Should all visible classes be displayed or only classes the current user is enrolled in? Default: No
  • Class Display Name: Which field from the class should be displayed as the class name in the block? Default: Full name
    • Short name - Display the course short name
    • Full name - Display the course full name
  • Use expandable categories: Display categories in an expandable and contractible format Default: Yes
  • Metacourses are visible: Should the block display metacourses or keep them hidden? Default: No
  • Show all Categories: Show all visible categories whether or not the user is enrolled in them Default: No
  • Display the category description: Display the category description below the category name Default: No
  • Show Hidden Categories: Shows all visible classes under hidden categories Default: No
  • Show sub categories: Should sub categories be shown? Default: Yes

2.5.5. Global Settings

  • Block Title: Title of the block displayed to the user Default: Courses Available To You
  • Category Display Start: The top category from which to start the display of courses Default: All Categories
  • All classes visible: Should all visible classes be displayed or only classes the current user is enrolled in? Default: No
  • Class Display Name: Which field from the class should be displayed as the class name in the block? Default: Full name
    • Short name - Display the course short name
    • Full name - Display the course full name
  • Use expandable categories: Display categories in an expandable and contractible format Default: Yes
  • Metacourses are visible: Should the block display metacourses or keep them hidden? Default: No
  • Show all Categories: Show all visible categories whether or not the user is enrolled in them Default: No
  • Display the category description: Display the category description below the category name Default: No
  • Show Hidden Categories: Shows all visible classes under hidden categories Default: No
  • Show sub categories: Should sub categories be shown? Default: Yes

2.6. Express Block

2.6.1. Overview

The Express block and Express theme together make up Express. The Express block is used for the following capabilities at the site, category and course levels:

  • Configure all Express settings (block, theme, menu and template)
  • Create an Express design from an Express template using a predefined set of colors and images
  • Create an Express design from an Express template using custom colors
  • Upload a custom logo for an Express design
  • Upload a custom favorite icon for an Express design
  • Upload an Express design
  • Download and delete Express design backups
  • Add dynamic navigation menus to an Express design
  • Upload and delete Express templates (only at the site level)

This document covers all of the user interface features of Express as part of the Express block. This document does not cover the technical aspects of manually creating an Express design or Express template.

2.6.2. Teacher Documentation

2.6.2.1. Enable the Express Theme

2.6.2.1.1. Express for a Category

If the site theme is something other than Express and your administrator has enable category level themes then you can follow the steps below to switch your category theme to the express theme.

To set the category theme, follow these steps:

  1. Click on Site Administration Block > Courses > Add/edit courses
    Moodle add edit course page
  2. Click on the category you want to see the theme for
  3. Click the Edit this category button
    Edit category screen
  4. Select "express" from the Force theme drop-down menu
    Select Express theme for the category
  5. Click the Save changes button.
2.6.2.1.2. Express for a Course

If the site theme is something other than Express and your administrator has enable course level themes then you can follow the steps below to switch your course theme to the express theme.

To set the course theme, follow these steps:

  1. Navigate to the course
  2. Click on the Settings link under the Administration block
  3. Select "express" in the Force theme drop-down menu
  4. Click the Save changes button

2.6.2.2. Create a Design

The simplest way to create an Express design is to use the Express block's Create a Design tab. This tab is used to create an Express design from an existing Express template. By default, Moodlerooms provides the Joule template to all clients and Site Administrators can add more templates as needed. See Express Template for more information.

Changing an Express design from manual to template and clicking the Save changes button will overwrite an Express design you have imported for the current site, category or course with the Express design created from the template you have selected. The Manage Designs tab allows you to download past designs for the course, category or site. It is highly recommended that, before making changes to your system default design, you first download that design from this tab. Should you run into any problems when creating a new design, the default design can then be uploaded back to the system. See Manage Designs for more information.

To create a simple Express design from a template, add the Express block to your site, category or course, and select the Create a Design link or tab.

Express block with links in a course
or
Create a design tab selected

You will see the screen shown below:

Express create a design tab

Express Theme Warning
If your site, category or course is using a Moodle theme other than the Express theme, you will see this warning in red lettering at the top of the Create a Design tab:

"Your course, category or site theme is not set to Express. The Express block only works with the Express theme.
If you cannot change the site, category or course theme, please contact your administrator and request that the site theme be changed to Express."

If this warning appears, all of your changes will be saved and your design created but not displayed. Please follow the steps for your situation within the Enable Express Theme section of this document.

2.6.2.2.1. Create a Design Settings

Below is a description of each of the fields on the form and their general use within the context of the Express design that you are creating from the Express template you have chosen:

2.6.2.2.1.1. General Design Settings
  • Type of Design: This determines if the Express design being used is created manually and uploaded or created using the Create a Design tab. A warning will appear if you attempt to change the type of design to manual. If you want a manual design, use the Manage Designs tab to upload a design.
  • Design Name: This is the name of the design as it will appear in the export area of the Manage Designs tab. Only one version of a design's backup exists per name. It is recommended that, if you want to differentiate versions of a design, you use different design names.
2.6.2.2.1.2. Logo Settings
These settings are used only if the template selected uses the %CUSTOMIMAGE% design variable.
  • Current Logo: This displays the current logo being used. Not all Express templates and Express designs allow you to change the logo.
  • Upload a Logo: This field allows you to upload a new logo that will replace the logo shown in the Current Logo field.
  • Current Favorite Icon: This displays the current favorite icon being used in the browser's URL bar.
  • Favorite Icon: This field allows you to upload a new favorite icon to replace the image shown in the Current Favorite Icon field.
2.6.2.2.1.3. Template Settings
  • Manage Templates: This is a listing of templates currently installed on the site, along with their variants. From the first drop-down menu, choose a template. Then, from the second drop-down menu, select a variant. Variants typically represent possible color schemes for that template. The preview image will change.
  • Style Preview: This is an image showing you a preview of the variant of the template. This image is not live and may not exist for every template; it is a screen shot provided by the template designer.
2.6.2.2.1.4. General Font Settings
  • Font Family: This is the font family used throughout the template. This text is added to the font family CSS tag. It is recommended to use commonly installed fonts in your designs and templates, as the font will only display correctly if the end user's computer has that font installed. It is also recommended that you add several fonts to the list in order to allow fall backs.
  • Font Size: This is the size of the font used throughout the template. Enter the size and then the extension type.
2.6.2.2.1.5. Customized Font Color Settings

The following settings only apply when the variant type (second drop-down menu next to the Manage Templates drop-down menu) is set to "custom." The effect these fields have on the design depends on how the template was designed. Review the template notes for information provided by the designer regarding the template's use of the different settings. These fields are intended to be used directly in the CSS color: attribute.

The fields represent the following in templates:

  • Body: The default text color of the design.
  • Header:The font or link color in the header div tags.
  • Menu: The font or link color in the Express and Flexpage menus.
  • Menu Highlight: The font or link color in the Express and Flexpage menus when a link is hovered over or currently selected.
  • Navigation/Breadcrumb: The font or link color in the navigation or breadcrumb bar.
  • Block Header: The font color at the top of a block.
  • Block Content: The font color inside a block.
  • Button: The font color of button text.
  • Gradebook Vertical: The font color when the grade book has a vertical selection.
  • Gradebook Horizontal: The font color when the grade book has a horizontal selection.
  • General Link Color: The link color throughout the site.
  • Heading (h1-h6): The h1 through h6 HTML tag font color.
  • Highlight: The font color when something is highlighted or hovered over.
  • Alternate Row: The font or link color when the alternative row background color is used.
  • Footer: The font or link color in the footer of the design.
2.6.2.2.1.6. Custom Background Color Settings
The following settings only apply when the variant type (second drop-down menu next to the Manage Templates drop-down menu) is set to "custom." The effect these fields have on the design depends on how the template was designed. Review the template notes for information provided by the designer regarding the template's use of the different settings.

The fields represent the following in templates:

  • Body: The background color/image in the body HTML tag for the design.
  • Header: The background color/image in the header of the design.
  • Navigation/Breadcrumb: The background color/image in the navigation or breadcrumb in the design.
  • Top Bar: The background color or image behind a bar of color that is printed instead of a menu bar, if menus have not been created on the specific page. This may also be used for the background color or image for the menu's top menu when menus have been added.
  • Menu: The background color/image in the menu drop down for all menu items.
  • Menu Highlight: The background color/image in the menu drop down when the user hovers over a menu item.
  • Page div: The background color/image in the div HTML tag in the ID page.
  • Content div:The background color/image in the div HTML tag in the ID content in the design.
  • Block Header: The background color/image of the heading of all blocks. Sometimes used in templates for other heading backgrounds, such as the topic or weeks outline heading.
  • Block Content: The background color/image of the content within a block. Sometimes used in templates for other block backgrounds, such as the section area in topics or weeks courses.
  • Button: The background color/image of all buttons on the site.
  • Gradebook Vertical:The background color/image of the vertical highlight color in the grade book.
  • Gradebook Horizontal: The background color/image of the horizontal highlight color in the grade book.
  • Alternate Row: The background color/image for areas of Moodle that alternate colors, typically found in tables such as the grade book, log report and other reports.
  • Footer: The background color/image of the footer of the design.

2.6.2.3. Manage Designs

The Manage Designs tab allows you to upload a manually developed Express design or download a ZIP of a design you previously created or uploaded. Any design you upload is expected to conform to the format described in Express Design Technical Manual and to be a ZIP of that structure. The Manage Designs tab is broken into two sections similar to below:

The top section allows you to upload a manually created design. The bottom section displays links to download ZIP files of designs you have named, with options for deleting a ZIP(s).

The Manage Designs tab does not contain links to mPower templates. If you want to access your mPower templates, you will need to navigate to Front Page > Site Files > theme and download the files you need there.
2.6.2.3.1. Upload an Express Design

The top area of the Manage Designs tab allows you to upload a design in ZIP format. To upload a design, you must first have either created a design manually and zipped it up following the directions in Express Design Technical Manual or have downloaded a design ZIP from the Manage Designs tab as explained in Download an Express Design.

Follow the these steps to upload a design:

  1. Assign a name for the design in the Name field. The name must be unique.
  2. Click the Browse button.
  3. Select the ZIP file for the design you want to upload.
  4. Click the Save changes button.

The Express design will be uploaded to your site, category or course and set as the current design. Files that are not allowed in the design structure will not be copied when the design is created. You can verify your design by reviewing the Express Design Technical Manual.

2.6.2.3.2. Download an Express Design

The bottom section of the Manage Designs tab allows you to download backups of each uniquely named design you have created for the site, category or course. To download a design, simply click on the linked name of the design you want to download. Your browser will prompt you to indicate the location in which you wish to save the design. It is highly recommended that, before you make any changes to a design using Express, you first download that design to keep a backup.

2.6.2.3.3. Delete an Express design backup

The bottom section of the Manage Designs tab allows you to select design backups to delete from the site in order to increase storage space.

To delete a design backup, follow these steps:

  1. Select the check box next to the design backup you want to delete. You can select multiple design backups to delete at one time.
  2. Click the Save changes button.

You will see a confirmation message for each design backup to be removed from the system.

Deleting an Express design backup that is set to current will not delete the current design. To delete the current design delete the Express block from the site, category or course.

2.6.2.4. Manage Menus

Express menus are used to display navigational menus in an Express design. Not all designs or templates support menus. The Manage Menus tab will display a red warning if the design that is currently being used does not support Express menus.

For clients using the Flexpage course format, you must select a site setting that determines if the Express menu overwrites the Flexpage menus or vice versa. It is recommended that you do not use Express menus if you are using the Flexpage course format.
The Custom JavaScript block setting must be set to "header" or "footer" for Express menus to work.
Warnings will appear if the Express block has been configured to user the Site menus for all locations or at the site only. A warning will also appear if the current design doesn't have the %PAGETABS% or %EXPRESSMENU% variables in any layout files.

To create a menu:

  1. Enter the menu structure text that is described in Structure to Create Express Menus.
  2. Click the Save changes button.

Express attempts to determine if your menu syntax is correct. If an error is found, you will see a red error message indicating a problem, and your menus will not be saved.

Menu tab screen

2.6.2.4.1. Structure to Create Express Menus

Express menus follow the structure of Moodle 2.0's theme menu item, with one menu item per line, allowing for an infinite number of menus and sub-menus. This structure uses the following fields:

  • level: Denoted by a dash (-) . The menu's title has no dash, and every sub-menu adds a dash. For example, a level 3 menu would have three dashes and requires a menu above it.
  • name: The label used for the menu or link.
  • url: The URL to which the label is linked.
  • target: (optional) What link target is to be used when opening this link. Should be one of the valid options from the target attribute at http://www.w3schools.com/tags/tag_a.asp. This is usually _blank or _self. _self is used as the default.

Express variables, like %MYCOURSESYUI%, can be used within an Express menu, and the variable will be replaced with the dynamic Moodle data.

Fields are separated by a pipe or |. A basic menu with a sub-menu and a sub sub-menu would look like:

Express menu structure
2.6.2.4.2. Example Menu Code:

Below is a robust example of a series of menus, sub-menus and sub sub-menus using all the fields in a menu, as well as the %MYCOURSESYUI% Express variable. If you need help with menus, copy this code directly into your Express menu to use it as a template.

Example Express menu

The example above produces menus like the following:

Example menus displayed in joule

2.6.3. Administrator Documentation

2.6.3.1. Enable the Express Theme

2.6.3.1.1. Express Site-wide

In order to apply an Express design to a site, you must first turn on the Express theme. To turn on the Express theme, log in as a user with Site Administration privileges. Navigate to the Site Administration block > Appearance > Themes > Theme Selector.

!EXPB_V1_theme selection_2011010500.png|alt=Select theme from Site Administration block !

Scroll down to the Express theme on the theme selector page and click the Choose button below the express theme.
Select Express theme

2.6.3.2. Manage Templates

Express comes with the capability to create multiple designs from templates as part of the Create a Design tab. Express also allows site administrators to add their own custom templates that can then be used to create Express designs in the Create a Design tab. The Manage Templates tab is used to upload and delete these templates. Templates uploaded to Express will appear site wide in the Template Settings > Manage Templates area of every Create a Design tab. You can access the Manage Templates tab from the Express block list or the tabs at the top of each form, but only when viewing the Express block at the site level.

The Manage Templates tab provides access to two functions:

  1. Uploading an Express template
  2. Deleting Express templates
2.6.3.2.1. Uploading an Express Template

Once you have developed an Express template, you will want to upload that design for use. To upload an Express template for use:

  1. Click the Browse button.
  2. Select the template ZIP file to upload.
  3. Click the Save changes button. The template will be uploaded, and the ZIP file will be uncompressed.

Any errors in the upload process will result in on-screen alerts. If no errors occurred, you will receive a success alert.

Manage templates screen

2.6.3.2.2. Deleting an Express Template

The bottom section of the Manage Templates tab allows you to select templates to delete from the site in order to increase storage space.

To delete a template:

  1. Select the check box next to the template you wish to delete. You can select multiple templates to delete at one time.
  2. Click the Save changes button.

You will see a confirmation message for each template to be deleted from the system.

2.6.4. Global Settings

Express has several administrative settings that can be configured to provide extra features or performance boosts. To access Express's administrative settings, navigate to Site Administration > Modules > Blocks > Express.

Select Express in the SIte Administration block under blocks

A screen similar to the one shown below is displayed:

Express block global settings

  • Cache Expiration: The expiration period for all files that Express prints expiration headers for, usually just CSS and JavaScript Default: 1 week
  • Use Central Resource System: Used for backwards compatibility with the mPower system that stored files within the Central Resource System. Leave at the default, unless you have CRS files for mPower that have not been converted to Express. This feature will be removed in Joule/Moodle 2.0. Default: No
  • Allow Custom User Profile Fields: This determines if you will be using custom user profile fields in the Express design files. If so, set this to "Yes" and the Express system will match the uppercase version of your custom profile field's shortname (surrounded by percent symbols) with the value in the student's profile field. Note that text areas will not be used due to the possibility of the information in the text area corrupting the theme. Default: No
  • Allow My Courses: If enabled, the variable %MYCOURSES% and %MYCOURSESYUI% will be available to the design. Default: No
  • Allow Custom Icons: Allow custom icons to be used in designs. Default: No
  • Custom JavaScript: This variable determines if custom JavaScript is allowed and, if so, where it is loaded on the page. This must be set for Express menus to work because Express menus store JavaScript to display menus in the same location that an Express design does. Default: No JavaScript
  • Menu Inheritance: This setting determines how Express menus affect other Express menus in Express designs that inherit from a parent. This will also turn off Express menus for a site. Default: All Site
    • Site only - Only the site displays menus
    • All Site - All levels show the site menus
    • Unique - Each level has its own menus
    • Inherit - Courses inherit all parent category and site menus, as do categories
  • Menu override: This setting determines whether the menu system (Flexpage's page menu) or Express should be used if both are present in a course. This only applies if you have purchased Flexpage. Default: Express

2.6.5. Permissions

Express has five capabilities that can be set for any role on the Site Administration > Users > Permissions > Define Roles page. These capabilities are:

By default, Express is configured to prevent all roles except Administrator from accessing any Express feature. A Site Administrator must reconfigure this if the organization wants to allow teachers or program managers to edit their course's Express design.
  • Create Express Template: A user with this capability is able to delete and upload Express templates. This only applies at the site level. This affects the display of the Manage Template tab.
    • Default Permissions
      Role Not Set Allow Prevent Prohibit
      Administrator   X    
      Course Creator     X  
      Teacher     X  
      Non-Editing teacher     X  
      Student     X  
      Guest     X  
      Authenticated User     X  
    • Risks
      • Change Site Configuration
      • XSS: templates can contain JavaScript
  • Create/Edit Express Designs): Users with this capability are allowed to use the Create a Design tab to create an Express design from an Express template.
    • Default Permissions
      Role Not Set Allow Prevent Prohibit
      Administrator   X    
      Course Creator     X  
      Teacher     X  
      Non-Editing teacher     X  
      Student     X  
      Guest     X  
      Authenticated User     X  
    • Risks
      • Change Site Configuration
      • XSS: Express designs can contain JavaScript
  • Edit Express Menus: Users with this capability can edit the Express menus within the context (e.g. site context, category context, course context) by adding and removing links.
    • Default Permissions
      Role Not Set Allow Prevent Prohibit
      Administrator   X    
      Course Creator     X  
      Teacher     X  
      Non-Editing teacher     X  
      Student     X  
      Guest     X  
      Authenticated User     X  
    • Risks
      • Change Site Configuration
      • XSS: Express menus can contain JavaScript
  • Export Express Designs: Users with this capability can download copies of Express designs that have been created.
    • Default Permissions
      Role Not Set Allow Prevent Prohibit
      Administrator   X    
      Course Creator     X  
      Teacher     X  
      Non-Editing teacher     X  
      Student     X  
      Guest     X  
      Authenticated User     X  
  • Import Express designs: Users with this capability can import manually-created Express designs or Express designs that have been previously downloaded.
    • Default Permissions
      Role Not Set Allow Prevent Prohibit
      Administrator   X    
      Course Creator     X  
      Teacher     X  
      Non-Editing teacher     X  
      Student     X  
      Guest     X  
      Authenticated User     X  
    • Risks
      • Change Site Configuration
      • XSS: Express designs can contain JavaScript

2.7. ILP Integration Block

2.7.1. Overview

The Intelligent Learning Platform block is part of Moodlerooms' Datatel integration. The block provides Datatel clients with the ability to set midterm and final grades for a course, send retention alerts, and view the last date of attendance for a student in the course. The midterm and final grades can also be published directly to the Datatel system.

2.7.2. User Documentation

The ILP Integration block provides students with a link back to the Intelligent Learning Platform from the course. Click the Back to Portal link to return to or access the Datatel Portal (WebAdvisor) from the course.

2.7.3. Teacher Documentation

The ILP (Intelligent Learning Platform) Integration block looks like the following to a teacher in a course:

Each link in the block provides the teacher with access to a feature of the Intelligent Learning Platform.

2.7.3.1. Back to Portal

The Back to Portal link provides a direct link back to the Intelligent Learning Platform site collection home page, where users are redirected to their constituency home page. This links displays to students as well.

2.7.3.2. Retention Alert

The Retention Alert page displays a listing of all students with a link that goes to the Contribute Retention Info page in the Intelligent Learning Platform's WebAdvisor.

If a teacher identifies a potential problem based on assignment scores or attendance, the teacher can click that link to contribute retention information.

Note
This feature is available only if you have licensed the optional Student Retention Alert module.

A retention alert is a feature of the Intelligent Learning Platform and is configured and sent through the Intelligent Learning Platform, not Joule.

2.7.3.3. Midterm Grades

The Midterm Grades page allows a teacher to submit up to six midterm grades (depending on the site settings for the block) for each student in the course as well as the student's last date of attendance or if the student has never attended the course, just like with the Last Date of Attendance page.

The Populate with course grade... drop-down menu can be used to automatically populate any of the midterm grades with the current course grade as seen in the Current Grade column. Otherwise, the teacher can manually enter a letter grade in each midterm column for the student. Once the teacher has entered all the data for the students, clicking the Submit Grades button will mark the grades and last date of attendance for import into Datatel Colleague.

Grade Validation
When the teacher clicks Submit Grades, the entered grades are checked against both the Moodle grade letters table and the ILP blocks list of additional grade letters. If a submitted grade is not found in either place, an error message is displayed immediately.

2.7.3.4. Final Grades

The Final Grades page allows a teacher to submit the student's final grade for the course.

The Populate with course grade... drop-down menu can be used to automatically populate any of the midterm grades with the current course grade as seen in the Current Grade column. Otherwise, the teacher can manually enter a letter grade in each midterm column for the student. The Expire Date column is used to set the grade for the student to expire in Colleague. It is recommended that this only be used for incomplete grades. Once the teacher has entered all the data for the students, clicking the Submit Grades button will mark the grades, expire date and last date of attendance for import into Colleague.

Grade Validation
When the teacher clicks the Submit Grades button, the entered grades are checked against both the grade letters table and the list of additional grade letters. If a submitted grade is not found in either place, an error message is displayed immediately.
Locked grades
The site administrator can configure the ILP Integration block to lock the final grades after the teacher has submitted them. If this is configured, the teacher will be unable to change the student's final grade after submission and the Final Grades tab will display the submitted grades to the teacher from then on.

2.7.3.5. Last Date of Attendance

The Last Date of Attendance page displays a list of all students in the course with a field that allows the teacher to enter a last date of attendance for a student or indicate that the student never attended the class. It also displays a link to create a retention alert just like with the Retention Alert page.

2.7.3.5.1. Mark Last Attendance Dates for Import into Colleague

To mark the last attendance dates for import into Colleague, follow these steps:

  1. Add a date in the format required by the site settings for the block (MM/DD/YYYY, DD/MM/YYYY, or YYYY/MM/DD) to the text field in the Last Date of Attendance column or check the checkbox in the Never attended column of the page for each student you wish to submit data for.
  2. Click the Submit LDA button.
Date Format
If the teacher enters the date in a format that doesn't match the site settings for the block, then an error will appear at the top of the page. The error will instruct the teacher as to the proper date format to use.

2.7.3.6. Daily Attendance

The Daily Attendance link goes to an attendance form in WebAdvisor. The behavior depends on whether the Colleague course section uses the positive attendance method for funding accounting, as specified in the Funding Acctg Method field on the Section Financial Info (SFIN) form:

  • If the course does not use positive attendance, the link is to the Attendance Calendar form in WebAdvisor.
  • If the course does use positive attendance, then the link is to a menu in WebAdvisor where the user can access either the Attendance Calendar form or the Attendance Hours form.

2.7.3.7. ST Gradebook

The site administrator can choose to have teachers submit students' grades and last date of attendance in the ST Gradebook in WebAdvisor. If the site administrator has set this feature, then the ILP Integration block will display the ST Gradebook link instead of the Midterm Grades, Final Grades and Date of Last Attendance links.

Once the teacher clicks on the ST Gradebook link, they will be forwarded to WebAdvisor to enter grades and see a screen similar to below:

2.7.4. Global settings

  • Gradebook Application: This setting determines which application is handling the grade reporting. Default: Moodle
    • Moodle
    • ILP ST
  • Retention alert link: This setting determines if a link to the Datatel retention alert will be displayed to the teacher in the course. Default: Yes
  • Daily attendance link: Display the Daily Attendance link? Default: Yes
  • Show last attendance: Display Last Date of Attendance links? Default: Yes
  • Lock Grades: Allow faculty to modify final grades after submission? Default: No
  • Date format: This determines the format of the date for date entry boxes. YYYY represents the four digit year, MM represents the two digit month and DD represents the two digit day. Default: MM/DD/YYYY
    • MM/DD/YYYY
    • DD/MM/YYYY
    • YYYY/MM/DD
  • Category grade cutoff: You can define one or more cutoff dates, after which midterm grades and final grades will no longer be visible in either the ILP integration block or the grading form. A cutoff date is associated with a course category and applies to all courses in that category and its subcategories, unless you define a separate cutoff date for a subcategory.
  • Midterm Grades: Number of midterm grades to display. Default: 1
  • Additional Grade Letters: Enter additional letter grades that can be submitted for mid-term or final grades, separated by commas
  • ILP URL: URL to the ILP Portal site
  • Retention alert process ID: The Datatel retention alert process ID Default: CORE-WBCOS067
  • Attendance process ID: The Datatel attendance process ID Default: ST-WESTS041
  • ST Gradebook process ID: The Datatel ST Gradebook process ID Default: ST-GBS005

2.7.5. Permissions

  • Edit: This permission allows the user to access the grade and retention alert link (if enabled).
    • Default Permissions
      Role Not Set Allow Prevent Prohibit
      Administrator   X    
      Course Creator X      
      Teacher   X    
      Non-Editing Teacher X      
      Student X      
      Guest X      
      Authenticated User X      

2.8. Joule Mobile Block

2.8.1. Overview

Joule Mobile allows for contact information to be shared between users in the Joule site via the Joule Mobile phone application. In the Joule Mobile block, users have the ability to specify which information they would like to share with other users. Administrators can determine what information should be shared with other users by default. This allows the administrator to create an opt-in policy (all contact data is hidden by default and individual users must enable the sharing of contact data), an opt-out policy (all contact data is on by default and the individual user must disable the sharing of contact data), or some contact data is shared by default and other data must be enabled. If users do not share their e-mail address, then they cannot take advantage of the Dubmenow card exchange platform.

2.8.1.1. Related Features

2.8.2. User Documentation

The block is accessible by all users at all levels (site and course) and allows the user to set their own preferences for what contact data is shared with other users within the Joule Mobile phone application. When you view the block, you are provided with a single link called Update preferences:

Once have entered the preferences, you will be presented with the following options that you can set:

  • Share my email?: This preference determines if your e-mail address is displayed when another user accesses your profile through Joule Mobile. If you choose to share your e-mail address, then you can receive cards from fellow students.
  • Share my address?: This preference determines if your address, city and country are displayed when another user accesses your profile through Joule Mobile.
  • Share my phone numbers?: This preference determines if your phone numbers are displayed when another user accesses your profile through Joule Mobile.
  • Share my IM clients?: This preference determines if your ICQ Number, Skype ID, AIM ID, Yahoo ID and MSN ID are displayed when another user accesses your profile through Joule Mobile.

2.8.3. Administrator Documentation

The administrative user interface is different from the instructor or student interface only by adding a link to the block's global settings. An administrator will see the following view of the block:

2.8.4. Global Settings

Joule Mobile's global block settings are used to set the default view permissions for the Joule Mobile phone application for all users on the site as well as the level of course displayed. The global settings are as follows:

  • Share email default: Determines if, by default, the user's e-mail address should be displayed in Joule Mobile. Default: unchecked(No)
  • Share address default: Determines if, by default, the user's address, city and country should be displayed in Joule Mobile. Default: unchecked(No)
  • Share phone numbers default: Determines if, by default, the user's phone numbers should be displayed in Joule Mobile. Default: unchecked(No)
  • Share IM clients default: Determines if, by default, the user's ICQ Number, Skype ID, AIM ID, Yahoo ID and MSN ID should be displayed in Joule Mobile. Default: unchecked(No)
  • Course category depth: When fetching courses for mobile services, limit returned courses to categories of this depth or lower. Additionally, the course will appear underneath the category of the matching depth. Use a depth of zero to include all courses and categories. Use a depth of one or more to dive deeper into sub categories. Default: 0
    • Sample category and course listing:
      • Cat 1
        • Course 1
        • Cat 2
          • Course 2
      • Cat 3
        • Course 3
        • Cat 4
          • Course 4
    • If the course category depth is set to zero, the mobile course listing would look similar to:
      • Cat 1
        • Course 1
        • Course 2
      • Cat 3
        • Course 3
        • Course 4
          **If the course category depth is set to one, the mobile course listing would look similar to:
      • Cat 2
        • Course 2
          • Cat 4
        • Course 4

2.9. Locations Block

2.9.1. Overview

A location signifies a building, meeting place, or point of interest to the institution's users. Administrators are able to use the Locations block to create site-wide locations for an institution. Instructors can then associate meeting times with these locations in a course to set up course study groups, office hours and events for an institution. Users can use the Joule Mobile application to view a location's information in the Maps module as well as find directions to that location. Meeting times are presented to the user in Joule Mobile's Course module's information screen, and from here the user can get directions to the location or view it in the Maps module.

2.9.1.1. Related Features

2.9.2. Teacher Course Interface

Adding the Locations block to a course provides an instructor with access to the meetings interface to create, update and delete meeting times.

Clicking on the Meeting link provides the user with access to a list of currently existing meetings for the course as well as the Add a meeting time tab.

Meeting times are unique to the course and must be associated with a location. An administrator must create a location before a meeting time can be created within a course. Meeting times are displayed to students within the Joule Mobile application's Course module's information screen. Students will be able to get directions to the location from within the Joule Mobile application.

2.9.2.1. Add a Meeting Time

Adding a meeting time to a course consists of completing the form below. A meeting time cannot be created without a location first existing at the site level.

  • Title: (Required) The title of the meeting time, which will be displayed to the students in Joule Mobile on the Course modules information screen. Ex: Office Hours
  • Location: (Required) Select the location that the meeting time is associated with from the drop-down list of all site-wide locations.
  • Hours: The meeting's time and date information as a single line of text. The format of this information is open to however the instructor wants to display this information and will be shown to the student in Joule Mobile on the Course modules information screen. Ex: MWF 3-5 PM
  • Room: The room number or name of the exact meeting area within the location selected, if applicable. Ex: 410A

2.9.2.2. Update a Meeting Time

In order to update a meeting time, the instructor must click on the name of an existing meeting time in the Meeting Times tab. This will bring the instructor to the Add a meeting time screen with all of the fields pre-filled with the meeting time's previously set information.

2.9.2.3. Delete a Meeting Time

To delete a meeting time, the instructor clicks on the delete link to the right of the Room column. There will be no verifications before deleting the meeting time — this action is permanent and instantaneous. As soon as the meeting time is removed from the Locations block, the meeting time will no longer be displayed in the Joule Mobile course information screen.

2.9.3. Administrator Documentation

Adding the Locations block to the site level provides users with the Administrator role with access to view and create locations. The block looks like the image below when added to the site level:

Clicking the Locations link provides the user with a list of all previously created locations. This list will be blank to begin with and a second New Location tab can be used to create a location.

2.9.3.1. Create a Location

Click on the New Location tab to bring up the location creation screen below:

  • Campus: (Required) A textual description of the overall area the location exists in. Institutions may have multiple campuses that users can toggle between within Joule Mobile's Maps module. Ex: Main Campus
  • Category: A text string that allows locations to be grouped together in the main Locations listing screen. Ex: Dorms
  • Location: The name of the location, which will be displayed to the user in the Joule Mobile application and the instructor when creating meeting times. This should be the common name for the location. Ex: Smith Dormitory
  • Description: A description of the location. For example: "Joseph Smith was an exemplary freshman, so the dorms were named in his honor."
  • Address: The street address for the location – used to provide directions.
  • City: The city associated with the location – used to provide directions.
  • State: The state associated with the location, if applicable.
  • Zipcode: The zip code for the location – used to provide directions.
  • Latitude: This field is required for the pin to be displayed in Joule Mobile's Maps module.
  • Longitude: This field is required for the pin to be displayed in Joule Mobile's Maps module.

2.9.3.2. Update a Location

To update an existing location click on the name of the location in the Location column. Modify the fields that need to change and click on the Save changes button.

2.9.3.3. Delete a Location

To delete a location click on the delete link to the right of the location name in the blank column. The location will be deleted without a confirmation page, clicking on the delete link accidentally will cause the location to be deleted.

2.9.4. Global Settings

  • Campus: Default campus name when creating a new location. Default: Main Campus
  • City: Default city name when creating a new location. Default: Empty
  • State: Default state when creating a new location. Default: Empty
  • Zipcode: Default zip code for the city used when creating a new location. Default: Empty
  • Country: Default country code when creating a new location. Default: United States
  • Zipcode Search Priority: This option returns more precise default geographic coordinates on the map when creating a location that is within the United States. Default: Yes

2.9.5. Permissions

  • View and Add Locations (block/locations:viewedit_locations): This permission allows the user to view and add locations for the entire site. Defaults settings are:
    • Defaults
      • Administrator: Allow
      • Course Creator: Not Set
      • Teacher: Prevent
      • Non-editing Teacher: Prevent
      • Student: Prohibit
      • Guest: Not Set
      • Authenticated User: Not Set
  • View and Add Meetings (block/locations:viewedit_meetings): This permission allows the user to view and add meetings to a course. Default settings are:
    • Defaults
      • Administrator: Allow
      • Course Creator: Not Set
      • Teacher: Allow
      • Non-editing Teacher: Allow
      • Student: Prohibit
      • Guest: Not Set
      • Authenticated User: Not Set

2.10. Microsoft Live Services

2.10.1. Overview

The Microsoft Live Services Plug-in for Moodle implements an integration with Windows Live™ Services allowing users to log into courses using their Windows Live ID and display Live Services on a Moodle site. Users can see and create emails and calendar events with Outlook® Live or Windows Live Hotmail®, and access Windows Live Messenger chat, Bing™ search and more within a course.

2.10.2. Administrator Documentation

Log in to a course and navigate to Settings>Site administration>Plugins>Blocks>Microsoft® Live Services.

These settings are required. They allow this Moodle to access the Windows Live™ Services APIs. Before your users can use any Microsoft Live Services Plug-in, you need to register for an Application ID from Microsoft. This Application ID and Secret Key, along with your Moodle's domain name, create a Relying Party Suite (RPS). This allows Microsoft to ensure that users are logging into your Moodle site and allows your users to come back your site after successfully authenticating with their Windows Live ID credentials. Registration takes less than five minutes.

2.10.2.1. Get Windows Live Application ID and Secret Key

To get a Windows Live Application ID:

  1. Visit http://live.azure.com/
  2. Sign in with your Windows Live ID. If you do not have a Windows Live ID, visit http://windows.live.com to get one free.
  3. After signing in, you need to create a new Azure account if you don't have one yet. The Azure account will be associated to your Windows Live ID.
    • Read the Privacy Statement and then click I Agree.
    • After your account is created, click Continue.
    • You do not need an invitation Token. Click Cancel to skip this step.
  4. Select the Live Services tab on the left.
  5. Click New Service on the upper right. You will be redirected to "Create a new service component" page.
  6. Click Live Services: Existing APIs.
  7. Read the terms of use, and then click I Accept.
  8. Provide the following information:
    • Project Label: Enter a descriptive name for your Moodle site. For example, English Department Moodle.
    • Project Description (optional): Enter a longer description for your Moodle site.
    • Domain: Enter the domain of your Moodle site. For example: www.contoso.edu
      The domain name should contain no slashes ("/"). Domain names such as "http://www.contoso.edu" are invalid.
    • Return URL: Enter the Web address of your Moodle site. For example: http://www.contoso.edu
  9. Click Create.
  10. After this step you will get your Application ID and Secret Key. You can edit or delete this service at any time.

Enter your Application ID and Secret Key in the appropriate fields.

2.10.2.2. Outlook Live Preparation

Outlook Live is a free e-mail service available to schools enrolled with Microsoft Live@edu. With the Microsoft Live Services Plug-in for Moodle you can easily access the Outlook Live service. In this section you will find steps to set up your Live@edu account and create an impersonation account.

To use Outlook Live with the Microsoft Live Services Plug-in for Moodle, you will need to perform the following configuration steps. If you are not using Outlook Live, skip this section.

  1. Enroll your school in the Live@edu program.
  2. Set up and Impersonation Account.
2.10.2.2.1. Enroll your school

Register your school’s domain with Live@edu. You can enroll your school in the Live@edu program at http://www.microsoft.com/liveatedu/. After you have enrolled your domain, Live@edu will provide instructions to update your domain mail records to use Outlook Live services as your e-mail service provider.

After you complete the Live@edu enrollment process, you need to create an impersonation account in Outlook Live.

2.10.2.2.2. Set Up Impersonation Account

Microsoft Live Services Plug-in for Moodle communicates with Outlook live through Exchange Web Services (EWS). Exchange Impersonation is an authorization mechanism designed for use within EWS. An impersonation account can only be created by the administrator. By verifying the impersonation information, the Exchange server knows whether a user is authorized by the administrator.

To set up an impersonation account:

  1. Create a new account for the impersonation role at Outlook Live (https://outlook.com/ecp/). For example, impersonation@yourliveatedu.com. In order to create an account you need to sign in to Outlook Live with the Administrator account.
  2. Install Powershell 2 ctp3 + WinRM 2 ctp3.
    Note: WinRM 2ctp3 requires Windows Vista. Windows 7 testing is not complete.
  3. Run Powershell as administrator. You may need to run the following cmdlet to create a remote session "Set-ExecutionPolicy RemoteSigned". For more information, refer to this Outlook help document.
  4. Run the following cdmlets to complete the setup process:

$LiveCred = Get-Credential # Use your admin account open a new PS session
$Session = New-PSSession -ConfigurationName Microsoft.Exchange -ConnectionUri `https://ps.outlookcom/powershell/ -Credential $LiveCred -Authentication Basic `
-AllowRedirection
Import-PSSession $Session
New-ManagementRoleAssignment -Name:EWSImpersionation -Role:ApplicationImpersonation `
-User: impersonation@yourliveatedu.com

Please replace "impersonation@yourliveatedu.com" with the account you set up in step 1.

More details about the cmdlets above can be found here.

2.10.2.3. Email and Calendar

Give users access to their online email and calendar using Microsoft Office Outlook® Web Access (OWA). The Outlook block allows the user to create a new email or calendar event without leaving the current screen. If more customized options are needed, or if the user wants to see all of the emails or calendar events, the full online application can be launched in a new browser window by clicking the Inbox link. If you choose not to use Outlook live, leave Use Outlook Live unchecked. The e-mail used in the block will be Hotmail® and the calendar will be Windows Live Calendar.

To disable all email and calendar options, uncheck all checkboxes in this section:

  • Use Outlook Live: Check to use Outlook Live for e-mail and calendar. Note: In Joule 2.0 only Outlook Live is supported.
  • Service Account: Enter your complete Windows Live ID. For example: "impersonation@yourliveatedu.com"
  • Password: Enter the password for your impersonation account.
  • Outlook URL: Enter the URL of your Outlook Live domain.
  • Show Email: Check to show e-mail in the Microsoft Live Services Block.
  • Show Calendar: Check to show calendar events in the Microsoft Live Services Block.
Note: In Joule 1.9 you have the option to hide the New E-mail link in the block. Uncheck Show New E-mail Link and it will not display from the block.

In order to obtain your Outlook URL:

  1. Open a new browser window and go to http://www.outlook.com.
  2. Log in using your Windows Live ID credentials.
  3. Copy the URL from your address bar omitting "/owa". For example: "https://pod51004.outlook.com"
For more information about configuring and deploying Outlook Live see http://help.outlook.com/en-us/140/dd277852.aspx.

2.10.2.4. Windows Live Messenger®

Windows Live Messenger is now available for Moodle. Users can now use the familiar Messenger application for chatting with their classmates, or Teachers.

Check Show Messenger to show Messenger contacts in the block.

2.10.2.5. Powerset and Bing® Search

Provide your users with the ability to highlight onscreen text and search the web for related information using Powerset and/or Bing search engines from Microsoft. A textbox is also provided for user input so any topic can be searched from Moodle.

If you wish to show search options in the Microsoft Live Services block check Show Search.

If the Enable Bing Search check box is checked, Bing will be the default search. Disabling Bing Search will make Powerset the default search.

Click Save Changes when you are finished.

For more information about Microsoft Live Services for Moodle see http://www.educationlabs.com/Pages/Microsoft_Live_Services_for_Moodle_Getting_Started.htm.

2.10.3. User Documentation

Log in to your Moodle site and Navigate to a course with the Microsoft® Live Services block.

microsoft live services block with email

Note: If you do not see the Microsoft Live Services block, a site Administrator or Teacher with editing permissions will need to add the block to the course.

The following links are at the top of the block under your Live ID:

  • Profile: takes you to your my.live.com account profile page.
  • FAQ: opens a list of frequently asked questions that may answer questions you may have.
  • Privacy: opens the Microsoft Live privacy policy.

2.10.3.1. Search the web

You can search the web using Bing™. Enter text in the box and click on the search (magnifying glass) icon to open results in a new window.

search box with magnifying glass icon for searching terms

Note: You can also highlight any text on the page and click the search icon to search and display results in a new window.

2.10.3.2. E-mail and Calendar

The Microsoft Live Services block gives you quick access to e-mail and calendar events. You will either have access to Windows Live Hotmail® or Outlook Live and calendar events. New messages and events are displayed in the block right in your Moodle course.

outlook live portion of block with new e-mail messages and new events displayed

The following links are available:

  • Inbox: opens a new window to display your inbox.
  • New E-mail: opens a new message so you can create e-mails from within your course.
  • New Event: opens a new event so you can create new events from within your course.

New messages and Upcoming events are listed in the block so you don't have to navigate away from your course to view them. Simply click on a message or event to view them from within a course.

Messages:

Click New E-mail to open the new message creation window.

pop-up window with new e-mail creation form displayed

From this window you can enter the email address of the person you are sending the e-mail To:, enter the Subject: and compose a message.

Note: In Joule 1.9 you have the option to include resource files from the course as a message attachment by clicking Attach and selecting a file.

Click on a message you wish to read under new messages

e-mail from inbox displayed with message and reply and forward options

From this window you can view previous, next, Reply and Forward the message or click Inbox to open your inbox in a new window.

Events:

Click New Event to open the new event creation window.

window with to

Enter the following information:

  • To: The e-mail address of the person(s) invited to the event.
  • Subject: Description of the event.
  • Message: Personal message to person(s) invited.
  • Start Date: The date the event starts. You can click on a date in the embedded calendar to fill this field.
  • Start Time: The time the event starts.
  • End Date: The date the event ends. You can click on a date in the embedded calendar to fill this field.
  • End Time: The time the event ends.
  • All Day Event: Check to make the event an all day event.

Click Send to send the message or Cancel to discard the event invitation and close the window.

Click on an event under upcoming events to view the event details.

pop-up window with event information displayed

From this window you can view event details for events on your calendar as well as click Inbox to open your inbox in a new window.

2.10.3.3. Messenger

The Microsoft Live Services block gives you quick access to Windows Live Messenger where you can easily determine who is on/off line and send messages to Teachers and students in the course.

messenger portion of block with Teachers and Classmates lists displayed

Note: Only students and Teachers with a Microsoft Live ID and are enrolled in the course will populate the contacts list.
2.10.3.3.1. Web Settings

You will need to allow others to see you in your Windows Live Web Settings before you can see and chat with each other.

To allow others to see you follow the steps below:

  1. Log in to Windows Live Messenger Web Settings.
  2. If necessary, log in using your Windows Live ID credentials.
  3. Check Allow anyone on the web to see my presence and send me messages.
  4. Click Save to save your changes.

web settings check box for allow anyone to see me

2.10.3.3.2. Add/Accept Contacts

You will also need to add classmates/Teachers to your contact list and they will need to accept the invitation.

Note: There are several ways to do this, in this example we are using the Windows Outlook Web Application.

Go to your Contact List and click Add contact....

inbox with add contact link highlighted

The Add Contact pop-up displays.

add contact pop-up with invite button and message box

Enter the IM/e-mail address of the person you wish to add. If you want you can add a personal message to the invite. Click Invite to send the invitation to that person.

Note: The person must accept your invitation and have their Web Settings set to allow others to see them as set above.

You will receive an e-mail if/when someone adds you to their contacts.

Open the e-mail and click the link to View Invitation.

email with link to view invitation to add to contacts

The Contact Requests invitation will display.

invitation with accept all

You have three options:

  1. Click Accept All to accept all invitations.
  2. Click Accept to accept the current invite only.
  3. Click Decline to decline the invite.

Once invitations have been sent/accepted and web settings are set, you will see a list of contacts in the MS Live Services block. Click on a Teacher or Student name to open a new window and chat. 

Note: You may want to use the MSN Messenger Application in addition to the MS Live Services block. The MS Live Services block does not log you into MSN Messenger, so if you are not logged in to your course your classmates will not see you as available to chat. This can be very helpful for a Teacher who stays logged in to MSN Messenger so they are available to students who log in to the course or for students who wish to chat with their classmates without being logged in to the course.

For more information see the links below:

2.11. Profile Redirect Block

2.11.1. Overview

The Profile Redirect block is designed to automatically redirect a user from the front page of the site or the My Moodle page (depending on the location of the block) to a different course. The course that the user is redirected to is based on a value in a mapped profile field that matches the value in a specified field within the course settings. This block, in combination with other Moodlerooms-developed features, provides clients with flexibility in their user's landing page beyond the Moodle/Joule front page and My Moodle page.

2.11.2. Usage Scenarios

The Profile Redirect block, in combination with other Moodlerooms features, provides clients with flexible options for the default landing page for different users as well as the ability to provide separate groups of users with separate themes. In each scenario below, the user is automatically redirected to the course that is identified in their specified user profile field.

2.11.2.1. User Redirected to a Department Course

In this scenario, the user is redirected to a department course page, which contains department-specific resources, activities and courses via the Courses Available to You block. This scenario is beneficial for institutions wishing to provide their students with a visual association with the department of their major or with department-specific information within Joule. The course can be branded to the department's specifications using Express.

To configure this scenario, the Profile Redirect block is mapped to the Department field within a user's profile. A course should then be created for each potential option (department) with a matching value in either the Short name, Full name or Course ID fields, depending on the Course Field setting within the Profile Redirect block. Department-specific activities, events and resources can then be added to the course.

It is recommended that the My Courses or Courses Available to You block is then also added to the course to provide the student with access to the courses they are enrolled in, thus making this course a portal-like area. Alternatively, Express menu's %MYCOURSES% variable can be used to create a dynamic menu of the courses that the student is enrolled in. An Express design should be created to brand the course to the specific department, providing the student with visual clues as to what department they belong to.

2.11.2.2. User is Redirected to an Introduction Course in Their Language

In this scenario, the user is redirected to a course that has been developed in a specific language. This introductory course provides instructions for a user based on the language they have set in the user profile. This scenario is particularly useful for language-oriented institutions or international organizations wishing to provide basic knowledge of the system in the user's native language.

To configure this scenario, the Profile Redirect block's Profile Field is set to match against the Language field within the user's profile. A course should then be created for each potential option (language) with a matching value in either the Short name, Full name or Course ID fields, depending on the Course Field setting within the Profile Redirect block. It is recommended that ID number is used in this scenario, because this field is not displayed to users and the value saved for the Language field in the user profile is not human readable (and thus should not be added to a visible field). The course's language should be set to the same language as the ID number of the course. All content developed in this course should be written in the language of the course.

2.11.2.3. User Redirected to a Company Portal Page

In this scenario, the Profile Redirect block is combined with Flexpage to provide users from different companies with separate landing pages. This can further be combined with the Courses Available to You block to provide each landing Flexpage course with a unique listing of courses for a specific set of users. The course can then be branded to the company's specifications using Express. This scenario is particularly helpful for Moodlerooms clients that are using Joule to sell training and want to tailor the experience for each of their own clients.

To configure this scenario, the Profile Redirect block is set to use the Institution field within the user profile. A course should then be created for each potential option (client/company name) with a matching value in either the Short name, Full name or Course ID fields, depending on the Course Field setting within the Profile Redirect block. Each course should be set to the Flexpage course format.

In each course, an institution/client manager can be set and that manager can then add calendar events specific to the institution/client, the Courses Available to You block to list institution/client-specific training courses, and institution/client-specific resources. Using Express, this course can be branded to the specific institution/company, providing the user with a visual connection of the course information to their organization (as well as a familiar learning environment). It is recommended that, with this scenario, the Institution profile field be locked and that the value is populated into Joule from an ERP or SIS system through Conduit.

2.11.2.4. Redirect User Once They Access a Specific Flexpage

In this scenario, any of the above scenarios could be used, but the difference is that the front page is set to use the Flexpage course format and that the Profile Redirect block is not placed on the first page. Instead, the Profile Redirect block is placed on a secondary or sub page.

In this scenario, the user logs in and is able to view information in pages that don't have the Profile Redirect block. As soon as the user accesses a Flexpage with the Profile Redirect block, they are redirected to another course based on the specified profile field. This scenario allows the site administrator to use the CMS features of Flexpage on the front page while still providing users with a unique experience associated with their profile later on in the site.

2.11.3. Administrator Documentation

The Profile Redirect block consists of the global settings for the block. Once these are set and the block is added to the page that will redirect the user, the block is set and will display something similar to the following, but only for site administrators:

Within the Profile Redirect block settings there is a Default Course Setting field that is used to identify which course the user should be redirected to. The block's Course Field field is used to identify which field within the course settings need to match the value specified in the Profile Redirect block's Default Course Setting field. For example, if the Default Course Setting field is set to Eng101 and the Course Field field is set to "short name," then the Profile Redirect block will redirect the user to the course that has "Eng101" as its short name.

It is recommended that the Profile Redirect block be placed in the upper left-hand corner of the course page. This means it will be the first item loaded after the header and will redirect the user quicker.

Use an Authentication Plug-in
It is recommended that Conduit or some other authentication system be used to create users and set the value for the user's profile field that matches the value set in the Profile Redirect block's Profile Field setting. The user profile field set in the Profile Redirect block's Profile Field setting can be locked for the authentication plug-in used within the authentication plugin's settings page. Locking the field will not allow users to update the profile field manually and cause misdirections.

2.11.4. Global Settings

  • Profile Field: This is the field in a user's profile that the Profile Redirect block will match against the course field. The user will then be redirected to the corresponding course. If there is not a valid value in the specified profile field, the block will instead redirect the user to the default course identified in the Default Course field. Default: Institution
    • ID number
    • Institution
    • Country
    • City/town
    • Language
    • Department
  • Course Field: This is the field in the course settings that the Profile Redirect block will match against the user's profile field for redirecting. Default: Short name
    • Short name
    • Full name
    • ID number
  • Default Course: This field identifies the course that all non-admin users who do not have a valid value in their profile field will be directed to upon viewing the block. This field should have the short name, full name, or course ID number of the course, depending on the value specified in the Course Field drop-down menu.

2.12. Reports Block

2.12.1. Overview

The Reports block provides Moodlerooms clients with access to a greater range of aggregate data about user, activities and courses in the Joule site, as well as engagement trends and distributions. Data is aggregated at the site, category (sometimes considered program or department) and course levels. The block can be accessed at the site, category and course levels by a different user base to provide different levels of insight into the use and effectiveness of instruction within Joule.

2.12.1.1. Related Features

Note
Joule Reports display data gathered by the Collect block. The Collect block only collects data for courses that have the Collect block added to them and if the data is checked to be collected in the Collect block's administrative settings. Please review the Collect Block Manual for more information on configuring and setting up data collection.

2.12.2. Teacher Documentation

2.12.2.1. Accessing Reports

Reports are accessed through links in the Reports block. The Reports block has two different interfaces: AJAX and basic HTML (displayed below).

2.12.2.2. Report View Types

Conduit reports, as well as the Conduit table views, come in two different views: basic and standard (AJAX). By default, Conduit uses the standard view to provide the quickest response and most features. However, if the standard view is causing problems, a user can always switch to the basic view and the problem should be alleviated.

2.12.2.2.1. Standard (AJAX) View

The standard view of a report or table renders the data using AJAX. In this view, the report data is loaded without a page refresh, making sorting and database processing quicker.

2.12.2.2.2. Basic HTML View

The basic HTML view displays all data in an HTML table for processing. Sorting will cause the page to refresh in this view type. It is recommended that the basic HTML view is used when using a screen reader.

2.12.2.2.3. Changing Views

To change your report view, click on the Basic HTML or Standard links at the bottom of the reports as in the image below:

Once you have clicked the desired link, the page will refresh and all reports will display in this view for the rest of your session.

2.12.2.3. Exporting Reports

Tabular data for all reports can be exported to a CSV file via the Export drop-down menu on the bottom of the page.

The user will be asked if they want to save or open the file depending on the browser's settings.

2.12.2.4. Aggregate Reports

2.12.2.4.1. Learner Detail Report

The Learner Detail Report gives you a quick snapshot your students' course grades in your courses, the number of graded activities available to them, how many of those they have attempted, and information about their views and posts of/to the course.

2.12.2.4.1.1. Report Filters

The Learner Detail Report allows the following filters to be applied:

  • User: Limits the report to the selected user
2.12.2.4.1.2. Display as Options
  • Tabular Report: A table of the data for the report that can be exported
2.12.2.4.2. Learner Outcome Report

The Learner Outcome Report displays information about users' interactions with outcomes including: the course, the outcome, the outcome grade, the outcome percentage, the course grade, and the scale.

2.12.2.4.2.1. Report Filters

The Learner Outcome Report allows the following filters to be applied:

  • User: Limits the report to the selected user
  • Outcome: Limits the report to a specific outcome used in the course or site
2.12.2.4.2.2. Display as Options
  • Tabular report: A table of the data for the report that can be exported
2.12.2.4.3. Learner Participation Report

The Learner Participation Report gives you a detailed look at the interactions that users are having with your course(s).

2.12.2.4.3.1. Report Filters

The report allows the following filters to be applied:

  • Activity: Limits the report to the selected activity
  • User: Limits the report to the selected user
  • Log Time Is Within: Limits the report to entries in the log within the past specified time span (day, week, month, etc.)
  • Log Time: Limits the report to entries in the log between the specified dates
2.12.2.4.3.2. Display as Options
  • Tabular Report: A table of the data for the report that can be exported
2.12.2.4.4. Learner Resource & Activity Report

The Learner Resource & Activity Report displays the information about users' interactions resources and activities including: the course, the section of the course an activity belongs to, users' grades, information about users' views, posts and attempts, the number of student submissions that still require grading, and the date of last grading.

2.12.2.4.4.1. Report Filters

The report allows the following filters to be applied:

  • User: Limits the report to activities participated in by the selected user
  • Activity: Limits the report to the activity selected
2.12.2.4.4.2. Display as Options
  • Tabular Report: A table of the data for the report that can be exported
2.12.2.4.5. Learner SCORM Report

The Learner SCORM Report displays information about users' latest attempts for a SCORM activity, including: the course name, the SCORM name, users' full names, the SCORM Sco title, the attempt number, the total time taken, users' SCORM lesson status, users' SCORM last access date, and users' raw grades.

2.12.2.4.5.1. Report Filters

The report allows the following filters to be applied:

  • User: Limits the report to the selected user
  • SCORM Name: Limits the report to a specific SCORM
2.12.2.4.6. Outcome Report

The Outcome Report displays information about outcomes including: the number of courses they are used in, the number of users using the outcome, the outcome grade, the outcome percentage, the scale used with the outcome, the number of enrolled users, and the average grade.

2.12.2.4.6.1. Report Filters

The report allows the following filters to be applied:

  • Outcome: Limits the report to a specific outcome used in the course or site
2.12.2.4.6.2. Display as Options
  • Tabular report: A table of the data for the report that can be exported.
2.12.2.4.7. Resource & Activity Report

The Resource & Activity Report displays the information about resources and activities including: the course it is in, the section of the course it belongs to, the average grade, the number of enrolled users, the number of enrolled users that have viewed the activity, the number of enrolled users who have posted to the activity, and the number of student submissions that still require grading.

2.12.2.4.7.1. Report Filters

The report allows the following filters to be applied:

  • Activity: Limits the report to the activity selected
2.12.2.4.7.2. Display as Options
  • Tabular Report: A table of the data for the report that can be exported

2.12.2.5. Engagement Reports

2.12.2.5.1. Activity Grade via Engagement Detail Report

This report reveals various learner scores within course activities. The average grade for the activity is represented with a bar chart. When you hover over the chart, you will see the total number of views and posts (engagement) within the grade's context.

This report can be viewed in different contexts with different results.

2.12.2.5.1.1. Report Filters

The report allows the following filters to be applied:

  • Group: Limit the results based on the users that are in the selected group
  • Grade Category: Limit the activities displayed by the grade category they are a part of
  • Sections: Limit the activities displayed by the section (week or topic) they are a part of
  • User: Limit the report to data about the selected user
  • Grade Distribution: Limit the grades that are shown to greater than a number and less than a number
  • Activities to show: Limit the activities shown to just graded activities or all activities in the course.
2.12.2.5.1.2. Display Options:

  • Sort by: How are the activities sorted?
    • Grades - Sort by the grade value for the activity
    • Activity - Sort by the name of the activity
    • Views - Sort by the number of views of the activity
    • Posts - Sort by the number of posts to the activity
  • Order By: Will the sort be displayed in ascending or descending order?
2.12.2.5.1.3. Display as Options
  • Activity Grade via Engagement Detail Graph: A horizontal bar graph displaying the grades based on the filters and display options
  • Tabular report: A table of the data for the report that can be exported
2.12.2.5.2. Learner Engagement Distribution Report

This report reveals how much learner engagement is captured within each grade distribution (e.g. how many views/posts are students making whose grades are between 50-60%? How many views/posts are students making whose grades are between 90-100%?).

2.12.2.5.2.1. Report Filters

The report allows the following filters to be applied:

  • Group: Limit the results based on the users that are in the group
  • User: Limit the report to data about the selected user
  • Date range: Display views or posts for the course between a specific start and end date
  • View to display: What data is displayed?
    • Views - Activity views
    • Posts - Activity posts
2.12.2.5.2.2. Display as Options
  • Learner Engagement Distribution Graph: Vertical bar graph of the grade distribution of views or posts
  • Tabular report: A table of the data for the report that can be exported
2.12.2.5.3. Learner Engagement Trends Report

This report reveals a total number of views or posts of users over a range of time. One can see when students are engaged (or not) with the course.

2.12.2.5.3.1. Report Filters

The report allows the following filters to be applied:

  • Group: Limit the report based on the users that are in the group
  • User: Limit the report to data about the selected user
  • Date range: Display views or posts for the course between a specific start and end date
  • View to display: What data is displayed?
    • Views - Activity views
    • Posts - Activity posts
2.12.2.5.3.2. Display as Options
  • Learner Engagement Trends Graph: Line graph displaying average views or posts over time
  • Tabular report: A table of the data for the report that can be exported
2.12.2.5.4. Learner Grade via Engagement Detail Report

This report reveals a learner's grade within an activity, course or series of courses. The learner's accumulated grade is represented with a bar chart. When you hover over the chart, you will see the total number of views and posts (engagement) within the grade's context.

This report can be viewed in different contexts with different results.

2.12.2.5.4.1. Report Filters

The report allows the following filters to be applied:

  • Group: Limit the report based on the users that are in the group
  • Grade Category: Limit the activities displayed by the grade category they are a part of
  • Sections: Limit the activities displayed by the section (week or topic) they are a part of
  • Activities: Limit the report to data about a specific activity
  • Grade Distribution: Limit the grades that are shown to greater than a number and less than a number
2.12.2.5.4.2. Display Options:

  • Sort by: How are the activities sorted?
    • Grades - Sort by the grade value for the activity
    • Student Name - Sort by the name of the student
    • Views - Sort by the number of views of the activity
    • Posts - Sort by the number of posts to the activity
  • Order By: Will the sort be displayed in ascending or descending order?
2.12.2.5.4.3. Display as Options
  • Learner Grade via Engagement Detail Graph: Horizontal bar graph of the grade distribution for the activities
  • Tabular report: A table of the data for the report that can be exported

2.12.3. Admin Documentation

2.12.3.1. Aggregate Reports

2.12.3.1.1. Course Report

The Course Report gives a quick snapshot of how many students are enrolled in a course, what the average grade is for users in the course, the types of student activity within the course, and the number of student submissions that still require grading.

2.12.3.1.1.1. Administrator Report Filters

The Course Report allows the following filters to be applied:

  • Category (Course Category): Limits the report to courses in the selected category
2.12.3.1.1.2. Collect Block Collectors to Enable

You will need to ensure that the data collection points below have been enabled in order to use all data points in this report:

  • Course/User Collector
    • Enrollment End
    • Enrollment Start
    • Course Grade
  • Activity/User Collector
    • Attempt
    • Grade
    • Post
    • View
2.12.3.1.2. Learner Detail Report

The Learner Detail Report gives you a quick snapshot your students' course grades in your courses, the number of graded activities available to them, how many of those they have attempted, and information of about their views and posts of/to the course.

2.12.3.1.2.1. Administrator Report Filters

The report allows the following filters to be applied:

  • Category (Course Category): Limits the report to courses in the selected category
  • Course:: Limits the report to the selected course
2.12.3.1.2.2. Collect Block Collectors to Enable

You will need to ensure that the data collection points below have been enabled in order to use all data points in this report:

  • Course/User Collector
    • Enrollment End
    • Enrollment Start
    • Course Grade
  • Activity Collector
    • Grade
    • Name
    • Sort order
  • Activity/User Collector
    • Attempt
    • Post
    • View
2.12.3.1.3. Learner Outcome Report

The Learner Outcome Report displays information about users' interactions with outcomes, including: the course, the outcome, the outcome grade, the outcome percentage, the course grade and the scale.

2.12.3.1.3.1. Administrator Report Filters

The Learner Outcome Report allows the following filters to be applied:

  • Category (Course Category): Limits the report to courses in the selected category
  • Course: Limits the report to the course selected
2.12.3.1.3.2. Collect Block Collectors to Enable

You will need to ensure that the data collection points below have been enabled in order to use all data points in this report:

  • Course/User Collector
    • Course Grade
2.12.3.1.4. Learner Participation Report

The Learner Participation Report gives you a detailed look at the interactions that users are having with your course(s).

2.12.3.1.4.1. Administrator Report Filters

The Learner Participation Report allows the following filters to be applied:

  • Category (Course Category): Limits the report to courses in the selected category
  • Course: Limits the report to the selected course
  • Activity: Limits the report to the selected activity
  • User: Limits the report to the selected user
  • Log Time is Within: Limits the report to entries in the log within the past specified time span (day, week, month, etc.)
  • Log Time: Limits the report to entries in the log between the specified dates
2.12.3.1.4.2. Collect Block Collectors to Enable

You will need to ensure that the data collection points below have been enabled in order to use all data points in this report:

  • Activity Collector
    • Name
  • Activity/Action
    • Post
    • View
2.12.3.1.5. Learner Resource & Activity Report
2.12.3.1.5.1. Administrator Report Filters

The Learner Resource & Activity Report allows the following filters to be applied:

  • Category (Course Category): Limits the report to courses/activities in the selected category
  • Course: Limits the report to activities in the selected course
2.12.3.1.5.2. Collect Block Collectors to Enable

You will need to ensure that the data collection points below have been enabled in order to use all data points in this report:

  • Course/User Collector and Any/All of the Following:
    • Enrollment End
    • Enrollment Start
    • Course Grade
    • Course Completion
    • View
  • Activity Collector
    • Name
    • Sort Order
  • Activity/User Collector
    • Attempt
    • Grade
    • Post
    • View
2.12.3.1.6. Learner SCORM Report
2.12.3.1.6.1. Administrator Report Filters

The Learner SCORM report allows the following filters to be applied:

  • Category: Limits the filterable courses in the course filter
  • Course: Limits the filterable users and SCORMs to those available in the selected course. Also limits the report to the selected course.
2.12.3.1.6.2. Collect Block Collectors to Enable

You will need to ensure that the data collection points below have been enabled in order to use all data points in this report:

  • SCORM/Track Collector
    • Track
2.12.3.1.7. Outcome Report
2.12.3.1.7.1. Administrator Report Filters

The Outcome Report allows the following filters to be applied:

  • Category (Course Category): Limits the report to courses in the selected category
  • Course: Limits the report to the course selected
2.12.3.1.7.2. Collect Block Collectors to Enable

You will need to ensure that the data collection points below have been enabled in order to use all data points in this report:

  • Course/User Collector
    • Course Grade
2.12.3.1.8. Resource & Activity Report
2.12.3.1.8.1. Administrator Report Filters

The Resource & Activity Report allows the following filters to be applied:

  • Category (Course Category): Limits the report to courses/activities in the selected category
  • Course: Limits the report to activities in the selected course
2.12.3.1.8.2. Collect Block Collectors to Enable

You will need to ensure that the data collection points below have been enabled in order to use all data points in this report:

  • Course/User Collector and Any/All of the Following:
    • Enrollment End
    • Enrollment Start
    • Course Grade
    • Course Completion
    • View
  • Activity Collector
    • Name
    • Sort Order
  • Activity/User Collector
    • Attempt
    • Grade
    • Post
    • View

2.12.3.2. Engagement Reports

2.12.3.2.1. Activity Grade via Engagement Detail Report

This report reveals various learner scores within course activities. The average grade for the activity is represented with a bar chart. When you hover over the chart, you will see the total number of views and posts (engagement) within the grade's context.

2.12.3.2.1.1. Administrator Report Filters

The Activity Grade via Engagement Detail Report allows the following filters to be applied:

  • Category (Course Category): Limits the report to courses/activities in the selected category
  • Course: Limits the report to activities in the selected course
2.12.3.2.1.2. Collect Block Collectors to Enable

You will need to ensure that the data collection points below have been enabled in order to use all data points in this report:

  • Course/User Collector and Any/All of the Following:
    • Enrollment End
    • Enrollment Start
    • Course Grade
    • Course Completion
    • View
  • Activity Collector
    • Name
    • Sort Order
  • Activity/User Collector
    • Attempt
    • Grade
    • Post
    • View
2.12.3.2.2. Learner Engagement Distribution Report

This report reveals how much learner engagement is captured within each grade distribution (e.g. how many views/posts are students making whose grades are between 50-60%? How many views/posts are students making whose grades are between 90-100%?).

2.12.3.2.2.1. Administrator Report Filters

The Learner Engagement Distribution Report allows the following filters to be applied:

  • Category (Course Category): Limits the report to courses/activities in the selected category
  • Course: Limits the report to activities in the selected course
2.12.3.2.2.2. Collect Block Collectors to Enable

You will need to ensure that the data collection points below have been enabled in order to use all data points in this report:

  • Course/User Collector and Any/All of the Following:
    • Enrollment End
    • Enrollment Start
    • Course Grade
    • Course Completion
    • View
  • Activity Collector
    • Name
    • Sort Order
  • Activity/User Collector
    • Attempt
    • Grade
    • Post
    • View
2.12.3.2.3. Learner Engagement Trends Report

This report reveals a total number of views or posts of users over a range of time. One can see when students are engaged (or not) with the course.

2.12.3.2.3.1. Administrator Report Filters

The report allows the following filters to be applied:

  • Category (Course Category): Limits the report to courses/activities in the selected category
  • Course: Limits the report to activities in the selected course
2.12.3.2.3.2. Collect Block Collectors to Enable

You will need to ensure that the data collection points below have been enabled in order to use all data points in this report:

  • Course/User Collector and Any/All of the Following:
    • Enrollment End
    • Enrollment Start
    • Course Grade
    • Course Completion
    • View
  • Activity Collector
    • Name
    • Sort Order
  • Activity/User Collector
    • Attempt
    • Grade
    • Post
    • View
2.12.3.2.4. Learner Grade via Engagement Detail Report

This report reveals a learner's grade within an activity, course or series of courses. The learner's accumulated grade is represented with a bar chart. When you hover over the chart, you will see the total number of views and posts (engagement) within the grade's context.

2.12.3.2.4.1. Administrator Report Filters

The report allows the following filters to be applied:

  • Category (Course Category): Limits the report to courses/activities in the selected category
  • Course: Limits the report to activities in the selected course
2.12.3.2.4.2. Collect Block Collectors to Enable

You will need to ensure that the data collection points below have been enabled in order to use all data points in this report:

  • Course/User Collector and Any/All of the Following:
    • Enrollment End
    • Enrollment Start
    • Course Grade
    • Course Completion
    • View
  • Activity Collector
    • Name
    • Sort Order
  • Activity/User Collector
    • Attempt
    • Grade
    • Post
    • View

2.12.4. Global Settings

  • AJAX default: Set the default report view for users, which is either Basic HTML or AJAX. Default: Yes
  • Enable the AJAX tree menu: Enable the tree menu for display in the block (AJAX must also be enabled) Default: No

2.12.5. Permissions

  • View (block/reports:view): If this permission is set to "allow," then the user is able to view the reports at the level they are at (site, category and course)
    • Default Permissions
      Role Not Set Allow Prevent Prohibit
      Administrator   X    
      Course Creator X      
      Teacher   X    
      Non-Editing teacher   X    
      Student X      
      Guest X      
      Authenticated User X      

2.13. Trouble Ticket Block

2.13.1. Overview

The Trouble Ticket block is designed to provide a simple interface for students and faculty to use to submit a help request from a page in Joule. It captures pertinent data about the user and their location at the time of submission to attempt to get a jump start on the issue.

2.13.2. Usage Scenarios

2.13.2.1. Trouble Tickets Linked to Support Portal

In this scenario, the Site Administrator configures the Trouble Ticket block to send an e-mail to an e-mail address that automatically creates a ticket in a support system like Kayako, Remedy or another product. This allows the support center for the student or teacher to respond to issues within Joule and provides the support center with information about the user's system and last actions within Joule. It also takes advantage of the support system's tracking or responses. The Trouble Ticket block is only used to initiate the creation of the support ticket. After the ticket has been created, Trouble Ticket no longer plays a part in the support of the user. Any response e-mails go directly to the e-mail address specified in the user's profile.

2.13.2.2. Trouble Tickets for In-Course Support

In this scenario, the teacher adds the Trouble Ticket block to a course page and sets the send-to e-mail address to an e-mail address they have access to. This allows the teacher to receive e-mails when the student is having problems in the course rather than an administrator. This is typically used to allow the teacher to answer student questions about the course materials or activity instructions rather than get application support.

2.13.3. User Documentation

The Trouble Ticket block can be displayed as either a button or a hypertext link like below:

Clicking on the button or link begins the ticket submission process. Below is an example Help Ticket form.

The Help Ticket form allows a user to describe the issue they experienced as best they can and upload a screen shot of the issue in the Attachment field, if they have one.

Once the user has submitted the Help Ticket form, they are brought to the auto-reply screen. This screen will vary depending on how the teacher or administrator has configured the Trouble Ticket block. Clicking on the link below the message will either return the user to the course or to a useful Web site the teacher or administrator wants to send the user to. Below is an example auto-reply page.

2.13.4. Teacher Documentation

2.13.4.1. Block Configuration

The Trouble Ticket block allows each instance of the block to be configured. This allows the teacher to create unique Trouble Ticket blocks to suit their specific course and student needs (for example, a course with students using a screen reader should opt to use the Display as a hyperlinked text option rather than a button for increased accessibility).

  • Display Type: This field represents how the link to this block will be displayed.
    • Display as a button: The user will see a button in the Trouble Ticket block to begin the process for submitting a trouble ticket.
    • Display as a hyperlinked text: The user will see a link in the Trouble Ticket block to begin the process for submitting a trouble ticket.
  • To E-mail Address: This is the address where the trouble ticket e-mail is sent.
  • Subject Prefix: This field represents the prefix which will be appended to the sent field of all e-mail sent through the Trouble Ticket form.
  • Auto Reply: This is the message that will automatically be e-mailed to people who submit a trouble ticket.
  • Auto Reply URL: This settings represents the URL the user will be sent when clicking on the Auto Reply Linked Text. This defaults to the course the that Trouble Ticket block was added to.
  • Auto Reply Linked Text: This setting represents the text for the auto reply URL, which is displayed below the Auto Reply text on the auto-reply page. This defaults to Continue if not set.

2.13.4.2. User Submitted Ticket

Once added to a course page, the Trouble Ticket block looks like an easy-to-use link or button (depending on settings) and is visible to those users who should see it based on roles and role overrides. The Trouble Ticket tool automatically harvests key information such as name, e-mail address, user name, role on the page, and a link to the page the Trouble Ticket block was accessed from. The notification e-mail also contains browser and OS information for help in diagnosis.

2.13.4.2.1. Sample E-Mail Message

From: jdoe@mrdemo.net
Subject: Test Help
Date/Time: 9-28-2010 8:14 PM
I forgot my name, someone please help me. Plus my shoe is untied. Thanks.
This problem was noticed in: http://XXX.mroomstest.net/course/view.php?id=7
By: jdoe, Jane Doe
Using: Mozilla/5.0 (Windows; U; Windows NT 6.1; en-US) AppleWebKit/534.3
(KHTML, like Gecko) Chrome/6.0.472.63 Safari/534.3
Role(s) in current context: Student

2.13.5. Global Settings

The Trouble Ticket block can be configured on the site level in the Site Administration block > Modules > Blocks > Trouble Ticket.

Here we find the site-wide settings for the block’s behavior, although local instances of the block can have local variations on some of these settings. For example, to allow for local override of the e-mail address destination for an exception course.

  • block_trouble_ticket_display_type: This field represents how the link to this block will be displayed.
    • Display button: The user will see a button in the Trouble Ticket block to begin the process for submitting a trouble ticket.
    • Display link: The user will see a link in the Trouble Ticket block to begin the process for submitting a trouble ticket.
  • block_trouble_ticket_address: This is the address where the Trouble Ticket e-mail is sent. This defaults to the first administrator's e-mail address.
  • Display in form: If checked, the block_trouble_ticket_address field will display in the Trouble Ticket form for the user to view.
  • block_trouble_ticket_subject_prefix: This field represents the default prefix, which will be appended to the sent field of all e-mail sent through the Trouble Ticket form.
  • block_trouble_ticket_autoreply: This is the default message that will automatically be e-mailed to people who submit a trouble ticket.
  • block_trouble_ticket_autoreply_url: This setting represents the default URL that the user will be sent when clicking on the block_trouble_ticket_autoreply_linktext text. This defaults to the course the Trouble Ticket block was added to.
  • block_trouble_ticket_autoreply_linktext: This setting represents the default text for the auto reply URL, which is displayed below the block_trouble_ticket_autoreply text on the auto reply page. This defaults to Continue if not set.
  • block_trouble_ticket_profilefields: Enable which user profile fields will be included in the Trouble Ticket e-mail.

2.13.6. Permissions

  • Submit Trouble Ticket: This permission allows the user to submit a trouble ticket.
    • Default Permissions
      Role Not Set Allow Prevent Prohibit
      Administrator   X    
      Course Creator   X    
      Teacher   X    
      Non-Editing teacher   X    
      Student   X    
      Guest     X  
      Authenticated User   X    
    • Risks
      • Spam: User could send spam to site users or others

3. Conduit

3.1. General Conduit

3.1.1. Overview

Moodle, the world's most widely used open-source learning management system and the core of Moodlerooms' learning management solutions, natively provides administrators with the flexibility to manage enrollments, users and courses. Conduit enhances this functionality to make administration easier by allowing administrators to automate these vital tasks.

Conduit can also integrate with any system that supports a Web services producer, a comma separated value (CSV) export, or an XML export, allowing for centralized data management and a truly connected learning architecture. CSV files are a common format for exchanging user information. This allows for a number of additional features not currently provided by Moodle’s manual user upload or flat file data import methods.

3.1.1.1. Primary features

  • User/Course/Enrollment/Group Management: Automates all aspects of user creation/update/deletion, course creation/update/deletion, enrollment add/drop, and group creation/update/deletion
  • Password Creation: Automatically create a unique password for each new user
  • CSV/XML Upload Format: Common, easy-to-produce data formats supported by most SIS/CRM/HR/etc. systems. Moodle will be updated with all changes to the uploaded CSV or XML files on a timed schedule.
  • RESTful Web Services: Manage your Conduit data with a Web services producer for your student information system (SIS). This allows for real-time instant updates to Conduit whenever an update is made in the SIS.
  • Course Templates: Have Conduit create courses according to a pre-populated template. Assign a default template for all courses and/or choose the specific "Master" template for a given course.
  • Detailed Log: Stores information about Conduit actions and errors
  • E-mail Notifications: E-mail alerts sent to designated system administrators when Conduit processes run
  • Load Tested: Conduit has been tested with over 100,000 users loaded and up to one million course enrollments executed

3.1.2. Conduit Revisions

3.1.2.1. Conduit Overall

3.1.2.1.1. Conduit 1.2
  • All Settings in Conduit: Conduit no longer requires Moodle's core external database enrollment and authentication plug-ins to be configured. Conduit's configuration is now completely contained within the Conduit Settings > General tab. We have also added a Conduit enrollment and authentication plug-in to Moodle.
  • RESTful Web Services: Manage your Conduit data with a Web services producer for your SIS. This allows for real-time instant updates to Conduit whenever an update is made in the SIS.
  • Enhanced All-In-One Logs: The Reports tab now includes all logs, file syncing, Moodle-to-Conduit syncing logs and Web services requests
  • Cron Sync and File Sync Independence: You no longer have to wait for the Conduit-to-Moodle sync cron to run. Conduit now syncs with Moodle after processing a file or Web services request
  • XML File Support: Conduit now supports uploading of XML files as well as CSV files
  • Full Meta Course Support: Conduit now can create courses that have a parent and will sync child enrollments to parent courses
  • Download Sample Files Based on Your Mappings: You can now download example CSV and XML files based on the mappings you set for users, courses and enrollments
  • New Custom Profile Field Mapping: Populate any custom profile fields you have created for your Moodle site with this new mapping
3.1.2.1.2. Conduit 1.3
  • Grade Web Services: Conduit can now return grade data to an external data system (SIS/ERP/etc.) for all courses and enrollments
  • Conduit Grade Report: allows an administrator to manually search for grade items in Joule and export them to a flat file
  • Notifications: Conduit can now be configured to e-mail administrators the log reports
  • Enhanced Log View: Conduit now uses the Joule reports look and feel, with advanced filtering and sorting
  • Auto-Archive: Ability to automatically archive courses marked for deletion
  • Settings Changes Logged: Logs when administrative settings are changed
  • User and Course Default Settings: Administrators can now set the default value for a mapped field.
3.1.2.1.3. Conduit 1.4
  • Groups Integration: Create, update and delete groups in a course; assign and remove users from groups
  • Course Sync Options: Course mappings can now be set to update every sync (like user mappings) or update Conduit when a mapping is changed in Moodle
3.1.2.1.4. Conduit 1.4.1
  • Export General Settings: This new capability helps for common SIS/ERP-specific installations, like Datatel
  • Automated Archival and Removal of Logs: Conduit now allows you to schedule the archival and removal of transaction logs
  • Conduit E-mailed Error Messages: Separated "Errors and warnings" from "Errors only" setting in Transactions field
  • Course Templating Enhancements: Consolidated "Restore template" and "Use template backup file" to a single configuration option, "Restore," with three options: "No," "Restore from backup," and "Restore from current version"
  • Log Manual Edit Transactions: When someone manually edits a Conduit table, Conduit logs the transaction
  • New Web Services: get_user and get_course endpoints, which retrieve user profile data and course settings data
  • New Authentication Settings: Conduit authentication now allows for a change password URL to be set for clients looking to use user forwarding
3.1.2.1.5. Conduit 1.4.2
  • Added ability to enroll users as a role for another user
  • Added reports to show all transactions related to a Conduit record
  • Grade percentage added to Conduit grade report and Web services
  • Added timecreated and timemodified fields to Conduit records
  • Edit screens can now export to Excel and CSV formats
  • When retrieving a user's record from a Conduit table, the search can now be based on ID number or e-mail in addition to user name
  • Conduit allows for user name changes from an external system
  • Added ability for Conduit to "own" enrollments that were originally created by another method, such as manually by a teacher
  • Sets the user's last modified date field upon update
  • Now throws an error with invalid user names and matches Moodle's user name convention, as specified by the "Allow extended characters in usernames" Moodle administration setting
  • Conduit now offers URL redirection when a user logs out of Joule
  • Updated Conduit documentation links in the Information tab
  • Language updated in the Conduit Mappings tab: "Update every sync" now reads "Update Moodle every sync"
3.1.2.1.6. Conduit 1.5
  • Conduit now allows the ability to change lookup key fields: This allows administrators to easily change User lookup values in Conduit when that value has changed in the external system. For example, if a username has changed because of a name change.
  • Conduit edit UI allows the change of lookup key field values for users: This allows an administrator to manually edit a username, email or idnumber and change it to a new value and have the change propagated throughout the system.

3.1.2.2. Conduit Web Services

3.1.2.2.1. Conduit 1.3
  • User and course web services now have the ability to return grade data for activities, grade categories, graded items and course total grade.
  • Grader report
  • Restrict web requests to IP ranges
3.1.2.2.2. Conduit 1.4
  • Groups: Create, update and delete groups in a course
  • Group Members: Create and delete users from a group in a course
3.1.2.2.3. Conduit 1.4.1
  • User methods added
    • get_user
    • get_user_course_recent_activity
    • get_user_course_activities_due
    • get_user_course_events
  • Course methods added
    • get_course

3.1.3. Administrative Documentation

3.1.3.1. Submitting Data

There are three approaches to submitting your information to Conduit:

  1. Upload a CSV file. This can be produced by your SIS or created from scratch manually. This will be managed by an SFTP upload process and a timed schedule for when Conduit updates Moodle from your SFTP location.
  2. Upload an XML file. This can be produced by your SIS or created from scratch manually. If you do not elect to use the RESTful Web services but your SIS produces XML files, this approach is for you. This will be managed by an SFTP upload process and a timed schedule for when Conduit updates Moodle from your SFTP location.
  3. RESTful Web Services. Instantly update Moodle with information and changes made in your SIS - no uploading required. Requires that your SIS has Web services producer capabilities.
TIP
You can get a head start on the CSV or XML structure by going to the Conduit Settings tab > Mappings sub-tab and then clicking on the Download example mappings buttons to download CSV headers or the XML schema for your configured data mappings.

3.1.3.2. Submitting Files

The five file names for course, user, enrollment, group and group member provisioning are set in the Conduit Settings tab > File sub-tab. If you specify a file with a CSV extension, like course.csv, then you must use CSV data. If you specify a file with an XML extension, like course.xml, then you must use XML data.

Each data set within a file must contain the following data:

  • An action, which will tell what Conduit should do with the data set. Valid actions are as follows:
    • Course actions: create, update (change), and delete (remove)
    • User actions: create, update and delete
    • Enrollment actions: create (add), update, and delete (drop)
    • Groups actions: create, update and delete
    • Group Members actions: create and delete
  • A mapped key to uniquely identify the user, course or enrollment to modify. The keys are defined in the Conduit Settings tab > General sub-tab.
    • Course keys: idnumber or shortname
    • User keys: email, idnumber or username
    • Enrollment keys: there are three required keys to identify and create the enrollment:
      • Moodle ID enrollment key: for courses, shortname or idnumber and for users, username, idnumber or email
      • User enrollment key: username, idnumber or email
      • Role enrollment key: shortname or name
      • Type: (Optional)can be course or user, defaults to course
    • Groups keys: Their is only one key for group creation
      • Course key: shortname or idnumber
      • Group key: name of the group to be created
    • Group Members keys: there are 2 keys for group member assignment.
      • User key: username, idnumber or email
      • Course key: shortname or idnumber
      • Group key: name of the group to assign members to.
Action values in parantheses are deprecated but still work -- they are an alternative to the command before it.

The rest of the data set can contain more data that goes along with the course, user or enrollment.

3.1.3.2.1. Example CSV Files
  • Course: create, update (change) and delete (remove) courses
  • User: create, update and delete users
  • Course Enrollment: create (add), update and delete (drop) enrollments
  • Parent/User Enrollment: create (add), update and delete (drop) enrollments
  • Groups: create, update and delete groups
  • Group Members: create, update and delete group members
3.1.3.2.2. Example XML Files
  • Course: create, update (change) and delete (remove) courses
  • User: create, update and delete users
  • Course Enrollment: create (add), update and delete (drop) enrollments
  • Parent/User Enrollment: create (add), update, delete (drop) enrollments
  • Groups: create, update and delete groups
  • Group Members: create, update and delete group members

3.1.3.3. Uploading Files

Once the files have been prepared, they can be uploaded to the server directory specified in the Conduit Settings tab > File sub-tab using your favorite FTP/SFTP program. The following are a few recommended SFTP programs:

3.1.3.4. Cron Processes

Conduit has two cron processes that run on the system to maintain continuity between Conduit and Moodle and to process file requests:

  • Conduit Cron: This cron runs every 15 minutes and looks for new CSV or XML files to process
  • Moodle Administrative Cron: This is part of the Moodle administrative cron that runs approximately once every 30 minutes. This cron looks for differences between Conduit and Moodle, and if it finds any, it updates one or the other depending on your settings. This cron is used to keep Conduit and Moodle in sync when users change information in Moodle that is inaccurate, or if a Conduit sync failed to update Moodle.

3.2. Web Services

3.2.1. Introduction

As of version 1.2 of Conduit, Moodlerooms has introduced the option to create users, course and enrollments through a restful Web service. This document is intended for technical programmers to develop services for their student information or data system that send RESTful Web service requests to the Conduit.
Document Revision 1.4.1

3.2.2. Web Service Basics

The Conduit RESTful Web service is broken up into five different Web service end points:

  1. user
  2. course
  3. enrol
  4. groups
  5. groupmembers

Each Conduit RESTful Web service is called from an HTTPS URL. An example URL is:

The site would be replaced with the client’s Moodlerooms site URL – usually something like clientname.mrooms.net. The service_name would be replaced with either user, course, enrol, groups or groupmembers.

Each of the Conduit RESTful Web services require two HTML post variables to be passed via an HTTPS call. These variables are:

  • string token: (Required) Set to the Token setting value used in Conduit Settings tab > Web services sub-tab.
  • string method: (Required) Must be set to the name of the method being called

3.2.2.1. Handle Method for all web services

The basic XML structure for all requests to all end points that use the "handle" method is as follows:

There are three variable values within this basic structure: action, mappingname and value. The action variable contains the action that you want the Conduit to execute. The mappingname is the value of the mapped field in the Conduit that the value variable will set. For example if I wanted to update the mapped field named “username” to “johndoe,” my XML would look like:

Each XML request can have datum with their own actions, and an XML file can mix action types as well.

The Conduit’s XML response structure looks like the following. Each Web service end point will respond in a similar manner. The only part that will change is the service name variable in the structure below. This value will be the name of the end point.

3.2.3. User Web Service

3.2.3.1. End Point

https://<site>/uib/public/rest/user

3.2.3.2. Methods

3.2.3.2.1. get_user

Get a Moodle user's profile data with custom profile fields.

3.2.3.2.1.1. POST Parameters:
  • string token: (Required) Set to the Token setting value used in Conduit Settings tab > Web services sub-tab.
  • string method: (Required) Must be set to 'get_user'
  • string value: (Required) The user value to lookup, EG: the user's username.
  • string field: (Optional, default = 'username') The Moodle table field to lookup against. Can be id, username, idnumber or email.
3.2.3.2.1.2. Returned XML schema
3.2.3.2.2. get_user_course_recent_activity

The Conduit user web service's get_user_course_recent_activity method provides and external interface to retrieve the logged information about a users activity with in a course for a period of time.

3.2.3.2.2.1. POST Parameters
  • string token: (Required) Set to the Token setting value used in Conduit Settings tab > Web services sub-tab.
  • string method: (Required) Must be set to 'get_user_course_recent_activity'
  • string username: (Required) The user's username
  • string course: (Optional, default = NULL) The course's idnumber - if not passed, all user courses are returned
  • int fromdate: (Optional, default = NULL) Unix timestamp of the start date
3.2.3.2.2.2. Returned XML Format
3.2.3.2.2.3. Example Return XML
3.2.3.2.3. get_user_course_activities_due

The Conduit User web service's get_user_course_activities_due method provides external access to the activities that a user has due in a course within a given time period.

3.2.3.2.3.1. POST Parameters
  • string token: (Required) Set to the Token setting value used in Conduit Settings tab > Web services sub-tab.
  • string method: (Required) Must be set to 'get_user_course_activities_due'
  • string username: (Required) The user's username
  • int todate: (Required) Unix timestamp of the end date
  • string course: (Optional, default = NULL) The course's idnumber - if not passed, all user courses are returned
3.2.3.2.3.2. Returned XML Format
3.2.3.2.3.3. Example Return XML
3.2.3.2.4. get_user_course_events

The Conduit user web service get_user_course_events method provides external access to the users calendar events within a course.

3.2.3.2.4.1. POST Parameters
  • string token: (Required) Set to the Token setting value used in Conduit Settings tab > Web services sub-tab.
  • string method: (Required) Must be set to 'get_user_course_events'
  • string username: (Required) The user's username
  • int fromdate: (Required) Unix timestamp of the start date
  • int todate: (Required) Unix timestamp of the end date
  • string course: (Optional, default = NULL) The course's idnumber - if not passed, all user courses are returned
3.2.3.2.4.2. Returned XML Format
3.2.3.2.4.3. Example Return XML
3.2.3.2.5. get_user_grades

The Conduit User and course web services provided external systems with a way to extract grades from Moodle. There are settings specifically for these services and they can be found in Grades section under the Conduit Settings tab > Web services sub-tab. Conduit provides two endpoints to retrieve Moodle grades.

3.2.3.2.5.1. POST parameters:
  • string token: (Required) Set to the Token setting value used in Conduit Settings tab > Web services sub-tab.
  • string method: (Required) Must be set to 'get_user_grades'.
  • string user: (Required) The user to return the grades for.
  • int batchsize: (Optional) The number of grades to return. Must be less than 10,000.
  • int lastprocessedid: (Optional) The last grade ID processed and returned from the web service. This helps with crawling though all of the Moodle grades because if you pass it, the service will only return grades with IDs that are greater than this one.
  • int starttime: (Optional) Use to get grades that have been modified after this time. Pass in the form of a Unix time stamp.
  • int endtime: (Optional) Use to get grades that have been modified before this time. Pass in the form of a Unix time stamp.
  • string course: (Optional) Use to get the grades from a specific course for the user. The value must be either course shortname or idnumber based on the Course ID setting found in Conduit Settings tab > General sub-tab. If omitted, all user grades are returned.
  • string itemtypes: (Optional, default = 'DEFAULT_SET') Pass a CSV list of grade item types to include. For all item types pass an empty string. To get the default grade items that are configured through Conduit, then do not pass this param or set it to 'DEFAULT_SET'
3.2.3.2.5.2. Returned XML schema

Both grade web service endpoints return the same XML schema. The schema returns the grade items and their grades. The user and course tags act like dictionaries as they contain all of the users and courses that the grade items and grades belong to. Use the courseid and the userid tags to look up their corresponding courses and users. The lastprocessedid tag is the last grade ID that the web service processed. Use this value if you wish to use the lastprocessedid web service parameter.

item types: course, mod, category, manual, null

3.2.3.2.6. handle
3.2.3.2.6.1. POST Parameters
  • string token: (Required) Set to the Token setting value used in Conduit Settings tab > Web services sub-tab.
  • string method: (Required) Must be set to 'handle'
  • string xml: (Required) XML schema that contains data for performing operations on Conduit records
3.2.3.2.6.2. Valid Actions
  • create
  • update
  • delete
3.2.3.2.6.3. Create Action XML Definition
3.2.3.2.6.4. Update Action XML Definition
3.2.3.2.6.5. Delete Action XML Definition
3.2.3.2.6.6. Response XML Definition

3.2.4. Course Web Services

3.2.4.1. End Point

https://<site>/uib/public/rest/course

3.2.4.2. Methods

3.2.4.2.1. get_course

Get Moodle course settings.

3.2.4.2.1.1. POST Parameters
  • string token: (Required) Set to the Token setting value used in Conduit Settings tab > Web services sub-tab.
  • string method: (Required) Must be set to 'get_course'
  • string value: (Required) The course value to lookup, EG: the course's shortname.
  • string field: (Optional, default = 'shortname') The Moodle table field to lookup against. Can be id, shortname or idnumber.
3.2.4.2.1.2. Returned XML schema
3.2.4.2.2. get_course_grades

The Conduit course web services provided external systems with a way to extract grades from Moodle. There are settings specifically for these services and they can be found in Grades section under the Conduit Settings tab > Web services sub-tab. Conduit provides two endpoints to retrieve Moodle grades.

3.2.4.2.2.1. POST parameters
  • string token: (Required) Set to the Token setting value used in Conduit Settings tab > Web services sub-tab.
  • string method: (Required) Set to get_course_grades
  • string course: (Optional) Use to get the grades from a specific course for the user. The value must be either course shortname or idnumber based on the Course ID setting found in Conduit Settings tab > General sub-tab. If omitted, all courses are returned.
  • int batchsize: (Optional) The number of grades to return. Must be less than 10,000.
  • int lastprocessedid: (Optional) The last grade ID processed and returned from the web service. This helps with crawling though all of the Moodle grades because if you pass it, the service will only return grades with IDs that are greater than this one.
  • int starttime: (Optional) Use to get grades that have been modified after this time. Pass in the form of a Unix time stamp.
  • int endtime: (Optional) Use to get grades that have been modified before this time. Pass in the form of a Unix time stamp.
  • string itemtypes: (Optional, default = 'DEFAULT_SET') Pass a CSV list of grade item types to include. For all item types pass an empty string. To get the default grade items that are configured through Conduit, then do not pass this param or set it to 'DEFAULT_SET'
3.2.4.2.2.2. Returned XML schema

Both grade web service endpoints return the same XML schema. The schema returns the grade items and their grades. The user and course tags act like dictionaries as they contain all of the users and courses that the grade items and grades belong to. Use the courseid and the userid tags to look up their corresponding courses and users. The lastprocessedid tag is the last grade ID that the web service processed. Use this value if you wish to use the lastprocessedid web service parameter.

item types: course, mod, category, manual, null

3.2.4.2.3. handle
3.2.4.2.3.1. POST Parameters
  • string token: (Required) Set to the Token setting value used in Conduit Settings tab > Web services sub-tab.
  • string method: (Required) Must be set to 'handle'
  • string xml: (Required) XML schema that contains data for performing operations on Conduit records
3.2.4.2.3.2. Valid Actions
  • create
  • update or change
  • delete or remove
3.2.4.2.3.3. Create Action XML Definition
3.2.4.2.3.4. Update Action XML Definition
3.2.4.2.3.5. Delete Action XML Definition
3.2.4.2.3.6. Response XML Definition

3.2.5. Enroll Web Service

3.2.5.1. Enroll Web Service End Point

https://<site>/uib/public/rest/enrol

3.2.5.2. Methods

3.2.5.2.1. handle
3.2.5.2.1.1. POST Parameters
  • string token: (Required) Set to the Token setting value used in Conduit Settings tab > Web services sub-tab.
  • string method: (Required) Must be set to 'handle'
  • string xml: (Required) XML schema that contains data for performing operations on Conduit records
3.2.5.2.1.2. Valid Actions
  • add or create
  • update
  • drop or delete
3.2.5.2.1.3. Add Action XML Definition
3.2.5.2.1.4. Drop Action XML Definition
3.2.5.2.1.5. Response XML Definition

3.2.6. Groups Web Service

3.2.6.1. End Point

https://<site>/uib/public/rest/groups

3.2.6.2. Methods

3.2.6.2.1. handle
3.2.6.2.1.1. POST Parameters
  • string token: (Required) Set to the Token setting value used in Conduit Settings tab > Web services sub-tab.
  • string method: (Required) Must be set to 'handle'
  • string xml: (Required) XML schema that contains data for performing operations on Conduit records
3.2.6.2.1.2. Valid Actions
  • create
  • update
  • delete
3.2.6.2.1.3. Create Action XML Definition
3.2.6.2.1.4. Update Action XML Definition
3.2.6.2.1.5. Delete Action XML Definition
3.2.6.2.1.6. Response XML Definition
3.2.6.2.2. get_groups

Get groups in a course

3.2.6.2.2.1. POST Parameters
  • string method: (Required) Must be set to 'get_groups'
  • string value: (Required) The course value to lookup
  • string field: (Optional, default = 'idnumber') The course field to match the value against, can be id, shortname or idnumber
3.2.6.2.2.2. Response XML Definition

3.2.7. Group Members Web Service Definition

3.2.7.1. End Point

https://<site>/uib/public/rest/groupmembers

3.2.7.2. Methods

3.2.7.2.1. handle
3.2.7.2.1.1. POST Parameters
  • string token: (Required) Set to the Token setting value used in Conduit Settings tab > Web services sub-tab.
  • string method: (Required) Must be set to 'get_user_course_events'
  • string xml: (Required) XML schema that contains data for performing operations on Conduit records
3.2.7.2.1.2. Valid Actions
  • create
  • delete
3.2.7.2.1.3. Create Action XML Definition
3.2.7.2.1.4. Delete Action XML Definition
3.2.7.2.1.5. Response XML Definition

3.3. ASP.Net Web Service Code Examples

3.3.1. User Web Service Examples

3.3.1.1. Methods

3.3.1.1.1. get_user
3.3.1.1.2. get_user_course_recent_activity
3.3.1.1.3. get_user_course_activities_due
3.3.1.1.4. get_user_course_events
3.3.1.1.5. get_user_grades
3.3.1.1.6. handle
3.3.1.1.6.1. Action create
3.3.1.1.6.2. Action update
3.3.1.1.6.3. Action delete

3.3.2. Course Web Service Examples

3.3.2.1. Methods

3.3.2.1.1. get_course
3.3.2.1.2. get_course_grades
3.3.2.1.3. handle
3.3.2.1.3.1. Action create
3.3.2.1.3.2. Action update
3.3.2.1.3.3. Action delete

3.3.3. Enroll Web Service Examples

3.3.3.1. Methods

3.3.3.1.1. handle
3.3.3.1.1.1. Action Add
3.3.3.1.1.2. Action drop

3.3.4. Groups Web Service Examples

3.3.4.1. Methods

3.3.4.1.1. handle
3.3.4.1.1.1. Action create
3.3.4.1.1.2. Action update
3.3.4.1.1.3. Action delete

3.3.5. Group Members Web Service Examples

3.3.5.1. Methods

3.3.5.1.1. handle
3.3.5.1.1.1. Action create
3.3.5.1.1.2. Action delete
h2. HTML Web Service Code Examples

3.3.6. User Web Service Examples

3.3.6.1. Methods

3.3.6.1.1. get_user

Create a file called Conduit_get_user.html on your web server and insert the html code below:

Enter guest for the username.

3.3.6.1.2. get_user_course_recent_activity

Create a file called Conduit_get_user_course_recent_activity.html on your web server and insert the html code below:

Enter guest for the username.

3.3.6.1.3. get_user_course_activities_due

Create a file called Conduit_get_user_course_activities_due.html on your web server and insert the html code below:

Enter guest for the username and use http://www.unixtimestamp.com/index.php to enter the current unix time stamp.

3.3.6.1.4. get_user_course_events

Create a file called Conduit_get_user_course_events.html on your web server and insert the html code below:

Enter guest for the username and use http://www.unixtimestamp.com/index.php to enter the current unix time stamp and to create a unix time stamp for fromdate.

3.3.6.1.5. get_user_grades

Create a file called Conduit_get_user_course_recent_activity.html on your web server and insert the html code below:

Set the user to username for a user that has grade data in a course.

3.3.6.1.6. handle

Create a file called Conduithandle.html on your web server and insert the html code below:

3.3.6.1.6.1. Action create

Insert the following xml to test user creation in the xml field then click submit:

3.3.6.1.6.2. Action update

Insert the following xml to test user update creation in the xml field then click submit:

3.3.6.1.6.3. Action delete

Insert the following xml to test deletion creation in the xml field then click submit:

3.3.7. Course Web Service Examples

3.3.7.1. Methods

3.3.7.1.1. get_course

Create a file called Conduit_get_course.html on your web server and insert the html code below:

Set the course to CF101 where there is a course with the shortname CF101 on the site.

3.3.7.1.2. get_course_grades
3.3.7.1.3. handle

Create a file called Conduit_course_handle.html on your web server and insert the html code below:

3.3.7.1.3.1. Action create

Insert the following xml to test course creation in the xml field then click submit:

3.3.7.1.3.2. Action update

Insert the following xml to test course change in the xml field then click submit:

3.3.7.1.3.3. Action delete

Insert the following xml to test course remove in the xml field then click submit:

3.3.8. Enroll Web Service Examples

3.3.8.1. Methods

3.3.8.1.1. handle

Create a file called Conduit_enrol_handle.html on your web server and insert the html code below:

3.3.8.1.1.1. Action add

Insert the following xml to test enroll add in the xml field then click submit:

3.3.8.1.1.2. Action drop

Insert the following xml to test enroll drop in the xml field then click submit:

3.3.9. Groups Web Service Examples

3.3.9.1. Methods

3.3.9.1.1. handle

Create a file called Conduit_groups_handle.html on your web server and insert the html code below:

3.3.9.1.1.1. Action create

Insert the following xml to test group creation in the xml field then click submit:

3.3.9.1.1.2. Action update

Insert the following xml to test group update in the xml field then click submit:

3.3.9.1.1.3. Action delete

Insert the following xml to test group delete in the xml field then click submit:

3.3.10. Group Members Web Service Examples

3.3.10.1. Methods

3.3.10.1.1. handle

Create a file called Conduit_group_members_handle.html on your web server and insert the html code below:

3.3.10.1.1.1. Action create

Insert the following xml to test group creation in the xml field then click submit:

3.3.10.1.1.2. Action delete

Insert the following xml to test group deleton in the xml field then click submit:

3.4. PHP Web Service Code Examples

3.4.1. User Web Service Examples

3.4.1.1. Methods

3.4.1.1.1. get_user
3.4.1.1.2. get_user_course_recent_activity
3.4.1.1.3. get_user_course_activities_due
3.4.1.1.4. get_user_course_events
3.4.1.1.5. get_user_grades
3.4.1.1.6. handle
3.4.1.1.6.1. Action create
3.4.1.1.6.2. Action update
3.4.1.1.6.3. Action delete

3.4.2. Course Web Service Examples

3.4.2.1. Methods

3.4.2.1.1. get_course
3.4.2.1.2. get_course_grades
3.4.2.1.3. handle
3.4.2.1.3.1. Action create
3.4.2.1.3.2. Action update
3.4.2.1.3.3. Action delete

3.4.3. Enroll Web Service Examples

3.4.3.1. Methods

3.4.3.1.1. handle
3.4.3.1.1.1. Action Add
3.4.3.1.1.2. Action drop

3.4.4. Groups Web Service Examples

3.4.4.1. Methods

3.4.4.1.1. handle
3.4.4.1.1.1. Action create
3.4.4.1.1.2. Action update
3.4.4.1.1.3. Action delete

3.4.5. Group Members Web Service Examples

3.4.5.1. Methods

3.4.5.1.1. handle
3.4.5.1.1.1. Action create
3.4.5.1.1.2. Action delete

4. Course Formats

4.1. Flexpage

4.1.1. Overview

The Flexpage is a course format that provides a teacher with complete control of how a education materials and assessments are presented to a student. Flexpage allows a teacher to create a flexible set of pages and sub pages where blocks and activities can be placed in any location on the page instead of being restricted to a right left or center column. Flexpage courses provided teachers with the ability to determine how many columns of data are contained within a course up to three-columns. This allow a teacher to have complete control over how they want to present course materials and assessments to the student.

The basic features of Flexpage are:

  • Multiple Pages: A Flexpage course can contain an infinite number of pages. Each page can contain different or the same blocks, activities and resources as another page.
  • Child Pages: A Flexpage course can contain an infinite number of child pages and children of child pages in a infinite sub structure. This parent child relationship allows a teacher to create a unique course structure based on their teaching style and preference.
  • 1, 2 and 3 Column View: Moodle blocks and modules can be assembled in any order in up to 3 columns on the page.
  • Inline Resource/Activity Display: The format can be extended to display resource and activity content inline (in the page). This currently only works for forums, assessments and resources - other activities show a link as expected.
  • Previous/Next Button: When you enter a Flexpage, there are previous and next arrows to return you to the page you were previously on.
  • Parent-Child Links: A page can have child pages (which appear as a link below their parent page), and child pages can have child pages (which appear upon clicking the child page).
  • Top Menu Tabs: A parent page can create a top menu tab with Flexpage.
  • Page Menu: This activity block provides a Table of Content style menu system for ease of navigating your pages.
  • Role-Based Menus: There is a "view menu" role to allow menus to be hidden or shown depending on the user's assigned role.
  • Backup and Restore: Any course in Flexpage format can be fully or partly backed up and copied to another course.
  • Page locking: Pages of content can be hidden and released to a user based on the completion of other assignments.

4.1.2. Usage Scenarios

4.1.2.1. Flexpage as a Front Page Portal

Flexpage can be enabled at the site level, which allows site administrators to create multiple pages with page menus at the site level. Having multiple pages allows the site administrator to create a portal-like landing page with more than just the list of courses that the user is enrolled in. Site administrators can add pages that contain content about the organization, contact information, support pages, example courses, video examples and so forth. Through the use of the Courses Available to You block, site administrators can also create several pages that are focused on specific categories of courses, departments or other information.

Example flex page as a front page portal

4.1.2.2. Flexpage as a Landing Page

Flexpage combined with the Profile Redirect block allows a site administrator to create unique landing pages/courses for users based on a custom profile field. The Profile Redirect block automatically redirects a user to a course with the same name as a value in the user's profile field. This secondary course becomes a default landing page for the user, similar to the site-level course being a landing page. The course can contain display information to the user that is associated with the profile field. For example, a user who is part of a Biology department can be forwarded to the Biology department's main course page. There the head of the Biology department can customize the course environment to focus on Biology-specific information, such as Biology events, a department forum, questionnaires and/or a page about the faculty in the Biology department.

Flex page as a landing page process map

4.1.3. Teacher Documentation

4.1.3.1. Adding a Page

The Add Page tab allows a teacher to add an infinite number of top pages and sub pages to a course. Pages are the basis for Flexpage and allow a teacher to group content by topic.

Flexpage add a page settings

  • Page Name: The name of the page displayed in all administrative interfaces, page drop-down selection, and manage pages. This will also be the name of the page in the top tab and page menu if Name to Show in Page menu is left blank.
  • Name to Show in Page menu: The value used in this setting will be displayed instead of the Page Name value in a page menu.
  • Publish: Determines if the page is viewable by students or not. This can be used to hide content that is being worked on or teacher/administrator-only pages.
  • Display in Page menu: This settings determines if the page displays when added to a page menu.
  • Display as Top Tab: This setting determines if the page displays as a top tab. This is recommended to be set to no and instead use page menus. Top tab pages do not have sub menus like page menus do – they just display the name of the page.
  • Left Column Width: The width of the left-side column. Appropriate values are CSS width attribute length or percentage value types. If no type is specified, the pixel length type is assumed. Zero means that the column will not be displayed if no blocks are added to it. Example: 100%, 100px, 100cm or 100
  • Center Column Width: The width of the center column. Appropriate values are CSS width attribute length or percentage value types. If no type is specified, the pixel length type is assumed. Zero means that the column will not be displayed if no blocks are added to it. Example: 100%, 100px, 100cm or 100
  • Right Column Width: The width of the right column. Appropriate values are CSS width attribute length or percentage value types. If no type is specified, the pixel length type is assumed. Zero means that the column will not be displayed if no blocks are added to it. Example: 100%, 100px, 100cm or 100
  • Previous & Next Link: This setting determines if the Previous or Next links display on a page if there is a page before or after it in the Manage Pages order.
    • No Links - No links will be displayed on the Flexpage, regardless if there are other pages before or after this page.
    • Previous Page only - The Previous link will appear if there is a page before this page in the page order.
    • Next Page only - The Next link will appear if there is a page after this page in the page order.
    • Both Previous and Next Page - The Previous link will appear if there is a page before this page in the page order, and the Next link will appear if there is a page after this page in the page order.
  • Use page settings as default: This setting determines if the current settings will be used when adding a page from now on for this course.
  • Select Parent Page: This drop-down menu allows the teacher to select a parent page for this page from a list of existing pages. This makes the new page a child or sub page from the start. You can make a page a child later by editing its settings or using the move interface in the Manage Pages tab.
Combining top tabs and page menus
It is not recommended to combine pages set as top tabs and page menus. The page menu order and the top tab order do not work together – top tab pages are displayed first with the greatest weight.

4.1.3.2. Managing Pages

The Manage Pages tab provides the teacher with an overview of all the pages in the course and access to several key settings. The interface provides quick access to the following:

  1. Edit a page
  2. Move a page (reorder or make a page a child page)
  3. Delete a page
  4. Change a top page's Display as Top Tab setting to "yes" or "no"
  5. Change a page's Display in Page menu status to "yes" or "no"
  6. Change a page's Publish status
  7. Access the Page locking interface for the page
Changing settings
Manage Pages allows quick access changes to several page settings: Display as Top Tab, Display in Page and Publish. Each of these settings has a value of "yes" or "no." An open eye icon means "yes" and a closed eye icon means "no" for the setting.
4.1.3.2.1. Moving Pages

Pages have an order and a hierarchy to them. The move interface allows a teacher to move pages into a different order or designate the pages as a sub or child page of another page. To move a page, perform the following steps:

  1. Click on the Manage Pages tab
    Manage pages tab selected
  2. Click the move icon
    Manage pages move pages interface
  3. You will then see a screen like the one below:
    Manage pages interface when a page is being moved

From here you have 2 options:

  1. Move the page into a different order by clicking on the dotted box next to the as the first master page
  2. Make the page a child page of another page by clicking on the dotted box next to the as a child of <page name>
4.1.3.2.2. Child Pages

Pages in the Flexpage format can have parent/child relationships for easy grouping. Child pages show up as nested pages of the parent in the page menu. There is no limit to the number of levels you can nest pages in the Flexpage format.

4.1.3.3. Managing Activities/Resources

The Manage Activities tab is used to add, edit and delete all activities and resources that have been associated with the course. The same Add an activity and Add a resource drop-down menus display in this interface the same as they appear in sections of the Topics and Weekly formatted courses. Activities and resources are displayed alphabetically with the edit and delete action icons displayed to the right of the activity or resource name.

Manage activities tab selected

4.1.3.3.1. Adding Activities/Resources

Adding an activity or a resource to a course is done the same way as with the Topics and Weekly formatted courses. The teacher selects the activity from the Add an activity drop-down menu or a resource from the Add a resource drop-down menu.

Add and activity drop down with all activities in the course listed

After adding an activity or resource and clicking on the Save and return to course button, the last page accessed is displayed. The assumption is that the teacher is adding one activity at a time to a page.

4.1.3.3.2. Edit/Deleting Activities/Resources

Use the Manage Activities tab to edit or delete any resources or activities in your course.

Edit and delete icons to the right of the activity name

Editing activities and resources is done by clicking the edit button next to their name. This will bring you to the usual editing screen for that activity or resource type.

The delete button will delete the activity or resource from the course. This will remove all data associated with that activity or resource and all instances of it on a page. If you click the delete link, Moodle will warn you that you are about to delete the activity. If you click this link accidentally, simply click the Cancel button to cancel the deletion.

4.1.3.4. Page Content

Course content (activities, blocks and/or resources) are displayed as blocks on a page. The same commands that govern how a block is moved, edited or removed from a Topics or Weekly course. The only difference is that the Edit icon for an activity or resource brings the teacher to the update activities or resources interface.

4.1.3.4.1. Adding Blocks to a Page

The Flexpage format uses the standard Moodle interface for adding blocks. To add a new block, simply choose the block from the Add Block... drop-down menu. At this time, you should add the administration block to your first page.

Add a block drop-down with all blocks listed

By default, new items are placed in the center/bottom of the page.

4.1.3.4.1.1. Sticky Blocks

The course sticky blocks (permanent default blocks) will apply to all course pages on the site, including the front page course. Once in place, the sticky block will not give the course editor the option to delete it from the course page nor will it give the option to move it. You should take this into consideration when designing courses and when selecting blocks to make "sticky." Please also note that, if the column in which the sticky block is being placed is too small, contents may be displayed incorrectly. Additionally, if a sticky block duplicates another block on a course page, there may be strange side effects in functionality. For these reasons (and more), it is recommended that sticky blocks are used sparingly.

4.1.3.4.2. Adding Activities/Resources to a Flexpage

Adding activities and resources to a Flexpage is different from adding activities to a standard Moodle format. Activities are added by selecting the activity from the Add Existing Activity... drop-down menu.

Add and activity drop down with all activities in the course listed

Depending on the activity/resource type, it will either display directly within the page (for Moodle Web Pages and HTML resources, forums and assessments) or it will show up as a link to the activity. New activities and resources are added to the bottom center of the page by default.

4.1.3.4.3. Moving Content

With editing turned on, you can move blocks, resources and activities into new positions, just like you would in a standard Moodle layout, by pressing the left, up, down or right arrows beneath the name of the item.

Block with move icons shown

4.1.3.5. Page Locking

With page locking, you can ensure your learner has completed the week/unit activities before moving on to new material. You can create a lock that is dependent on accessing material and/or the receipt of a grade for an activity or assignment. This creates the opportunity to build in review material and practice activities before low-scoring students are able to move on in the course.

4.1.3.5.1. General

Page locking general settings area

  • Show pre-requisites: When set to "Yes," the user will receive detailed prerequisite information on how to unlock the page. When set to "No," the user will receive a generic message that the page is locked.
  • Visible when locked: When set to "Yes," the page and its children will appear in the page menu. If the page is locked for the current user, a lock icon will appear next to the page's name. When set to "No," the page and its children will not appear in the page menu.
4.1.3.5.2. Graded Activity Lock

Page locking graded activity lock settings area

  • Required grade: This setting determines the grade or grade range that a user must earn in the activity before the lock is satisfied. To do a grade range, enter in a value formatted like "low:high" where low is the bottom of the range and high is the top of the range. Examples:
    • When set to 50, the user must earn a grade of 50 or more.
    • When set to 10:20, the user must earn a grade equal to or between 10 and 20.
    • When set to 0:10, the user must earn a grade of less than or equal to 10.
4.1.3.5.3. All Lock Type Setting

Page locking settings remove a lock checkbox

  • Remove this lock: This checkbox is used to remove the lock from the page. Once it is checked and the page is saved, the lock will be removed from the page.
4.1.3.5.4. Add a Page Lock

The are three types of page locks that can be created for a page. Each type will only be selectable if there is an activity or resource associated with the course that can satisfy the type's unlock requirement. Each type is displayed under the Add a page lock section of the page locking interface.

  • Add activity accessed: This lock is based on the Moodle logs, and once an activity logs access information about a user, this lock is considered satisfied. This lock does not work with activities that do not create Moodle logs.
  • Add graded activity item: This lock is based on graded activity items in this course's grade book. The lock is satisfied once a user scores a grade that meets the lock's grade requirements.
  • Add activity submitted: This lock is based on the Moodle logs, and once an activity logs submission information about a user, this lock is considered satisfied. This lock does not work with activities that do not create Moodle logs and do not register their submit log actions.

To set up page locking on a page, do the following:

  1. Click the Manage Pages tab.
  2. Click the lock icon next to the page you wish to set a lock on.
  3. Use the Choose drop-down menu to select either an activity accessed (the student opened the resource or activity) or a graded activity item (the student has received a grade for the activity).
  4. Add as many locks as you need using the Choose drop-down menu. You can require learners to access or complete more than one activity before they're able to open this page.
  5. For graded activity items, you need to define either the minimum grade or grade range required to access this page.
  6. Define the settings for this lock.
4.1.3.5.5. Remove a Page Lock

To remove your access or grade-based activity locks, do the following:

  1. Click the Manage Pages tab.
  2. Click the lock icon next to the page you wish to set a lock on.
  3. Select the Remove this lock checkbox.
  4. Click the Save Changes button.

4.1.4. Global Settings

4.1.4.1. Front Page Settings

When Flexpage is enabled for a site, a new setting is added to the Front page settings interface below the Default frontpage role settings called Show page format on front page.

Flexpage global settings page

  • Show page format on front page: When enabled, the front page course for the site will be displayed in the Flexpage format.

4.1.5. Permissions

  • Add New Pages: This permission allows a user to add a new page to the Flexpage course.
    • Default Permissions
      Role Not Set Allow Prevent Prohibit
      Administrator   X    
      Course Creator   X    
      Teacher   X    
      Non-Editing Teacher X      
      Student X      
      Guest X      
      Authenticated User X      
  • Edit Pages and Page Settings: This permission allows a user to edit page settings as well as modify what is displayed on the page.
    • Default Permissions
      Role Not Set Allow Prevent Prohibit
      Administrator   X    
      Course Creator   X    
      Teacher   X    
      Non-Editing Teacher X      
      Student X      
      Guest X      
      Authenticated User X      
  • Use Manage Pages Settings: This permission allows the user to change settings for pages via the Manage page settings tab.
    • Default Permissions
      Role Not Set Allow Prevent Prohibit
      Administrator   X    
      Course Creator   X    
      Teacher   X    
      Non-Editing Teacher X      
      Student X      
      Guest X      
      Authenticated User X      
  • View Hide/Show Pages (Modules) Settings: This permission allows the user to view the page's hide and show settings but no other settings for the page. This also allows a user to view hidden pages.
    • Default Permissions
      Role Not Set Allow Prevent Prohibit
      Administrator   X    
      Course Creator   X    
      Teacher   X    
      Non-Editing Teacher X      
      Student X      
      Guest X      
      Authenticated User X      

5. eFolio

5.1. eFolio Site

5.1.1. Overview

Moodlerooms' eFolio product is an integration between an institution's Joule site and the institution's Moodlerooms hosted eFolioWorld site. The basic feature of the integration is a single sign-on connection between Joule and eFolio, allowing a user to seamlessly navigate between the two systems without re-authenticating. The integration also provides an assignment, which allows a student to submit an eFolio item to an assignment and the teacher to view that eFolio item and grade the assignment.

5.1.2. User Documentation

Below is a list of sites that document the use of eFolio by a student:

5.1.3. Administrator Documentation

5.1.3.1. Validate Required Settings

5.1.3.1.1. Validate That SSL is Enabled and Active on Your Site

An SSL certificate is required for the single sign-on between Joule and eFolio to work. SSL certificates are purchased from Moodlerooms and enabled by Moodlerooms systems administrators. To validate that SSL is enabled for your site, navigate to https://<your site url>. You should see the front page to your site. If you do not, please inform your implementation specialist or send an e-mail to Moodlerooms Support at support@moodlerooms.com.

5.1.3.1.2. Validate That Conduit is Enabled

Conduit's Web services are used by the eFolio-to-Joule integration for single sign-on and other features. As such, it is recommended that an administrator validate that the Conduit block is installed. The block is installed if it is listed under Site Administration block > Modules > Blocks > Manage blocks. Once it is installed, add it to your site page and run http://<your site url>/uib/scripts/install.php to make sure Conduit is installed. Usually Moodlerooms employees will execute all of these processes.

5.1.3.2. Enable eFolio Authentication Plug-In

The eFolio authentication plug-in is required to connect the user with eFolio via single sign-on. Users do no need to have their authentication set to eFolio as they are not authenticating against eFolio. This means that eFolio will work with other authentication systems, such as LDAP, Shibboleth and Conduit. Validate that the eFolio authentication plug-in is enabled by going to Site Administration block > Authentication > Manage authentication. Make sure that the eye icon next to the eFolio plug-in name is open.

If the eye icon is closed, click on it to activate/show the eFolio authentication plug-in.

5.1.3.3. Enable eFolio Block

In order for the integration to work, the eFolio block must be installed and enabled on the site. The block is installed if it is listed under Site Administration block > Modules > Blocks > Manage blocks. This same screen will show if the block is enabled via the eye icon to the right of the block name. This eye icon should be open if it is enabled, as shown in the screen shot below:

6. Express

6.1. Overview

Moodlerooms has developed enhanced branding capabilities to provide both basic and advanced users with tools to completely customize the appearance of their site, course categories and courses. Express places the branding power in the client’s hands and provides the following benefits:

  • Access to Joule or Power’s dynamic information about users and courses
  • Ability to change appearance with and without advanced coding skills
  • Creation of templates that can be selected or have their colors altered by an instructor at the course level
  • Real-time updates to the branding and appearance
  • Site-wide templates for consistent site-wide look and feel, with personal touches at the department or course level
  • Easy to modify dynamic/drop down navigational menus

Express is an upgrade, redesign and rebranding of Moodlerooms' previous mPower template system. It encompasses all of mPower's features and more.

6.2. Express Comparison

Feature Express mPower Moodle 1.9 theme Moodle 2.0 theme
Site-level look and feel X X X X
Category-level look and feel X X X X
Course-level look and feel X X X X
Site-level dynamic navigation menus X     X
Category-level dynamic navigation menus X      
Course-level dynamic navigation menus X      
Ability to upload look and feel X X   X
Site-level custom icons X X X X
Category-level custom icons X   X X
Course-level custom icons X   X X
Easy access to dynamic user information X X    
No redesign required to work with Moodle 2.0 X     X
Moodlerooms support in Joule 2.0 X     X
Instant look and feel updates for Moodlerooms hosting X X    
Easy ability for a developer to display category that a course is in within the Moodle navigation breadcrumb X X   X
Easy ability for a developer to display a user's course list as a dynamic drop down X X    
Ability for teachers to change course look and feel based on a predefined template uploaded by an administrator X      
Ability to create a look and feel without Moodle or PHP knowledge X X    

6.2.1. Differences between Express and mPower

Express is an upgraded version of mPower that has been rebranded and slightly redesigned to improve performance, fix design flaws, add new features, and align Express with Moodle 2.0 themes.

The differences between Express and mPower are:

  1. Nomenclature changes
  2. New file structure
  3. New features

6.2.1.1. Nomenclature changes

In the past, Moodlerooms has used the nomenclature mPower template or mPower theme to refer to files that were used to create a look and feel via the mPower theme. These terms often caused confusion when a client read about Moodle themes. mPower also caused confusion with Moodlerooms' mPower Partner Plug-in program, which was developed to create business partnerships between Moodlerooms and third-party vendors wishing to integrate with Moodle and Joule.

Moodlerooms now calls mPower templates or themes Express designs. Moodlerooms has also added a new feature called Express templates. Express templates are used in the Express block's Create a Design tab to create an Express design. In the past, Moodlerooms has named the block that works with mPower both mPower and Express Designer. With the rebranding, Moodlerooms has standardized the use of the word Express in relation to this feature, and the Express Designer was renamed the Express block.

6.2.1.2. New file structure

mPower used the Front Page > Site Files > theme directory in the past. It was determined that if client changed the ID associated with this directory in their Moodle data directory that mPower would stop working. Moodlerooms has redesigned express to work with its own unique directory structure within the Moodle data directory. This has allowed Moodlerooms to add new features such as design backups, Express templates and Express menus. This will also allow Express to be forward compatible with Express in Joule 2.0, requiring no redesign -- unlike Moodle 1.9 themes.

6.2.1.3. New features

Express adds several new features over mPower:

  1. User editable menus within the Express block
  2. Menus can be inherited from the site or category at the course level
  3. Administrators can upload Express templates to allow teachers or course creators to customize Express designs from a pre-approved template
  4. Improved caching
  5. Ability to include JavaScript files in designs and templates
  6. Access to a greater number of areas to control color for a template
  7. Improved backup and restore of designs within a course
  8. Backup of a design in a ZIP format that can be downloaded

6.3. Difference between Express design and Express template

Express designs are created from Express templates. By default Express comes with the Moodlerooms developed Joule template. Express allows clients to create new templates with color variants and upload them to their site for use within the Create a Design tab in the Express block. Moodlerooms will be adding more templates as standard options to Express in the coming Joule releases.

6.4. Express Design Technical

6.4.1. Introduction

The Express block allows end users to create an Express design from an Express template. Alternatively, a user can create an Express design manually. An Express design is a series of folders and files that allow users with CSS, HTML and Web design skills to customize the look and feel of their site, course categories or courses. This document covers the Express design structure and all the variables that can be used in an Express design. This document is considered a technical reference and is referenced by all tutorials on Express designs.

This document covers the technical aspects of an Express design, the file structure and XML manifest file that are specific to an Express design. This document does not cover how to create a custom Express design, but is referenced by all tutorials on creating Express designs. Specifically, this document will cover:

6.4.2. Express CSS Inheritance Hierarchy

The CSS has an inheritance hierarchy where one set of style sheets is loaded and then a second set will overload those styles. The Express designs CSS inheritance hierarchy acts just like a theme in Moodle. The Moodle standard theme contains all the base styles sheets within its styles_colors.css, style_fonts.css, styles_layout.css, browser-specific files and all Moodle developer defined styles that are specific to an activity, course format or block. Express then overloads all of these style sheets with its core.css. Browser-specific style sheets overload the Express core style sheet. Finally there are element-specific styles that are often applied within YUI interfaces or the grade book that can't be overloaded.

6.4.2.1. Express Inheritance Diagram

Express Inheritance Diagram

6.4.3. Express Design Structure

An Express design's structure is similar to the Moodle 2.0 theme structure, with folders being used to logically separate files that are used to display the look and feel. Express designs are expected to be zipped up before being uploaded to the client's site via the Express block's Manage Designs tab in the Express block. The following is a list of folders and files that make up the Express design structure (not all files are required):

Express design zip file structure

js/
js/menu.js
layout/
layout/footer.html
layout/header.html
layout/menu.html
layout/meta.html
pix/
pix/favicon.ico
pix/logo.png
pix/mod/
style/
style/core.css
style/ie.css
style/ie6.css
style/ie7.css
style/ie_rtl.css
style/ie6_rtl.css
style/ie7_rtl.css
style/rtl.css

6.4.3.1. JavaScript Directory (js/)

The JavaScript directory contains all the Express design's JavaScript files. Each file in this directory is loaded in either the header or footer of the Express theme based on the site settings for the Express block's Custom JavaScript setting. In order for files in this directory to be loaded when the design is displayed by the Express theme, the Express block's Custom JavaScript setting must be set to "header" or "footer."

6.4.3.1.1. menu.js

This file is created by the Express block within the Manage Menus tab and is part of the Express menus process. It is used to load up all JavaScript functions required by Yahoo's User Interface to display dynamic menus. In general, it is not recommended that you create this file or include it in a design. If you have downloaded a design from the Express block, this file may exist if you have already created Express menus for the design.

6.4.3.2. Layout Directory (layout/)

The layout directory contains all of the Express design's HTML files that are used by the Express theme to display the look and feel. Each of these files can contain the variables detailed in the Express Design Variables section.

6.4.3.2.1. footer.html

The footer.html displays at the bottom of the Moodle page after the closing of the <div id="page"> tag and opens the <div id="footer"> tag. The footer.html usually contains navigation links, performance data, validation links, Moodlerooms tutorials, and/or logo/package information. The footer has unique variables for it that can be found in Express Design Footer Specific Variables.

Example footer.html
6.4.3.2.2. header.html

The header.html file contains all the header information printed at the top of the page before the <div id="page"> tag. The header.html usually contains a company logo, navigation, information regarding the logged in user, access to log in if the user has not already done so, and/or Flexpage tabs. The header has unique variables that can be found in Express Design Header Specific Variables.

Example header.html
6.4.3.2.3. meta.html

The meta.html file is included within the <head></head> HTML tags and should consist mainly of <meta> HTML tags used by search engines to find the site.

Example meta.html
6.4.3.2.4. menu.html

The menu.html file contains the YUI menu code that is created in the Express menu tab in the Express block. It is generally best to leave this file alone and allow the Express block to generate the correct HTML code. The menu uses the standard Express variables, but the most commonly used one is %MYCOURSESYUI%.

Example menu.html
Moodlerooms does not recommend that this file is created manually or added to a design.

6.4.3.3. Pix Directory (pix/)

The Pix directory contains all the images used by the design for backgrounds, logos, favorite icon, icons, etc. This directory can contain multiple files of various names that the Express developer can add without fear that they will not be copied when the design is uploaded via the Manage Designs tab of the Express block. The js and pix folders will be copied no matter how many files are in them or what they are named. This directory also contains all custom icons used by the design. All custom icons must be included in the design or broken image links will be displayed instead of the icons.

6.4.3.4. Style Directory (style/)

The style directory contains all of the cascading style sheets used by the design. The structure and naming convention follows the Moodle 2.0 structure and naming. Each file in this directory will get recreated as a PHP file in order to provide compression and caching for the style sheets when loaded by the Express theme.

6.4.3.4.1. core.css

This is the core CSS file for the theme and is required for the design to function properly. This file is always included when the design is displayed.

6.4.3.4.2. ie.css

This is a CSS file used when the design requires specific CSS to work in all versions of Internet Explorer.

6.4.3.4.3. ie6.css

This is a CSS file used when the design requires specific CSS to work in Internet Explorer v6.

6.4.3.4.4. ie7.css

This is a CSS file used when the design requires specific CSS to work in Internet Explorer v7.

6.4.3.4.5. ie_rtl.css

This file contains CSS for all versions of Internet Explorer for a right-to-left language.

6.4.3.4.6. ie6_rtl.css

This file contains CSS for Internet Explorer v6 for a right-to-left language.

6.4.3.4.7. ie7_rtl.css

This file contains CSS for Internet Explorer v7 for a right-to-left language.

6.4.3.4.8. rtl.css

This CSS file is used when the language selected by the user in Moodle is a right-to-left language.

6.4.4. Express Design Variables

Express design variables are used to dynamically add information to the Express design files such as header.html, footer.html and core.css. These variables act just like a PHP variable or a block of PHP code in a Moodle theme. When the Express theme loads an Express design file, the variables are replaced with the data from Moodle that they represent. For example, the %WWWROOT% is replaced with the base URL for the site -- usually http://<client name>.mrooms.net. Below is a listing of all Express design variables. These variables can also be used in an Express template, but their values are not replaced until the Express theme reads the design files. The list below is grouped by where the variable is typically used. Some variables can only be used in the header.html or footer.html because they are only available in Moodle at those points in time.

6.4.4.1. Express Design Common Variables

6.4.4.1.1. Navigation Variables
  • %BREADCRUMB%: Renders the breadcrumb line, which shows the user where s/he is on the site, along with the Turn editing on button and the Switch to role drop-down menu based on the user’s permissions.
  • %CATBREADCRUMB%: Renders the breadcrumb line, showing the user where s/he is on the site, along with Turn editing on button and the Switch to role drop-down menu based on the user’s permissions. This variable displays the category and sub-category to which the course belongs within the breadcrumb before the course short name and after the site short name (e.g. Joule 1.9 > History > American History > US_Revolution).
  • %DOCLINK%: Renders the core Moodle help doc links, which usually point to docs.moodle.org.
  • %EXPRESSMENU%: Renders the menu.html file and the JavaScript necessary to convert it to a YUI menu. Expressmenu will not respect the Express Block's Menu override settings it will only display the Express menu.
  • %JUMPTOMENU%: Renders the Jump to menu in an activity, allowing the user to jump to another activity in the course.
  • %LANGMENU%: Renders the Choose a language drop-down menu, allowing the user to select the interface display language.
  • %LOGGEDINAS%: Renders only the You are logged in as area without the language menu selector.
  • %MENU%: Renders the Choose a language menu, You are logged in as text, and links to log in to the site. Renders the Jump to menu in an activity.
6.4.4.1.2. Site Variables
  • %SITEFULLNAME%: Renders the full name of the site.
  • %SITESHORTNAME%: Renders the short name of the site.
  • %SITESUMMARY%: Renders the summary of the site.
6.4.4.1.3. Course Variables
  • %COURSEFULLNAME%: Renders the full name of the course that the user is currently in.
  • %COURSEID%: Renders the course's ID number. This should be used to create dynamic links to the course, module, block or user profile.
  • %COURSESHORTNAME%: Renders the short name of the course that the user is currently in.
  • %COURSESUMMARY%: Renders the course summary.
  • %CUSTOMIMAGE%: Renders the logo that has been uploaded to the site, category or course via the Express block's Create a Design tab.
6.4.4.1.4. User Variables
  • %ADDRESS%: Renders the user’s address as it appears in the user’s profile.
  • %CITY%: Renders the user’s city as it appears in the user’s profile.
  • %COUNTRY%: Renders the user’s country as it appears in the user’s profile.
  • %DEPARTMENT%: Renders the user’s department as it appears in the user’s profile.
  • %EMAIL%: Renders the user’s e-mail address as it appears in the user’s profile.
  • %FIRSTNAME%: Renders the user’s first name as it appears in the user’s profile.
  • %IDNUMBER%: Renders the user’s ID number as it appears in the user’s profile.
  • %INSTITUTION%: Renders the user’s institution as it appears in the user’s profile.
  • %LASTNAME%: Renders the user’s last name as it appears in the user’s profile.
  • %MYCOURSES%: Renders a list of <li> HTML tags for each course that the user is enrolled in. An Express design should wrap an ordered list or unordered list HTML tag around this variable. This is most often used in a JavaScript drop-down list in the header of the design.Example:
    <ul id=”mycourses”>%MYCOURSES%</ul>
    Use My Courses must be set to “Yes” in the Express site settings for this variable to work.
    Warning
    This feature could cause performance issues with a large number of courses.
  • %MYCOURSESYUI%: Renders a YUI appropriate menu item that contains each course that the user is enrolled in. This is best used in the Express menu but can be used by itself if a developer understands how the YUI menu works.
    Use My Courses must be set to “Yes” in the Express site settings for this variable to work.
    Warning
    This feature could cause performance issues with a large number of courses.
  • %PHONE1%: Renders the user’s phone number as it appears in the user’s profile.
  • %PHONE2%: Renders the user’s mobile phone number as it appears in the user’s profile.
  • %PICBIG%: Renders the image tag to display the user’s large formatted profile picture. It also adds a custom CSS class called “userpicbig” to allow a developer to customize the height and width of the image through CSS.
  • %PICSML%: Renders the image tag to display the user’s small formatted profile picture. It also adds a custom CSS class called “userpicsml” to allow a developer to customize the height and width of the image through CSS.
  • %USERID%: Renders the user's ID number. This should be used to create dynamic links to the user profile or blocks and activities that use the user's ID.
  • %USERNAME%: Renders the user's username. This can be used to create dynamic links, or to display to the user they are logged in as a specific username.
6.4.4.1.5. Custom Profile Field Variables

Custom profile field variables are named based on the short name assigned when the custom profile field was created. Text-area type custom profile fields cannot be displayed in a design.

Variable names should be all uppercase with a percentage (%) symbol at the beginning and end. You will need to enable custom profile fields in the Express settings (through the Site Administration block) to use custom profile field variables.

Warning
This feature could cause performance issues with a large number of custom profile fields.
6.4.4.1.5.1. Example:

Custom profile field short name: major
Express Designer variable: %MAJOR%

6.4.4.1.6. URL Variables
  • %DESIGNDIR%: Renders the beginning of the URL to access a file in the Express storage directory. This is usually used in img tags and CSS to load images that are stored in the design directory. The value returned is usually something like http://www.moodlerooms.com/express/design. This replaces the mPower variable %SITETHEMEDIR%.
  • %WWWROOT%: Renders the Web root directory for the site. Usually something like http://www.moodlerooms.com.
6.4.4.1.7. Flexpage Variables
These variables only work if a client has purchased Flexpage.
  • %PAGEBACKTOBUTTON%: Renders the Back to page button when a user navigates away from a Flexpage page to an activity. This button is used to return the user to the last page they were on before entering an activity.
  • %PAGETABS%: Renders the div tags required to display Flexpage’s page tabs and page menu module tabs (if there are any for the course). Page tabs will respect the Express Block's Menu override settings.

6.4.4.2. Express Design Header Specific Variables

  • %COURSEIMAGE%: (deprecated -- will be removed in Joule 2.0) Renders an img tag linked to a file named “header” with the file extension .gif, .png or .jpg (if it exists in the course files for the course that the user is in).
  • %HEADERID%: Used to add a dynamic ID attribute for a div tag. Values are “header,” “header-home,” or “header-none,” depending on where the user is within the site.
  • %HEADING%: Renders a value in the heading variable (usually this is the full name of the site).

6.4.4.3. Express Design Footer Specific Variables

  • %EDITCONTENT%: Renders the Central Resource System Edit Content button to edit content if Central Resource System activities are present on the page.
  • %HOMELINK%: Renders the Home button, which sends the user back to the home page. The application determines the pages on which this button is displayed.
  • %PERFORMANCEINFO%: Renders the performance information on page load time and database queries.
  • %VALIDATORS%: Renders the links to the HTML validators for the application.
  • %ROUNDEDCORNERJS%: Renders the necessary JavaScript to add rounded corners to blocks.  The JavaScript will create extra div tags around all the blocks in order to allow rounded images to be placed at the corners. This requires that you add the following CSS to your CSS files. Edit as needed for your design:
    Rounded Corners CSS

    You will also need to modify the margins to line up your corner images with the block’s top, bottom and side borders. Download rounded_corner_images.zip for a copy of the default rounded corner images used above.

6.5. Express Template Technical

6.5.1. Introduction

The Express block allows a user with the "Create Express template" capability at the site level to upload manually created Express templates. An Express template is used by the Express block to allow users with the "Create/Edit Express designs" capability to create an Express design for the site, course category or course based on a template. Express templates are a way for clients to create an unlimited number of common looks and feels (multiple templates with multiple color combinations) for their users to choose from. They also allow the client to provide some flexibility for their users to customize the colors within the template.

This document covers the technical aspects of an Express template, the file structure, XML manifest file and the variables that are specific to an Express template. This document does not cover how to create an Express template, but is referenced by all tutorials on creating Express templates. Specifically, this document will cover:

6.5.2. How an Express Template Becomes an Express Design

As explained in the introduction, an Express design is created from an Express template. This doesn't explain technically what happens and what an Express developer needs to know about templates in order to allow their users to successfully create designs from them. The process by which a design is created from a variant of the template in the Create a Design sub tab of the Express block in as follows:

  1. The design folder is created in the moodledata/express/design directory using the shortname of the course or name of the category and the ID for the course or category. (Site is considered a course in this context)
  2. All Express template variables are loaded from the template's manifest.xml for the variant of the template the user has selected.
  3. Each of the valid template files in the layout and style directories including variant director files (explained below) opened
    1. If the template file is in the style folder and a matching variant file in the variants directory is found, then the variants file is opened and appended to the end of the template file (a variants core.css is appended to the end of the style/core.css)
  4. All template variables in the opened file are replaced with the values from the variable loaded from the mainfest.xml
  5. The template file is written to the design directory under the appropriate directory (template/style/core.css to design/shortnameID/style/core.css).

The above steps are repeated for each file in the style and layout directories. Once those files are repeated, then the Express block does the following:

  1. Copies all JavaScript files from the template's js directory to the design's js directory
  2. Copies all images in the template's pix and pix/variant directories to the design's pix directory
  3. Adds the logo, favorite icon and menu information to the design if it previously existed for the site, course or category.

6.5.3. Express Template File Structure

An Express template's structure is similar to an Express design's file structure, with folders being used to logically separate the files that are used to display the look and feel. An Express template differs from an Express design because it has various sub folders that contain variant-specific files as well as a manifest.xml file that defines information about the template. Express templates are expected to be zipped up before being uploaded to the Express block's Manage Templates tab. The following is a list of folders and files that make up the Express design structure (not all files are required):

Express design file structure

js/ (optional)
js/core.js(optional)
layout/footer.html
layout/header.html
layout/meta.html (optional)
pix/
pix/favicon.ico (optional)
pix/logo.(png,jpg or gif) (optional)
pix/variant1_directory/
pix/variant1_directory/screenshot.png
pix/variant2_directory/
pix/variant2_directory/screenshot.png
style/core.css
style/ie.css (optional)
style/ie6.css (optional)
style/ie7.css (optional)
style/ie_rtl.css (optional)
style/ie6_rtl.css (optional)
style/ie7_rtl.css (optional)
style/rtl.css (optional)
style/variant1_directory/(optional)
style/variant1_directory/core.css (optional)
style/variant1_directory/ie.css (optional)
style/variant1_directory/ie6.css (optional)
style/variant1_directory/ie7.css (optional)
style/variant1_directory/ie_rtl.css (optional)
style/variant1_directory/ie6_rtl.css (optional)
style/variant1_directory/ie7_rtl.css (optional)
style/variant1_directory/rtl.css (optional)
style/variant2_directory/ (optional)
style/variant2_directory/core.css (optional)
style/variant2_directory/ie.css (optional)
style/variant2_directory/ie6.css (optional)
style/variant2_directory/ie7.css (optional)
style/variant2_directory/ie_rtl.css (optional)
style/variant2_directory/ie6_rtl.css (optional)
style/variant2_directory/ie7_rtl.css (optional)
style/variant2_directory/rtl.css (optional)
manifest.xml

In your actual Express template structure, replace the variant_directory with the value you place in the directory tag for the variant in the manifest.xml file.

6.5.3.1. Variant Folders (pix/variant_directory and style/variant_directory)

In the style and pix directories, there is the option to add a variant directory that corresponds to the value you place in the directory tag for the variant within the manifest.xml file. When a variants directory exists in the pix directory, then the files within that directory are copied to the design's pix directory as well as the files in the pix directory when that variant is selected by the user in the Create a Design sub tab. When a variants directory exists in the style directory, the CSS in the variant's file is appended to the appropriate file in the style directory, so a variant's core.css would have its CSS appended to the bottom of the style/core.css when that file is copied to the design's style directory. Variant directories allow Express developers to add custom CSS and images for each variant and provide greater flexibility for templates.

The pix directory requires a variant directory for each variant with at least a screenshot.png file in it in order to properly display a sample of the variant's look and feel when applied as a design.

6.5.3.2. JavaScript Directory (js/)

The JavaScript directory contains all the Express design's JavaScript files. Each file in this directory is loaded in either the header or footer of the Express theme based on the site settings for the Express block's Custom JavaScript setting. In order for files in this directory to be loaded when the design is displayed by the Express theme, the Express block's Custom JavaScript setting must be set to "header" or "footer."

6.5.3.2.1. menu.js

This file is created by the Express block within the Menus tab and is part of the Express menus process. It is used to load up all JavaScript functions required by Yahoo's User Interface to display dynamic menus. In general, it is not recommended that you create this file or include it in a design. If you have downloaded a design from the Express block, this file may exist if you have already created Express menus for the design.

6.5.3.3. Layout Directory (layout/)

The layout directory contains all of the Express design's HTML files that are used by the Express theme to display the look and feel. Each of these files can contain the variables detailed in the Express Design Variables section. The files in this directory that are Express design files are copied directly to the Express design when the user creates a design from this template.

6.5.3.3.1. footer.html

The footer.html displays at the bottom of the Moodle page after the closing of the <div id="page"> tag and opens the <div id="footer"> tag. The footer.html usually contains navigation links, performance data, validation links, Moodlerooms tutorials, and/or logo/package information. The footer has unique variables for it that can be found in Express Design Footer Specific Variables.

Example footer.html
6.5.3.3.2. header.html

The header.html file contains all the header information printed at the top of the page before the <div id="page"> tag. The header.html usually contains a company logo, navigation, information regarding the logged in user, access to log in if the user has not already done so, and/or Flexpage tabs. The header has unique variables that can be found in Express Design Header Specific Variables.

Example header.html
6.5.3.3.3. meta.html

The meta.html file is included within the <head></head> HTML tags and should consist mainly of <meta> HTML tags used by search engines to find the site.

Example meta.html
6.5.3.3.4. menu.html

The menu.html file contains the YUI menu code that is created by the Express menu link in the Express block. It is generally best to leave this file alone and allow the Express block to generate the correct HTML code. The menu uses the standard Express variables, but the most commonly used one is %MYCOURSESYUI%.

Example menu.html
Moodlerooms does not recommend that this file is created manually or added to a template.

6.5.3.4. Pix Directory (pix/)

The pix directory contains all the images used by the template for backgrounds, logos, favorite icons, etc. This directory can contain multiple files of various names that the Express developer can add. All of the images in the pix folders will be copied to the server and then copied to the design when the user uses the Create a Design sub tab to create an Express design from the template. This directory also contains all custom icons used by the template. All icons must be included in the template or else broken image links will be displayed instead of the icons.

6.5.3.4.1. favicon.ico

This will be used as the default favorite icon for the template. This file will be replaced if the user has already uploaded a favorite icon.

6.5.3.4.2. logo.(jpg,gif,png)

This is the default logo for the template. This file will be replaced if the user has already uploaded a favorite icon.

6.5.3.4.3. variant_directory/screenshot.png

This file is used by the Express block's Create a Design sub tab as an example of what the variant looks like when selected by the user to create a design. This file is recommended to be 450px in width and is a screen shot of what the variant looks like in a course. Multiple screen shots can be placed within this one file if the Express developer wants to show multiple examples of the variant. Below is an example for the Joule template:

6.5.3.5. Style Directory (style/)

6.5.3.5.1. core.css

This is the core CSS file for the theme and is required for the design to function properly. This file is always included when the design is displayed.

6.5.3.5.2. ie.css

This is a CSS file used when the design requires specific CSS to work in all versions of Internet Explorer.

6.5.3.5.3. ie6.css

This is a CSS file used when the design requires specific CSS to work in version 6 of Internet Explorer.

6.5.3.5.4. ie7.css

This is a CSS file used when the design requires specific CSS to work in version 7 of Internet Explorer.

6.5.3.5.5. ie_rtl.css

This file contains CSS for all versions of Internet Explorer for a right-to-left language.

6.5.3.5.6. ie6_rtl.css

This file contains CSS for version 6 of Internet Explorer for a right-to-left language.

6.5.3.5.7. ie7_rtl.css

This file contains CSS for version 7 of Internet Explorer for a right-to-left language.

6.5.3.5.8. rtl.css

This the CSS file that is used when the language selected by the user in Moodle is a right-to-left language.

6.5.3.6. manifest.xml

The manifest.xml file contains all of the information the Express block needs to display, create and customize a template when a user creates a design within the Create a Design sub tab.

6.5.3.6.1. manifest.xml Structure

The manifest.xml is designed to contain information about one template with multiple variants. Each variant will contain multiple variables where a variable is either a background color, image or a font color. The variable value for each variable in the variant selected by the user will be loaded into the Custom settings fields of the Create a Design sub tab that is associated with that variable (headerbgcolor matches the Header field within the Custom Background settings area of the form). If the variant is chosen by the user, the variable value will replace the string %VARIABLE_NAME% within the template CSS and HTML files when the design is created. Below is the XML structure for the manifest.xml file.

XML definition for manifest.xml
6.5.3.6.2. XML Tag Definition
6.5.3.6.2.1. <default> (optional)

If this tag has a value of 1, then when the template is selected, this is the default variant selected. This is a child tag of <variant> and is optional.

6.5.3.6.2.2. <directory>

This tag is used for the name of the directory that the template or variant is stored in. The Express block will do the following with the value of this tag:

  • Create a directory with this value where all of the template files are stored in the moodledata/express/templates directory when when the template is uploaded via the Manage template tab.
  • Use this value to locate variant-specific images in the pix directory or CSS files in the style directory for the template when a design is created from this template.
  • Replace the %VARIANT% template variable with the value of this field if this variant is selected.
  • Use this value to locate the screenshot.png for the variant in the template's pix directory when the variant is selected by the user in the Create a Design sub tab.

This tag is a child of <template> and <variant> and is required by both.

6.5.3.6.2.3. <name>

This is the displayed name for the template or variant in all locations where Express displays the template or variant. This is a child tag of <template> and <variant> and is required by both.

6.5.3.6.2.4. <notes>

This tag is used to convey information about the template's design, variable usage and/or required Express block settings. This is a child tag of <template> and is required.

6.5.3.6.2.5. <variant>

This tag is used as a wrapper around the information for a variant. There can be multiple variants for a template. This is a child tag of <variants>. The variant tag contains the following tags:

  • name
  • directory
  • default
  • variables
6.5.3.6.2.6. <variable>

This tag is used to define the value for the Express template variables that are used by the template and will populate the Custom settings field for the like named field. The name attribute is used to define the name of the variable and should be the lowercase equivalent of the Express template variables below. The possible name values are:

  • bodyfontcolor
  • headerfontcolor
  • menufontcolor
  • menuhfontcolor
  • navfontcolor
  • sbhfontcolor
  • sbcfontcolor
  • buttonfontcolor
  • gradvfontcolor
  • gradhfontcolor
  • linkcolor
  • headingcolor
  • highlight
  • rowaltfontcolor
  • footerfontcolor
  • bodybgcolor
  • headerbgcolor
  • navbgcolor
  • topbar
  • menubgcolor
  • menuhbgcolor
  • pagebgcolor
  • contentbgcolor
  • sbhbgcolor
  • sbcbgcolor
  • buttonbgcolor
  • gradvbgcolor
  • gradhbgcolor
  • rowaltbgcolor
  • footerbgcolor

Each variable with a specific name attribute is optional and should only be added if the variant of the template uses the variable. See the example manifest.xml below:

6.5.3.6.3. Example manifest.xml

Below is an example manifest.xml file for a template with two variants. Note that not all of the possible variables exist in this template.

Example manifest.xml with two variants

6.5.4. Express Template Variables

Express template variables are used as place holders for the values in the variables for the variant in the manifest.xml file or the user selected colors in the Custom settings area of the Create a Design sub tab. Each of these variables can be used however the Express developer would like to use them. Below is a description of the recommended area where the variable can be used. Moodlerooms recommends that the Express developer document within the notes tag of the template's manifest.xml any deviation from these recommendations. Below is an example of where each variable appears in a design for the Joule template and is used as a reference guide for uses in the Express block documentation.

6.5.4.1. Background Variables

These variables are the uppercase equivalent of the value in the name attribute of the variable tag of the manifest.xml for the variant the user has selected. These variables can also be replaced by the fields in the Custom Background Color Settings area of the Create a Design sub tab. These match the name there exactly, or remove the BGCOLOR and you will match the field in the form.

  • %BODYBGCOLOR%: The background color of the body of the page. Usually used with the background or background-color CSS attribute. Ex.: background: %BODYBGCOLOR%;
  • %HEADERBGCOLOR%: The background color of the header of the page. Usually used with the background or background-color CSS attribute. Ex.: background: %HEADERBGCOLOR;
  • %NAVBGCOLOR%: The background color for the navigation or breadcrumb printed using %CATBREADCRUMB% or %BREADCRUMB%. Usually used with the background or background-color CSS attribute. Ex.: background: %NAVBGCOLOR%;
  • %TOPBAR%: The background color for the div tag with the ID attribute set to tabbar, which is only printed if the Express menu and Flexpage menus are not present. Usually used with the background or background-color CSS attribute. Ex.: background: %TOPBAR%;
  • %MENUBGCOLOR%: The background color for Flexpage or Express menu items. Usually used with the background or background-color CSS attribute. Ex.: background: %MENUBGCOLOR%;
  • %MENUHBGCOLOR%: The background color for Flexpage and Express menu items when they are highlighted or hovered over. Usually used with the background or background-color CSS attribute. Ex.: background: %MENUHBGCOLOR%;
  • %PAGEBGCOLOR%: The background color for the div tag with the ID attribute set to page. Usually used with the background or background-color CSS attribute. Ex.: background: %PAGEBGCOLOR%;
  • %CONTENTBGCOLOR%: The background color for the div tag with the ID attribute set to content. Usually used with the background or background-color CSS attribute. Ex.: background: %CONTENTBGCOLOR%;
  • %SBHBGCOLOR%: The background color header of all blocks. Usually used with the background or background-color CSS attribute. Ex.: background: %SBHBGCOLOR%;
  • %SBCBGCOLOR%: The background color for the content area of all blocks. Usually used with the background or background-color CSS attribute. Ex.: background: %SBCBGCOLOR%;
  • %BUTTONBGCOLOR%: The background color for buttons. Usually used with the background or background-color CSS attribute. Ex.: background: %BUTTONBGCOLOR%;
  • %GRADVBGCOLOR%: The background color for cells in the grade book when a column of activity grades is selected. Usually used with the background or background-color CSS attribute. Ex.: background: %GRADVBGCOLOR%;
  • %GRADHBGCOLOR%: The background color cells in a row of data in the grade book when a student row is selected. Usually used with the background or background-color CSS attribute. Ex.: background: %GRADHBGCOLOR%;
  • %ROWALTBGCOLOR%: The background color of the r1 or even rows in tables. Used by Joule and Moodle grade book row records and reports when tabular data is displayed. Usually used with the background or background-color CSS attribute. Ex.: background: %ROWALTBGCOLOR%;
  • %FOOTERBGCOLOR%: The background color of the footer of the page. Usually used with the background or background-color CSS attribute. Ex.: background: %FOOTERBGCOLOR%;

6.5.4.2. Font Color Variables

These variables are the uppercase equivalent of the value in the name attribute of the variable tag of the manifest.xml for the variant the user has selected. These variables also can be replaced by the fields in the Custom Font Color Settings area of the Create a Design sub tab, these match the name there exactly, or remove the BGCOLOR and you will match the field in the form.

  • %BODYFONTCOLOR%: The default font color of the body of the page. Usually used with the color CSS attribute. Ex.: color: %BODYFONTCOLOR%;
  • %HEADERFONTCOLOR%: The font color for the header of the page. Usually used with the color CSS attribute. Ex.: color: %HEADERFONTCOLOR%;
  • %MENUFONTCOLOR%: The font color for Flexpage or Express menu items. Usually used with the color CSS attribute. Ex.: color: %MENUFONTCOLOR%;
  • %MENUHFONTCOLOR%: The font color for Flexpage and Express menu items when they are highlighted or hovered over. Usually used with the color CSS attribute. Ex.: color: %MENUHFONTCOLOR%;
  • %NAVFONTCOLOR%: The font color for the navigation or breadcrumb printed using %CATBREADCRUMB% or %BREADCRUMB%. Usually used with the color CSS attribute. Ex.: color: %NAVFONTCOLOR%;
  • %SBHFONTCOLOR%: The font color for the blocks header. Usually used with the color CSS attribute. Ex.: color: %SBHFONTCOLOR%;
  • %SBCFONTCOLOR%: The font color for the blocks content, usually links and text. Usually used with the color CSS attribute. Ex.: color: %SBCFONTCOLOR%;
  • %BUTTONFONTCOLOR%: The font color for buttons. Usually used with the color CSS attribute. Ex.: color: %BUTTONFONTCOLOR%;
  • %GRADVFONTCOLOR%: The font color for the grade book when a column of activity grades is selected. Usually used with the color CSS attribute. Ex.: color: %GRADVFONTCOLOR%;
  • %GRADHFONTCOLOR%: The font color for the grade book when a student row is selected. Usually used with the color CSS attribute. Ex.: color: %GRADHFONTCOLOR%;
  • %LINKCOLOR%: The default font color for all links on the page. Usually used with the color CSS attribute. Ex.: color: %LINKCOLOR%;
  • %HEADINGCOLOR%: The default color for the h1-h6 header tags. Usually used with the color CSS attribute. Ex.: color: %HEADINGCOLOR%;
  • %HIGHLIGHT%: The font color for selected or hover links. Usually used with the color CSS attribute. Ex.: color: %HIGHLIGHT%;
  • %ROWALTFONTCOLOR%: The font color for r1 and the even or odd rows in tables. Used by Joule and Moodle grade book row records and reports when tabular data is displayed. Usually used with the color CSS attribute. Ex.: color: %ROWALTFONTCOLOR%;
  • %FOOTERFONTCOLOR%: The font color in the footer of the page. Usually used with the color CSS attribute. Ex.: color: %FOOTERFONTCOLOR%;

6.5.4.3. General Font Variables

These variables are the uppercase equivalent of the value in the name attribute of the variable tag of the manifest.xml for the variant the user has selected. These variables can also be replaced by the fields in the General Font Settings area of the Create a Design sub tab. These match the name there exactly:

  • %FONTFAMILY%: The default font used on the page. Usually used with the font-family CSS attribute. Ex.: font-family:%FONTFAMILY%;
  • %FONTSIZE%: The default font size for the page. Usually used with the font-size CSS attribute. Ex.: font-size: %FONTSIZE%;

6.5.4.4. General Variables

These variables are replaced by the directory tag for the template and variant selected by the users. They are used to link to images in the template directory that are common or that the developer wants to have cached only once, even if the template and variant is used to create multiple designs.

  • %VARIANT%: The directory tag value for the variant selected by the user. Usually used in a CSS or HTML URL. Ex: url('%TEMPLATEDIR%/pix/%VARIANT%/imagename.png');
  • %TEMPLATEDIR%: Represents the full Web URL to the directory where the template is stored on the server. Usually used in a CSS or HTML URL. Ex: url('%TEMPLATEDIR%/pix/%VARIANT%/imagename.png');

7. Filters

7.1. Coursename

7.1.1. Overview

The Coursename filter allows you to create a custom course program overview, allowing the Moodler insight into future classes & instant access once they are enrolled or if guest access is enabled. The filter works by translating the course shortname into a clickable link or button, with the option of adding that course's summary or section overview.

7.1.2. User Documentation

The Coursename filter replaces strings starting with SN_ and ending with _CN in any HTML area with the information from the course and a link based on the course shortname provided.

The Coursename filter can display 10 pieces of information about a course:

  1. Fullname link
  2. Shortname link
  3. Link to course with custom text
  4. Button link to course with custom text
  5. Sections link
  6. Summary
  7. Cost
  8. Completion Bar (Unlocked Pages/Total Pages) (flex page only)
  9. Completion Percentage (Unlocked Pages/Total Pages) (flex page only)
  10. Completion Enrollment Days Left

7.1.2.1. Fullname Link

Displays the course's full name as a clickable link

7.1.2.1.1. Filter Structure

CN_fullname_<course shortname>_CN

7.1.2.1.2. Example

CN_fullname_CF101_CN

7.1.2.2. Shortname Link

Displays the course's short name as a clickable link.

7.1.2.2.1. Filter Structure

CN_shortname_<course shortname>_CN

7.1.2.2.2. Example

CN_shortname_CF101_CN

7.1.2.3. Link to course with custom text

Displays whatever text you determine as a direct link to the course.

7.1.2.3.1. Filter Structure

CN_link_<course shortname>_<Your Text Here>_CN

7.1.2.3.2. Example

CN_link_CF101_Your Text Here_CN

7.1.2.4. Button link to course with custom text

Displays whatever text you determine as a button link to that course.

7.1.2.4.1. Filter Structure

CN_button_<course shortname>_<Your Text Here>_CN

7.1.2.4.2. Example

CN_button_CF101_Your Text Here_CN

7.1.2.5. Sections Link

Displays the sections/topics of the course as clickable links.

7.1.2.5.1. Filter Structure

CN_sections_<course shortname>_CN

7.1.2.5.2. Example

CN_sections_CF101_CN

7.1.2.6. Summary

Displays the course summary.

7.1.2.6.1. Filter Structure

CN_summary_<course shortname>_CN

7.1.2.6.2. Example

CN_summary_CF101_CN

7.1.2.7. Cost

Displays the cost of the course.

7.1.2.7.1. Filter Structure

CN_cost_<course shortname>_CN

7.1.2.7.2. Example

CN_cost_CF101_CN

7.1.2.8. Completion Bar (Unlocked Pages/Total Pages)

Displays a horizontal progress bar that can be styled via CSS to look how you want. The bar's width is determined by the number of flex pages in a course that are unlocked for the user.

7.1.2.8.1. Filter Structure

CN_comppagebar_<course shortname>_CN

7.1.2.8.2. Example

CN_comppagebar_CF101_CN

7.1.2.9. Completion Percentage (Unlocked Pages/Total Pages)

Displays a percentage value that is determined by the number of flex pages in a course that are unlocked for the user.

7.1.2.9.1. Filter Structure

CN_comppageperc_<course shortname>_CN

7.1.2.9.2. Example

CN_comppageperc_CF101_CN

7.1.2.10. Completion Enrollment Days Left

Displays the number of days that the user has left for their enrollment in the course based on the users enrollment end date. It displays Unlimited if the user doesn't have an enrollment end date.

7.1.2.10.1. Filter Structure

CN_daysleft_<course shortname>_CN

7.1.2.10.2. Example

CN_daysleft_CF101_CN

7.1.3. Administrator Documentation

7.1.3.1. Enabling Coursename Filter

  1. Click the eye icon next to the Coursename filter in Site Administration > Activities > Filters > Manage Filters
  2. Click the settings link to the right of the eye icon for the Coursename filter and fill in the settings

7.1.4. Global Settings

  • Show section zero: Display the Topic 0 when listing the sections using the CN_sections filter. Default: Yes
  • Show Blank Sections: Show sections with no content in the summary when using the CN_sections filter. Default: No

7.2. ScreenSteps

7.2.1. Overview

The ScreenSteps filter was developed to integrate with hosted Web sites provided to ScreenSteps clients. The filter will display spaces, manuals, buckets and lessons from the site inline wherever the filtered string is found. This is useful for rapidly developing step-by-step how-to instructions to include within a user's course.

7.2.2. User Documentation

The ScreenSteps filter replaces strings starting with SS_ and ending with _SS in any HTML area with the information from the ScreenSteps Web site (if found).

The ScreenSteps filter has 6 types of filter strings:

  1. Manual spaces
  2. Bucket spaces
  3. Manuals
  4. Buckets
  5. Manual lesson steps
  6. Bucket lesson steps
Warning on Naming
The ScreenSteps filter does not work with buckets, manuals or lessons that have underscores (_) in their name. The underscore is used by the filter to separate different variables that it needs in order to determine what to return and display.

7.2.2.1. Spaces

This use of the filter displays a listing of all manuals and buckets that exist in the space and links to the ScreenSteps-hosted page for each manual or bucket.

7.2.2.1.1. Filter Structure

SS_space_<space name>_SS

7.2.2.1.2. Example

*filter:*SS_space_steps_SS
URL: http://clickables.moodlerooms.com/spaces/steps

7.2.2.2. Manual

This use of the filter displays all chapters and all of their lessons with links to the ScreenSteps-hosted page for each lesson in the manual.

7.2.2.2.1. Filter Structure

SS_manual_<space name>_<manual name>_SS

7.2.2.2.2. Example

filter: SS_manual_steps_joule_SS
URL: http://clickables.moodlerooms.com/spaces/steps/manuals/joule/

7.2.2.3. Bucket

This use of the filter displays links to the ScreenSteps-hosted page for all of the lessons within the bucket manual.

7.2.2.3.1. Filter Structure

SS_bucket_<space name>_<bucket name>_SS

7.2.2.3.2. Example

filter: SS_bucket_employees_employeestuff_SS
URL: http://bmls.screenstepslive.com/spaces/employees/buckets/employeestuff

7.2.2.4. Lesson Steps

These filters are used to display the actual ScreenSteps lesson, which will display the actual how-to instructions.

7.2.2.4.1. Manual Lesson Steps

User this filter if you are looking to display the steps in a lesson from a manual.

7.2.2.4.1.1. Filter Structure

SS_mlesson_<space name><manual name><lesson name>_SS

7.2.2.4.1.2. Example

filter: SS_mlesson_steps_joule_12302-Can-I-view-a-sample-of-a-course-organized-by-type-_SS
URL: http://clickables.moodlerooms.com/spaces/steps/manuals/joule/lessons/12302-Can-I-view-a-sample-of-a-course-organized-by-type-

7.2.2.4.2. Bucket Lesson Steps
7.2.2.4.2.1. Filter Structure

SS_blesson_<space name><bucket name><lesson name>_SS

7.2.2.4.2.2. Example

filter: SS_blesson_employees_employeestuff_5543-Adding-Messages-to-Highrise-via-Email_SS
URL: http://bmls.screenstepslive.com/spaces/employees/buckets/employeestuff/lessons/5543-Adding-Messages-to-Highrise-via-Email

7.2.3. Administrator Documentation

7.2.3.1. Enabling ScreenSteps Filter

  1. Click the eye icon next to the ScreenSteps filter in Site Administration > Activities > Filters > Manage Filters
  2. Click the settings link to the right of the eye icon for the ScreenSteps filter and fill in the settings

7.2.4. Global Settings

  • URL: The URL to your ScreenSteps instance without the http:// or the trailing / ex: clickables.moodlerooms.com
  • User Name: A ScreenSteps account with access to view all the ScreenSteps you want to link to, usually an administrative account
  • Password: Password for the account on the ScreenSteps site

8. Joule Mobile

8.1. Phone Application

8.1.1. Overview

The Joule Mobile application is the core component of Moodlerooms' Joule Mobile product. The application is supported on a number of mobile devices using the Apple, Android or BlackBerry operating systems. The Joule Mobile application allows these mobile devices to access the user's course grades, course rosters, upcoming events, campus directory, campus news and campus locations on a map. The Joule Mobile application is a powerful tool for users on the go who need to access their learning management platform.

8.1.2. Basic Setup

8.1.2.1. Installing Joule Mobile

8.1.2.2. Select an Institution Upon First Accessing the Application

The first time a user accesses the the Joule Mobile application on their device, they will need to select the institution they would like to log in to. The user can enter search terms which match on the Site Name and Keywords fields from the Dubmenow configuration settings.

Android BlackBerry iPhone, iPad or iPod touch

Upon selecting an institution, the user will be asked to verify that they want to select this institution.

Android BlackBerry iPhone, iPad or iPod touch

Once the institution is accepted, then the application uses this institution every time the application is run. If a user needs to switch to a different institution, they will need to reset the university.

8.1.2.3. Log In/Log Out of an Institution's Joule Site

After opening the Joule Mobile application, the user first sees the main menu. If this is the first time the user has accessed the application, they are not logged in.

Android BlackBerry iPhone, iPad or iPod touch

To log in, the user clicks on the Login button for Apple and Android devices. BlackBerry devices must click the BlackBerry logo button and then select Login.

Android BlackBerry iPhone, iPad or iPod touch

Logging in allows Joule Mobile to retrieve data about the user from the institution's Joule site. Logging in is required before the user is able to use many of the Joule Mobile features.

8.1.2.4. Navigation in Joule Mobile

At any time, you are able to navigate backwards in Joule Mobile by clicking the appropriate navigational icon in the top left corner of the screen. For example, to navigate back to the Main Menu, you would click on the icon in the upper left-hand corner of the application, or the device's back button.

8.1.3. Directory

Android BlackBerry iPhone, iPad or iPod touch

The Directory module allows the user to see information about all users in the courses the user is enrolled in. The interface for the Directory module allows the user to search by first and last name or e-mail address for specific users. For example, you may enter "M" to search for all users with the letter M in their first name, last name, or e-mail address. The Directory module can also show only students or only teachers that are in the user's courses. This is done by selecting the appropriate option beneath the search bar (options are All, student or Teacher).

How to Search

  1. Enter a search term into the search field - this can be part of a person's name or e-mail address
  2. Select which user type you are searching for: All, Student, or Teacher
  3. Click Search
  4. The list will automatically filter results based on your search query

Once the list of students and teachers has been filtered, a user can select a specific student or teacher to view detailed information about them based on the user's settings in the Joule Mobile block. For more information about setting view permissions, see the Joule Mobile Block Manual. The directory can show the following detailed information about a user:

  • First and last name
  • Home phone number
  • Mobile phone number
  • Home address
  • Home e-mail address
  • ICQ user name
  • Skype user name
  • Yahoo user name
  • AIM user name
  • MSN user name
Android BlackBerry iPhone, iPad or iPod touch

From the contact details screen, you may add the contact to your device's address book or send a friend request through the Dubmenow network. Clicking on a contact's phone number will initiate a call to that individual. Clicking on the contact's address will display the address on the device's map. Clicking on the contact's e-mail address will begin the composition of an e-mail to that user.

8.1.4. News

Android BlackBerry iPhone, iPad or iPod touch

The News module provides the institution with the capabilities to display a predefined set of RSS feeds. These RSS feeds can be internal or external to Joule. RSS feeds expand and contract to show and hide the entries in the feed. The RSS feed with the most recent entry appears first on the list. Selecting a new entry causes the user to navigate to the RSS entry via the device's Web browser.

8.1.5. Courses

Android BlackBerry iPhone, iPad or iPod touch

The Courses module displays a list of all the courses in which the user is enrolled, organized by course category based on the institution's global settings for the Joule Mobile block. When a user selects a course, they are provided with more information about the course. The Joule Mobile app separates the course information into five areas through the use of buttons or tabs:

  1. Info: Overview information about the course
  2. Recent: Recent activity in the course
  3. Upcoming: Upcoming calendar events for the next 7 days
  4. Roster: A list of all users enrolled in the course
  5. Grades: Student grades for the course

Each of the screens are discussed in greater detail below.

8.1.5.1. Info

Android BlackBerry iPhone, iPad or iPod touch

Selecting a course from the course list presents the user with the Course info screen. The course info screen lists out information about the course, the faculty members, course summary, and any meetings created for the course. For more information on creating meetings for a course, see the Locations Block Manual.

8.1.5.2. Recent Activity

Android BlackBerry iPhone, iPad or iPod touch

The Recent Activity screen (accessed through the Recent tab or button on the device in the Course module) displays the same information displayed by the Recent Activity block for the selected course in Joule. This includes all logged actions performed by users enrolled in the selected course. For a student, this is useful to view what updates a teacher has made. For a teacher, this allows them to see when students have completed or viewed activities. A user can click on an activity and they will be logged in (via single sign-on) to the institution's Joule site and sent to the activity via the device's Web browser.

8.1.5.3. Upcoming Events

Android BlackBerry iPhone, iPad or iPod touch

The Upcoming Events screen (accessed through the Upcoming tab or button on the device in the Course module) displays events in the course calendar over the next two weeks. These events can be user, group or course events. Clicking on an event provides the event details listing the date, time, duration and summary of the event.

8.1.5.4. Roster

Android BlackBerry iPhone, iPad or iPod touch

Similar to the Directory screen, the Roster screen lists out all other users enrolled in the course. Users can view a participant's contact details by clicking on the participant's name. The contact detail displayed from the Roster screen is the same contact detail displayed in the Directory module.

8.1.5.5. Grades

Students and teachers have different views of the Grades screen. More information can be found in the Teacher Grades section or Student Grades section below.

8.1.6. Maps

Android BlackBerry iPhone, iPad or iPod touch

The Maps module synchronizes with the Locations block in the institution's Joule site to get a list of all of the locations an institution has created for their campus. The Maps module displays the locations as pins using the device's native mapping application (typically Google Maps) inline the Joule Mobile application. Users are able to view the details for a particular location by clicking on the pin. Details include the address of the location and the ability to view directions to the location.

Note: Get Directions Exits Joule Mobile
If the user clicks on the Get Directions button, the user will exit the Joule Mobile application and be brought to the device's map application. This will require the user to use the device's navigation buttons to return to the Joule Mobile application.

From the Maps main screen, a user can change to a list view of buildings or campuses that have been created for the institution. The method for viewing this list depends on the device's operating system:

8.1.7. Events

Android BlackBerry iPhone, iPad or iPod touch

The Events module displays all calendar events (site, user, group and course events) from the institution's Joule site for the user for the next two weeks. Selecting an event provides the user with greater detail, including the date, time, duration and summary of the event. This behaves the same as an upcoming event in the Course module.

8.1.8. Info

Android BlackBerry iPhone, iPad or iPod touch

The Info module displays information about the Joule Mobile application as well as support contact information for the institution. The following information is displayed to the user:

  • Version The version # of the Joule Mobile application for the device's operating system
  • Help Desk E-mail: E-mail address of the institution's end user support help desk for the Joule site
  • Help Desk Web Site: Web site of the institution's end user support help desk for the Joule site
  • Help Desk Phone Number: Phone number for the institution's end user support help desk for the Joule site

The institution configures the help desk e-mail, Web site and phone number when purchasing Joule Mobile.

8.1.9. Notifications

Android BlackBerry iPhone, iPad or iPod touch

Users receive Joule Notifications in the Main Menu of the Joule Mobile application. The notification details include the date and time of the notification and the same message that is delivered to the user's e-mail.

No HTML support
Currently, HTML is not supported in the notification message.

8.1.10. DubMeNow Modules

Two modules in the Joule Mobile application provide the user access to DubMeNow's contact sharing network. Review the privacy policy attached DubMeNow's Privacy Policy and visit https://www.dubhub.com/ for more information about DubMeNow.

8.1.10.1. Friends

The Friends module displays contacts you have added to the Dub network and allows you to contact them.

8.1.10.2. My Card

The My Card module displays the user's Dub contact card.

8.1.11. Course

8.1.11.1. Grades

Users that are enrolled as a Teacher in the course will have access to additional screens within the Grade screen than students. Instructors can view individual grades for all students, and the average grades for all students for all activities. Selecting a user or an activity will display a detailed view of the overall grades for that user or activity.

8.1.11.1.1. Student Grades
Android BlackBerry iPhone, iPad or iPod touch

The default view of the Grades screen displays the overall grade for each student currently enrolled in the course. This screen is also accessible by clicking the Student tab or button. The screen shows a list of participants by last name in alphabetical order with the associated course grade and average course grade in parentheses. Clicking on a student will take the user to the Student Grade Details screen.

8.1.11.1.2. Student Grade Details
Android BlackBerry iPhone, iPad or iPod touch

The Student Grade Details screen displays each activity grade for the student in the order that they appear in the course. The average grade for the activity is listed in parentheses to the right of the activity name. Each activity has an icon to the left of the activity name that indicates whether a grading action is required for the activity. A checkmark indicates that there are no submissions, or all submissions have been graded. An empty circle indicates that there is a submission for the activity that requires grading. Clicking on an activity will take the user to the grade book for the course in the institution's Joule site via the phone's Web browser.

8.1.11.1.3. Activity Grades
Android BlackBerry iPhone, iPad or iPod touch

The Activity Grades screen displays a list of all activities with the average student grade for each activity in parentheses. Each activity has an icon to the left of the activity name that indicates whether a grading action is required for the activity. A checkmark indicates that there are no submissions, or all submissions have been graded. An empty circle indicates that there is a submission for the activity that requires grading. The activities are listed by the order they appear in the course. Clicking on an activity will take the user to the Activity Grade Details screen.

8.1.11.1.4. Activity Grade Details
Android BlackBerry iPhone, iPad or iPod touch

The Activity Grade Details screen displays a list of students in alphabetical order by last name with their course grade and average course grade in parentheses for the activity selected. Clicking on a student will take the user to the grade book for the course in the institution's Joule site via their phone's Web browser.

9. Joule Social

9.1. Social Site

9.1.1. Overview

Joule Social offers an environment where all institutional users can choose to befriend each other, communicate, join groups together, or create new ad-hoc groups. Community tools allow users to share links, multimedia, status updates, blogs, forums, and questions and answers.

9.1.2. Benefits

Joule Social supports collaboration, networking, crowd-sourced knowledge, and ad-hoc groups. Every learner can also participate as an informal teacher.

While Joule Social benefits a community of students, it also supports communities of alumni, parents, and other constituencies who desire to connect and learn from each other.

9.1.2.1. Social Constructionism as a Design Referent

Open-source Moodle was designed as a tool to support Social Constructionism. Martin Dougiamas, Moodle's founder and lead developer, followed these tenants in the creation of Moodle:

  • All of us are potential teachers as well as learners - in a true collaborative environment, we are both.
  • We learn particularly well from the act of creating or expressing something for others to see.
  • We learn a lot by just observing the activity of our peers.
  • By understanding the contexts of others, we can teach in a more transformational way (constructivism).
  • A learning environment needs to be flexible and adaptable, so that it can quickly respond to the needs of the participants within it.

Joule Social was designed by rethinking these same tenants through the lens of contemporary social networking, rather than through the lens of a traditional LMS. We see Joule Social as a powerful companion to the LMS – a place where informal learning can be fostered and celebrated.

9.1.3. Usage Scenarios

Joule Social can be used in a variety of ways:

  • To create discussion/collaboration spaces for school groups (clubs, teams, committees, etc.)
  • To create spaces for ad-hoc groups (study groups, etc.)
  • To create spaces for parent communities
  • To create spaces for alumni communities
  • Encourage program/campus-wide engagement and interaction

9.1.4. User Documentation

In the Joule Social environment, student and teacher roles do not exist; however, a manager role exists, which has extended capabilities.

9.1.4.1. Select Joule Social

Users can enter the Joule Social environment by clicking the link within the Joule Social block.

9.1.4.2. Community Stream

The community "stream" allows you to see aggregated activity within your community of friends and groups. When you befriend someone in Joule Social, their activities are added to your community stream. When you join a group, those activities are also shown on the community stream. When you are in a Joule course, the recent course activity is added to the stream as well. This aggregation of activity and updates makes staying connected much easier, because you do not have to visit every person, group or course in order to view activities.

9.1.4.2.1. Filtering the Stream

If you do not want to see evidence of all activities for groups or friends, you can click the filter (funnel shaped) icon in order to filter out streams.

Identify which content and streams you want to view by checking them appropriately. Click the Update button to confirm your decision.

As your community grows, these filters will help you focus on your favorite things.

9.1.4.2.2. Adding to the Stream

If you want to add an activity to the stream, you can type a status update in the stream box.

If you want to attach items to your post, click on the appropriate icon. Attachment choices include:

  • URL link
  • Image files
  • Video URL (for embedded posts)

If you want to cancel the attachment, click the Cancel button.

You will notice that the resulting post includes your icon (so that others can identify you), a time stamp and the ability for others to click on the Comment link to post a note about your post.

9.1.4.3. User Information Column

On the left side of the screen is a list of user information.

You can use this list to quickly navigate to different Joule Social activities within your profile.

9.1.4.4. View Friends

To view friends, click the Friends link in the header navigation or in the User Information column.

Any of your existing friends will appear in this list.

9.1.4.4.1. Find Friends

To find a friend, click the Find People link. A list of people within the institution will appear.

Find the user that you want to add as a friend, hover the mouse over the corresponding wrench icon until it reveals two additional icons:

Click the Add Friend (silhouette shape with a plus sign) icon to make a friend request. If they choose to accept your request, a notification message will appear in the Notifications list.

Click the Mail (envelope) icon to send a message to that person.

9.1.4.4.2. Friend Request Notifications

When someone requests to be your friend, the request goes to their Notifications area. Click the Notifications icon to view all alerts.

Click the Accept link to add the person as a friend. Click the Decline link to ignore the request and remove the notification.

9.1.4.4.3. Removing Friends

When you view your friend list or add friends (see above), you will see the people who are your current friends. Hover the mouse over the wrench icon until it reveals the additional icons:

Click the Remove friend (silhouette shape with a red X) to drop the user from your list.

9.1.4.4.4. Visiting a Friend's Profile

Once a friend appears in your list, you can click on his or her name and visit their profile page.

A friend's profile page reveals everything about his or her activities. Click on the Actions link to view those activities.

One of the central concepts of Joule Social is that both people and groups offer "centers" of activities. Compared to other Web activities, people-based activities include personal updates, personal media albums, etc. (think Facebook). Meanwhile, groups are more like informal Web communities (think Ning), where users can share blogs, forums, etc. with a specific group. Rather than distinguish the activities of people and groups differently, we instead provide the same activities within both contexts.

9.1.4.5. Groups

To view groups, click the Groups link in the header navigation or in the User Information column.

Any existing groups will appear in this list.

Click on the Group Name link to visit the group.

9.1.4.5.1. View Group Activities

The group page displays recent activity in the stream, as well as a list of group members.

Click on the Actions link to view all activities, sorted by activity type.

Click on the Edit Group Settings link to manage/edit the group settings.

9.1.4.5.2. Find and Join a Group

To find a group, click the Find Groups link.

You will see a list of current and available groups.

After you have found the group you want to join, click the Join Group link.

Joining groups adds you to a smaller community of users. Some of those users may not be your formal friends.

9.1.4.5.3. Leave a Group

Click the Groups link in the User Information column.

Identify the group you want to leave and hover the mouse over the wrench icon.

Hovering will reveal the Leave Group (silhouette with a red X) icon:

Clicking the icon will remove you from the group.

9.1.4.5.4. Create a Group

To create a group, click the Create Group link.

You will be asked for to provide the following information:

  • A unique group name
  • An image to reflect your group's focus (optional)
  • A couple sentences describing your group's focus (optional)

Next, a group leader needs to determine who will have access to join the group. The following three methods are available:

  • Open: This will allow anyone to join this group
  • Closed: Anyone can apply for membership but only group administrators will be able to approve of new members to the group
  • Hidden: This group is invite only – people on the site will not be able to search for your group and it will not appear anywhere unless they are a member of your group

Save your changes to this new group by clicking the Create Group button at the bottom of the page.

9.1.4.6. Group Activities

Groups, like user profiles, offer a series of activities that are shared with the community of people belonging to the group.

Users can post status updates and attachments within the group's activities stream.

Users can click the Actions link to view group forums, media albums, answers or blogs. Likewise, users can view members of the group and send messages to individuals within the group.

9.1.4.7. Managing the Group

If you are a group manager, you can re-visit the group's settings page by clicking the Action link and choosing Edit Group Settings option.

Alternately, when you want to return and make changes to the group settings, click the Groups link in the header navigation or in the User Information column. Find the group that you want to manage, hover the mouse over the wrench icon next to your selected group until it reveals the additional icons:

  • Edit (pencil icon)
  • Transfer (circular arrows)

Click the Edit icon to navigate to the group management page, where you can change the group's name, description, image and access settings. Moreover, you will see a series of links to manage invitations, membership, ownership and (ultimately) whether the group should be deleted.

9.1.4.7.1. Managing Group Invites

When you want to invite someone to a group (especially if group access is limited to Closed or Hidden), click the Invite link within the group management page.

You will then see a list of all your current friends. Select the friends (by checking the corresponding box) that you would like to invite to the group. Then click the Send Invitations button.

9.1.4.7.2. Managing Group Members

When you want to manage members of a group, click the Members link within the group management page.

You will be able to remove members from the group by clicking the Delete (red X) icon corresponding to their name. Additionally, by checking the Admin box, you can designate them as a manager/admin of the group.

9.1.4.7.3. Resigning Ownership of a Group

When you want to resign as the owner of a group, click the Resign Ownership link within the group management page.

Click on a group member's name in order to designate that person as a new owner/manager/admin of the group.

Alternately, you may transfer management of a group through the following method:

  1. Click the Groups link in the header navigation or in the User Information column
  2. Find the group that you want to transfer
  3. Hover the mouse over the wrench icon (associated with the group) until it reveals the additional icons
  4. Click the Transfer icon to navigate to the ownership transfer page
  5. Click on a group member's name in order to make them a new owner/manager/admin of the group
9.1.4.7.4. Deleting a Group

When you want to delete a group, click the Delete link within the group management page.

Joule Social will present a warning and require confirmation prior to deleting the group.

9.1.4.8. View Messages

To view your messages, click the Messages link in the User Information column.

The inbox contains all of your messages. Click on the message's subject line to read it and reply.

Mark a message for the trash by checking the corresponding box and clicking the Move to Trash button.

When you are reading a message, you can click on the author's name to visit his profile, post your own reply, or click the Close or Move to Trash buttons.

9.1.4.8.1. Compose Messages

To write a new message, click the Compose link in the User Information column.

Messages can be sent to any of your friends. Begin typing their names to see them in the To Friend field. Add a subject, compose your message, and then click the Send Message button to send.

9.1.4.9. View Media Albums

To view your media albums, click the Media Albums link in the User Information column.

Next, choose the album you want to view by clicking on its title. You may also edit or delete the album by clicking on the links.

Upon clicking on an album title, you will see all of the media within the album. You may also edit or delete the media by clicking on the links.

Click on individual items to see them alone.

On this page, you can view the number of comments and views as well as add your own comments. Further, clicking the navigation arrow will take you to the next item in the media album.

9.1.4.9.1. Create New Album

To create a new media album, click the Create Album link in the User Information column.

To add media to your album, click one of the three media buttons: photos (.jpg, .tif, .gif, .png), movies (.avi, .mov, .mp4, .wmv) and sounds (.mp3, .wma).

Prior to uploading the file, Joule Social will offer information about maximum file sizes and types, as well as require the user to claim authority to post the media items.

9.1.4.10. Answers

If you want to "community-source" answers to various questions, use the Answers activity. This system allows you and your friends to post various questions, then allow others to provide answers to them. Favorite (or most accurate) answers can be voted upon by the community.

Begin by clicking the Answers link in the User Information column.

9.1.4.10.1. New Questions

Next, you can pose a new question to your community of friends by typing your question in the text box and clicking the green check mark button to post it.

9.1.4.10.2. Sorting Questions

Your questions will be added to a list that can be sorted by clicking the Most Recent Questions link. You may also sort by the Most Popular Questions, and Questions without Answers.

9.1.4.10.3. Question Detail

Your list of questions will indicate how many answers are associated with each. You will also know the time of last activity associated with each question.

9.1.4.10.4. Answers

Once questions have been raised, you can offer answers to them. You may also add comments to the question, offering contextual layers.

Within your answer, you can use text, photos, attachments and links to craft your response.

Example of an answer:

9.1.4.10.5. Commenting on Answers

You may comment on someone's answer. Click on the Dialogue icon to start.

9.1.4.10.6. Voting on Answers

You can also vote for the answer you think is best. Click on the one of the three star icons. The three stars represent: Good answer, reasonable answer, and flawed answer.

9.1.4.11. Forums

Forums are activities that allow a deeper conversational flow then common Joule Social media comments.

To view forums, click the Forums link in the User Information column.

Forums are organized as a three-level system. First, you have a forum title, then you have a topic, then you have posts to that topic.

Click on a forum title to view its various topics.

Click on a topic to view its various discussion posts. Or you can click the green plus sign to add a topic or the red X to delete any checked topics.

9.1.4.11.1. Post to a Topic Within a Forum

Add a post by replying to a topic or an existing post. Discussion posts are displayed as nested conversations so that you can reply to individual posts.

9.1.4.11.2. Add a New Forum

Click on the folder icon in the forum bar to create a new forum. Give the new forum a name before clicking on the Submit button.

9.1.4.11.3. Navigate From Forum to Forum

Users can navigate back to the main forum page by clicking on the Forums link in the breadcrumb nav. To go to a different forum, click on the Change Forum drop-down menu and select the forum you'd like to visit.

9.1.4.11.4. Deleting Posts, Topics and Forums

The author of a post can hover over the wrench icon of a post and see the following three options:

  • Edit icon: Allows editing of the post
  • Delete icon: Allows deletion of the post
  • Flag icon: Will flag the post for inappropriate content

The owner of a forum can erase one or more forums by marking the corresponding forum, then clicking the Delete button.

The owner of a topic can erase one or more topics by marking the corresponding topic, then clicking the Delete button.

9.1.4.12. Blogs

To view blogs, click the Blogs link in the User Information column.

A list of current blogs will appear in the center of the screen. You will be able to see, at a glance, the number of comments and views per post. Click on the Comments link to view or make comments.

Click on the title of the blog to see its full length. Note the ability to add photos to your blog posts.

9.1.4.12.1. Add a New Blog Post

The new blog will require a title, and could include an image attachment. The body of the post is composed using a WYSIWYG HTML editor, which allows users to toggle between WYSIWYG view and source code view, depending on their preferences.

9.1.4.12.2. Browsing Blogs and Group Blogs

Click on the Browse Blogs link to see a list of most recent blogs from the entire community (not limited to your friend community). Click on the title of the blog to see its full length.

Click on the Group Blogs link to see a list of most recent blogs from your groups.

By browsing blogs, it is possible to learn about interesting writers on the site who may be potential friends.

9.1.4.13. Notifications

Numerous actions within Joule Social send notifications to the user. These are available by clicking on the Notifications icon, which looks like an exclamation point in an orange circle. A red number will appear on the icon to indicate you have the many new notifications waiting.

You will be prompted to accept actions or dismiss them. Notifications will disappear from the list only when you click on one of their links (e.g. to Read or Dismiss).

9.1.4.14. News

An institution/organization can post news articles to Joule Social that appear one of two ways.

9.1.4.14.1. Headline News

News articles that are marked as "featured" will appear in the top of the header. Clicking on the article title will open the article in the main page. Clicking the left and right arrow icons will scroll through the list of featured articles.

9.1.4.14.2. News Link

Click on the News link in the User Information column to view the news summary in the main page.

9.1.4.14.3. News Summary

The News summary is a quick view of the featured and regular articles on the site. Click on article titles for the full story. Some articles allow for commenting or voting.

Note: Only Joule Social managers can submit and curate the news articles.

9.1.4.15. Links

Click on the Links icon in the header for a list of quick links for the organization.

Note: Only Joule Social managers can submit and curate the links.

9.1.4.16. Search

Click on the Search (magnifying glass) icon in the header to search for keywords. You may filter your search to include the entire site, news, blogs, groups or users.

Search results will present summaries of matches. Click on the link within the summary to visit the source.

9.1.4.17. Chatbar

Along the footer of Joule Social is a bar that supports individual user chats, as well as chatrooms.

Clicking on the gear icon in the Chatbar opens some user options, such as setting an availability status and enabling/disabling sound and popup notifications of new chat messages.

Clicking on the Close (downward arrows) icon will collapse the long bar into a single chat icon.

Clicking on the Chatroom icon will open a panel of existing chats, as well as provide the ability to create new chats with friends.

10. Repositories

10.1. Alfresco

10.1.1. Overview

The Alfresco repository plug-in for Joule connects Joule's file browser and HTML editor interfaces to an Alfresco repository. The plug-in works with site, course and personal Alfresco spaces and allows a user to access these files from within Joule based on their role. The Alfresco plug-in has the following advantages:

  1. Spaces within Alfresco are automatically created for each course and user within Joule
  2. Users can seamlessly switch between Joule and Alfresco via single sign-on integration
  3. Both the file browser and HTML editor allows for easy searching and browsing of the Alfresco spaces that the user has access to
  4. Alfresco content can either be viewed directly from within Alfresco or copied to Joule for use, depending on the user's preference
  5. Content can easily be moved from Joule to Alfresco or Alfresco to Joule
  6. Alfresco video content will be automatically embedded using the HTML editor and the multimedia filter
  7. Site administrators can set a storage quota for users in Alfresco from within Joule

The Alfresco repository plug-in was originally developed by Moodle Partner Remote-Learner and has been modified by Moodlerooms to work within Joule and the Dell hosting environment.

10.1.1.1. Related Features

10.1.2. User Documentation

10.1.2.1. My Files

A user can access the Alfresco personal and shared spaces from within Moodle/Joule via a new tab called My Files in the user's profile page.

User profile page with the new my files tab

To access the My Files tab, click on your name in the upper right-hand corner. This will bring you to your profile page where you can click on the My Files tab.

10.1.2.1.1. Switching Alfresco Spaces

Every user has access to two Alfresco spaces in the My Files tab: a personal and a shared space. A user can switch between the personal and shared spaces by clicking on the Browse from files drop-down menu in the upper right-hand corner of the file browser interface.

file browser browse from file drop-down

Select Repository user files to access your personal Alfresco space and select Repository shared files to access the shared Alfresco space.

10.1.2.1.2. Upload Files to Alfresco

The file browser allows a user to upload files to an Alfresco repository space. To upload a file to Alfresco, follow these steps:

  1. Select the file repository (user or shared) that you want to upload the file to from the Browse from files drop-down menu
  2. Click the Upload File button
    click the upload file button in the file browser interface
  3. Click the Browse button
    upload file interface click the browse button to select a file to upload
  4. Select the file from your computer to upload
  5. Click the Open button
  6. Click the Upload this file button

Once a file is uploaded to Alfresco, it will show any time the file browser displays the repository user files, as well as in the HTML editor when adding an image or a link (see Repository File in the HTML Editor)

File browser with files in it

10.1.2.1.3. Make a Folder in Alfresco

The file browser allows a user to create folders within an Alfresco repository space. To create a new folder, follow these steps:

  1. Click the Make a folder button
    Click the make a folder button
  2. Type in a name for the folder in the text field
  3. Click the Create button

The folder will now be listed in the file browser. To upload files to the folder, click on the folder and follow the instructions for uploading a file above.

10.1.2.1.4. Move Files and/or Folders to an Alfresco Folder

The file browser allows a user to move files and folders between folders, from a parent folder to a child folder, or vice versa in an Alfresco repository space. To move files and/or folders from one folder to another in Alfresco, follow these steps:

  1. Check the checkbox next to each file that you want to move to the folder
  2. Select the "Move to another folder" option from the With chosen files... drop-down menu
    Select the "Move to another folder" option from the With Chosen Files... drop-down
  3. Click on the folder that you want to move the files to
  4. Click the Move files here button
    Click the move files here button

The files will be removed from the original folder and placed in the new folder.

Files moved to a folder

10.1.2.1.5. Deleting Files and/or Folders From Alfresco

The file browser allows a user to delete files and folders from an Alfresco repository space. To remove files and/or folders from Alfresco from within Joule, follow these steps:

  1. Check the checkbox next to each file and folder that you want to delete
  2. Select the "Delete completely" option from the With chosen files... drop-down menu
    Select the "Delete completely" option from the With chosen files... drop down
  3. Confirm that the file listed are the ones you want to delete by clicking the Yes button
    Delete confirmation page
10.1.2.1.6. Zipping Files and/or Folders Within Alfresco

The file browser allows a user to compress files and folders into a ZIP archive file within an Alfresco repository space. To compress files and/or folders into a ZIP file within Alfresco via Joule, follow these steps:

  1. Check the checkbox next to each file and folder that you want to add to a ZIP archive
  2. Select the "Create zip archive" option from the With chosen files... drop down
    Select the "Create zip archive" option from the With chosen files... drop down
  3. Confirm that the files about to be added to the ZIP archive are correct
  4. Name the new ZIP file that will be created using the text field
    Name the ZIP file and click the Create ZIP Archive button
  5. Click the Create zip archive button

The files and/or folders selected will be compressed into a ZIP file, and the ZIP file will be added to Alfresco and display via the file browser in Joule.

File browser listing with the created zip file

10.1.2.1.7. Unzipping a ZIP Archive

The file browser allows a user to unzip a ZIP archive in an Alfresco repository space. To unzip a ZIP archive, follow these steps:

  1. Click the Unzip link to the right of the ZIP archive
    Click the Unzip link to the right of the zip archive in the file browser
  2. Click the Continue button below the list of folders and files that have been extracted
10.1.2.1.8. Listing All Files in a ZIP Archive

The file browser allows a user to list all of the files and folders in a ZIP archive in an Alfresco repository space. To list the files and folders in a ZIP archive, follow these steps:

  1. Click the List link to the right of the ZIP archive
    Click the list link to the right of the zip archive in the file browser
  2. Click the Ok button below the list of folders and files in the ZIP archive
10.1.2.1.9. Searching for Files in Alfresco

The Alfresco plug-in allows a user to search for files in Alfresco spaces from within Joule. To search for a file, enter all or part of the file name in the search field and click the Search button.

File browser search for a jpg file

The files that are found will be displayed below the search field. You can return to the list of files in your space by clicking the Return to file list link in the lower left-hand corner of the screen or by clicking the Show all button.

10.1.2.2. Repository File in the HTML Editor

The Alfresco plug-in enhances the Joule HTML editor to allow users to add images and media inline from repository spaces. The Alfresco plug-in also allows a user to link text to files in a repository space. Both the Insert Link and Insert Image interfaces bring the user to the file browser, similar to the My File's file browser. This file browser allows a user to:

  • Select a file to link to or display inline
  • Create a folder
  • Delete files
  • Upload files
  • Compress files and/or folders
  • Unzip a ZIP archive
  • List the files in a ZIP archive

All of these actions, except selecting a file to link to, work the same as in the file browser in the My Files area, described above. See My Files for more information.

10.1.2.2.1. Select a File to Display Inline

To add an image or media file from an Alfresco repository space inline, follow these steps:

  1. Click the image icon (looks like a framed picture) on the HTML editor toolbar
    image button on the html editor
  2. Click the link to the image you want to display inline
    image selected to use inline
  3. Preview the image in the preview pane
  4. Add Alternative text
  5. Set the height and width that the image is to be displayed at, Unknown is entered by default and will not display the image correctly.
  6. Click the Ok button in the upper right hand corner

The image will be added inline of the HTML editor at the height and width specified.

10.1.2.2.2. Select a File to Link HTML Text to

To link HTML text to a file in an Alfresco repository space, follow these steps:

  1. Highlight the text you wish to turn into a hyperlink
  2. Click the link icon (looks like a chain link) on the HTML editor toolbar
    Click the link button after selecting text to link a file from the repository to some text
  3. Click the Browse button
    Click browse button to view the files in the repository space
  4. Click the link of the file that you want to link to
    file browser from the browse button to add a link to the html editor
  5. Enter a title and other values for the link
    Enter a title and other values for the link
  6. Click the Ok button and the highlighted text will be converted to an HTML link to the chosen file

10.1.3. Teacher Documentation

Teachers have the same access to the user and shared Alfresco repository spaces as a student does. Teachers also can access a course Alfresco repository space for each course they are teaching. Each course has its own unique Alfresco repository space that only users assigned as teachers for the course can upload files to. Students have access to view files from this space when used in the course.

There are four methods that can be used to access a course's Alfresco repository space. The first method is navigating to the course and, within in the Course Administration Block, clicking on the Files link.

course administration block click on the files link

The second method is navigating to the course and then adding an activity or resource that requires a file as an attachment, such as the File or Page resources. Within the add activity or resource interfaces, you can click the Choose or upload a file button.

Click the choose or upload a file button

The third method is through the HTML editor as documented in the User Documentation section . Once in the file browser, a teacher can change the repository from the current repository to the Joule course files or the course Alfresco repository space via the Browse files from drop-down menu.

Teacher view of the browse files from drop-down

The final method is by accessing your profile page when in the course you teach and clicking the My Files tab.

Once in the course repository space, you can perform all the same actions a user can in the shared and personal Alfresco repository spaces.

The file browser defaults to the last option selected in the Browse files from drop-down menu. This means that, if a user last browsed for files within a space that they are allowed to view but then attempts to browse for files in a context where they don't have permissions to view that same space, they may see the following error message: "Sorry, but you do not currently have permissions to do that (View site-level content)." For example, if a user last browsed in the "Course files" space while in a course that they teach, but then attempts to browse for files at the site level, the file browser will automatically look within the "Course files" space at the site level. If that user does not have the permissions to view the "Course files" space for the site level, they will get an error.

To fix this error, return to a course you are teaching and click the Files link under the Course Administration block and select "Repository user files" from the Browse files from drop-down menu.

10.1.4. Administrator Documentation

10.1.4.1. Enabling Alfresco File Repository Plug-In

The Alfresco plug-in adds a new repository system within the Site Administration block on the front page of the site called File System. Within the File system link, you will find the Repositories area. The Repositories area allows a site administrator to manage and view all repositories in Joule. Repositories in Joule work the same as authentication and enrollment plug-ins in that they must be enabled before they can work. To enable the Alfresco plug-in, follow these steps:

  1. Click on File System > Repositories > Manage Repositories.
    Alfresco repository link within the site administration block
  2. Click the Enable check box to the right of the Alfresco repository
    Manage repositories interface
  3. Click the Save Changes button

10.1.4.2. Configuring the Alfresco Repository Plug-In

Once the repository has been enabled, it can be configured. The URL, port, user name, password and root folder settings are configured by Moodlerooms employees when Joule and Alfresco are set up. To change the default global settings, follow these steps:

  1. Click on File System > Repositories > Manage Repositories (or click on File System > Repositories > Alfresco and skip the next step)
    Alfresco repository link within the site administration block
  2. Click the Edit link under the Settings column to the right of the Alfresco repository
    Manage repositories interface
  3. Modify the settings based on your needs. See the Global Settings section below for detail on each setting.
  4. Click the Save Changes button

10.1.4.3. Accessing Site-Level Repository Files

Once the Alfresco plug-in is configured, site administrators will be able to access the site, shared and user file spaces within the Alfresco repository from Joule's Site files link (Site Administration block > Front Page > Site Files).

Site files with Alfresco repository

From here, the site administrator will be able to perform the same actions that a student or teacher can within the user and course files in Joule.

10.1.4.4. Automatic Space Creation in Alfresco

The first time a user views the file browser, Joule creates the following spaces automatically in Alfresco:

  • A user space for each user based on their user name. These can be found in Alfresco under Company Home > User Homes.
  • A course space for each course on the Joule site based on the course's short name. These can be found in Alfresco under Company Home > Moodle > Course.

Users will only be able to see spaces in Alfresco that they have permissions to view. By default, this is their personal space, the shared space, and any space for any course in which they are enrolled as a teacher.

10.1.5. Global Settings

  • URL: The URL to your Alfresco server (should be in the following format http://www.myserver.org). This setting is configured by Moodlerooms. Default: http://localhost
  • Port: The port that your Alfresco server is running on (e.g. 80, 8080). This setting is configured by Moodlerooms. Default: 8080
  • Username: The user name used to log into the Alfresco server. This setting is configured by Moodlerooms.
  • Password: The password used to log into the Alfresco server. This setting is configured by Moodlerooms.
  • Category Filter: Choose the categories available when filtering search results.
  • Root Folder: The root folder on the repository where this Moodle site will store its files in Alfresco. Default: /moodle
  • Cache Files: Specify that files from the repository should be cached for this long in the user's browser. Default: No
  • User Storage Quota: Set the default value for how much storage space each Moodle user on Alfresco can use. Select "Unlimited" for unlimited storage space. Default: Not Set
  • Auto-Delete Alfresco User Directories: When deleting a Moodle user account, if that user has an Alfresco account, it will be deleted at the same time. By default, their Alfresco home directory will not be deleted. Change this option to enable or disable that behavior. Default: No
    Deleting a user's home directory in Alfresco will break any links in Moodle to content that was located in that directory.
  • Default File Browsing Location: If you choose a value here, it will be the default location that a user is automatically sent to when launching a file browser without having a previous location to be sent to. Default: Moodle files
    • Moodle Files - The Moodle course or site files directory, depending on where the file browser is accessed from
    • Repository Site Files - The Alfresco space for site-level files
    • Repository Shared Files - The Alfresco space that is shared by all users
    • Repository Course Files - The Alfresco space that is linked to the specific course the user is in. Only teachers can view this area.
    • Repository User Files - The Alfresco space that is unique to the user who is logged in.
      If a user does not have permissions to view the default location, they will see the next available location on the list that they have permissions to view.

10.1.6. Permissions

  • Create shared organization content: This permission allows a user to create content for an organization space in the repository.
    • Default Permissions
      Role Not Set Allow Prevent Prohibit
      Administrator   X    
      Course Creator X      
      Teacher X      
      Non-Editing Teacher X      
      Student X      
      Guest X      
      Authenticated User X      
    • Risks
      • XSS: Users could add files and texts that allow cross-site scripting (XSS)
  • Create personal content: This allows users to create personal content in their repository space (for example, uploading a new file).
    • Default Permissions
      Role Not Set Allow Prevent Prohibit
      Administrator   X    
      Course Creator   X    
      Teacher   X    
      Non-Editing Teacher X      
      Student X      
      Guest X      
      Authenticated User X      
  • Create shared content: This permission allows users to create/upload new content to the repository shared folder for the site
    • Default Permissions
      Role Not Set Allow Prevent Prohibit
      Administrator   X    
      Course Creator   X    
      Teacher   X    
      Non-Editing Teacher X      
      Student X      
      Guest X      
      Authenticated User X      
    • Risks
      • XSS: Users could add files and texts that allow cross-site scripting (XSS)
  • Create site level content: This permission allows site-level content to be created.
    • Default Permissions
      Role Not Set Allow Prevent Prohibit
      Administrator   X    
      Course Creator X      
      Teacher X      
      Non-Editing Teacher X      
      Student X      
      Guest X      
      Authenticated User X      
    • Risks
      • XSS: Users could add files and texts that allow cross-site scripting (XSS)
  • View shared organization content: This allows users to access site-level organization content, but not add new content.
    • Default Permissions
      Role Not Set Allow Prevent Prohibit
      Administrator   X    
      Course Creator X      
      Teacher X      
      Non-Editing Teacher X      
      Student X      
      Guest X      
      Authenticated User X      
  • View personal content: This allows a user to access personal repository content from their repository space, but not add new content.
    • Default Permissions
      Role Not Set Allow Prevent Prohibit
      Administrator   X    
      Course Creator   X    
      Teacher   X    
      Non-Editing Teacher X      
      Student X      
      Guest X      
      Authenticated User X      
  • View shared content: This allows a user to access repository shared files, but not add new content.
    • Default Permissions
      Role Not Set Allow Prevent Prohibit
      Administrator   X    
      Course Creator   X    
      Teacher   X    
      Non-Editing Teacher X      
      Student X      
      Guest X      
      Authenticated User X      
  • View site level content: This allows a user to access the repository site-level content, but not add new content.
    • Default Permissions
      Role Not Set Allow Prevent Prohibit
      Administrator   X    
      Course Creator X      
      Teacher X      
      Non-Editing Teacher X      
      Student X      
      Guest X      
      Authenticated User X      

11. Product Manual Terms of Use

Permission for the use of Product Manual is granted subject to the following terms and conditions:

By accessing this page and using this manual, you agree to and are bound by the terms of this Terms of Use. If you do not agree to all of the terms and conditions contained in the Terms of Use, you are not authorized to use this page or these documents.

In using Product Manual, you agree that you will use them only for their intended purpose and not use them for any purpose that is unlawful or prohibited by these terms. You may not misuse or alter any document in any way, including any derivative work, or reproduce or display these documents outside your enterprise without the express written consent of Moodlerooms.

Except as expressly granted in the Terms of Use, no other permissions, licenses or rights are granted, either express or implied, to the Product Manual, or to any information, data, software or other intellectual property contained therein.

Moodlerooms reserves the right to withdraw the permissions granted herein whenever, in its sole discretion, the use of the Product Manual is detrimental to its interest or, as determined by Moodlerooms, the instructions contained herein are not being properly followed.

Moodlerooms makes no guarantee about the content of the Product Manual. Use of the Product Manual is at your own risk. They are provided “as is” and without warranty of any kind, either express or implied, including, but not limited to implied warranties of merchantability, non-infringement and fitness for a particular purpose.

The Content, Software, Services and all other aspects of this web site are subject to these Terms of Use. Moodlerooms reserves the right to update these Terms of Use at any time without notice to you. The applicable and most current version of the Terms of Use can be reviewed by clicking on the “Terms of Use” hypertext link located at the bottom of our web pages.

Your Rating: Results: PatheticBadOKGoodOutstanding! 9 rates
Adaptavist Theme Builder Powered by Atlassian Confluence