SPDataStore.UpdateIndicator method

Article
05/27/2015

Updates an indicator in a SharePoint list.

Namespace: Microsoft.PerformancePoint.Scorecards.Store
Assembly: Microsoft.PerformancePoint.Scorecards.Store (in Microsoft.PerformancePoint.Scorecards.Store.dll)

Syntax

'Declaration
Public Function UpdateIndicator ( _
    indicator As Indicator _
) As Indicator
'Usage
Dim instance As SPDataStore
Dim indicator As Indicator
Dim returnValue As Indicator

returnValue = instance.UpdateIndicator(indicator)

public Indicator UpdateIndicator(
    Indicator indicator
)

Parameters

indicator
Type: Indicator

The indicator object that contains the updated information. The Location property must specify the URL of the object to update.

Return value

Type: Indicator
The updated object, which contains updated information such as the new version number.

Implements

IBIMonitoringStore.UpdateIndicator(Indicator)

Remarks

For indicator, we recommend that you use an indicator object that was previously retrieved by using the GetIndicator(RepositoryLocation) method.

Examples

The following code example shows how to retrieve an indicator, update the retrieved indicator, and then save the updated object to the repository.

Before you can compile this code example, you must do the following:

Configure your development environment and create a C# class library project in Visual Studio. For information about configuring a development environment, see Set up a general development environment for SharePoint 2013.
Add the Microsoft.PerformancePoint.Scorecards.Client, Microsoft.PerformancePoint.Scorecards.ServerCommon, and Microsoft.PerformancePoint.Scorecards.Store DLLs as references to your project. For more information about PerformancePoint Services DLLs, see PerformancePoint Services DLLs Used in Development Scenarios.

Add the following using directives to your class.

using Microsoft.PerformancePoint.Scorecards;
using Microsoft.PerformancePoint.Scorecards.Indicators;
using Microsoft.PerformancePoint.Scorecards.Store;
using System.Globalization;

Create a method that does the following:
- Defines a string variable named "relativePath" to store the server-relative path to the object. The following example path sets the object identifier to "5": /BI Center/Lists/PerformancePoint Content/5_.000.
- Creates an instance of an Indicator object named "updatedIndicator." For an example of how to create the object, see the CreateIndicator method.
Paste the following code example into the new method.

// As a best practice, retrieve an object and then update it.
// The RepositoryLocation constructor takes the server-relative path to the object.
Indicator requestedIndicator = SPDataStore.GlobalDataStore.GetIndicator(new RepositoryLocation(relativePath));

if (requestedIndicator != null)
{
    // Update the description to show the time of the last update operation.
    requestedIndicator.Description.Text = String.Format(
        CultureInfo.CurrentCulture,
        "Last updated at {0}",
        DateTime.Now.ToLocalTime());

    // Update the indicator in the repository.
    updatedIndicator = SPDataStore.GlobalDataStore.UpdateIndicator(requestedIndicator);
}