Co-Curricular Registration File Format
Co-Curricular Registration File Considerations and Best Practices
This file provides the registration information for the Co-Curricular Sections.
This file is optional and can be used if you plan on sending administrative divisions, units and co-curricular activities, sections and their enrollments for import. If you would like to send these files during implementation, please discuss with your implementation team. Otherwise, please review the file format for correctness and submit a ticket via our support portal or reach out to your HelioCampus contact to schedule an initial import or to ask questions.
If you included “TermCode” field, the 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 CoCurricularSectionUniqueIds and verify that they exist in the Co-Curricular 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", "CoCurricularSectionUniqueId", "ProcessDate"
Example File Name:
institution_cocurricular_registration.csv
Term Based: If you plan on sending a/multiple term(s) 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_cocurricular_registration_fall2023.csv
|
||||
|
Data Field |
Data Type |
Required | Optional |
Description |
Impact |
|
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 |
|
CoCurricularSectionUniqueId |
String |
Required |
Should match the CoCurricularSectionUniqueId provided in the Co-Curricular 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 |
Information about whether the student has successfully completed the co-curricular 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. |
|
TermCode |
String |
Optional |
Should match the TermCode provided in the Co-Curricular Section File |
Use this field if you are going to send a term based file, needed as part of the unique identifier |
If you would like to submit files for co-curricular sections created via the User Interface, please first submit a ticket to add your custom CoCurricularSectionUniqueIds to those sections in our database.