TracCloud: Rosetta: Difference between revisions
From Redrock Wiki
No edit summary |
No edit summary |
||
(10 intermediate revisions by the same user not shown) | |||
Line 47: | Line 47: | ||
<div class="tcWidgetPage" style="margin:1%;"> | <div class="tcWidgetPage" style="margin:1%;"> | ||
<div class="mw-customtoggle-1 mw-customtoggle-2 mw-customtoggle-3 mw-customtoggle-4" style="float: left; color: white; background-color: grey; border: 3px solid grey; font-weight: bold; border-radius: 5px">'''Invert All Visibility'''</div><br> | <div class="mw-customtoggle-1 mw-customtoggle-2 mw-customtoggle-3 mw-customtoggle-4 mw-customtoggle-5 mw-customtoggle-6 mw-customtoggle-7" 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> | ||
</div> | </div> | ||
Line 55: | Line 55: | ||
<div class="tcWidgetPage"> | <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 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"> | <div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-1"> | ||
<br><br> | <br><br> | ||
{| class="wikitable sortable" style="min-width: 100%; font-size: 15px" | {| class="wikitable sortable" style="min-width: 100%; font-size: 15px" | ||
Line 165: | Line 165: | ||
<div class="tcWidgetPage"> | <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 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"> | <div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-2"> | ||
<br><br> | <br><br> | ||
{| class="wikitable sortable" style="min-width: 100%; font-size: 15px" | {| class="wikitable sortable" style="min-width: 100%; font-size: 15px" | ||
Line 240: | Line 240: | ||
<div class="tcWidgetPage"> | <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 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"> | <div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-3"> | ||
<br><br> | <br><br> | ||
{| class="wikitable sortable" style="min-width: 100%; font-size: 15px" | {| class="wikitable sortable" style="min-width: 100%; font-size: 15px" | ||
Line 338: | Line 338: | ||
</div> | </div> | ||
<!------------------------------------------------------- AvailBlocks------------------------------------------------------> | |||
<!------------------------------------------------------- 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 style="float: left;"><big><b> | <div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-4"> | ||
<div class="mw-collapsible" id="mw-customcollapsible-4"> | |||
<br><br> | <br><br> | ||
{| class="wikitable sortable" style="min-width: 100%; font-size: 15px" | {| class="wikitable sortable" style="min-width: 100%; font-size: 15px" | ||
Line 360: | Line 359: | ||
| <span title="MONWEDFRI">DAYS</span> || varchar(30) || Which days of the week this availability is available on. || || AvailBlocks.Days | | <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. | | <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="Scheduled off for Holiday.">BlockType</span> || varchar(256) || Reserve block description. || || AvailBlocks.BlockType | ||
Line 378: | Line 377: | ||
| <span title="ACTG100*">AvailSubj</span> || varchar(256) || The availability subject, including wildcard entries. || || AvailBlocks.AvailSubj | | <span title="ACTG100*">AvailSubj</span> || varchar(256) || The availability subject, including wildcard entries. || || AvailBlocks.AvailSubj | ||
|- | |- | ||
| <span title=" | | <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 mw-collapsed" 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=" | | <span title="Building 3">Bldg</span> || varchar(80) || The building. || SectionSchedule.Bldg | ||
|- | |||
<span title=" | | <span title="Room 2">Room</span> || varchar(80) || The room. || SectionSchedule.Room | ||
|} | |} | ||
</div> | </div> | ||
<br> | <br> | ||
</div> | </div> | ||
--> | |||
<!------------------------------------------------------- Staff/Consultants------------------------------------------------------> | |||
<div class="tcWidgetPage"> | |||
<div style="float: left;"><big><b>Staff/Consultants</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-6">Toggle Visibility</div> | |||
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-6"> | |||
<br><br> | |||
In the table below you will notice that there are two Twig tags available for each field. Depending on where you are using these tags, one or the other needs to be used. Tags with the "Staff" prefix should be used in [[TracCloud:_Workshops|Workshop descriptions and notifications]], [[TracCloud:_Announcements|announcements]], [[TracCloud:_Confirm_Bio|staff bio on search availability]], and the [[TracCloud:_Welcome_Messages|staff welcome message]]. The tags with the "Consultant" prefix should be used everywhere else. | |||
{| 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 || Static identifer for staff. || || Staff.Sequence || | |||
|- | |||
| <span title="1a23b4c5-6789-01d2-ef3g-456h78901ijk">UUID</span> || varchar(36) || Unique Identifer for each user. || || Staff.UUID || | |||
|- | |||
| <span title="Jane">First_Name</span> || varchar(80) || The staff member's first name. || <nowiki>{{Consultant.First_Name}}</nowiki><br><nowiki>{{Staff.First_Name}}</nowiki> || Staff.First_Name || ConsultantFirst | |||
|- | |||
| <span title="Doe">Last_Name</span> || varchar(80) || The staff member's last name. || <nowiki>{{Consultant.Last_Name}}</nowiki><br><nowiki>{{Staff.Last_Name}}</nowiki> || Staff.Last_Name || ConsultantLast | |||
|- | |||
| <span title="Doe, Jane">LastFirst</span> || varchar(255) || The staff member's full name, formatted as "Last, First". || <nowiki>{{Consultant.LastFirst}}</nowiki><br><nowiki>{{Staff.LastFirst}}</nowiki> || Staff.LastFirst || | |||
|- | |||
| <span title="Jane Doe">FirstLast</span> || varchar(255) || The staff member's full name, formatted as "First Last". || <nowiki>{{Consultant.FirstLast}}</nowiki><br><nowiki>{{Staff.FirstLast}}</nowiki> || Staff.FirstLast || | |||
|- | |||
| <span title="Jan">Alias</span> || varchar(120) || The staff member's alias/alternative name. || <nowiki>{{Consultant.Alias}}</nowiki><br><nowiki>{{Staff.Alias}}</nowiki> || Staff.Alias || ConsultantAlias | |||
|- | |||
| <span title="jdoe123@example.edu">Email</span> || varchar(120) || The staff member's email address. || <nowiki>{{Consultant.Email}}</nowiki><br><nowiki>{{Staff.Email}}</nowiki> || Staff.Email || ConsultantEmail | |||
|- | |||
| <span title="jdoe123">UserName</span> || varchar(80) || The staff member's username. This typically matches Students.Username if the user has both account types. || <nowiki>{{Consultant.UserName}}</nowiki><br><nowiki>{{Staff.UserName}}</nowiki> || Staff.UserName || ConsultantUserName | |||
|- | |||
| <span title="2">UserLevel</span> || int || The staff member's [[TracCloud:_Staff_User_Level|user level]]. The possible options are listed below. <p style="line-height: 95%; font-size: 15px"><br>0 = Staff<br>1 = SysAdmin<br>2 = Profile Admin</p> || || Staff.UserLevel || | |||
|- | |||
| <span title="2025-03-17 10:21:34">LastAccess</span> || datetime || Date and time this staff member last logged into TracCloud. || || Staff.LastAccess || | |||
|- | |||
| <span title="1234">GroupID</span> || bigint || The staff member's permission group, relates to Groups.Sequence. || || Staff.GroupID || | |||
|- | |||
| <span title="0">isKiosk</span> || tinyint || Whether or not this staff account is configured to be a kiosk account. || || Staff.isKiosk || | |||
|- | |||
| <span title="1">isConsultant</span> || tinyint || Whether or not this staff account is configured to be a consultant account. || || Staff.isConsultant || | |||
|- | |||
| <span title="0">Inactive</span> || tinyint || Whether or not this account is inactive. || || Staff.Inactive || | |||
|- | |||
| <span title="555-555-5555">Phone</span> || varchar(30) || The staff member's phone number. || <nowiki>{{Consultant.Phone}}</nowiki><br><nowiki>{{Staff.Phone}}</nowiki> || Staff.Phone || | |||
|- | |||
| <span title="555-555-5555">CellPhone</span> || varchar(80) || The staff member's cell phone number. || <nowiki>{{Consultant.CellPhone}}</nowiki><br><nowiki>{{Staff.CellPhone}}</nowiki> || Staff.CellPhone || | |||
|- | |||
| <span title="555-555-5555">WorkPhone</span> || varchar(80) || The staff member's work phone number. || <nowiki>{{Consultant.WorkPhone}}</nowiki><br><nowiki>{{Staff.WorkPhone}}</nowiki> || Staff.WorkPhone || | |||
|- | |||
| <span title="1234 E Example St.">Address</span> || varchar(80) || The staff member's street address. || || Staff.Address || | |||
|- | |||
| <span title="Tempe">City</span> || varchar(120) || The staff member's city. || || Staff.City || | |||
|- | |||
| <span title="AZ">State</span> || varchar(80) || The staff member's state. || || Staff.State || | |||
|- | |||
| <span title="85210">Zip</span> || varchar(20) || The staff member's zip/post code. || || Staff.Zip || | |||
|- | |||
| <span title="1234">CourseListID</span> || bigint || Relates to CourseList.Sequence || || Staff.CourseListID || | |||
|- | |||
| <span title="Room 201">Location</span> || varchar(512) || The staff member's assigned in-person location. || || Staff.Location || ConsultantLocation | |||
|- | |||
| <span title="https://zoom.us/example">OnlineLink</span> || varchar(512) || The staff member's assigned online URL. || || Staff.OnlineLink || ConsultantOnlineLink | |||
|- | |||
| <span title="FWS">Fund</span> || varchar(80) || The staff member's assigned fund. || || Staff.Fund || ConsultantFund | |||
|- | |||
| <span title="1234">PayCodeID</span> || bigint || Relates to PayCodes.Sequence. || || Staff.PayCodeID || | |||
|- | |||
| <span title="2025-01-31">Hired</span> || date || The date this staff member was hired. || || Staff.Hired || ConsultantHired | |||
|- | |||
| <span title="2025-02-01">Terminated</span> || date || The date this staff member's employment was terminated. || || Staff.Terminated || ConsultantTerminated | |||
|- | |||
| <span title="Gave notice due to leaving state.">ReasonQuit</span> || varchar(220) || The reason for employment termination. || || Staff.ReasonQuit || ConsultantReasonQuit | |||
|- | |||
| <span title="201">Mailbox</span> || varchar(80) || The staff member's mailbox. || || Staff.Mailbox || | |||
|- | |||
| <span title="1234">CenterID</span> || bigint || The staff member's default center. Relates to Centers.Sequence. || || Staff.CenterID || Mailbox | |||
|- | |||
| <span title="0">noShowOnSched</span> || tinyint || Whether or not this staff member has been configured to not show on the schedule. || || Staff.noShowOnSched || | |||
|- | |||
| <span title="Peer tutor referal from Dave Smith.">Notes</span> || text || The staff member's notes field. || || Staff.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>{{Consultant.CustomData.cf_123}}</nowiki><br><nowiki>{{Staff.CustomData.cf_123}}</nowiki> || Staff.CustomData->>``$.cf_123`` || [Field Name] | |||
|- | |||
| <span title="A12345">OtherID</span> || varchar(80) || The staff member's alternate/other ID. || || Staff.OtherID || ConsultantOtherID | |||
|- | |||
| <span title="Jane Doe is a Peer Tutor who specializes in...">StaffBIO</span> || text || The staff member's bio text. || <nowiki>{{Consultant.StaffBIO|raw}}</nowiki><br><nowiki>{{Staff.StaffBIO|raw}}</nowiki>|| Staff.StaffBIO || | |||
|- | |||
| <span title="She/Her">Pronouns</span> || varchar(80) || The staff member's preferred pronouns. || <nowiki>{{Consultant.Pronouns}}</nowiki><br><nowiki>{{Staff.Pronouns}}</nowiki> || Staff.Pronouns || ConsultantPronouns | |||
|- | |||
| <span title="2025-01-31 14:30:26">CreatedDT</span> || datetime || The date that this staff record was created. || || Staff.CreatedDT || | |||
|- | |||
| <span title="2025-03-15 04:30:01">_LastImportedDT</span> || datetime || The date that this staff record was last imported (only applicable if importing staff). || || Staff._LastImportedDT || | |||
|- | |||
| <span title="AAA">KioskSort</span> || varchar(10) || The staff member's sort code. || || Staff.KioskSort || | |||
|- | |||
| <span title="1234">SupervisorID</span> || int || The staff member's assigned supervisor. Relates to Staff.Sequence. || || Staff.SupervisorID || | |||
|- | |||
| <span title="Peer Tutor">TitleOrPosition</span> || varchar(80) || The staff member's title/position. || || Staff.TitleOrPosition || | |||
|- | |||
| <span title="N/A">Photo</span> || || The staff member's photo. || <nowiki>{{Consultant.StaffBIO|raw}}</nowiki> || || | |||
|} | |||
</div> | |||
<br> | |||
</div> | |||
<!------------------------------------------------------- Centers, Profiles, Groups, Reasons ------------------------------------------------------> | |||
<div class="tcWidgetPage"> | |||
<div style="float: left;"><big><b>Profile Related</b> (Profiles, Centers, Reasons, Groups)</big></div><div style="float: right; color: white; background-color: grey; border: 3px solid grey; font-weight: bold; border-radius: 5px" class="mw-customtoggle-7">Toggle Visibility</div> | |||
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-7"> | |||
<br><br> | |||
{| class="wikitable sortable" style="min-width: 100%; font-size: 15px" | |||
|+ Profiles | |||
|- | |||
! <b>Field</b> !! <b>Type</b> !! <b>Description</b> !! <b>API</b> | |||
|- | |||
| <span title="1234">Sequence</span> || bigint || Unique identifer for each profile. || Profiles.Sequence | |||
|- | |||
| <span title="1">Type</span> || int || The type of profile. Possible values are listed below.<p style="line-height: 95%; font-size: 15px"><br>1 = TutorTrac<br>2 = AdvisorTrac<br>3 = FitnessTrac</p> || Profiles.Type | |||
|- | |||
| <span title="Redrock University">Name</span> || varchar(80) || The name of the profile. || Profiles.Name | |||
|- | |||
| <span title="0">Inactive</span> || tinyint || Whether or not this profile is currently inactive. || Profiles.Inactive | |||
|- | |||
| <span title="1234">ContactID</span> || bigint || The main contact for this profile. Relates to Staff.Sequence. || Profiles.ContactID | |||
|- | |||
| <span title="Tutors">NameForConsultant</span> || varchar(80) || The name of the "consultant" user type in TracCloud. || Profiles.NameForConsultant | |||
|- | |||
| <span title="America/Phoenix">TimeZone</span> || varchar(120) || This profile's time zone. Uses system time zone if blank (which is common). || Profiles.TimeZone | |||
|} | |||
{| class="wikitable sortable" style="min-width: 100%; font-size: 15px" | |||
|+ Centers | |||
|- | |||
! <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 || Unique identifier for each center. || || Centers.Sequence || | |||
|- | |||
| <span title="Writing Center">Name</span> || varchar(80) || The name of the center. || <nowiki>{{Center.Name}}</nowiki> || Centers.Name || Centers | |||
|- | |||
| <span title="1234">CourseListID</span> || bigint || The center's linked course list, relates to CourseList.Sequence. || || Centers.CourseListID || | |||
|- | |||
| <span title="1234">ProfileID</span> || bigint || Which profile this center is linked to, relates to Profiles.Sequence. || || Centers.ProfileID || | |||
|- | |||
| <span title="0">Inactive</span> || tinyint || Whether or not this center is currently inactive. || || Centers.Inactive || | |||
|- | |||
| <span title="2025-03-11 10:40:47">UpdatedDT</span> || datetime || The last time this center record was modified. || || Centers.UpdatedDT || | |||
|- | |||
| <span title="1">IsWritingCenter</span> || tinyint || Whether or not this center has been configured to ignore consultant specialties. || || Centers.IsWritingCenter || | |||
|} | |||
{| class="wikitable sortable" style="min-width: 100%; font-size: 15px" | |||
|+ Reasons | |||
|- | |||
! <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 || Unique identifier for each reason. || || Reasons.Sequence || | |||
|- | |||
| <span title="1234">ProfileID</span> || bigint || Which profile this reason is linked to, relates to Profiles.Sequence. || || Reasons.ProfileID || | |||
|- | |||
| <span title="Essay Help">Reason</span> || varchar(80) || The name of the reason. || <nowiki>{{Reason.ReasonName}}</nowiki> || Reasons.Name || Reason | |||
|- | |||
| <span title="0">Inactive</span> || tinyint || Whether or not this reason is inactive. || || Reasons.Inactive || | |||
|- | |||
| <span title="0">isWork</span> || tinyint || Whether or not this reason is a [[TracCloud:_Payroll|work reason.]] || || Reasons.isWork || | |||
|- | |||
| <span title="AAA">SortCode</span> || varchar(40) || The sort code for this reason to override alphabetical sorting. || || Reasons.SortCode || | |||
|- | |||
| <span title="Writing">Category</span> || varchar(80) || The reason's category. || <nowiki>{{Reason.Category}}</nowiki> || Reasons.Category || | |||
|} | |||
{| class="wikitable sortable" style="min-width: 100%; font-size: 15px" | |||
|+ Groups | |||
|- | |||
! <b>Field</b> !! <b>Type</b> !! <b>Description</b> !! <b>API</b> | |||
|- | |||
| <span title="1234">Sequence</span> || bigint || Unique identifier for each group. || Groups.Sequence | |||
|- | |||
| <span title="Peer Tutors">GroupName</span> || varchar(80) || The name of the group. || Groups.GroupName | |||
|- | |||
| <span title="1234">ProfileID</span> || bigint || Which profile this group is assigned to, relates to Profiles.Sequence. || Groups.ProfileiD | |||
|} | |||
</div> | |||
<br> | |||
</div> | |||
<div class="tcWidgetPage"> | <div class="tcWidgetPage"> | ||
<big><i>More coming soon!</i></big> | <big><i>More coming soon!</i></big> | ||
</div> | </div> |
Latest revision as of 18:41, 18 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 | Description |
---|---|
varchar(#) | Alphanumeric field with a specified maximum length. |
int | Integer, maximum value of about 4 billion, or a 10-digit numeric value. |
bigint | Big integer, maximum value of about 9 quintillion, or a 16-digit numeric value. |
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). |
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 |
varchar(120) | The student's email address, typically their campus email. | {{Student.Email}} | Students.Email | ||
Preferred | varchar(80) | The student's preferred contact method. Possible values are listed below.
|
{{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 |
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 |
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 |
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.
|
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 |
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 |
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 |
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 |
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 |
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 | |
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 |
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 |
In the table below you will notice that there are two Twig tags available for each field. Depending on where you are using these tags, one or the other needs to be used. Tags with the "Staff" prefix should be used in Workshop descriptions and notifications, announcements, staff bio on search availability, and the staff welcome message. The tags with the "Consultant" prefix should be used everywhere else.
Field | Type | Description | Twig | API | SFTP Export |
---|---|---|---|---|---|
Sequence | bigint | Static identifer for staff. | Staff.Sequence | ||
UUID | varchar(36) | Unique Identifer for each user. | Staff.UUID | ||
First_Name | varchar(80) | The staff member's first name. | {{Consultant.First_Name}} {{Staff.First_Name}} |
Staff.First_Name | ConsultantFirst |
Last_Name | varchar(80) | The staff member's last name. | {{Consultant.Last_Name}} {{Staff.Last_Name}} |
Staff.Last_Name | ConsultantLast |
LastFirst | varchar(255) | The staff member's full name, formatted as "Last, First". | {{Consultant.LastFirst}} {{Staff.LastFirst}} |
Staff.LastFirst | |
FirstLast | varchar(255) | The staff member's full name, formatted as "First Last". | {{Consultant.FirstLast}} {{Staff.FirstLast}} |
Staff.FirstLast | |
Alias | varchar(120) | The staff member's alias/alternative name. | {{Consultant.Alias}} {{Staff.Alias}} |
Staff.Alias | ConsultantAlias |
varchar(120) | The staff member's email address. | {{Consultant.Email}} {{Staff.Email}} |
Staff.Email | ConsultantEmail | |
UserName | varchar(80) | The staff member's username. This typically matches Students.Username if the user has both account types. | {{Consultant.UserName}} {{Staff.UserName}} |
Staff.UserName | ConsultantUserName |
UserLevel | int | The staff member's user level. The possible options are listed below.
|
Staff.UserLevel | ||
LastAccess | datetime | Date and time this staff member last logged into TracCloud. | Staff.LastAccess | ||
GroupID | bigint | The staff member's permission group, relates to Groups.Sequence. | Staff.GroupID | ||
isKiosk | tinyint | Whether or not this staff account is configured to be a kiosk account. | Staff.isKiosk | ||
isConsultant | tinyint | Whether or not this staff account is configured to be a consultant account. | Staff.isConsultant | ||
Inactive | tinyint | Whether or not this account is inactive. | Staff.Inactive | ||
Phone | varchar(30) | The staff member's phone number. | {{Consultant.Phone}} {{Staff.Phone}} |
Staff.Phone | |
CellPhone | varchar(80) | The staff member's cell phone number. | {{Consultant.CellPhone}} {{Staff.CellPhone}} |
Staff.CellPhone | |
WorkPhone | varchar(80) | The staff member's work phone number. | {{Consultant.WorkPhone}} {{Staff.WorkPhone}} |
Staff.WorkPhone | |
Address | varchar(80) | The staff member's street address. | Staff.Address | ||
City | varchar(120) | The staff member's city. | Staff.City | ||
State | varchar(80) | The staff member's state. | Staff.State | ||
Zip | varchar(20) | The staff member's zip/post code. | Staff.Zip | ||
CourseListID | bigint | Relates to CourseList.Sequence | Staff.CourseListID | ||
Location | varchar(512) | The staff member's assigned in-person location. | Staff.Location | ConsultantLocation | |
OnlineLink | varchar(512) | The staff member's assigned online URL. | Staff.OnlineLink | ConsultantOnlineLink | |
Fund | varchar(80) | The staff member's assigned fund. | Staff.Fund | ConsultantFund | |
PayCodeID | bigint | Relates to PayCodes.Sequence. | Staff.PayCodeID | ||
Hired | date | The date this staff member was hired. | Staff.Hired | ConsultantHired | |
Terminated | date | The date this staff member's employment was terminated. | Staff.Terminated | ConsultantTerminated | |
ReasonQuit | varchar(220) | The reason for employment termination. | Staff.ReasonQuit | ConsultantReasonQuit | |
Mailbox | varchar(80) | The staff member's mailbox. | Staff.Mailbox | ||
CenterID | bigint | The staff member's default center. Relates to Centers.Sequence. | Staff.CenterID | Mailbox | |
noShowOnSched | tinyint | Whether or not this staff member has been configured to not show on the schedule. | Staff.noShowOnSched | ||
Notes | text | The staff member's notes field. | Staff.Notes | ||
CustomData | json | All custom fields are stored in this field. Specify a custom field with its sequence number after "cf_". | {{Consultant.CustomData.cf_123}} {{Staff.CustomData.cf_123}} |
Staff.CustomData->>``$.cf_123`` | [Field Name] |
OtherID | varchar(80) | The staff member's alternate/other ID. | Staff.OtherID | ConsultantOtherID | |
StaffBIO | text | The staff member's bio text. | {{Consultant.StaffBIO|raw}} {{Staff.StaffBIO|raw}} |
Staff.StaffBIO | |
Pronouns | varchar(80) | The staff member's preferred pronouns. | {{Consultant.Pronouns}} {{Staff.Pronouns}} |
Staff.Pronouns | ConsultantPronouns |
CreatedDT | datetime | The date that this staff record was created. | Staff.CreatedDT | ||
_LastImportedDT | datetime | The date that this staff record was last imported (only applicable if importing staff). | Staff._LastImportedDT | ||
KioskSort | varchar(10) | The staff member's sort code. | Staff.KioskSort | ||
SupervisorID | int | The staff member's assigned supervisor. Relates to Staff.Sequence. | Staff.SupervisorID | ||
TitleOrPosition | varchar(80) | The staff member's title/position. | Staff.TitleOrPosition | ||
Photo | The staff member's photo. | {{Consultant.StaffBIO|raw}} |
Field | Type | Description | API |
---|---|---|---|
Sequence | bigint | Unique identifer for each profile. | Profiles.Sequence |
Type | int | The type of profile. Possible values are listed below.
|
Profiles.Type |
Name | varchar(80) | The name of the profile. | Profiles.Name |
Inactive | tinyint | Whether or not this profile is currently inactive. | Profiles.Inactive |
ContactID | bigint | The main contact for this profile. Relates to Staff.Sequence. | Profiles.ContactID |
NameForConsultant | varchar(80) | The name of the "consultant" user type in TracCloud. | Profiles.NameForConsultant |
TimeZone | varchar(120) | This profile's time zone. Uses system time zone if blank (which is common). | Profiles.TimeZone |
Field | Type | Description | Twig | API | SFTP Export |
---|---|---|---|---|---|
Sequence | bigint | Unique identifier for each center. | Centers.Sequence | ||
Name | varchar(80) | The name of the center. | {{Center.Name}} | Centers.Name | Centers |
CourseListID | bigint | The center's linked course list, relates to CourseList.Sequence. | Centers.CourseListID | ||
ProfileID | bigint | Which profile this center is linked to, relates to Profiles.Sequence. | Centers.ProfileID | ||
Inactive | tinyint | Whether or not this center is currently inactive. | Centers.Inactive | ||
UpdatedDT | datetime | The last time this center record was modified. | Centers.UpdatedDT | ||
IsWritingCenter | tinyint | Whether or not this center has been configured to ignore consultant specialties. | Centers.IsWritingCenter |
Field | Type | Description | Twig | API | SFTP Export |
---|---|---|---|---|---|
Sequence | bigint | Unique identifier for each reason. | Reasons.Sequence | ||
ProfileID | bigint | Which profile this reason is linked to, relates to Profiles.Sequence. | Reasons.ProfileID | ||
Reason | varchar(80) | The name of the reason. | {{Reason.ReasonName}} | Reasons.Name | Reason |
Inactive | tinyint | Whether or not this reason is inactive. | Reasons.Inactive | ||
isWork | tinyint | Whether or not this reason is a work reason. | Reasons.isWork | ||
SortCode | varchar(40) | The sort code for this reason to override alphabetical sorting. | Reasons.SortCode | ||
Category | varchar(80) | The reason's category. | {{Reason.Category}} | Reasons.Category |
Field | Type | Description | API |
---|---|---|---|
Sequence | bigint | Unique identifier for each group. | Groups.Sequence |
GroupName | varchar(80) | The name of the group. | Groups.GroupName |
ProfileID | bigint | Which profile this group is assigned to, relates to Profiles.Sequence. | Groups.ProfileiD |
More coming soon!