|
|
| Line 1: |
Line 1: |
| <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>
| | 4854462 |
| | |
| Every description can potentially be used across multiple Report articles. Do not use specific examples on this page.
| |
| | |
| 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" />
| |
| | |
| 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" />
| |
| | |
| 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" />
| |
| | |
| ShowCanceledAppts
| |
| <section begin="ShowCanceledAppts" />
| |
| * <b>Show Canceled Appointments</b>
| |
| ::Include appointments that have been canceled in your report results.
| |
| <section end="ShowCanceledAppts" />
| |
| | |
| 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" />
| |
| | |
| ShowSummary
| |
| <section begin="ShowSummary" />
| |
| * <b>ShowSummary</b>
| |
| ::Only show data totals, excluding details of individual records.
| |
| <section end="ShowSummary" />
| |
| | |
| ShowWorkVisits
| |
| <section begin="ShowWorkVisits" />
| |
| * <b>ShowWorkVisits</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" />
| |
| | |
| 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>Multiple fields can be added to further narrow down your results.
| |
| <section end="AdditionalSearch" />
| |
| | |
| <big>General 'Show' descriptions</big>
| |
| | |
| ShowEmail
| |
| <section begin="ShowEmail" />
| |
| * <b>Show Email</b>
| |
| ::Include email address in results.
| |
| <section end="ShowEmail" />
| |
| | |
| ShowPhone
| |
| <section begin="ShowPhone" />
| |
| * <b>Show Phone</b>
| |
| ::Include phone number in results.
| |
| <section end="ShowPhone" />
| |
| | |
| <big>Rarely used descriptions</big>
| |
| | |
| IgnoreCenterCourseListSubject
| |
| <section begin="IgnoreCenterCourseListSubject" />
| |
| * <b>Ignore Center Course Lists for Subjects</b>
| |
| ::Ignore the selected centers and show all specialties regardless of center.
| |
| <section end="IgnoreCenterCourseListSubject" />
| |
| | |
| ShowOnlyActiveSections
| |
| <section begin="ShowOnlyActiveSections" />
| |
| * <b>Show Only Active Sections</b>
| |
| ::Only include active sections in this report.
| |
| <section end="ShowOnlyActiveSections" />
| |
| | |
| 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" />
| |
