TracCloud: Rosetta: Difference between revisions

From Redrock Wiki

Visual
Created page with "<div class="tcWidgetPage" style="width:100%"> {| class="wikitable" |+ Students |- ! <b>Field</b> !! <b>Type</b> !! <b>Description</b> !! <b>Twig Tag</b> !! <b>API</b> !! <b>SFTP Export Column</b> !! <b>Example</b> |- | ID || bigint || The student's ID number. Should be unique. || <nowiki>{{Student.ID}}</nowiki> || Students.ID || ID || 1234567 |- | First Name || varchar(80) || The student's preferred first name. || <nowiki>{{Student.First_Name}}</nowiki> || Students.First..."
 
No edit summary
 
(50 intermediate revisions by the same user not shown)
Line 1: Line 1:
<div class="tcWidgetPage" style="width:100%">
<div style="width:50%; float:left">
{| class="wikitable"
<div class="tcWidgetPage" style="margin:1%;">
|+ Students
<b>TracCloud: Table and Field List</b>
<div class="line"></div>
 
This article lists fields in TracCloud grouped by table. For each field, it will show the data type, description, how the field is accessible in [[TracCloud:_Twig|Twig]], the [[TracCloud:_API|API]], as well as how it displays in the [[TracCloud:_Data_Export|SFTP data export]].
</div>
 
<div class="tcWidgetPage" style="margin:1%;">
<b>Tips</b>
<div class="line"></div>
 
* Hover over the field name to see an example value.
 
* Click the header to sort by that column, shift-click to sort by multiple.
</div>
</div>
 
<div style="width:50%; float:right;">
<div class="tcWidgetPage" style="margin:1%;">
<div style="float: left; margin-top: 0em; margin-bottom: 1em"><b>Type Definitions</b></div><div class="mw-collapsible mw-collapsed">
<br><br>
{| class="wikitable" style="margin:auto;"
!Type!!Description
|-
|-
! <b>Field</b> !! <b>Type</b> !! <b>Description</b> !! <b>Twig Tag</b> !! <b>API</b> !! <b>SFTP Export Column</b> !! <b>Example</b>
|varchar(#)||Alphanumeric field with a specified maximum length.
|-
|-
| ID || bigint || The student's ID number. Should be unique. || <nowiki>{{Student.ID}}</nowiki> || Students.ID || ID || 1234567
|int||Integer, maximum value of about 4 billion, or a 10-digit numeric value.
|-
|-
| First Name || varchar(80) || The student's preferred first name. || <nowiki>{{Student.First_Name}}</nowiki> || Students.First_Name || FirstName || Sam
|bigint||Big integer, maximum value of about 9 quintillion, or a 16-digit numeric value.
|-
|-
| Last Name || varchar(80) || The student's last name || <nowiki>{{Student.Last_Name}}</nowiki> || Students.Last_Name || LastName || Smith
|tinyint||Tiny integer, typically used to store a 1 or 0 as true or false.
|-
|date||Date, formatted as YYYY-MM-DD
|-
|time||A specific time using a 24-hour format (HH:MM:SS), e.g., 13:45:00
|-
|datetime||Date and time, YYYY-MM-DD HH:MM:SS
|-
|double||Decimal # with up to 12 digits precision
|-
|json||JSON-formatted field that contains multiple fields and values (e.g., custom fields).
|}
</div>
<br>
</div>
 
<div class="tcWidgetPage" style="margin:1%;">
<div class="mw-customtoggle-1 mw-customtoggle-2 mw-customtoggle-3 mw-customtoggle-4 mw-customtoggle-5" style="float: left; color: white; background-color: grey; border: 3px solid grey; font-weight: bold; border-radius: 5px">'''Invert All Visibility'''</div><br>
</div>
</div>
 
<hr>
<!------------------------------------------------------- Students ------------------------------------------------------>
<div class="tcWidgetPage">
<div style="float: left;"><big><b>Students</b></big></div><div style="float: right; color: white; background-color: grey; border: 3px solid grey; font-weight: bold; border-radius: 5px" class="mw-customtoggle-1">Toggle Visibility</div>
<div class="mw-collapsible" id="mw-customcollapsible-1">
<br><br>
{| class="wikitable sortable" style="min-width: 100%; font-size: 15px"
|-
! <b>Field</b> !! <b>Type</b> !! <b>Description</b> !! <b>Twig</b> !! <b>API</b> !! <b>SFTP Export</b>
|-
| <span title="1234567">Sequence</span>||bigint ||Static identifier for students, unrelated to ID. || || Students.Sequence ||
|-
| <span title="1a23b4c5-6789-01d2-ef3g-456h78901ijk">UUID</span> || varchar(36) || Unique identifier for this user. || || Students.UUID ||
|-
| <span title="1234567">ID</span> || bigint || The student's ID number. Should be unique.|| <nowiki>{{Student.ID}}</nowiki> || Students.ID || StudentID
|-
| <span title="A1234567">Other_ID</span>||varchar(40) || Alternative identifier for the student.|| <nowiki>{{Student.Other_ID}}</nowiki> || Students.Other_ID || OtherID
|-
| <span title="ssmith1234">Other_ID2</span>|| varchar(40) || Another alternative identifier for the student. || <nowiki>{{Student.Other_ID2}}</nowiki>|| Students.Other_ID2 || OtherID2
|-
|<span title="87654321">Barcode</span>|| varchar(80) || The student's [[TracCloud:_General_Kiosk_Login_Options_/_Barcode_Scanners|barcode]]. || <nowiki>{{Student.Barcode}}</nowiki> || Students.Barcode || Barcode
|-
| <span title="ACTIVE">Status</span> || varchar(80) || Whether the student is Active or Inactive. || <nowiki>{{Student.Status}}</nowiki> || Students.Status || Status
|-
| <span title="Enrolled">OtherStatus</span> || varchar(80) || Alternative/custom status. || || Students.OtherStatus || StudentOtherStatus
|-
| <span title="Samantha">Legal_First</span> || varchar(80) || The student's legal first name. || <nowiki>{{Student.Legal_First}}</nowiki> || Students.Legal_First || LegalFirst
|-
| <span title="Sam">First Name</span> || varchar(80) || The student's preferred first name.|| <nowiki>{{Student.First_Name}}</nowiki> || Students.First_Name || FirstName
|-
| <span title="Smith">Last Name</span> || varchar(80) || The student's last name. || <nowiki>{{Student.Last_Name}}</nowiki> || Students.Last_Name || LastName
|-
| <span title="Jane">Middle</span> || varchar(80) || The student's middle name. || <nowiki>{{Student.Middle}}</nowiki> || Students.Middle || Middle
|-
| <span title="Smith, Sam J.">Full_Name</span> || varchar(255) || The student's full name, formatted as "Last, First M.". || <nowiki>{{Student.Full_Name}}</nowiki> || Students.Full_Name ||
|-
| <span title="Smith, Sam J">LastFirst</span> || varchar(255) || The student's full name, formatted as "Last, First M". || <nowiki>{{Student.LastFirst}}</nowiki> || ||
|-
| <span title="Sam J. Smith">Full_Name2</span>|| varchar(255) || The student's full name, formatted as "First M. Last". || <nowiki>{{Student.Full_Name2}}</nowiki> || Students.Full_Name2 ||
|-
| <span title="Sam Smith">FirstLast</span>|| varchar(255) || The student's full name, formatted as "First Last". || <nowiki>{{Student.FirstLast}}</nowiki> || ||
|-
| <span title="1234 W Example St">Street</span>|| varchar(250) || The student's street address. || || Students.Street || Street
|-
| <span title="123">Apt</span>|| varchar(80) || The student's apartment number. || || Students.Apt ||
|-
| <span title="Tempe">City</span>|| varchar(120) || The student's city. || || Students.City || City
|-
| <span title="Arizona">State</span>|| varchar(80) || The student's state. || || Students.State || State
|-
| <span title="85210">Zip</span>|| varchar(20) || The student's zip code. || || Students.Zip || ZIP
|-
| <span title="555-555-5555">Home_Phone</span>|| varchar(80) || The student's home phone number. || <nowiki>{{Student.Home_Phone}}</nowiki> || Students.Home_Phone || HomePhone
|-
| <span title="555-555-5555">Work_Phone</span>|| varchar(80) || The student's work phone number. || <nowiki>{{Student.Work_Phone}}</nowiki> || Students.Work_Phone || WorkPhone
|-
| <span title="555-555-5555">Cell_Phone</span>|| varchar(80) || The student's cell phone number. || <nowiki>{{Student.Cell_Phone}}</nowiki> || Students.Cell_Phone || CellPhone
|-
| <span title="ssmith1234@example.edu">Email</span> || varchar(120) || The student's email address, typically their campus email. || <nowiki>{{Student.Email}}</nowiki> || Students.Email || Email
|-
| <span title="Email">Preferred</span>||varchar(80) || The student's preferred contact method. Possible values are listed below.<p style="line-height: 95%; font-size: 15px"><br>1 = Home<br>2 = Work<br>3 = Cell<br>4 = Email<br>5 = Verbal</p>|| <nowiki>{{Student.Preferred}}</nowiki> || Students.Preferred ||
|-
| <span title="2025-01-31">LastDateIn</span>|| date || Date of the student's last visit. || || Students.LastDateIn ||
|-
| <span title="ssmith1234">UserName</span>|| varchar(120) || The student's username for authentication. || <nowiki>{{Student.UserName}}</nowiki> || Students.UserName || StudentUserName
|-
| <span title="1999-12-31">Birthdate</span>||date || The student's birthdate. || || Students.Birthdate || Birthdate
|-
| <span title="He/Him">Pronouns</span>|| varchar(80) || The student's preferred pronouns. || <nowiki>{{Student.Pronouns}}</nowiki> || Students.Pronouns || StudentPronouns
|-
| <span title="Male">Gender</span>|| varchar(80) || The student's gender. || <nowiki>{{Student.Gender}}</nowiki> || Students.Gender || Gender
|-
| <span title="Asian-American">Ethnicity</span>|| varchar(150) || The student's ethnicity. || <nowiki>{{Student.Ethnicity}}</nowiki> || Students.Ethnicity|| Ethnicity
|-
| <span title="Mathematics">Major</span>|| varchar(120) || The student's major. || <nowiki>{{Student.Major}}</nowiki> || Students.Major|| Major
|-
| <span title="Senior">Class</span>||varchar(80) || The student's class. || <nowiki>{{Student.Class}}</nowiki> || Students.Class|| Class
|-
| <span title="BS">DegreeGoal</span>||varchar(80) || The student's degree goal. || <nowiki>{{Student.DegreeGoal}}</nowiki> || Students.DegreeGoal|| DegreeGoal
|-
| <span title="XYZ 2025">Cohort</span>||varchar(80) || The student's cohort. || <nowiki>{{Student.Cohort}}</nowiki> || Students.Cohort|| Cohort
|-
| <span title="Example University">College</span>||varchar(80) || The student's college. || <nowiki>{{Student.College}}</nowiki> || Students.College|| College
|-
| <span title="Grad">Grad_Und</span>||varchar(80) || The student's graduate status. || <nowiki>{{Student.Grad_Und}}</nowiki> || Students.Grad_Und|| GradUndergrad
|-
| <span title="3.4">GPA</span>||double || The student's GPA. || <nowiki>{{Student.GPA}}</nowiki> || Students.GPA || GPA
|-
| <span title="37">AccumHours</span>||double || The student's accumulated hours. || || Students.AccumHours || Hours
|-
| <span title="FWS">Fund</span>|| varchar(80) || The student's fund. || || Students.Fund || StudentFund
|-
| <span title="1234">PrimaryConsultantID</span> || bigint || Relates to Staff.Sequence. || || Students.PrimaryConsultantID ||
|-
| <span title="Men's Tennis SP2024">FlagText</span>|| varchar(80) || The contents of the student's [[TracCloud:_Student_Entry_Choices|"Flag Information" field.]] || || Students.FlagText ||
|-
| <span title="This can be anything.">CustomData</span> || json || All [[TracCloud:_Custom_Fields|custom fields]] are stored in this field. Specify a custom field with its sequence number after "cf_".|| <nowiki>{{Student.CustomData.cf_123}}</nowiki> || Students.CustomData->>``$.cf_123`` || [Field Name]
|-
| <span title="true">WatchLists</span> || json || Returns a true or false value based on whether or not the student is on the specified [[TracCloud:_Student_Lists|watch list.]] Hover over the name of your watch list to find its sequence number (e.g., wl_9) || <nowiki>{{Student.WatchLists.wl_0}}</nowiki> || ||
|-
| <span title="1">gen_BIOConfirmed</span>|| varchar(2) || Whether or not the student has [[TracCloud:_Confirm_Bio|confirmed their bio.]] || || Students.gen_BIOConfirmed ||
|-
| <span title="2025-03-11 08:59:44">gen_BIOConfirmedDT</span>|| varchar(20) || When the student last confirmed their bio. || || Students.gen_BIOConfirmedDT ||
|-
| <span title="2025-03-11 08:53:11">CreatedDT</span>|| timestamp || When this student record was initially created in TracCloud. || || Students.CreatedDT ||
|-
| <span title="2025-01-07 03:48:16">_LastImportedDT</span>|| datetime || The last time this student record was [[TracCloud:_Student_Data_Import|imported]] into TracCloud. || || Students._LastImportedDT ||
|}
</div>
<br>
</div>
<!------------------------------------------------------- Visits ------------------------------------------------------>
<div class="tcWidgetPage">
<div style="float: left;"><big><b>Visits</b></big></div><div style="float: right; color: white; background-color: grey; border: 3px solid grey; font-weight: bold; border-radius: 5px" class="mw-customtoggle-2">Toggle Visibility</div>
<div class="mw-collapsible" id="mw-customcollapsible-2">
<br><br>
{| class="wikitable sortable" style="min-width: 100%; font-size: 15px"
|-
! <b>Field</b> !! <b>Type</b> !! <b>Description</b> !! <b>Twig</b> !! <b>API</b> !! <b>SFTP Export</b>
|-
| <span title="1234">Sequence</span> || bigint || A unique identifier for every visit record. || || Visits.Sequence || VisitID
|-
| <span title="2025-03-07 08:45:00">EnteredDT</span> || datetime || The date and time the student entered the center. This will only differ from TimeIn if your center tracks wait time.|| <nowiki>{{Visit.EnteredDT}}</nowiki> || Visits.EnteredDT ||
|-
| <span title="09:45am">EnteredTime</span> || time || The time the student entered, formatted as "09:45am." || <nowiki>{{Visit.EnteredTime}}</nowiki> || ||
|-
| <span title="01/31/25">EnteredDate</span> || time || The date the student entered. || <nowiki>{{Visit.EnteredDate}}</nowiki> || ||
|-
| <span title="2025-03-07 09:00:00">TimeIn</span> || datetime || The date and time the student's visit began. || <nowiki>{{Visit.TimeIn}}</nowiki> || Visits.TimeIn || DateIn <b>and</b> TimeIn
|-
| <span title="09:45am">StartTime</span> || time || The time the student's visit began, formatted as "09:45am." || <nowiki>{{Visit.StartTime}}</nowiki> || ||
|-
| <span title="01/31/25">StartDate</span> || time || The datethe student's visit began. || <nowiki>{{Visit.StartDate}}</nowiki> || ||
|-
| <span title="2025-03-07 10:00:00">TimeOut</span> || datetime || The date and time the student's visit ended. || <nowiki>{{Visit.TimeOut}}</nowiki> || Visits.TimeOut || TimeOut
|-
| <span title="10:45am">EndTime</span> || time || The time the student's visit ended, formatted as "09:45am."  || <nowiki>{{Visit.EndTime}}</nowiki> || ||
|-
| <span title="01/31/25">EndDate</span> || time || The datethe student's visit ended. || <nowiki>{{Visit.EndDate}}</nowiki> || ||
|-
| <span title="0">isWork</span> || tinyint || Whether or not this visit is a work visit. || <nowiki>{{Visit.isWork}}</nowiki> || Visits.isWork ||
|-
| <span title="1234">StudentID</span> || bigint || Relates to Students.Sequence (not Students.ID). || || Visits.StudentID ||
|-
| <span title="1234">CenterID</span> || bigint || Relates to Centers.Sequence || || Visits.CenterID ||
|-
| <span title="1234">ConsultantID</span> || bigint || Relates to Staff.Sequence || || Visits.ConsultantID ||
|-
| <span title="1234">RegistrationID</span> || bigint || Relates to Registrations.Sequence || || Visits.RegistrationID ||
|-
| <span title="1234">ReasonID</span> || bigint || Relates to Reasons.Sequence || || Visits.ReasonID ||
|-
| <span title="1">isWaiting</span> || tinyint || Whether or not the student is currently waiting to be seen (i.e., TimeIn not yet started). || || Visits.isWaiting ||
|-
| <span title="15">WaitTime</span> || double || How long the student waited to start their visit in minutes (TimeIn - EnteredDT). || <nowiki>{{Visit.WaitTime}}</nowiki> || Visits.WaitTime || WaitTime
|-
| <span title="60">Duration</span> || int || The length of the student's visit in minutes. || <nowiki>{{Visit.Duration}}</nowiki> || Visits.Duration || Duration
|-
| <span title="75">TotalTime</span> || double  || The total visit time (WaitTime + Duration). || <nowiki>{{Visit.TotalTime}}</nowiki> || Visits.TotalTime || TotalTime
|-
| <span title="This can be anything.">CustomData</span> || json || All [[TracCloud:_Custom_Fields|custom fields]] are stored in this field. Specify a custom field with its sequence number after "cf_".|| <nowiki>{{Visit.CustomData.cf_123}}</nowiki> || Visits.CustomData->>``$.cf_123`` || [Field Name]
|-
| <span title="1">isTerminated</span> || tinyint || Whether or not this visit was automatically [[TracCloud:_Log_Listing_Message,_KIOSK_Notices,_and_Custom_KIOSKs|terminated]] by TracCloud. || || Visits.isTerminated ||
|-
| <span title="FWS">Fund</span> || varchar(80) || The fund for this visit. || <nowiki>{{Visit.Fund}}</nowiki> || Visits.Fund || Fund
|-
| <span title="During this visit, we covered X, Y, and an introduction to Z.">CtrNotes</span> || text || The notes field filled in by staff/consultants in TracCloud. || <nowiki>{{Visit.CtrNotes}}</nowiki> || Visits.CtrNotes || VisitNotes
|-
| <span title="1234">SurveyRespID</span> || bigint || Relates to Responses.Sequence. || || Visits.SurveyRespID ||
|-
| <span title="1234">TermID</span> || bigint || Relates to Terms.Sequence. || || Visits.TermID || VisitTermCode (displays Terms.TermCode)
|-
| <span title="1234">SectionID</span> || bigint || Relates to Sections.Sequence. || || Visits.SectionID ||
|-
| <span title="Library">Location</span> || varchar(512) || The location of the visit. || <nowiki>{{Visit.Location}}</nowiki> || Visits.Location || Location
|-
| <span title="0">Online</span> || tinyint || Whether or not the visit was online. || <nowiki>{{Visit.Online}}</nowiki> || Visits.Online|| Online
|-
| <span title="America/Phoenix">TimeZone</span> || varchar(120) || The time zone of this visit's time. || || Visits.TimeZone ||
|-
| <span title="Friday">VisitDay</span> || varchar(20) || The day of week the visit took place. || <nowiki>{{Visit.Day}}</nowiki> || Visits.VisitDay ||Weekday
|}
</div>
<br>
</div>
 
<!------------------------------------------------------- Appointments ------------------------------------------------------>
<div class="tcWidgetPage">
<div style="float: left;"><big><b>Appointments</b></big></div><div style="float: right; color: white; background-color: grey; border: 3px solid grey; font-weight: bold; border-radius: 5px" class="mw-customtoggle-3">Toggle Visibility</div>
<div class="mw-collapsible" id="mw-customcollapsible-3">
<br><br>
{| class="wikitable sortable" style="min-width: 100%; font-size: 15px"
|-
! <b>Field</b> !! <b>Type</b> !! <b>Description</b> !! <b>Twig</b> !! <b>API</b> !! <b>SFTP Export</b>
|-
| <span title="1234">Sequence</span> || bigint || A unique identifier for each appointment record. || || Appointments.Sequence || ApptID
|-
| <span title="2025-01-31 14:00:00">StartDT</span> || datetime || The appointment start date and time. || <nowiki>{{Appointment.StartDT}}</nowiki> || Appointments.StartDT || DateIn <b>and</b> TimeIn
|-
| <span title="02:00pm">StartTime</span> || time || The appointment start time, formatted as "02:00pm". || <nowiki>{{Appointment.StartTime}}</nowiki> || ||
|-
| <span title="200pm">DisplayTime</span> || time || The appointment start time, formatted as 2<small>00p</small>. || <nowiki>{{Appointment.DisplayTime|raw}}</nowiki> || ||
|-
| <span title="01/31/25">StartDate</span> || date || The appointment start date, formatted as "01/31/25". || <nowiki>{{Appointment.StartDate}}</nowiki> || ||
|-
| <span title="Fri, Jan 31">DisplayDate</span> || date || The appointment start date, formatted as "Fri, Jan 31". || <nowiki>{{Appointment.DisplayDate}}</nowiki> || ||
|-
| <span title="60">Duration</span> || double || The length of the appointment in minutes. || <nowiki>{{Appointment.Duration}}</nowiki> || Appointments.Duration || Duration
|-
| <span title="2025-01-31 15:00:00">EndDT</span> || datetime || The appointment end date and time. || <nowiki>{{Appointment.EndDT}}</nowiki> || Appointments.EndDT || TimeOut
|-
| <span title="03:00pm">EndTime</span> || time || The appointment end time. || <nowiki>{{Appointment.EndTime}}</nowiki> || ||
|-
| <span title="01/31/25">EndDate</span> || date || The appointment end date. || <nowiki>{{Appointment.EndDate}}</nowiki> || ||
|-
| <span title="Monday">Day</span> || varchar || The appointment day of week. || <nowiki>{{Appointment.Day}}</nowiki> || || Weekday
|-
| <span title="https://traccloud.go-redrock.com/example/trac/entryinc.php?res=example&_ttoken=example">Link</span> || varchar || A link to the appointment record in TracCloud. || <nowiki>{{Appointment.Link}}</nowiki> || ||
|-
| <span title="1234">StudentID</span> || bigint || Relates to Students.Sequence (not Students.ID). || || Appointments.StudentID ||
|-
| <span title="1234">ConsultantID</span> || bigint || Relates to Staff.Sequence. || || Appointments.ConsultantID ||
|-
| <span title="1234">VisitID</span> || bigint || Relates to Visits.Sequence. || || Appointments.VisitID ||
|-
| <span title="1234">CenterID</span> || bigint || Relates to Centers.Sequence. || || Appointments.CenterID ||
|-
| <span title="1234">ReasonID</span> || bigint || Relates to Reasons.Sequence. || || Appointments.ReasonID ||
|-
| <span title="1234">SectionID</span> || bigint || Relates to Sections.Sequence. || || Appointments.SectionID ||
|-
| <span title="1234">AvailRecID</span> || bigint || Relates to AvailBlocks.Sequence. || || Appointments.AvailRecID ||
|-
| <span title="1234">RecurID</span> || bigint || Recurring appointments that are part of the same series (e.g., weekly at 2pm) will have a matching RecurID. || || Appointments.RecurID ||
|-
| <span title="Attended">Status</span> || varchar(80) || The status of the appointment. || <nowiki>{{Appointment.Status}}</nowiki> || Appointments.Status || ApptStatus
|-
| <span title="Room 15">Location</span> || varchar(512) || The location of the appointment, can either be an in-person location or an online link. || <nowiki>{{Appointment.Location}}</nowiki> || Appointments.Location || Location
|-
| <span title="FWS">Fund</span> || varchar(80) || The appointment fund. || <nowiki>{{Appointment.Fund}}</nowiki> || Appointments.Fund || Fund
|-
| <span title="0">Online</span> || int || Whether or not the appointment is online. || <nowiki>{{Appointment.Online}}</nowiki> || Appointments.Online || Online (displays as "Yes" or blank)
|-
| <span title="https://zoom.us/example">OnlineURL</span> || varchar(512) || The online meeting link for the appointment. This will be blank for in-person appointments. The Twig tag will contain a TracCloud link that tracks attendance when the student joins rather than a direct link to the meeting room. || <nowiki>{{Appointment.OnlineLink}}</nowiki> || Appointments.OnlineURL || ApptOnlineURL
|-
| <span title="Schedule conflict.">OtherNotes</span> || text || Student cancellation reason. || <nowiki>{{Appointment.OtherNotes}}</nowiki> || Appointments.OtherNotes || OtherNotes
|-
| <span title="Online 1-on-1">Type</span> || varchar || The type of appointment. 1-on-1, Group, etc. || <nowiki>{{Appointment.Type}}</nowiki> || || ApptType
|-
| <span title="N/A">Icon</span> || || An icon that indicates the appointment type, such as {{#fas:user-group}}.  || <nowiki>{{Appointment.Icon|raw}}</nowiki> || ||
|-
| <span title="false">hasDocument</span> || varchar || Whether or not the appointment has a document uploaded, displayed as "true" or "false". || <nowiki>{{Appointment.hasDocument}}</nowiki> || ||
|-
| <span title="Online">OnlineText</span> || varchar || If the appointment is online, this tag will display as "Online", otherwise it will be blank. || <nowiki>{{Appointment.OnlineText}}</nowiki> || ||
|-
| <span title="false">isRecurring</span> || varchar || Whether or not the appointment is recurring, displayed as "true" or "false". || <nowiki>{{Appointment.isRecurring}}</nowiki> || ||
|-
| <span title='<nowiki>["Mar 13, 10:00 am <br/>","Mar 14, 10:00 am <br/>","Mar 15, 10:00 am <br/>"]</nowiki>'>RecurringDates</span> || varchar || An <b>array</b> of recurring appointments in the series. || <nowiki>{{Appointment.RecurringDates}}</nowiki> || ||
|-
| <span title="2025-01-31">recurFirstDate</span> || date || The first date of a recurring appointment series. || <nowiki>{{Appointment.recurFirstDate}}</nowiki> || ||
|-
| <span title="2025-02-28">recurLastDate</span> || date || The last date of a recurring appointment series. || <nowiki>{{Appointment.recurLastDate}}</nowiki> || ||
|-
| <span title="false">isCancelled</span> || varchar || Whether or not the appointment is currently canceled, displayed as "true" or "false". || <nowiki>{{Appointment.isCanceled}}</nowiki> || ||
|-
| <span title="false">isMissed</span> || varchar || Whether or not the appointment is currently missed, displayed as "true" or "false". || <nowiki>{{Appointment.isMissed}}</nowiki> || ||
|-
| <span title="false">autoCanceled</span> || varchar || Whether or not the appointment was automatically canceled due to max cancel/missed in recurring series rules, displayed as "true" or "false". || <nowiki>{{Appointment.autoCanceled}}</nowiki> || ||
|-
| <span title="2024-01-31 14:00:00">SchedDT</span> || datetime || The date and time this appointment was scheduled. || <nowiki>{{Appointment.SchedDT}}</nowiki> || Appointments.SchedDT || ApptScheduledDT
|-
| <span title="2024-01-31 14:00:00">SchedModDT</span> || datetime || The date and time this appointment was last modified || <nowiki>{{Appointment.SchedModDT}}</nowiki> || Appointments.SchedModDT || ApptModifiedDT
|-
| <span title="Student Sam Smith">SchedUser</span> || varchar(80) || The user who originally scheduled this appointment. || <nowiki>{{Appointment.SchedUser}}</nowiki> || Appointments.SchedUser || ScheduledBy
|-
| <span title="N/A">SchedNotes || text || Unused. || || || SchedNotes
|-
| <span title="1234">SurveyRespID</span> || bigint || Relates to Responses.Sequence. || || Appointments.SurveyRespID ||
|-
| <span title="This can be anything.">CustomData</span> || json || All [[TracCloud:_Custom_Fields|custom fields]] are stored in this field. Specify a custom field with its sequence number after "cf_".|| <nowiki>{{Appointment.CustomData.cf_123}}</nowiki> || Appointments.CustomData->>``$.cf_123`` || [Field Name]
|-
| <span title="SysAdmin jdoe">SchedModBy</span> || varchar(80) || The user who last edited the appointment. || <nowiki>{{Appointment.SchedModBy}}</nowiki> || Appointments.SchedModBy || ApptModifiedBy
|}
</div>
<br>
</div>
 
<!------------------------------------------------------- AvailBlocks------------------------------------------------------>
<div class="tcWidgetPage">
<div style="float: left;"><big><b>Availabilities</b></big></div><div style="float: right; color: white; background-color: grey; border: 3px solid grey; font-weight: bold; border-radius: 5px" class="mw-customtoggle-4">Toggle Visibility</div>
<div class="mw-collapsible" id="mw-customcollapsible-4">
<br><br>
{| class="wikitable sortable" style="min-width: 100%; font-size: 15px"
|-
! <b>Field</b> !! <b>Type</b> !! <b>Description</b> !! <b>Twig</b> !! <b>API</b>
|-
| <span title="1234">Sequence</span> || bigint || A unique identifier for every availability record. || || AvailBlocks.Sequence
|-
| <span title="2025-03-11 09:30:00">FromDT</span> || datetime || The starting date and time of this availability block. || || AvailBlocks.FromDT
|-
| <span title="2025-04-12 11:30:00">ToDT</span> || datetime || The ending date and time of this availability block. || || AvailBlocks.ToDT
|-
| <span title="45">Increments</span> || varchar(5) || The increment duration in minutes. || || AvailBlocks.Increments
|-
| <span title="15">Breaks</span> || varchar(5) || The delay between increments in minutes. || || AvailBlocks.Breaks
|-
| <span title="MONWEDFRI">DAYS</span> || varchar(30) || Which days of the week this availability is available on. || || AvailBlocks.Days
|-
| <span title="1">isAvail</span> || int || 0 = Reserve block, 1 = Regular availability, 2 = Stacked availability. || <nowiki>{{AvailBlock.isAvail}}</nowiki> || AvailBlocks.isAvail
|-
| <span title="Scheduled off for Holiday.">BlockType</span> || varchar(256) || Reserve block description. || || AvailBlocks.BlockType
|-
| <span title="Canceled - Holiday">BlockStatus</span> || varchar(80) || Reserve block appointment status. || || AvailBlocks.BlockStatus
|-
| <span title="3">MaxStudents</span> || int || The number of available slots at this time. || <nowiki>{{AvailBlock.MaxStudents}}</nowiki> || AvailBlocks.MaxStudents
|-
| <span title="1234">ConsultantID</span> || bigint || Relates to Staff.Sequence. || || AvailBlocks.ConsultantID
|-
| <span title="1234">CenterID</span> || bigint || Relates to Centers.Sequence. || || AvailBlocks.CenterID
|-
| <span title="1234">ReasonID</span> || bigint || Relates to Reasons.Sequence. || || AvailBlocks.ReasonID
|-
| <span title="1234">SectionID</span> || bigint || Relates to Sections.Sequence. || || AvailBlocks.SectionID
|-
| <span title="ACTG100*">AvailSubj</span> || varchar(256) || The availability subject, including wildcard entries. || || AvailBlocks.AvailSubj
|-
| <span title="Optional Weekly Chosen">RecurType</span> || || The type of recurring appointment. The possible options are listed below.<p style="line-height: 95%; font-size: 15px"><br>None<br>Daily<br>Weekly<br>Bi-Weekly<br>Optional Daily<br>Optional Weekly<br>Optional Bi-Weekly<br>Optional Daily Chosen<br>Optional Weekly Chosen<br>Optional Bi-Weekly Chosen</p> || || AvailBlocks.RecurType
|-
| <span title="Room 15">Location</span> || varchar(512) || The in-person location for this availability. || || AvailBlocks.Location
|-
| <span title="https://zoom.us/example">OnlineURL</span> || varchar(512) || The online location for this availability. || || AvailBlocks.OnlineURL
|-
| <span title="FWS">Fund || varchar(80) || The availability fund. || || AvailBlocks.Fund
|-
| <span title="1">isInperson</span> || tinyint || Whether or not the availability is in-person. || || AvailBlocks.isInperson
|-
| <span title="1">isOnline</span> || tinyint || Whether or not the availability is online. || || AvailBlocks.isOnline
|-
| <span title="0">isAsynch</span> || tinyint || Whether or not the availability is asynchronous. || || AvailBlocks.isAsync
|-
| <span title="2">defLocChoice</span> || int || The default location choice. 0 = in-person, 1 = online, 2 = asynchronous. || || AvailBlocks.defLocChoice
|-
| <span title="0">isMeeting || tinyint || Whether or not a reserve block is designated as as meeting block. || || AvailBlocks.isMeeting
|}
</div>
<br>
</div>
 
<!------------------------------------------------------- Course Related  ------------------------------------------------------>
<div class="tcWidgetPage">
<div style="float: left;"><big><b>Course Related</b> (Courses, Sections, Terms, Registrations, Faculty, SectionSchedule)</big></div><div style="float: right; color: white; background-color: grey; border: 3px solid grey; font-weight: bold; border-radius: 5px" class="mw-customtoggle-5">Toggle Visibility</div>
<div class="mw-collapsible" id="mw-customcollapsible-5">
<br><br>
{| class="wikitable sortable" style="min-width: 100%; font-size: 15px"
|+ Courses
|-
! <b>Field</b> !! <b>Type</b> !! <b>Description</b> !! <b>Twig</b> !! <b>API</b> !! <b>SFTP Export</b>
|-
| <span title="1234">Sequence</span> || bigint || A unique identifier for every course. ||  || ||
|-
| <span title="BIOL">Subject</span> || varchar(40) || The subject. || <nowiki>{{Course.Subject}}</nowiki> || Courses.Subject || Subject
|-
| <span title="101">Course</span> || varchar(20) || The course number. || <nowiki>{{Course.Course}}</nowiki> || Courses.Course || Course
|-
| <span title="Introduction to Biology">Title</span> || varchar(120) || The course title. || <nowiki>{{Course.Title}}</nowiki> || Courses.Title || Title
|-
| <span title="0">ExcludeFromCharts</span> || tinyint || Whether or not this course is configured to be excluded from charts. || || Courses.ExcludeFromCharts ||
|-
| <span title="Computer Science">Dept</span> || varchar(40) || The assigned department for this course. || || Courses.Dept ||
|-
| <span title="BIOL101">SubjectCourse</span> || varchar(200) || Combination of Subject and Course in one field. ||  <nowiki>{{Course.SubjectCourse}}</nowiki> || Courses.SubjectCourse ||
|-
| <span title="BIOL101 Introduction to Biology">SubjectCourseTitle</span> || varchar || Combination of Subject, Course, and Title in one field. || <nowiki>{{Course.SubjectCourseTitle}}</nowiki> || ||
|-
| <span title="2025-01-31 02:00:00">_LastImportedDT</span> || datetime || The date and time this record was last imported. || || Courses._LastImportedDT ||
|-
| <span title="This can be anything.">CustomData</span> || json || All [[TracCloud:_Custom_Fields|custom fields]] are stored in this field. Specify a custom field with its sequence number after "cf_".|| <nowiki>{{Course.CustomData.cf_123}}</nowiki> || Courses.CustomData->>``$.cf_123`` || [Field Name]
|-
| <span title="A123B456C">RelatedCoursesID</span> || varchar(20) || The course family identifer. || || Courses.RelatedCoursesID ||
|}
 
{| class="wikitable sortable" style="min-width: 100%; font-size: 15px"
|+ Sections
|-
! <b>Field</b> !! <b>Type</b> !! <b>Description</b> !! <b>Twig</b> !! <b>API</b> !! <b>SFTP Export</b>
|-
| <span title="1234">Sequence</span> || bigint || A unique identifier for each section. || || Sections.Sequence ||
|-
| <span title="0">Inactive</span> || tinyint || Whether or not this section is currently inactive. || || Sections.Inactive ||
|-
| <span title="A01">Code</span> || varchar(80) || The section code/number. || <nowiki>{{Section.Code}}</nowiki> || Sections.Code || Section
|-
| <span title="1234">CourseID</span> || bigint || Relates to Courses.Sequence. || || Sections.CourseID ||
|-
| <span title="1234">GradeGroupID</span> || bigint || Relates to GradeGroups.Sequence. || || Sections.GradeGroupID ||
|-
| <span title="12345">CRN</span> || varchar(80) || The CRN of this section record. || <nowiki>{{Section.CRN}}</nowiki> || Sections.CRN || CRN
|-
| <span title="1234">TermID</span> || bigint || Relates to Terms.Sequence (not Terms.TermCode). || || Sections.TermID ||
|-
| <span title="1234">FacultyID</span> || bigint || Relates to Sections.FacultyID (not Faculty.UserID). || || Sections.FacultyID ||
|-
| <span title="0">nonEnrolled</span> || tinyint || Whether or not this is a [[TracCloud:_Non-Enrolled_Courses|non-enrolled course]]. || || Sections.nonEnrolled ||
|-
| <span title="This can be anything.">CustomData</span> || json || All [[TracCloud:_Custom_Fields|custom fields]] are stored in this field. Specify a custom field with its sequence number after "cf_".|| <nowiki>{{Section.CustomData.cf_123}}</nowiki> || Sections.CustomData->>``$.cf_123`` || [Field Name]
|-
| <span title="2025-01-31 02:00:00">CreatedDT</span> || timestamp || When this section record was initially created. || || Sections.CreatedDT ||
|-
| <span title="0">ignoreRegImportDeactivate</span> || tinyint || Whether or not this section is configured to ignore deactivations. || || Sections.ignoreRegImportDeactivate ||
|-
| <span title="100">Credits</span> || double || The potential credits for this section. || || Sections.Credits ||
|-
| <span title="2025-01-31 02:00:00">_LastImportedDT</span> || datetime || The latest date and time this record was imported into TracCloud. || || Sections._LastImportedDT ||
|-
| <span title="Introduction to Biology">Title</span> || varchar(120) || This optional field overrides Courses.Title if present. || <nowiki>{{Section.Title}}</nowiki> || Sections.Title ||
|}
 
{| class="wikitable sortable" style="min-width: 100%; font-size: 15px"
|+ Terms
|-
! <b>Field</b> !! <b>Type</b> !! <b>Description</b> !! <b>Twig</b> !! <b>API</b> !! <b>SFTP Export</b>
|-
| <span title="1234">Sequence</span> || bigint || A unique identifer for this term record. || || Terms.Sequence ||
|-
| <span title="1">Active</span> || tinyint || Whether or not this term is currently active. || || Terms.Active ||
|-
| <span title="2025SP">TermCode</span> || varchar(80) || The term/semester code. || <nowiki>{{Term.TermCode}}</nowiki> || Terms.TermCode || Term
|-
| <span title="2025-01-31">ActiveFrom</span> || date || The start date of this term. || || Terms.ActiveFrom ||
|-
| <span title="2025-03-31">ActiveTo</span> || date || The end date of this term. || || Terms.ActiveTo ||
|}
 
{| class="wikitable sortable" style="min-width: 100%; font-size: 15px"
|+ Registrations
|-
! <b>Field</b> !! <b>Type</b> !! <b>Description</b> !! <b>Twig</b> !! <b>API</b> !! <b>SFTP Export</b>
|-
| <span title="1234">Sequence</span>|| bigint || A unique identifier for this registration record. || || Registrations.Sequence ||
|-
| <span title="0">Inactive</span> || tinyint || Whether or not this registration is currently inactive. || || Registrations.Inactive ||
|-
| <span title="0">OverrideDate</span> || tinyint || Whether or not this registration is configured with a date override. || || Registrations.OverrideDate ||
|-
| <span title="1234">SectionID</span> || bigint || Relates to Sections.Sequence. || || Registrations.SectionID ||
|-
| <span title="1234">StudentID</span> || bigint || Relates to Students.Sequence (not Students.ID). || || Registrations.StudentID ||
|-
| <span title="B+">Grade</span> || varchar(40) || The registration grade. || || Registrations.Grade ||
|-
| <span title="2025-01-31 02:00:00">ValidFromDT</span> || datetime || The start date of this registration. || || Registrations.ValidFromDT ||
|-
| <span title="2025-03-31 02:00:00">ValidToDT</span> || datetime || The end date of this registration. || || Registrations.ValidToDT ||
|-
| <span title="This can be anything.">Notes</span> || text || The registration notes field. || || Registrations.Notes ||
|-
| <span title="This can be anything.">CustomData</span> || json || All [[TracCloud:_Custom_Fields|custom fields]] are stored in this field. Specify a custom field with its sequence number after "cf_".|| <nowiki>{{Registration.CustomData.cf_123}}</nowiki> || Registrations.CustomData->>``$.cf_123`` || [Field Name]
|-
| <span title="2025-01-31 02:00:00">_LastImportedDT</span> || datetime || The latest date and time this record was imported into TracCloud. || || Registrations._LastImportedDT ||
|-
| <span title="Dropped">RegStatus</span> || varchar(40) || The registration status (dropped, withdrawn, enrolled, etc). || || Registrations.RegStatus ||RegistrationStatus
|-
| <span title="100">EarnedCredits</span> || double || The student's earned credits in this enrollment. || || Registrations.EarnedCredits ||
|}
 
{| class="wikitable sortable" style="min-width: 100%; font-size: 15px"
|+ Faculty
|-
! <b>Field</b> !! <b>Type</b> !! <b>Description</b> !! <b>Twig</b> !! <b>API</b> !! <b>SFTP Export</b>
|-
| <span title="1234">Sequence</span> ||  bigint || Static identifier for faculty, unrelated to UserID. || || Faculty.Sequence ||
|-
| <span title="1a23b4c5-6789-01d2-ef3g-456h78901ijk">UUID</span> || varchar(36) || Unique identifer for faculty records. || || Faculty.UUID ||
|-
| <span title="Jane">FirstName</span> || varchar(80) || The faculty member's first name. || <nowiki>{{Faculty.FirstName}}</nowiki> || Faculty.FirstName || FacultyFirst
|-
| <span title="Doe">LastName</span> || varchar(80) || The faculty member's last name. || <nowiki>{{Faculty.LastName}}</nowiki> || Faculty.LastName || FacultyLast
|-
| <span title="A1234">UserID</span> || varchar(80) || The faculty member's ID number. || <nowiki>{{Faculty.UserID}}</nowiki> || Faculty.UserID || FacultyUserID
|-
| <span title="jdoe123">UserName</span> || varchar(80) || The faculty member's username for authentication. || <nowiki>{{Faculty.UserName}}</nowiki> || Faculty.UserName || FacultyUserName
|-
| <span title="Dr.">Salutation</span> || varchar(40) || The faculty member's salutation (e.g., Dr.). || <nowiki>{{Faculty.Salutation}}</nowiki> || Faculty.Salutation || Salutation
|-
| <span title="Computer Science">Department</span> || varchar(60) || The faculty member's department. || <nowiki>{{Faculty.Department}}</nowiki> || Faculty.Department || FacultyDepartment
|-
| <span title="0">Inactive</span> || tinyint || Whether or not this faculty is currently inactive. || || Faculty.Inactive ||
|-
| <span title="555-555-5555">Phone</span> || varchar(80) || The faculty member's phone number. || <nowiki>{{Faculty.Phone}}</nowiki> || Faculty.Phone ||
|-
| <span title="jdoe@example.edu">Email</span> || varchar(120) || The faculty member's email address. || <nowiki>{{Faculty.Email}}</nowiki> || Faculty.Email || FacultyEmail
|-
| <span title="This can be anything.">CustomData</span> || json || All [[TracCloud:_Custom_Fields|custom fields]] are stored in this field. Specify a custom field with its sequence number after "cf_".|| <nowiki>{{Faculty.CustomData.cf_123}}</nowiki> || Faculty.CustomData->>``$.cf_123`` || [Field Name]
|-
| <span title="A1234567">OtherID</span> || varchar(80) || An alternate hidden identifier for faculty. This is typically left blank. || || Faculty.OtherID ||
|-
| <span title="Jane Doe Dr.">FullName</span> || varchar(255) || Combination of FirstName, LastName, and Saltuation in one field. || <nowiki>{{Faculty.FullName}}</nowiki> || Faculty.FullName ||
|-
| <span title="2025-01-31 02:00:00">_LastImportedDT</span> || datetime || The latest date and time this record was imported into TracCloud. || || Faculty._LastImportedDT ||
|}
 
{| class="wikitable sortable" style="min-width: 100%; font-size: 15px"
|+ SectionSchedule
|-
! <b>Field</b> !! <b>Type</b> !! <b>Description</b> !! <b>API</b>
|-
| <span title="1234">Sequence</span> || bigint || A unique identifer for this section schedule record. || SectionSchedule.Sequence
|-
| <span title="1234">SectionID</span> || bigint || Relates to Sections.Sequence (not Sections.Code). || SectionSchedule.SectionID
|-
| <span title="MONTUEFRI">Days</span> || varchar(30) || Which days this class takes place on. || SectionSchedule.Days
|-
| <span title="09:00:00">Time</span> || time || What time the class starts. || SectionSchedule.Time
|-
| <span title="120">Duration</span> || int || The duration of the class in minutes. ||  SectionSchedule.Duration
|-
| <span title="This can be anything.">Description</span> || text || The description for this class. || SectionSchedule.Description
|-
| <span title="North Campus">Campus</span> || varchar(80) || The campus. || SectionSchedule.Campus
|-
| <span title="Building 3">Bldg</span> || varchar(80) || The building. || SectionSchedule.Bldg
|-
| <span title="Room 2">Room</span> || varchar(80) || The room. || SectionSchedule.Room
|}
|}
</div>
<br>
</div>
<!------------------------------------------------------- Staff Related  ------------------------------------------------------>
<div class="tcWidgetPage">
<big><i>More coming soon!</i></big>
</div>
</div>

Latest revision as of 18:48, 14 March 2025

TracCloud: Table and Field List

This article lists fields in TracCloud grouped by table. For each field, it will show the data type, description, how the field is accessible in Twig, the API, as well as how it displays in the SFTP data export.

Tips

  • Hover over the field name to see an example value.
  • Click the header to sort by that column, shift-click to sort by multiple.
Type Definitions


Invert All Visibility

Students
Toggle Visibility



Field Type Description Twig API SFTP Export
Sequence bigint Static identifier for students, unrelated to ID. Students.Sequence
UUID varchar(36) Unique identifier for this user. Students.UUID
ID bigint The student's ID number. Should be unique. {{Student.ID}} Students.ID StudentID
Other_ID varchar(40) Alternative identifier for the student. {{Student.Other_ID}} Students.Other_ID OtherID
Other_ID2 varchar(40) Another alternative identifier for the student. {{Student.Other_ID2}} Students.Other_ID2 OtherID2
Barcode varchar(80) The student's barcode. {{Student.Barcode}} Students.Barcode Barcode
Status varchar(80) Whether the student is Active or Inactive. {{Student.Status}} Students.Status Status
OtherStatus varchar(80) Alternative/custom status. Students.OtherStatus StudentOtherStatus
Legal_First varchar(80) The student's legal first name. {{Student.Legal_First}} Students.Legal_First LegalFirst
First Name varchar(80) The student's preferred first name. {{Student.First_Name}} Students.First_Name FirstName
Last Name varchar(80) The student's last name. {{Student.Last_Name}} Students.Last_Name LastName
Middle varchar(80) The student's middle name. {{Student.Middle}} Students.Middle Middle
Full_Name varchar(255) The student's full name, formatted as "Last, First M.". {{Student.Full_Name}} Students.Full_Name
LastFirst varchar(255) The student's full name, formatted as "Last, First M". {{Student.LastFirst}}
Full_Name2 varchar(255) The student's full name, formatted as "First M. Last". {{Student.Full_Name2}} Students.Full_Name2
FirstLast varchar(255) The student's full name, formatted as "First Last". {{Student.FirstLast}}
Street varchar(250) The student's street address. Students.Street Street
Apt varchar(80) The student's apartment number. Students.Apt
City varchar(120) The student's city. Students.City City
State varchar(80) The student's state. Students.State State
Zip varchar(20) The student's zip code. Students.Zip ZIP
Home_Phone varchar(80) The student's home phone number. {{Student.Home_Phone}} Students.Home_Phone HomePhone
Work_Phone varchar(80) The student's work phone number. {{Student.Work_Phone}} Students.Work_Phone WorkPhone
Cell_Phone varchar(80) The student's cell phone number. {{Student.Cell_Phone}} Students.Cell_Phone CellPhone
Email varchar(120) The student's email address, typically their campus email. {{Student.Email}} Students.Email Email
Preferred varchar(80) The student's preferred contact method. Possible values are listed below.


1 = Home
2 = Work
3 = Cell
4 = Email
5 = Verbal

 {{Student.Preferred}} Students.Preferred
LastDateIn date Date of the student's last visit. Students.LastDateIn
UserName varchar(120) The student's username for authentication. {{Student.UserName}} Students.UserName StudentUserName
Birthdate date The student's birthdate. Students.Birthdate Birthdate
Pronouns varchar(80) The student's preferred pronouns. {{Student.Pronouns}} Students.Pronouns StudentPronouns
Gender varchar(80) The student's gender. {{Student.Gender}} Students.Gender Gender
Ethnicity varchar(150) The student's ethnicity. {{Student.Ethnicity}} Students.Ethnicity Ethnicity
Major varchar(120) The student's major. {{Student.Major}} Students.Major Major
Class varchar(80) The student's class. {{Student.Class}} Students.Class Class
DegreeGoal varchar(80) The student's degree goal. {{Student.DegreeGoal}} Students.DegreeGoal DegreeGoal
Cohort varchar(80) The student's cohort. {{Student.Cohort}} Students.Cohort Cohort
College varchar(80) The student's college. {{Student.College}} Students.College College
Grad_Und varchar(80) The student's graduate status. {{Student.Grad_Und}} Students.Grad_Und GradUndergrad
GPA double The student's GPA. {{Student.GPA}} Students.GPA GPA
AccumHours double The student's accumulated hours. Students.AccumHours Hours
Fund varchar(80) The student's fund. Students.Fund StudentFund
PrimaryConsultantID bigint Relates to Staff.Sequence. Students.PrimaryConsultantID
FlagText varchar(80) The contents of the student's "Flag Information" field. Students.FlagText
CustomData json All custom fields are stored in this field. Specify a custom field with its sequence number after "cf_". {{Student.CustomData.cf_123}} Students.CustomData->>``$.cf_123`` [Field Name]
WatchLists json Returns a true or false value based on whether or not the student is on the specified watch list. Hover over the name of your watch list to find its sequence number (e.g., wl_9) {{Student.WatchLists.wl_0}}
gen_BIOConfirmed varchar(2) Whether or not the student has confirmed their bio. Students.gen_BIOConfirmed
gen_BIOConfirmedDT varchar(20) When the student last confirmed their bio. Students.gen_BIOConfirmedDT
CreatedDT timestamp When this student record was initially created in TracCloud. Students.CreatedDT
_LastImportedDT datetime The last time this student record was imported into TracCloud. Students._LastImportedDT


Visits
Toggle Visibility



Field Type Description Twig API SFTP Export
Sequence bigint A unique identifier for every visit record. Visits.Sequence VisitID
EnteredDT datetime The date and time the student entered the center. This will only differ from TimeIn if your center tracks wait time. {{Visit.EnteredDT}} Visits.EnteredDT
EnteredTime time The time the student entered, formatted as "09:45am." {{Visit.EnteredTime}}
EnteredDate time The date the student entered. {{Visit.EnteredDate}}
TimeIn datetime The date and time the student's visit began. {{Visit.TimeIn}} Visits.TimeIn DateIn and TimeIn
StartTime time The time the student's visit began, formatted as "09:45am." {{Visit.StartTime}}
StartDate time The datethe student's visit began. {{Visit.StartDate}}
TimeOut datetime The date and time the student's visit ended. {{Visit.TimeOut}} Visits.TimeOut TimeOut
EndTime time The time the student's visit ended, formatted as "09:45am." {{Visit.EndTime}}
EndDate time The datethe student's visit ended. {{Visit.EndDate}}
isWork tinyint Whether or not this visit is a work visit. {{Visit.isWork}} Visits.isWork
StudentID bigint Relates to Students.Sequence (not Students.ID). Visits.StudentID
CenterID bigint Relates to Centers.Sequence Visits.CenterID
ConsultantID bigint Relates to Staff.Sequence Visits.ConsultantID
RegistrationID bigint Relates to Registrations.Sequence Visits.RegistrationID
ReasonID bigint Relates to Reasons.Sequence Visits.ReasonID
isWaiting tinyint Whether or not the student is currently waiting to be seen (i.e., TimeIn not yet started). Visits.isWaiting
WaitTime double How long the student waited to start their visit in minutes (TimeIn - EnteredDT). {{Visit.WaitTime}} Visits.WaitTime WaitTime
Duration int The length of the student's visit in minutes. {{Visit.Duration}} Visits.Duration Duration
TotalTime double The total visit time (WaitTime + Duration). {{Visit.TotalTime}} Visits.TotalTime TotalTime
CustomData json All custom fields are stored in this field. Specify a custom field with its sequence number after "cf_". {{Visit.CustomData.cf_123}} Visits.CustomData->>``$.cf_123`` [Field Name]
isTerminated tinyint Whether or not this visit was automatically terminated by TracCloud. Visits.isTerminated
Fund varchar(80) The fund for this visit. {{Visit.Fund}} Visits.Fund Fund
CtrNotes text The notes field filled in by staff/consultants in TracCloud. {{Visit.CtrNotes}} Visits.CtrNotes VisitNotes
SurveyRespID bigint Relates to Responses.Sequence. Visits.SurveyRespID
TermID bigint Relates to Terms.Sequence. Visits.TermID VisitTermCode (displays Terms.TermCode)
SectionID bigint Relates to Sections.Sequence. Visits.SectionID
Location varchar(512) The location of the visit. {{Visit.Location}} Visits.Location Location
Online tinyint Whether or not the visit was online. {{Visit.Online}} Visits.Online Online
TimeZone varchar(120) The time zone of this visit's time. Visits.TimeZone
VisitDay varchar(20) The day of week the visit took place. {{Visit.Day}} Visits.VisitDay Weekday


Appointments
Toggle Visibility



Field Type Description Twig API SFTP Export
Sequence bigint A unique identifier for each appointment record. Appointments.Sequence ApptID
StartDT datetime The appointment start date and time. {{Appointment.StartDT}} Appointments.StartDT DateIn and TimeIn
StartTime time The appointment start time, formatted as "02:00pm". {{Appointment.StartTime}}
DisplayTime time The appointment start time, formatted as 200p. {{Appointment.DisplayTime|raw}}
StartDate date The appointment start date, formatted as "01/31/25". {{Appointment.StartDate}}
DisplayDate date The appointment start date, formatted as "Fri, Jan 31". {{Appointment.DisplayDate}}
Duration double The length of the appointment in minutes. {{Appointment.Duration}} Appointments.Duration Duration
EndDT datetime The appointment end date and time. {{Appointment.EndDT}} Appointments.EndDT TimeOut
EndTime time The appointment end time. {{Appointment.EndTime}}
EndDate date The appointment end date. {{Appointment.EndDate}}
Day varchar The appointment day of week. {{Appointment.Day}} Weekday
Link varchar A link to the appointment record in TracCloud. {{Appointment.Link}}
StudentID bigint Relates to Students.Sequence (not Students.ID). Appointments.StudentID
ConsultantID bigint Relates to Staff.Sequence. Appointments.ConsultantID
VisitID bigint Relates to Visits.Sequence. Appointments.VisitID
CenterID bigint Relates to Centers.Sequence. Appointments.CenterID
ReasonID bigint Relates to Reasons.Sequence. Appointments.ReasonID
SectionID bigint Relates to Sections.Sequence. Appointments.SectionID
AvailRecID bigint Relates to AvailBlocks.Sequence. Appointments.AvailRecID
RecurID bigint Recurring appointments that are part of the same series (e.g., weekly at 2pm) will have a matching RecurID. Appointments.RecurID
Status varchar(80) The status of the appointment. {{Appointment.Status}} Appointments.Status ApptStatus
Location varchar(512) The location of the appointment, can either be an in-person location or an online link. {{Appointment.Location}} Appointments.Location Location
Fund varchar(80) The appointment fund. {{Appointment.Fund}} Appointments.Fund Fund
Online int Whether or not the appointment is online. {{Appointment.Online}} Appointments.Online Online (displays as "Yes" or blank)
OnlineURL varchar(512) The online meeting link for the appointment. This will be blank for in-person appointments. The Twig tag will contain a TracCloud link that tracks attendance when the student joins rather than a direct link to the meeting room. {{Appointment.OnlineLink}} Appointments.OnlineURL ApptOnlineURL
OtherNotes text Student cancellation reason. {{Appointment.OtherNotes}} Appointments.OtherNotes OtherNotes
Type varchar The type of appointment. 1-on-1, Group, etc. {{Appointment.Type}} ApptType
Icon An icon that indicates the appointment type, such as . {{Appointment.Icon|raw}}
hasDocument varchar Whether or not the appointment has a document uploaded, displayed as "true" or "false". {{Appointment.hasDocument}}
OnlineText varchar If the appointment is online, this tag will display as "Online", otherwise it will be blank. {{Appointment.OnlineText}}
isRecurring varchar Whether or not the appointment is recurring, displayed as "true" or "false". {{Appointment.isRecurring}}
RecurringDates varchar An array of recurring appointments in the series. {{Appointment.RecurringDates}}
recurFirstDate date The first date of a recurring appointment series. {{Appointment.recurFirstDate}}
recurLastDate date The last date of a recurring appointment series. {{Appointment.recurLastDate}}
isCancelled varchar Whether or not the appointment is currently canceled, displayed as "true" or "false". {{Appointment.isCanceled}}
isMissed varchar Whether or not the appointment is currently missed, displayed as "true" or "false". {{Appointment.isMissed}}
autoCanceled varchar Whether or not the appointment was automatically canceled due to max cancel/missed in recurring series rules, displayed as "true" or "false". {{Appointment.autoCanceled}}
SchedDT datetime The date and time this appointment was scheduled. {{Appointment.SchedDT}} Appointments.SchedDT ApptScheduledDT
SchedModDT datetime The date and time this appointment was last modified {{Appointment.SchedModDT}} Appointments.SchedModDT ApptModifiedDT
SchedUser varchar(80) The user who originally scheduled this appointment. {{Appointment.SchedUser}} Appointments.SchedUser ScheduledBy
SchedNotes text Unused. SchedNotes
SurveyRespID bigint Relates to Responses.Sequence. Appointments.SurveyRespID
CustomData json All custom fields are stored in this field. Specify a custom field with its sequence number after "cf_". {{Appointment.CustomData.cf_123}} Appointments.CustomData->>``$.cf_123`` [Field Name]
SchedModBy varchar(80) The user who last edited the appointment. {{Appointment.SchedModBy}} Appointments.SchedModBy ApptModifiedBy


Availabilities
Toggle Visibility



Field Type Description Twig API
Sequence bigint A unique identifier for every availability record. AvailBlocks.Sequence
FromDT datetime The starting date and time of this availability block. AvailBlocks.FromDT
ToDT datetime The ending date and time of this availability block. AvailBlocks.ToDT
Increments varchar(5) The increment duration in minutes. AvailBlocks.Increments
Breaks varchar(5) The delay between increments in minutes. AvailBlocks.Breaks
DAYS varchar(30) Which days of the week this availability is available on. AvailBlocks.Days
isAvail int 0 = Reserve block, 1 = Regular availability, 2 = Stacked availability. {{AvailBlock.isAvail}} AvailBlocks.isAvail
BlockType varchar(256) Reserve block description. AvailBlocks.BlockType
BlockStatus varchar(80) Reserve block appointment status. AvailBlocks.BlockStatus
MaxStudents int The number of available slots at this time. {{AvailBlock.MaxStudents}} AvailBlocks.MaxStudents
ConsultantID bigint Relates to Staff.Sequence. AvailBlocks.ConsultantID
CenterID bigint Relates to Centers.Sequence. AvailBlocks.CenterID
ReasonID bigint Relates to Reasons.Sequence. AvailBlocks.ReasonID
SectionID bigint Relates to Sections.Sequence. AvailBlocks.SectionID
AvailSubj varchar(256) The availability subject, including wildcard entries. AvailBlocks.AvailSubj
RecurType The type of recurring appointment. The possible options are listed below.


None
Daily
Weekly
Bi-Weekly
Optional Daily
Optional Weekly
Optional Bi-Weekly
Optional Daily Chosen
Optional Weekly Chosen
Optional Bi-Weekly Chosen

 AvailBlocks.RecurType
Location varchar(512) The in-person location for this availability. AvailBlocks.Location
OnlineURL varchar(512) The online location for this availability. AvailBlocks.OnlineURL
Fund varchar(80) The availability fund. AvailBlocks.Fund
isInperson tinyint Whether or not the availability is in-person. AvailBlocks.isInperson
isOnline tinyint Whether or not the availability is online. AvailBlocks.isOnline
isAsynch tinyint Whether or not the availability is asynchronous. AvailBlocks.isAsync
defLocChoice int The default location choice. 0 = in-person, 1 = online, 2 = asynchronous. AvailBlocks.defLocChoice
isMeeting tinyint Whether or not a reserve block is designated as as meeting block. AvailBlocks.isMeeting


Course Related (Courses, Sections, Terms, Registrations, Faculty, SectionSchedule)
Toggle Visibility



Courses
Field Type Description Twig API SFTP Export
Sequence bigint A unique identifier for every course.
Subject varchar(40) The subject. {{Course.Subject}} Courses.Subject Subject
Course varchar(20) The course number. {{Course.Course}} Courses.Course Course
Title varchar(120) The course title. {{Course.Title}} Courses.Title Title
ExcludeFromCharts tinyint Whether or not this course is configured to be excluded from charts. Courses.ExcludeFromCharts
Dept varchar(40) The assigned department for this course. Courses.Dept
SubjectCourse varchar(200) Combination of Subject and Course in one field. {{Course.SubjectCourse}} Courses.SubjectCourse
SubjectCourseTitle varchar Combination of Subject, Course, and Title in one field. {{Course.SubjectCourseTitle}}
_LastImportedDT datetime The date and time this record was last imported. Courses._LastImportedDT
CustomData json All custom fields are stored in this field. Specify a custom field with its sequence number after "cf_". {{Course.CustomData.cf_123}} Courses.CustomData->>``$.cf_123`` [Field Name]
RelatedCoursesID varchar(20) The course family identifer. Courses.RelatedCoursesID
Sections
Field Type Description Twig API SFTP Export
Sequence bigint A unique identifier for each section. Sections.Sequence
Inactive tinyint Whether or not this section is currently inactive. Sections.Inactive
Code varchar(80) The section code/number. {{Section.Code}} Sections.Code Section
CourseID bigint Relates to Courses.Sequence. Sections.CourseID
GradeGroupID bigint Relates to GradeGroups.Sequence. Sections.GradeGroupID
CRN varchar(80) The CRN of this section record. {{Section.CRN}} Sections.CRN CRN
TermID bigint Relates to Terms.Sequence (not Terms.TermCode). Sections.TermID
FacultyID bigint Relates to Sections.FacultyID (not Faculty.UserID). Sections.FacultyID
nonEnrolled tinyint Whether or not this is a non-enrolled course. Sections.nonEnrolled
CustomData json All custom fields are stored in this field. Specify a custom field with its sequence number after "cf_". {{Section.CustomData.cf_123}} Sections.CustomData->>``$.cf_123`` [Field Name]
CreatedDT timestamp When this section record was initially created. Sections.CreatedDT
ignoreRegImportDeactivate tinyint Whether or not this section is configured to ignore deactivations. Sections.ignoreRegImportDeactivate
Credits double The potential credits for this section. Sections.Credits
_LastImportedDT datetime The latest date and time this record was imported into TracCloud. Sections._LastImportedDT
Title varchar(120) This optional field overrides Courses.Title if present. {{Section.Title}} Sections.Title
Terms
Field Type Description Twig API SFTP Export
Sequence bigint A unique identifer for this term record. Terms.Sequence
Active tinyint Whether or not this term is currently active. Terms.Active
TermCode varchar(80) The term/semester code. {{Term.TermCode}} Terms.TermCode Term
ActiveFrom date The start date of this term. Terms.ActiveFrom
ActiveTo date The end date of this term. Terms.ActiveTo
Registrations
Field Type Description Twig API SFTP Export
Sequence bigint A unique identifier for this registration record. Registrations.Sequence
Inactive tinyint Whether or not this registration is currently inactive. Registrations.Inactive
OverrideDate tinyint Whether or not this registration is configured with a date override. Registrations.OverrideDate
SectionID bigint Relates to Sections.Sequence. Registrations.SectionID
StudentID bigint Relates to Students.Sequence (not Students.ID). Registrations.StudentID
Grade varchar(40) The registration grade. Registrations.Grade
ValidFromDT datetime The start date of this registration. Registrations.ValidFromDT
ValidToDT datetime The end date of this registration. Registrations.ValidToDT
Notes text The registration notes field. Registrations.Notes
CustomData json All custom fields are stored in this field. Specify a custom field with its sequence number after "cf_". {{Registration.CustomData.cf_123}} Registrations.CustomData->>``$.cf_123`` [Field Name]
_LastImportedDT datetime The latest date and time this record was imported into TracCloud. Registrations._LastImportedDT
RegStatus varchar(40) The registration status (dropped, withdrawn, enrolled, etc). Registrations.RegStatus RegistrationStatus
EarnedCredits double The student's earned credits in this enrollment. Registrations.EarnedCredits
Faculty
Field Type Description Twig API SFTP Export
Sequence bigint Static identifier for faculty, unrelated to UserID. Faculty.Sequence
UUID varchar(36) Unique identifer for faculty records. Faculty.UUID
FirstName varchar(80) The faculty member's first name. {{Faculty.FirstName}} Faculty.FirstName FacultyFirst
LastName varchar(80) The faculty member's last name. {{Faculty.LastName}} Faculty.LastName FacultyLast
UserID varchar(80) The faculty member's ID number. {{Faculty.UserID}} Faculty.UserID FacultyUserID
UserName varchar(80) The faculty member's username for authentication. {{Faculty.UserName}} Faculty.UserName FacultyUserName
Salutation varchar(40) The faculty member's salutation (e.g., Dr.). {{Faculty.Salutation}} Faculty.Salutation Salutation
Department varchar(60) The faculty member's department. {{Faculty.Department}} Faculty.Department FacultyDepartment
Inactive tinyint Whether or not this faculty is currently inactive. Faculty.Inactive
Phone varchar(80) The faculty member's phone number. {{Faculty.Phone}} Faculty.Phone
Email varchar(120) The faculty member's email address. {{Faculty.Email}} Faculty.Email FacultyEmail
CustomData json All custom fields are stored in this field. Specify a custom field with its sequence number after "cf_". {{Faculty.CustomData.cf_123}} Faculty.CustomData->>``$.cf_123`` [Field Name]
OtherID varchar(80) An alternate hidden identifier for faculty. This is typically left blank. Faculty.OtherID
FullName varchar(255) Combination of FirstName, LastName, and Saltuation in one field. {{Faculty.FullName}} Faculty.FullName
_LastImportedDT datetime The latest date and time this record was imported into TracCloud. Faculty._LastImportedDT
SectionSchedule
Field Type Description API
Sequence bigint A unique identifer for this section schedule record. SectionSchedule.Sequence
SectionID bigint Relates to Sections.Sequence (not Sections.Code). SectionSchedule.SectionID
Days varchar(30) Which days this class takes place on. SectionSchedule.Days
Time time What time the class starts. SectionSchedule.Time
Duration int The duration of the class in minutes. SectionSchedule.Duration
Description text The description for this class. SectionSchedule.Description
Campus varchar(80) The campus. SectionSchedule.Campus
Bldg varchar(80) The building. SectionSchedule.Bldg
Room varchar(80) The room. SectionSchedule.Room


More coming soon!

Retrieved from "https://wiki.go-redrock.com/index.php?title=TracCloud:_Rosetta&oldid=12205"