Conduit Mappings

Andy Braden
Updated

Mappings are how you match up the data fields between your source files and Open LMS. You map a field in Conduit by telling it what column header (CSV) or datum mapping name (XML) your source information uses for the matching field in the Open LMS record. If your information system uses the term “User” to identify what Open LMS calls the username in the Open LMS user profile, then you would define this relationship for the username field in the user record mapping.

2022-11-11_13_45_14-Conduit_mappings2.png

For CSV files, the mappings you provide are the column headings in the file. For XML files or packages, these are your object datum mapping name values. 

What to expect

CSV headers for an enrollment might be

action, course, user, role

The same in an XML package might look like:

<?xml version="1.0" encoding="UTF-8"?>

<data>

    <datum action="create">

        <mapping name="course">course_id</mapping>

        <mapping name="user">user_id</mapping>

        <mapping name="role">rolename</mapping>

    </datum>

</data>

 

Tip: The matching and mappings are case sensitive. If the name provided in the mappings is “User” but the name in the file is “user” they will not match. If the action provided is Create or CREATE the action will not work; Conduit expects to see create, update, or delete commands only. Some data fields will be processed in a way that cleans up case issues and others will store exactly what is provided. The information for each field possible is listed below and includes that information. 

What Fields to Map

Each of the fields marked with an asterisk * in the Mappings page are required for Conduit to work. All of the others are optional and are based on your SIS/CRM/HR/etc. system and/or organizational needs. Not every field needs to be mapped, and you do not need to supply a value for every mapped field. Conduit prefers that you only give it data that has been mapped, but if the record includes extra fields that have not been mapped, Conduit will log a warning identifying this situation. 

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

Setting Up Mappings

Notice that there are mappings available for every possible field for each of the supported record types, including any custom fields you might have added to user or course profiles. Also note that when setting the configuration for the first time, mappings are required for each data object handled by Conduit, even if you are not using them. In a brand new site, all of the required fields have a placeholder in them, so that if you are not using that kind of record, you can still save the Mappings. You do not need to provide those files ever or every time, but Conduit needs a base mapping for them. 

Steps: 

  1. Select the Mappings page under the Conduit Settings tab. Conduit > Settings > Mappings.
  2. Define the mappings between your export and the available fields in the record in Open LMS.
  3. Select Save changes when you have finished mapping the desired fields.

Besides the actual mappings, of what data value goes with what records value in Open LMS, there are also several other options available to user and course records. On a field by field basis you may determine if the field is left alone once created, stays in sync with the data in Conduit, or changes from the profile in Open LMS are passed back to Conduit. There is also support for providing a default value for a given field if no value is set in the record details. 

  • Default: Most of the field mappings have a default field option. When Conduit adds or updates a record and does not have a value for a mapped field, it uses the default value if one has been provided in the mapping.
  • Update Moodle every sync: This updates the Open LMS record based on changes made in Conduit. Updates are made anytime the cron is run or a change is made. This is used for fields that need to be updated with changes from the outside source.
  • Update Conduit: This takes changes made using the Open LMS edit profile interface and updates Conduit with those changes.

Available Mappings

Users

The Conduit user record mappings are tied to user records in Open LMS. You map the fields that you might provide for user records from your information source to the Open LMS user profile fields. Once set, the mapped fields correspond to the user record CSV or XML file by determining what the column headings or mapping tag attribute should be. 

There are several options for controlling the behavior for updating user profile information. On a field by field basis you may determine if the field is left alone once created, stays in sync with the data in Conduit, or changes from the profile in Open LMS are passed back to Conduit. There is also support for providing a default value for a given field if no value is set in the record details. 

  • Default: Most of the field mappings have a default field option. When Conduit adds or updates a user and does not have a value for a mapped field, it uses the default value if one has been provided in the mapping.
  • Update Moodle every sync: This updates the user’s profile based on changes made in Conduit. Updates are made anytime the cron is run or a change is made. This is used for fields that need to be updated with changes from the outside source.
  • Update Conduit: This takes changes made using the user’s edit profile interface and updates Conduit with those changes.

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

  • username: (Required or Optional) This is a required field by default and is the username that the user logs in with. Conduit allows you to choose which of the three fields available to make the required field; username, email, or idnumber.
    • Converts numbers to strings.
    • Trims strings of white space.
    • Lower cases string.
    • Validates that the value is a valid username based on the site settings.
  • idnumber: (Required or Optional) The idnumber for the user, such as student ID or any other value your organization uses to track unique users. Can be used as the required field based on Conduit General settings.
    • Converts numbers to strings.
    • Trims strings of white space.
    • Validates that the value is less than 255 characters long.
  • email: (Required or Optional) The user’s email address, used by the platform for all email communications. Can be used as the required field based on Conduit General settings.
    • Converts numbers to strings.
    • Trims strings of white space.
    • Validates that the value is an email address format.
  • externalkey: (Optional) This value is stored in the Conduit tables but does not map to a value in the record in Open LMS. It is designed to 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.
  • auth: (Optional) 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. To delete users via Conduit, their authentication mapping must match their authentication type.
    • 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, cas, conduit, db, efolio, email, fc, gsaml, imap, ldap, lti, manual, mnet, nologin, none, oauth2, oidc, pop3, radius, saml2, webservice.
  • mnethostid: (Optional) 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: (Optional) This field determines if the user account is active (default) or suspended. Suspended accounts have their grades and enrollments kept but the user cannot be logged into. Valid values are 0 for not suspended and 1 for suspended.
    • Trims strings of white space.
    • Validates that the value is an integer.
  • password: (Optional) 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 password, an MD5 hash, or a BCrypt 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 field is checked.
  • firstname: (Optional) User’s first name.
    • Converts numbers to strings.
    • Trims strings of white space.
    • Validates that the value is less than 100 characters long.
  • lastname: (Optional) User’s last name.
    • Converts numbers to strings.
    • Trims strings of white space.
    • Validates that the value is less than 100 characters long.
  • emailstop: (Optional) This is whether the email 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.
  • phone1: (Optional) 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: (Optional) 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: (Optional) 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: (Optional) 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: (Optional) 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: (Optional) 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: (Optional) 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: (Optional) The user’s language for Open LMS to use in displaying the interfaces and optional translated content. This is associated with a language installed on the site, and must be identified by the language code. You can check the Site Administration interface for Languages to see the acceptable language codes to use for any language pack installed.
    • Converts numbers to strings.
    • Trims strings of white space.
    • Validates that the value is less than 30 characters long.
  • theme: (Optional) 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: (Optional) 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: (Optional) The image used for the user.
    • Trims strings of white space.
    • Validates that the value is positive integer (zero or greater).
  • url: (Optional) 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: (Optional) A description of the user – this can include HTML.
    • Converts numbers to strings.
  • descriptionformat: (Optional) 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: (Optional) This is how the user chooses to receive emails.
    • Trims strings of white space.
    • Validates that the value is 0 = Plain Text or 1 = HTML.
  • maildigest: (Optional) This determines if the user receives emails 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 email per forum post); 1 = Complete (daily email with full posts); and 2 = Subjects (daily email with subjects only).
  • maildisplay: (Optional) This is whether the user’s email is displayed or not.
    • Trims strings of white space.
    • Validates that the value is one of the following: 0 = Hide my email address from everyone; 1 = Allow everyone to see my email address; and 2 = Allow only other course members to see my email address.
  • htmleditor: (Optional) 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: (Optional) 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: (Optional) 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: (Optional) 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.
  • lastnamephonetic: (Optional) Provides a space to store and present the phonetic spelling of the user’s last name.
    • Converts numbers to strings.
    • Trims strings of white space.
    • Validates that the value is less than 100 characters long.
  • firstnamephonetic: (Optional) Provides a space to store and present the phonetic spelling of the user’s first name.
    • Converts numbers to strings.
    • Trims strings of white space.
    • Validates that the value is less than 100 characters long.
  • middlename: (Optional) Provides a space to store and present the user’s middle name.
    • Converts numbers to strings.
    • Trims strings of white space.
    • Validates that the value is less than 100 characters long.
  • alternatename: (Optional) Provides a space to store and present the phonetic spelling of an alternate for the user’s name.
    • Converts numbers to strings.
    • Trims strings of white space.
    • Validates that the value is less than 100 characters long.
  • calendartype: (Optional) This is associated with the calendar to be displayed for the user. If multiple calendars are enabled on the site, this sets which calendar format to present to the user. More on calendar types – may be available in English only.
    • Converts numbers to strings.
    • Trims strings of white space.
    • Validates that the value is less than 30 characters long.
  • Any Custom Profile Fields created by the site administrator.

Note: Custom Profile Fields

Conduit allows for the creation and update of custom profile fields. When a custom profile is created in Open LMS, it displays at the bottom of the User record mapping area under the last standard field.

Custom profile fields have all the extra information that a standard profile field has except that you cannot specify a default value. You need to use the custom profile field’s default value in the profile field interface to set the default there.

Courses

The Conduit course record mappings are tied to courses in Open LMS. You map the fields that you might provide for course records from your information source to the Open LMS course settings (or profile) fields. Once set, the mapped fields correspond to the course record CSV or XML file by determining what the column headings or mapping tag attribute should be. 

There are several options for controlling the behavior for updating course settings information. On a field by field basis you may determine if the field is left alone once created, stays in sync with the data in Conduit, or changes to the course settings in Open LMS are passed back to Conduit. There is also support for providing a default value for a given field if no value is set in the record details. 

  • Default: Most of the field mappings have a default field option. When Conduit adds or updates a course and does not have a value for a mapped field, it uses the default value if one has been provided in the mapping.
  • Update Moodle every sync: This updates the course’s settings based on changes made in Conduit. Updates are made anytime the cron is run or a change is made. This is used for fields that need to be updated with changes from the outside source.
  • Update Conduit: This takes changes made using the course’s edit settings interface and updates Conduit with those changes.

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

  • shortname: (Required) This is a required field by default and is the shortname that is used for the course in Open LMS. Conduit allows you to choose which of the two fields available to make the key record field; shortname or idnumber. The shortname for the course must be unique for each course and each course requires a shortname.
    • Converts numbers to strings.
    • Trims strings of white space.
    • Validates that the value is less than 100 characters long.
  • idnumber: (Required or Optional) The idnumber for the course, such as a CRN or any other value your organization uses to track unique courses. Can be used as the required field based on Conduit General settings.
    • Converts numbers to strings.
    • Trims strings of white space.
    • Validates that the value is less than 100 characters long.
  • externalkey: (Optional) This value is stored in the Conduit tables but does not map to a value in the record in Open LMS. It is designed to 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.
  • parent: (Optional) 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: (Optional) 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: (Optional) 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: (Optional) The summary for the course. This can be in HTML.
    • Converts numbers to strings.
  • summaryformat: (Optional) 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: (Optional) 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: social, topics, or weekly.
  • showgrades: (Optional) Controls the show the grades behavior in the course. Whether grades are shown to the learners or not.
    • Trims strings of white space
    • Validates that the value is one of the following: 0, 1.
  • newsitems: (Optional) The number of news items displayed in the latest news.
    • Trims strings of white space.
    • Validates that the value is between 0 and 10.
  • startdate: (Optional) The Unix timestamp for when the course starts.
    • Trims strings of white space.
    • Validates that the value is positive integer (zero or greater).
  • enddate: (Optional) The Unix timestamp for when the course ends. Can be used in conjunction with the Conduit General setting to have Conduit automatically hide the course when the end date has passed.
    • Trims strings of white space.
    • Validates that the value is positive integer (zero or greater).
  • numsections: (Optional) 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: (Optional) 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: (Optional) 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: (Optional) 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: (Optional) 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: (Optional) 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: (Optional) 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: (Optional) 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: (Optional) 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: (Optional) 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: (Optional) 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: boost or snap.
  • requested: (Optional) 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: (Optional) 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.
  • completionnotify: (Optional) Enabled or disable notifications for completion.
    • Trims strings of white space.
    • Validates that the value is one of the following: 0, 1.
  • calendartype: (Optional) This is associated with the calendar to be displayed for the user in this course. If multiple calendars are enabled on the site, this sets which calendar format to present to the user. More on calendar types – may be available in English only.
    • Converts numbers to strings.
    • Trims strings of white space.
    • Validates that the value is less than 30 characters long.
  • coursedisplay: (Optional) This setting determines whether the whole course is displayed on one page or split over several pages. The setting has no effect 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: (Optional) 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.
  • profiledata: (Optional) 
  • Any Custom Profile Fields created by the site administrator.

Note: Custom Profile Fields

Conduit allows for the creation and update of custom profile fields. When a custom profile is created in Open LMS, it displays at the bottom of the Course record mapping area under the last standard field.

Custom profile fields have all the extra information that a standard profile field has except that you cannot specify a default value. You need to use the custom profile field’s default value in the profile field interface to set the default there.

Enrollments

The Conduit enrollment record mappings are tied to courses in Open LMS. You map the fields that you might provide for enrollment records from your information source to the Open LMS enrollment fields. Once set, the mapped fields correspond to the enrollment record CSV or XML file by determining what the column headings or mapping tag attribute should be. 

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

  • externalkey: (Optional) This value is stored in the Conduit tables but does not map to a value in the record in Open LMS. It is designed to 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: (Required) This is mapped to the primary identification of the course in Conduit. This is either the shortname or idnumber for the course; based on the lookup key specified for roles in the Conduit General settings.
    • Converts numbers to strings
    • Trims strings of white space
    • Validates that the value is less than 100 characters long
  • userkey: (Required) This is mapped to the primary identification of the user in Conduit. This is either the username, idnumber or email for the user; based on the lookup key specified for roles in the Conduit General settings.
    • Converts numbers to strings
    • Trims strings of white space
    • Lower cases string
    • Validates that the value is a valid username
  • rolekey: (Optional) The role of the user being enrolled in the course. This field in the export should have a value of the shortname or full name for one of the roles on the site, based on the lookup key specified for roles in the Conduit General settings. Roles come with predefined names but can be changed to suit your needs; please check the Define roles table under Site administration > Users > Permissions > Define roles to see what names are in use or to change the names to match your external system information. 
    • Converts numbers to strings
    • Trims strings of white space
    • Validates that the value is less than 255 characters long
  • Status: (Optional) The status of the enrollment, active (0) or suspended (1). 
    • Trims strings of white space
    • Validates that the value is 0 or 1
  • timestart: A Unix timestamp for the date and time when the user enrollment should start.
    • Trims strings of white space
    • Validates that the value is positive integer (zero or greater)
  • timeend: A Unix timestamp for the date and time when the user enrollment should end.
    • Trims strings of white space
    • Validates that the value is positive integer (zero or greater)

Role Assignments

The Conduit role assignment record mappings are available to support roles that are not tied to course enrollments in Open LMS. You map the fields that you might provide for role records from your information source to the Open LMS role fields. Once set, the mapped fields correspond to the role assignment record CSV or XML file by determining what the column headings or mapping tag attribute should be. 

This is typically not needed or used by most clients, however role assignments can be used for special cases where the user is not in courses but still needs roles. The most common use is for the assignment of a parent or a manager to their learners in the system. 

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

  • externalkey: (Optional) This value is stored in the Conduit tables but does not map to a value in the record in Open LMS. It is designed to 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.
  • Context: (Required) 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: (Required) 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: (Required) This is mapped to the primary identification of the user in Conduit. This is the username, ID number, or email for the user; based on the lookup key specified for roles in the Conduit General settings.
    • Converts numbers to strings.
    • Trims strings of white space.
    • Lower cases string.
    • Validates that the value is a valid Moodle username.
  • rolekey: (Required) The role being assigned to the user. This field in the export should have a value of the shortname or full name for one of the roles on the site, based on the lookup key specified for roles in the Conduit General settings. Roles come with predefined names but can be changed to suit your needs; please check the Define roles table under Site administration > Users > Permissions > Define roles to see what names are in use or to change the names to match your external system information. 
    • Converts numbers to strings.
    • Trims strings of white space.
    • Validates that the value is less than 255 characters long.
  • timestart: A Unix timestamp for the date and time when the user should be added to the given role. 
    • Trims strings of white space.
    • Validates that the value is positive integer (zero or greater).
  • timeend: A Unix timestamp 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).

Groups

The Conduit Groups record mappings are available to create groups in courses in Open LMS. You map the fields that you might provide for groups from your information source to the Open LMS group profile fields. Once set, the mapped fields correspond to the groups record CSV or XML file by determining what the column headings or mapping tag attribute should be.  

In Conduit, you first create the groups in the course and then add members to those groups in a separate action and record file. 

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

  • externalkey: (Optional) This value is stored in the Conduit tables but does not map to a value in the record in Open LMS. It is designed to 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: (Required) This is mapped to the primary identification of the course in Conduit. This is either the shortname or idnumber for the course; based on the lookup key specified for roles in the Conduit General settings.
    • Converts numbers to strings.
    • Trims strings of white space.
    • Validates that the value is less than 255 characters long.
  • groupkey: (Required) This is mapped to the name of the group. Once created this field is treated as locked; not available to be edited. In order to change the Group key and group name shown to the users, you must send the change to the newgroupkey field. 
    • Converts numbers to strings.
    • Trims strings of white space.
    • Validates that the value is less than 255 characters long.
  • newgroupkey: (Optional) This field is used to replace the groupkey with a new value. This will replace the groupkey and the name as the name of the group shown to users.
    • Converts numbers to strings.
    • Trims strings of white space.
    • Validates that the value is less than 255 characters long.
  • idnumber: (Optional) 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: (Optional) This is mapped to the description of the group.
    • Converts numbers to strings.
  • descriptionformat: (Optional) 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: (Optional) 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: (Optional) 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 record mappings are available to add users into groups in courses in Open LMS. You map the fields that you might provide for group member additions from your information source to the Open LMS group members fields. Once set, the mapped fields correspond to the group member records CSV or XML file by determining what the column headings or mapping tag attribute should be.  

In Conduit, you first create the groups in the course and then add members to those groups in a separate action and record file. 

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

  • externalkey: (Optional) This value is stored in the Conduit tables but does not map to a value in the record in Open LMS. It is designed to 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: (Required) This is mapped to the primary identification of the course in Conduit. This is either the shortname or idnumber for the course; based on the lookup key specified for roles in the Conduit General settings.
    • Converts numbers to strings.
    • Trims strings of white space.
    • Validates that the value is less than 255 characters long.
  • userkey: (Required) This is mapped to the primary identification of the user in Conduit. This is the username, ID number, or email for the user; based on the lookup key specified for roles in the Conduit General settings. 
    • Converts numbers to strings.
    • Trims strings of white space.
    • Lower cases string.
    • Validates the value matches the assigned format for user keys.
  • groupkey: (Required) This is the name of the group the user is being added into.
    • Converts numbers to strings.
    • Trims strings of white space.
    • Validates that the value is less than 255 characters long.

Cohort Members

The Conduit Cohort members record mappings are available to add users into cohorts on the site level in Open LMS. You map the fields that you might provide for cohort member additions from your information source to the Open LMS cohort members fields. Once set, the mapped fields correspond to the cohort member records CSV or XML file by determining what the column headings or mapping tag attribute should be. 

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

  • externalkey: (Optional) This value is stored in the Conduit tables but does not map to a value in the record in Open LMS. It is designed to 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.
  • userkey: (Required) This is mapped to the primary identification of the course in Conduit. This is either the shortname or idnumber for the course; based on the lookup key specified for roles in the Conduit General settings. 
    • Converts numbers to strings.
    • Trims strings of white space.
    • Lower cases string.
    • Validates the value matches the assigned format for user keys.
  • cohortkey: (Required) This is the name of the group the user is being assigned to.
    • Converts numbers to strings.
    • Trims strings of white space.
    • Validates that the value is less than 255 characters long.

Copying Mappings

In Conduit, you can copy Mappings from one site to another using a simple export and import process. 

How to Export Conduit Mappings

  1. Navigate to Conduit > Settings > Mappings tab.
  2. Scroll to the bottom of the Mappings page, you will find the Export button.  This will allow you to export and download an XML file that has the mappings.
     
  3. Save the mappings file to your computer.

How to Import Conduit Mappings

  1. On the site you wish to copy your Conduit Mappings to, navigate to Conduit > Settings >Import tab.
  2. Upload the mappings file and click the Import button.

Once imported you will see the Mappings screen. The changes from the import will be presented, but not yet saved.  Review the changes on this page and then click the Save changes button to complete the import.

 

Related to

Was this article helpful?
0 out of 0 found this helpful