Template

TracCloudReportsDescriptions: Difference between revisions

From Redrock Wiki

No edit summary
No edit summary
Line 3: Line 3:
Every description can potentially be used across multiple Report articles. Do not use specific examples here, put them in the individual report's article.
Every description can potentially be used across multiple Report articles. Do not use specific examples here, put them in the individual report's article.


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


Centers
Centers
Line 28: Line 28:
::Adds a visual bar chart to your report data.
::Adds a visual bar chart to your report data.
<section end="ShowBarChart" />
<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
DataTableTotals
Line 52: Line 58:
::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).
::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" />
<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" />
<section begin="Test" />
* <b>Test</b>
::
<section end="Test" />
<section begin="Test" />
* <b>Test</b>
::
<section end="Test" />
<section begin="Test" />
* <b>Test</b>
::
<section end="Test" />
<section begin="Test" />
* <b>Test</b>
::
<section end="Test" />

Revision as of 09:28, 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 here, put them in the individual report's article.

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.


  • Test


  • Test


  • Test


  • Test
Retrieved from "https://wiki.go-redrock.com/index.php?title=Template:TracCloudReportsDescriptions&oldid=5256"