Designing a dashboard widget is the first step in the process of dashboard designing.
A dashboard widget is a single visual information provider that cannot be further subdivided.
Dashboard widget is designed on Widget Designer page. You can also open and update a previously designed dashboard widget. As a part of dashboard widget designing, you set report or a web link on the widget and save it as an application object.
A widget can be placed on multiple dashboards.
To open widget designer page, click Navigate > Design > Dashboard Widget (Figure 2)
Figure 2: Create Dashboard Widget
The Widget Designer opens up as shown in Figure 3.
Figure 3: Widget Designer
Every dashboard widget has a unique Widget Name.
In Contents, select the item that the widget should display:
- To display report output, select Report.
- To view content available at a URL, select Web Link.
Other details you need to provide for a dashboard widget depends on the contents.
To place a report layout on the widget or create a new Ad hoc/ Smart/ High Speed View report, click Real Time tab. When such a widget is placed on dashboard, the report is executed and output is displayed on the widget.
To place a pre-generated report output (output of a published report) on the widget, click Pre-generated tab. This is a report, which is already generated. When such a widget is placed on dashboard, pre-generated output is displayed on the dashboard as it is.
Click Real Time tab to place a report on the widget.
Figure 4: Selecting a report for widget
Select a Report. If the selected report has runtime user parameters, then Report Parameters will be displayed below the property area, where you will need to provide parameter values. When dashboard having this widget will be viewed, the report will run using the parameter values provided on the form.
You can also create or edit an Ad hoc, Smart or High Speed View report by clicking the down arrow adjacent to the report dropdown.
Click Pre-generated tab to place a published report on the widget. You can filter the reports by selecting values in Report, By Job and In Category.
Figure 5: Selecting a pre-generated report on widget
To get last published instance of:
- A specific report: From Report, select the report. You need not make any selection in By Job as well as In Category.
- A report executed by a specific job: From By Job, select a job. You need not make any selection in Report as well as In Category.
- A report deployed in a specific category and executed by a specific job: From In Category select a category and from By Job select a job.
- Any of the reports from the jobs you own: You own the jobs that you created or were created on your behalf. Check Look in User’s all jobs
- Any of the reports deployed in your default category: Check User’s working folder
Web Link Widget
Select Web Link to view content available at a URL. In URL, specify the URL you want to display in the dashboard widget.
Widget related common information and information specific to what is placed on widget is provided in Web Link Widget Properties area of the page.
Widget Properties in case an ad hoc/smart/standard report is added on the widget
- Report Format: Select the format in which report should be displayed on the dashboard widget. It could be Acrobat PDF, HTML, iHTML or Smart format.
- Show Control: In case of smart report format, you can specify what controls (grid/chart/all) to show on the dashboard from the Show Control drop down menu.
- Viewer Toolbar: Using the Viewer toolbar, you can switch between different views like chart, grid etc. of smart report. In case of an ad hoc report, you have export, print, publish, email, upload and refresh report options on the Viewer toolbar. Select Yes to always show the toolbar, No to keep the toolbar in hidden state and On Multipage to show toolbar only if the report is a multi-page report.
- Ad hoc Toolbar: Dashboard Designers can display the Ad hoc toolbar on the widget containing smart or ad hoc report. This facilitates the end user to change the parameters, sorting order or grouping etc. as per their need and see the effects on the dashboard immediately. Select Yesto always show the Ad hoc toolbar,No to keep the toolbar in hidden state and select Yes Expanded to show the Ad hoc toolbar in expanded format.
- Ad hoc Toolbar Tabs: If the Ad hoc toolbar is set to Yes, you can select multiple tabs (using ctrl or shift key with mouse click) that you wish to see on the toolbar. Example, Fields, Filter, Group etc.
- You can see the Report Options (under the ellipsis icon ) on the report if both the Viewer and Ad hoc Toolbars are set to Yes. To know more about the report options, please refer WorkingwithSmartView.pdf for smart reports or DesigningAdhocReports.pdf for ad hoc reports.
- Parameter Toolbar: The report selected for dashboard widget may have parameters. Parameter value for such a report needs to be provided during dashboard widget design. Select Yes if the user should provide values at runtime (when the report is actually executed) also (on dashboard viewer, Input Parameter Form in collapsed state will be displayed where user will need to provide parameter values). Select No to provide parameter values during dashboard widget design only. Select Yes, Expanded when the Input Parameter Form is displayed in expanded format.
Figure 6: Parameter Toolbar as Yes, No and Yes, Expanded
Note: If the standard report uses parameter “By Ref”, then such parameters are candidates for “Dashboard Parameters”. On Dashboard, a common Input Parameter Form (among all the reports) will be displayed to receive values for all such Dashboard Parameters.
- Show Scrollbar: The content at the URL may be more than what can be displayed on the widget. If toolbar is displayed, you can scroll down to view the parts that are not visible on the dashboard widget. Select Yes to show scrollbar. Select No to keep the toolbar hidden.
- Link Widgets: This is used to link this widget with another widget. This will appear if report has a grid, chart or map component. When you click this button, a dialog will open. On the dialog, in Item(s), select the series and in Widget(s) select the widget to be opened when the selected series is clicked. Both the widgets need to be placed on the dashboard.
Ad hoc toolbar on Dashboard Widget
Dashboard Designers can now display the Ad hoc toolbar on the Widget containing an Ad hoc report. This facilitates the end user to change the filters, sorting order or grouping as per their need and see the effects on the dashboard immediately. Widget designer need to enable the Ad hoc toolbar and choose what all tabs they want in the toolbar and then include the same widget on the dashboard.
Figure 7: Ad hoc Toolbar in Dashboard Widgets
The above two widgets when visualized on a dashboard will come with the respective tab enabled on the Ad hoc toolbar.
Figure 8: Ad hoc Toolbar in Dashboard
Widget Properties in case OLAP Report is selected on the widget
- Mode: You can choose to display an OLAP report either in View or Edit mode.
- Filter: Select whether to show or hide the filters applied to the OLAP report.
- Drill Operations: Select enable/disable to allow/restrict user to perform drilling actions on the OLAP report.
- Expand Operations: Select enable/disable to allow/restrict user perform expand or collapse actions on the OLAP report.
- Selection Operations: You can enable this option to be able to select specific data on the OLAP report.
- Change Cube: Choose the Enable option to allow user to change the cube object for the OLAP report.
- Fields Selection: If enabled, user can add or remove fields to the Crosstab view of existing OLAP report.
- Add/Remove Views: You can choose to enable or disable this option, to allow or restrict user to add and remove views to the OLAP report.
- Change Visualizations: Select Enable to allow user to change the visualization type of the OLAP report.
- Report Properties: Report Properties like the Report Name, Default View, etc. can be shown or hidden.
- View Properties: Properties specific to a selected view can be shown or hidden using this option.
- Save: To show or hide the option of saving the OLAP report on the dashboard.
Pre-generated Widget Properties
- Viewer Toolbar: Select Yes to always show the toolbar, No to keep the toolbar in hidden state and MultiPage to show toolbar only if the report spreads over multiple pages.
- Instance Navigation: This is applicable when the report placed on the dashboard was already run and saved multiple times. Click Yes to get a dropdown box to select one of the saved reports and view it. Click No to view report as per preference set in Instance Type.
Properties common to all
- Use Report Name As Widget Title: Check this option if you wish that the name of the selected report should appear as title on the widget.
- Auto Refresh: If the report-data changes frequently, you may wish to refresh (regenerate) the report to view the latest report-data. Select Yes, to automatically refresh the report. Select No to continue viewing the report that was generated when dashboard was loaded for the first time.
- Refresh Interval: If Auto Refresh is Yes, specify the time in minutes or seconds after which the report should be regenerated. For example, to refresh the report every 15 minutes, set 15 Min(s) in the box.