Sections and Enrollments for sections can be created, updated, and deleted using CSV Imports.
The fields requested for the update are identical to those requested for create, with the exception of needing the Section ID for making section updates via import. For Enrollment updates, they are the same.
Generating a section or enrollment export should provide most of the data you need for an Update or Delete-action import. You may also need a Term, Course, or User export to obtain the system IDs for any changes you want to make to the sections.
A Delete-action import for a section requires only the system ID for the section. A Delete-action enrollments import requires the user ID/email of the user you are un-enrolling and the Section ID of the section you are removing them from.
IMPORTED FILES MUST HAVE ALL FIELDS/COLUMNS REQUESTED: If the Update-import example contains a field, that field MUST be included in the final import, even if you are not making changes to the values for that field. As cited below, if a value is blank for an optional field, the value is removed for that item. Similarly, if the FIELD itself is missing from the import file for an optional field, that value will be removed from ALL of the items in the update file. If the field is required, it must both exist in the import file and must have a value in it.
Removing or Appending Field Values on update
Since you can copy existing values from an export into an update-action import file, we expect that if you wish to retain the existing values, those will be resident in the import. This means that for updates:
- To REMOVE the value(s) for a field where the value is optional, remove the existing value and leave the field blank.
- If the value is required and the field is blank, the row will be rejected.
- If the value is optional and the field is blank, the value will be removed from the object's properties.
- If the value is optional and the field is missing (the column is not resident) from the import, that value will be removed from ALL of the items in the update.
- To REPLACE the value for a field, remove the existing value and replace it with the new/updated value.
- To APPEND the values in a field where multiple values are allowed, retain the existing values but add the new values into the field (separating with a semi-colon.
Create Section
Download a sample CSV file and enter the values for your new sections into the fields provided. Then import your new file.
You must use the system ID for the Course, Term and any Instructors you are adding to the section on create. To obtain the system ID for these fields, perform an Export for the object type whose IDs you want to use, then copy that information into the appropriate fields of your import file.
Field Name | Description | Example |
---|---|---|
Course (required) | System ID of the course to which this section belongs | 69324a-315-4de-8dg-g75d42 |
Term (required) | System ID of the term during which this section is to occur | 84672-315-4de-8dg-h46e97 |
Section number (required) | Label to identify the Section; must be unique to the course/term combination | BritLit351 |
Description (optional) | Description of the section | Victorian British Literature 1800-1900 |
Instructor (optional) | System ID of the primary instructor for the section (can also use email) | 27472-315-4de-8dg-h46e65 |
Secondary instructor(s) (optional) | Additional instructor to be assigned to the section; must use system ID (from export). Separate multiple values with semi-colons. | 87635-315-7be-9dz-b43f53 |
External Id (optional) | External system identifier of the section | Determined by the external system |
LMS Course Ids (optional) | Identifier(s) for the LMS (Learning Management System) course/section to which this section is to be linked. Separate multiple values with semi-colons. | ENG0351 or 035679;68390 or other identifiers used by the LMS |
Update Section
Generate a Section Export, then select and update the necessary information for the import file. Then import your new file.
IMPORTED FILES MUST HAVE ALL FIELDS/COLUMNS REQUESTED: If the Update-import example contains a field, that field MUST be included in the final import, even if you are not making changes to the values for that field. As cited above, if a value is blank for an optional field, the value is removed for that item. Similarly, if the FIELD itself is missing from the import file for an optional field, that value will be removed from ALL of the items in the update file. If the field is required, it must both exist in the import file and must have a value in it.
Field Name | Description | Example |
---|---|---|
Section ID (required) | System ID of the section being updated | 69324a-315-4de-8dg-g75d42 |
Section number (required) | Label to identify the Section; must be unique to the course/term combination | BritLit352 |
Description (optional) | Description of the section | Victorian British Literature 1800-1900 |
Instructor (optional) | System ID of the primary instructor for the section (can also use email) | 84672-315-4de-8dg-h46e97 |
External Id (optional) | External system identifier of the section | Determined by the external system |
Update LMS Course IDs
The Update LMS Course IDs import allows you to identify the LMS Courses that will link into each EchoVideo section, and to update or remove those links as needed. The LMS Courses field of the import allows a true/false parameter to identify whether the LMS Course will automatically link to the EchoVideo section. Adding the "true" parameter to the field data causes the EchoVideo LTI link in the LMS course to automatically take users into the EchoVideo section without requiring any selection on the part of the Instructor or administrator in the LMS.
If using the LMS Courses field to establish direct default linking behavior, you will need the LMS Configuration ID from the Configurations page for the LMS you are using. The LMS Configuration ID identifies the LMS configuration link being used, and the ID to use is the same as the ID number shown in the LTI Configuration URL used to establish the LTI link between EchoVideo and the LMS.
IMPORTANT NOTES: Default linking from the LMS into an EchoVideo section will only work if there is only ONE EchoVideo section identified for the LMS Course. There can be multiple LMS courses that link into a single section. However, if one LMS Course is linked to multiple EchoVideo sections, the admin or the instructor will need to select the appropriate section in the LMS course. In addition, if there are discrepancies between the LMS Course ID(s) entered in the LMS Course IDs field and those entered in the LMS Courses field, those in the LMS Courses field will take precedence.
Generate a Section Export to get the Section IDs needed, and the LMS Course ID if one is already linked to one or more sections. Then import your new file.
As with other imports, if the Update-import example contains a field, that field MUST be included in the final import, even if you are not making changes to the values for that field. If a value is blank for an optional field, the value is removed for that item. You can use this feature of Update imports to REMOVE the LMS Id and linking values from each EchoVideo section if necessary.
Field Name | Description | Example |
---|---|---|
ID (required) | System ID of the Section being updated | 69324a-315-4de-8dg-g75d42 |
LMS Course IDs | The identifier of the LMS course or section to link to. Separate multiple values with a semi colon (to link multiple LMS courses to the single section). For each LMS this value can be found:
|
LMSID1; LMSID2 or 1874496 |
LMS Courses | Used to enable direct linking from the LMS Course into the EchoVideo section. Must include the LMS Configuration ID (from EchoVideo) as well as the LMS Course ID (from the LMS). Add the parameter "true" to establish direct linking (no intervention) behavior. If multiple LMS courses link into the single EchoVideo section, use semi-colons between entries, and use the "true" or "false" parameter for each to set the desired default behavior of LTI links placed into those LMS courses. |
d0da1041-0392-4f9a-bea4-cda39d80e777=1874496=true |
Delete Section
Generate a Section Export, then select and copy the rows for the sections you want to delete into a new file for the Delete-action import. You can retain additional fields in the file; all except ID are ignored. Then import your new file.
Field Name | Description | Example |
---|---|---|
Section ID (required) | System ID of the section being deleted | 69324a-315-4de-8dg-g75d42 |
Enroll Users (Create Enrollments for a section)
Download a sample CSV file and enter the values for your new sections into the fields provided. Then import your new file.
You can use an email address or system ID for the User field. You must use the system ID to identify the section. All fields in the Create Enrollment import are required.
To obtain the system ID, perform an Export for the object type whose IDs you need, then copy that information into the appropriate fields of your import file.
Field Name | Description | Example |
---|---|---|
User ID (required) | System ID of the user to enroll in the section | 84672-315-4de-8dg-h46e97 |
Section ID (required) | System ID of the section into which the user is being enrolled | 38151b-015-4de-8cc-f98d91 |
Role (required) | The role this user has in the section | Instructor, Teaching Assistant, or Student |
Update User Enrollments (Change user roles in a section)
Download a sample CSV file and enter the values for your new sections into the fields provided. Then import your new file.
You can use an email address or system ID for the User field. You must use the system ID to identify the section. All fields in the Update Enrollments import are required.
To obtain the system ID, perform an Export for the object type whose IDs you need, then copy that information into the appropriate fields of your import file.
Field Name | Description | Example |
---|---|---|
User ID (required) | System ID of the user to enroll in the section | 84672-315-4de-8dg-h46e97 |
Section ID (required) | System ID of the section into which the user is being enrolled | 38151b-015-4de-8cc-f98d91 |
Role (required) | The role this user has in the section | Instructor, Teaching Assistant, or Student |
Unenroll users (Delete Enrollments from a section)
Generate an Enrollment Export, then select and copy (into a new file) the rows for the users you want to un-enroll and the sections from which you want to remove them. You can retain additional fields in the file; all except ID are ignored. Then import your new file.
Field Name | Description | Example |
---|---|---|
User ID (required) | System ID of the user to remove from the identified section | 84672-315-4de-8dg-h46e97 |
Section ID (required) | System ID of the section from which users are being removed | 38151b-015-4de-8cc-f98d91 |