Skip to content

How to create a profile dashboard

Replace the default Profinity home page with a custom dashboard for your profile. Build the dashboard in the dashboard visual editor, or upload an existing dashboard YAML file instead. The Profile Dashboard page is the full reference for profile dashboards.

Before you start, you need:

  • An active profile in Profinity.
  • The Modify profiles permission, which allows profile settings to be changed (refer to Roles and Permissions).
  • The Modify dashboards permission, which allows dashboards to be edited.
  • Optional: an existing dashboard YAML file to upload, if you are not starting from the starter dashboard.

Turn on the custom home dashboard

  1. Select ADMIN in the side menu.
  2. Select the Profile pill.
  3. Select the name of your profile in the list to open its settings.
  4. Enable the Custom Home Dashboard option.
  5. Leave the Dashboard YAML file (Optional) field empty and save the profile settings.

Profinity creates a starter dashboard from the built-in template.

Build the dashboard in the visual editor

  1. Go to the home page (select the home icon or refresh).
  2. Select the pencil (Edit Dashboard) icon in the menu at the right of the dashboard title bar.
  3. In DESIGN mode, add rows, groups, and widgets, set their properties and bind tags. Refer to Dashboard Visual Editor for the steps.
  4. Resolve anything listed under Schema validation issues, then select SAVE.

Close the editor to see the result, because DESIGN is an outline and not a live preview. The custom dashboard now replaces the default home page, and it stays in place whenever this profile is the active profile.

Upload a YAML file

You can upload a dashboard YAML file that already exists instead of building a new one, for example one written outside the editor or shared from another profile.

  1. Open the profile settings and enable the Custom Home Dashboard option.
  2. In the Dashboard YAML file (Optional) field, select your dashboard YAML file. It must have the .yaml extension.
  3. Save the profile settings.

An uploaded dashboard opens in the visual editor like any other, so you can change it there. The YAML tab shows the source, which you can copy as a backup. The editor does not save a dashboard that fails schema validation, and an invalid dashboard does not load.

Remove a profile dashboard

To revert to the default home page:

  1. Open the profile settings.
  2. Disable the Custom Home Dashboard option.
  3. Save the profile settings.

Removing the dashboard deletes its file

Saving the profile with Custom Home Dashboard disabled deletes the dashboard YAML file from the profile's dashboards folder and clears the dashboard file setting, so the file cannot be recovered from Profinity afterwards. Download or copy the dashboard YAML before saving the profile if it is needed again. If the file cannot be deleted, for example because of a file permission problem, the dashboard file setting is not cleared and the error is written to the log.

For more on dashboards, refer to the Dashboard Development Guide.