This content has been archived.

Table of Contents

Quick start: Setting up a dashboard

A dashboard is a landing page that is created from a portal. It contains one or more widgets grouped into slots that are arranged within a template.

To set up a dashboard, you need to do the following tasks:

  1. Create a custom portal
  2. Create a dashboard template
  3. Create a dashboard widget

Creating a custom portal

A custom portal references a harness that in turn references a section to determine what is displayed when the portal is launched.

Use this tutorial to create a personalized custom portal for creating the dashboard in the user portal, such as Case Manager in the application. An example configuration is also included.

This walkthrough takes approximately 15 minutes to complete.

Requirements

Before getting started, you must be in the Designer Studio portal for your application. From here, you need to do the following tasks:

Create a harness

You can create a harness by using one of the following procedures:

Copying an existing harness rule

To copy a harness, open an existing harness such as:

  • pyCaseWorker – Case Worker dashboard harness
  • pyCaseManager7 – Case Manager dashboard harness

This example creates a copy of the Case Manager harness to use as a foundation for your custom harness.

  1. Search for pyCaseManager7, and then open the harness.
  2. Click Save as to copy the harness.
  3. Give the harness a new name and save it in the context of your application.
    Harness Create/Save As rule form
  4. Click Create and open.

Create a new harness

You can also use a new harness in your custom portal.

  1. Create a harness by clicking +Create > User Interface > Harness.
  2. Set the Apply to field to the Data-Portal class so that the harness can reuse existing sections.
  3. Click Create and open.
When you create a new harness rule, you need to add sections for the header, navigation, and content.
  1. Click the Scripts & Styles tab.
  2. Enter py-dashboard-personalization in the File name field of the Style sheets section to enable the dashboard personalization.
    Harness Rule Form
  3. Click Save.

Create a portal

  1. Create a portal for your dashboard by clicking +Create > User Interface > Portal. Set the context to your application ruleset and click Create and open.
    Create dashboard portal form
  2. Enter the class that your harness belongs to in the Harness applies to field.
  3. Enter the name of the custom harness that you created in the Harness name field.
  4. Use defaults for all other fields, and then click Save.
    Portal Rule Form
  5. Open the access group that the new portal applies to and add it to the list of available portals.
    Access Group Rule Form
  6. Click Save.

You now have a portal available to the members of the corresponding access group.

Test your example at run time

To see your new dashboard option, open the Launch menu and look for the new portal name.

Next steps

Now that you know the basics of creating a custom portal, you can personalize it. For more information, see these PDN articles:

Quick start: Creating a dashboard template

Quick start: Creating a dashboard widget

Suggest Edit

80% found this useful

Have a question? Get answers now.

Visit the Pega Support Community to ask questions, engage in discussions, and help others.