Skip to main content

Data Integration from SFTP - Direct into Projects

Importing Data Directly into Projects via SFTP

The Course Evaluations & Surveys SFTP data import Direct into Projects feature allows the transfer of secure files containing course information and corresponding student, instructor, and teaching assistant enrollments directly into pre-existing projects.

 

SFTP Folder Setup

  1. If sFTP has not already been set up for your organization, log into the Help Center and contact the Support Team to request an SFTP folder setup. Course Evaluations & Surveys will establish a secure directory to deposit files.

  2. Connect to the folder via Secure File Transfer Protocol (SFTP).

  3. Locate the two primary directories created within the SFTP root directory for Direct into Projects:

  • DirectEnrollmentFilesToProcess: Drop files into this directory to upload course and enrollment data.

  • DirectEnrollmentFilesProcessed: Review this directory to find files that have successfully completed processing.

SFTP File Specifications

  1. Format: Save files in Comma Delimited format with a CSV file extension (.csv).

  2. File Name: Name the file using the format CourseUsers-mmddyyyyhhmm.csv, where MMDDYYYYHHMM serves as the date and time identifier.

  3. Header Row: Include a required header row containing the exact field names listed below.

  4. Content Rows: Ensure each row represents a single enrollment into a course, aligned with the header row fields.

SFTP Fields and Characteristics

Feel free to omit optional fields from the SFTP file if they are not needed. When omitting a field, remove the field name from the Header Row and exclude the data from the Content Rows entirely.

NOTES: 

  • The column header must be an exact match, though it is not case-sensitive (capitalization doesn't matter). For example, the sFTP file will fail if the header is written as 'First Name' instead of 'FirstName'.

  • A downloadable sample file is provided at the end of this article.

Column HeaderRequirements/LimitsDescription
ProjectIDRequiredThe unique project identifier system-assigned to every newly created project. Locate this ID within the specific project on the Project tab UI.
NodePathOptionalThe path value where the course can be assigned to a specific area in the report Hierarchy.
AddDropRequired

Controls enrollment and course status:

1 = Add an enrollment to a course.

0 = Drop an enrollment from a course.

2 = Remove a course from the Project.

Note: A null (empty) value defaults to an Add.

CodeRequired (Max 512 characters)The course code displayed to users.
TitleRequired (Max 1024 characters)The course title.
UniqueIDRequired (Max 32 characters)The unique identifier for the course. This value must remain unique over time and across projects.
CrossListUniqueIDOptionalUsed for cross-listed courses. Insert the parent course's Unique ID to turn this course into a "child" course. Survey responses roll up to the parent course, and child courses are hidden in reporting.
SurveyStartOptionalThe defined start date for survey access. Recommended if using course-level dates.
SurveyEndOptionalThe defined end date for survey access. Recommended if using course-level dates.
AdminStartOptionalThe defined start date for administrator reporting access. Recommended if using course-level dates.
AdminEndOptionalThe defined end date for administrator reporting access.
InstructorStartOptionalThe defined start date for instructor reporting access. Recommended if using course-level dates.
InstructorEndOptionalThe defined end date for instructor reporting access.
TAStartOptionalThe defined start date for teaching assistant reporting access. Recommended if using course-level dates.
TAEndOptionalThe defined end date for teaching assistant reporting access.
UserTypeIdRequired

The code designated for the user type:

3 = Instructor

4 = Student

6 = Teaching Assistant

FirstNameRequired (Max 128 characters)The user’s first name.
LastNameRequired (Max 128 characters)The user’s last name.
EmailRequired (Max 256 characters)The user’s email address.
UsernameRequired (Max 60 characters)The user’s Course Evaluations & Surveys username.

SFTP Fields and Field Characteristics

  1. File Header row includes the following fields:

    1. ProjectID, AddDrop, Code, Title, UniqueId, UserTypeId, Firstname, Lastname, Email, Username.
  2. Each additional row in file indicates either a student, instructor or teaching assistant enrollment into a course following the fields indicated in the Header.

SFTP File with Optional Fields

  1. File Header row includes the following fields:

    1. ProjectID, AddDrop, Code, Title, UniqueId, SurveyStart, SurveyEnd, AdminStart, AdminEnd, InstructorStart, InstructorEnd, TAStart, TAEnd, UserTypeId, Firstname, Lastname, Email, Username, Password.
  2. Each additional row in file indicates either a student, instructor or teaching assistant enrollment into a course following the fields indicated in the Header.

File Processing

  1. Once a file is deposited in the SFTP folder, the system/service will detect a new file has been added and immediately process the file. The enrollments contained in the file will accordingly get added or dropped from the specified course within the specified project.
  2. Dropping enrollments is no different than the process described above with the exception that the AddDrop code in the row would be set to “0” to drop the enrollment.
  3. For sake of clarity, the SFTP file may contain enrollments from multiple projects all needing to be added/dropped.
  4. The SFTP files should only contain an enrollment needing to be added or dropped. Enrollments contained in the file to be added, which are already in the specified project for the specified course will be ignored if no changes are detected in any of the row contents for that enrollment.

File Confirmation Email and Error Messaging/Handling

  1. Once a file is deposited into the SFTP folder and processed, a confirmation email will be sent to the email address you have listed under Account > SFTP

    The FTP Data Integration page showing fields to enter an FTP confirmation recipient name and email, along with a save button.

  2. Confirmation Email Subject Line

    1. Includes – Filename
    2. Includes – File Status (Successful, Some Failures, Failed)
  3. Confirmation Email Contents of Email

    1. Includes – Filename
    2. Includes – File Status (Successful, Some Failures, Failed)
    3. Summary Metrics Organized by Project ID from the file

      1. Courses Added
      2. Student Enrollments Added and Dropped
      3. Instructor or Teaching Assistant Enrollments Added and Dropped
      4. Failed Enrollments
      5. Specific Rows in File That Failed
  4. Additional Error Handling

    1. In the event a file is deposited in the SFTP folder and the Course Evaluations & Surveys service to process the file is halted for any reason (e.g., System Maintenance, etc.), SFTP files will accumulate in the SFTP Folder until the service resumes processing, at which time the service will process any/all files in the folder beginning with the oldest file.
    2. Any files added to the SFTP Folder not conforming to the required format will generate a Confirmation Email indicating a Failure to process the file.

FILE REQUIREMENTS AND SAMPLE

  1. Required file format is Comma Delimited, with CSV file extension (.csv)
  2. Name file CourseUsers-mmddyyyyhhmm.csv
  3. File contains a header row and each additional row represents an enrollment into a course.

ATTACHMENTS

 

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

Articles in this section

How to Contact Support
There are many ways to reach out! Click the icon above for our support options.
Watermark Academy
Click the icon above to access the Watermark Academy for consultation, training, and implementation companion courses.
Customer Community
Can’t find the answer? Ask fellow users how they’re making the most of Watermark in our Community!