Skip to main content
pdf?stylesheet=default
Blackboard Help

Set Up Files to Upload Data

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 file uses. For instance, if you use the term User instead of Username, then you would define this for the Username field.

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 are based on 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 name as the field name on the settings page. For example, the username field would remain username.

This section contains the instructions for the mappings and the details for each field.


Set the Mappings configuration

Steps: Conduit > Settings > Mappings

  1. Select Settings in the Conduit block.
  2. Select on the Mappings link under the Conduit Settings tab.
  3. Define the mappings between your export and Moodle's Conduit.
  4. Select Save changes when you have finished mapping your fields.

Map the fields

Users

The Conduit user mappings affect the auth.csv or auth.xml file by determining what the column headings or mapping tag attribute should be. You have several options 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 uses the entered default value.
  • Update Moodle every sync: This updates the user's Moodle profile based on changes made in Conduit. Updates are made anytime the cron is run or your file is uploaded.
  • Update Conduit: This takes changes made using Moodle's edit profile interface and update Conduit with those changes.

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

  • username: This is a required field.
    • Converts numbers to strings.
    • Trims strings of white space.
    • Lower cases string.
    • Validates that the value is a valid Moodle username.
  • idnumber: The idnumber for the user, such as student ID or any other value your organization uses to track unique users.
    • Converts numbers to strings.
    • Trims strings of white space.
    • Validates that the value is less than 255 characters long.
  • email: The user's email address, used by Conduit to email a new password.
    • Converts numbers to strings.
    • Trims strings of white space.
    • Validates that the value is an email address.
  • externalkey: This value is stored in the Conduit tables but not sent to Moodle. It can be used as an external identification for the user, mostly used for LIS support.
    • Converts numbers to strings.
    • Trims strings of white space.
    • Validates that the value is less than 255 characters long.
  • 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 Conduit, such as LDAP. Conduit is used by default if no value is passed.
    • Converts numbers to strings.
    • Trims strings of white space.
    • Lower cases string.
    • Changes the following values: uib to conduit for backwards compatibility.
    • Validates that the value is one of the following: accessid, alfrescosso, cas, conduit, db, efolio, email, fc, gsaml, imap, ldap, liveid, manual, mnet, nntp, nologin, none, pam, pop3, radius, saml, shibboleth, webservice.
  • mnethostid: Moodle network host ID – usually not set unless you know your site is using Moodle networking.
    • Trims strings of white space.
    • Validates that the value is a MNet Host ID.
  • suspended: This field determines if the user can login or if they account is suspended from user. Suspended accounts have their grades and enrollments kept but the user cannot log in to the site. Valid values are 0 for not suspended and 1 for suspended.
    • Trims strings of white space.
    • Validates that the value is an integer.
  • password: This is the user's password. Set this to the value in the Settings > User > Create password if it is file if you want Conduit to generate a password for the user and e-mail it to them. Otherwise, this can be a plain text or MD5 hash.
    • Converts numbers to strings.
    • Trims strings of white space.
    • Validates that the value is less than 32 characters long.
    • Validates that the password meets the Site's Password Policy (Settings Block > Site Administration > Security > Site Policy) if the password is plaintext and the Password policy filed is checked.
  • firstname: User's first name.
    • Converts numbers to strings.
    • Trims strings of white space.
    • Validates that the value is less than 100 characters long.
  • lastname: User's last name.
    • Converts numbers to strings.
    • Trims strings of white space.
    • Validates that the value is less than 100 characters long.
  • emailstop: This is whether the e-mail is enabled or disabled. The values are 0 for enabled and 1 for disabled.
    • Trims strings of white space.
    • Validates that the value is one of the following: 0, 1.
  • icq: The user's ICQ number.
    • Converts numbers to strings.
    • Trims strings of white space.
    • Validates that the value is less than 15 characters long.
  • skype: The user's Skype account name.
    • Converts numbers to strings.
    • Trims strings of white space.
    • Validates that the value is less than 50 characters long.
  • yahoo: The user's Yahoo account name.
    • Converts numbers to strings.
    • Trims strings of white space.
    • Validates that the value is less than 50 characters long.
  • aim: The user's AIM account name.
    • Converts numbers to strings.
    • Trims strings of white space.
    • Validates that the value is less than 50 characters long.
  • msn: The user's MSN account name.
    • Converts numbers to strings.
    • Trims strings of white space.
    • Validates that the value is less than 50 characters long.
  • phone1: The user's main phone number.
    • Converts numbers to strings.
    • Trims strings of white space.
    • Validates that the value is less than 20 characters long.
  • phone2: The user's secondary number.
    • Converts numbers to strings.
    • Trims strings of white space.
    • Validates that the value is less than 20 characters long.
  • institution: The institution the user attends – can be used for other things as desired.
    • Converts numbers to strings.
    • Trims strings of white space.
    • Validates that the value is less than 40 characters long.
  • department: The department the user is a part of.
    • Converts numbers to strings.
    • Trims strings of white space.
    • Validates that the value is less than 30 characters long.
  • address: The street address for the user.
    • Converts numbers to strings.
    • Trims strings of white space.
    • Validates that the value is less than 70 characters long.
  • city: City the user lives in.
    • Converts numbers to strings.
    • Trims strings of white space.
    • Validates that the value is less than 120 characters long.
  • country: These are the same values used when determining the country in a user's profile using the Conduit Mapping User Table.
    • Converts numbers to strings.
    • Trims strings of white space.
    • Upper cases strings.
  • 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.
    • Converts numbers to strings.
    • Trims strings of white space.
    • Validates that the value is less than 30 characters long.
  • theme: This is the shortname of the theme that the user uses. This is only used if you allow user themes in the site administration.
    • Converts numbers to strings.
    • Trims strings of white space.
    • Validates that the value is less than 50 characters long.
  • 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.
    • Converts numbers to strings.
    • Trims strings of white space.
    • Validates that the value is less than 100 characters long.
  • picture: The image used for the user.
    • Trims strings of white space.
    • Validates that the value is positive integer (zero or greater).
  • url: A URL that the user wants to be seen in their profile.
    • Converts numbers to strings.
    • Trims strings of white space.
    • Validates that the value is less than 255 characters long.
  • description: A description of the user – this can include HTML.
    • Converts numbers to strings.
  • descriptionformat: The text format the description of the user is in.
    • Trims strings of white space.
    • Validates that the value is one of the following: 0 = Moodle auto-format; 1 = HTML format: 2 = Plain Text format; and 4 = Markdown format.
  • mailformat: This is how the user chooses to receive e-mails.
    • Trims strings of white space.
    • Validates that the value is 0 = Plain Text or 1 = HTML.
  • maildigest: This determines if the user receives e-mails in the form of digests from forums.
    • Trims strings of white space.
    • Validates that the value is one of the following: 0 = No digest (single e-mail per forum post); 1 = Complete (daily e-mail with full posts); and 2 = Subjects (daily e-mail with subjects only).
  • maildisplay: This is whether the user's e-mail is displayed or not.
    • Trims strings of white space.
    • Validates that the value is one of the following: 0 = Hide my e-mail address from everyone; 1 = Allow everyone to see my e-mail address; and 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.
    • Trims strings of white space.
    • Validates that the value is 0 = Use standard Web forms; or 1 = Use HTML editor.
  • autosubscribe: This is if the user is automatically subscribed to a forum.
    • Trims strings of white space.
    • Validates that the value is 0 = No (don't automatically subscribe to forums); or 1 = Yes (when I post, subscribe to that forum).
  • trackforums: This is whether the user tracks the number of unread and read forum posts when viewing the forum.
    • Trims strings of white space.
    • Validates that the value is 0 = No (don't keep track of unread posts); or 1 = Yes (highlight new posts).
  • imagealt: The alt text to describe the user's picture.
    • Converts numbers to strings.
    • Trims strings of white space.
    • Validates that the value is less than 255 characters long.
  • screenreader: This is whether the user uses a screen reader or not.
    • Trims strings of white space.
    • Validates that the value is 0 = No or 1 = Yes.

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 displays at the bottom of the User Mapping area under the Screenreader field.

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

Courses

The Conduit course mappings affect the course.csv or course.xml file by determining what the column headings or mapping tag value attribute should be. You have several options 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 uses the entered default value.
  • Update Moodle every sync: This updates the course settings based on changes made in Conduit. Updates are made anytime the cron is run or your file is uploaded.
  • Update Conduit: This takes changes made using Moodle's course settings interface and update Conduit with those changes.

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

  • shortname: The shortname for the course – this must be unique for each course and is a required field.
    • Converts numbers to strings.
    • Trims strings of white space.
    • Validates that the value is less than 100 characters long.
  • idnumber: The idnumber for the course.
    • Converts numbers to strings.
    • Trims strings of white space.
    • Validates that the value is less than 100 characters long.
  • externalkey: This value is stored in the Conduit tables but not sent to Moodle. It can be used as an external identification for the course, mostly used for LIS support.
    • Converts numbers to strings.
    • Trims strings of white space.
    • Validates that the value is less than 255 characters long.
  • parent: The identification (based on general settings) of the parent course of the course being created. Used in meta course associations where child enrollments populate into the parent course.
    • Converts numbers to strings.
    • Trims strings of white space before and after parent separator in the course settings area.
  • category: The category(s) that the course is in. These should have the same separator as the category separator in the course area of the settings general sub tab.
    • Converts numbers to strings.
    • Trims strings of white space.
  • fullname: The course's full name.
    • Converts numbers to strings.
    • Trims strings of white space.
    • Validates that the value is less than 254 characters long.
  • summary: The summary for the course. This can be in HTML.
    • Converts numbers to strings.
  • summaryformat: Format that the summary field is in.
    • Trims strings of white space.
    • Validates that the value is one of the following: 0 = Moodle auto-format; 1 = HTML format; 2 = Plain Text Format; or 4 = Markdown Format.
  • format: The format for the course.
    • Converts numbers to strings.
    • Trims strings of white space.
    • Lower cases string.
    • Validates that the value is one of the following: flexpage, folderview, social, topics, or weeks.
  • showgrades: Whether to show the grades to the users or not.
    • Trims strings of white space
    • Validates that the value is one of the following: 0, 1.
  • newsitems: The number of news items displayed.
    • Trims strings of white space.
    • Validates that the value is between 0 and 10.
  • startdate: The UNIX time stamp for when the course starts.
    • Trims strings of white space.
    • Validates that the value is positive integer (zero or greater).
  • enddate: Used by certain SIS integrations. Clients should not use this field unless directed by Client Engagement.
    • Trims strings of white space.
    • Validates that the value is positive integer (zero or greater).
  • numsections: The number of sections in the topics or weeks format.
    • Trims strings of white space.
    • Validates that the value is between 0 and 52.
  • marker: Marks the current section that is visible to the student. Used mostly in topics and weekly course format and can be no higher than the number of sections.
    • Trims strings of white space.
    • Validates that the value is positive integer (zero or greater).
  • maxbytes: The maximum number of bytes a user can upload to a forum in the course.
    • Trims strings of white space.
    • Validates that the value is one of the following: 524288000 (500mb), 104857600 = (100mb), 52428800 (50mb), 20971520 (20mb), 10485760 (10mb), 5242880 (5mb), 2097152 (2mb), 1048576 (1mb), 512000 (500kb), 102400 (100kb), 51200 (50kb), 10240 (10kb), and 0.
  • showreports: Whether or not activity reports are available for each participant that show their activity in the current course.
    • Trims strings of white space.
    • Validates that the value is one of the following: 0, 1.
  • visible: Whether the course is visible to students or not. Use 0 for not available to students and 1 for available.
    • Trims strings of white space.
    • Validates that the value is one of the following: 0, 1.
  • 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.
    • Trims strings of white space.
    • Validates that the value is one of the following: 0, 1.
  • groupmode: This determines if groups are to be used in the course.
    • Trims strings of white space.
    • Validates that the value is one of the following: 0 = No groups; 1 = Separate groups; and 2 = Visible groups.
  • groupmodeforce: This determines if groups are forced in the course. Values are 0 for no and 1 for yes.
    • Trims strings of white space.
    • Validates that the value is one of the following: 0, 1.
  • defaultgroupingid: Default group that a user is assigned to if the course has groups set up.
    • Trims strings of white space.
    • Validates that the value is positive integer (zero or greater).
  • 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.
    • Converts numbers to strings.
    • Trims strings of white space.
    • Lower cases string.
  • 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.
    • Converts numbers to strings.
    • Trims strings of white space.
    • Lower cases string.
    • Validates that the value is one of the following: base, anomaly, afterburner, canvas, express, standard, magazine, formal_white, boxxie, serenity, leatherbound, binarius, nonzero, sky_high, arialist, overlay, nimble, fusion, brick, mrmobile, formfactor, flexpage, standardold, cherub.
  • requested: Whether the course was requested by a student or teacher rather than created by an administrator.
    • Trims strings of white space.
    • Validates that the value is one of the following: 0, 1.
  • enablecompletion: Turns on or off the course completion tracking for the course.
    • Trims strings of white space.
    • Validates that the value is one of the following: 0, 1.
  • completionstartonenrol: Enabled course completion based on when the user is enrolled in the course as opposed to the Date setting for the course completion settings.
    • Trims strings of white space.
    • Validates that the value is one of the following: 0, 1.
  • completionnotify: Enabled or disable notifications for completion.
    • Trims strings of white space.
    • Validates that the value is one of the following: 0, 1.
  • coursedisplay: This setting determines whether the whole course is displayed on one page or split over several pages. The setting has no affect on certain course formats, such as SCORM and folderview format.
    • Trims strings of white space.
    • Validates that the value is 0 (Show all sections on one page) or 1 (Show one section per page).
  • coursetemplate: This field is where you add the shortname for the master course. The new course is created from a backup of this master course.
    • Converts numbers to strings.
    • Trims strings of white space.
    • Validates that the value is less than 100 characters long.

Enrollments

The Conduit enrollments mappings affect the enroll.csv or enroll.xml file by determining what the column headings or mapping tag value attribute should be.

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

  • externalkey: This value is stored in the Conduit tables but not sent to Moodle. It can be used as an external identification for the enrollment, mostly used for LIS support.
    • Validation
      • Converts numbers to strings
      • Trims strings of white space
      • Validates that the value is less than 255 characters long
  • coursekey: This is mapped to the primary identification of the course in Conduit. Usually this is either the short name or ID number for the course.
    • Validation
      • Converts numbers to strings
      • Trims strings of white space
      • Validates that the value is less than 100 characters long
  • userkey: This is mapped to the primary identification of the user in Conduit. Usually this is either the user name, ID number or e-mail for the user.
    • Validation
      • Converts numbers to strings
      • Trims strings of white space
      • Lower cases string
      • Validates that the value is a valid Moodle username
  • rolekey: 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. ** ** Validation
      • Converts numbers to strings
      • Trims strings of white space
      • Validates that the value is less than 255 characters long
        Conduit Value Moodle Fullname
        manager Manager
        coursecreator Course Creator
        editingteacher Teacher
        teacher Non-Editing Teacher
        student Student
        guest Guest
        user Authenticated User
  • status: The status of the enrollment
    • Validation
      • Trims strings of white space
      • Validates that the value is 0 or 1
        Conduit Value Moodle Value
        0 Enabled
        1 Disabled
  • timestart: A UNIX time stamp for the date and time when the user should be added to the given role
    • Validation
  • timeend: A UNIX time stamp for the date and time when the user should be removed from the given role
    • Validation
      • Trims strings of white space
      • Validates that the value is positive integer (zero or greater)

You can map multiple fields in Conduit to one data field in your export. For example, if you want the e-mail and username to be the same, you could use "e-mail" as the mapping for both fields.

Role Assign

The Conduit role assign mappings affect the role_assign.csv or enroll_assign.xml file by determining what the column headings or mapping tag value attribute should be. The following are the mapping fields with their descriptions and accepted values:

  • externalkey: This value is stored in the Conduit tables but not sent to Moodle. It can be used as an external identification for the role assignment, mostly used for LIS support.
    • Converts numbers to strings.
    • Trims strings of white space.
    • Validates that the value is less than 255 characters long.
  • context: This is mapped to identify the type of enrollment coming in. This mapping is optional and if left blank, then it defaults to course enrollments.
    • Converts numbers to strings.
    • Trims strings of white space.
    • Lower cases string.
    • Validates that the value is one of the following: user, course.
  • moodlekey: 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 the user name, email, or idnumber of the user.
    • Converts numbers to strings.
    • Trims strings of white space.
    • Validates that the value is less than 255 characters long.
  • userkey: This is mapped to the primary identification of the user in Conduit. Usually this is the user name, ID number, or email for the user.
    • Converts numbers to strings.
    • Trims strings of white space.
    • Lower cases string.
    • Validates that the value is a valid Moodle username.
  • rolekey: 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.
    • Converts numbers to strings.
    • Trims strings of white space.
    • Validates that the value is less than 255 characters long.
      Conduit Value Moodle Fullname
      manager Manager
      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. rims strings of white space.
    • Validates that the value is positive integer (zero or greater).
  • timeend: A UNIX time stamp for the date and time when the user should be removed from the given role.
    • Trims strings of white space.
    • Validates that the value is positive integer (zero or greater).

Parents

In order to set up conduit to create parent access you need to do following:

  1. Create an account for a parent. If you are using any type of authentication (LDAP, CAS, etc.) but you do not authenticate parents' accounts against it, you can simply set up their authentication as manual.
  2. Create Parent/Mentor role, available in the user context and set up with the permissions you want.
  3. Go to Conduit > Settings > Mappings scroll down to the section Conduit Role Assignments. Use this area to assign a parent/mentor/guardian to a student.
    Field Mapping Comments
    externalkey leave empty It can be used as an external identification for the role assignment, mostly used for LIS support.
    context context You would be using "user" as a context to assign a parent.
    moodlekey student_account Under the Conduit Settings tab see what you are using as a unique identifier for your users. Can be an e-mail, idnumber, or username. Set this accordingly - this is your student account(primary key you selected).
    userkey parent_account This is the lookup field for your parent/mentor account. Can be e-mail, idnumber, or username *(primary key you selected).
    rolekey role You may use name or short name for a role, see under Settings what lookup field you have decided on primary key you selected).
    timestart At your discretion If you need to specify the period of time for a parent to have access to the student's information, you may set this up. Has to be in UNIX format.
    timeend At your discretion If you need to specify the period of time for a parent to have access to the student's information, you may set this up. Has to be in UNIX format.

    All the mappings can be changed to match your needs. Once you set this up, you can download the csv headers file. The csv file would look as follows (assuming you have e-mail as key field):

    action context student_account parent_account role
    create user student@email.com parent@email.com parent
  4. Use Operations tab to do the testing of the file. If everything was setup correctly, the parent is assigned to a student.
  5. At this point you can add the Mentees block to the parent's page so they could easily navigate to the student they needed.

Groups

The Conduit groups mappings affect the groups.csv or groups.xml file by determining what the column headings or mapping tag value attribute should be. The following are the mapping fields with their descriptions and accepted values:

  • externalkey: This value is stored in the Conduit tables but not sent to Moodle. It can be used as an external identification for the group, mostly used for LIS support.
    • Converts numbers to strings.
    • Trims strings of white space.
    • Validates that the value is less than 255 characters long.
  • coursekey: 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.
    • Converts numbers to strings.
    • Trims strings of white space.
    • Validates that the value is less than 255 characters long.
  • groupkey: This is mapped to the name of the group.
    • Converts numbers to strings.
    • Trims strings of white space.
    • Validates that the value is less than 255 characters long.
  • newgroupkey: This is used to replace the name column with the new name as the name of the group in Conduit and Moodle.
    • Converts numbers to strings.
    • Trims strings of white space.
    • Validates that the value is less than 255 characters long.
  • idnumber: The id for the group.
    • Converts numbers to strings.
    • Trims strings of white space.
    • Validates that the value is less than 100 characters long.
  • description: This is mapped to the description of the group.
    • Converts numbers to strings.
  • descriptionformat: The format of the description field.
    • Trims strings of white space.
    • Validates that the value is one of the following: 0 = Moodle auto-format; 1 = HTML format; 2 = Plain Text Format; and 4 = Markdown Format.
  • 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 entering that key lets the user into the course, but it also automatically makes them a member of the specific group.
    • Converts numbers to strings.
    • Trims strings of white space.
    • Validates that the value is less than 50 characters long.
  • hidepicture: This determines if the group picture is hidden. Valid values are 0 for visible or 1 for hidden.
    • Trims strings of white space.
    • Validates that the value is one of the following: 0, 1.

Group Members

The Conduit group members mappings affect the group_members.csv or group_members.xml file by determining what the column headings or mapping tag value attribute should be. The following are the mapping fields with their descriptions and accepted values:

  • externalkey: This value is stored in the Conduit tables but not sent to Moodle. It can be used as an external identification for the group members, mostly used for LIS support.
    • Converts numbers to strings.
    • Trims strings of white space.
    • Validates that the value is less than 255 characters long.
  • coursekey: 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.
    • Converts numbers to strings.
    • Trims strings of white space.
    • Validates that the value is less than 255 characters long.
  • userkey: 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.
    • Converts numbers to strings.
    • Trims strings of white space.
    • Lower cases string.
    • Validates that the value is a valid Moodle username.
  • groupkey: This is the name of the group the user is being created in.
    • Converts numbers to strings.
    • Trims strings of white space.
    • Validates that the value is less than 255 characters long.