Portal board widget form

  • Release version: Zurich
  • Updated July 31, 2025
  • 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 in ServiceNow Zurich release enables you to configure investment widgets that display aggregated investment data on your Investment Board and Investment Portal page. This form allows you to define how investment metrics are calculated, displayed, and organized for better visualization and decision-making in portfolio management.

    Show full answer Show less

    Key Features

    • Name and Order: Assign a unique name and set the display order of widgets on boards, with lower numbers appearing first.
    • Aggregate Type: Choose from Sum, Average, Minimum, Maximum, or Count to aggregate investment data such as project costs or demand metrics.
    • Scripted Calculation: Optionally enable scripted calculations for dynamic investment metrics using provided script variables like projectFilter, demandFilter, projectClass, demandClass, and boardSysId. This allows customization beyond standard aggregation.
    • Display Options: Customize the widget label and color, activate or deactivate widgets, and decide whether they appear on the investment board by default.
    • Parent-Child Widget Structure: Supports hierarchical widgets with up to three child widgets under a parent for organized metric grouping.
    • Project and Demand Sections: Configure aggregation columns, tables, and filters specifically for Project [pmproject] and Demand [dmndemand] tables to refine the data included in widgets.

    Practical Use and Benefits

    This widget form empowers ServiceNow customers to tailor investment metrics according to their portfolio needs, enabling clear visualization of key financial and demand-related indicators. By using aggregation types or scripting, customers can derive meaningful insights such as total costs, averages, or counts of projects and demands. The ability to filter data and organize widgets hierarchically enhances the management and monitoring of investments on the portal.

    As a result, customers can expect more accurate, customizable, and actionable investment data presentations within their ServiceNow environment, supporting better strategic decision-making and portfolio oversight.

    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.