Template:TracCloudReportsDescriptions
From Redrock Wiki
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.
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.
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).
ShowCanceledAppts
- Show Canceled Appointments
- Include appointments that have been canceled in your report results.
ShowAvails
- Show Availabilities
- Include availability times in the report results.
ShowReserved
- ShowReserved
- Include blocked or reserved schedule time in the report results.
ShowSummary
- ShowSummary
- Only show data totals, excluding details of individual records.
ShowWorkVisits
- ShowWorkVisits
- Include consultant work visits in report results.
CalculateTotals
- Calculate Totals
- Include data totals in report results.
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.
General 'Show' descriptions
ShowEmail
- Show Email
- Include email address in results.
ShowPhone
- Show Phone
- Include phone number in results.
Rarely used descriptions
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.
ReasonSearch
- Reason
- Only show results for the specific Reason.
SubjectSearch
- Subject/Course/Section
- Only show results for the specific Subject, Course, or Section.
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'.
Increment
- Increment
- Select your preferred time increment. I.e., separate results in increments of 1-hour, 30-minutes, or 15-minutes.
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.
VisitTimeFormat
- Visit Time Format
- This determines the format of visit duration, a 90-minute session could display as 1.50, 01:30:00, or 01:30.