Difference between revisions of "Report Builder Column Settings"
From SmartWiki
Nancy Sabo (talk | contribs) |
|||
| Line 5: | Line 5: | ||
[[Image:ReportBuilderColumnNew.png|link=]] | [[Image:ReportBuilderColumnNew.png|link=]] | ||
| − | + | ||
Each report column consists of the following settings: | Each report column consists of the following settings: | ||
| − | * '''Column Heading''' - The text you wish to appear above each column in the report. | + | * '''Column Heading''' - The text you wish to appear above each column in the report. Initially, this will be set to the same name as the field, but you can edit the text if required. If you wish to change the text back to the '''Field''' name, then click the button to the right of the column heading. [[Image:Reps6.png]] |
* '''Recordset''' - Refers to the recordset selected in the [[Recordsets]] tab. If multiple Recordsets have been selected to build your report, you can select from them in this dropdown. | * '''Recordset''' - Refers to the recordset selected in the [[Recordsets]] tab. If multiple Recordsets have been selected to build your report, you can select from them in this dropdown. | ||
| − | * '''Type''' - When the Table has been selected, you can select the [[Client Categories|category]], [[role]], [[template]] or [[type]] from which your field will be derived. | + | * '''Type''' - When the Table has been selected, you can select the [[Client Categories|category]], [[role]], [[template]] or [[type]] from which your field will be derived. |
| − | * '''Field''' - The field you wish to display in this column. | + | * '''Field''' - The field you wish to display in this column. All fields from all selected tables will be displayed in the field list. Fields are sorted alphabetically by table name, and by field name. |
* '''Date/Time Translation''' - Used to “extract” the day, month, week, or year from a date field for comparison purposes. | * '''Date/Time Translation''' - Used to “extract” the day, month, week, or year from a date field for comparison purposes. | ||
* '''Group By''' - Used in [[Creating Summary Reports|summary reports]] to group by, sum, count, or calculate the average of the field. Also provides [[Using Total Group Options in Report Builder| Total Group options]] for configuration of report groupings and easier retrieval of total rows. | * '''Group By''' - Used in [[Creating Summary Reports|summary reports]] to group by, sum, count, or calculate the average of the field. Also provides [[Using Total Group Options in Report Builder| Total Group options]] for configuration of report groupings and easier retrieval of total rows. | ||
| Line 17: | Line 17: | ||
* '''Align''' - Determines the alignment of the column header and the column values. Options are ''Left'' (the default setting), ''Center'' and ''Right''. | * '''Align''' - Determines the alignment of the column header and the column values. Options are ''Left'' (the default setting), ''Center'' and ''Right''. | ||
* '''[[Calculated Field]]''' - Allows you to build out further complexity such as mathematical operators, concatenation, and supports MySQL syntax. For additional information, please see the '''Calculated Field''' tab in the Report Builder or [[Calculated Field|this article]]. | * '''[[Calculated Field]]''' - Allows you to build out further complexity such as mathematical operators, concatenation, and supports MySQL syntax. For additional information, please see the '''Calculated Field''' tab in the Report Builder or [[Calculated Field|this article]]. | ||
| − | * '''Show''' - This flag is used to suppress the display of a field that you may need to use for criteria, but not display in the reports. | + | * '''Show''' - This flag is used to suppress the display of a field that you may need to use for criteria, but not display in the reports. For example, you may wish to produce a list of salaries over 100,000 per year and use the salary as criteria, but not show the result. |
| − | * '''[[Changing the Column Display Order in a Report|Move Icons]]''' - '''Move Left''' and '''Move Right''' icons are displayed to the left and right of each '''Show''' check box. | + | * '''[[Changing the Column Display Order in a Report|Move Icons]]''' - '''Move Left''' and '''Move Right''' icons are displayed to the left and right of each '''Show''' check box. [[Image:Reps7.png]] These buttons are used to change the column order. |
| − | * '''[[Criteria]]''' - Sets the criteria for the records to be displayed in the report. | + | * '''[[Criteria]]''' - Sets the criteria for the records to be displayed in the report. There are ten rows for criteria. |
Initially, the report will be configured for 15 columns, but you can increase the number of columns in increments of 15 by clicking the '''more columns''' button. | Initially, the report will be configured for 15 columns, but you can increase the number of columns in increments of 15 by clicking the '''more columns''' button. | ||
[[Image:Reps8.png]] | [[Image:Reps8.png]] | ||
| − | + | ||
| − | There is a fixed limit of '''30 columns''' in any report. | + | There is a fixed limit of '''30 columns''' in any existing Classic report. If more columns are required you will need to use two reports linked together. (See [[Merge Sub-Reports]]) |
'''Note''': If you have many custom fields, access the reports tab within the application you are creating the report from. If you are creating a report from a particular UTA, access the reports tab from that UTA. | '''Note''': If you have many custom fields, access the reports tab within the application you are creating the report from. If you are creating a report from a particular UTA, access the reports tab from that UTA. | ||
'''Note''': Also, Mozilla Firefox will load the report builder faster than Internet Explorer. | '''Note''': Also, Mozilla Firefox will load the report builder faster than Internet Explorer. | ||
| + | |||
==Report Builder Action Buttons== | ==Report Builder Action Buttons== | ||
| − | + | The following buttons are visible at the bottom of the Report Builder page, just above the Help Panel:<br /> | |
| − | The following buttons are visible at the bottom of the Report Builder page, just above the Help Panel:<br> | ||
{{ReportBuilderButtons}} | {{ReportBuilderButtons}} | ||
| − | * {{BuildQueryButton}} - The "Build Query" button is used to create your report based on the fields and criteria you have selected in the Report Builder. When the "Build Query" button is clicked, the report builder will close and you will be brought back to the Report Editing screen. The [[Report Template]] will also be rebuilt when "Build Query" is clicked, so if custom work has been done to the Report Template, make sure to save your changes elsewhere before rebuilding your query. | + | * {{BuildQueryButton}} - The "Build Query" button is used to create your report based on the fields and criteria you have selected in the Report Builder. When the "Build Query" button is clicked, the report builder will close and you will be brought back to the Report Editing screen. The [[Report Template]] will also be rebuilt when "Build Query" is clicked, so if custom work has been done to the Report Template, make sure to save your changes elsewhere before rebuilding your query. |
| − | * {{ClearAllButton}} - This button will clear all fields, calculated fields, criteria, etc. selected in the Report Builder. | + | * {{ClearAllButton}} - This button will clear all fields, calculated fields, criteria, etc. selected in the Report Builder. |
| − | * {{MoreColumnsButton}} - This button will add another 25 columns to the Report Builder interface, to a maximum of 50. | + | * {{MoreColumnsButton}} - This button will add another 25 columns to the Report Builder interface, to a maximum of 50, for any new Classic report. |
==Report Builder Help Panel== | ==Report Builder Help Panel== | ||
| + | The bottom panel provides help on the '''Report''' builder, and consists of six tabs. Each displays help on a different report-related topic. | ||
| − | + | [[Image:ReportBuilderHelp.JPG|link=]] | |
| − | |||
| − | |||
Click on each of these tabs to review the associated help. | Click on each of these tabs to review the associated help. | ||
| Line 65: | Line 64: | ||
* [[Using Date Criteria]] | * [[Using Date Criteria]] | ||
| − | {{PrevNextStart}} [[Adding a Table to a Report]] | + | {{PrevNextStart}} [[Adding a Table to a Report]] |
| − | {{PrevNextMid}} [[Adding Fields to a Report]] {{PrevNextEnd}} | + | {{PrevNextMid}} [[Adding Fields to a Report]] {{PrevNextEnd}} |
[[Category:Reports]] | [[Category:Reports]] | ||
Revision as of 14:09, 19 November 2018
Click here to watch a video on SmartSimple's integrated reporting subsystem.
The report builder window consists of two panels.
The top panel is used to construct the report by selected the required fields and setting the way the field should be used within the report.
Each report column consists of the following settings:
- Column Heading - The text you wish to appear above each column in the report. Initially, this will be set to the same name as the field, but you can edit the text if required. If you wish to change the text back to the Field name, then click the button to the right of the column heading.
- Recordset - Refers to the recordset selected in the Recordsets tab. If multiple Recordsets have been selected to build your report, you can select from them in this dropdown.
- Type - When the Table has been selected, you can select the category, role, template or type from which your field will be derived.
- Field - The field you wish to display in this column. All fields from all selected tables will be displayed in the field list. Fields are sorted alphabetically by table name, and by field name.
- Date/Time Translation - Used to “extract” the day, month, week, or year from a date field for comparison purposes.
- Group By - Used in summary reports to group by, sum, count, or calculate the average of the field. Also provides Total Group options for configuration of report groupings and easier retrieval of total rows.
- Sort By - Determines the display order of the report results, Ascending or Descending.
- Align - Determines the alignment of the column header and the column values. Options are Left (the default setting), Center and Right.
- Calculated Field - Allows you to build out further complexity such as mathematical operators, concatenation, and supports MySQL syntax. For additional information, please see the Calculated Field tab in the Report Builder or this article.
- Show - This flag is used to suppress the display of a field that you may need to use for criteria, but not display in the reports. For example, you may wish to produce a list of salaries over 100,000 per year and use the salary as criteria, but not show the result.
- Move Icons - Move Left and Move Right icons are displayed to the left and right of each Show check box.
These buttons are used to change the column order. - Criteria - Sets the criteria for the records to be displayed in the report. There are ten rows for criteria.
Initially, the report will be configured for 15 columns, but you can increase the number of columns in increments of 15 by clicking the more columns button.
There is a fixed limit of 30 columns in any existing Classic report. If more columns are required you will need to use two reports linked together. (See Merge Sub-Reports)
Note: If you have many custom fields, access the reports tab within the application you are creating the report from. If you are creating a report from a particular UTA, access the reports tab from that UTA.
Note: Also, Mozilla Firefox will load the report builder faster than Internet Explorer.
Report Builder Action Buttons
The following buttons are visible at the bottom of the Report Builder page, just above the Help Panel:
-
- The "Build Query" button is used to create your report based on the fields and criteria you have selected in the Report Builder. When the "Build Query" button is clicked, the report builder will close and you will be brought back to the Report Editing screen. The Report Template will also be rebuilt when "Build Query" is clicked, so if custom work has been done to the Report Template, make sure to save your changes elsewhere before rebuilding your query. -
- This button will clear all fields, calculated fields, criteria, etc. selected in the Report Builder. -
- This button will add another 25 columns to the Report Builder interface, to a maximum of 50, for any new Classic report.
Report Builder Help Panel
The bottom panel provides help on the Report builder, and consists of six tabs. Each displays help on a different report-related topic.
Click on each of these tabs to review the associated help.
- Overview - Describes the components of the top panel of the Report Builder.
- Comparison Operators - Describes how to set basic criteria based on logical tests. See also Setting Text Criteria – Logical Operators in a Report and Specifying Multiple Criteria in Reports.
- Wildcard and Like Operators - Describes how to set partial criteria. See also Using Wildcard Criteria in Reports and Prompting for a Criteria using a Wildcard.
- Special SmartSimple Criteria Values - Describes how to set criteria from user prompts and user attributes (user and company identifiers).
- Date Comparison - Describes how to set date- and time-based criteria. See also Using Date Criteria and Accessing the Current Date in a Report.
- Calculated Fields - Describes valid mathematical expressions and functions, string functions and logical statements for use in the Calculated Field section.
See Also
- Calculated Field
- Setting Text Criteria – Logical Operators in a Report
- Specifying Multiple Criteria in Reports
- Using Wildcard Criteria in Reports
- Prompting for a Criteria using a Wildcard
- Using Date Criteria
