KPIs (Stats)

This resource explains KPI Accumulators or KPI Templates. There is a section for <KPIs> at the very bottom of a compensation plan. KPIs are something that clients frequently change, especially after their site has gone live. KPIs (Key Performance Indicators) are another name for stats. They keep track of your Associate's performance and volume and are used in many places throughout the system:

Here's an example of a KPI in XML:

<KPIs>
    <TemplateKPI Description="Group Volume" Key="GVKPI">
        <Accumulator>
            <VolumeSumAccumulator TreeVolume="GV" PersonalVolume="RRQV" Volume="RRQV"/>
        </Accumulator>
    </TemplateKPI>
</KPIs>

Each <TemplateKPI> assigns Description and Key attributes. There's a ten-character limit for Keys. Keys should be as concise as possible. It's a best practice to have no spaces or special characters in Keys.

Keys don't appear anywhere in the UI, showing the Descriptions instead. Descriptions have no character limit and can be longer and more "phrase-like". You can update Descriptions at any time. Keys, however, should never change.



Referencing Rules and Volumes

Because you typically write KPIs at the end of a compensation plan, they can reference almost any Rule, Volume, or anything else in the plan. For example:

<KPIs>
    <TemplateKPI Description="Group Volume" Key="GVKPI">
        <Accumulator>
            <VolumeSumAccumulator TreeVolume="GV" PersonalVolume="RRQV" Volume="RRQV"/>
        </Accumulator>
    </TemplateKPI>
</KPIs>

As you can see in the preceding example, we use <VolumeSumAccumulator> to look at the volumes previously written and return them as a KPI named GVKPI. The Description says that this KPI is Group Volume, so we pass in the Tree Volume(GV) to get the group volume and add the Associate's Personal Volume (RRQV) in as well.

Learn more about Tree Volumes and Volumes.

In another example:

<TemplateKPI Description="Builder Legs" Key="BLegS">
      <Accumulator>
        <LegCountAccumulator Tree="Enrollment" TreeIndex="0" OptionID="BLeg" PersonalSponsored="False" MaxValue="0" Leg="" />
      </Accumulator>
</TemplateKPI>

We use <LegCountAccumulator> looks at the Enrollment Tree and looks for any Associates who meet the Rule (OptionID) and returns a number. That number will be the KPI stat displayed with the Description "Builder Legs".

Learn more about Rules.

PersonalSponsored is set to False; if it were True, then it would include only those the Associate has personally sponsored for enrollment. If you're doing a Binary or Matrix compensation plan, you can specify the Right or Left Leg to restrict the Leg's data.

<TemplateKPI Description="Sponsored Quick Start 200" Key="SQS200">
      <Accumulator>
        <NodeCountAccumulator Tree="Enrollment" TreeIndex="0" OptionID="QS200" BegGen="1" EndGen="1" CompressOptionID="" IncludeCompressed="False" />
      </Accumulator>
</TemplateKPI>

The preceding example looks at the Enrollment Tree to see who meets the Rule (OptionID="QS200") and is on the Associate's Generation 1 (BegGen="1" EndGen="1"). You can also include compression (IncludeCompressed) and compress on a specific Rule (CompressOptionID).



Setting KPIs in Rules

As you're building your Rules, you can set specific Rules to Result in setting a KPI. Using the <SetStat> element, you can assign a Name and Description for the KPI; these KPIs function as true/false. If the Associate meets the Rule, then the KPI will show as true for them.

<Result>
    <SetStat Name="ComACT" Description="Commission Active" />
</Result>


Adding Stats Template Name

After adding a new KPI to the template, the KPI won't immediately show up. In the system, the Stats run on a different service called the "Worker Service". The Worker Service doesn't recognize KPIs until you clear the cache or wait until it clears itself (around 30 minutes).

Learn more about Stats and Projected Commissions Template Names.


Did this page help you?