TracCloudST and TracCloudTechImport: Difference between pages

From Redrock Wiki

(Difference between pages)
No edit summary
 
No edit summary
 
Line 1: Line 1:
{| style="width:100%; vertical-align:top; "
<div style="float: left; margin-top: 0em; margin-right: 1em; margin-bottom: 1em">{{TracCloudTechTOC}}</div>
| style="width:250px; vertical-align:top; padding:2px 15px 2px 2px;" | {{TracCloudModulesTOC}}
<b><span style="color:blue"><big>Importing Student Data into TracCloud</big></span></b>
| style="vertical-align:top; padding:20px 20px 20px 2px;" |
{| style="width:100%; vertical-align:top; "
<div style='text-align: center;'>
<big><b>
==SurveyTrac==
</big></b></div><br>


The SurveyTrac module allows you to send surveys to students and staff, to collect information about their visits, appointments, or otherwise. These surveys can contain an unlimited number of questions, be initiated by over a dozen different scenarios, and be reported on after the fact or be set to immediately email the results of each response to a specified address. There are practically endless combinations of survey types and questions available to create.<br>
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.


[[File:9429636.png|850px]]<br><br>


<b><big>Creating a new Survey</big></b><br>
<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.
</span>


To create a new survey, head over to your SurveyTrac menu (within the “Other” menu in your Navigation Bar), click the hamburger icon, then select “New Survey.” This will bring you to a survey entry form where you can start configuring basic options relating to your survey. Additional options will become available after saving.


[[File:5047740.png|600px]]<br><br><hr>
There are no restrictions on column order, and optional columns can safely be excluded from your file if preferred.


<div style='text-align: center;'><big>General</big></div>
{| style="width:100%; vertical-align:top; "


[[File:9779618.png|900px]]<br><br>
|-
| style="vertical-align:top; " | <HR>


* <b>Created By</b>
Click the buttons below to view or download example files. The Section Schedule file is optional.
::The staff member who created this survey.<br>


* <b>Profile</b>
[[File:7360533.png|150px|link=https://wiki.go-redrock.com/images/2/21/Students.txt|View Student File]]
::The profile that this survey is assigned to.<br>
[[File:1502208.png|150px|link=https://wiki.go-redrock.com/images/a/ac/Courses.txt|View Course File]]
[[File:2498178.png|150px|link=https://wiki.go-redrock.com/images/a/ae/Schedule.txt|View Section Schedule File]]


* <b>Active</b>
|-
::Enables or disables this survey.<br>
| style="vertical-align:top; font-size:120%; color:#0C3773; " |
<HR>'''Description of Import fields'''
|-
| style="vertical-align:top; font-size:100%; " |
{| cellpadding="5" cellspacing="0" border="1"
!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, <span style="color:red>formatted as YYYY-MM-DD</span>
|-
|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
|}
|-
| style="vertical-align:top; font-size:140%; color:#0C3773; " | <HR>'''Available Student Import Fields'''
|-
| style="vertical-align:top; font-size:100%; " |
{| cellpadding="5" cellspacing="0" border="1"
!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||A80|| ||The street address of the student.||1234 E. Nowhere St.
|-
|Apt||A80|| ||Apartment Number.||#46
|-
|City||A80|| ||City of the student address.||Tempe
|-
|State||A80|| ||The state of the student address. Two-letter formatting displays best.||AZ
|-
|Zip||A10|| ||The zip code of the student address.||88881
|-
|Country||A10|| ||The country of the student address.||USA
|-
|Home_Phone||A20|| ||The student's home phone number.||555-555-5551
|-
|Work_Phone||A20|| ||The student's work phone number.||555-555-5552
|-
|Cell_Phone||A20|| ||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
|-
|Preferred||A20|| ||The student's preferred phone number, 'Home', 'Work', or 'Phone'.||Home
|-
|Username||A80|| * ||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||A80|| ||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.||?
|-
|}


* <b>Survey Name</b>
|-
::The name of the survey. This will also appear within emails sent to students and staff.<br>
| style="vertical-align:top; font-size:140%; color:#0C3773; " | <HR>'''Available Registration Import Fields'''


* <b>Survey Period From</b> & <b>To</b><br>
::The active period of the survey. Used for “Initiated Via” options that specify "during survey period," such as “Email after 1st visit during survey period.”<br>
* <b>Initiated Via</b><br>
::This setting determines the send criteria for this survey, see table below.
{| class="wikitable"
|-
|-
! Initiated Via !! Description
| style="vertical-align:top; font-size:100%; " |
{| cellpadding="5" cellspacing="0" border="1"
!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.||Intro to Accounting
|-
|Section.Code||A80||Yes||The section code.||03
|-
|Section.CRN||A20|| ||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
|-
|-
| Display during visit entry || displays within the “Surveys” tab of a visit record, allowing you to fill out and submit the survey from the visit record itself
|Term.ActiveTo||Date|| ||Active end date.||2022-12-31
|-
|-
| Email after visit || will be sent to the student/staff after a visit takes place (immediately after the student is logged out)
|Faculty.OtherID||A80||Yes*||Faculty ID. Only the primary faculty will be imported. Required if this is the only unique faculty identifier.||J25059
|-
|-
| Email after 1st visit during survey period || will be sent to the student/staff after a visit takes place, but only after the student’s first visit during the survey period specified
|Faculty.FirstName||A80||Yes||Faculty First Name.||Jane
|-
|-
| Email after new student record || is emailed to the student immediately after their account is created
|Faculty.LastName||A80||Yes||Faculty Last Name.||Doe
|-
|-
| Show at entry || displays during the login process.
|Faculty.UserName||A80||Yes*||Faculty Username, only required if faculty members will be logging into TracCloud, or as primary unique identifier.||JDoe
|-
|-
| Show at entry before 1st visit during survey period || displays during the login process, but only after the student’s first visit during the survey period specified
|Faculty.Salutation||A40|| ||Faculty's salutation.||Dr.
|-
|-
| Show at exit || displays during the logout process
|Faculty.Department||A80|| ||Faculty Assigned Department.||M262
|-
|-
| Show at exit after 1st visit during survey period || displays during the logout process, but only after the student’s first visit during the survey period specified
|Faculty.Phone||A80|| ||Faculty's phone number.||555-555-5555
|-
|-
| Display as link on Main Menu || displays on student dashboards
|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
|-
|-
| Do not auto send || This survey can be manually sent on the Student Listing, from Student Profiles, Batch Visits, or Group Rosters.
|Faculty.Custom1-X||A80|| ||Faculty custom fields. Multiple custom fields can be used.||?
|-
|-
| Link on edit student || Appears as an option within each student’s profile. This allows you to manually send a survey to a student when needed.
|Student.ID||A40||Yes||The ID/OtherID/OtherID2 of the student this registration is assigned to.||A123456789
|-
|-
| Link on edit visit || displays within the “Surveys” tab of a visit record, allowing you to manually email out a survey relating to a specific visit
|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+
|-
|-
| Display on document posting || is manually sent to the student from their profile via the Actions > “Survey Document…” prompt
|Registration.RegStatus||A30||||An optional registration status that can be used to deactivate certain enrollments.||Dropped
|-
|-
| Display as Student Entry Form || is manually sent to the student from their profile via the Actions > “Complete form…” prompt
|Registration.Custom1-X||A80|| ||Registration custom fields. Multiple custom fields can be used. A common example would be midterm grades.||?
|}
|}
<br>
* <b>In-Person / Online</b>
::Allows you to optionally only send this survey for In-Person or Online appointments/visits.<br>
* <b>Recipient Email Settings</b> (emailed surveys only)
::Options relating to the emailed survey formatting. From email address and contact name, the subject line, and the body itself. The twig tags <nowiki>{{Survey.Link}}</nowiki> and <nowiki>{{Survey.Name}}</nowiki> can be used to display a link to the survey and the survey name field respectively.<br>
* <b>Link to Centers</b>
::Determines which centers this survey is assigned to.<br>
* <b>Instructions and Survey Head Text</b>
::These messages will appear at the very top of the survey entry window. Head Text appears in bold at the top, typically a title for the survey. Instructions appears smaller just beneath Head Text, typically a description for the survey or basic instructions.<br>
* <b>Confirmation Message</b>
::The confirmation message will display at the bottom of the survey after submitting responses.<br>
<hr>
<div style='text-align: center;'><big>Options</big></div>
[[File:6758807.png|900px]]<br><br>
* <b>Allow modification</b>
::This setting allows students/staff to re-open and edit their responses after the initial submission.<br>
* <b>Anonymous Survey</b>
::Will not display student names in responses. Once an Anonymous Survey has responses, it is permanently anonymous.<br>
* <b>Questions directed to…</b>
::These settings determine who this survey will be sent to. For example, if this is an “Email after visit” survey, you can control if the survey gets sent to the Student, the Consultant, the Faculty member, or even all three.<br>
* <b>Make this survey a quiz</b>
::See <b>[[TracCloudGuideGlobalGradesAssign#5._SurveyTrac_Quizzes|Grade Groups and Assignments]]</b> for more information.<br>
* <b>Send Rate</b>
::Allows you to define a percentage chance of a survey being sent to a student. 100% will always send the survey when the 'Initiated Via' criteria is met.
* <b>Notify results to emails</b>
::Email addresses entered here will be notified when a survey has been completed. These emails will contain the questions and answers provided by the student/staff.<br>
* <b>Notify email subject</b>
::The subject line of the notify email above.<br>
* <b>Notify from email</b>
::Which email address is this response notification sent from?<br>
* <b>Link Survey to Reasons/Subjects</b>
::If you only want this survey to be sent out for visits/appointments of a specific reason or subject, you can list out the entries here. For example, “General Help,Exam Prep”<br>
* <b>Answers Position</b>
::Position of answer fields, either below or to the right of the question, as seen below.
::[[File:5340868.png|600px]]<br>
* <b>Radio Button Style</b> & <b>Multi Checkbox Style</b>
::Determines how Radio and Multi-Checkbox Choice style questions display. Tall vs Wide, as seen below.
::[[File:42784.png|400px]]<br>
<hr><div style='text-align: center;'><big>Questions and Preview</big></div>
The Questions tab is where we can configure the questions we’re asking within this survey. The Preview tab allows us to immediately take a look at our survey formatting to make sure everything is appearing as intended.
[[File:4210337.png|900px]]<br><br>
To begin creating a new question, go to <i>hamburger icon > New Question</i>, or click the <b>+</b> icon on the right-hand side.
[[File:5517490.png|800px]]<br><br>
* <b>Question #</b>
::This determines the order that questions will appear in. 0/Blank will hide the question.
* <b>Question Type</b>
::There are various Question Types available for use, depending on the format of your question. Each of the available options can be seen in the screenshot below.
::[[File:8503894.png|700px]]
* <b>Required</b>
::Determines whether or not the question requires an answer before being submitted.
* <b>Question</b>
::Write out your question here. There are also some optional text formatting tools available if you’d like to display the question in a specific way, including the ability to use standard HTML by selecting <i>Tools > Source Code</i>.
* <b>Choices</b>
::Depending on the Question Type chosen, you may need to list out the available answers. If this box is available, include your answer choices on unique lines, as seen in the screenshot earlier in this article.
<hr><div style='text-align: center;'><big>Responses</big></div>
Here you can find a list of surveys sent, whether or not a response has been recorded, and you even the ability to resend surveys that have not yet had a response back. All of these entries can be opened to view the responses from that student or staff member.
[[File:2919276.png|900px]]<br><br>
<hr><div style='text-align: center;'><big>Survey Snapshot Report</big></div>
A Survey Snapshot report can be found in your Management Reports category. {{:TracCloudReportsSurvey01}}<br><br>
For information on purchasing the SurveyTrac Module, reach out to [mailto:sales@go-redrock.com sales@go-redrock.com]<br>
For SurveyTrac functionality questions, reach out to [mailto:helpdesk@go-redrock.com helpdesk@go-redrock.com]


|-
| style="vertical-align:top; font-size:120%; color:#0C3773; " | <HR>'''Section Schedule Import Fields''' <span style="color:black">(Optional)</span>
|-
| style="vertical-align:top; font-size:100%; " |


{| cellpadding="5" cellspacing="0" border="1"
!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
|-
| 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
|-
| colspan="5" | 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
|}


<!-- here is the end of the content table -->
|}
|}

Revision as of 12:33, 16 August 2022

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.


Import files must be in a flat-text format (.csv or .txt), comma or tab delimited. Comma delimited files must have quotes surrounding every 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.


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.

View Student File View Course File View Section Schedule File


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 A80 The street address of the student. 1234 E. Nowhere St.
Apt A80 Apartment Number. #46
City A80 City of the student address. Tempe
State A80 The state of the student address. Two-letter formatting displays best. AZ
Zip A10 The zip code of the student address. 88881
Country A10 The country of the student address. USA
Home_Phone A20 The student's home phone number. 555-555-5551
Work_Phone A20 The student's work phone number. 555-555-5552
Cell_Phone A20 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
Preferred A20 The student's preferred phone number, 'Home', 'Work', or 'Phone'. Home
Username A80 * 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 A80 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. Intro to Accounting
Section.Code A80 Yes The section code. 03
Section.CRN A20 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 A80 Faculty Assigned Department. M262
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.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 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.RegStatus A30 An optional registration status that can be used to deactivate certain enrollments. Dropped
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 A20 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