TracCloudReportsDescriptions: Difference between revisions
From Redrock Wiki
No edit summary |
No edit summary |
||
Line 564: | Line 564: | ||
::Show registrations specifically with or without related visit records. Defaults to 'All.' | ::Show registrations specifically with or without related visit records. Defaults to 'All.' | ||
<section end="ShowReg_RegBy" /> | <section end="ShowReg_RegBy" /> | ||
LinkToAdvisors_VisByAdvisor | |||
<section begin="LinkToAdvisors_VisByAdvisor" /> | |||
* <b>Link to Advisor's Email</b> or <b>Name</b> | |||
::Define how students are linked to advisors based on either of these two fields (email is more common). | |||
<section end="LinkToAdvisors_VisByAdvisor" /> |
Revision as of 16:37, 5 October 2022
This template is used to provide descriptions throughout the TracCloud Reports guide. If you've ended up here by mistake, click here to return to the Reports wiki.
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: {{#lst:Template:TracCloudReportsDescriptions|TimeFrame}}, replacing 'TimeFrame' with the relevant description code below.
Centers
- Centers
- 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.
TimeFrame
- Time Frame
- 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.
SecondTimeFrame
- Secondary Time Frame
- An additional date range for data comparison.
Increment
- Increment
- Select your preferred time increment. I.e., separate results in increments of 1-hour, 30-minutes, or 15-minutes.
ShowBarChart
- Show bar chart
- Adds a visual bar chart to your report data.
ShowTotalsChart
- Show Totals Bar Chart
- Adds a visual bar chart of totals to your report data.
DataTableTotals
- Show data table with totals
- Adds a data table to the report, listing out the results separately from a bar chart.
InPersonOnline
- In-Person/Online
- Filter the data in this report to only include In-Person or Online records. Defaults to All.
ShowOnlineSpecifically
- Show online locations specifically
- 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., 'https://zoom.us/123456789').
OutputFormat
- Output format
- 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.
DeliverTo
- Deliver to
- 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).
ShowSummary
- Show Summary
- Only show data totals, excluding details of individual records.
ShowWorkVisits
- Show Work Visits
- Include consultant work visits in report results.
CalculateTotals
- Calculate Totals
- Include data totals in report results.
SortBy
- Sort by
- Choose how the selected data is sorted.
GroupBy
- Group by
- Group records by the selected field. Some reports allow you to add secondary and tertiary groupings as well.
SearchGroup
- Search Group
- 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.
AdditionalSearch
- Additional Search
- Filter your results by a selected field.
Use * as a wildcard (Subject: MAT*)
| as "or" (Major: Mathematics|Biology)
# as "Not" (Status: #Inactive)
Multiple fields can be added to further narrow down your results.
- Filter your results by a selected field.
AdditionalFieldsToShow
- Additional fields to show
- 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.
VisitTimeFormat
- Time Format
- This determines the format of duration, a 90-minute session could display as 1.50, 01:30:00, or 01:30.
DecimalAccuracy
- Decimal Accuracy
- This determines the decimal accuracy of duration data. Defaults to 2, showing a 1-hour session as "1.00".
IgnoreCenterCourseListSubject
- Ignore Center Course Lists for Subjects
- Ignore the selected centers and show all specialties regardless of center.
ShowOnlyActiveSections
- Show Only Active Sections
- Only include active sections in this report.
SelectTerm
- Select Term
- Only show records for the selected term.
ShowWhichSpecialties
- Show Which Specialties
- Only show sections that have already been Assigned to a consultant, or view Sections that are still Unassigned. Defaults to 'All'.
ShowAttendanceHourDayWk
- Show Attendance by Hour by Day of Week
- This will include an additional graph displaying how many visits took place per day of week in addition to the hour-by-hour breakdown.
GroupByStudent
- Group by Student
- This option will group individual records by student name.
ApplyDateRange
- Apply Date Range to
- Choose what your selected date range is in reference to. Defaults to any matching date range.
ShowEmail
- Show Email
- Include email address in results.
ShowPhone
- Show Phone
- Include phone number in results.
ShowDescription
- Show Description
- Include record description in results.
ShowVisitDetails
- Show Visit Details
- If checked, the Subject, Reason, Consultant, and Center of the visit will be included in the results.
ShowApptDetails
- Show Appointment Details
- If checked, the Subject, Reason, Consultant, and Center of the appointment will be included in the results.
ShowAvails
- Show Availabilities
- Include availability times in the report results.
ShowReserved
- ShowReserved
- Include blocked or reserved schedule time in the report results.
ShowCanceledAppts
- Show Canceled Appointments
- Include appointments that have been canceled in your report results.
ShowStudentID
- Show Student ID
- Include Student ID in report results.
ShowReason
- Show Reason
- Include Reason in report results.
ShowSubject
- Show Subject
- Include Subject in report results.
ShowLocation
- Show Location
- Include Location in report results.
ShowAllConsultants
- Show All Consultants
- Include all consultants in report results, regardless of if they're assigned to relevant records.
ShowOnlyAppts
- Show Only Appointments
- Only show appointments in report results, excluding availability data.
ShowAllDates
- Show All Dates
- Display all dates in report results, even if there are no relevant records on those dates.
ReasonSearch
- Reason
- Only show results for the specific Reason.
SubjectSearch
- Subject/Course/Section
- Only show results for the specific Subject, Course, or Section.
SkillsSearch
- Skills / Accommodations
- Only show results for a specific Skill/Accommodation.
SearchApptStatus
- Search Appointment Status
- Only show results for a specific appointment status.
AddUnattendedSession
- Additional Unattended Sessions
- Specify additional unattended SI sessions to account for in results.
Report-Specific Descriptions
ViewBy_StudVisitApptBy
- View by Visits or Appointments
- This is one of a few reports in the system that can be generated using different methods. View by Visits will search for Visits first, and can also display information about related Appointments. View by Appointments 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.
ViewBy_UsageSnapshot
- View Snapshot or Date Comparison
- Snapshot will display visit data for all Snapshot Fields in the date range specified and includes a pie chart view for each field. Date Comparison does the same, but for both of your selected date ranges, allowing to compare traffic from two periods in a single report.
ShowOnlyStudentsApptStatus_ApptStatCrosstab
- Show only students with these appointment statuses
- This will filter the list of students to only those with appointments that match the statuses you specify in the box beneath.
FieldsToShow_UsageSnapshot
- Snapshot Fields
- 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.
ShowStudents_VisitsCleanup
- Show: All Students or Students that Visited
- Show all students in this report, or only those who visited. 'Students that Visited' is default.
UserSearch_UserDetail
- User First Name & User Last Name
- This allows you to search for a specific user account, rather than showing everyone.
IncludeFillInEssay_SurveyReports
- Include Fill-in & Essay Answers
- These options will include the answers that were written manually during the response process (as opposed to checkbox/multiple-choice answers).
Survey_SurveyReport
- Survey
- Export responses from this selected survey.
ShowHours_ConsCertification
- Show Hours
- Include certification hours in results.
CertType_ConsCertification
- Certification Type
- Filter results to only certifications of a specified type, defaults to 'All.'
ShowExtra_ConsCertification
- Show Extra Field
- Include the certification 'Extra Field' value in results.
ShowOnlyConsCerts_ConsCertification
- Show Only Consultants with Certifications
- Check this to exclude consultants without certifications from your results.
SearchOptions_Resources
- Student ID, Resource Type, Resource Title, Barcode, Keywords
- Search by Student ID, Resource Type, Resource Title, Resource Barcode, or the keywords of your resources.
ShowInactive_Resources
- Show Inactive Resources
- Include resources in results that have a status of 'Inactive.'
OnlyTable_Q2
- Show Only Table Visits
- Only show Q2 Table visits specifically, exclude center visit records.
NotesFields_ApptRequests
- Show Looking-for Notes, Found Notes, Followed-Up Notes
- Checking any of these three boxes will include the related 'Notes' field content to your report results.
ActiveReferral_SAGESnapshot
- Show Only Active Referral Types
- Check this to exclude inactive referral types from your results.
PageBreak_GroupRoster
- Page Break for Center, Consultant, Class/Group
- Check the relevant box to add a page break for each of the related records. This only applies when printing the report.
RefType_SAGERefBy
- Referral Type
- Only show referrals of a specific type.
RefStatus_SAGERefBy
- Processed
- Filter referrals based on status, Processed or Not Processed. Defaults to 'All.'
RefReasonRec_SAGERefBy
- Referral Reason, Recommendation
- Filter referrals by the selected Reason and/or Recommendation.
RefDelimit_SAGERefBy
- Reason/Recommendation Delimiter
- 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.
RefCons_SAGERefBy
- Assigned Consultant
- Filter referrals based on the assigned consultant/advisor.
ShowWithoutHours_Payroll
- Show Consultants without Hours
- Display all consultants in payroll report, those without work time will simply display as having 0.00 hours.
Recompute_Payroll
- Recompute Data
- This will recalculate your consultant work times to retrieve the most up to date information, but can slightly slow down processing time.
DailyTime_Payroll
- Show Daily Payroll Hours
- Shows a day-by-day breakdown of work hours within the overall date range that you selected.
MailboxNotes_Payroll
- Show Email, Mailbox, Notes
- Additional consultant fields that can be included in report results if needed.
ShowFund_Payroll
- Show Funds
- Include fund source in results.
GroupFund_Payroll
- Group by Fund, Reason, Center
- Group payroll report results by Fund, Reason, and/or Center.
ShowVisits_Payroll
- Show Work Visits
- Include data on the individual visits in the report itself.
Round_Payroll
- Round to Nearest & Round individual visits first
- Round total visit time to the nearest X-minutes. You also have the ability to round individual visit durations first.
StudentVisit_Payroll
- Show Student Visits
- Include Student Visit data in report results, to view who the consultant was working with during their work hours.
PageBreak_Payroll
- Page Break
- Separate consultants onto different pages when printing the HTML version of this report. Requires 'Group by' options to be unchecked.
SelectSessions_SISession
- Select Sessions
- Include all sessions, or only visited.
NumGroupings_SISession
- Number of Groupings
- 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).
ExcludRegGrade_SIComp
- Exclude Registrations Without a Grade
- Exclude ungraded registrations from report results.
412ptGPA_SIComp
- Compare 4-point and 12-point GPAs
- Adds a 12pt GPA column for comparison.
GradeDefs_SIComp
- Passing/Failing/Withdraw Grade Definitions
- Add Grade values here, delimited by a comma, to designate them as Passing, Failing, or Withdraw Grades.
NameGroup_SIComp
- Name of Group
- This determines the phrasing of your 'Visited' group of students. Typically SI, Visited, or similar.
VisitBreakdown_SIComp
- Affects of SI on Visits & Withdraw Visits Breakdown
- 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.
SessionLength_SIComp
- Length of Typical Session
- Specify your average/expected session length here.
ShowVisitsDate_RegBy
- Show Visit Date/Time
- Choose whether or not visit data is displayed in the report.
ShowVisitsInLine_RegBy
- Show Visits In-Line
- Keep visit records in the same registration line, rather than duplicating registration information for each visit.
ShowReg_RegBy
- Show Registrations
- Show registrations specifically with or without related visit records. Defaults to 'All.'
LinkToAdvisors_VisByAdvisor
- Link to Advisor's Email or Name
- Define how students are linked to advisors based on either of these two fields (email is more common).