TracCloudReportsDescriptions: Difference between revisions
From Redrock Wiki
No edit summary |
No edit summary |
||
Line 22: | Line 22: | ||
::An additional date range for data comparison. | ::An additional date range for data comparison. | ||
<section end="SecondTimeFrame" /> | <section end="SecondTimeFrame" /> | ||
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 | ShowBarChart | ||
Line 70: | Line 76: | ||
::Include appointments that have been canceled in your report results. | ::Include appointments that have been canceled in your report results. | ||
<section end="ShowCanceledAppts" /> | <section end="ShowCanceledAppts" /> | ||
ShowSummary | ShowSummary | ||
Line 150: | Line 144: | ||
::If checked, the Subject, Reason, Consultant, and Center of the appointment will be included in the results. | ::If checked, the Subject, Reason, Consultant, and Center of the appointment will be included in the results. | ||
<section end="ShowApptDetails" /> | <section end="ShowApptDetails" /> | ||
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" /> | |||
Line 195: | Line 201: | ||
::Only show sections that have already been Assigned to a consultant, or view Sections that are still Unassigned. Defaults to 'All'. | ::Only show sections that have already been Assigned to a consultant, or view Sections that are still Unassigned. Defaults to 'All'. | ||
<section end="ShowWhichSpecialties" /> | <section end="ShowWhichSpecialties" /> | ||
ShowAttendanceHourDayWk | ShowAttendanceHourDayWk | ||
Line 213: | Line 213: | ||
::This determines the format of duration, a 90-minute session could display as 1.50, 01:30:00, or 01:30. | ::This determines the format of duration, a 90-minute session could display as 1.50, 01:30:00, or 01:30. | ||
<section end="VisitTimeFormat" /> | <section end="VisitTimeFormat" /> | ||
GroupByStudent | |||
<section begin="GroupByStudent" /> | |||
* <b>Group by Student</b> | |||
::This option will group individual records by student name. | |||
<section end="GroupByStudent" /> |
Revision as of 10:43, 27 April 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.
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).
ShowCanceledAppts
- Show Canceled Appointments
- Include appointments that have been canceled in your 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.
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.
General 'Show' descriptions
ShowEmail
- Show Email
- Include email address in results.
ShowPhone
- Show Phone
- Include phone number 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.
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.
SkillsSearch
- Skills / Accommodations
- Only show results for a specific Skill/Accommodation.
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.
VisitTimeFormat
- Time Format
- This determines the format of duration, a 90-minute session could display as 1.50, 01:30:00, or 01:30.
GroupByStudent
- Group by Student
- This option will group individual records by student name.