Revision as of 16:10, 27 October 2022

Overview

The SmartSimple reporting system, an integral part of our business operating system, allows you to manipulate both the contents and the presentation of data contained in one or more of the SmartSimple tables. Unlike a table, reports present only the data that meets the criteria you define - they can also aggregate and display summarized data information. 

You can utilize the functionality of reports in your SmartSimple instance without additionally buying or installing software. Reports are completely created from within the standard interface and are viewable from any browser, as well as via Microsoft Word or Excel with the appropriate SmartSimple plug-in. 

Benefits of Reports: 

• Display data from one or more tables in one place
• Group-aggregate data from one or more tables
• Display the grouped data in a variety of different types of graphs
• Export the data into any file format that you wish OR 
  • Designate Internet-enabling so that the reports can be linked to public websites 
• Group reports together as tabs, allowing similar topic-based reports to be found together
• Copy and modify built-in reports as the basis of your customized reports 

User Role-based security defines who can view the reports that you create from your system.

 You must be a user with SysAdmin privileges in order to create reports from your SmartSimple system. 

Report Components

You will encounter three major components in the reporting system: 

• Reports that are created from underlying SmartSimple database tables - you can connect the required tables to generate a report
• Graphs that you create yourself. These are based on existing reports and are used to display the report in a graphic format. 
• Dashboards that will display multiple charts on a single page

The following diagram shows the relationship between these three types of entities:

Charts

Charts are used to display the information from a report in an easy-to-read “graphic” format.

• You can create pie charts, bar charts, line charts, and table-type charts.
• You can create more than one chart type of each report and when displaying a report, choose from any of the charts associated with the report.
• Generally, you will choose a “summary” type report as the basis for the chart, as that type of information is more meaningful when displayed in this manner.

 A user can only access the chart if they have permission to see the report that the chart is based on. 

A user can only access the chart if they have permission to see the report the chart is based on.

Dashboards

A dashboard is a single page view of a set of charts.

• When the user displays the dashboard, each report referenced by each chart is processed, and the current data is displayed in charts that are displayed on the dashboard.
• You can create multiple dashboards to show different sets of key indicators.
• A user can indicate that a specific dashboard should be their home page within SmartSimple, giving them an immediate view of key information from the system when they first log in.

 Each dashboard needs to be permissioned for the roles that you wish to be able to see the dashboard. 

Tables

In order to make the creation of reports a little simpler, some of the SmartSimple tables are presented in a denormalized format when using the Report Builder.

For example, the contact record does not contain the company name; these two tables are linked at the database level through the CompanyID field. So contact table does not contain the company name field but rather a key field that links to the company table.

But when you use the contact table within the Report Builder it will display a field Company Name. This means that you can use this field without needing to link the two tables together.

Configuration - Essentials

Permissioning Reports

Access to the report-creation features is controlled by the role-based manager permission. So you must be in a role associated with this feature in order to create reports.

 Users who will only need to view reports do not need these manager permissions. 

You must be a member of a role with manager permission for Reports if you wish to do any of the following actions: 

• Create new reports.
• Edit or copy existing reports.
• Delete existing reports, either individual or as batch deletes.

To permission which roles will have the ability to create, edit, and delete reports in your system, follow these steps: 

1. Click on the 9-square menu icon on the top right of your page.

2. Under the heading Configuration, select Roles and Security. 

3. Under the subheading System Security Settings, select the hyperlink System Feature Permissions. 

4. Click into the tab labelled Action Permission. 

5. Scroll down until you see the field labelled Reports - Manager. Click into the text box in order to select from a drop-down of user roles that will have manager permissions for reports. 

• You can also specifically permission which roles will have the ability to Export Data from reports. 

6. Click Save at the bottom of the screen when you are done. 

Accessing Reports

A user who is permissioned for report use can access the reports available to them. Follow these steps to access reports in your SmartSimple system: 

1. Click the 9-square menu icon on the top right of your page.

2. Under the heading Tools, select Reports. 

The list view of available system reports will be displayed. 

The report window consists of the following sections along the top row of tabs:

• Reports: This displays a list of your system's current reports that have been made available to you. 
• Global Report Template: This tab is used to define a customized HTML template for all reports.
• Dashboards: This tab is used to create a dashboard to display a set of charts.
• Web Access Statistics: This tab displays statistics on how often your web-enabled reports have been accessed.
• Deleted Reports: This tab displays a list of any deleted reports in your system. 

You can filter the results of your report list by choosing a Category of reports - this can be found at the top right of your page. Any reports that have not been associated with a category will appear in the Uncategorized category option. Clicking into the Category field will allow a drop-down list of available report categories to appear: 

You can also search through reports manually by using the Search bar on the top right, just above the list view. If your results exceed the maximum amount of records displayed on a page, toggle between different pages by selecting the next or back arrow icons on the top right. The count of records that you are viewing out of the total will always be displayed next to these buttons. Any reports that have been Internet-enabled will have a black dot under the Internet Enabled column to indicate so. 

Report List Columns

Each report on the main list of reports will have buttons to the left of it that have several different functions.

The functions are described in the table below: 

Run Report	Clicking this icon will cause the system to run the report and display the results to you.
Custom Export </span>	Clicking this icon will allow you to configure the information that you wish to export from your SmartSimple report to external applications such as MS Word, MS Excel, or Quickbooks.
Export File </span>	Clicking this icon will allow you to export your SmartSimple report to external applications in a standard file format such as MS Word, MS Excel, PDF, HTML or more. There is less configurability available with the Export File function than the Custom Export function.
Edit Report	Click this icon in order to open the edit options for this report. If the report is a built-in report, you will be able to edit the report to see how it is constructed, but any modifications you make will not be saved to the built-in report. In order to customize a report you will have to make a copy of the built-in report and make further edits with the copy.

• Any reports that are not enabled for certain features - for example, for File Export or Custom Export - will have the corresponding button icon greyed out next to the report name. 
• In order to enable these features, simply click the pencil icon next to the report name, go to the appropriate tab of Custom or File Export, ensure that it is both enabled and set up to how you want it, then click Save. When you return to the list view of reports, the corresponding icon should now be clickable. 

The columns on the list view of reports are described in the following table: 

Remember: Any user will only be able to see the reports and functions that they have permissions to. If a user is permissioned to be able to create new reports, they will see a + icon on the top left that allows them to create a new report. 

Creating a Basic Report

Learn how to create a basic report by following the steps below. Prior to these steps, you must first be in the Reports list view (read the Accessing Reports section if you need help). 

• 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 , access the reports tab from that UTA.

1. Click the + icon on the top left of the screen to Create a New Report.

2. The new report window is displayed: 

The fields on the new report page are described below: 

The second tab following the General settings provides Advanced settings for how the report will be displayed, its external accesses, its caching options and more. For more information about the Advanced configuration, please see our Advanced Settings of Reports section. 

Editing Reports

After clicking the Save button, the page will reload and save your report into the system. You will now be in the position to edit this report with more detailed configuration. 

The Builder Type will no longer be modifiable once you have saved your new report. Furthermore, the main report information will now include the Created By, Last Modified, and Last Modified By auto-populated fields. 

To the right of the page will be the Notes tab that allows you to make new notes or see any existing notes that have been made on your report. 

You will also be able to see the following new buttons at the bottom of the page: Save, Save As, Delete, and Preview. 

• If you have not yet selected any table(s) nor fields from tables in your Report Builder, you will not be able to see a preview of the report.

Copying a Report

• The Save As button at the bottom of the General Settings page when editing any individual report will enable a pop-up to appear that prompts you to enter the new name of your report. Once you insert a name and click OK, the system will make a copy of this report under the new name, and the list of reports accessed from Tools > Reports will be updated with this new copy. 

When a report is copied, the configurations made in the Report Builder and on the Advanced, Security, File Export, Custom Export and Report Template tabs will be copied over to the new report. Sub-Report settings and Charts will not, however, be copied.

Report Tabs

If you selected Classic Builder Type for this report, the following tabs will appear after the General settings tab. 

Each Classic Report Builder tab will soon have its own subsection within this article for further explanation, if needed.

• Note: In Report Builder Neo, the only difference is that you will not see a Sub-Reports tab. 

Adding a Table to a Report

The first step for constructing a report is always to add the tables required to the report on the Recordsets tab (right after the General tab). 

1. As as an example, in the Recordsets tab, scroll down and set the Primary table option for the Contacts table.

Selecting the primary table automatically selects that table for the report.

2. Click the Save button at the bottom of the page. 

• For more information about Inner and Outer Join, see this article - however, the default when you add a table to a report is Inner Join, and the Outer Join functionality is not necessary until you want to add multiple tables to a report. 

Launching the Report Builder

Once you have Saved your new report, a four square icon will appear at the top left of your page above the report name.

Clicking on this icon will launch a modal window that displays the Report Builder, either in Neo or Classic.

 It is highly recommended for all users to use the Report Builder Neo for easier and more intuitive functionality. 

• Ensure that your Builder Type is selected as Neo in order to launch the Report Builder Neo. 

Classic Report Builder - Column Settings

In the March 2020 upgrade, the ability to create classic style report was depricated. Existing reports will continue to function, but you will not have the ability to copy or create any new reports that use the classic report builder.

Report Builder Neo is recommended for all users, please see the Report Builder Neo - Column Settings section of the page.

Each column will consist of the basic construction of the report by selecting the required fields and setting the way that the field should be used within the report.
Each report column consists of the following settings: 

Column Heading	The text that 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	This refers to the recordset that has been selected in the Recordsets tab. If multiple recordsets have been selected to build your report, you can select which one you want to use as a table for your report from the drop-down when you click into the field box.
Type	When a specific recordset has been selected, the Type field box will have a drop-down of corresponding types. Depending on what recordset it is, you can select the category, role, template, or type from which your field will be derived. Ex: If the Recordset you selected was Contacts, the corresponding Type would be from the available system roles.
Field	The field you wish to display in this column. All of the 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 comparative 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 sort order of the report results, either Ascending or Descending.
Align	Determines the alignment of the column header and column values. Options are Left (default), Center and Right.
Calculated Field	This option allows you to build out further complexity - for example, mathematical operators and concatenation. This field also supports MySQL syntax.
Show	Checking this option will show the specific field data. An example of when you might not want to enable Show is if you wish to produce a list of salaries over $100,000 a year and use the salary as criteria, but not show the result.  Left/Right Move Arrow Icons - These icons are displayed on the left and right of each Show check box and can be used to change the column order.
Show Total	Checking this option will display the total of all the data accumulated from this column.
Criteria	Here you can set the criteria for which records to be displayed in a report. There are 5 columns available for setting criteria, each separated by the OR operator.

• Note: If you want to add more columns, click on the More Columns button at the bottom of the page to add 25 more columns. 
• There is a fixed limit of 50 columns for the Classic Report Builder. If more columns are required, you will need to use two reports linked together - see Merge Sub-Reports. 
• Tip: The browser Mozilla Firefox will load the Report Builder more efficiently than Internet Explorer. 

At the bottom of the page are a row of buttons: 

Classic Report Builder Help Panel

At the very bottom of the Classic Report Builder interface is the Help Panel with an upwards arrow that will open up help options when clicked. 

The Help menu consists of 6 tabs, each with helpful information corresponding to that tab's topic. 

Report Builder Neo - Column Settings

If your new report has been saved under Builder Type - Neo, then the Report Builder that is launched will be the Neo rather than the Classic version. 

The Report Builder Neo was introduced as an upgrade to our Classic Report Builder; it provides the following benefits: 

• A more intuitive interface with higher degree of configurability 
• Saving time and effort in creating targeted, impactful reports
• Uses your organization's language (the terminology related to your )

The primary upgrade in Neo is that it streamlines the process of finding, selecting, and setting up your information. 

The Report Builder Neo can only be used to create new reports; any existing reports with the Classic Report Builder will not be able to switch to Neo. 

1. Click on the four-square icon on the top left of your page to launch the Report Builder Neo. 

2. The Report Builder Neo window will open up as a modal window: 

It will have the following functions and fields: 

• The Report Builder Neo has the Drag and Drop functionality to re-order the display view of columns in a report and to input fields into the appropriate columns. 
• The Report Builder will automatically note which base dataset your columns relate to. 

You can also use the Search functionality in the dataset field picker in order to narrow down your fieldset to those which include matches to a word search. Simply click on the Fields tab, and insert your search into the search box: 

Report Builder Neo Help Panel

See the Classic Report Builder Help Panel. 

Deleting a Report

The user must be permissioned to be able to delete a report in order to do so. 

Batch Delete Reports

1. Click on the 9-square menu icon on the top right of your page.

2. Under the heading Tools, select Reports. 3. Check the box on the left of all report names for the reports that you wish to delete.  4. A trashcan icon will appear in the top left row of buttons once at least one report has been selected. Click on this button to batch delete all of your selected reports.

5. A confirmation message will pop-up on your screen. Click Yes to confirm the deletion.  The reports will be deleted and your list view of reports will refresh to display these changes. 

Individually Deleting a Report

1. Click on the 9-square menu icon on the top right of your page.

2. Under the heading Tools, select Reports. 3. Click on the pencil icon next to the name of the report that you want to delete to go into Edit mode for that report.  4. The report details will be displayed, and at the bottom will be a Delete button among a row of other buttons. Click on the Delete button.

5. A confirmation message will pop-up on your screen. Click Yes to confirm the deletion. The report will be deleted. Your page will refresh and you will be brought back to the list of reports, now updated to reflect your deletion.

View Deleted Reports

In order to see which reports have been deleted from your system, either by you or another user, you can always click onto the last tab in the Reports section of the system, titled Deleted Reports.

• Note: Only a user with System Administrator privileges can view the Deleted Reports tab. 

  

The list of deleted records will have columns that include who deleted the report (Deleted By column) and when (Deleted Date column, presented as a date and time stamp).

Restore or Purge Deleted Reports

 You must have SysAdmin privileges in order to view or modify already deleted reports. 

 1. Click on the 9-square menu icon on the top right of your page.

2. Under the heading Tools, select the hyperlink Reports.

3. The list view of reports will be displayed. Click into the last tab, labelled Deleted Reports. 

4. The list of deleted reports in your system will be displayed.

5. Select the checkbox on the left of the report name of the report that you would like to either Restore or Purge.

Once you click this checkbox, two buttons will appear on the top left of your page underneath the tab labels. The reload button will allow you to restore the deleted report so that it will once more be accessible, viewable, and modifiable in your system. The trashcan icon will allow you to permanently delete this report, so that it is not accessible even from the Deleted Reports tab. 

 

• Note: If you choose to permanently delete a report, a pop-up confirmation message will appear. Click Yes to go through with this purge. 

 Any reports that have been deleted for over one year will be automatically purged. 

Configuration - Advanced

Advanced Settings of Reports

The second tab on the New Report page is labelled Advanced. This tab will display all the advanced settings that can be configured for the report.

The options for the Advanced tab are described in the table below:

Criteria Text	Text used to prompt the user when they are required to enter some criteria values. This setting will also specify the introduction text, as well as labels for Custom Fields. Labels are defined by a hyphen (-) preceding the label (ex: "-First Name") and are applied to the criteria fields in the other that they are entered.
View Mode	List View - Selecting this option will allow all the records to appear in a list. Single Record View - Selecting this option means that each report will be displayed one at a time.
External Access	Internet Enabled - Toggling on this function will generate a URL that allows the report to be accessed over the internet without the need for a user to log into the system. This setting is useful for creating public reports.
OData Connector	Toggling on this option will use Open Data Protocol to simplify data-sharing across disparate applications in enterprise, Cloud, and mobile devices. This feature will only appear for Neo Reports; it is not available for new Classic Reports.
Disable Global Template	Toggling on this option will disable the Global Report Template (a personalization of HTML header/footer for all system-based reports) for this specific report.
Interactive View Display	None  Display Link to Interactive View -  Open Report Directly in Interactive View -
Total Label	Provide a name for the Total column. See Using Total Group Options in Report Builder for more./
Enable Translation	Allows report headers and associated charts to use translation options in the system's Language Library. See Using Language Translation in Reports for more.
Enable Straight Join	See Straight Join.
Enable Pivot View	Enables pivot functionality; this means that when grouping by two different columns, you now have the option to perform an aggregate function and pivot the grouped columns across the x-/y-axis. This example report is using "Pivot View" with the data grouped by "type" and "status". The user can choose which group options they wish to view via the drop down.
Merge Sub-Reports	Merging of two Classic builder type reports
No Name URL Parameter	See Enable URL Parameter Encryption.
Hide Custom Export	This will hide the ability for a user to Custom Export this report by hiding the custom export icon .
Hide File Export	This will hide the ability for a user to File Export this report by hiding the export icon

Report and Field Caching

Scrolling further down the Advanced Settings tab will allow you to modify the functionality of caching for reports and field. 

Internet-Enabling Reports

The ability to Internet Enable a report is useful because it will make that report public, presenting real-time reports on the Internet - it generates a URL relating to that report that can then be linked to your website, or sent as a link in an email or email broadcast or other communication method. 

• The person who clicks the link does not need to have login access to your SmartSimple system. 
• Once the link is clicked, the report is processed and the results are displayed accordingly. 

The following steps are for reports made with Report Builder Neo, although the Classic Report Builder undergoes a very similar process for Internet Enabling reports. 

1. Once you have the Reports section of your system open (see Accessing Reports if needed), click on the pencil icon next to a specific report name to Edit it. 

2. Click on the second tab labelled Advanced. 

3. Look for the field External Access. Toggle on the Internet Enabled feature. 

• The URLs for reports that are Internet-enabled are automatically generated. Simply copy and paste them to use it.

4. Click Save. 

• Note: You can always tell whether a report is properly Internet-enabled if it has a black dot in the Internet-Enabled column on the main reports list view, found from Tools > Reports. See screenshot below. 

  

Language Translation for Internet-Enabled Reports

Users can now add a parameter to the Internet Enabled URL of all reports so the results and column headers can be made language-specific, if corresponding translations have been configured for the fields.

The parameter used is lang followed by the ID of the language that the report should be translated into.

In the example below the parameter lang=2 is used to translate the report into French.

https://test.smartsimpleqa.com/ex/ex_viewreport.jsp?key=&token=%40GgUNSxoaeFxbSxRdSRxRRVdQZFB3H3Q~&lang=2

Reports vs List Views

In terms of displaying data, SmartSimple offers numerous methods to do so. In particular, list views and Reports are two of the most popular and highly configurable functions. A critical question is therefore when is it appropriate to use a list view, and when is it appropriate to build a report? For more in-depth information, see our List View and Reports - Why? page. 

See Also

• List View and Reports - Why?