Registration File Format
Registration File Considerations and Best Practices
This file is required if you are using any of the following modules: Syllabus, Surveys, Assessments (Optional)
This file provides the registration information for the Course Sections within one term.
The Registration file is a term based file so it should only contain one term code and partial terms that belong to the one parent term. If there is more than one term in the file, the client should create a file for each parent term.
Before submitting the file to HelioCampus, please confirm the following:
-
Make sure that all required fields are included in the files.
-
Make sure that the data in the field matches up with the header it belongs to. For example, email addresses are in the email address field.
-
Choose a small set of CourseSectionUniqueIDs and verify that they exist in the Course Section file
-
Choose a small set of STUDENTUnivIds and verify that they exist in the Student file
File Format:
Please note when creating the Data File in a text editor each column must be surrounded by double quotes and separated by a comma.
Example: "TermCode","STUDENTUnivId","CourseSectionUniqueId","ProcessDate"
Example File Name:
institution_registration.csv
File Splitting: If you plan on sending multiple terms at the same time during your daily uploads, we request that you send us multiple versions of this file, each version containing one term only. We suggest prepending or appending the TermCode to the file name.
Example: institution_registration_Fall18.csv
|
||||
|
Data Field |
Data Type |
Required | Optional |
Description |
Impact |
|
TermCode |
String |
Required |
Should match the TermCode provided in the Course Section File |
Needed as part of the unique identifier |
|
STUDENTUnivId |
String |
Required |
Should match Student University ID provided in the Student Information File |
Needed as part of the unique identifier / used to link student to section |
|
CourseSectionUniqueId |
String |
Required |
Should match the CourseSectionUniqueId provided in the Course Section File |
Used as unique identifier |
|
ProcessDate |
datetime |
Required |
Date in which the data was extracted (exported) expected format: YYYY-MM-DD i.e. 2020-01-13 |
Needed to validate that consecutive data loads should update existing records |
|
||||
|---|---|---|---|---|
|
Data Field |
Data Type |
Required | Optional |
Description |
Impact |
|
SectionCompleted |
boolean |
Optional |
Expected Values:“true” or “false”. Information about whether student has successfully completed the course section. |
This field will be used in the Learning Journey to surface whether or not a student successfully completed a course or CoCurr experience mapped to a learning outcome. Determination of “success” is dependent on the institution. |