Report Viewer Control
  • 26 Sep 2022
  • 5 Minutes to read
  • Dark
    Light

Report Viewer Control

  • Dark
    Light

Overview

The Report Viewer control provides a way to view Reports on a Page. The control can be found under the Reports category.



Report Setup

SettingDefault ValueDescription
Pick or Create Default Report---Sets the default report to be displayed by the report viewer
Get Report Id from Selection BusFalseRetrieves a Report ID, which can be used to display a Report
Default Folder---Determines the default folder that houses the Reports.



Behavior

SettingDefault ValueDescription
Initially VisibleTrueSets if the Report Viewer control is visible when loading the page
Initially EnabledTrueDetermines if the Report Viewer can be interacted with
Navigate ActionPortal NavigationDetermines what occurs when a row on the Report Viewer is clicked
Pick or Create Selected Row Flow---Starts a Flow that runs when a Row item is selected
Actions------

Filter Actions------


By CategoriesFalseFilters actions by categories


By NamesFalseFilters actions by name
Grid------

Start in Multi Select ModeFalseDisplays the Report in Multi Select Mode

Reset Selection on RefreshFalseResets the selected Row on refresh

Column Filtering------


EnabledFalseAllows filtering  based on the column

Grouping------


EnabledTrueEnables grouping Rows in a Report


Show Group Field NameDefaultDrop down list which determines whether the Group Field Name will be displayed.


Collapse on LoadFalseCollapses Grouped row items on load


Show Group Collapse/Expand asButtonDetermines if a button can be used to collapse/expand grouped rows

Paging------


Use PagingUse Designer SettingsDetermines if paging will be used by the Report. 
Print------

Excel Default Template---Determines the default excel template used when exporting the Report
Refresh---Settings which control if the displayed Report will be refreshed
Settings------

Show Default Report ListFalseDisplays a list of default reports used by the Report Viewer

Get Parameters From PageTrueDetermines if the Report Viewer can retrieve parameters from the Page.

Show loading indicatorTrueDisplays the loading indicator text when Reports are being loaded

Auto Select First RowTrueAuto selects the first Row on the Report.

Loading indicator textLoading...String which is displayed when the Report is loading

Hide No Action MenuFalseSetting which toggles whether to display the No Action Menu

No Data MessageNo data to displayString which is shown when the selected Report has no data to display
Text------

Grouping------


Show Grouping OptionTrueDisplays what group each Row belongs to, if it is grouped


Show Only ValueFalseDisplays only the grouped values



View

SettingDefault ValueDescription
View Mode---Determines the views available for a Report in the Report Viewer
Default ViewUse Designer SettingsSets the default view of a Report used by the Report Viewer
Data Drill ViewDataDetermines how the Data Drill View will be displayed as
View to PrintCurrent ViewControls which view will be shown when the Report is being printed
Hide HeaderFalseHides the Report Viewer Header
Show Header As ToolbarUse Designer SettingsDisplays the Report Viewer Header as a Toolbar
Override Drill Down Dialog TitleFalseAllows the Drill Down Dialog Title to be overridden
Override Drill Down Report TitleFalseAllows the Drill Down Report Title to be overridden
Control Css Class---Determines the CSS class which will affect the Report Viewer control
No Data Message Css Class---Sets the CSS class which affects the No Data Message text.

Calendar View

SettingDefault ValueDescription
Calendar View Modes---Controls which Calendar Views will be available to be used by the Report Viewer
Default View Mode---Determines which Calendar View will be displayed as default by the Report Viewer
Navigation Bar VisibleTrueControls whether the navigation bar is visible
Time Interval60Displays events tied to specific time intervals
Navigation Bar DisplayBottomDetermines where the navigation bar will be displayed by the Report
Working Schedule------

Start Time9Displays events on or after the specified start time for the day.

End Time18Displays events before or on the specified end time for the day

Days Of Week---Limits events to only display on the selected days

Chart

SettingDefault ValueDescription
Turn Off Drill DownFalseDisables Drill Down View for the Report
Show Add/Remove Chart AsButtonAllows charts to be added/removed from the Report Viewer

Grid

SettingDefault ValueDescription
Can Add ColumnsUse Designer SettingsDetermines if additional columns can be added to the Report.
Show Group Actions ButtonShow Group Actions ButtonToggles, whether a button to display Group actions, is available
Always Show Action On RowAlways Show Action On RowDetermines if Actions will appear when a Row is selected
Allow Settings PersistenceFor current folderDetermines if Report settings will persist between page loads
Remember SelectionFalseDetermines if the selected Row will still be selected on page load
Notification GroupSelectionBusControls what values to pull from the selection bus
Hide Column HeaderFalseControls whether column headers will be hidden
Allow Adjusting of Column PropertiesFalseDetermines if column properties can be adjusted when viewing the Report
Grid StyleDefaultSets the Grid style used by the Report Viewer
Grid Settings TypeDefaultDetermines the Grid Setting used by the Report Viewer
Show Runtime Editable Filters as Column FiltersFalseControls whether Runtime Editable Filters will be displayed as Column Filters

Header

SettingsDefault ValueDescription
Show Report SelectionTrueDetermines if the current Report Shown is selected in the header for the Report Viewer.
Selection Folders---Controls what folders are available to pull Reports from
Save Report SelectionFor current folderSaves the current selected Report for the Folder
Show SnapshotsNoDisplays Snapshots taken for a Report
Show Refresh AsButtonDetermines if the refresh button will appear on the header for the Report Viewer
Show Export AsButtonDetermines if the Export action will appear in the header for the Report Viewer
Show Favorites AsButtonDetermines if the Favorites action will appear in the header for the Report Viewer
Show Edit Filters AsButtonDetermines if the Edit Filters action will appear in the header for the Report Viewer
Show Save Report AsButtonDetermines if the Save Report action will appear in the header for the Report Viewer 
Allow Edit Report Button in HeaderUse Designer SettingsDetermines if the Edit Report action will appear in the header for the Report Viewer
Search------

Show SearchTrueDetermines if the Show Search button appears in the header for the Report Viewer

Layout View

SettingDefault ValueDescription
Allow Group CollapsingFalseControls whether grouped rows in Layout View can be collapsed
Show Action BarFalseControls whether the Action Bar will be displayed when displaying a Report using Layout View

Matrix

SettingDefault ValueDescription
Column Size ModeAuto SizeControls the column size used for displaying a Matrix View Report in the Report Viewer.
Row Size ModeAuto SizeControls the row size used for displaying a Matrix View Report in the Report Viewer.
Items Across Intersection1Controls how many items will appear in the intersections for the Matrix View. By default, this value is 1
Limit Rows and ColumnsUse Designer SettingsControls how many Rows and Columns that will be displayed in the Report Viewer

Preview

SettingDefault ValueDescription
Width200Determines the width of the Page when using the Preview action
Height100Determines the height of the Page when using the Preview action
Specify Percentage ValueFalseDetermines if percentage values will be used instead of specifying the width and height when using the Preview action
Show ActionsTrueDetermines if Actions will appear  when using the Preview action

Rich Text

SettingDefault ValueDescription
Columns1Determines how many columns will be displayed when using a Rich Text View of a Report
Show Action BarFalseDetermines whether the Action Bar will appear for a Rich Text View of a Report
Row Left Click Action TypeShow ActionsSets the behavior when left clicking a row
Row Right Click Action TypeUse DefaultSets the behavior when right clicking a Row

Text List

SettingDefault ValueDescription
Always Show Action On RowTrueDetermines whether or not actions will appear for a row for a Text List View of a Report



Help

SettingDefault ValueDescription
Help Message Key---Sets the Help Message Key used by the Report Viewer
Pick Help Message KeyFalseAllows preconfigured message keys to be used



Settings

SettingDefault ValueDescription
Part TypeBaseContentControls how the Report Viewer will be displayed on the Page
Use Custom TitleFalseAllows a custom title to be set for the Report 



For further information on Pages, visit the Decisions Forum.



Was this article helpful?

What's Next