Skip to main content

Creating Custom Dashboard Widgets

Distributor steps for building a custom dashboard widget in Encompass from a code block and editing it in the Dashboard Widgets table. Needs APISolutionAdmin permission; v22.11+.

B
Written by Bailey Naas-Thornton

Minimum Version Required: 22.11

Pre-Conditions

  1. The steps Require APISolutionAdmin permission
    ​
    ​

  2. Users will only be able to create or edit widgets for applications where they have a Solution Authentication.
    ​
    ​

  3. Users will only be able to add widgets to their dashboards if the widget's application is installed on their site or has to Require Installation = False

Steps

How to Create a Custom Dashboard Widget

  1. From the Dashboard Edit page, click the + icon and select the </> Code dashboard item to add a Code Block
    ​
    ​

  2. Select the Save Changes button
    ​
    ​

  3. On the Dashboard Edit page, hover over the Code section and click the Diamond icon
    ​
    ​

  4. Set the Widget Properties in the 'Convert to a Dashboard widget' overlay and click Convert when complete
    ​
    ​

  5. The widget is saved on the current Dashboard and a Dashboard Widgets record is created
    ​
    ​

  6. The Custom widget will now be available in the Dashboard Items menu when editing any dashboard
    ​

How to edit a Custom Dashboard Widget

  1. Using Universal Search, navigate to the Dashboard Widgets table
    ​
    ​

  2. Click the Pencil icon to open the Code Block Editor page
    ​
    ​

  3. Modify and update as needed and click 'Save Changes' when complete
    ​
    ​

  4. In the Save Dashboard Widget overlay, select a save option: Save as Released or Save as Draft
    ​
    ​NOTE: Changes made to the Code will impact all dashboards with that widget.
    ​
    ​

Did this answer your question?