To publish reports on the Dashboard, or the “frontend”, modules are used. There are a growing number of modules that can be used independently or together to offer functionality to the end user.
Modules:
Report
This module is used to publish a specific view of a report.
Display Options
Show Title: Show the view title, on the left side above the report table.
Show Filters Btn: Show the "Filters" button, on the right side above the report table.
Show Export Btn: Show the "Export" button, on the right side above the report table.
Collapsible Columns: Collapse columns based on the available horizontal space on the page.
Filtering
Filter by Logged Person: The report needs to contain a column with a "person_id" identifier which will be used to filter by, using the logged-in person's ID.
Filter by Logged Person's Household: The report needs to contain a column with a "household_id" identifier which will be used to filter by, using the logged-in person's household ID.
Links
Configurable links for columns in a report view. You can select a site page or enter a custom URL, and configure query params that can use data from the report. Multiple of these can be configured on a given report.
View Column: (the column where the link will appear)
Site Page: (the site page where the link will point to)
Custom Link: Leave empty to use the site page selected above (or a custom URL where the link will point)
Query param: This can be used to pass values to other pages a common one would be passing the person ID to a CRM record detail page with the param `person_id` to view the full record
Download Report
This module is used for an in-browser download of a specific view. It can be published on its own, or in conjunction with a “report” module. If published independently, it will export the entire view with the exception of any filtering that is specifically applied to the module itself. If published in conjunction with a report module, filters can be applied by the user and the export will be limited by those filters.
Button Label
The display on the button to the end user. E.g. “Download Statement”
Report View
Identifies the report to export from. If being published in conjunction with a report module the views must match for additional filtering to apply
File Type
CSV or select a specific PDF template for export
Filtering
Filter by Logged Person: The report needs to contain a column with a "person_id" identifier which will be used to filter by, using the logged-in person's ID.
Filter by Logged Person's Household: The report needs to contain a column with a "household_id" identifier which will be used to filter by, using the logged-in person's household ID.
Report Date Range Filter
Only adds additional quick filtering to report modules published on the same page.
This filter works on any report that has a column with the same identifier as defined below.
Value Identifier:
Specify the column identifier that will be used to filter the results EG “date” which would need to match the identifier on a date column.
Start / End Label:
Show Clear Icon:
Check this to show the clear icon to clear the fields. Note that even if this is unchecked, the fields can still be cleared manually.
Match NULL:
Check this to also match null values.
Report Value Filter
Only adds additional quick filtering to report modules published on the same page.
This filter works based on a report that has two columns with identifiers set, that provide the value and the display of the filter, respectively. The identifier for the value will be used to apply the filter in the URL.
Report
Report:
Select a report (not view) that will be used to extract the values for the filter.
Value Identifier:
A specific identifier is already configured on a column in the report. E.g. person_id
The column identifier that will provide the values for the filter (usually an id, eg. a data group id value)
Display Identifier:
The column identifier that will provide the display values for the filter (usually a label, eg. a data group display value). Can be the same as the value identifier.
Order Identifier:
The column identifier will be used to sort the filter values in the field. If not specified, the values will be sorted by the "Display Identifier" column. Example: You might want to sort random values like "Past 13 months", "13-26 months ago" etc. in a specific way.
Order Direction:
ASC or DESC (Ascending or Descending)
Display
Default Value:
A default value will be used to apply an initial filter on the report results. When set, the clearable option below should remain unchecked, to always force this filter on.
Clearable:
Check this to allow the filter to be cleared.
Filtering
If the Report module is already filtered by the logged-in person or household, configuring this will improve the performance speed of the quick filter.
Filtering by the logged-in person is very important for performance reasons! It should be checked when the filter is used with a report that is also filtered by the logged-in person, to speed up the request for getting the filter values.
Year/Month Filter
Only adds additional quick filtering to report modules published on the same page.
For this filter to work, the report needs to have two columns for the year and month, with identifiers year and month respectively.
Year
Report
Select a report that will be used to extract all values for the year field.
Min/Max Year:
You can specify years (e.g. 2010) or zero or negative numbers, which will calculate the year backward starting from the current year (e.g. -3 means 2020 or 0 means 2023).
Month
Show Month:
Check this to show the month filter along with the year. If this is unchecked, only the year will be displayed.
Disable if only the year filter is desired
Clearable Month:
Check this to allow the month to be cleared, thus filtering only by the year.
Modified on Mon, 18 Sep, 2023 at 10:03 AM
Was this article helpful?
That’s Great!
Thank you for your feedback
Sorry! We couldn't be helpful
Thank you for your feedback
Feedback sent
We appreciate your effort and will try to fix the article