Conduit currently functions with the following file formats and services:
- Uploaded CSV or XML files
- RESTful Web Services XML files
Overview of Conduit setup
- Configure the Conduit General Settings for users, courses, and enrollments.
- Map your CSV or XML column headings/data fields to the Conduit fields in the Settings > Mappings tab.
- Setup location of files or services:
- If using file upload, define the name and location of your files in the Settings > Files tab.
- 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.
Add the Conduit block
Steps: Turn editing on > Add block > Conduit
To configure Conduit, you must first add the Conduit block to your site page.
- On the site’s homepage, select Turn editing on.
- Add the Conduit block using the Add block menu.
Select the Conduit settings
Steps: Conduit > Settings
The Settings tab contains all of the configurations for Conduit. Use the General settings page to set the synchronization rules between Conduit and your site.
- Select Settings in the Conduit block.
- Configure the synchronization settings in the Cron area:
- Select Cron enabled to determine if the Conduit block runs during site’s cron or not. If enabled, the cron performs a full synchronization of the Conduit’s external tables to your Moodle site tables.
- Determine whether to Remove logs or archive the logs, and when to delete or archive.
Archived logs are stored in the data directory under archive/conduit/logs in a zip file. These files can be downloaded via SFTP and extracted locally. The data in the file is all SQL insert statements to add the records back into a database.
- Configure the Email notifications for transactions:
- Select the types of Transactions to send emails about. Options include:
- None – No transactions.
- File and Web service – Only file and Web services transactions are e-mailed. The administrative cron transactions are ignored.
- Non-Empty – Only transactions where data is in the file, plus Web services and administrative cron messages.
- 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.
- Select who should be emailed in the Send to box.
- Select whether or not to include the transaction records as an Attachment.
- Select the types of Transactions to send emails about. Options include:
- Determine how to look up information in your site to compare it to the information in Conduit using the Conduit to Moodle lookup fields area.
- Set the mapping field to use for the User record. Options include username, idnumber, and email.
- Set the mapping field to use for the Course record. Options include shortname and idnumber.
- Set the mapping field to use for the Role record for course enrollment. Options include name and shortname.
- Determine how User data sent to Conduit is processed and how Conduit sends that information to Moodle.
- Determine what to do with the Moodle user accounts if the user removed from the submitted CSV, XML or Web services files. Options include Keep, Suspend, or Delete. Only suspended users are automatically revived if they reappear in the next upload.
- Set the type of Password hash for Conduit to expect in the CSV, XML files, or the Web services request.
- Determine if a unique password should be created and e-mailed to the user’s e-mail address from the Create password list.
- Set a value in the Create Password if it is box to have Moodle create a password for those users. For example: “changeme” causes all users with the password “changeme” to have a unique password created and e-mailed to them.
- Determine if users should be forced to change their password when they first log in.
- Determine whether or not to have Conduit Update all user accounts. If set to Yes, Conduit updates all users regardless of the authentication type set.
- Determine how Course data sent to Conduit is processed and how Conduit sends that information to Moodle:
- Leave Auto-create courses to Yes to have Conduit create your courses in Moodle.
- Determine in Auto-update courses if you want courses in Moodle updates with changes in Conduit.
- Determine in Auto-delete courses if you want courses in Moodle automatically deleted when set to remove in Conduit.
- Determine whether or not to Auto-archive courses.
When a course is deleted by Conduit, the course is automatically backed up prior to deletion. The backup is moved to SITEFILES/backupdata/autoarchive/. Both the backup output and archive are logged. If any errors occur, the course is not deleted and error is logged.
- Select the Default category for auto-created courses missing the category information.
- Determine whether or not to Auto-create category when automatically created courses belong to a category that does not exist in Moodle.
- If using sub-categories in your site, specify the character to use as the Category Separator. If there are no subcategories in your Moodle site, leave this box empty.
- If using meta courses in your site, specific the character to use as the Parent Separator. If there are no meta courses in your Moodle site, leave this box empty.
- If you want to hide the course after its end date has passed, select Hide after course end date.
- Treat category names as record IDs:
- When the course category value is a number, then Conduit will treat that value as a Moodle category database record ID.
- Using a course category with id number 2017 and setting this option to Yes, Conduit will look for a Moodle category with a database record of 2017. Only numbers in that course category field are valid when using it as a record ID.
- Using a course category with id number 2017 and setting this option to no, Conduit will look for a Moodle category named 2017.
- When combining values, Bio/435 for example, Conduit will look for a Moodle category named 435 that is a subcategory of Bio.
- Select the Default Template to use when auto-creating course.
- Determine if the Conduit course template feature is being used. Options are:
- Restore from backup – Set this to restore a course from a course backup that is stored in the Course Settings > Backups as the backup file area. The file name in the backups file area must be the exact same as the file name in the Restore template name box.
- 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 (which is linked to the default template field) or a course’s mapped template into auto-created courses (found in the Mappings tab).
- Restore template name – This is the name of the backup file to use when Restore from backup is set for the restore setting. For example, if this setting is set to “conduit_template.mbz” and in a course’s backup files there is a backup named “conduit_template.mbz”, then Conduit uses that backup file as the template. Otherwise, Conduit creates its own backup file to use and name it “conduit_template.mbz” by default.
- Determine how Enrollment data sent to Conduit is processed and how Conduit sends that information to Moodle:
- Determine if you want users to be unenrolled from courses from Auto-unenroll users. If enrollment entry is removed from Conduit, the user would be unenrolled from Moodle.
- Determine how course Group data sent to Conduit is processed and how Conduit sends that information to Moodle:
- Determine whether or not to Auto-create groups available in Conduit but not in Moodle.
- Determine whether or not to Auto-update groups in Moodle with updated information in Conduit.
- Determine whether or not to Auto-delete groups in Moodle if marked as deleted in Conduit.
- Determine how Group Member data sent to Conduit is processed and how Conduit sends that information to Moodle:
- Determine whether or not to Auto-assign members into groups for group members that do not exist in Moodle but are available in Conduit.
- Determine whether or not to Auto-remove members from Moodle if the group member record is marked as deleted in Conduit.
- Select Save changes when finished.