Key Performance Indicator (KPI) Portlets in SDF Custom Objects

You can create KPI portlets in SuiteCloud Development Framework (SDF) using the publisheddashboard SDF custom object. For information about the appropriate context, see Published Dashboards as XML Definitions.

KPIs provide summaries of your forecast, pipeline, orders, cases, and financial data on a dashboard. Each KPI compares data based on reports over different time ranges. You can reference standard KPIs or create custom KPIs based on saved searches.

KPI portlets in SDF are represented with the keyperformanceindicators element. You can specify this element in a dashboard of a published dashboard object.

The following example shows a KPI portlet definition that sets up three distinct KPIs—Bank Balance, Closed Cases, Utilization. Each KPI contains child elements to represent the included data, such as date or period ranges and comparisons.

          <keyperformanceindicators>
    <cachedata>F</cachedata>
    <kpis>
        <kpi>
            <compare>T</compare>
            <comparedaterange>LAST_MONTH_TO_DATE</comparedaterange>
            <compareperiodrange>LAST_PERIOD</compareperiodrange>
            <daterange>TODAY</daterange>
            <headline>F</headline>
            <kpi>BANKBAL</kpi>
            <periodrange>THIS_PERIOD</periodrange>
        </kpi>
        <kpi>
            <compare>T</compare>
            <comparedaterange>LAST_WEEK</comparedaterange>
            <daterange>THIS_WEEK</daterange>
            <headline>F</headline>
            <highlightif>ALWAYS</highlightif>
            <kpi>CLOSEDCASES</kpi>
         </kpi>
         <kpi>
            <daterange>LAST_MONTH</daterange>
            <headline>F</headline>
            <kpi>UTILIZATION</kpi>
            <periodrange>THIS_PERIOD</periodrange>
        </kpi>
    </kpis>
</keyperformanceindicators>

The kpi element supports several child elements to configure KPIs but some of these child elements are not supported by all KPI types. In addition, some child elements function differently depending on whether the Accounting Periods feature is enabled in the target NetSuite account. For example, KPIs that define a periodrange element must always have a daterange defined, too. If the Accounting Periods feature is disabled in the account, only the daterange element is used. If the Accounting Periods feature is enabled, the periodrange or daterange element is used according to the Report by Period preference.

Due to these caveats and the varied configurations for each portlet, SDF performs extensive validation on KPI portlets when they are deployed to a target NetSuite account. This validation ensures that the child elements used for any KPI type is supported.

Note:

Some KPI fields may contain or require account-specific values. These values cannot be specified or imported into a SuiteCloud project. These values can only be specified in the portlet using the NetSuite UI after the published dashboard is deployed to a target account.

For more information about KPI portlets, see:

Related Topics