View source for TracCloudReportsDescriptions

<b>This template is used to provide descriptions throughout the TracCloud Reports guide. If you've ended up here by mistake, [[TracCloudReports|click here to return to the Reports wiki.]]</b>

Every description can potentially be used across multiple Report articles. Do not use specific examples on this page unless needed, and add "_ReportName" to differentiate them in those cases.

Transclude sections like this: <nowiki>{{#lst:Template:TracCloudReportsDescriptions|TimeFrame}}</nowiki>, replacing 'TimeFrame' with the relevant description code below.<br><br>

Centers
<section begin="Centers" />
* <b>Centers</b>
::Filter report data by center. You can select all centers or only a specific few to narrow down your results. At least one center must be selected.
<section end="Centers" />

TimeFrame
<section begin="TimeFrame" />
* <b>Time Frame</b>
::The date range for the data in this report. Beyond entering a date range manually, you can also choose a preset date range (Today, This Month, This Semester, etc) from the dropdown list above.
<section end="TimeFrame" />

SecondTimeFrame
<section begin="SecondTimeFrame" />
* <b>Secondary Time Frame</b>
::An additional date range for data comparison.
<section end="SecondTimeFrame" />

ChartType
<section begin="ChartType" />
* <b>Chart Type</b>
::This allows you to select the format of the chart. Pie, bar, or line.
<section end="ChartType" />

Increment
<section begin="Increment" />
* <b>Increment</b>
::Select your preferred time increment. I.e., separate results in increments of 1 hour, 30 minutes, or 15 minutes.
<section end="Increment" />

ShowBarChart
<section begin="ShowBarChart" />
* <b>Show bar chart</b>
::Adds a visual bar chart to your report data.
<section end="ShowBarChart" />

ShowTotalsChart
<section begin="ShowTotalsChart" />
* <b>Show Totals Bar Chart</b>
::Adds a visual bar chart of totals to your report data.
<section end="ShowTotalsChart" />

DataTableTotals
<section begin="DataTableTotals" />
* <b>Show data table with totals</b>
::Adds a data table to the report, listing out the results separately from a bar chart.
<section end="DataTableTotals" />

InPersonOnline
<section begin="InPersonOnline" />
* <b>In-Person/Online</b>
::Filter the data in this report to only include In-Person or Online records. Defaults to All.
<section end="InPersonOnline" />

ShowOnlineSpecifically
<section begin="ShowOnlineSpecifically" />
* <b>Show online locations specifically</b>
::If unchecked, the 'Location' for online Appts/Visits will be displayed as simply 'Online.' If this option is checked, it will display the specific online location (e.g., '<nowiki>https://zoom.us/123456789</nowiki>').
<section end="ShowOnlineSpecifically" />

OutputFormat
<section begin="OutputFormat" />
* <b>Output format</b>
::Use HTML to view report data in your browser, or export this report to a CSV file (available for most reports). Some reports offer additional CSV options depending on if you want to include totals and/or data grouping in your export.
<section end="OutputFormat" />

DeliverTo
<section begin="DeliverTo" />
* <b>Deliver to</b>
::Display this report immediately in your browser ("Screen"), or send the report to a specified email address ("Email"). Multiple email addresses can be specified, use ; to separate them (example@example.edu;sample@example.edu).
<section end="DeliverTo" />

ShowSummary
<section begin="ShowSummary" />
* <b>Show Summary</b>
::Only show data totals, excluding details of individual records.
<section end="ShowSummary" />

ShowWorkVisits
<section begin="ShowWorkVisits" />
* <b>Show Work Visits</b>
::Include consultant work visits in report results.
<section end="ShowWorkVisits" />

CalculateTotals
<section begin="CalculateTotals" />
* <b>Calculate Totals</b>
::Include data totals in report results.
<section end="CalculateTotals" />

SortBy
<section begin="SortBy" />
* <b>Sort by</b>
::Choose how the selected data is sorted.
<section end="SortBy" />

ChartBy
<section begin="ChartBy" />
* <b>Chart by</b>
::Choose how the selected data is sorted in charts.
<section end="ChartBy" />

GroupBy
<section begin="GroupBy" />
* <b>Group by</b>
::Group records by the selected field. Some reports allow you to add secondary and tertiary groupings as well.
<section end="GroupBy" />

SearchGroup
<section begin="SearchGroup" />
* <b>Search Group</b>
::Filter results based on your search in this group. For example, if you're grouping by Student Major, you can put 'Mathematics' in this field to only show students assigned to that Major.
<section end="SearchGroup" />

AdditionalSearch
<section begin="AdditionalSearch" />
* <b>Additional Search</b>
::Filter your results by a selected field.<br>Use * as a wildcard (Subject: MAT*)<br>| as "or" (Major: Mathematics|Biology)<br># as "Not" (Status: #Inactive)<br>&& as "And" (Major: #Mathematics&&#Biology)<br>blankornull as a keyword to find records where the field is blank (Reason: blankornull)<br>Multiple fields can be added to further narrow down your results.
<section end="AdditionalSearch" />

AdditionalFieldsToShow
<section begin="AdditionalFieldsToShow" />
* <b>Additional fields to show</b>
::This can be used to add additional data fields to the report results. For example, you could use this to add a student's email address in a visit report.
<section end="AdditionalFieldsToShow" />

VisitTimeFormat
<section begin="VisitTimeFormat" />
* <b>Time Format</b>
::This determines the format of duration, a 90-minute session could display as 1.50, 01:30:00, or 01:30.
<section end="VisitTimeFormat" />

DecimalAccuracy
<section begin="DecimalAccuracy" />
* <b>Decimal Accuracy</b>
::This determines the decimal accuracy of duration data. Defaults to 2, showing a 1-hour session as "1.00".
<section end="DecimalAccuracy" />

IgnoreCenterCourseListSubject
<section begin="IgnoreCenterCourseListSubject" />
* <b>Ignore Center Course Lists for Subjects</b>
::Ignore the selected centers and show all specialties regardless of center for subject.
<section end="IgnoreCenterCourseListSubject" />

IgnoreCenterStaffReason
<section begin="IgnoreCenterStaffReason" />
* <b>Ignore Center Staff Link for Reasons</b>
::Ignore the selected centers and show all specialties regardless of center for reason.
<section end="IgnoreCenterStaffReason" />

IgnoreSectionForSubj
<section begin="IgnoreSectionForSubj" />
* <b>Ignore Section for Subjects</b>
::Only view specialties by subject, rather than subject + section.
<section end="IgnoreSectionForSubj" />

ShowOnlyActiveSections
<section begin="ShowOnlyActiveSections" />
* <b>Show Only Active Sections</b>
::Only include active sections in this report.
<section end="ShowOnlyActiveSections" />

SelectTerm
<section begin="SelectTerm" />
* <b>Select Term</b>
::Only show records for the selected term.
<section end="SelectTerm" />

ShowWhichSpecialties
<section begin="ShowWhichSpecialties" />
* <b>Show Which Specialties</b>
::Only show sections that have already been Assigned to a consultant, or view Sections that are still Unassigned. Defaults to 'All'.
<section end="ShowWhichSpecialties" />

ShowAttendanceHourDayWk
<section begin="ShowAttendanceHourDayWk" />
* <b>Show Attendance by Hour by Day of Week</b>
::This will include an additional graph displaying how many visits took place per day of week in addition to the hour-by-hour breakdown.
<section end="ShowAttendanceHourDayWk" />

GroupByStudent
<section begin="GroupByStudent" />
* <b>Group by Student</b>
::This option will group individual records by student name.
<section end="GroupByStudent" />

ApplyDateRange
<section begin="ApplyDateRange" />
* <b>Apply Date Range to</b>
::Choose what your selected date range is in reference to. Defaults to any matching date range.
<section end="ApplyDateRange" />

ShowEmail
<section begin="ShowEmail" />
* <b>Show Email</b>
::Include email address in results.
<section end="ShowEmail" />

ShowNotes
<section begin="ShowNotes" />
* <b>Show Notes</b>
::Include the contents of the Notes field in report results.
<section end="ShowNotes" />

ShowPhone
<section begin="ShowPhone" />
* <b>Show Phone</b>
::Include phone number in results.
<section end="ShowPhone" />

ShowDescription
<section begin="ShowDescription" />
* <b>Show Description</b>
::Include record description in results.
<section end="ShowDescription" />

ShowVisitDetails
<section begin="ShowVisitDetails" />
* <b>Show Visit Details</b>
::If checked, the Subject, Reason, Consultant, and Center of the visit will be included in the results.
<section end="ShowVisitDetails" />

ShowApptDetails
<section begin="ShowApptDetails" />
* <b>Show Appointment Details</b>
::If checked, the Subject, Reason, Consultant, and Center of the appointment will be included in the results.
<section end="ShowApptDetails" />

ShowApptVisitDetails
<section begin="ShowApptVisitDetails" />
* <b>Show Appointment/Visit Details</b>
::If checked, the Dates/Times, Statuses, Consultants, and Centers of the appointments and visits will be included in the results.
<section end="ShowApptVisitDetails" />

ShowAvails
<section begin="ShowAvails" />
* <b>Show Availabilities</b>
::Include availability times in the report results.
<section end="ShowAvails" />

ShowReserved
<section begin="ShowReserved" />
* <b>ShowReserved</b>
::Include blocked or reserved schedule time in the report results.
<section end="ShowReserved" />

ShowCanceledAppts
<section begin="ShowCanceledAppts" />
* <b>Show Canceled Appointments</b>
::Include appointments that have been canceled in your report results.
<section end="ShowCanceledAppts" />

ShowDeletedAppts
<section begin="ShowDeletedAppts" />
* <b>Show Deleted Appointments</b>
::Include appointments that have been deleted (i.e., have a status of "Canceled - Deleted") in your report results.
<section end="ShowDeletedAppts" />

ApplyDatesToLastMod
<section begin="ApplyDatesToLastMod" />
* <b>Apply Dates to Appointment Last Modified</b>
::Your time frame choice is in reference to the date of the appointment that was booked. By checking this box, you will instead search for appointments that were last modified in the date range you provide.
<section end="ApplyDatesToLastMod" />

ShowFacultyInfo
<section begin="ShowFacultyInfo" />
* <b>Show Faculty Name and Email</b>
::Include [[TracCloudGuideListingsFaculty|Faculty]] Name and Email address in report results.
<section end="ShowFacultyInfo" />

ShowStudentID
<section begin="ShowStudentID" />
* <b>Show Student ID</b>
::Include Student ID in report results.
<section end="ShowStudentID" />

ShowStudentEmail
<section begin="ShowStudentEmail" />
* <b>Show Student Email</b>
::Include Student Email in report results.
<section end="ShowStudentEmail" />

StudentsWithoutVisits
<section begin="StudentsWithoutVisits" />
* <b>Include Students without Visits</b>
::Include all students in report results, even if they don't have any visit records.
<section end="StudentsWithoutVisits" />

ShowReason
<section begin="ShowReason" />
* <b>Show Reason</b>
::Include Reason in report results.
<section end="ShowReason" />

ShowSubject
<section begin="ShowSubject" />
* <b>Show Subject</b>
::Include Subject in report results.
<section end="ShowSubject" />

ShowLocation
<section begin="ShowLocation" />
* <b>Show Location</b>
::Include Location in report results.
<section end="ShowLocation" />

ShowStatus
<section begin="ShowStatus" />
* <b>Show Status</b>
::Include appointment status in report results.
<section end="ShowStatus" />

ShowAllConsultants
<section begin="ShowAllConsultants" />
* <b>Show All Consultants</b>
::Include all consultants in report results, regardless of if they're assigned to relevant records.
<section end="ShowAllConsultants" />

ShowConsultantEmail
<section begin="ShowConsultantEmail" />
* <b>Show Consultant Email</b>
::Include the consultant email address in report results.
<section end="ShowConsultantEmail" />

ShowOnlyAppts
<section begin="ShowOnlyAppts" />
* <b>Show Only Appointments</b>
::Only show appointments in report results, excluding availability data.
<section end="ShowOnlyAppts" />

ShowOnlyAvails
<section begin="ShowOnlyAvails" />
* <b>Show Only Availabilities</b>
::Only show availabilities in report results, excluding appointment data.
<section end="ShowOnlyAvails" />

ShowAllDates
<section begin="ShowAllDates" />
* <b>Show All Dates</b>
::Display all dates in report results, even if there are no relevant records on those dates.
<section end="ShowAllDates" />
</div>

ReasonSearch
<section begin="ReasonSearch" />
* <b>Reason</b>
::Only show results for the specific Reason.
<section end="ReasonSearch" />

SubjectSearch
<section begin="SubjectSearch" />
* <b>Subject/Course/Section</b>
::Only show results for the specific Subject, Course, or Section.
<section end="SubjectSearch" />

SubjectSearchCRN
<section begin="SubjectSearchCRN" />
* <b>Subject/Course/CRN</b>
::Only show results for the specific Subject, Course, or CRN.
<section end="SubjectSearchCRN" />

SkillsSearch
<section begin="SkillsSearch" />
* <b>Special Needs / Skills / Accommodations</b>
::Only show results for a specific Need/Skill/Accommodation.
<section end="SkillsSearch" />

SearchApptStatus
<section begin="SearchApptStatus" />
* <b>Search Appointment Status</b>
::Only show results for a specific appointment status.
<section end="SearchApptStatus" />

IncludeMissed
<section begin="IncludeMissed" />
* <b>Include Missed Appointments</b>
::Show Missed appointment records in the report results as well.
<section end="IncludeMissed" />

IncludeAsync
<section begin="IncludeAsync" />
* <b>Include Asynchronous Appointments</b>
::Show Asynchronous appointment records in the report results as well.
<section end="IncludeAsync" />

IncludeCanceled
<section begin="IncludeCanceled" />
* <b>Include Canceled Appointments</b>
::Show Canceled appointment records in the report results as well.
<section end="IncludeCanceled" />

ShowAutoCancel
<section begin="ShowAutoCancel" />
* <b>Show Auto Canceled Appointments</b>
::Include appointments that were automatically canceled in the report results. [[TracCloudGuideProfilePrefsEmails|More information.]]
<section end="ShowAutoCancel" />

AddUnattendedSession
<section begin="AddUnattendedSession" />
* <b>Additional Unattended Sessions</b>
::Specify additional unattended SI sessions to account for in results.
<section end="AddUnattendedSession" />

IncludeTotalApptType
<section begin="IncludeTotalApptType" />
* <b>Include Totals by Appointment Type</b>
::Enabling this checkbox adds additional columns to the report results displaying the total visits that were linked to group appointments, 1-on-1 appointments, and drop-ins (no linked appointments).
<section end="IncludeTotalApptType" />

QuestionsKey
<section begin="QuestionsKey" />
* <b>Questions Key Option</b>
::This allows you to add the written questions to the top or bottom of report results. By default, only the question number is visible as the column name.
<section end="QuestionsKey" />


<hr>
<b><big>Report-Specific Descriptions</big></b>
<br><br>

ViewBy_StudVisitApptBy
<section begin="ViewBy_StudVisitApptBy" />
* <b>View by Visits</b> or <b>Appointments</b>
::This is one of a few reports in the system that can be generated using different methods. <i>View by Visits</i> will search for Visits first, and can also display information about related Appointments. <i>View by Appointments</i> will do the opposite.

::As a real-world example, if Sam Smith has a missed appointment (i.e., no visit record), that information won't display if you View by Visits, but it will if you View by Appointments.
<section end="ViewBy_StudVisitApptBy" />

ViewBy_UsageSnapshot
<section begin="ViewBy_UsageSnapshot" />
* <b>Report Option</b>
::<b>Usage Snapshot</b> will display visit data for all Snapshot Fields in the date range specified and includes a pie chart view for each field.
::[[File:6936254.png|650px]]
::<b>Date Comparison</b> does the same, but for both of your selected date ranges, allowing you to compare attendance from two periods in a single report. Keep in mind that certain fields can change for students over time, and all reports (including this one) will only show the current state of these records. This report option should be used on static/unchanging fields like the visit's subject, center, or reason, and not on fields like the student's class or GPA as those may have changed since the date of their visits.
::[[File:8962653.png|650px]]
::<b>Custom Field Multi-Check Tally</b> will provide the total times each [[TracCloudGuideGlobalCustom|multi-check custom field]] from a visit record was checked, as opposed to the total times every combination of options was chosen (i.e., counting instances of A, B, and C individually rather than A, A + B, A + C, A + B + C, B, etc).
::[[File:4494241.png|650px]]
<section end="ViewBy_UsageSnapshot" />

UtilizationPastDue_Resources
<section begin="UtilizationPastDue_Resources" />
* <b>View Utilization</b> or <b>View Past Due</b>
::<b>Utilization</b> will show all checked out resources and the individual checkouts. <b>Past Due</b> will only display overdue checkouts, items that were not returned soon enough, filtering out checkouts that were returned in time.
<section end="UtilizationPastDue_Resources" />

ShowOnlyStudentsApptStatus_ApptStatCrosstab
<section begin="ShowOnlyStudentsApptStatus_ApptStatCrosstab" />
* <b>Show only students with these appointment statuses</b>
::This will filter the list of students to only those with appointments that match the statuses you specify in the box beneath.
<section end="ShowOnlyStudentsApptStatus_ApptStatCrosstab" />

FieldsToShow_UsageSnapshot
<section begin="FieldsToShow_UsageSnapshot" />
* <b>Snapshot Fields</b>
::Use this to add fields to your report. Add Location to see location usage, consultants to see who has met with the most students, etc.
<section end="FieldsToShow_UsageSnapshot" />

ShowStudents_VisitsCleanup
<section begin="ShowStudents_VisitsCleanup" />
* <b>Show: All Students</b> or <b>Students that Visited</b>
::Show all students in this report, or only those who visited. 'Students that Visited' is default.
<section end="ShowStudents_VisitsCleanup" />

IncludeFillInEssay_SurveyReports
<section begin="IncludeFillInEssay_SurveyReports" />
* <b>Include Fill-in</b> & <b>Essay Answers</b>
::These options will include the answers that were written manually during the response process (as opposed to checkbox/multiple-choice answers).
<section end="IncludeFillInEssay_SurveyReports" />

Survey_SurveyReport
<section begin="Survey_SurveyReport" />
* <b>Survey</b>
::Export responses from this selected survey.
<section end="Survey_SurveyReport" />

ShowHours_ConsCertification
<section begin="ShowHours_ConsCertification" />
* <b>Show Hours</b>
::Include certification hours in results.
<section end="ShowHours_ConsCertification" />

CertType_ConsCertification
<section begin="CertType_ConsCertification" />
* <b>Certification Type</b>
::Filter results to only certifications of a specified type, defaults to 'All.'
<section end="CertType_ConsCertification" />

ShowExtra_ConsCertification
<section begin="ShowExtra_ConsCertification" />
* <b>Show Extra Field</b>
::Include the certification 'Extra Field' value in results.
<section end="ShowExtra_ConsCertification" />

ShowOnlyConsCerts_ConsCertification
<section begin="ShowOnlyConsCerts_ConsCertification" />
* <b>Show Only Consultants with Certifications</b>
::Check this to exclude consultants without certifications from your results.
<section end="ShowOnlyConsCerts_ConsCertification" />

SearchOptions_Resources
<section begin="SearchOptions_Resources" />
* <b>Student ID, Resource Type, Resource Title, Barcode, Keywords, Profile</b>
::Search by Student ID, Resource Type, Resource Title, Resource Barcode, Keywords, or the Profile of your resources.
<section end="SearchOptions_Resources" />

SearchOptions_Resources2
<section begin="SearchOptions_Resources2" />
* <b>Resource Type, Resource Title, Barcode, Keywords, Profile</b>
::Search by Resource Type, Resource Title, Resource Barcode, Keywords, or the Pofile of your resources.
<section end="SearchOptions_Resources2" />

ShowReservations_Resources2
<section begin="ShowReservations_Resources2" />
* <b>Show Current and Future Reservations</b>
::Include current and upcoming reservations in report results. 
<section end="ShowReservations_Resources2" />

ShowInactive_Resources
<section begin="ShowInactive_Resources" />
* <b>Show Inactive Resources</b>
::Include resources in results that have a status of 'Inactive.'
<section end="ShowInactive_Resources" />

OnlyTable_Q2
<section begin="OnlyTable_Q2" />
* <b>Show Only Table Visits</b>
::Only show Q2 Table visits specifically, exclude center visit records.
<section end="OnlyTable_Q2" />

NotesFields_ApptRequests
<section begin="NotesFields_ApptRequests" />
* <b>Show Looking-for Notes, Found Notes, Followed-Up Notes</b>
::Checking any of these three boxes will include the related 'Notes' field content to your report results.
<section end="NotesFields_ApptRequests" />

ActiveReferral_SAGESnapshot
<section begin="ActiveReferral_SAGESnapshot" />
* <b>Show Only Active Referral Types</b>
::Check this to exclude inactive referral types from your results.
<section end="ActiveReferral_SAGESnapshot" />

PageBreak_GroupRoster
<section begin="PageBreak_GroupRoster" />
* <b>Page Break for Center, Consultant, Class/Group</b>
::Check the relevant box to add a page break for each of the related records. This only applies when printing the report.
<section end="PageBreak_GroupRoster" />

Also used for Referrals by Students and Appointments/Visits<br>
RefType_SAGERefBy
<section begin="RefType_SAGERefBy" />
* <b>Referral Type</b>
::Only show referrals of a specific type.
<section end="RefType_SAGERefBy" />

Also used for Referrals by Students and Appointments/Visits<br>
RefStatus_SAGERefBy
<section begin="RefStatus_SAGERefBy" />
* <b>Processed</b>
::Filter referrals based on status, Processed or Not Processed. Defaults to 'All.'
<section end="RefStatus_SAGERefBy" />

Also used for Referrals by Students and Appointments/Visits<br>
RefReasonRec_SAGERefBy
<section begin="RefReasonRec_SAGERefBy" />
* <b>Referral Reason, Recommendation</b>
::Filter referrals by the selected Reason and/or Recommendation.
<section end="RefReasonRec_SAGERefBy" />

RefDelimit_SAGERefBy
<section begin="RefDelimit_SAGERefBy" />
* <b>Reason/Recommendation/QA Delimiter</b>
::If multiple Reasons/Recommendations are chosen for a single referral, you can decide how to separate them with this option. E.g., Comma delimited, Pipe delimited, etc.
<section end="RefDelimit_SAGERefBy" />

Also used for Referrals by Students and Appointments/Visits<br>
RefCons_SAGERefBy
<section begin="RefCons_SAGERefBy" />
* <b>Assigned Consultant</b>
::Filter referrals based on the assigned consultant/advisor.
<section end="RefCons_SAGERefBy" />

ShowWithoutHours_Payroll
<section begin="ShowWithoutHours_Payroll" />
* <b>Show Consultants without Hours</b>
::Display all consultants in payroll report, those without work time will simply display as having 0.00 hours.
<section end="ShowWithoutHours_Payroll" />

Recompute_Payroll
<section begin="Recompute_Payroll" />
* <b>Recompute Data</b>
::This will recalculate your consultant work times to retrieve the most up to date information, but can slightly slow down processing time.
<section end="Recompute_Payroll" />

DailyTime_Payroll
<section begin="DailyTime_Payroll" />
* <b>Show Daily Payroll Hours</b>
::Shows a day-by-day breakdown of work hours within the overall date range that you selected.
<section end="DailyTime_Payroll" />

MailboxNotes_Payroll
<section begin="MailboxNotes_Payroll" />
* <b>Show Email, Mailbox, Notes</b>
::Additional consultant fields that can be included in report results if needed.
<section end="MailboxNotes_Payroll" />

ShowFund_Payroll
<section begin="ShowFund_Payroll" />
* <b>Show Funds</b>
::Include fund source in results.
<section end="ShowFund_Payroll" />

GroupFund_Payroll
<section begin="GroupFund_Payroll" />
* <b>Group by Fund, Reason, Center</b>
::Group payroll report results by Fund, Reason, and/or Center.
<section end="GroupFund_Payroll" />

ShowVisits_Payroll
<section begin="ShowVisits_Payroll" />
* <b>Show Work Visits</b>
::Include data on the individual visits in the report itself. If enabled, you will also be able to include notes from the work visit record in the report results by checking <b>Show Work Notes</b>.
<section end="ShowVisits_Payroll" />

Round_Payroll
<section begin="Round_Payroll" />
* <b>Round to Nearest</b> & <b>Round individual visits first</b>
::Round total visit time to the nearest X-minutes. You also have the ability to round individual visit durations first.
<section end="Round_Payroll" />

StudentVisit_Payroll
<section begin="StudentVisit_Payroll" />
* <b>Show Student Visits</b>
::Include Student Visit data in report results, to view who the consultant was working with during their work hours.
<section end="StudentVisit_Payroll" />

PageBreak_Payroll
<section begin="PageBreak_Payroll" />
* <b>Page Break</b>
::Separate consultants onto different pages when printing the HTML version of this report. Requires 'Group by' options to be unchecked.
<section end="PageBreak_Payroll" />

SelectSessions_SISession
<section begin="SelectSessions_SISession" />
* <b>Select Sessions</b>
::Include all sessions, or only visited.
<section end="SelectSessions_SISession" />

NumGroupings_SISession
<section begin="NumGroupings_SISession" />
* <b>Number of Groupings</b>
::The maximum number of groupings. Use this to add totals to different levels of the report (i.e., total visits on this date, in this center, for this reason).
<section end="NumGroupings_SISession" />

ExcludRegGrade_SIComp
<section begin="ExcludRegGrade_SIComp" />
* <b>Exclude Registrations Without a Grade</b>
::Exclude ungraded registrations from report results.
<section end="ExcludRegGrade_SIComp" />

412ptGPA_SIComp
<section begin="412ptGPA_SIComp" />
* <b>Compare 4-point and 12-point GPAs</b>
::Adds a 12pt GPA column for comparison.
<section end="412ptGPA_SIComp" />

GradeDefs_SIComp
<section begin="GradeDefs_SIComp" />
* <b>Passing/Failing/Withdraw Grade Definitions</b>
::Add Grade values here, delimited by a comma, to designate them as Passing, Failing, or Withdraw Grades.
<section end="GradeDefs_SIComp" />

NameGroup_SIComp
<section begin="NameGroup_SIComp" />
* <b>Name of Group</b>
::This determines the phrasing of your 'Visited' group of students. Typically SI, Visited, or similar.
<section end="NameGroup_SIComp" />

VisitBreakdown_SIComp
<section begin="VisitBreakdown_SIComp" />
* <b>Affects of SI on Visits</b> & <b>Withdraw Visits Breakdown</b>
::Use this to determine how you would like to breakdown the SI Group comparisons. For example, students who have visited 1-4 times vs those who visited 5-9 times. Separate ranges with commas.
<section end="VisitBreakdown_SIComp" />

SessionLength_SIComp
<section begin="SessionLength_SIComp" />
* <b>Length of Typical Session</b>
::Specify your average/expected session length here.
<section end="SessionLength_SIComp" />

ShowVisitsDate_RegBy
<section begin="ShowVisitsDate_RegBy" />
* <b>Show Visit Date/Time</b>
::Choose whether or not visit data is displayed in the report.
<section end="ShowVisitsDate_RegBy" />

ShowVisitsInLine_RegBy
<section begin="ShowVisitsInLine_RegBy" />
* <b>Show Visits In-Line</b>
::Keep visit records in the same registration line, rather than duplicating registration information for each visit.
<section end="ShowVisitsInLine_RegBy" />

ShowReg_RegBy
<section begin="ShowReg_RegBy" />
* <b>Show Registrations</b>
::Show registrations specifically with or without related visit records. Defaults to 'All.'
<section end="ShowReg_RegBy" />

LinkToAdvisors_VisByAdvisor
<section begin="LinkToAdvisors_VisByAdvisor" />
* <b>Link to Advisor's Email</b> (Required) and <b>Name</b> (Optional)
::Select the student custom field that contains the advisor email address. Optionally, you can also specify which student field contains the advisor name if it has been set up.
<section end="LinkToAdvisors_VisByAdvisor" />

SuccessPlan_PlanType
<section begin="SuccessPlan_PlanType" />
* <b>Success Plan</b>
::Select the Success Plan type that you want to show results for.
<section end="SuccessPlan_PlanType" />

SuccessPlan_InactivePlans
<section begin="SuccessPlan_InactivePlans" />
* <b>Include Inactive Plans</b>
::Inactive plans are hidden by default, this option allows you to include them in report results.
<section end="SuccessPlan_InactivePlans" />

SuccessPlan_Faculty
<section begin="SuccessPlan_Faculty" />
* <b>Faculty Name</b>
::Filter by assigned faculty name. Expected format is "Last, First".
<section end="SuccessPlan_Faculty" />


SuccessPlan_StepDetails
<section begin="SuccessPlan_StepDetails" />
* <b>Show Step Details</b>
::If enabled, student progress on individual steps and a visual timeline of step due dates will be shown.
<section end="SuccessPlan_StepDetails" />

WorkPlan_PlanType
<section begin="WorkPlan_PlanType" />
* <b>Work Plan</b>
::Select the Work Plan type that you want to show results for.
<section end="WorkPlan_PlanType" />

WorkPlan_Supervisor
<section begin="WorkPlan_Supervisor" />
* <b>Faculty Name</b>
::Filter by assigned supervisor name. Expected format is "Last, First".
<section end="WorkPlan_Supervisor" />

WorkPlan_StepDetails
<section begin="WorkPlan_StepDetails" />
* <b>Show Step Details</b>
::If enabled, consultant progress on individual steps and a visual timeline of step due dates will be shown.
<section end="WorkPlan_StepDetails" />


CenterGrid_MoreCenters
<section begin="CenterGrid_MoreCenters" />
* <b>Only List Students Visiting # or More Centers</b>
::If this report is being run on multiple centers at once, you can use this option to only list students who visited X number of unique centers or more.
<section end="CenterGrid_MoreCenters" />

Tasks_TaskType
<section begin="Tasks_TaskType" />
* <b>Select Task Type</b>
::Select the specific task type/category that you want to include in this report.
<section end="Tasks_TaskType" />

Surveys_ShowCharts
<section begin="Surveys_ShowCharts" />
* <b>Show Charts</b>
::This field allows you to add charts to the report results. Pie, bar, or line.
<section end="Surveys_ShowCharts" />

Tasks_TaskInfo
<section begin="Tasks_TaskInfo" />
* <b>Task Name, Assigned to Name, Student Name, Created by Name</b>
::These fields allow you to further filter report results to view the specific tasks you're looking for.
<section end="Tasks_TaskInfo" />

ApptsAvailsByHour
<section begin="ApptsAvailsByHour" />
* <b>Visits to Include</b>
::You can additionally include the total number of visits on each day. Select between <b><i>Appointment-related</i></b> and <b><i>All Visits</i></b>. The latter will include drop-ins, batch visits, and other visits that aren't directly linked to an appointment record.
<section end="ApptsAvailsByHour" />

StudentSearchAvail_Include
<section begin="StudentSearchAvail_Include" />
* <b>Searches to Include</b>
::This allows you to filter results to only students who booked or did not book an appointment. Default is all.
<section end="StudentSearchAvail_Include" />

RefbyStudentApptVisit_OnlyIncludeSubject
<section begin="RefbyStudentApptVisit_OnlyIncludeSubject" />
* <b>Only Include Appointments/Visits Linked to Referral Subject</b>
::If checked, only visits/appointments for the same section as the referral will be included in the report results.
<section end="RefbyStudentApptVisit_OnlyIncludeSubject" />

RefbyStudentApptVisit_PrecedingApptsVisits
<section begin="RefbyStudentApptVisit_PrecedingApptsVisits" />
* <b>Include Appointments/Visits Preceding Referral Creation Date</b>
::By default, the visits/appointments shown will only be those that take place after the creation of the referral. If this option is checked, older records will also be included.
<section end="RefbyStudentApptVisit_PrecedingApptsVisits" />

RefbyStudentApptVisit_ShowLinks
<section begin="RefbyStudentApptVisit_ShowLinks" />
* <b>Show Links</b>
::This enables a clickable hyperlink in the report to immediately open visit/appointment records. This only applies when running the report as HTML.
<section end="RefbyStudentApptVisit_ShowLinks" />

RefbyStudentApptVisit_Delimiter
<section begin="RefbyStudentApptVisit_Delimiter" />
* <b>Details/Reason/Recommend/QA Delimiter</b>
::This allows you to choose how appointments and visits are delimited/separated. E.g., Comma delimited, Pipe delimited, etc.
<section end="RefbyStudentApptVisit_Delimiter" />

RefbyStudentApptVisit_WhichReferrals
<section begin="RefbyStudentApptVisit_WhichReferrals" />
* <b>Show Which Referrals</b>
::Filter results to only show referrals with visits/appointments, or without. Default is all.
<section end="RefbyStudentApptVisit_WhichReferrals" />

SecondarySort_StudVisSummary
<section begin="SecondarySort_StudVisSummary" />
* <b>Secondary Sorting</b>
::Select the secondary field that data will be sorted/grouped by. With a field selected, multiple rows can display visits at once. Use <b>Hide Student Name Repeats</b> to hide the student's name on those rows if preferred.
<section end="SecondarySort_StudVisSummary" />

SortByRec_SurveyResponses
<section begin="SortByRec_SurveyResponses" />
* <b>Sort by Recipient</b>
::Sort results by (and add column for) student name, as opposed to ordering results by response date/time.
<section end="SortByRec_SurveyResponses" />

ForPastDue_Resources
<section begin="ForPastDue_Resources" />
* <b>For Past Due, Show All Checkouts</b>
::If this is checked, currently checked out resources will be included in report results. Unchecked would exclude these.
<section end="ForPastDue_Resources" />

IncludeCheckoutNotes_Resources
<section begin="IncludeCheckoutNotes_Resources" />
* <b>Include Checkout Notes</b>
::Adds the checkout notes field as an additional column in report results.
<section end="IncludeCheckoutNotes_Resources" />

VisitsCleanup_OnlyShowAppts
<section begin="VisitsCleanup_OnlyShowAppts" />
* <b>Only Show Appointments for Selected Centers</b>
::The center selection above only filters visits (the left-column of this report). Appointments from other centers will still be shown. By checking this box, the appointments will also be filtered by your selected centers.
<section end="VisitsCleanup_OnlyShowAppts" />

SAGE_ShowActions
<section begin="SAGE_ShowActions" />
* <b>Show Actions</b>
::Include [[TracCloudSAGE|SAGE Potential Actions]] data in report results.
<section end="SAGE_ShowActions" />

UserDetail_TimeFrame
<section begin="UserDetail_TimeFrame" />
* <b>Time Frame</b>, <b>Apply Date Range to Last Access</b>, <b>Apply Date Range to Last Modified</b>
::Time frame is ignored unless one or both checkboxes are enabled. This allows you to filter results to only staff members who logged in during your specified date range and/or the staff records that were modified during your specified date range.
<section end="UserDetail_TimeFrame" />

SIComp_StandardDeviation
<section begin="SIComp_StandardDeviation" />
* <b>Show GPA Standard Deviation</b>
::If enabled, the standard deviation of the GPA fields will be displayed.
<section end="SIComp_StandardDeviation" />

PayCode
<section begin="PayCode" />
* <b>Pay Code</b>
::Filter report results by consultant [[TracCloudGuideBasicsPayroll|pay code]].
<section end="PayCode" />

ShowActiveSurveys_ResponseRate
<section begin="ShowActiveSurveys_ResponseRate" />
* <b>Show Only Active Surveys</b>
::This option is available if "Include All Surveys" is selected, allowing you to at least filter the results to only active surveys.
<section end="ShowActiveSurveys_ResponseRate" />

DocType_Documents
<section begin="DocType_Documents" />
* <b>Document Type</b>
::Optionally filter results based on [[TracCloudGuideGlobalDocs|document type]].
<section end="DocType_Documents" />

InclInactive_Documents
<section begin="InclInactive_Documents" />
* <b>Include Inactive Documents</b>
::If checked, documents that have been deactivated will still be included in report results.
<section end="InclInactive_Documents" />

OnlyActiveReg_Specialties
<section begin="OnlyActiveReg_Specialties" />
* <b>Only Active Registrations</b>
::Only include section specialties for currently active enrollments.
<section end="OnlyActiveReg_Specialties" />

ApptTotals_CenterSched
<section begin="ApptTotals_CenterSched" />
* <b>Show Appointment Totals</b>
::Include the total appointment count for each grouping.
<section end="ApptTotals_CenterSched" />

ShowAvailNotes_CenterSched
<section begin="ShowAvailNotes_CenterSched" />
* <b>Show Availability Notes</b>
::Include availability notes in report results.
<section end="ShowAvailNotes_CenterSched" />

IncludeEmailInUtil_Resources
<section begin="IncludeEmailInUtil_Resources" />
* <b>Include Email in Utilization</b>
::Include the email address of the user who checked out the item.
<section end="IncludeEmailInUtil_Resources" />

Centers_WorkPlans
<section begin="Centers_WorkPlans" />
* <b>Centers</b>
::Filter report data by center. This is in relation to the linked centers of the consultants.
<section end="Centers_WorkPlans" />