TracCloud: Rosetta

From Redrock Wiki

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



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).


Invert All Visibility

Students
Toggle Visibility



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


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

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


Visits
Toggle Visibility



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


Appointments
Toggle Visibility



Field Type Description Twig API SFTP Export
Sequence bigint A unique identifier for each appointment record. Appointments.Sequence ApptID
StartDT datetime The appointment start date and time. {{Appointment.StartDT}} Appointments.StartDT DateIn and TimeIn
StartTime time The appointment start time, formatted as "02:00pm". {{Appointment.StartTime}}
DisplayTime time The appointment start time, formatted as 200p. {{Appointment.DisplayTime|raw}}
StartDate date The appointment start date, formatted as "01/31/25". {{Appointment.StartDate}}
DisplayDate date The appointment start date, formatted as "Fri, Jan 31" or "Today" for same-day appointments. {{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. 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. {{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. Possible values are listed below.


0 = In-person
1 = Online
2 = Asynchronous
3 = Phone

 {{Appointment.Online}} Appointments.Online Appointment Meeting Type

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 or Group. {{Appointment.Type}} ApptType
Icon An icon that indicates the appointment type. for in-person and for online. {{Appointment.Icon|raw}}
hasDocument varchar Whether or not the appointment has a document uploaded, displayed as "true" or "false". {{Appointment.hasDocument}}
OnlineText varchar If the appointment is online, this tag will display as "Online", otherwise it will be blank. {{Appointment.OnlineText}}
isRecurring varchar Whether or not the appointment is recurring, displayed as "true" or "false". {{Appointment.isRecurring}}
RecurringDates varchar An array of recurring appointments in the series. {{Appointment.RecurringDates}}
recurFirstDate date The first date of a recurring appointment series. {{Appointment.recurFirstDate}}
recurLastDate date The last date of a recurring appointment series. {{Appointment.recurLastDate}}
isCancelled varchar Whether or not the appointment is currently canceled, displayed as "true" or "false". {{Appointment.isCanceled}}
isMissed varchar Whether or not the appointment is currently missed, displayed as "true" or "false". {{Appointment.isMissed}}
autoCanceled varchar Whether or not the appointment was automatically canceled due to max cancel/missed in recurring series rules, displayed as "true" or "false". {{Appointment.autoCanceled}}
SchedDT datetime The date and time this appointment was scheduled. {{Appointment.SchedDT}} Appointments.SchedDT ApptScheduledDT
SchedModDT datetime The date and time this appointment was last modified {{Appointment.SchedModDT}} Appointments.SchedModDT ApptModifiedDT
SchedUser varchar(80) The user who originally scheduled this appointment. {{Appointment.SchedUser}} Appointments.SchedUser ScheduledBy
SchedNotes text Unused. SchedNotes
SurveyRespID bigint Relates to Responses.Sequence. Appointments.SurveyRespID
CustomData json All custom fields are stored in this field. Specify a custom field with its sequence number after "cf_". {{Appointment.CustomData.cf_123}} Appointments.CustomData->>``$.cf_123`` [Field Name]
SchedModBy varchar(80) The user who last edited the appointment. {{Appointment.SchedModBy}} Appointments.SchedModBy ApptModifiedBy


Availabilities
Toggle Visibility



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


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

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


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



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


Staff/Consultants
Toggle Visibility



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 ConsultantFirst
Last_Name varchar(80) The staff member's last name. {{Consultant.Last_Name}}* Staff.Last_Name ConsultantLast
LastFirst varchar(255) The staff member's full name, formatted as "Last, First". {{Consultant.LastFirst}}* Staff.LastFirst
FirstLast varchar(255) The staff member's full name, formatted as "First Last". {{Consultant.FirstLast}}* Staff.FirstLast
Alias varchar(120) The staff member's alias/alternative name. {{Consultant.Alias}}* Staff.Alias ConsultantAlias
Email varchar(120) The staff member's email address. {{Consultant.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 ConsultantUserName
UserLevel int The staff member's user level. The possible options are listed below.


0 = Staff
1 = SysAdmin
2 = Profile Admin

 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
CellPhone varchar(80) The staff member's cell phone number. {{Consultant.CellPhone}}* Staff.CellPhone
WorkPhone varchar(80) The staff member's work phone number. {{Consultant.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}}*CustomData.cf_123}}</nowiki> 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
Pronouns varchar(80) The staff member's preferred pronouns. {{Consultant.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.Photo|raw}}*

* 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.


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



Profiles
Field Type Description API
Sequence bigint Unique identifer for each profile. Profiles.Sequence
Type int The type of profile. Possible values are listed below.


1 = TutorTrac
2 = AdvisorTrac
3 = FitnessTrac

 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
Centers
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
Reasons
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.Reason 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
Groups
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


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



Surveys
Field Type Description Twig API
Sequence bigint Unique identifer for each survey. Surveys.Sequence
Name varchar(80) The title of the survey. {{Survey.Name}} Surveys.Name
CreatedBy bigint The user who created the survey, relates to Staff.Sequence. Surveys.CreatedBy
ProfileID bigint Which profile this survey is linked to, relates to Profiles.Sequence. Surveys.ProfileID
AutoSend varchar(80) The chosen "Initiated Via" option. Surveys.AutoSend
Active tinyint Whether or not this survey is currently active. Surveys.Active
ActiveFrom date The start date of the survey period. Surveys.ActiveFrom
ActiveTo date The end date of the survey period. Surveys.ActiveTo
Instructions text The instructions displayed to the recipient when filling out the survey. Surveys.Instructions
Confirmation text The text shown to the recipient after submitting a response. Surveys.Confirmation
HeadText text The survey title shown to the recipient above the questions. Surveys.HeadText
SrvyQuestions
Field Type Description API
Sequence bigint Unique identifer for each survey question. SrvyQuestions.Sequence
Question text The question text. SrvyQuestions.Question
SurveyID bigint Which survey the question is assigned to, relates to Surveys.Sequence. SrvyQuestions.SurveyID
Points double How many points a correct answer is worth (more info. SrvyQuestions.Points
AnswerChoices text The available answers students can select from. SrvyQuestions.AnswerChoices
Type varchar(80) The format/type of question. SrvyQuestions.Type
Number int The question number; the value that determines question order. SrvyQuestions.Number
Responses
Field Type Description API
Sequence bigint Unique identifer for each survey response. Responses.Sequence
SurveyID bigint Which survey this response is linked to, relates to Surveys.Sequence. Responses.Sequence
linkedUID varchar(36) The UUID of the person who answered this survey. Responses.linkedUID
SentByID 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
StudentID bigint The student recipient, relates to Students.Sequence (not Students.ID). Responses.StudentID
SentBy varchar(80) Same as SentByID, except in the case of surveys sent by staff this field will display username instead of UUID. Responses.SentBy
SentDate datetime The date and time this survey was sent to the recipient. Responses.SentDate
AnsweredDate datetime The date and time the recipient responded to the survey. This will be null if no response has been received. Responses.AnsweredDate
StaffID bigint The staff recipient, relates to Staff.Sequence. Responses.StaffID
FacultyID bigint The faculty recipient, relates to Faculty.Sequence. Responses.FacultyID
SentManually tinyint Whether or not this survey was manually sent to the recipient. Responses.SentManually
SrvyRespAnswers
Field Type Description API
Sequence bigint Unique identifer for each question response. SrvyRespAnswers.Sequence
QuestionID bigint Which question this response relates to, relates to SrvyQuestions.Sequence. SrvyRespAnswers.QuestionID
ResponseID bigint Which survey response this question response relates to, relates to Responses.Sequence. SrvyRespAnswers.ResponseID
tAnswer varchar(80) The recipient's answer to the question SrvyRespAnswers.tAnswer


Document Related (Documents, DocTypes)
Toggle Visibility



Documents
Field Type Description Twig API
Sequence bigint Unique identifer for each document. Documents.Sequence
linkedUID varchar(36) The UUID of the user account this document is upload to, for Student/Staff documents. Documents.linkedUID
Usage varchar(255) Where this document is uploaded. Possible values are listed below.


student
staff
appointment
visit
availability
group
survey

 {{Document.Usage}} Documents.Usage
StudentID bigint Which student record this document is related to, relates to Students.Sequence (not Students.ID). Documents.StudentID
StaffID bigint Which staff record this document is related to, relates to Staff.Sequence. Documents.StaffID
DocTypeID bigint Which document type this document is related to, relates to DocTypes.Sequence. Documents.DocTypeID
Date datetime The date and time this document was uploaded. Documents.Date
Notes text The document notes. {{Document.Notes}} Documents.Notes
PostedBy varchar(255) The UUID of the user who uploaded the document. {{Document.PostedBy}} Documents.PostedBy
PostedByName The user type, sequence, and name of the user who uploaded this document. {{Document.PostedByName}}
OrigName varchar(512) The name of the document. {{Document.OrigName}} Documents.OrigName
LinkedApptID bigint Which appointment record this document is related to, relates to Appointments.Sequence. Documents.LinkedApptID
Type varchar(255) The document type. Documents.Type
SizeK double The file size (in KiB) Documents.SizeK
Inactive tinyint Whether or not this document is marked as inactive. Documents.Inactive
LinkedAvailRecID bigint Which availability record this document is related to, relates to AvailBlocks.Sequence. Documents.LinkedAvailRecID
LinkedVisitID bigint Which visit record this document is related to, relates to Visits.Sequence. Documents.LinkedVisitID
DocTypes
Field Type Description Twig API
Sequence bigint Unique identifer for each document type. DocTypes.Sequence
Name varchar(255) The name of the document type. {{DocType.Name}} DocTypes.Name
Inactive tinyint Whether or not this document type is inactive. DocTypes.Inactive


Resource Related (Resources, ResourceTypes, Checkouts)
Toggle Visibility



Resources
Field Type Description Twig API
Sequence bigint Unique identifer for each resource. Resources.Sequence
Title varchar(80) The name of the resource. {{Resource.Title}}
BarCode varchar(20) The barcode value of the resource. {{Resource.BarCode}} Resources.BarCode
Description text The description of the resource. {{Resource.Description}} Resources.Description
Keywords varchar(80) The keywords for thsi resource, used to find the resource during checkout. {{Resource.Keywords}} Resources.Keywords
Status int The status of this resource, possible values are listed below.


-1 = Inactive
0 = Checked out
1 = Available
2 = Always available

 {{Resource.Status}} Resources.Status
MaxDaysOut int The maximum number of days that an item can be checked out. {{Resource.MaxDaysOut}} Resources.MaxDaysOut
LastDTOut datetime The date an time this item was last checked out. Resources.LastDTOut
MaxTimeOut time The maximum amount of time that an item can be checked out. {{Resource.MaxTimeOut}} Resources.MaxTimeOut
DueDT datetime The date and time this item is due to be returned. This will match Checkouts.DueDT of the most recent checkout. Resources.DueDT
Type int The resource type, relates to ResourceTypes.Sequence. Resources.Type
Inactive tinyint Whether or not this resource is currently inactive. Resources.Inactive
ProfileID bigint Which profile this resource is assigned to, relates to Profiles.Sequence. Resources.ProfileID
AlwaysAvailable tinyint Whether or not this resource is designated as always available. Resources.AlwaysAvailable
MaxRenews int The maximum number of times a checkout for this resource can be renewed. Resources.MaxRenews
CollateralLogic tinyint Whether or not this resource requires collateral to be checked out. Resources.CollateralLogic
LastOutToUUID varchar(46) The UUID of the last user to check this resource out. Resources.LastOutToUUID
PickupInstructions Instructions for resource pickup. {{Resource.CustomData.PickupInstructions}}
ReturnInstructions Instructions for resource return. {{Resource.CustomData.ReturnInstructions}}
ResourceTypes
Field Type Description Twig API
Sequence bigint Unique identifer for each resource type. ResourceTypes.Sequence
Name varchar(80) The name of the resource type/category that resources are assigned to. {{ResourceType.Name}} ResourceTypes.Name
Description varchar(255) The description of the resource type. {{ResourceType.Description}} ResourceTypes.Description
Checkouts
Field Type Description Twig API
Sequence bigint Unique identifer for each checkout. Checkouts.Sequence
ResourceID bigint Which resource this checkout is for, relates to Resources.Sequence. Checkouts.ResourceID
Date datetime The date and time of the checkout. {{Checkout.Date}} Checkouts.Date
ReturnedDT datetime The date and time the checkout was returned. Checkouts.ReturnedDT
TotalTimeHrs double The total number of hours the resource was checked out for. Checkouts.TotalTimeHrs
Collateral varchar(80) The collateral for checkout. {{Checkout.Collateral}} Checkouts.Collateral
Notes text The notes in the checkout record. Checkouts.Notes
Overdue tinyint Whether or not this checkout is overdue. {{Checkout.Overdue}} Checkouts.Overdue
DueDT datetime The date and time the checkout is due to be returned. {{Checkout.DueDT}} Checkouts.DueDT
CheckedOutToUUID varchar(46) The UUID of the user who checked out this resource. Checkouts.CheckedOutToUUID
CheckedOutToType varchar(80) What type of user checked out this resource (Student or Staff). Checkouts.CheckedOutToType


Workshops
Toggle Visibility



Field Type Description Twig API
Sequence bigint Unique identifer for each workshop. Workshops.Sequence
CenterID bigint Which center this workshop is assigned to, relates to Centers.Sequence. Workshops.CenterID
ReasonID bigint Which reason this workshop is assigned to, relates to Reasons.Sequence. Workshops.ReasonID
Name varchar(255) The name of the workshop. {{Workshop.Name}} Workshops.Name
Instructor varchar(255) The instructor of the workshop. {{Workshop.Instructor}} Workshops.Instructor
RosterSubject json Contains the subject, course, and section code of the workshop. Workshops.RosterSubject
RosterSubject.Subject varchar(40) The workshop subject. {{Workshop.RosterSubject.Subject}}
RosterSubject.Course varchar(20) The workshop course. {{Workshop.RosterSubject.Course}}
RosterSubject.Section varchar(80) The workshop section code. {{Workshop.RosterSubject.Section}}
StudentLinkedListID bigint The list of students this workshop is restricted to, relates to Lists.Sequence. Workshops.StudentLinkedListID
Description text The description of the workshop. {{Workshop.Description}} Workshops.Description
AssignmentID bigint Which potential assignment this workshop is assigned to, relates to Assignments.Sequence. Workshops.AssignmentID
CreatedDT datetime The date and time this workshop was created. {{Workshop.CreatedDT}} Workshops.CreatedDT
DateFrom datetime The start date and time of the workshop. {{Workshop.DateFrom}} Workshops.DateFrom
StartDate The start date of the workshop. {{Workshop.StartDate}}
StartTime The start time of the workshop. {{Workshop.StartTime}}
DateTo datetime The end date and time of the workshop. {{Workshop.DateTo}} Workshops.DateTo
EndDate The end date of the workshop. {{Workshop.EndDate}} Workshops.EndDate
EndTime The end time of the workshop. {{Workshop.EndTime}} Workshops.EndTime
EnrolledDate The date of student enrollment. {{WorkshopsRoster.EnrolledDate}}


Custom Fields
Toggle Visibility



Replace '123' in the Twig examples with the sequence of your custom field.
Field Type Description Twig API
Sequence bigint Unique identifer for each workshop. CustomDataTypes.Sequence
DataName varchar(80) The internal name of the custom field (different than prompt). CustomFields.cf_123.DataName CustomDataTypes.DataName
Location varchar(80) Where the custom field is located. Possible values are listed below.


Appointment - Consultant
Appointment - Student
Availability
Certification
Consultant
Document
Faculty
Reason
Registration
Resource
Section
SI_Session
Student - Campus
Student - Custom1
Student - Custom2
Student - Custom3
Student - Custom4
Student - Custom5
Student - Other Info
Student - QuickStudent
Visit - Consultant
Visit - Q2 Raise Hand
Visit - Student

 CustomDataTypes.Location
Prompt text The visible name of the custom field (what students see). CustomFields.cf_123.Prompt CustomDataTypes.Prompt
Choices text The available list of choices for custom fields with predefined answers. CustomFields.cf_123.Choices CustomDataTypes.Choices
InputType varchar(80) What type of custom field this is. Possible values are listed below.


field
areafield
leftcheckfield
multicheckfield
radiofield
radioimagefield
toggle
menufield
imagemenufield
imagepopfield
signaturefield
uploaddocfield
popfield
labeledhtml
infohtml
headerhtml
group

 CustomDataTypes.InputType
ProfileID bigint Which profile this custom field is linked to, 0 is all. Relates to Profiles.Sequence. CustomDataTypes.ProfileID


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



SuccessPlan
Field Type Description Twig API
Sequence bigint Unique identifer for each success plan. SuccessPlan.Sequence
Name varchar(120) The name of the success plan. {{SuccessPlan.Name}} SuccessPlan.Name
ProfileID bigint Which profile this success plan is assigned to, relates to Profiles.Sequence. SuccessPlan.ProfileID
Inactive tinyint Whether or not this success plan is currently inactive. SuccessPlan.Inactive
SPSteps
Field Type Description Twig API
Sequence bigint Unique identifer for each success plan step. {{SPStep.Sequence}} SPSteps.Sequence
SuccessPlanID bigint Which success plan this step is assgined to. {{SPStep.}} SPSteps.SuccessPlanID
Type varchar(120) What type of step this is. Possible values are listed below.


Visit
Survey
Document
Task
Checkout
Notification
Prompt

 {{SPStep.Type}} SPSteps.Type
DateOrOffset varchar(36) When this Step needs to be completed (number of days or static date based on Plan type) {{SPStep.DateOrOffset}} SPSteps.DateOrOffset
isOptional tinyint Whether or not the step is optional. {{SPStep.isOptional}} SPSteps.isOptional
isNoSendEmails tinyint Whether or not emails are disabled for this step. {{SPStep.isNoSendEmails}} SPSteps.isNoSendEmails
isPromptOnDash tinyint Whether or not the prompt is set to display on the dashboard. {{SPStep.isPromptOnDash}} SPSteps.isPromptOnDash
DirectedTo int Who the confirmation is directed to. Possible values are listed below.


0 = Student
1 = Plan Staff
2 = Plan Faculty
3 = Step Staff
4 = Step Faculty

 {{SPStep.DirectedTo}} SPSteps.DirectedTo
OverrideRequireConfirmation int Whether or not this step has been overridden to allow/disallow confirmation. {{SPStep.OverrideRequireConfirmation}} SPSteps.OverrideRequireConfirmation
SPAssigned
Field Type Description Twig API
Sequence bigint Unique identifer for each assigned success plan. SPAssigned.Sequence
SuccessPlanID bigint What type of success plan this is, relates to SuccessPlan.Sequence SPAssigned.SuccessPlanID
StudentID bigint Which student this plan is assigned to, relates to Students.Sequence (not Students.ID). SPAssigned.StudentID
ConsultantID bigint The assigned plan consultant, relates to Staff.Sequence. SPAssigned.ConsultantID
DateStarted date The date the plan began. {{SPAssigned.DateStarted}} SPAssigned.DateStarted
DateCompleted date The date the plan was completed. {{SPAssigned.DateCompleted}} SPAssigned.DateCompleted
DueDate date The date the plan is due for completion. {{SPAssigned.DueDate}} SPAssigned.DueDate
TermID bigint The term this plan is linked to, relates to Terms.Sequence. SPAssigned.TermID
Inactive tinyint Whether or not this plan is inactive. SPAssigned.Inactive
Status varchar(120) The status of the plan. Possible values are listed below.


In Progress
Complete
Overdue

 {{SPAssigned.Status}} SPAssigned.Status
Percent int The completion percentage of the plan. {{SPAssigned.Percent}} SPAssigned.Percent
FacultyID bigint The faculty assigned to the plan, relates to Faculty.Sequence (not Faculty.UserID). SPAssigned.FacultyID
DashboardStatus The HTML text that would appear on the student's main menu showing their progress in the plan. {{SPAssigned.DashboardStatus|raw}}
SPAssignedSteps
Field Type Description Twig API
Sequence bigint Unique identifer for each assigned success plan step. SPAssignedSteps.Sequence
SPAssignedID bigint Which assigned success plan this is assigned to, relates to SPAssigned.Sequence. SPAssignedSteps.SPAssignedID
StudentID bigint Which student this is assigned to, relates to Students.Sequence (not Students.ID). SPAssignedSteps.StudentID
SPStepID bigint Which success plan step this relates to, relates to SPSteps.Sequence SPAssignedSteps.SPStepID
CompletedDate date The date this step was completed. {{SPAssignedStep.CompletedDate}} SPAssignedSteps.CompletedDate
DueDate date The date this step was due to be completed. {{SPAssignedStep.DueDate}} SPAssignedSteps.DueDate
CompletionOverride tinyint Whether or not the completion override option is enabled for this step. {{SPAssignedStep.CompletionOverride}} SPAssignedSteps.CompletionOverride
StaffNotes text Any notes entered by the staff for this step. {{SPAssignedStep.StaffNotes}} SPAssignedSteps.StaffNotes
Confirmed tinyint Whether or not this step has been confirmed. {{SPAssignedStep.Confirmed}} SPAssignedSteps.Confirmed
StepFacultyID bigint Which faculty this step is assigned to, relates to Faculty.Sequence (not Faculty.UserID). {{SPAssignedStep.StepFacultyID}} SPAssignedSteps.StepFacultyID
StepConsultantID bigint Which staff record this step is assigned to, relates to Staff.Sequence. {{SPAssignedStep.StepConsultantID}} SPAssignedSteps.StepConsultantID
Index The number of the step, based on the order they were created in. {{SPAssignedStep.Index}}
PartialStepValue 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. {{SPAssignedStep.CustomData|json_decode.PartialStepValue}}


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



WorkPlan
Field Type Description Twig API
Sequence bigint Unique identifer for each work plan. WorkPlan.Sequence
Name varchar(120) The name of the work plan. {{WorkPlan.Name}} WorkPlan.Name
ProfileID bigint Which profile this work plan is assigned to, relates to Profiles.Sequence. WorkPlan.ProfileID
Inactive tinyint Whether or not this work plan is currently inactive. WorkPlan.Inactive
WPSteps
Field Type Description Twig API
Sequence bigint Unique identifer for each work plan step. {{WPStep.Sequence}} WPSteps.Sequence
WorkPlanID bigint Which work plan this step is assgined to. {{WPStep.}} WPSteps.WorkPlanID
Type varchar(120) What type of step this is. Possible values are listed below.


Work Visit
Consultation Visit
Appointment
Survey
Document
Task
Checkout
Notification
Prompt

 {{WPStep.Type}} WPSteps.Type
DateOrOffset varchar(36) When this Step needs to be completed (number of days or static date based on Plan type) {{WPStep.DateOrOffset}} WPSteps.DateOrOffset
isOptional tinyint Whether or not the step is optional. {{WPStep.isOptional}} WPSteps.isOptional
isNoSendEmails tinyint Whether or not emails are disabled for this step. {{WPStep.isNoSendEmails}} WPSteps.isNoSendEmails
isPromptOnDash tinyint Whether or not the prompt is set to display on the dashboard. {{WPStep.isPromptOnDash}} WPSteps.isPromptOnDash
DirectedTo int Who the confirmation is directed to. Possible values are listed below.


0 = Consultant
1 = Plan Supervisor
3 = No Prompt

 {{WPStep.DirectedTo}} WPSteps.DirectedTo
OverrideRequireConfirmation int Whether or not this step has been overridden to allow/disallow confirmation. {{WPStep.OverrideRequireConfirmation}} WPSteps.OverrideRequireConfirmation
WPAssigned
Field Type Description Twig API
Sequence bigint Unique identifer for each assigned work plan. WPAssigned.Sequence
WorkPlanID bigint What type of work plan this is, relates to WorkPlan.Sequence WPAssigned.WorkPlanID
ConsultantID bigint The assigned plan consultant, relates to Staff.Sequence. WPAssigned.ConsultantID
SupervisorID bigint The assigned supervisor for this work plan, relates to Staff.Sequence. WPAssigned.SupervisorID
DateStarted date The date the plan began. {{WPAssigned.DateStarted}} WPAssigned.DateStarted
DateCompleted date The date the plan was completed. {{WPAssigned.DateCompleted}} WPAssigned.DateCompleted
DueDate date The date the plan is due for completion. {{WPAssigned.DueDate}} WPAssigned.DueDate
TermID bigint The term this plan is linked to, relates to Terms.Sequence. WPAssigned.TermID
Inactive tinyint Whether or not this plan is inactive. WPAssigned.Inactive
Status varchar(120) The status of the plan. Possible values are listed below.


In Progress
Complete
Overdue

 {{WPAssigned.Status}} WPAssigned.Status
Percent int The completion percentage of the plan. {{WPAssigned.Percent}} WPAssigned.Percent
WPAssignedSteps
Field Type Description Twig API
Sequence bigint Unique identifer for each assigned work plan step. WPAssignedSteps.Sequence
WPAssignedID bigint Which assigned work plan this is assigned to, relates to WPAssigned.Sequence. WPAssignedSteps.WPAssignedID
ConsultantID bigint Which consultant this is assigned to, relates to Staff.Sequence. WPAssignedSteps.ConsultantID
WPStepID bigint Which work plan step this relates to, relates to WPSteps.Sequence WPAssignedSteps.WPStepID
CompletedDate date The date this step was completed. {{WPAssignedStep.CompletedDate}} WPAssignedSteps.CompletedDate
DueDate date The date this step was due to be completed. {{WPAssignedStep.DueDate}} WPAssignedSteps.DueDate
CompletionOverride tinyint Whether or not the completion override option is enabled for this step. {{WPAssignedStep.CompletionOverride}} WPAssignedSteps.CompletionOverride
StaffNotes text Any notes entered by the staff for this step. {{WPAssignedStep.StaffNotes}} WPAssignedSteps.StaffNotes
Confirmed tinyint Whether or not this step has been confirmed. {{WPAssignedStep.Confirmed}} WPAssignedSteps.Confirmed
StepSupervisorID bigint Which supervisor this step is assigned to, relates to Staff.Sequence. {{WPAssignedStep.StepSupervisorID}} WPAssignedSteps.StepSupervisorID


SAGE Related (ReferralType, Referrals)
Toggle Visibility



ReferralType
Field Type Description Twig API
Sequence bigint Unique identifer for each referral type. ReferralType.Sequence
Name varchar(255) The name of the referral type. {{ReferralType.Name}} ReferralType.Name
RosterSubject json This array contains information about what subject(s) this referral type is linked to. ReferralType.RosterSubject
StudentLinkedListID bigint Which student list this referral type is limited to, relates to Lists.Sequence. ReferralType.StudentLinkedListID
Active tinyint Whether or not this referral type is currently active. ReferralType.Active
NotesInstructions text The contents of the notes instructions field. {{ReferralType.NotesInstructions}} ReferralType.NotesInstructions
Reasons json An array of all of this referral type's reasons. {{ReferralType.Reasons}} ReferralType.Reasons
Recommend json An array of all of this referral type's recommendations. {{ReferralType.Recommend}} ReferralType.Recommend
AdditionalNotesInstr text The contents of the additional notes instrucitons field. {{ReferralType.AdditionalNotesInstr}} ReferralType.AdditionalNotesInstr
OtherInstructions text The contents of the other instructions field. {{ReferralType.OtherInstructions}} ReferralType.OtherInstructions
Referrals
Field Type Description Twig API
Sequence bigint Unique identifer for each referral. Referrals.Sequence
RefTypeID bigint Which referral type this referral is linked to, relates to ReferralType.Sequence Referrals.RefTypeID
StudentID bigint Which student this referral is assigned to, relates to Students.Sequence (not Students.ID). Referrals.StudentID
FacultyID bigint Which faculty this referral is linked to, relates to Faculty.Sequence (not Faculty.UserID). Referrals.FacultyID
SectionID bigint Which section this referral is linked to, relates to Sections.Sequence. Referrals.SectionID
ConsultantID bigint Which consultant this referral is linked to, relates to Staff.Sequence. Referrals.ConsultantID
CenterID bigint Which center this referral is linked to, relates to Centers.Sequence. Referrals.CenterID
CreatedDT datetime The date and time this referral was created. {{Referrals.CreatedDT}} Referrals.CreatedDT
CreatedBy varchar(255) Who created this referral, either a faculty or staff member. {{Referrals.CreatedBy}} Referrals.CreatedBy
NotesInstrData text Notes entered while the referral is being submitted. {{Referrals.NotesInstrData}} Referrals.NotesInstrData
ReasonsData json An array of chosen reasons in this referral. Reasons* Referrals.ReasonsData
ReasonsAndLabels Same as above, but this array will also include the reason labels. ReasonsAndLabels*
RecommendData json An array of chosen recommendations in this referral. Recommendations* Referrals.RecommendData
RecommendationsAndLabels Same as above, but this array will also include the recommendation labels. RecommendationsAndLabels*
AdditionalNotes text Additional notes entered during referral submission. {{Referrals.AdditionalNotes}} Referrals.AdditionalNotes
FollowUpDate date The specified follow-up date from the referral. {{Referrals.FollowUpDate}} Referrals.FollowUpDate
FollowUpBy varchar(255) The name of the user who followed up on this referral. {{Referrals.FollowUpBy}} Referrals.FollowUpBy
FollowedUp tinyint Whether or not this referral has been followed up on. {{Referrals.FollowedUp}} Referrals.FollowedUp
FollowedUpDT datetime The date and time this referral was followed up on. {{Referrals.FollowedUpDT}} Referrals.FollowedUpDT
Processed tinyint Whether or not this referral has been processed (resolved). {{Referrals.Processed}} Referrals.Processed
ProcessedDT datetime The date and time this referral was processed. {{Referrals.ProcessedDT}} Referrals.ProcessedDT
ProcessedBy varchar(255) The user who processed this referral. {{Referrals.ProcessedBy}} Referrals.ProcessedBy
ProcessedNotes text Notes entered while the referral was being processed. {{Referrals.ProcessedNotes}} Referrals.ProcessedNotes
StudentContacted date The date the student was contacted about this referral. {{Referrals.StudentContacted}} Referrals.StudentContacted
OverrideResend tinyint Whether or not the 'Override and resend' feature has been used. Referrals.OverrideResend
AssignedConsultant varchar(255) The name of the consultant or advisor assigned to this referral. {{Referrals.AssignedConsultant}} Referrals.AssignedConsultant
AssignedConsultantID varchar(255) The sequence number of the assigned consultant, relates to Staff.Sequence. {{Referral.CustomData.AssignedConsultantID}}


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