TracCloud: Rosetta: Difference between revisions

From Redrock Wiki

No edit summary
No edit summary
 
(40 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 mw-customtoggle-8 mw-customtoggle-9 mw-customtoggle-10 mw-customtoggle-11 mw-customtoggle-12 mw-customtoggle-13 mw-customtoggle-14 mw-customtoggle-15" 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 256: Line 256:
| <span title="01/31/25">StartDate</span> || date || The appointment start date, formatted as "01/31/25". || <nowiki>{{Appointment.StartDate}}</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="Fri, Jan 31">DisplayDate</span> || date || The appointment start date, formatted as "Fri, Jan 31" or "Today" for same-day appointments. || <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="60">Duration</span> || double || The length of the appointment in minutes. || <nowiki>{{Appointment.Duration}}</nowiki> || Appointments.Duration || Duration
Line 288: Line 288:
| <span title="Attended">Status</span> || varchar(80) || The status of the appointment. || <nowiki>{{Appointment.Status}}</nowiki> || Appointments.Status || ApptStatus
| <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="Room 15">Location</span> || varchar(512) || The location of the appointment. This will be the in-person location if in-person or the availability's meeting link if online. For online sessions, you may want to use "OnlineLink" instead so TracCloud can track attendance.|| <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="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="0">Online</span> || int || Whether or not the appointment is online. Possible values are listed below.<p style="line-height: 95%; font-size: 15px"><br>0 = In-person<br>1 = Online<br>2 = Asynchronous<br>3 = Phone</p> || <nowiki>{{Appointment.Online}}</nowiki> || Appointments.Online || Appointment Meeting Type<br><br>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="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
Line 298: Line 298:
| <span title="Schedule conflict.">OtherNotes</span> || text || Student cancellation reason. || <nowiki>{{Appointment.OtherNotes}}</nowiki> || Appointments.OtherNotes || OtherNotes
| <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="Online 1-on-1">Type</span> || varchar || The type of appointment. 1-on-1 or Group. || <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="N/A">Icon</span> || || An icon that indicates the appointment type. {{#fas:user-group}} for in-person and {{#fas:wifi}} for online.  || <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="false">hasDocument</span> || varchar || Whether or not the appointment has a document uploaded, displayed as "true" or "false". || <nowiki>{{Appointment.hasDocument}}</nowiki> || ||  
Line 338: Line 338:
</div>
</div>


<!------------------------------------------------------- AvailBlocks------------------------------------------------------>
<div class="tcWidgetPage">
<div class="tcWidgetPage">
<div style="float: left;"><big><b>AvailBlocks</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>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">
<div class="mw-collapsible mw-collapsed" 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 358: 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.MaxStudents}}</nowiki> || AvailBlocks.isAvail
| <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 398: Line 399:
</div>
</div>


<!------------------------------------------------------- Course Related  ------------------------------------------------------>
<div class="tcWidgetPage">
<div class="tcWidgetPage">
<big><i>More coming soon!</i></big>
<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 ||
|-
| <span title="MAT350 2025SP">SubjectTermCode</span> || || Combination of Courses.SubjectCourse and Terms.TermCode. || <nowiki>{{Section.SubjectTermCode}}</nowiki> || ||
|-
| <span title="MAT300 Introduction to Calculus">SubjectTitle</span> || || Combination of Courses.SubjectCourse and Courses.Title. || <nowiki>{{Section.SubjectTitle}}</nowiki> || ||
|}
 
{| 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="Dr. Jane Doe">SalutationFullName</span> ||  || Combination of salutation and full name. || <nowiki>{{Faculty.SalutationFullName}}</nowiki>* || ||
|-
| <span title="Dr. Doe">SalutationLastName</span> ||  || Combination of salutation and last name. || <nowiki>{{Faculty.SalutationLastName}}</nowiki>* || ||
|-
| <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 ||
|}
* To reference the STEP faculty in [[TracCloud:_Work_Plans|work plans]] with Twig, the "StepFaculty" prefix should be used instead (e.g., <nowiki>{{StepFaculty.FirstName}}</nowiki>). The regular "Faculty" prefix shown above should be used everywhere else.
 
{| 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/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>
{| 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>* || Staff.First_Name || ConsultantFirst
|-
| <span title="Doe">Last_Name</span> || varchar(80) || The staff member's last name. || <nowiki>{{Consultant.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>* || Staff.LastFirst ||
|-
| <span title="Jane Doe">FirstLast</span> || varchar(255) || The staff member's full name, formatted as "First Last". || <nowiki>{{Consultant.FirstLast}}</nowiki>* || Staff.FirstLast ||
|-
| <span title="Jan">Alias</span> || varchar(120) || The staff member's alias/alternative name. || <nowiki>{{Consultant.Alias}}</nowiki>* || Staff.Alias || ConsultantAlias
|-
| <span title="jdoe123@example.edu">Email</span> || varchar(120) || The staff member's email address. || <nowiki>{{Consultant.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>* || 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>* || Staff.Phone ||
|-
| <span title="555-555-5555">CellPhone</span> || varchar(80) || The staff member's cell phone number. || <nowiki>{{Consultant.CellPhone}}</nowiki>* || Staff.CellPhone ||
|-
| <span title="555-555-5555">WorkPhone</span> || varchar(80) || The staff member's work phone number. || <nowiki>{{Consultant.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. || <nowiki>{{Consultant.Notes}}</nowiki>* || 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> || 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>* || Staff.StaffBIO ||
|-
| <span title="She/Her">Pronouns</span> || varchar(80) || The staff member's preferred pronouns. || <nowiki>{{Consultant.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.Photo|raw}}</nowiki>* || ||
|}
 
<b><nowiki>*</nowiki></b> Depending on the context, different table prefixes must be used for Twig tags specifically. Most Twig-supported locations throughout TracCloud use the "Consultant" table prefix shown above. Exceptions are listed below.<br>
* "Staff" (e.g., <nowiki>{{Staff.First_Name}}</nowiki>) should be used in: [[TracCloud:_Workshops|Workshop descriptions and notifications]], [[TracCloud:_Announcements|announcements]], [[TracCloud:_Confirm_Bio|staff bio on search availability]], [[TracCloud:_Work_Plans|Work Plan assignees]], and the [[TracCloud:_Welcome_Messages|staff welcome message]]
* "Supervisor" (e.g., <nowiki>{{Supervisor.First_Name}}</nowiki>) should be used when referencing the assigned supervisor in [[TracCloud:_Work_Plans|Work Plan]] fields.
* "StepSupervisor" (e.g., <nowiki>{{StepSupervisor.First_Name}}</nowiki>) should be used when referencing the STEP supervisor in [[TracCloud:_Work_Plans|Work Plan]] fields.
</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><br><nowiki>{{Reason.Reason}}</nowiki> || Reasons.Reason || 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>
 
<!------------------------------------------------------- SurveyTrac ------------------------------------------------------>
<div class="tcWidgetPage">
<div style="float: left;"><big><b>SurveyTrac Related</b> (Surveys, SrvyQuestions, Responses, SrvyRespAnswers)</big></div><div style="float: right; color: white; background-color: grey; border: 3px solid grey; font-weight: bold; border-radius: 5px" class="mw-customtoggle-8">Toggle Visibility</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-8">
<br><br>
{| class="wikitable sortable" style="min-width: 100%; font-size: 15px"
|+ Surveys
|-
! <b>Field</b> !! <b>Type</b> !! <b>Description</b> !! <b>Twig</b> !! <b>API</b>
|-
| <span title="1234">Sequence</span> || bigint || Unique identifer for each survey. || || Surveys.Sequence
|-
| <span title="Writing Center Survey">Name</span> || varchar(80) || The title of the survey. || <nowiki>{{Survey.Name}}</nowiki> || Surveys.Name
|-
| <span title="1234">CreatedBy</span> || bigint || The user who created the survey, relates to Staff.Sequence. || || Surveys.CreatedBy
|-
| <span title="1234">ProfileID</span> || bigint || Which profile this survey is linked to, relates to Profiles.Sequence. || || Surveys.ProfileID
|-
| <span title="Email after visit">AutoSend</span> || varchar(80) || The chosen "Initiated Via" option. || || Surveys.AutoSend
|-
| <span title="1">Active</span> || tinyint || Whether or not this survey is currently active. || || Surveys.Active
|-
| <span title="2025-01-31">ActiveFrom</span> || date || The start date of the survey period. || || Surveys.ActiveFrom
|-
| <span title="2025-02-15">ActiveTo</span> || date || The end date of the survey period. || || Surveys.ActiveTo
|-
| <span title="Please fill out the questions below.">Instructions</span> || text || The instructions displayed to the recipient when filling out the survey. || || Surveys.Instructions
|-
| <span title="Thanks for responding!">Confirmation</span> || text || The text shown to the recipient after submitting a response. || || Surveys.Confirmation
|-
| <span title="Writing Survey">HeadText</span> || text || The survey title shown to the recipient above the questions. || || Surveys.HeadText
|}
 
{| class="wikitable sortable" style="min-width: 100%; font-size: 15px"
|+ SrvyQuestions
|-
! <b>Field</b> !! <b>Type</b> !! <b>Description</b> !! <b>API</b>
|-
| <span title="1234">Sequence</span> || bigint || Unique identifer for each survey question. || SrvyQuestions.Sequence
|-
| <span title="How was your visit today?">Question || text || The question text. || SrvyQuestions.Question
|-
| <span title="1234">SurveyID</span> || bigint || Which survey the question is assigned to, relates to Surveys.Sequence. || SrvyQuestions.SurveyID
|-
| <span title="100">Points</span> || double || How many points a correct answer is worth ([[TracCloud:_Grade_Groups_%26_Potential_Assignments|more info.]] || SrvyQuestions.Points
|-
| <span title="Strongly Agree\nAgree\nDisagree\nStrongly Disagree">AnswerChoices || text || The available answers students can select from. || SrvyQuestions.AnswerChoices
|-
| <span title="multi-check">Type</span> || varchar(80) || The format/type of question. || SrvyQuestions.Type
|-
| <span title="3">Number</span> || int || The question number; the value that determines question order. || SrvyQuestions.Number
|}
 
{| class="wikitable sortable" style="min-width: 100%; font-size: 15px"
|+ Responses
|-
! <b>Field</b> !! <b>Type</b> !! <b>Description</b> !! <b>API</b>
|-
| <span title="1234">Sequence</span> || bigint || Unique identifer for each survey response. || Responses.Sequence
|-
| <span title="1234">SurveyID</span> || bigint || Which survey this response is linked to, relates to Surveys.Sequence. || Responses.Sequence
|-
| <span title="1a23b4c5-6789-01d2-ef3g-456h78901ijk">linkedUID</span> || varchar(36) || The UUID of the person who answered this survey. || Responses.linkedUID
|-
| <span title="Dashboard">SentByID</span> || varchar(36) || Who/what sent the survey to the recipient. This can be "Dashboard" for dashboard surveys, the name of center for automated surveys, or the UUID of a staff member if manually sent. || Responses.SentByID
|-
| <span title="1234">StudentID</span> || bigint || The student recipient, relates to Students.Sequence (not Students.ID). || Responses.StudentID
|-
| <span title="Dashboard">SentBy</span> || varchar(80) || Same as SentByID, except in the case of surveys sent by staff this field will display username instead of UUID. || Responses.SentBy
|-
| <span title="2025-01-31 14:00:00">SentDate</span> || datetime || The date and time this survey was sent to the recipient. || Responses.SentDate
|-
| <span title="2025-01-31 15:30:00">AnsweredDate</span> || datetime || The date and time the recipient responded to the survey. This will be null if no response has been received. || Responses.AnsweredDate
|-
| <span title="1234">StaffID</span> || bigint || The staff recipient, relates to Staff.Sequence. || Responses.StaffID
|-
| <span title="1234">FacultyID</span> || bigint || The faculty recipient, relates to Faculty.Sequence. || Responses.FacultyID
|-
| <span title="0">SentManually</span> || tinyint || Whether or not this survey was manually sent to the recipient. || Responses.SentManually
|}
 
{| class="wikitable sortable" style="min-width: 100%; font-size: 15px"
|+ SrvyRespAnswers
|-
! <b>Field</b> !! <b>Type</b> !! <b>Description</b> !! <b>API</b>
|-
| <span title="1234">Sequence</span> || bigint || Unique identifer for each question response. || SrvyRespAnswers.Sequence
|-
| <span title="1234">QuestionID</span> || bigint || Which question this response relates to, relates to SrvyQuestions.Sequence. || SrvyRespAnswers.QuestionID
|-
| <span title="1234">ResponseID</span> || bigint || Which survey response this question response relates to, relates to Responses.Sequence. || SrvyRespAnswers.ResponseID
|-
| <span title="Strongly Agree">tAnswer</span> || varchar(80) || The recipient's answer to the question || SrvyRespAnswers.tAnswer
|}
</div>
<br>
</div>
 
<!------------------------------------------------------- Documents ------------------------------------------------------>
<div class="tcWidgetPage">
<div style="float: left;"><big><b>Document Related</b> (Documents, DocTypes)</big></div><div style="float: right; color: white; background-color: grey; border: 3px solid grey; font-weight: bold; border-radius: 5px" class="mw-customtoggle-9">Toggle Visibility</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-9">
<br><br>
{| class="wikitable sortable" style="min-width: 100%; font-size: 15px"
|+ Documents
|-
! <b>Field</b> !! <b>Type</b> !! <b>Description</b> !! <b>Twig</b> !! <b>API</b>
|-
| <span title="1234">Sequence</span> || bigint || Unique identifer for each document. || || Documents.Sequence
|-
| <span title="1a23b4c5-6789-01d2-ef3g-456h78901ijk">linkedUID</span> || varchar(36) || The UUID of the user account this document is upload to, for Student/Staff documents. || || Documents.linkedUID
|-
| <span title="appointment">Usage</span> || varchar(255) || Where this document is uploaded. Possible values are listed below.<p style="line-height: 95%; font-size: 15px"><br>student<br>staff<br>appointment<br>visit<br>availability<br>group<br>survey</p> || <nowiki>{{Document.Usage}}</nowiki> || Documents.Usage
|-
| <span title="1234">StudentID</span> || bigint || Which student record this document is related to, relates to Students.Sequence (not Students.ID). || || Documents.StudentID
|-
| <span title="1234">StaffID</span> || bigint || Which staff record this document is related to, relates to Staff.Sequence. || || Documents.StaffID
|-
| <span title="1234">DocTypeID</span> || bigint || Which document type this document is related to, relates to DocTypes.Sequence. || || Documents.DocTypeID
|-
| <span title="2025-01-31 14:30:00">Date</span> || datetime || The date and time this document was uploaded. || || Documents.Date
|-
| <span title="This can be anything.">Notes</span> || text || The document notes. || <nowiki>{{Document.Notes}}</nowiki> || Documents.Notes
|-
| <span title="1a23b4c5-6789-01d2-ef3g-456h78901ijk">PostedBy</span> || varchar(255) || The UUID of the user who uploaded the document. || <nowiki>{{Document.PostedBy}}</nowiki> || Documents.PostedBy
|-
| <span title="Student #1931 Smith, Sam T.">PostedByName</span> || || The user type, sequence, and name of the user who uploaded this document. || <nowiki>{{Document.PostedByName}}</nowiki> ||
|-
| <span title="draft-2025-02-12.docx">OrigName</span> || varchar(512) || The name of the document. || <nowiki>{{Document.OrigName}}</nowiki> || Documents.OrigName
|-
| <span title="1234">LinkedApptID</span> || bigint || Which appointment record this document is related to, relates to Appointments.Sequence. || || Documents.LinkedApptID
|-
| <span title="application/vnd.openxmlformats-officedocument.wordprocessingml.document">Type</span> || varchar(255) || The document type. || || Documents.Type
|-
| <span title="43.45">SizeK</span> || double || The file size (in KiB) || || Documents.SizeK
|-
| <span title="0">Inactive</span> || tinyint || Whether or not this document is marked as inactive. || || Documents.Inactive
|-
| <span title="1234">LinkedAvailRecID</span> || bigint ||  Which availability record this document is related to, relates to AvailBlocks.Sequence. || || Documents.LinkedAvailRecID
|-
| <span title="1234">LinkedVisitID</span> || bigint ||  Which visit record this document is related to, relates to Visits.Sequence. || || Documents.LinkedVisitID
|}
 
{| class="wikitable sortable" style="min-width: 100%; font-size: 15px"
|+ DocTypes
|-
! <b>Field</b> !! <b>Type</b> !! <b>Description</b> !! <b>Twig</b> !! <b>API</b>
|-
| <span title="1234">Sequence</span> || bigint || Unique identifer for each document type. || || DocTypes.Sequence
|-
| <span title="Essay">Name</span> || varchar(255) || The name of the document type. || <nowiki>{{DocType.Name}}</nowiki> || DocTypes.Name
|-
| <span title="0">Inactive</span> || tinyint || Whether or not this document type is inactive. || || DocTypes.Inactive
|-
|}
</div>
<br>
</div>
 
<!------------------------------------------------------- Resources ------------------------------------------------------>
<div class="tcWidgetPage">
<div style="float: left;"><big><b>Resource Related</b> (Resources, ResourceTypes, Checkouts)</big></div><div style="float: right; color: white; background-color: grey; border: 3px solid grey; font-weight: bold; border-radius: 5px" class="mw-customtoggle-10">Toggle Visibility</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-10">
<br><br>
{| class="wikitable sortable" style="min-width: 100%; font-size: 15px"
|+ Resources
|-
! <b>Field</b> !! <b>Type</b> !! <b>Description</b> !! <b>Twig</b> !! <b>API</b>
|-
| <span title="1234">Sequence</span> || bigint || Unique identifer for each resource. || || Resources.Sequence
|-
| <span title="Dell Laptop #5">Title</span> || varchar(80) || The name of the resource. || <nowiki>{{Resource.Title}}</nowiki>
|-
| <span title="ABC123">BarCode</span> || varchar(20) || The barcode value of the resource. || <nowiki>{{Resource.BarCode}}</nowiki> || Resources.BarCode
|-
| <span title="Dell laptop with an Intel i5, 8gb of ram, and a 14 inch screen.">Description</span> || text || The description of the resource. || <nowiki>{{Resource.Description}}</nowiki> || Resources.Description
|-
| <span title="Laptop, Computer, PC">Keywords</span> || varchar(80) || The keywords for thsi resource, used to find the resource during checkout. || <nowiki>{{Resource.Keywords}}</nowiki> || Resources.Keywords
|-
| <span title="1">Status</span> || int || The status of this resource, possible values are listed below.<p style="line-height: 95%; font-size: 15px"><br>-1 = Inactive<br>0 = Checked out<br>1 = Available<br>2 = Always available</p> || <nowiki>{{Resource.Status}}</nowiki> || Resources.Status
|-
| <span title="14">MaxDaysOut</span> || int || The maximum number of days that an item can be checked out. || <nowiki>{{Resource.MaxDaysOut}}</nowiki> || Resources.MaxDaysOut
|-
| <span title="2025-01-31 15:16:18">LastDTOut</span> || datetime || The date an time this item was last checked out. || || Resources.LastDTOut
|-
| <span title="05:00:00">MaxTimeOut</span> || time || The maximum amount of time that an item can be checked out. || <nowiki>{{Resource.MaxTimeOut}}</nowiki> || Resources.MaxTimeOut
|-
| <span title="2024-06-25 15:16:18">DueDT</span> || datetime || The date and time this item is due to be returned. This will match Checkouts.DueDT of the most recent checkout. || || Resources.DueDT
|-
| <span title="1234">Type</span> || int || The resource type, relates to ResourceTypes.Sequence. || || Resources.Type
|-
| <span title="0">Inactive</span> || tinyint || Whether or not this resource is currently inactive. || || Resources.Inactive
|-
|<span title="1234">ProfileID</span> || bigint || Which profile this resource is assigned to, relates to Profiles.Sequence. || || Resources.ProfileID
|-
| <span title="0">AlwaysAvailable</span> || tinyint || Whether or not this resource is designated as always available. || || Resources.AlwaysAvailable
|-
| <span title="2">MaxRenews</span> || int || The maximum number of times a checkout for this resource can be renewed. || || Resources.MaxRenews
|-
| <span title="1">CollateralLogic</span> || tinyint || Whether or not this resource requires collateral to be checked out. || || Resources.CollateralLogic
|-
| <span title="1a23b4c5-6789-01d2-ef3g-456h78901ijk">LastOutToUUID</span> || varchar(46) || The UUID of the last user to check this resource out. || || Resources.LastOutToUUID
|-
| <span title="Pickup at the front desk.">PickupInstructions</span> || || Instructions for resource pickup. || <nowiki>{{Resource.CustomData.PickupInstructions}}</nowiki> ||
|-
| <span title="Return at the front desk.">ReturnInstructions</span> || || Instructions for resource return. || <nowiki>{{Resource.CustomData.ReturnInstructions}}</nowiki> ||
|-
|}
 
{| class="wikitable sortable" style="min-width: 100%; font-size: 15px"
|+ ResourceTypes
|-
! <b>Field</b> !! <b>Type</b> !! <b>Description</b> !! <b>Twig</b> !! <b>API</b>
|-
| <span title="1234">Sequence</span> || bigint || Unique identifer for each resource type. || || ResourceTypes.Sequence
|-
| <span title="Computers">Name</span> || varchar(80) || The name of the resource type/category that resources are assigned to. || <nowiki>{{ResourceType.Name}}</nowiki> || ResourceTypes.Name
|-
| <span title="Desktops, Laptops, and Tablets.">Description</span> || varchar(255) || The description of the resource type. || <nowiki>{{ResourceType.Description}}</nowiki> || ResourceTypes.Description
|}
 
{| class="wikitable sortable" style="min-width: 100%; font-size: 15px"
|+ Checkouts
|-
! <b>Field</b> !! <b>Type</b> !! <b>Description</b> !! <b>Twig</b> !! <b>API</b>
|-
| <span title="1234">Sequence</span> || bigint || Unique identifer for each checkout. || || Checkouts.Sequence
|-
| <span title="1234">ResourceID</span> || bigint || Which resource this checkout is for, relates to Resources.Sequence. || || Checkouts.ResourceID
|-
| <span title="2024-03-01 08:33:27">Date</span> || datetime || The date and time of the checkout. || <nowiki>{{Checkout.Date}}</nowiki> || Checkouts.Date
|-
| <span title="2024-03-01 08:40:27">ReturnedDT</span> || datetime || The date and time the checkout was returned. || || Checkouts.ReturnedDT
|-
| <span title="678.5075">TotalTimeHrs</span> || double || The total number of hours the resource was checked out for. || || Checkouts.TotalTimeHrs
|-
| <span title="(Sam Smith) Student ID Card">Collateral</span> || varchar(80) ||  The collateral for checkout.  || <nowiki>{{Checkout.Collateral}}</nowiki> || Checkouts.Collateral
|-
| <span title="This can be anything.">Notes</span> || text || The notes in the checkout record. || || Checkouts.Notes
|-
| <span title="0">Overdue</span> || tinyint || Whether or not this checkout is overdue. || <nowiki>{{Checkout.Overdue}}</nowiki> || Checkouts.Overdue
|-
| <span title="2025-03-20 09:05:12">DueDT</span> || datetime || The date and time the checkout is due to be returned. || <nowiki>{{Checkout.DueDT}}</nowiki> || Checkouts.DueDT
|-
| <span title="1a23b4c5-6789-01d2-ef3g-456h78901ijk">CheckedOutToUUID</span> || varchar(46) || The UUID of the user who checked out this resource. || || Checkouts.CheckedOutToUUID
|-
| <span title="Student">CheckedOutToType</span> || varchar(80) || What type of user checked out this resource (Student or Staff). ||  || Checkouts.CheckedOutToType
|}
</div>
<br>
</div>
 
<!------------------------------------------------------- Workshops ------------------------------------------------------>
<div class="tcWidgetPage">
<div style="float: left;"><big><b>Workshops</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-11">Toggle Visibility</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-11">
<br><br>
<section begin="workshops" />
{| 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 || Unique identifer for each workshop. || || Workshops.Sequence
|-
| <span title="1234">CenterID</span> || bigint || Which center this workshop is assigned to, relates to Centers.Sequence. || || Workshops.CenterID
|-
| <span title="1234">ReasonID</span> || bigint || Which reason this workshop is assigned to, relates to Reasons.Sequence. ||  || Workshops.ReasonID
|-
| <span title="Accounting Workshop">Name</span> || varchar(255) || The name of the workshop. || <nowiki>{{Workshop.Name}}</nowiki> || Workshops.Name
|-
| <span title="Jane Doe">Instructor</span> || varchar(255) || The instructor of the workshop. || <nowiki>{{Workshop.Instructor}}</nowiki> || Workshops.Instructor
|-
| <span title='<nowiki>{"Course": "100", "Section": "01", "Subject": "ACTG"}</nowiki>'>RosterSubject</span> || json || Contains the subject, course, and section code of the workshop.  ||  || Workshops.RosterSubject
|-
| <span title="ACTG">RosterSubject.Subject</span> || varchar(40) || The workshop subject. || <nowiki>{{Workshop.RosterSubject.Subject}}</nowiki> ||
|-
| <span title="100">RosterSubject.Course</span> || varchar(20) || The workshop course. || <nowiki>{{Workshop.RosterSubject.Course}}</nowiki> ||
|-
| <span title="01">RosterSubject.Section</span> || varchar(80) || The workshop section code. || <nowiki>{{Workshop.RosterSubject.Section}}</nowiki> ||
|-
| <span title="1234">StudentLinkedListID</span> || bigint || The list of students this workshop is restricted to, relates to Lists.Sequence. ||  || Workshops.StudentLinkedListID
|-
| <span title="This workshop is for students in Accounting courses.">Description</span> || text || The description of the workshop. || <nowiki>{{Workshop.Description}}</nowiki> || Workshops.Description
|-
| <span title="1234">AssignmentID</span> || bigint || Which [[TracCloud:_Grade_Groups_%26_Potential_Assignments|potential assignment]] this workshop is assigned to, relates to Assignments.Sequence. || || Workshops.AssignmentID
|-
| <span title="2024-10-21 11:14:44">CreatedDT</span> || datetime || The date and time this workshop was created. || <nowiki>{{Workshop.CreatedDT}}</nowiki> || Workshops.CreatedDT
|-
| <span title="2025-03-31 11:00:00">DateFrom</span> || datetime || The start date and time of the workshop. || <nowiki>{{Workshop.DateFrom}}</nowiki> || Workshops.DateFrom
|-
| <span title="03/31/25">StartDate</span> || || The start date of the workshop. || <nowiki>{{Workshop.StartDate}}</nowiki> ||
|-
| <span title="11:00am">StartTime</span> || || The start time of the workshop. || <nowiki>{{Workshop.StartTime}}</nowiki> ||
|-
| <span title="2025-03-31 12:00:00">DateTo</span> || datetime || The end date and time of the workshop. || <nowiki>{{Workshop.DateTo}}</nowiki> || Workshops.DateTo
|-
| <span title="03/31/25">EndDate</span> || || The end date of the workshop. || <nowiki>{{Workshop.EndDate}}</nowiki> || Workshops.EndDate
|-
| <span title="12:00pm">EndTime</span> || || The end time of the workshop. || <nowiki>{{Workshop.EndTime}}</nowiki> || Workshops.EndTime
|-
| <span title="2025-03-20">EnrolledDate</span> || || The date of student enrollment. || <nowiki>{{WorkshopsRoster.EnrolledDate}}</nowiki> ||
|}
<section end="workshops" />
</div>
<br>
</div>
 
<!------------------------------------------------------- CustomDataTypes ------------------------------------------------------>
<div class="tcWidgetPage">
<div style="float: left;"><big><b>Custom Fields</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-12">Toggle Visibility</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-12">
<br><br>
{| class="wikitable sortable" style="min-width: 100%; font-size: 15px"
|+ Replace '123' in the Twig examples with the sequence of your custom field.
|-
! <b>Field</b> !! <b>Type</b> !! <b>Description</b> !! <b>Twig</b> !! <b>API</b>
|-
| <span title="1234">Sequence</span> || bigint || Unique identifer for each workshop. || || CustomDataTypes.Sequence
|-
| <span title="StudentApptNotes">DataName</span> || varchar(80) || The internal name of the custom field (different than prompt). || <nowiki>CustomFields.cf_123.DataName</nowiki> || CustomDataTypes.DataName
|-
| <span title="Student - Custom1">Location</span> || varchar(80) || Where the custom field is located. Possible values are listed below.<p style="line-height: 95%; font-size: 15px"><br>Appointment - Consultant<br>Appointment - Student<br>Availability<br>Certification<br>Consultant<br>Document<br>Faculty<br>Reason<br>Registration<br>Resource<br>Section<br>SI_Session<br>Student - Campus<br>Student - Custom1<br>Student - Custom2<br>Student - Custom3<br>Student - Custom4<br>Student - Custom5<br>Student - Other Info<br>Student - QuickStudent<br>Visit - Consultant<br>Visit - Q2 Raise Hand<br>Visit - Student</p> || || CustomDataTypes.Location
|-
| <span title="What do you need help with in this appointment?">Prompt</span> || text || The visible name of the custom field (what students see). || <nowiki>CustomFields.cf_123.Prompt</nowiki> || CustomDataTypes.Prompt
|-
| <span title="<nowiki>Yes\r\nNo</nowiki>">Choices</span> || text || The available list of choices for custom fields with predefined answers. || <nowiki>CustomFields.cf_123.Choices</nowiki> || CustomDataTypes.Choices
|-
| <span title="menufield">InputType</span> || varchar(80) || What type of custom field this is. Possible values are listed below.<p style="line-height: 95%; font-size: 15px"><br>field<br>areafield<br>leftcheckfield<br>multicheckfield<br>radiofield<br>radioimagefield<br>toggle<br>menufield<br>imagemenufield<br>imagepopfield<br>signaturefield<br>uploaddocfield<br>popfield<br>labeledhtml<br>infohtml<br>headerhtml<br>group</p> ||  || CustomDataTypes.InputType
|-
| <span title="1234">ProfileID</span> || bigint || Which profile this custom field is linked to, 0 is all. Relates to Profiles.Sequence. ||  || CustomDataTypes.ProfileID
|}
</div>
<br>
</div>
 
<!------------------------------------------------------- Success Plans ------------------------------------------------------>
<div class="tcWidgetPage">
<div style="float: left;"><big><b>Success Plan Related</b> (SuccessPlan, SPSteps, SPAssigned, SPAssignedSteps)</big></div><div style="float: right; color: white; background-color: grey; border: 3px solid grey; font-weight: bold; border-radius: 5px" class="mw-customtoggle-13">Toggle Visibility</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-13">
<br><br>
<section begin="SPTags" />
{| class="wikitable sortable" style="min-width: 100%; font-size: 15px"
|+ SuccessPlan
|-
! <b>Field</b> !! <b>Type</b> !! <b>Description</b> !! <b>Twig</b> !! <b>API</b>
|-
| <span title="1234">Sequence</span> || bigint || Unique identifer for each success plan. || || SuccessPlan.Sequence
|-
| <span title="Academic Coaching Plan">Name</span> || varchar(120) || The name of the success plan. || <nowiki>{{SuccessPlan.Name}}</nowiki> || SuccessPlan.Name
|-
| <span title="1234">ProfileID</span> || bigint || Which profile this success plan is assigned to, relates to Profiles.Sequence. || || SuccessPlan.ProfileID
|-
| <span title="0">Inactive</span> || tinyint || Whether or not this success plan is currently inactive. || || SuccessPlan.Inactive
|}
 
{| class="wikitable sortable" style="min-width: 100%; font-size: 15px"
|+ SPSteps
|-
! <b>Field</b> !! <b>Type</b> !! <b>Description</b> !! <b>Twig</b> !! <b>API</b>
|-
| <span title="1234">Sequence</span> || bigint || Unique identifer for each success plan step. || <nowiki>{{SPStep.Sequence}}</nowiki> || SPSteps.Sequence
|-
| <span title="1234">SuccessPlanID</span> || bigint || Which success plan this step is assgined to. || <nowiki>{{SPStep.}}</nowiki> || SPSteps.SuccessPlanID
|-
| <span title="Visit">Type</span> || varchar(120) || What type of step this is. Possible values are listed below.<p style="line-height: 95%; font-size: 15px"><br>Visit<br>Survey<br>Document<br>Task<br>Checkout<br>Notification<br>Prompt</p>|| <nowiki>{{SPStep.Type}}</nowiki> || SPSteps.Type
|-
| <span title="14">DateOrOffset</span> || varchar(36) || When this Step needs to be completed (number of days or static date based on Plan type) || <nowiki>{{SPStep.DateOrOffset}}</nowiki> || SPSteps.DateOrOffset
|-
| <span title="1">isOptional</span> || tinyint || Whether or not the step is optional. || <nowiki>{{SPStep.isOptional}}</nowiki> || SPSteps.isOptional
|-
| <span title="0">isNoSendEmails</span> || tinyint || Whether or not emails are disabled for this step. || <nowiki>{{SPStep.isNoSendEmails}}</nowiki> || SPSteps.isNoSendEmails
|-
| <span title="0">isPromptOnDash</span> || tinyint || Whether or not the prompt is set to display on the dashboard. || <nowiki>{{SPStep.isPromptOnDash}}</nowiki> || SPSteps.isPromptOnDash
|-
| <span title="1">DirectedTo</span> || int || Who the confirmation is directed to. Possible values are listed below.<p style="line-height: 95%; font-size: 15px"><br>0 = Student<br>1 = Plan Staff<br>2 = Plan Faculty<br>3 = Step Staff<br>4 = Step Faculty</p> || <nowiki>{{SPStep.DirectedTo}}</nowiki> || SPSteps.DirectedTo
|-
| <span title="1">OverrideRequireConfirmation</span> || int || Whether or not this step has been overridden to allow/disallow confirmation. || <nowiki>{{SPStep.OverrideRequireConfirmation}}</nowiki> || SPSteps.OverrideRequireConfirmation
|}
 
{| class="wikitable sortable" style="min-width: 100%; font-size: 15px"
|+ SPAssigned
|-
! <b>Field</b> !! <b>Type</b> !! <b>Description</b> !! <b>Twig</b> !! <b>API</b>
|-
| <span title="1234">Sequence</span> || bigint || Unique identifer for each assigned success plan. || || SPAssigned.Sequence
|-
| <span title="1234">SuccessPlanID</span> || bigint || What type of success plan this is, relates to SuccessPlan.Sequence || || SPAssigned.SuccessPlanID
|-
| <span title="1234">StudentID</span> || bigint || Which student this plan is assigned to, relates to Students.Sequence (not Students.ID). || || SPAssigned.StudentID
|-
| <span title="1234">ConsultantID</span> || bigint || The assigned plan consultant, relates to Staff.Sequence. || || SPAssigned.ConsultantID
|-
| <span title="2025-01-14">DateStarted</span> || date || The date the plan began. || <nowiki>{{SPAssigned.DateStarted}}</nowiki> || SPAssigned.DateStarted
|-
| <span title="2025-01-25">DateCompleted</span> || date || The date the plan was completed. || <nowiki>{{SPAssigned.DateCompleted}}</nowiki> || SPAssigned.DateCompleted
|-
| <span title="2025-02-14">DueDate</span> || date || The date the plan is due for completion. || <nowiki>{{SPAssigned.DueDate}}</nowiki> || SPAssigned.DueDate
|-
| <span title="1234">TermID</span> || bigint || The term this plan is linked to, relates to Terms.Sequence. || || SPAssigned.TermID
|-
| <span title="0">Inactive</span> || tinyint || Whether or not this plan is inactive. || || SPAssigned.Inactive
|-
| <span title="Overdue">Status</span> || varchar(120) || The status of the plan. Possible values are listed below.<p style="line-height: 95%; font-size: 15px"><br>In Progress<br>Complete<br>Overdue</p> || <nowiki>{{SPAssigned.Status}}</nowiki> || SPAssigned.Status
|-
| <span title="75">Percent</span> || int || The completion percentage of the plan. || <nowiki>{{SPAssigned.Percent}}</nowiki> || SPAssigned.Percent
|-
| <span title="1234">FacultyID</span> || bigint || The faculty assigned to the plan, relates to Faculty.Sequence (not Faculty.UserID). ||  || SPAssigned.FacultyID
|-
| <span title="N/A">DashboardStatus</span> || || The HTML text that would appear on the student's main menu showing their progress in the plan. || <nowiki>{{SPAssigned.DashboardStatus|raw}}</nowiki> ||
|}
 
{| class="wikitable sortable" style="min-width: 100%; font-size: 15px"
|+ SPAssignedSteps
|-
! <b>Field</b> !! <b>Type</b> !! <b>Description</b> !! <b>Twig</b> !! <b>API</b>
|-
| <span title="1234">Sequence</span> || bigint || Unique identifer for each assigned success plan step. || || SPAssignedSteps.Sequence
|-
| <span title="1234">SPAssignedID</span> || bigint || Which assigned success plan this is assigned to, relates to SPAssigned.Sequence. || || SPAssignedSteps.SPAssignedID
|-
| <span title="1234">StudentID</span> || bigint || Which student this is assigned to, relates to Students.Sequence (not Students.ID). || || SPAssignedSteps.StudentID
|-
| <span title="1234">SPStepID</span> || bigint || Which success plan step this relates to, relates to SPSteps.Sequence ||  || SPAssignedSteps.SPStepID
|-
| <span title="2023-01-09">CompletedDate</span> || date || The date this step was completed. || <nowiki>{{SPAssignedStep.CompletedDate}}</nowiki> || SPAssignedSteps.CompletedDate
|-
| <span title="2023-01-09">DueDate</span> || date || The date this step was due to be completed. || <nowiki>{{SPAssignedStep.DueDate}}</nowiki> || SPAssignedSteps.DueDate
|-
| <span title="1">CompletionOverride</span> || tinyint || Whether or not the completion override option is enabled for this step. || <nowiki>{{SPAssignedStep.CompletionOverride}}</nowiki> || SPAssignedSteps.CompletionOverride
|-
| <span title="This can be anything.">StaffNotes</span> || text || Any notes entered by the staff for this step. || <nowiki>{{SPAssignedStep.StaffNotes}}</nowiki> || SPAssignedSteps.StaffNotes
|-
| <span title="1">Confirmed</span> || tinyint || Whether or not this step has been confirmed. || <nowiki>{{SPAssignedStep.Confirmed}}</nowiki> || SPAssignedSteps.Confirmed
|-
| <span title="1234">StepFacultyID</span> || bigint || Which faculty this step is assigned to, relates to Faculty.Sequence (not Faculty.UserID). || <nowiki>{{SPAssignedStep.StepFacultyID}}</nowiki> || SPAssignedSteps.StepFacultyID
|-
| <span title="1234">StepConsultantID</span> || bigint || Which staff record this step is assigned to, relates to Staff.Sequence. || <nowiki>{{SPAssignedStep.StepConsultantID}}</nowiki> || SPAssignedSteps.StepConsultantID
|-
| <span title="3">Index</span> || || The number of the step, based on the order they were created in. || <nowiki>{{SPAssignedStep.Index}}</nowiki> ||
|-
| <span title="2">PartialStepValue</span> || || The progress in the step. For example, you may want to show how many visits they've completed out of a step that requires they complete X visits. || <nowiki>{{SPAssignedStep.CustomData|json_decode.PartialStepValue}}</nowiki> ||
|}
<section end="SPTags" />
</div>
<br>
</div>
 
<!------------------------------------------------------- Work Plans ------------------------------------------------------>
<div class="tcWidgetPage">
<div style="float: left;"><big><b>Work Plan Related</b> (WorkPlan, WPSteps, WPAssigned, WPAssignedSteps)</big></div><div style="float: right; color: white; background-color: grey; border: 3px solid grey; font-weight: bold; border-radius: 5px" class="mw-customtoggle-14">Toggle Visibility</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-14">
<br><br>
<section begin="WPTags" />
{| class="wikitable sortable" style="min-width: 100%; font-size: 15px"
|+ WorkPlan
|-
! <b>Field</b> !! <b>Type</b> !! <b>Description</b> !! <b>Twig</b> !! <b>API</b>
|-
| <span title="1234">Sequence</span> || bigint || Unique identifer for each work plan. || || WorkPlan.Sequence
|-
| <span title="Certification Plan">Name</span> || varchar(120) || The name of the work plan. || <nowiki>{{WorkPlan.Name}}</nowiki> || WorkPlan.Name
|-
| <span title="1234">ProfileID</span> || bigint || Which profile this work plan is assigned to, relates to Profiles.Sequence. || || WorkPlan.ProfileID
|-
| <span title="0">Inactive</span> || tinyint || Whether or not this work plan is currently inactive. || || WorkPlan.Inactive
|}
 
{| class="wikitable sortable" style="min-width: 100%; font-size: 15px"
|+ WPSteps
|-
! <b>Field</b> !! <b>Type</b> !! <b>Description</b> !! <b>Twig</b> !! <b>API</b>
|-
| <span title="1234">Sequence</span> || bigint || Unique identifer for each work plan step. || <nowiki>{{WPStep.Sequence}}</nowiki> || WPSteps.Sequence
|-
| <span title="1234">WorkPlanID</span> || bigint || Which work plan this step is assgined to. || <nowiki>{{WPStep.WorkPlanID}}</nowiki> || WPSteps.WorkPlanID
|-
| <span title="Work Visit">Type</span> || varchar(120) || What type of step this is. Possible values are listed below.<p style="line-height: 95%; font-size: 15px"><br>Work Visit<br>Consultation Visit<br>Appointment<br>Survey<br>Document<br>Task<br>Checkout<br>Notification<br>Prompt</p>|| <nowiki>{{WPStep.Type}}</nowiki> || WPSteps.Type
|-
| <span title="14">DateOrOffset</span> || varchar(36) || When this Step needs to be completed (number of days or static date based on Plan type) || <nowiki>{{WPStep.DateOrOffset}}</nowiki> || WPSteps.DateOrOffset
|-
| <span title="1">isOptional</span> || tinyint || Whether or not the step is optional. || <nowiki>{{WPStep.isOptional}}</nowiki> || WPSteps.isOptional
|-
| <span title="0">isNoSendEmails</span> || tinyint || Whether or not emails are disabled for this step. || <nowiki>{{WPStep.isNoSendEmails}}</nowiki> || WPSteps.isNoSendEmails
|-
| <span title="0">isPromptOnDash</span> || tinyint || Whether or not the prompt is set to display on the dashboard. || <nowiki>{{WPStep.isPromptOnDash}}</nowiki> || WPSteps.isPromptOnDash
|-
| <span title="1">DirectedTo</span> || int || Who the confirmation is directed to. Possible values are listed below.<p style="line-height: 95%; font-size: 15px"><br>0 = Consultant<br>1 = Plan Supervisor<br>3 = No Prompt</p> || <nowiki>{{WPStep.DirectedTo}}</nowiki> || WPSteps.DirectedTo
|-
| <span title="1">OverrideRequireConfirmation</span> || int || Whether or not this step has been overridden to allow/disallow confirmation. || <nowiki>{{WPStep.OverrideRequireConfirmation}}</nowiki> || WPSteps.OverrideRequireConfirmation
|}
 
{| class="wikitable sortable" style="min-width: 100%; font-size: 15px"
|+ WPAssigned
|-
! <b>Field</b> !! <b>Type</b> !! <b>Description</b> !! <b>Twig</b> !! <b>API</b>
|-
| <span title="1234">Sequence</span> || bigint || Unique identifer for each assigned work plan. || || WPAssigned.Sequence
|-
| <span title="1234">WorkPlanID</span> || bigint || What type of work plan this is, relates to WorkPlan.Sequence || || WPAssigned.WorkPlanID
|-
| <span title="1234">ConsultantID</span> || bigint || The assigned plan consultant, relates to Staff.Sequence. || || WPAssigned.ConsultantID
|-
| <span title="1234">SupervisorID</span> || bigint || The assigned supervisor for this work plan, relates to Staff.Sequence. || || WPAssigned.SupervisorID
|-
| <span title="2025-01-14">DateStarted</span> || date || The date the plan began. || <nowiki>{{WPAssigned.DateStarted}}</nowiki> || WPAssigned.DateStarted
|-
| <span title="2025-01-25">DateCompleted</span> || date || The date the plan was completed. || <nowiki>{{WPAssigned.DateCompleted}}</nowiki> || WPAssigned.DateCompleted
|-
| <span title="2025-02-14">DueDate</span> || date || The date the plan is due for completion. || <nowiki>{{WPAssigned.DueDate}}</nowiki> || WPAssigned.DueDate
|-
| <span title="1234">TermID</span> || bigint || The term this plan is linked to, relates to Terms.Sequence. || || WPAssigned.TermID
|-
| <span title="0">Inactive</span> || tinyint || Whether or not this plan is inactive. || || WPAssigned.Inactive
|-
| <span title="Overdue">Status</span> || varchar(120) || The status of the plan. Possible values are listed below.<p style="line-height: 95%; font-size: 15px"><br>In Progress<br>Complete<br>Overdue</p> || <nowiki>{{WPAssigned.Status}}</nowiki> || WPAssigned.Status
|-
| <span title="75">Percent</span> || int || The completion percentage of the plan. || <nowiki>{{WPAssigned.Percent}}</nowiki> || WPAssigned.Percent
|}
 
{| class="wikitable sortable" style="min-width: 100%; font-size: 15px"
|+ WPAssignedSteps
|-
! <b>Field</b> !! <b>Type</b> !! <b>Description</b> !! <b>Twig</b> !! <b>API</b>
|-
| <span title="1234">Sequence</span> || bigint || Unique identifer for each assigned work plan step. || || WPAssignedSteps.Sequence
|-
| <span title="1234">WPAssignedID</span> || bigint || Which assigned work plan this is assigned to, relates to WPAssigned.Sequence. || || WPAssignedSteps.WPAssignedID
|-
| <span title="1234">ConsultantID</span> || bigint || Which consultant this is assigned to, relates to Staff.Sequence. || || WPAssignedSteps.ConsultantID
|-
| <span title="1234">WPStepID</span> || bigint || Which work plan step this relates to, relates to WPSteps.Sequence ||  || WPAssignedSteps.WPStepID
|-
| <span title="2023-01-09">CompletedDate</span> || date || The date this step was completed. || <nowiki>{{WPAssignedStep.CompletedDate}}</nowiki> || WPAssignedSteps.CompletedDate
|-
| <span title="2023-01-09">DueDate</span> || date || The date this step was due to be completed. || <nowiki>{{WPAssignedStep.DueDate}}</nowiki> || WPAssignedSteps.DueDate
|-
| <span title="1">CompletionOverride</span> || tinyint || Whether or not the completion override option is enabled for this step. || <nowiki>{{WPAssignedStep.CompletionOverride}}</nowiki> || WPAssignedSteps.CompletionOverride
|-
| <span title="This can be anything.">StaffNotes</span> || text || Any notes entered by the staff for this step. || <nowiki>{{WPAssignedStep.StaffNotes}}</nowiki> || WPAssignedSteps.StaffNotes
|-
| <span title="1">Confirmed</span> || tinyint || Whether or not this step has been confirmed. || <nowiki>{{WPAssignedStep.Confirmed}}</nowiki> || WPAssignedSteps.Confirmed
|-
| <span title="1234">StepSupervisorID</span> || bigint || Which supervisor this step is assigned to, relates to Staff.Sequence. || <nowiki>{{WPAssignedStep.StepSupervisorID}}</nowiki> || WPAssignedSteps.StepSupervisorID
|}
<section end="WPTags" />
</div>
<br>
</div>
 
<!------------------------------------------------------- SAGE ------------------------------------------------------>
<div class="tcWidgetPage">
<div style="float: left;"><big><b>SAGE Related</b> (ReferralType, Referrals)</big></div><div style="float: right; color: white; background-color: grey; border: 3px solid grey; font-weight: bold; border-radius: 5px" class="mw-customtoggle-15">Toggle Visibility</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-15">
<br><br>
<section begin="SAGE" />
{| class="wikitable sortable" style="min-width: 100%; font-size: 15px"
|+ ReferralType
|-
! <b>Field</b> !! <b>Type</b> !! <b>Description</b> !! <b>Twig</b> !! <b>API</b>
|-
| <span title="1234">Sequence</span> || bigint || Unique identifer for each referral type. || || ReferralType.Sequence
|-
| <span title="Academic Performance Alert">Name</span> || varchar(255) || The name of the referral type. || <nowiki>{{ReferralType.Name}}</nowiki> || ReferralType.Name
|-
| <span title='<nowiki>{"Course": "101", "Section": "01", "Subject": "MATH", "CourseList": "", "useCourseList": "0"}</nowiki>'>RosterSubject</span> || json || This <b>array</b> contains information about what subject(s) this referral type is linked to. || || ReferralType.RosterSubject
|-
| <span title="1234">StudentLinkedListID</span> || bigint || Which student list this referral type is limited to, relates to Lists.Sequence.  || || ReferralType.StudentLinkedListID
|-
| <span title="1">Active</span> || tinyint || Whether or not this referral type is currently active. || || ReferralType.Active
|-
| <span title="This can be anything.">NotesInstructions</span> || text || The contents of the notes instructions field. || <nowiki>{{ReferralType.NotesInstructions}}</nowiki> || ReferralType.NotesInstructions
|-
| <span title='<nowiki>[{"key": "abcdefg12345678", "label": true, "value": "Pick a reason", "active": true}, {"key": "abcdefg12345679", "label": false, "value": "Reason A", "active": true}, {"key": "abcdefg12345680", "label": false, "value": "Reason B", "active": true}, {"key": "abcdefg12345681", "label": false, "value": "Reason C", "active": true}]</nowiki>'>Reasons</span> || json || An <b>array</b> of all of this referral type's reasons. || <nowiki>{{ReferralType.Reasons}}</nowiki> || ReferralType.Reasons
|-
| <span title='<nowiki>[{"key": "abcdefg12345678", "label": true, "value": "Pick a Recommendation", "active": true}, {"key": "abcdefg12345679", "label": false, "value": "Recommendation A", "active": true}, {"key": "abcdefg12345680", "label": false, "value": "Recommendation B", "active": true}, {"key": "abcdefg12345681", "label": false, "value": "Recommendation C", "active": true}]</nowiki>'>Recommend</span> || json || An <b>array</b> of all of this referral type's recommendations. || <nowiki>{{ReferralType.Recommend}}</nowiki> || ReferralType.Recommend
|-
| <span title="This can be anything.">AdditionalNotesInstr</span> || text|| The contents of the additional notes instrucitons field. || <nowiki>{{ReferralType.AdditionalNotesInstr}}</nowiki> || ReferralType.AdditionalNotesInstr
|-
| <span title="This can be anything.">OtherInstructions</span> || text || The contents of the other instructions field. || <nowiki>{{ReferralType.OtherInstructions}}</nowiki> || ReferralType.OtherInstructions
|}
 
{| class="wikitable sortable" style="min-width: 100%; font-size: 15px"
|+ Referrals
|-
! <b>Field</b> !! <b>Type</b> !! <b>Description</b> !! <b>Twig</b> !! <b>API</b>
|-
| <span title="1234">Sequence</span> || bigint || Unique identifer for each referral. || || Referrals.Sequence
|-
| <span title="1234">RefTypeID</span> || bigint || Which referral type this referral is linked to, relates to ReferralType.Sequence || || Referrals.RefTypeID
|-
| <span title="1234">StudentID</span> || bigint || Which student this referral is assigned to, relates to Students.Sequence (not Students.ID). || || Referrals.StudentID
|-
| <span title="1234">FacultyID</span> || bigint || Which faculty this referral is linked to, relates to Faculty.Sequence (not Faculty.UserID). ||  || Referrals.FacultyID
|-
| <span title="1234">SectionID</span> || bigint || Which section this referral is linked to, relates to Sections.Sequence. || || Referrals.SectionID
|-
| <span title="1234">ConsultantID</span> || bigint || Which consultant this referral is linked to, relates to Staff.Sequence. || || Referrals.ConsultantID
|-
| <span title="1234">CenterID</span> || bigint || Which center this referral is linked to, relates to Centers.Sequence. || || Referrals.CenterID
|-
| <span title="2024-01-31 08:00:00">CreatedDT</span> || datetime || The date and time this referral was created. || <nowiki>{{Referrals.CreatedDT}}</nowiki> || Referrals.CreatedDT
|-
| <span title="Jeff Daniels, Dr">CreatedBy</span> || varchar(255) || Who created this referral, either a faculty or staff member. || <nowiki>{{Referrals.CreatedBy}}</nowiki> || Referrals.CreatedBy
|-
| <span title="This can be anything.">NotesInstrData</span> || text || Notes entered while the referral is being submitted. || <nowiki>{{Referrals.NotesInstrData}}</nowiki> || Referrals.NotesInstrData
|-
| <span title='<nowiki>[{"key": "abddefgh12345678", "reason": "Submitted work is acceptable"}, {"key": "abddefgh12345679", "reason": "Attendance is unacceptable"}]</nowiki>'>ReasonsData</span> || json || An <b>array</b> of chosen reasons in this referral. || [[TracCloud:_Twig|<span title="Requires specific formatting due to this field being an array. Click to learn more.">Reasons*</span>]] || Referrals.ReasonsData
|-
| <span title= '<nowiki>[{"key": "abddefgh12345678", "reason": "Attendance and Coursework Reasons"}, {"key": "abddefgh12345678", "reason": "Submitted work is acceptable"}, {"key": "abddefgh12345679", "reason": "Attendance is unacceptable"}]</nowiki>'>ReasonsAndLabels</span> || || Same as above, but this <b>array</b> will also include the reason labels. || [[TracCloud:_Twig|<span title="Requires specific formatting due to this field being an array. Click to learn more.">ReasonsAndLabels*</span>]] ||
|-
| <span title='<nowiki>[{"key": "abddefgh12345678", "recommend": "Meet with Advisor"}, {"key": "abddefgh12345679", "recommend": "Meet with Instructor"}]</nowiki>'>RecommendData</span> || json || An <b>array</b> of chosen recommendations in this referral. || [[TracCloud:_Twig|<span title="Requires specific formatting due to this field being an array. Click to learn more.">Recommendations*</span>]] || Referrals.RecommendData
|-
| <span title= '<nowiki>[{"key": "abddefgh12345678", "recommend": "Meet with..."}, {"key": "abddefgh12345678", "recommend": "Meet with Advisor"}, {"key": "abddefgh12345679", "recommend": "Meet with Instructor"}]</nowiki>'>RecommendationsAndLabels</span> || || Same as above, but this <b>array</b> will also include the recommendation labels. || [[TracCloud:_Twig|<span title="Requires specific formatting due to this field being an array. Click to learn more.">RecommendationsAndLabels*</span>]] ||
|-
| <span title="This can be anything.">AdditionalNotes</span> || text || Additional notes entered during referral submission.|| <nowiki>{{Referrals.AdditionalNotes}}</nowiki> || Referrals.AdditionalNotes
|-
| <span title="2025-03-25">FollowUpDate</span> || date || The specified follow-up date from the referral. || <nowiki>{{Referrals.FollowUpDate}}</nowiki> || Referrals.FollowUpDate
|-
| <span title="Jane Doe">FollowUpBy</span> || varchar(255) || The name of the user who followed up on this referral. || <nowiki>{{Referrals.FollowUpBy}}</nowiki> || Referrals.FollowUpBy
|-
| <span title="1">FollowedUp</span> || tinyint || Whether or not this referral has been followed up on.|| <nowiki>{{Referrals.FollowedUp}}</nowiki> || Referrals.FollowedUp
|-
| <span title="2025-03-25 08:19:34">FollowedUpDT</span> || datetime || The date and time this referral was followed up on. || <nowiki>{{Referrals.FollowedUpDT}}</nowiki> || Referrals.FollowedUpDT
|-
| <span title="1">Processed</span> || tinyint || Whether or not this referral has been processed (resolved). || <nowiki>{{Referrals.Processed}}</nowiki> || Referrals.Processed
|-
| <span title="2025-03-25 08:23:39">ProcessedDT</span> || datetime || The date and time this referral was processed. || <nowiki>{{Referrals.ProcessedDT}}</nowiki> || Referrals.ProcessedDT
|-
| <span title="Jane Doe">ProcessedBy</span> || varchar(255) || The user who processed this referral. || <nowiki>{{Referrals.ProcessedBy}}</nowiki> || Referrals.ProcessedBy
|-
| <span title="This can be anything.">ProcessedNotes</span> || text || Notes entered while the referral was being processed. || <nowiki>{{Referrals.ProcessedNotes}}</nowiki> || Referrals.ProcessedNotes
|-
| <span title="2025-03-25">StudentContacted</span> || date || The date the student was contacted about this referral. || <nowiki>{{Referrals.StudentContacted}}</nowiki> || Referrals.StudentContacted
|-
| <span title="1">OverrideResend</span> || tinyint || Whether or not the 'Override and resend' feature has been used. || || Referrals.OverrideResend
|-
| <span title="Jane Doe">AssignedConsultant</span> || varchar(255) || The name of the consultant or advisor assigned to this referral. || <nowiki>{{Referrals.AssignedConsultant}}</nowiki> || Referrals.AssignedConsultant
|-
| <span title="1234">AssignedConsultantID</span> || varchar(255) || The sequence number of the assigned consultant, relates to Staff.Sequence. || <nowiki>{{Referral.CustomData.AssignedConsultantID}}</nowiki> ||
|}
<section end="SAGE" />
</div>
<br>
</div>
</div>

Latest revision as of 15:14, 6 August 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


Visits
Toggle Visibility


Appointments
Toggle Visibility


Availabilities
Toggle Visibility


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


Staff/Consultants
Toggle Visibility


Profile Related (Profiles, Centers, Reasons, Groups)
Toggle Visibility


SurveyTrac Related (Surveys, SrvyQuestions, Responses, SrvyRespAnswers)
Toggle Visibility


Document Related (Documents, DocTypes)
Toggle Visibility


Resource Related (Resources, ResourceTypes, Checkouts)
Toggle Visibility


Workshops
Toggle Visibility


Custom Fields
Toggle Visibility


Success Plan Related (SuccessPlan, SPSteps, SPAssigned, SPAssignedSteps)
Toggle Visibility


Work Plan Related (WorkPlan, WPSteps, WPAssigned, WPAssignedSteps)
Toggle Visibility


SAGE Related (ReferralType, Referrals)
Toggle Visibility