EchoVideo provides for the retrieval (export) of object lists, including their IDs. This allows users to copy the data from those lists and use it to make bulk changes to the system via CSV Import. This provides a full round-trip system for retrieving, updating, and deleting system objects.

Some create-action imports create objects that belong to an existing object (such as creating sections for a term or course). In this case, we require unique IDs for these existing objects. These unique IDs ensure accuracy and proper validation for the associated objects. They can be either the EchoVideo internal system IDs, or they can be External IDs established for the object (typically by an external SIS or other system). You can obtain the needed IDs by generating one or more Exports, then copying and pasting them into the worksheet you will import.

If you are using Version 2 imports / exports (currently only available for Schedules), you can run a Version 2 export, remove the rows that are not changing, edit the values that are changing, and then import the updated file. Version 2 exports are formatted to match Version 2 imports, with the same fields in the same order.

Support for Designated Administration: If designated administration is enabled for the institution, institution-level admins can view all imports and exports performed in the system through the Imports/Exports tab. Organization and Department-level admins can only see the imports / exports they initiated.
If designated administration is not enabled for the institution, all admins can see all imports / exports run through this tab.

Generating a Sample Import File

Each import type / action provides a link for downloading a sample import file. Additionally, the dialog box where the link appears lists the fields (columns) accepted for import and whether a value is required for each.

If you use the sample file to generate your import file, delete the sample data but retain the header row.

To generate a sample import file

Log in as an Administrator and click IMPORTS / EXPORTS, located to the right of Users.
On the Imports tab (which appears by default - click Imports if coming from the Exports tab) click Import CSV as shown in the figure below.
In the dialog box that appears, use the drop-down lists on the left side, identified in the below figure, to select an object Type and the Action you want to perform.
If you are performing a Version 2 Schedule Import, select Version 2 from the Version drop-down. All other imports default to Version 1.
On the right side of the Import dialog box, above the list of fields needed in the import, click Download a sample CSV file. This is also shown in the figure below.

A sample file is downloaded to your Downloads directory or the location specified in your browser settings.
Remove the sample data from the sample file download, but leave the headings in place. You can now enter or copy (from an export) data into the fields as needed.

Performing an Import

The import process is the same, regardless of the type of object being imported or the action being taken. The only difference (by type and action) is the data required in the imported file.

If designated administration is enabled for your institution, your import can only include objects you have been granted access to. If you do not have permission to create / update / delete an object in your import file, the row will be rejected.

Large imports can take some time to process. For this reason, your imported CSV file should contain only the rows being created or that require updates. Every row in the file must be parsed and validated, even if it makes no changes; having unnecessary rows in the imported file will needlessly increase processing time.

To perform bulk actions by import

Log in as an Administrator and click IMPORTS / EXPORTS, located to the right of Users.
On the Imports tab (which appears by default - click Imports if coming from the Exports tab), click Import CSV.
In the dialog box that appears, use the drop-down lists to select an object Type and the Action you want to perform.
Click Upload CSV.
In the FileStack window that appears, navigate to and select the CSV file you want to import.
Once the upload is complete, the file appears in the list of imported files, along with its status. Use the refresh button to update the table if necessary.

Viewing Import Status and Errors

Once your import has been processed, you can view it and its status in the Import tab on the Imports / Exports page.

List of Imports with Status identified as described

Click on any row to see a pop-up window with details, including any rows that may have thrown errors on import. Each error message is shown with the row number it applies to (including the header row), so your row number may be offset by one.

The pop-up also lets you download the imported file if you need to review it and don't have the original (e.g., you weren't the admin who imported it).
Error list for import with row numbers and error messages and download file link as described

Note: The error list currently shows up to 100 errors. We are working on a method to provide a full list of errors over 100, and once that is available, this note will be removed.

Creating Objects via CSV Import

Objects can be created by downloading the sample file and entering the field data. Depending on the object type you are creating, you may want or need to generate an export to copy information into your new import file.

The following object types can be created via import. Each is linked to the topic that provides details on the requested fields for the import:

Note: If designated administration is enabled for your institution, your import can only include objects you have been granted access to. If you do not have permission to create / update / delete an object in your import file, the row will be rejected.

Updating Objects via CSV Import

CSV Updates can be performed by exporting the same object type, selecting the rows that require updates, copying them to a new file, and entering the field changes. Then import your new file. Also, if you have External IDs established for objects in the system, you can use them instead of any system IDs requested by the import 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 noted below, if an optional field is blank, the value is removed for that item. Similarly, if the optional field is missing from the import file, its value will be removed from all items in the update file. If the field is required, it must both exist in the import file and have a value.

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 from the import (the column is not present), that value will be removed from all items in the update.
To replace a field's value, 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.

The following object types can be updated via import. Each is linked to the topic that provides details on the requested fields for the import:

Deleting Objects via CSV Import

Delete-action imports do not require any fields other than ID because the values in the other fields are irrelevant when the item is being deleted. The only validation we have is that the ID provided matches the object type you selected to delete.

The exception is the Enrollments deletion import, which requires the User ID and the Section ID (from which you are removing the user).

If you have External IDs established for objects in the system, you can use them instead of the system IDs requested for the import file fields.
import dialog box for deleting sections showing requested field as described

You may want to retain one or more other fields in the Delete-action CSV file to perform your own validation that the listed items are the ones you want to delete, or to confirm that those items have been deleted once the import is finished.

You can simply use a CSV export, limit the rows to those you need to delete, and then reimport the file to apply those changes. The Export file contains fields not needed by the delete-action import, but in this case, the import ignores them.

The following object types can be deleted via import. Each is linked to the topic that provides details on the requested fields for the import:

Organization
Department
Section
Schedules V1
Schedules V2
Section Enrollments (removing users from a section OR removing sections from a user)
Rooms