TracCloudReportsDescriptions: Difference between revisions
From Redrock Wiki
(Created page with "<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...") |
No edit summary |
||
| 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> | |||
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> | |||
Centers | |||
<section begin="Centers" /> | <section begin="Centers" /> | ||
* <b>Centers</b> | * <b>Centers</b> | ||
| Line 4: | Line 11: | ||
<section end="Centers" /> | <section end="Centers" /> | ||
TimeFrame | |||
<section begin="TimeFrame" /> | <section begin="TimeFrame" /> | ||
* <b>Time Frame</b> | * <b>Time Frame</b> | ||
| Line 9: | Line 17: | ||
<section end="TimeFrame" /> | <section end="TimeFrame" /> | ||
SecondTimeFrame | |||
<section begin="SecondTimeFrame" /> | <section begin="SecondTimeFrame" /> | ||
* <b>Secondary Time Frame</b> | * <b>Secondary Time Frame</b> | ||
::An additional date range for data comparison. | ::An additional date range for data comparison. | ||
<section end="SecondTimeFrame" /> | <section end="SecondTimeFrame" /> | ||
ShowBarChart | |||
<section begin="ShowBarChart" /> | |||
* <b>Show bar chart</b> | |||
::Adds a visual bar chart to your report data. | |||
<section end="ShowBarChart" /> | |||
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" /> | |||
Revision as of 09:11, 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}}
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.
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).