Portal board widget form

  • Release version: Australia
  • Updated March 12, 2026
  • 3 minutes to read
    • Summarize
    Summarized using AI
    This content was generated using new OpenAI-powered functionality. Results are provided on an as is basis and are not guaranteed to be accurate or complete.

    Summary of Portal Board Widget Form

    The Portal Board Widget Form allows ServiceNow customers to configure widgets for Investment Boards and Investment Portal pages. This form includes various fields that define how widgets are displayed and calculated, enhancing the visibility and management of investment metrics.

    Show full answer Show less

    Key Features

    • Name: Unique identifier for the widget.
    • Order: Determines the display sequence of widgets; lower numbers appear first.
    • Aggregate type: Specifies the method of calculating investment metrics (Sum, Average, Minimum, Maximum, Count).
    • Scripted: Option to include a custom script for calculations.
    • Show Label: Controls the display of labels or color indicators.
    • Active: Indicates whether the widget is currently active.
    • Display on board: Option to show the widget on the investment board.
    • Parent widget: Allows for a hierarchy of widgets with a maximum of three child widgets.
    • Include by default: Automatically includes the widget on new and existing boards without configured selections.
    • Short description: Brief overview of the widget's purpose.
    • Script: Custom script field for dynamic calculations, appearing only when the Scripted checkbox is selected.

    Key Outcomes

    By effectively utilizing the Portal Board Widget Form, ServiceNow customers can customize their investment board views, streamline their investment metric calculations, and enhance overall data visualization. This enables better decision-making and project management within the organization.

    Learn about the fields of portal board widget form.

    Table 1. Portal board widget form
    Field Description
    Name Unique name for the widget you are configuring.
    Order

    The order in which your widgets appear on both your Investment Board and the Investment Portal page. Lower numbers are placed ahead of higher numbers.

    For example, a widget with an order set to 100 appears before a widget with an order set to 200.
    Aggregate type Type of aggregation applied for the investment widget calculation: Sum, Average, Minimum, Maximum, and Count.

    For example, you are aggregating the actual cost of three projects, A, B, and C, surfaced by a filter. Actual costs are 1000 for project A, 2000 for project B, and 3000 for project C.

    If sum is selected as the aggregate type, then the actual cost metric value would be 6000. If average is selected as the aggregate type, then the actual cost metric value would be 2000. If minimum is selected as the aggregate type, then the actual cost metric value would be 1000. If maximum is selected as the aggregate type, then the actual cost metric value would be 3000. If count is selected as the aggregate type, then the actual cost metric value would be 3.
    Scripted Check box to specify a script for the investment widget calculation.
    Show Label Check box to display either the label or the color indicator.

    If you clear the check box, the Color field displays, which allows you to set the color.
    Active Check box to indicate that the investment widget is active.
    Display on board Check box to display the investment widget on your investment board.
    Parent widget Parent widget for this investment metric widget. A parent widget can have up to a maximum of three child widgets.
    Include by default Check box to show an active investment widget by default on:
    • new boards
    • existing boards that do not have widget selection configured
    The check box is selected by default.

    For more information on configuring widgets on an investment board, see Widget Configuration.
    Short description Brief description about the investment widget.
    Script Script written for the dynamic calculation of investment widget. This field is displayed only when the Scripted check box is selected.

    The following script returns a string containing the desired output to be displayed on widget. Five variables (which are programmatically introduced to the script) are available:

    • projectFilter: Project filter of Investment Portal board.
    • demandFilter: Demand filter of Investment Portal board.
    • projectClass: Project class of Investment Portal board which is used during teamspaces value evaluation. It returns tsp1_project for Teamspace1 Portal Board.
    • demandClass: Demand class of Investment Portal board which is used during teamspaces value evaluation. It returns tsp1_demand for Teamspace1 Portal Board.
    • boardSysId: SysId of Investment Portal board. It provides access to more information on Investment Portal board when needed.
    Sample scripted widget for project cost 
    totalProjectCost();

function totalProjectCost() 
{
    var totalCost = 0;
    
    if(!JSUtil.nil(projectClass) && !JSUtil.nil(projectFilter))
{ 
        var projectGa = new GlideAggregate(projectClass);
        projectGa.addEncodedQuery(projectFilter);
        projectGa.setGroup(false);
        projectGa.addAggregate('SUM', 'cost');

        projectGa.query();

        if(projectGa.next()) 
{
            if(projectGa.getAggregate('SUM', 'cost'))
            totalCost += parseFloat(projectGa.getAggregate('SUM', 'cost'));
        }
    }
    return PPMCurrencyHelper.defaultCurrencySymbol() + PPMCurrencyHelper.getFormattedAmount(totalCost);
}
    Table 2. Project section of the Portal board widget form
    Field Description
    Project aggregate column Aggregation is applied on the selected column of the Project [pm_project] table.
    Project table Table from which projects are being filtered.
    Project filter Criteria applied to filter projects from the Project table.
    Table 3. Demand section of the Portal board widget form
    Field Description
    Demand aggregate column Aggregation is applied on the selected column of the Demand [dmn_demand] table.
    Demand table Table from which demands are being filtered.
    Demand filter Criteria applied to filter demands from the Demand table.