KPI Scorecards as XML Definitions

KPI scorecards compare complex relationships among multiple KPIs over multiple date ranges or accounting periods. Use KPI scorecards to store your selection of performance indicators, mathematical formulas, time periods, and date ranges. Each KPI scorecard object supports several standard KPIs and up to ten custom KPIs that are based on saved searches. For more information about KPI scorecards, see the following:

Create and manage KPI scorecards using SuiteCloud Development Framework (SDF). You can model a KPI scorecard definition in a SuiteCloud project and deploy the project to a target NetSuite account. For more information about working with KPI scorecards in a NetSuite account, see the following:

KPI scorecards are referenced by the kpiscorecard root element in SDF. The following is a sample KPI scorecard object that contains some basic information:

          <kpiscorescard scriptid="custkpiscorecard_sample">
    <name>Sample KPI Scorecard</name>
    <useperiods>F</useperiods>
    <description>This is a sample KPI scorecard.</description>
    <custom>
        <kpi1>SAVEDSEARCH1</kpi1>
        <kpi2>SAVEDSEARCH2</kpi2>
        <kpi3>SAVEDSEARCH3</kpi3>
        <kpi4>SAVEDSEARCH4</kpi4>
        <kpi5>SAVEDSEARCH5</kpi5>
        <kpi6>SAVEDSEARCH6</kpi6>
        <kpi7>SAVEDSEARCH7</kpi7>
        <kpi8>SAVEDSEARCH8</kpi8>
        <kpi9>SAVEDSEARCH9</kpi9>
        <kpi10>SAVEDSEARCH10</kpi10>
    <custom>
    <audience>
        <allroles>T</allroles>
        <allpartners>F</allpartners>
        <allemployees>F</allemployees>
    </audience>
    ...
</kpiscorecard>

Use the useperiods Boolean element to determine whether the KPI scorecard should use periods instead of date ranges. When periods are used, accounting periods should be set up in a NetSuite account. You should set the Report by Period preference to All Reports on the Analytics tab of the Set Preferences page.

The custom structure is required when using custom KPIs in your formulas and comparisons. Each element should reference the saved search ID that is used as the basis for each custom KPI. Each element is labeled from kpi1 through kpi10, supporting up to ten saved search references. A KPI scorecard object supports up to ten custom KPIs.

The audience structure is optional. Use this structure to define which roles can display the KPI scorecard in their KPI scorecard portlets.

In addition to these information fields, KPI scorecards can have the following structures:

kpis

The kpis structure encapsulates all the KPIs that you want to compare. Alternatively, you can use this structure to set up formula expressions. For more information about setting up the kpis structure, see the following:
- KPI Comparisons in KPI Scorecards
- KPI Formulas in KPI Scorecards
ranges

The ranges structure defines multiple date ranges or periods that apply to all scorecard data. For more information, see Date Ranges and Periods in KPI Scorecards.
highlightings

The highlightings structure sets highlighting options to make results more visible in the KPI scorecard portlet. For more information, see Highlighting in KPI Scorecards.

After deploying a KPI scorecard object from a SuiteCloud project to the target NetSuite account, you can reference it from a published dashboard through NetSuite. For more information, see Adding a KPI Scorecard Portlet to a Dashboard.

Important:

KPI scorecard objects cannot be referenced or configured for use in any published dashboard objects that are managed through a SuiteCloud project.

For more information about the KPI scorecard object, see kpiscorecard.

Example

The following is an example of a KPI scorecard object. This scorecard creates a matrix involving two key performance indicators, COGS vs Bank Balance and Activities vs Previous, and two ranges, THIS FISCAL HALF and LAST YEAR VS. THIS FISCAL YEAR.

            <kpiscorescard scriptid="custkpiscorecard_sample">
    <name>Sample KPI</name>
    <useperiods>F</useperiods>
    <kpis>
        <kpi>
            <kpi>COGS</kpi>
            <comparevalueto>BANKBAL</comparevalueto>
            <comparewithprevious>F</comparewithprevious>
            <hidden>F</hidden>
            <invertcomparison>F</invertcomparison>
        </kpi>
        <kpi>
            <kpi>CUSTOM</kpi>
            <comparewithprevious>T</comparewithprevious>
            <comparisontype>RATIO_PERCENT</comparisontype>
            <hidden>F</hidden>
            <invertcomparison>T</invertcomparison>
        </kpi>
    </kpis>
    <ranges>
        <range>
            <comparewithprevious>F</comparewithprevious>
            <invertcomparison>T</invertcomparison>
            <range>THIS_FISCAL_HALF</range>
        </range>
        <range>
            <comparevalueto>THIS_FISCAL_YEAR</comparevalueto>
            <comparewithprevious>F</comparewithprevious>
            <comparisontype>SUM</comparisontype>
            <invertcomparison>F</invertcomparison>
            <range>LAST_YEAR</range>
        </range>
     </ranges>
    <custom>
        <kpi1>ACTIVITIES</kpi1> <!-- Saved Search associated with the first CUSTOM KPI -->
    </custom>
    <highlightings>
        <highlighting>
            <backgroundcolor>000000</backgroundcolor>
            <bold>T</bold>
            <condition>ALWAYS</condition>
            <foregroundcolor>FF0000</foregroundcolor>
            <headline>T</headline>
            <icon>DOLLAR_SIGN_3</icon>
            <kpiindex>1</kpiindex>
            <rangeindex>1</rangeindex>
        </highlighting>
    </highlightings>
    <audience>
        <allemployees>F</allemployees>
        <allpartners>F</allpartners>
        <allroles>T</allroles>
    </audience>
</kpiscorecard>

Example

Related Topics