TracCloudTechImport: Difference between revisions

From Redrock Wiki

No edit summary
No edit summary
 
(21 intermediate revisions by the same user not shown)
Line 1: Line 1:
<div style="float: left; margin-top: 0em; margin-right: 1em; margin-bottom: 1em">{{TracCloudTechTOC}}</div>  
{{TracCloudGuideTabs}}
<b><span style="color:blue"><big>Importing Student Data into TracCloud</big></span></b>
<div class="tcWidgetPage">
<div class="category">
{{TracCloudTechTOC}}
</div>
<b><big>Importing Student Data into TracCloud</big></b>


TracCloud can import data from any source as long as it's provided in the correct format. Using your current Student Information System (Banner, PeopleSoft, DataTel, etc) as a source, create files that match the specifications below. We will require at least two files- A student file and an enrollment/registration file.
TracCloud can import data from any source as long as it's provided in the correct format. Using your current Student Information System (Banner, PeopleSoft, DataTel, etc) as a source, create files that match the specifications below. We will require at least two files- A student file and an enrollment/registration file. It's generally recommended to send data for the current term and one prior term in your registrations file, in case past registrations need to be kept active through the semester changeover.




<span style="color:red>
<span style="color:red>
Import files must be in a flat-text format (.csv or .txt), comma or tab delimited. Comma delimited files must have quotes surrounding <b>every</b> field, including numeric fields. A header row is required, and custom fields must be coordinated with Redrock Software to ensure assignment to the correct data field. UTF-8 is preferred. File names must be static, with each import upload overwriting the previous copies of the files.
Import files must be in a flat-text format (.csv or .txt), comma or tab delimited, UTF-8.
Comma delimited files must have quotes surrounding <b>every</b> field.  
A header row is required, and custom fields must be coordinated with Redrock Software to ensure assignment to the correct data field.  
File names must be static, with each import upload overwriting the previous copies of the files.
If you anticipate section's linked faculty changing, let us know, as this may require additional changes to your import process.
Lab courses should be designated in the course information rather than the section. For example, "BIO100L".
</span>
</span>


Line 19: Line 28:
Click the buttons below to view or download example files. The Section Schedule file is optional.
Click the buttons below to view or download example files. The Section Schedule file is optional.


[[File:7360533.png|150px|link=https://wiki.go-redrock.com/images/2/21/Students.txt|View Student File]]
<div class="guideTabs" style="min-width:170px">
[[File:1502208.png|150px|link=https://wiki.go-redrock.com/images/a/ac/Courses.txt|View Course File]]
[[Media:Students.txt|View Student File]]
[[File:2498178.png|150px|link=https://wiki.go-redrock.com/images/a/ae/Schedule.txt|View Section Schedule File]]
</div>
<div class="guideTabs" style="min-width:170px">
[[Media:Courses.txt|View Course File]]
</div>
<div class="guideTabs" style="min-width:170px">
[[Media:Schedule.txt|Section Schedule File]]
</div>
 
<HR>
 
All import files will be uploaded to our SFTP server. The IP addresses for our SFTP server are listed below if you need to whitelist them.
{| class="wikitable"
| Primary || 3.135.4.128
|-
| Failover || 44.228.245.56
|}


|-
|-
Line 28: Line 52:
|-
|-
| style="vertical-align:top; font-size:100%; " |
| style="vertical-align:top; font-size:100%; " |
{| cellpadding="5" cellspacing="0" border="1"
{| class="wikitable" border="1" style="margin:auto"
!Type!!Description
!Type!!Description
|-
|-
Line 47: Line 71:
|-
|-
| style="vertical-align:top; font-size:100%; " |
| style="vertical-align:top; font-size:100%; " |
{| cellpadding="5" cellspacing="0" border="1"
{| class="wikitable" border="1" style="margin:auto"
!Name!!Type!!Required!!Field Description!!Example
!Name!!Type!!Required!!Field Description!!Example
|-
|-
Line 68: Line 92:
|Middle||A80|| ||The middle name or initial of the student.||L.
|Middle||A80|| ||The middle name or initial of the student.||L.
|-
|-
|Street||A80|| ||The street address of the student.||1234 E. Nowhere St.
|Street||A250|| ||The street address of the student.||1234 E. Nowhere St.
|-
|-
|Apt||A80|| ||Apartment Number.||#46
|Apt||A80|| ||Apartment Number.||#46
|-
|-
|City||A80|| ||City of the student address.||Tempe
|City||A120|| ||City of the student address.||Tempe
|-
|-
|State||A80|| ||The state of the student address. Two-letter formatting displays best.||AZ
|State||A80|| ||The state of the student address. Two-letter formatting displays best.||AZ
|-
|-
|Zip||A10|| ||The zip code of the student address.||88881
|Zip||A20|| ||The zip code of the student address.||88881
|-
|-
|Country||A10|| ||The country of the student address.||USA
|Country||A80|| ||The country of the student address.||USA
|-
|-
|Home_Phone||A20|| ||The student's home phone number.||555-555-5551
|Home_Phone||A80|| ||The student's home phone number.||555-555-5551
|-
|-
|Work_Phone||A20|| ||The student's work phone number.||555-555-5552
|Work_Phone||A80|| ||The student's work phone number.||555-555-5552
|-
|-
|Cell_Phone||A20|| ||The student's cell phone number.||555-555-5553
|Cell_Phone||A80|| ||The student's cell phone number.||555-555-5553
|-
|-
|Email||A80|| * ||The student's email address. Required if students are going to be receiving emails from TracCloud.||dsmith@school.edu
|Email||A120|| * ||The student's email address. Required if students are going to be receiving emails from TracCloud.||dsmith@school.edu
|-
|-
|Preferred||A20|| ||The student's preferred phone number, 'Home', 'Work', or 'Phone'.||Home
|Preferred||A80|| ||The student's preferred phone number, 1 = 'Home', 2 = 'Work', 3 = 'Cell', 4 = 'Email', 5 = 'Phone'||3
|-
|-
|Username||A80|| * ||The student's username or handle, required if students are going to be logging into TracCloud.||dsmith
|Username||A120|| * ||The student's username or handle, required if students are going to be logging into TracCloud.||dsmith
|-
|-
|Birthdate||Date|| ||The student's birthdate.||1970-01-01
|Birthdate||Date|| ||The student's birthdate.||1970-01-01
Line 96: Line 120:
|Gender||A80|| ||The student's gender.||Male
|Gender||A80|| ||The student's gender.||Male
|-
|-
|Ethnicity||A80|| ||The student's ethnicity.||Caucasian
|Ethnicity||A150|| ||The student's ethnicity.||Caucasian
|-
|-
|Major||A120|| ||The student's major.||Accounting
|Major||A120|| ||The student's major.||Accounting
Line 137: Line 161:
|-
|-
| style="vertical-align:top; font-size:100%; " |
| style="vertical-align:top; font-size:100%; " |
{| cellpadding="5" cellspacing="0" border="1"
{| class="wikitable" border="1" style="margin:auto"
!Name!!Type!!Required!!Description!!Example
!Name!!Type!!Required!!Description!!Example
|-
|-
Line 144: Line 168:
|Course.Course||A20||Yes||The course number.||100
|Course.Course||A20||Yes||The course number.||100
|-
|-
|Course.Title||A120||Yes||The name of the course in which the student is enrolled.||Intro to Accounting
|Course.Title||A120||Yes||The name of the course in which the student is enrolled. The course title is only tied to the subject, such as "ACTG100".||Intro to Accounting
|-
|Section.Title||A120||Yes||The name of the section in which the student is enrolled. This overrides the course title if provided, allowing different sections to have unique titles.||Intro to Accounting
|-
|-
|Section.Code||A80||Yes||The section code.||03
|Section.Code||A80||Yes||The section code.||03
|-
|-
|Section.CRN||A20|| ||The unique course reference number (cannot be reused).||123456789
|Section.CRN||A80|| ||The unique course reference number (cannot be reused).||123456789
|-
|-
|Section.Custom1-X||A80|| ||Optional custom fields relating to this section. Multiple custom fields can be used.||?
|Section.Custom1-X||A80|| ||Optional custom fields relating to this section. Multiple custom fields can be used.||?
Line 168: Line 194:
|Faculty.Salutation||A40|| ||Faculty's salutation.||Dr.
|Faculty.Salutation||A40|| ||Faculty's salutation.||Dr.
|-
|-
|Faculty.Department||A80|| ||Faculty Assigned Department.||M262
|Faculty.Department||A60|| ||Faculty Assigned Department.||M262
|-
|-
|Faculty.Phone||A80|| ||Faculty's phone number.||555-555-5555
|Faculty.Phone||A80|| ||Faculty's phone number.||555-555-5555
|-
|-
|Faculty.Email||A80||Yes||Faculty's email address. Only required if faculty members need to receive emails, or as a primary unique identifier.||jdoe80@school.edu
|Faculty.Email||A120||Yes||Faculty's email address. Only required if faculty members need to receive emails, or as a primary unique identifier.||jdoe80@school.edu
|-
|-
|Faculty.Custom1-X||A80|| ||Faculty custom fields. Multiple custom fields can be used.||?
|Faculty.Custom1-X||A80|| ||Faculty custom fields. Multiple custom fields can be used.||?
Line 178: Line 204:
|Student.ID||A40||Yes||The ID/OtherID/OtherID2 of the student this registration is assigned to.||A123456789
|Student.ID||A40||Yes||The ID/OtherID/OtherID2 of the student this registration is assigned to.||A123456789
|-
|-
|Registration.Grade||A4||||The final grade/withdraw code for this registration. Redrock will require a list of possible grades/codes to properly set this up.||B+
|Registration.Grade||A40||||The final grade/withdraw code for this registration. Redrock will require a list of possible grades/codes to properly set this up.||B+
|-
|Registration.RegStatus||A40||||An optional registration status that can be used to deactivate certain enrollments.||Dropped
|-
|Registration.ValidFromDT||Date||*||The start date of the registration. Not strictly required, but highly recommended.||2023-08-15
|-
|-
|Registration.RegStatus||A30||||An optional registration status that can be used to deactivate certain enrollments.||Dropped
|Registration.ValidToDT||Date||*||The end date of the registration. Not strictly required, but highly recommended.||2023-12-15
|-
|-
|Registration.Custom1-X||A80|| ||Registration custom fields. Multiple custom fields can be used. A common example would be midterm grades.||?
|Registration.Custom1-X||A80|| ||Registration custom fields. Multiple custom fields can be used. A common example would be midterm grades.||?
Line 190: Line 220:
| style="vertical-align:top; font-size:100%; " |
| style="vertical-align:top; font-size:100%; " |


{| cellpadding="5" cellspacing="0" border="1"
{| class="wikitable" border="1" style="margin:auto"
!Name!!Type!!Required!!Description!!Example
!Name!!Type!!Required!!Description!!Example
|-
|-
Line 201: Line 231:
| colspan="5" | Alternatively, a section CRN number can be used instead of the basic course information:
| colspan="5" | Alternatively, a section CRN number can be used instead of the basic course information:
|-
|-
|Section.CRN||A20||Yes||The course reference number.||123456789
|Section.CRN||A80||Yes||The course reference number.||123456789
|-
|-
| colspan="5" | Plus, the schedule data:
| colspan="5" | Plus, the schedule data:
Line 212: Line 242:
|}
|}


<!-- here is the end of the content table -->
[[Category:TracCloud]]
|}
</div>

Latest revision as of 10:50, 16 April 2024

Importing Student Data into TracCloud

TracCloud can import data from any source as long as it's provided in the correct format. Using your current Student Information System (Banner, PeopleSoft, DataTel, etc) as a source, create files that match the specifications below. We will require at least two files- A student file and an enrollment/registration file. It's generally recommended to send data for the current term and one prior term in your registrations file, in case past registrations need to be kept active through the semester changeover.


Import files must be in a flat-text format (.csv or .txt), comma or tab delimited, UTF-8. Comma delimited files must have quotes surrounding every field. A header row is required, and custom fields must be coordinated with Redrock Software to ensure assignment to the correct data field. File names must be static, with each import upload overwriting the previous copies of the files. If you anticipate section's linked faculty changing, let us know, as this may require additional changes to your import process. Lab courses should be designated in the course information rather than the section. For example, "BIO100L".


There are no restrictions on column order, and optional columns can safely be excluded from your file if preferred.


Click the buttons below to view or download example files. The Section Schedule file is optional.


All import files will be uploaded to our SFTP server. The IP addresses for our SFTP server are listed below if you need to whitelist them.

Primary 3.135.4.128
Failover 44.228.245.56

Description of Import fields
Type Description
A## Alphanumeric field with a specified maximum length
#B Big Integer, maximum value of about 9 quintillion, or a 16-digit numeric value
Date Date, formatted as YYYY-MM-DD
Double Decimal # with up to 12 digits precision
Time A specific time using a 24-hour format (HH:MM:SS), e.g., 13:45:00
Duration A duration stored in number of minutes, e.g., 90

Available Student Import Fields
Name Type Required Field Description Example
ID #B Yes* The unique numeric ID of the student, required if Other_ID isn't being used. 19310045
Other_ID A40 Yes* A secondary ID or handle for the student, required if ID isn't being used. A19310045
Other_ID2 A40 An optional tertiary ID or handle for the student. dsmith1990
Barcode A80 A barcode ID for the student, required if scanners are used to log students in. A2609376378
OtherStatus A80 An optional secondary status. Primary status is set automatically. Registered
Legal_First A80 The legal first name of the student. David
First_Name A80 Yes The preferred first name of the student. Dave
Last_Name A80 Yes The last name of the student. Smith
Middle A80 The middle name or initial of the student. L.
Street A250 The street address of the student. 1234 E. Nowhere St.
Apt A80 Apartment Number. #46
City A120 City of the student address. Tempe
State A80 The state of the student address. Two-letter formatting displays best. AZ
Zip A20 The zip code of the student address. 88881
Country A80 The country of the student address. USA
Home_Phone A80 The student's home phone number. 555-555-5551
Work_Phone A80 The student's work phone number. 555-555-5552
Cell_Phone A80 The student's cell phone number. 555-555-5553
Email A120 * The student's email address. Required if students are going to be receiving emails from TracCloud. dsmith@school.edu
Preferred A80 The student's preferred phone number, 1 = 'Home', 2 = 'Work', 3 = 'Cell', 4 = 'Email', 5 = 'Phone' 3
Username A120 * The student's username or handle, required if students are going to be logging into TracCloud. dsmith
Birthdate Date The student's birthdate. 1970-01-01
Gender A80 The student's gender. Male
Ethnicity A150 The student's ethnicity. Caucasian
Major A120 The student's major. Accounting
Class A80 The student's class. SO
DegreeGoal A80 The student's degree goal. AAS
Cohort A80 The student's cohort. 2017SP
College A80 The student's college. Nowhere State University
Grad_Und A80 The student's graduate status. Und
DateStarted Date The student's start or enrollment date. 2015-12-01
DateWithdrawn Date The student's withdrawn date. 2015-12-02
ReasonWithdrawn A128 The student's withdrawn reason. Reasons
GradDate Date The student's graduation date. 2020-10-05
GradDegree A128 The student's graduate degree. AAS
GPA Double The student's GPA. 3.2
AccumHours Double The student's total accumulated hours. 46
Fund A80 The student's fund. Federal Work Study
Pronouns A80 The student's preferred pronouns. He/Him/His
CustomData1-X A80 Custom fields, available for any purpose. Multiple custom fields can be used. ?

Available Registration Import Fields
Name Type Required Description Example
Course.Subject A40 Yes The subject in which the student is enrolled. ACTG
Course.Course A20 Yes The course number. 100
Course.Title A120 Yes The name of the course in which the student is enrolled. The course title is only tied to the subject, such as "ACTG100". Intro to Accounting
Section.Title A120 Yes The name of the section in which the student is enrolled. This overrides the course title if provided, allowing different sections to have unique titles. Intro to Accounting
Section.Code A80 Yes The section code. 03
Section.CRN A80 The unique course reference number (cannot be reused). 123456789
Section.Custom1-X A80 Optional custom fields relating to this section. Multiple custom fields can be used. ?
Term.Code A80 Yes Term number for this enrollment. 2022SP
Term.ActiveFrom Date Active start date. 2022-10-01
Term.ActiveTo Date Active end date. 2022-12-31
Faculty.OtherID A80 Yes* Faculty ID. Only the primary faculty will be imported. Required if this is the only unique faculty identifier. J25059
Faculty.FirstName A80 Yes Faculty First Name. Jane
Faculty.LastName A80 Yes Faculty Last Name. Doe
Faculty.UserName A80 Yes* Faculty Username, only required if faculty members will be logging into TracCloud, or as primary unique identifier. JDoe
Faculty.Salutation A40 Faculty's salutation. Dr.
Faculty.Department A60 Faculty Assigned Department. M262
Faculty.Phone A80 Faculty's phone number. 555-555-5555
Faculty.Email A120 Yes Faculty's email address. Only required if faculty members need to receive emails, or as a primary unique identifier. jdoe80@school.edu
Faculty.Custom1-X A80 Faculty custom fields. Multiple custom fields can be used. ?
Student.ID A40 Yes The ID/OtherID/OtherID2 of the student this registration is assigned to. A123456789
Registration.Grade A40 The final grade/withdraw code for this registration. Redrock will require a list of possible grades/codes to properly set this up. B+
Registration.RegStatus A40 An optional registration status that can be used to deactivate certain enrollments. Dropped
Registration.ValidFromDT Date * The start date of the registration. Not strictly required, but highly recommended. 2023-08-15
Registration.ValidToDT Date * The end date of the registration. Not strictly required, but highly recommended. 2023-12-15
Registration.Custom1-X A80 Registration custom fields. Multiple custom fields can be used. A common example would be midterm grades. ?

Section Schedule Import Fields (Optional)
Name Type Required Description Example
Course.Subject A40 Yes The subject. MAT
Course.Course A20 Yes The course number. 100
Section.Code A80 Yes The section number. 45
Alternatively, a section CRN number can be used instead of the basic course information:
Section.CRN A80 Yes The course reference number. 123456789
Plus, the schedule data:
Schedule.Days A30 Yes Days of the week, formatted as MONTUEWEDTHUFRISATSUN. MONFRI
Schedule.Time Time Yes Schedule start time, military/24-hour format. 13:00:00
Schedule.Duration Duration Yes The duration of this section schedule in minutes. 50