{"id":2891,"date":"2011-11-30T11:30:58","date_gmt":"2011-11-30T03:30:58","guid":{"rendered":"http:\/\/www.sharepointboost.com\/blog\/?p=2891"},"modified":"2023-07-31T11:40:23","modified_gmt":"2023-07-31T03:40:23","slug":"how-to-use-c-to-read-sharepoint-kpi-list-value","status":"publish","type":"post","link":"https:\/\/www.boostsolutions.com\/blog\/how-to-use-c-to-read-sharepoint-kpi-list-value\/","title":{"rendered":"How to Use C# to read SharePoint KPI List Value"},"content":{"rendered":"

A Key Performance Indicator (KPI) is a visual clue that communicates the amount of progress made towards a goal. This article explains how to read KPI values using C#.<\/p>\n

Key Performance Indicators are valuable for teams, managers, and businesses to evaluate quickly the progress made regarding to measurable goals, but we cannot use common SharePoint object module to read kpi list value. If you cannot use MS API to read this information, if you want to access KPI list value you should use c#.<\/p>\n

All SharePoint KPI List Code is contained in Microsoft.SharePoint.Portal.dll, and most core code about KPI list cannot be accessed using SharePoint API because they use internal keywords. Luckily, a KPIData class is public, we can access it and the KPI List Value contained in this class.<\/p>\n

Some description of KPIData properties.<\/strong><\/p>\n

\"\"<\/a><\/p>\n

Now , if we get KPIConsts.KPIData we will get KPI values.<\/strong><\/p>\n

If we use SharePoint 2010 we will use<\/strong><\/p>\n

<\/strong>Assembly<\/span> asm = System.Reflection.Assembly<\/span>.Load(“Microsoft.SharePoint.Portal, Version=14.0.0.0, Culture=neutral, PublicKeyToken=71e9bce111e9429c”<\/span>);<\/p>\n

In SharePoint 2007 use<\/strong><\/p>\n

Assembly<\/span> asm = System.Reflection.Assembly<\/span>.Load(“Microsoft.SharePoint.Portal, Version=14.0.0.0, Culture=neutral, PublicKeyToken=71e9bce111e9429c<\/span>“<\/span>);<\/p>\n

we have another way to load this dll which does not specifies version.<\/strong><\/p>\n

Type<\/span> kpiDataType = typeof<\/span>(KPIConsts.KPIData<\/span>);<\/p>\n

Assembly<\/span> asm = Assembly<\/span>.GetAssembly(kpiDataType);<\/p>\n

When we get this assembly we can use reflect to get KPI list value.<\/strong><\/p>\n

The first step is to get KPI Factory Type, this class is static.<\/strong><\/p>\n

Type<\/span>kpiFactoryType=asm.GetType(“Microsoft.SharePoint.Portal.WebControls.KpiFactory”<\/span>);<\/p>\n

The second step is to get KPI data, but this data object does not contain KPI values.<\/strong><\/p>\n

object<\/span> kpi = kpiFactoryType.InvokeMember(“GetKpi<\/span>“, BindingFlags<\/span>.InvokeMethod | BindingFlags<\/span>.NonPublic | BindingFlags<\/span>.Public | BindingFlags<\/span>.Static, null<\/span>,null<\/span>, new object<\/span>[] { item });<\/p>\n

The third step is to get KPIData, this data is what we need.<\/p>\n

Object <\/span>data = kpi.GetType().InvokeMember(“GetKpiData<\/span>“, BindingFlags<\/span>.InvokeMethod | BindingFlags<\/span>.Public | BindingFlags<\/span>.NonPublic | BindingFlags<\/span>.Instance, null<\/span>, kpi, new object<\/span>[] { });<\/p>\n

KPIConsts<\/span>.KPIData <\/span>kpidata= return<\/span> data as<\/span> KPIConsts<\/span>.KPIData<\/span><\/p>\n

The last step is to use KPIData properties in your project.<\/strong><\/p>\n

Except this, KPI object has some filter features, with Indicator using data in SharePoint list content type.<\/p>\n

To specify the Indicator value: Section choice.<\/p>\n

Calculation using all list items in the view.<\/p>\n

If have some item setting like this, you can add filter feature using other code.<\/p>\n

\"\"<\/a><\/p>\n

 <\/p>\n

 <\/p>\n

 <\/p>\n

 <\/p>\n

 <\/p>\n

 <\/p>\n

 <\/p>\n

 <\/p>\n

 <\/p>\n

 <\/p>\n

 <\/p>\n

 <\/p>\n

 <\/p>\n

\"\"<\/a><\/p>\n

 <\/p>\n

 <\/p>\n

 <\/p>\n

 <\/p>\n

 <\/p>\n

 <\/p>\n

 <\/p>\n

 <\/p>\n

 <\/p>\n

 <\/p>\n

 <\/p>\n

 <\/p>\n

 <\/p>\n

 <\/p>\n

 <\/p>\n

 <\/p>\n

IFilterValues is a interface which has two properties :<\/p>\n

1. public string ParameterName : returns filter field name, this field name is the displayed name.<\/p>\n

2. public ReadOnlyCollection<string> ParameterValues : returns all filter conditions.<\/p>\n

you can implement filter interface like this.<\/p>\n

\"\"<\/a><\/p>\n

 <\/p>\n

 <\/p>\n

 <\/p>\n

 <\/p>\n

 <\/p>\n

 <\/p>\n

 <\/p>\n

 <\/p>\n

 <\/p>\n

 <\/p>\n

 <\/p>\n

 <\/p>\n

 <\/p>\n

 <\/p>\n

 <\/p>\n

Of course there are some unclear parameters that do various other things, I will update as soon as I figure out what they are but if all you want is read KPI values the explanation above is sufficient.<\/p>\n","protected":false},"excerpt":{"rendered":"

A Key Performance Indicator (KPI) is a visual clue that communicates the amount of progress made towards a goal. This article explains how to read KPI values using C#. Key Performance Indicators are valuable for teams, managers, and businesses to evaluate quickly the progress made regarding to measurable goals, but we cannot use common SharePoint […]<\/p>\n","protected":false},"author":44,"featured_media":0,"comment_status":"closed","ping_status":"closed","sticky":false,"template":"","format":"standard","meta":[],"categories":[125],"tags":[270,268,269],"_links":{"self":[{"href":"https:\/\/www.boostsolutions.com\/blog\/wp-json\/wp\/v2\/posts\/2891"}],"collection":[{"href":"https:\/\/www.boostsolutions.com\/blog\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/www.boostsolutions.com\/blog\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/www.boostsolutions.com\/blog\/wp-json\/wp\/v2\/users\/44"}],"replies":[{"embeddable":true,"href":"https:\/\/www.boostsolutions.com\/blog\/wp-json\/wp\/v2\/comments?post=2891"}],"version-history":[{"count":12,"href":"https:\/\/www.boostsolutions.com\/blog\/wp-json\/wp\/v2\/posts\/2891\/revisions"}],"predecessor-version":[{"id":9273,"href":"https:\/\/www.boostsolutions.com\/blog\/wp-json\/wp\/v2\/posts\/2891\/revisions\/9273"}],"wp:attachment":[{"href":"https:\/\/www.boostsolutions.com\/blog\/wp-json\/wp\/v2\/media?parent=2891"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/www.boostsolutions.com\/blog\/wp-json\/wp\/v2\/categories?post=2891"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/www.boostsolutions.com\/blog\/wp-json\/wp\/v2\/tags?post=2891"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}