Creating a Dashboard Header Page and Component Definition

The dashboard header component defines the contextual data keys that are used to provide context to the tiles on the dashboard. This dashboard header component is normally displayed fixed at the top of the dashboard page except when the dashboard is displayed in a fluid activity guide, master/detail component, or on a small form factor device.

To create a dashboard header page and component:

  1. Create a new, standard page definition. Do not select the Page (Fluid) definition type because that also requires selecting a layout type.

  2. On the Use tab of the Page Properties dialog box, select the Fluid Page check box.

  3. Add a group box to the page encompassing most of the width and height of the page.

    1. Select the Fluid tab of the Group Box Properties dialog box.

    2. In the Style Classes field, enter the following style: psc_lpbanner-context

    3. In the Group Box Type field, select Layout Only.

  4. Add one or more input fields that represent the contextual data keys. Note the following design considerations:

    • Disable autocomplete for each field (record field properties, Use tab).

    • Do not use FieldChange PeopleCode on these input fields to invoke any BannerTile methods that would refresh the dashboard. See Adding PeopleCode to the Dashboard Header Page and Component for information on how to add an Update button to the page.

    • In certain circumstances, rather than allowing input directly on this page, create a secondary page for entering contextual data. Do this when there are more than two input fields on the page or if an input field is a date field or a popup group box field.

      • Add an Edit button on the main page to open the secondary page.

      • Set the input fields on the main page to display only.

  5. In designing your page and component, note the “Limitations with Interactive Grouplets” in Fluid Related Content.

  6. Create a standard fluid component definition. Note the following design considerations:

    • Specify a search record as is appropriate for your page and component design.

    • On the Fluid tab of the Component Properties dialog box, ensure the search page type is None.

    • Do not run the component registration wizard or register this component in the portal registry. Do not create a content reference definition for this component in the tile repository. Moreover, do not provide any direct menu navigation to this component.

  7. Manually, add the dashboard header component to a menu definition in Application Designer.

    Note:

    If necessary, create a menu definition specifically for this and other dashboard header components.

  8. In the browser, add the menu, component, and page to one or more permission lists. Use these same security settings when you create the fluid dashboard definition.

WARNING:

While the delivered PTNUI_BANNERTILE component provides an example of a dashboard header component, do not clone this component or the PTNUI_BANNERTILE page as a starting point for your implementation. Moreover, do not clone the PTNUI:Banner:DefaultBannerTile to create your custom application class.