A dashboard is a part of the user interface that contains one or more widgets grouped into slots arranged within a template. A template is an arrangement of slots. Each slot can have multiple (or no) widgets assigned to it. Widgets contain controls that the user can configure.
Use this tutorial to create a personalized dashboard template in Designer Studio for displaying case data in an application. An example configuration is also included.
This walkthrough takes approximately 15 minutes to complete.
Before getting started, you must enable dashboard personalization for your portal. The Customize dashboard icon is displayed at the top of the screen for users who have the privilege for pxDashboard. You should also add the section pxUserDashboard if the Customize dashboard icon is not displayed.
Choosing a default template
The Pega 7 Platform includes several default templates that require no setup.
To select an existing template at run time:
- Click the Customize dashboardicon to display the Edit dashboard panel.
- Click Switch template.
- Select the template that you want to use.
Default templates available in the Pega 7 Platform
Creating a customized template
To create your own dashboard template, complete the following steps:
- Create a section
- Add dynamic layouts
- Set section type
Create a section
- Create a section for your template by clicking
- In the Apply to field, reference the class that you want in your application.
Ensure that your section is in the same class as the harness being used for your dashboard, or in one of its parent classes.
- Click Create and open.
Add dynamic layouts
In this set of instructions, you want each dynamic layout that you add to represent a slot for assigning widgets.
- Add dynamic layouts to the section to match the layout that you want.
- Drag the section pxUserDashboardSlot into each dynamic layout (slot) so that you can place widgets.
Do not use a repeating layout when placing the pxUserDashboardSlotsection.
- Change Page context to Use clipboard page.
- Use .pxUserDashboard.pySlots(x) for the Clipboard page, where x represents the slot number.
Use the most important or main content in the first slot .pxUserDashboard.pySlots(1) as a best practice.
- Add the name of your section.
- Optional: You can customize the direction of your widgets by including a section parameter, or you can leave this field blank to stack your slots by default.
Slot orientation options are case-sensitive and include:
- stacked (default)
- Click OK, and then save your changes.
Set the section type
Identify the type of section that you are creating and configure its settings.
- From the Settings tab, select Dashboard template.
- Enter a title and, optionally, an icon for your template.
- Click Save.
You must save your progress, check in your rules, log out, and then log in again after creating a template in order for the template and widget pickers to display correctly at run time.
You have successfully created a dashboard template. From the Case Manager portal, select the Settings icon to view your new template at run time.
For a guided walkthrough of adding widgets to your template, see Quick start: Creating a dashboard widget.
Now that you know the basics of setting up a template, get the most out of your customized dashboards by viewing Section form - Completing the Settings tab. From here, you can obtain additional information about: