TracCloudReportsManagement05 and Template:TracCloudReportsDescriptions: Difference between pages

From Redrock Wiki

(Difference between pages)
No edit summary
 
No edit summary
 
Line 1: Line 1:
{{TracCloudReportTabs}}
<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>
{| style="width:100%; vertical-align:top; "
| style="width:250px; vertical-align:top; padding:2px 15px 2px 2px;" | {{TracCloudReportsManagementTOC}}
| style="vertical-align:top; padding:20px 20px 20px 2px;" |
{| style="width:100%; vertical-align:top; "
<b><big>Consultant Non-Duplicated Visit Time</big></b><hr>


This report will show unique, non-overlapping visit times by Consultant. For example, if a consultant has a 1-hour long 3-person group, in most reports total tutoring time would be reported as 3 Hours, one for each student. While this is important and accurate information, some users need the ability to report on the unique time that the <i>consultant</i> is working. However, this report will show that the consultant worked for 1 hour while providing 3 visit hours’ worth of time.<br><br>
Every description can potentially be used across multiple Report articles. Do not use specific examples on this page.


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


{{#lst:Template:TracCloudReportsDescriptions|Centers}}
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" />


{{#lst:Template:TracCloudReportsDescriptions|TimeFrame}}
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" />


{{#lst:Template:TracCloudReportsDescriptions|ShowSummary}}
SecondTimeFrame
<section begin="SecondTimeFrame" />
* <b>Secondary Time Frame</b>
::An additional date range for data comparison.
<section end="SecondTimeFrame" />


{{#lst:Template:TracCloudReportsDescriptions|ShowTotalsChart}}
ShowBarChart
<section begin="ShowBarChart" />
* <b>Show bar chart</b>
::Adds a visual bar chart to your report data.
<section end="ShowBarChart" />


{{#lst:Template:TracCloudReportsDescriptions|AdditionalSearch}}
ShowTotalsChart
<section begin="ShowTotalsChart" />
* <b>Show Totals Bar Chart</b>
::Adds a visual bar chart of totals to your report data.
<section end="ShowTotalsChart" />


{{#lst:Template:TracCloudReportsDescriptions|OutputFormat}}
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" />


{{#lst:Template:TracCloudReportsDescriptions|DeliverTo}}
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" />


<hr>
DeliverTo
<b><big>HTML</b></big><br>
<section begin="DeliverTo" />
[[File:4646045.png|900px]]
* <b>Deliver to</b>
<br><br>
::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).
<b><big>CSV</b></big>
<section end="DeliverTo" />
[[File:3989731.png|900px]]


|}
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" />

Revision as of 10:50, 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.


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.


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.


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.
Retrieved from "https://wiki.go-redrock.com/index.php?title=TracCloudReportsManagement05&oldid=5260"